Docs - update TOML generation

Author: ethancrawford

app/server/ruby/bin/qt-doc2.rb

@@ -36,72 +36,108 @@ class QtDocs
   include SonicPi::Util
   include GetText
 
-  def doc_collections
-    synths = SonicPi::Synths::SynthInfo.get_all.select do |k, v|
-      v.is_a?(SonicPi::Synths::SynthInfo) && v.user_facing?
-    end
-    [
-      {
-        items: synths,
-        template_path: synth_and_fx_template_path,
-        interpolated_path: synths_interpolated_path,
-        output_path: synths_toml_path,
-        klass: SonicPi::Synths::SynthInfo
-      },
-      {
-        items: @@docs,
-        template_path: lang_template_path,
-        interpolated_path: lang_interpolated_path,
-        output_path: lang_toml_path
-      }
-    ]
-  end
-
   def run
-    _generate_docs
+    generate_docs
+    sync_to_documentation_app
   end
 
   def t_(arg)
+    # this didn't work on docstrings containing "blah"
+    arg = arg.tr('"', "\"") if arg.is_a?(String)
     "<%= _(\"#{arg}\") %>"
   end
 
   private
-  def _generate_docs
-    interpolated_file_paths = doc_collections.each_with_object([]) do |collection, paths|
+  def generate_docs
+    interpolated_file_paths = [synths, fx, samples, lang].each_with_object([]) do |collection, paths|
       original_template = File.read(collection[:template_path])
       collection[:items].to_a.take(2).each do |key, item|
+        # this really needs a more elegant way of reading arg/slide data from the object for
+        # all types (synths/fx/samples)
+        data_object = collection[:data_object] || item
+        key = key.to_s[3..-1] if collection[:klass] == SonicPi::Synths::FXInfo
         interpolated_file_path = "#{collection[:interpolated_path]}/#{key}.toml.erb"
-        template = ERB.new(original_template).result(binding)
+        template = ERB.new(original_template, nil, '-').result(binding)
         File.open(interpolated_file_path, 'w') do |f|
           f.write template
         end
         paths << interpolated_file_path
       end
-    end
-    _generate_pot_file(interpolated_file_paths)
-    _generate_toml_files
 
+    end
+    generate_pot_file(interpolated_file_paths)
+    generate_toml_files
   end
 
-
-  def _generate_pot_file(interpolated_file_paths)
+  def generate_pot_file(interpolated_file_paths)
     GetText::Tools::XGetText.run(
       *interpolated_file_paths,
       "-o ../../../../../../etc/doc/generated/toml/synths/test.pot"
     )
   end
 
-  def _generate_toml_files
-    doc_collections.each do |collection|
+  def generate_toml_files
+    [synths, fx, samples, lang].each do |collection|
       collection[:items].to_a.take(2).each do |key, item|
+        key = key.to_s[3..-1] if collection[:klass] == SonicPi::Synths::FXInfo
         interpolated_file = File.read("#{collection[:interpolated_path]}/#{key}.toml.erb")
-        output = ERB.new(interpolated_file).result(binding)
+        output = ERB.new(interpolated_file, nil, '-').result(binding)
         File.open("#{collection[:output_path]}/#{key}.toml", 'w') do |f|
           f.write output
         end
       end
     end
   end
+
+  def sync_to_documentation_app
+    FileUtils.cp_r(doc_toml_path, documentation_app_priv_path, remove_destination: true)
+  end
+
+  def synths
+    items = SonicPi::Synths::SynthInfo.get_all.select do |k, v|
+      v.is_a?(SonicPi::Synths::SynthInfo) && v.user_facing?
+    end
+    {
+      items: items,
+      template_path: synth_and_fx_template_path,
+      interpolated_path: synths_interpolated_path,
+      output_path: synths_toml_path,
+      klass: SonicPi::Synths::SynthInfo
+    }
+  end
+
+  def fx
+    items = SonicPi::Synths::SynthInfo.get_all.select do |k, v|
+      v.is_a?(SonicPi::Synths::FXInfo) && v.user_facing? && !(k.to_s.include? 'replace_')
+    end
+    {
+      items: items,
+      template_path: synth_and_fx_template_path,
+      interpolated_path: fx_interpolated_path,
+      output_path: fx_toml_path,
+      klass: SonicPi::Synths::FXInfo
+    }
+  end
+
+  def samples
+    {
+      items: SonicPi::Synths::SynthInfo.grouped_samples,
+      template_path: samples_template_path,
+      interpolated_path: samples_interpolated_path,
+      output_path: samples_toml_path,
+      data_object: SonicPi::Synths::StereoPlayer.new
+    }
+  end
+
+  def lang
+    {
+      items: @@docs,
+      template_path: lang_template_path,
+      interpolated_path: lang_interpolated_path,
+      output_path: lang_toml_path
+    }
+  end
+
 end
 
 QtDocs.new.run

app/server/ruby/lib/sonicpi/synths/synthinfo.rb

@@ -3819,7 +3819,7 @@ def specific_arg_info
 
           :pitch_dis =>
           {
-            :doc => "Pitch dispersion - how much random variation in pitch to add. Using a low value like 0.001 can help to \"soften up\" the metallic sounds, especially on drum loops. To be really technical, pitch_dispersion is the maximum random deviation of the pitch from the pitch ratio (which is set by the pitch param)",
+            :doc => "Pitch dispersion - how much random variation in pitch to add. Using a low value like 0.001 can help to 'soften up' the metallic sounds, especially on drum loops. To be really technical, pitch_dispersion is the maximum random deviation of the pitch from the pitch ratio (which is set by the pitch param)",
             :validations => [v_greater_than_oet(:pitch_dis, 0)],
             :modulatable => true
           },

etc/doc/templates/lang.toml.erb

@@ -1,5 +1,5 @@
 <%=
-t_(<<~TEXT
+t_(<<~TEXT.chomp
 # This is a data file that contains information describing the text that is
 # displayed on pages in the Lang section of Sonic Pi's help panel.
 TEXT
@@ -12,7 +12,7 @@ TEXT
 [<%= item[:name] %>]
 
 <%=
-t_(<<~TEXT
+t_(<<~TEXT.chomp
 # A short phrase describing this Sonic Pi function. (Eg the 'chord' function has
 # a summary phrase: 'Create chord').
 TEXT
@@ -21,14 +21,14 @@ TEXT
 summary = "<%= t_(summary) %>"
 
 <%=
-t_(<<~TEXT
+t_(<<~TEXT.chomp
 # Args are the required parameters for the function. Each arg has two documented
 # properties:
 # - the arg's name
 # - the arg's type (number, integer, symbol, ...).
 TEXT
 )
-%>
+-%>
 <% item[:args].each do |name, type| %>
 [[<%= item[:name] %>.args]]
 name = "<%= name %>"
@@ -40,7 +40,7 @@ doc = '''
 '''
 
 <%=
-t_(<<~TEXT
+t_(<<~TEXT.chomp
 # The label describing the version of Sonic Pi in which this function first
 # appeared.
 TEXT
@@ -51,7 +51,7 @@ label = "<%= t_("Introduced in #{item[:introduced].to_s}") %>"
 <% if item[:opts] && !item[:opts].empty? %>
 
 <%=
-t_(<<~TEXT
+t_(<<~TEXT.chomp
 # The options are the optional parameters of this function.
 # Each option has two documented properties:
 # - the option's name
@@ -68,7 +68,7 @@ doc = "<%= t_(doc) %>"
 <% end %>
 <% end %>
 <%=
-t_(<<~TEXT
+t_(<<~TEXT.chomp
 # Each function may have one or more examples. If it has any, they are listed
 # under an overall 'Example' or 'Examples' label (heading), and each example has
 # a numbered sub-heading, such as 'Example 1'.

etc/doc/templates/slides.toml.erb

@@ -2,7 +2,7 @@
 slide_label = "<%= t_('Slide Options') %>"
 slide_description = '''
 <%=
-t_(<<~TEXT
+t_(<<~TEXT.chomp
 Any parameter that is slidable has three additional options named _slide,
 slide_curve, and _slide_shape.  For example, 'amp' is slidable, so you can also
 set amp_slide, amp_slide_curve, and amp_slide_shape with the following effects:
@@ -12,11 +12,11 @@ TEXT
 '''
 <%
 slide_opts = {
-  :_slide => {:default => 0, :doc=>item.generic_slide_doc('parameter')},
-  :_slide_shape => {:default=>5, :doc=>item.generic_slide_shape_doc('parameter')},
-  :_slide_curve => {:default=>0, :doc=>item.generic_slide_curve_doc('parameter')}
+  :_slide => {:default => 0, :doc=>data_object.generic_slide_doc('parameter')},
+  :_slide_shape => {:default=>5, :doc=>data_object.generic_slide_shape_doc('parameter')},
+  :_slide_curve => {:default=>0, :doc=>data_object.generic_slide_curve_doc('parameter')}
 }
-%>
+-%>
 <% slide_opts.each do |name, attributes| %>
 [[sliding.slide_opts]]
 name = "<%= name %>"

etc/doc/templates/synth_and_fx.toml.erb

@@ -1,5 +1,5 @@
 <%=
-t_(<<~TEXT
+t_(<<~TEXT.chomp
 # This is a data file that contains information describing the text that is
 # displayed on pages in the Synths section of Sonic Pi's help panel.
 
@@ -12,7 +12,7 @@ TEXT
 [<%= key %>]
 
 <%=
-t_(<<~TEXT
+t_(<<~TEXT.chomp
 # A word or short phrase that is used as a label for the synth or fx.
 # (For example: Pretty Bell).
 TEXT
@@ -26,8 +26,8 @@ usage = '''
 if collection[:klass] == SonicPi::Synths::SynthInfo
   "use_synth :#{key}"
 elsif collection[:klass] == SonicPi::Synths::FXInfo
-  fx_string = <<~TEXT
-with_fx :#{key.to_s[3..-1]} do
+  fx_string = <<~TEXT.chomp
+with_fx :#{key} do
   play 50
 end
 TEXT
@@ -41,7 +41,7 @@ doc = '''
 '''
 
 <%=
-t_(<<~TEXT
+t_(<<~TEXT.chomp
 # The label describing the version of Sonic Pi in which this synth or fx first
 # appeared.
 TEXT
@@ -51,7 +51,7 @@ TEXT
 label = "<%= t_("Introduced in #{item.introduced.to_s}") %>"
 
 <%=
-t_(<<~TEXT
+t_(<<~TEXT.chomp
 # The options are the opts of this synth or fx.
 # In the documentation, we currently display two tables of opts:
 # - one listing the name of each opt and its default value for easy reference
@@ -93,6 +93,6 @@ t_(
 <% end %>
 <%=
 if item.arg_info.any? { |name, arg| arg[:slidable] }
-  ERB.new(File.read(slides_template_path), eoutvar: '_slide01').result(binding)
+  ERB.new(File.read(slides_template_path), nil, '-', eoutvar: '_slide01').result(binding)
 end
 %>

etc/docs/lib/docs/application.ex

@@ -17,6 +17,7 @@ defmodule Docs.Application do
       # {Docs.Worker, arg}
     ]
 
+    :ets.new(:session, [:set, :public, :named_table, read_concurrency: true])
     # See https://hexdocs.pm/elixir/Supervisor.html
     # for other strategies and supported options
     opts = [strategy: :one_for_one, name: Docs.Supervisor]

etc/docs/lib/docs_web/endpoint.ex

@@ -5,8 +5,9 @@ defmodule DocsWeb.Endpoint do
   # this means its contents can be read but not tampered with.
   # Set :encryption_salt if you would also like to encrypt it.
   @session_options [
-    store: :cookie,
-    key: "_docs_key",
+    store: :ets,
+    key: "sid",
+    table: :session,
     signing_salt: "lVcj/WFu"
   ]
 

etc/docs/lib/docs_web/live/page_live.ex

@@ -2,8 +2,8 @@ defmodule DocsWeb.PageLive do
   use DocsWeb, :live_view
 
   @impl true
-  def mount(_params, _session, socket) do
-    {:ok, assign(socket, query: "", results: %{})}
+  def mount(_params, %{"metadata" => metadata}, socket) do
+    {:ok, assign(socket, query: "", results: %{}, metadata: metadata)}
   end
 
   @impl true

etc/docs/lib/docs_web/live/page_live.html.leex

@@ -12,7 +12,7 @@
     <button type="submit" phx-disable-with="Searching...">Go to Hexdocs</button>
   </form>
 </section>
-
+<p><%= inspect @metadata %></p>
 <section class="row">
   <article class="column">
     <h2>Resources</h2>

etc/docs/lib/docs_web/router.ex

@@ -8,6 +8,7 @@ defmodule DocsWeb.Router do
     plug :put_root_layout, {DocsWeb.LayoutView, :root}
     plug :protect_from_forgery
     plug :put_secure_browser_headers
+    plug DocsWeb.Plug.InjectToml
   end
 
   pipeline :api do