Spider - move all path methods to the Paths module

samaaron · samaaron · commit f540d08d75b2 · 2021-09-07T18:08:39.000+01:00
diff --git a/app/server/ruby/bin/qt-doc.rb b/app/server/ruby/bin/qt-doc.rb
@@ -87,14 +87,14 @@
   "zh_TW" => "臺灣華語" # Chinese (Traditional, Taiwan)
 ]
 
-FileUtils::rm_rf "#{qt_gui_path}/help/"
-FileUtils::mkdir "#{qt_gui_path}/help/"
+FileUtils::rm_rf "#{Paths.qt_gui_path}/help/"
+FileUtils::mkdir "#{Paths.qt_gui_path}/help/"
 
-FileUtils::rm_rf "#{qt_gui_path}/info/"
-FileUtils::mkdir "#{qt_gui_path}/info/"
+FileUtils::rm_rf "#{Paths.qt_gui_path}/info/"
+FileUtils::mkdir "#{Paths.qt_gui_path}/info/"
 
-FileUtils::rm_rf "#{qt_gui_path}/book/"
-FileUtils::mkdir "#{qt_gui_path}/book/"
+FileUtils::rm_rf "#{Paths.qt_gui_path}/book/"
+FileUtils::mkdir "#{Paths.qt_gui_path}/book/"
 
 docs = []
 filenames = []
@@ -172,7 +172,7 @@
 
     filenames << filename
 
-    File.open("#{qt_gui_path}/#{filename}", 'w') do |f|
+    File.open("#{Paths.qt_gui_path}/#{filename}", 'w') do |f|
       f << "#{doc}"
     end
 
@@ -197,7 +197,7 @@
   book_body = book[/<body.*?>/]
   book.gsub!(/<\/?body.*?>/, '')
   book.gsub!(/<meta http-equiv.*?>/, '')
-  File.open("#{qt_gui_path}/book/Sonic Pi - #{name.capitalize}" + (lang != "en" ? " (#{lang})" : "") + ".html", 'w') do |f|
+  File.open("#{Paths.qt_gui_path}/book/Sonic Pi - #{name.capitalize}" + (lang != "en" ? " (#{lang})" : "") + ".html", 'w') do |f|
     f << "<link rel=\"stylesheet\" href=\"../theme/light/doc-styles.css\" type=\"text/css\"/>\n"
     f << "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/>\n\n"
     f << book_body << "\n"
@@ -218,9 +218,9 @@
   docs << "\n  // language #{lang}\n"
   tutorial_html_map = {}
   if lang == "en" then
-    markdown_path = tutorial_path
+    markdown_path = Paths.tutorial_path
   else
-    markdown_path = File.expand_path("../generated/#{lang}/tutorial", tutorial_path)
+    markdown_path = File.expand_path("../generated/#{lang}/tutorial", Paths.tutorial_path)
   end
   Dir["#{markdown_path}/*.md"].sort.each do |path|
     f = File.open(path, 'r:UTF-8')
@@ -241,7 +241,7 @@
 example_html_map = {}
 example_dirs = ["Apprentice", "Illusionist", "Magician", "Sorcerer", "Wizard", "Algomancer"]
 example_dirs.each do |ex_dir|
-  Dir["#{examples_path}/#{ex_dir.downcase}/*.rb"].sort.each do |path|
+  Dir["#{Paths.examples_path}/#{ex_dir.downcase}/*.rb"].sort.each do |path|
     bname = File.basename(path, ".rb")
     bname = ActiveSupport::Inflector.titleize(bname)
     name = "[#{ex_dir}] #{bname}"
@@ -269,7 +269,7 @@
 # before the generic language code,
 # e.g., "de_CH" should be handled before "de"
 languages =
-  Dir[File.expand_path("../lang/sonic-pi-tutorial-*.po", tutorial_path)].
+  Dir[File.expand_path("../lang/sonic-pi-tutorial-*.po", Paths.tutorial_path)].
   map { |p| File.basename(p).gsub(/sonic-pi-tutorial-(.*?).po/, '\1') }.
   sort_by {|n| [-n.length, n]}
 
@@ -338,7 +338,7 @@ def generate_ui_lang_names
   locale_arrays << "\n};\n"
 
   # Write the map to lang_list.h
-  content = File.readlines("#{qt_gui_path}/utils/lang_list.tmpl")
+  content = File.readlines("#{Paths.qt_gui_path}/utils/lang_list.tmpl")
   lang_names_generated = content.take_while { |line| !line.start_with?("// AUTO-GENERATED")}
   lang_names_generated << "// AUTO-GENERATED HEADER FILE\n"
   lang_names_generated << "// Do not add any code to this file\n"
@@ -350,7 +350,7 @@ def generate_ui_lang_names
   lang_names_generated << locale_arrays.join()
   lang_names_generated << "#endif\n"
 
-  File.open("#{qt_gui_path}/utils/lang_list.h", 'w') do |f|
+  File.open("#{Paths.qt_gui_path}/utils/lang_list.h", 'w') do |f|
     f << lang_names_generated.join()
   end
 end
@@ -360,7 +360,7 @@ def generate_ui_lang_names
 if options[:output_name] then
    cpp = options[:output_name]
 else
-   cpp = "#{qt_gui_path}/ruby_help.h"
+   cpp = "#{Paths.qt_gui_path}/ruby_help.h"
 end
 
 content = File.readlines(cpp)
@@ -377,7 +377,7 @@ def generate_ui_lang_names
   f << new_content.join
 end
 
-File.open("#{qt_gui_path}/help_files.qrc", 'w') do |f|
+File.open("#{Paths.qt_gui_path}/help_files.qrc", 'w') do |f|
   f << "<RCC>\n  <qresource prefix=\"/\">\n"
   f << filenames.map{|n| "    <file>#{n}</file>\n"}.join
   f << "  </qresource>\n</RCC>\n"
@@ -389,7 +389,7 @@ def generate_ui_lang_names
 ###
 
 info_sources = ["CHANGELOG.md", "CONTRIBUTORS.md", "COMMUNITY.md", "CORETEAM.html", "LICENSE.md"]
-outputdir = "#{qt_gui_path}/info"
+outputdir = "#{Paths.qt_gui_path}/info"
 
 info_sources.each do |src|
 
diff --git a/app/server/ruby/bin/sonic-pi-server.rb b/app/server/ruby/bin/sonic-pi-server.rb
@@ -17,6 +17,7 @@
 
 
 require_relative "../core.rb"
+require_relative "../paths"
 require_relative "../lib/sonicpi/studio"
 
 require_relative "../lib/sonicpi/server"
@@ -41,13 +42,19 @@
 STDOUT.puts "The time is #{Time.now}"
 
 ## Ensure ~/.sonic-pi/* user config, history and setting directories exist
-[home_dir_path, project_path, log_path, cached_samples_path, config_path, system_store_path].each do |d|
+[ SonicPi::Paths.home_dir_path,
+  SonicPi::Paths.project_path,
+  SonicPi::Paths.log_path,
+  SonicPi::Paths.cached_samples_path,
+  SonicPi::Paths.config_path,
+  SonicPi::Paths.system_store_path
+].each do |d|
   ensure_dir(d)
 end
 
 ## Just check to see if the user still has an old settings.json and if
 ## so, remove it. This is now stored in system_cache_store_path
-old_settings_file_path = File.absolute_path("#{home_dir_path}/settings.json")
+old_settings_file_path = File.absolute_path("#{SonicPi::Paths.home_dir_path}/settings.json")
 File.delete(old_settings_file_path) if File.exist?(old_settings_file_path)
 
 ## Move across any config example files if they don't
@@ -56,12 +63,12 @@
 
 
 begin
-  if File.exists?(original_init_path)
-    if (File.exists?(init_path))
-      STDOUT.puts "Warning, you have an older init.rb file in #{original_init_path} which is now being ignored as your newer config/init.rb file is being used instead. Consider deleting your old init.rb (perhaps copying anything useful across first)."
+  if File.exists?(SonicPi::Paths.original_init_path)
+    if (File.exists?(SonicPi::Paths.init_path))
+      STDOUT.puts "Warning, you have an older init.rb file in #{SonicPi::Paths.original_init_path} which is now being ignored as your newer config/init.rb file is being used instead. Consider deleting your old init.rb (perhaps copying anything useful across first)."
     else
-      STDOUT.puts "Found init.rb in old location #{original_init_path}. Moving it to the new config directory #{init_path}."
-      FileUtils.mv(original_init_path, init_path)
+      STDOUT.puts "Found init.rb in old location #{SonicPi::Paths.original_init_path}. Moving it to the new config directory #{SonicPi::Paths.init_path}."
+      FileUtils.mv(SonicPi::Paths.original_init_path, init_path)
     end
   end
 rescue Exception => e
@@ -75,9 +82,9 @@
 
 
 
-Dir["#{user_config_examples_path}/*"].each do |f|
+Dir["#{SonicPi::Paths.user_config_examples_path}/*"].each do |f|
   basename = File.basename(f)
-  full_config_path = File.absolute_path("#{config_path}/#{basename}")
+  full_config_path = File.absolute_path("#{SonicPi::Paths.config_path}/#{basename}")
   unless File.exist?(full_config_path)
     FileUtils.cp(f, full_config_path)
   end
@@ -277,10 +284,10 @@
   STDOUT.puts "Spider - Runtime Server Initialised"
   STDOUT.flush
   # read in init.rb if exists
-  if File.exists?(init_path)
-    sp.__spider_eval(File.read(init_path), silent: true)
+  if File.exists?(SonicPi::Paths.init_path)
+    sp.__spider_eval(File.read(SonicPi::Paths.init_path), silent: true)
   else
-    STDOUT.puts "Spider - Could not find init.rb file: #{init_path} "
+    STDOUT.puts "Spider - Could not find init.rb file: #{SonicPi::Paths.init_path} "
   end
 
   sp.__print_boot_messages
diff --git a/app/server/ruby/lib/sonicpi/lang/core.rb b/app/server/ruby/lib/sonicpi/lang/core.rb
@@ -4782,7 +4782,7 @@ def load_buffer(path)
 
 
       def load_example(example_name)
-        path = Dir[examples_path + '/**/' + example_name.to_s + '.rb'].first
+        path = Dir[Paths.examples_path + '/**/' + example_name.to_s + '.rb'].first
         raise IOError, "Error - no example found with name: #{example_name.inspect}" unless path
         buf = __current_job_info[:workspace]
         __info "loading #{buf} with #{path}"
diff --git a/app/server/ruby/lib/sonicpi/lang/sound.rb b/app/server/ruby/lib/sonicpi/lang/sound.rb
@@ -78,7 +78,7 @@ def self.included(base)
 
             @sample_paths_cache = {}
 
-            @sample_loader = SampleLoader.new("#{samples_path}/**")
+            @sample_loader = SampleLoader.new("#{Paths.samples_path}/**")
 
             @job_groups = {}
             @job_group_mutex = Mutex.new
@@ -3279,7 +3279,7 @@ def fx_names
           examples:      []
 
 
-      def load_synthdefs(path=synthdef_path)
+      def load_synthdefs(path=Paths.synthdef_path)
         path = File.expand_path(path)
         raise "No directory exists called #{path.inspect}" unless File.exist? path
         @mod_sound_studio.load_synthdefs(path)
diff --git a/app/server/ruby/lib/sonicpi/runtime.rb b/app/server/ruby/lib/sonicpi/runtime.rb
@@ -52,7 +52,7 @@ module RuntimeMethods
     ## Probably should be moved somewhere else
     @@stop_job_mutex = Mutex.new
 
-    def load_snippets(path=snippets_path, quiet=false)
+    def load_snippets(path=Paths.snippets_path, quiet=false)
       path = File.expand_path(path)
       Dir["#{path}/**/*.sps"].each do |p|
 
@@ -265,10 +265,10 @@ def __gui_heartbeat(id)
     end
 
     def __extract_git_hash
-      head_path = root_path + "/.git/HEAD"
+      head_path = Paths.root_path + "/.git/HEAD"
       if File.exist? head_path
         ref = File.readlines(head_path).first
-        ref_path = root_path + "/.git/" + ref[5..-1]
+        ref_path = Paths.root_path + "/.git/" + ref[5..-1]
         ref_path = ref_path.strip
         if File.exist? ref_path
           return File.readlines(ref_path).first
@@ -568,7 +568,7 @@ def __stop_other_jobs
     def __load_buffer(id)
       id = id.to_s
       raise "Aborting load: file name is blank" if  id.empty?
-      path = project_path + id + '.spi'
+      path = File.expand_path("#{Paths.project_path}/#{id}.spi")
       s = "# Welcome to Sonic Pi\n\n"
       if File.exist? path
         s = IO.read(path)
@@ -1408,7 +1408,7 @@ def initialize(ports, msg_queue, user_methods)
       @ports = ports
       @git_hash = __extract_git_hash
       gh_short = @git_hash ? "-#{@git_hash[0, 5]}" : ""
-      @settings = Config::Settings.new(system_cache_store_path)
+      @settings = Config::Settings.new(Paths.system_cache_store_path)
       # @scsynth_clobber_args = @audio_settings.scsynth_opts_override
       # @scsynth_opts = @audio_settings.scsynth_opts
       @version = Version.new(4, 0, 0, "beta1")
@@ -1495,7 +1495,7 @@ def initialize(ports, msg_queue, user_methods)
       @gui_heartbeats = {}
       @gui_last_heartbeat = nil
       begin
-        @gitsave = GitSave.new(project_path)
+        @gitsave = GitSave.new(Paths.project_path)
       rescue
         @gitsave = nil
       end
@@ -1507,7 +1507,7 @@ def initialize(ports, msg_queue, user_methods)
           event = @save_queue.pop
           id, content = *event
           filename = id + '.spi'
-          path = project_path + "/" + filename
+          path = File.expand_path("#{Paths.project_path}/#{filename}")
           content = filter_for_save(content)
           begin
             File.open(path, 'w') {|f| f.write(content) }
@@ -1527,11 +1527,11 @@ def initialize(ports, msg_queue, user_methods)
       __info "Initialised Erlang OSC Scheduler"
 
       if safe_mode?
-        __info "!!WARNING!! - file permissions issue:\n   Unable to write to folder #{home_dir_path} \n   Booting in SAFE MODE.\n   Buffer auto-saving is disabled, please save your work manually.", 1
+        __info "!!WARNING!! - file permissions issue:\n   Unable to write to folder #{Paths.home_dir_path} \n   Booting in SAFE MODE.\n   Buffer auto-saving is disabled, please save your work manually.", 1
       end
 
-      log "Unable to initialise git repo at #{project_path}" unless @gitsave
-      load_snippets(snippets_path, true)
+      log "Unable to initialise git repo at #{Paths.project_path}" unless @gitsave
+      load_snippets(Paths.snippets_path, true)
     end
 
     def __print_boot_messages
diff --git a/app/server/ruby/lib/sonicpi/samplebuffer.rb b/app/server/ruby/lib/sonicpi/samplebuffer.rb
@@ -102,7 +102,7 @@ def onset_data
           # [:minioi_ms]       12.0 (ms)
 
           begin
-            aubio_onsets_command = "\"#{aubio_onset_path}\" \"#{@path}\""
+            aubio_onsets_command = "\"#{Paths.aubio_onset_path}\" \"#{@path}\""
             onsets_str = `#{aubio_onsets_command}`
             onsets = onsets_str.split.map(&:to_f)
           rescue Exception => e
diff --git a/app/server/ruby/lib/sonicpi/server.rb b/app/server/ruby/lib/sonicpi/server.rb
@@ -109,7 +109,7 @@ def initialize(port, msg_queue, state, register_cue_event_lambda, current_spider
       add_event_oneshot_handler("/sonic-pi/server-info") do |payload|
         info_prom.deliver! payload
       end
-      load_synthdefs(synthdef_path)
+      load_synthdefs(Paths.synthdef_path)
       osc @osc_path_s_new, "sonic-pi-server-info", 1, 0, 0
       server_info = info_prom.get
       @scsynth_info = SonicPi::Core::SPMap.new({
diff --git a/app/server/ruby/lib/sonicpi/sox.rb b/app/server/ruby/lib/sonicpi/sox.rb
@@ -20,8 +20,8 @@ module Sox
 
     def self.info(path)
       # Some sox commands print out to std err?!
-      info_out, info_err = Open3.capture3("'#{sox_path}' --info '#{path}'")
-      stat_out, stat_err = Open3.capture3("'#{sox_path}' '#{path}' -n stat")
+      info_out, info_err = Open3.capture3("'#{Paths.sox_path}' --info '#{path}'")
+      stat_out, stat_err = Open3.capture3("'#{Paths.sox_path}' '#{path}' -n stat")
       res = {}
       (info_out.lines + info_err.lines + stat_out.lines + stat_err.lines).each do |l|
         m = l.match(/\A(.+?)\s*:\s+(.*)\Z/)
diff --git a/app/server/ruby/lib/sonicpi/studio.rb b/app/server/ruby/lib/sonicpi/studio.rb
@@ -69,7 +69,7 @@ def init_scsynth
     end
 
     def init_studio
-      @server.load_synthdefs(synthdef_path)
+      @server.load_synthdefs(Paths.synthdef_path)
       @amp = [0.0, 1.0]
       @server.add_event_handler("/sonic-pi/amp", "/sonic-pi/amp") do |payload|
         @amp = [payload[2], payload[3]]
@@ -84,7 +84,7 @@ def init_studio
       end
 
       # load rand stream directly - ensuring it doesn't get considered as a 'sample'
-      rand_buf = @server.buffer_alloc_read(buffers_path + "/rand-stream.wav")
+      rand_buf = @server.buffer_alloc_read(Paths.buffers_path + "/rand-stream.wav")
 
       @sample_sem.synchronize do
         @buffers = {}
@@ -141,7 +141,7 @@ def allocate_buffer(name, duration_in_seconds)
 
         # our buffer has the same name but is of a different duration
         # therefore nuke it
-        path = cached_samples_path + "/#{name}.wav"
+        path = Paths.cached_samples_path + "/#{name}.wav"
         # now actually allocate a new buffer and cache it
         sample_rate = @server.scsynth_info[:sample_rate]
         buffer_info = @server.buffer_alloc(duration_in_seconds * sample_rate, 2)
diff --git a/app/server/ruby/lib/sonicpi/util.rb b/app/server/ruby/lib/sonicpi/util.rb
diff --git a/app/server/ruby/paths.rb b/app/server/ruby/paths.rb
