step_sequencer 1.0.9 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67affdea7861f5d586e34a4f50684dff3f74bbfa
-  data.tar.gz: 9813101ea22693d209eab0e7b1ff9ccb7ca966ee
+  metadata.gz: a1a99a39b5af66339839e11d3bfeba26a8ed4e90
+  data.tar.gz: a87451ab93c254931775e24a6e6f67504c5293e8
 SHA512:
-  metadata.gz: b2f3ffbad7e5e899e5e4f89d2b2c51cd8c5f9496acce582eea2c2c0120baba8beb6c82a719c74e990f723120f0752e4820d6aa061c88ae8743a8eeadaf0aa1e4
-  data.tar.gz: 627ae1c677444aa8ad8933a4d3c44f8ef9914769a471de7d439782be5e2caa0e3752c68bfe6e14b672ad136d705572e2775e1677fcaeffd47f616ae81e0036c6
+  metadata.gz: d1e463dcc91df228ad719392a574ef81f0beb2fb51d0d9ba21a4b3ea33925be0155c49d9af5b204c5768be3151c58cf072efbd31a102a205b0af550216621a37
+  data.tar.gz: 8f7d39fbcb03d282d1708fb4881813fbaaa12b53b310375e87b44a033708f834320ee1d5dc0058cbea1ca30f66353d5e193d5a8838673b9cd4306bfa93dd45e1

data/lib/step_sequencer/repl.rb

@@ -3,12 +3,151 @@ class StepSequencer::REPL
   # Makes all the instance methods of Helpers available to REPL
   # The binding.pry here is not a remnant of bug-hunting,
   # this is how the REPL starts
-  def self.start
-    self::Helpers.new.instance_exec { binding.pry }
+  def self.run
+    self::Helpers.new.instance_exec do
+      docs
+      Pry.start(self)
+    end
   end
 
   class Helpers
-    # todo
+
+    HelpSections = {
+      play: "
+        Usage: play #{"\"<path>\"".blue}
+        - plays the file in its own thread using mpg123
+        - hides the output
+      ",
+      combine: "
+        Usage: combine #{"\"[<paths>]\"".blue}
+        - note that this combines them sequentially.
+          for concurrent playback, use overlay
+        - returns a single path.
+      ",
+      gain: "
+        Usage: gain #{"\"<path>\"".blue}, #{"<value>".blue}
+        - <value> is a float, e.g. 0.5 for half and 2.0 for double
+        - returns a single path
+      ",
+      loop: "
+        Usage: loop #{"\"<path>\"".blue}, #{"<num_times>".blue}
+        - <num_times> can be a int or a float. if it's a float, then the last
+          loop will include only part of the original sample.
+        - returns a single path
+
+      ",
+      overlay: "
+        Usage: overlay #{"\"[<paths>]\"".blue}
+        - combines files so they play on top of one another
+        - returns a single path
+      ",
+      pitch: "
+        Usage: pitch #{"\"<path>\"".blue}, #{"<value>".blue}, #{"<speed_correct>".blue}
+        - <value> here is a integer/float, e.g. 0.5 for half and 2.0 for double.
+        - <speed_correct> defaults to true. It will prevent the pitch shift from
+          changing the speed.
+        - returns a single path
+      ",
+      scale: "
+        Usage: scale #{"\"<path>\"".blue}, #{"<inverse>".blue}
+        - This will generate 12 notes of the equal temperament tuning
+        - <inverse> defaults to false. If true then the generated notes will
+          be downtuned from the original (descending).
+      ",
+      slice: "
+        Usage: slice #{"\"<path>\"".blue} #{"<start>".blue} #{"<end>".blue}
+        - <start> and <end> are floats referring to a number of seconds.
+          Providing values of 2.0 and 3.5 would create a 1.5 second slice
+        - returns a single path
+      ",
+      speed: "
+        Usage: speed #{"\"<path>\"".blue} #{"<value>".blue}
+        - <value> is a integer/float, e.g. 0.5 for half and 2.0 for double
+        - returns a single path
+      "
+    }
+
+    def docs(section=nil)
+      section = section.to_sym if section
+      if section && (doc = self.class::HelpSections[section])
+        puts HelpSections[section]
+      elsif section
+        puts "
+          docs section #{section} not found.
+          Enter #{"docs".blue} to see a list of sections
+        ".red
+      else
+        puts "
+          StepSequencer
+          #{"================"}
+
+          Usage: docs #{"\"command\"".blue}
+          where #{"command".blue} is one of:
+          #{self.class::HelpSections.keys.join(", ")}
+        "
+      end
+    end
+
+    def builder
+      StepSequencer::SoundBuilder
+    end
+
+    def combine(paths)
+      builder.build(
+        sources: paths, effect: :Combine
+      )
+    end
+
+    def gain(path, val)
+      builder.build(
+        sources: [path], effect: :Gain, args: [value: val]
+      )[0]
+    end
+
+    def loop(path, times)
+      builder.build(
+        sources: [path], effect: :Loop, args: [times: val]
+      )[0]
+    end
+
+    def overlay(paths)
+      builder.build(
+        sources: paths, effect: :Overlay
+      )
+    end
+
+    def pitch(path, val, speed_correct=true)
+      builder.build(
+        sources: [path], effect: :Pitch,
+        args: [{times: val, speed_correction: speed_correct}]
+      )[0]
+    end
+
+    def scale(path, inverse)
+      builder.build(
+        sources: [path], effect: :Scale,
+        args: [{scale: :equal_temperament, inverse: inverse}]
+      )[0]
+    end
+
+    def slice(path, start_time, end_time)
+      builder.build(
+        sources: [path], effect: :Slice,
+        args: [{start_time: start_time, end_time: end_time}]
+      )[0]
+    end
+
+    def speed(path, val)
+      builder.build(
+        sources: [path], effect: :Speed,
+        args: [{value: val}]
+      )[0]
+    end
+
+    def play(path)
+      Thread.new { `mpg123 #{path} 2> /dev/null` }
+    end
+
   end
 
 end

data/lib/step_sequencer/sound_builder/default_effects/combine.rb

@@ -16,7 +16,7 @@ class StepSequencer::SoundBuilder::DefaultEffects::Combine < protocol
   # `sox #{sources.join(" ")} #{outfile}`
 
   class << self
-    private
+    public
     def generate_outfile_path(sources)
       "#{output_dir}/#{SecureRandom.urlsafe_base64}.mp3"
     end

data/lib/step_sequencer/sound_builder/default_effects/gain.rb

@@ -11,7 +11,7 @@ class StepSequencer::SoundBuilder::DefaultEffects::Gain < protocol
   end
 
   class << self
-    private
+    public
     def build_outfile_path path, value
       "#{output_dir}/#{SecureRandom.urlsafe_base64}.mp3"
     end

data/lib/step_sequencer/sound_builder/default_effects/loop.rb

@@ -13,7 +13,7 @@ class StepSequencer::SoundBuilder::DefaultEffects::Loop < protocol
   end
 
   class << self
-    private
+    public
     def build_outfile_path
       "#{output_dir}/#{SecureRandom.urlsafe_base64}.mp3"
     end

data/lib/step_sequencer/sound_builder/default_effects/overlay.rb

@@ -15,7 +15,7 @@ class StepSequencer::SoundBuilder::DefaultEffects::Overlay < protocol
   end
 
   class << self
-    private
+    public
     def build_outfile_path
       "#{output_dir}/#{SecureRandom.urlsafe_base64}.mp3"
     end

data/lib/step_sequencer/sound_builder/default_effects/pitch.rb

@@ -23,7 +23,7 @@ class StepSequencer::SoundBuilder::DefaultEffects::Pitch < protocol
   end
 
   class << self
-    private
+    public
     def build_outfile_name(source, value)
       "#{output_dir}/#{SecureRandom.urlsafe_base64}.mp3"
     end

data/lib/step_sequencer/sound_builder/default_effects/slice.rb

@@ -15,7 +15,7 @@ class StepSequencer::SoundBuilder::DefaultEffects::Slice < protocol
   end
 
   class << self
-    private
+    public
     def build_outfile_path
       "#{output_dir}/#{SecureRandom.urlsafe_base64}.mp3"
     end

data/lib/step_sequencer/sound_builder/default_effects/speed.rb

@@ -11,7 +11,7 @@ class StepSequencer::SoundBuilder::DefaultEffects::Speed < protocol
   end
 
   class << self
-    private
+    public
     def build_outfile_path path, value
       "#{output_dir}/#{SecureRandom.urlsafe_base64}.mp3"
     end

data/lib/step_sequencer/sound_builder/effects_component_protocol.rb

@@ -10,7 +10,7 @@ class StepSequencer::SoundBuilder::EffectsComponentProtocol
 
   class << self
     
-    private
+    public
 
     # Helper method to call other effects
     def builder

data/lib/step_sequencer/sound_builder.rb

@@ -18,7 +18,7 @@ class StepSequencer::SoundBuilder
   end
 
   class << self
-    private
+    public
     def effects_components
       StepSequencer::SoundBuilder::EffectsComponents
     end

data/lib/step_sequencer/sound_player.rb

@@ -42,7 +42,7 @@ class StepSequencer::SoundPlayer
     @limit = nil # an upper limit for steps_played, defaults to no limit
   end
 
-  private
+  public
 
   def build_matrix_from_string(string)
     string.tr(" ", '').gsub(/\#.+$/, '').split("\n").map(&:chars).map do |chars|

data/lib/step_sequencer/tests.rb

@@ -1,7 +1,7 @@
 # =============================================================================
 # A custom test runner. The tests themselves are in test_cases.rb
 # Usage: StepSequencer::Tests.run
-# The private method run_test_collection can also be used; it's more modular.
+# The public method run_test_collection can also be used; it's more modular.
 # =============================================================================
 
 class StepSequencer::Tests
@@ -24,13 +24,13 @@ class StepSequencer::Tests
   # shared 'around' hook for tests
   def self.run_test_case(test_class, fn_name, test_case)
     speak_fn_name fn_name
-    puts fn_name
+    puts fn_name.yellow
     test_class.method(fn_name).source.display
     test_case.call
   end
 
   class << self
-    private
+    public
 
     def builder_tests
       StepSequencer::Tests::TestCases::Builder
@@ -86,7 +86,7 @@ class StepSequencer::Tests
 
   # Helpers made available to test cases (if they include the module)
   module TestCaseHelpers
-    private
+    public
     def asset_path(name)
       Gem.find_files("step_sequencer/test_assets/#{name}.mp3")[0]
     end

data/lib/step_sequencer.rb

@@ -2,6 +2,7 @@ require 'securerandom'
 require 'pry'
 require 'espeak'
 require 'method_source'
+require 'colored'
 
 Thread.abort_on_exception = true
 

data/lib/version.rb

@@ -1,4 +1,4 @@
 module StepSequencer
-  VERSION = '1.0.9'
+  VERSION = '1.1.0'
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: step_sequencer
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.1.0
 platform: ruby
 authors:
 - max pleaner
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: ''
 email: maxpleaner@gmail.com
 executables: