mass 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YmUwMjYwZDZlOWNkOWZiNWJhMmI5YmEzNzcxZDhkNmQwYjI0ZjcwOQ==
+    YTIyODFiODNmNzVlMTMyNDg5ZDA4MTZkZTJjOTMxNGE2MmQwOWNmNw==
   data.tar.gz: !binary |-
-    Mjk4YjIxZjM1Yjg5ZTAzNzNjZTE5NTI3MzJiNTY3NDgxOTJiZmUzMg==
+    NGMxY2JkYTcwZGVkYjEyZDBkMzExMTQ4MGVkYmFjY2U5YzU4MzU4YQ==
 SHA512:
   metadata.gz: !binary |-
-    NjVlZmRmNzdjZTg1MWU0NTU3YmNmODUxNjQ5NGYyNDNjYTg5NDY3YmVlZmYz
-    MmNmODk3NjFmM2NlZWJlZWI1NWY3NmIzNWNiMGRhNDVhNWIxNjQwNTJiN2Jl
-    ZTg1MWNlOGVmZGQ5ZmJmMGVlZDU1MGFiNjAzMDg3M2M0MDY4NjU=
+    ZTY0ZjY4NmU5ODAyZmYyMjIyZTcxYjgyOGYwNjY0MGEyY2ViZjY4NWM0ZWRk
+    MTQ4OGEwNzhiN2FjNzBjNjliMDY2YzMzNmI5OWJiZDAyMzI2OWU0NjY5OGE1
+    MGQ5YzMxZDNkMmQ2NTk4YmY2Njc1MzE4Nzg5NzhiOWRlODg5NjQ=
   data.tar.gz: !binary |-
-    ZWFmYjhjODI3ODVkMGIyM2MyOGNmOWM2ZjVmYzdlODExNTAxN2Q3N2VlZjI3
-    MDMyYzk3ZjEwYzdiY2U0MDEwNmRmMWE1Y2Y4OTAxMDY0NmYzZGY1Mzg2Mjcy
-    OTc5NDVjZDFmMDQ2OWI5MjFkZDAzODlkYWU2YzZlZGVhM2VmZDM=
+    MTk0ODQ4M2RjMmJhODU1NjIzYmYwMmE0Mzk1M2M2Mzk3MmM5MGJiMjhjYWZm
+    MDllN2I2NTg4YWVkZTc0MWI3ZTA4YWE3NzhmOGE2MTNiMzQ1ZDA4N2NiYWI3
+    NTg1ZjM0MDgwMDJjYTI1MzczZWNlNzhkMmM2YzM4YmYxYjFmMjA=

data/README.md

@@ -41,10 +41,10 @@ include Mass
 
 bpm 128
 pattern bars: 4 do
-  note 4, pitch: 'c2'
-  note 4, pitch: 'c3'
-  note 4, pitch: 'c4'
-  note 4, pitch: 'c3'
+  note 4, pitch: 'C2'
+  note 4, pitch: 'C3'
+  note 4, pitch: 'C4'
+  note 4, pitch: 'C3'
 end
 ```
 
@@ -80,3 +80,8 @@ newly built `.gem` file to [RubyGems][gem]:
 ```bash
 $ bin/rake release
 ```
+
+[tubbo]: https://github.com/tubbo
+[rdoc]: http://www.rubydoc.info/github/tubbo/mass/master/frames
+[gem]: https://rubygems.org
+[mit]: https://github.com/tubbo/mass/blob/master/LICENSE.txt

data/lib/mass.rb

@@ -4,48 +4,11 @@ require 'mass/version'
 require 'mass/pitch'
 require 'mass/note'
 require 'mass/pattern'
+require 'mass/sequence'
 
 # A massive synth library.
 module Mass
-  class << self
-    # The current BPM of this track. Defaults to +100+.
-    #
-    # @return [Integer]
-    def current_bpm
-      @current_bpm ||= 100
-    end
-
-    # Change BPM of the track.
-    #
-    # @example
-    #   require 'mass'
-    #   include Mass
-    #
-    #   bpm 128
-    #
-    def bpm(new_bpm)
-      @current_bpm = new_bpm
-    end
-
-    # Create a pattern in Mass.
-    #
-    # @example
-    #   require 'mass'
-    #   include Mass
-    #
-    #   pattern name: 'verse', bars: 1 do
-    #     note 8, pitch: 'C4'
-    #     note 8, pitch: 'C3'
-    #     note 8, pitch: 'A3'
-    #     note 8, pitch: 'B4'
-    #     note 8, pitch: 'C4'
-    #     note 8, pitch: 'Gb2'
-    #     note 8, pitch: 'C4'
-    #     rest 8
-    #   end
-    #
-    def pattern(**params, &block)
-      Pattern.create(**params, &block)
-    end
+  def self.sequence(*args)
+    Sequence.define(*args)
   end
 end

data/lib/mass/note.rb

@@ -1,4 +1,5 @@
 require 'forwardable'
+require 'mass/pitch'
 
 module Mass
   # Represents a single note in the pattern.
@@ -49,6 +50,16 @@ module Mass
     # @attr_reader [Mass::Pitch]
     attr_reader :pitch
 
+    # Rhythmic duration value for this note.
+    #
+    # @attr_reader [Integer]
+    attr_reader :value
+
+    # BPM passed in from the sequence.
+    #
+    # @attr_reader [Integer]
+    attr_reader :bpm
+
     # Hex value for sending to +UniMIDI+ that signals when
     # this note should begin playing.
     #
@@ -65,18 +76,15 @@ module Mass
     # @param [String] pitch
     # @param [Symbol | Integer] exp - Can be expressed as either
     # @param [UniMIDI::Output] midi
-    def initialize(value: 1, pitch: nil, exp: :mp, midi: nil)
+    def initialize(value: 1, pitch: nil, exp: :mp, midi: nil, bpm: 100)
       @value = value
+      @name = pitch
       @pitch = Pitch.find pitch
       @expression = exp
       @midi = midi
+      @bpm = bpm
     end
 
-    # The given note name.
-    #
-    # @return [String]
-    def_delegator :pitch, :name, :id
-
     # This note as expressed in a MIDI pitch value.
     #
     # @return [Integer]
@@ -92,14 +100,20 @@ module Mass
     # The given duration value divided by the BPM of
     # the current song.
     def duration
-      value / Mass.current_bpm
+      vpm * 0.01
     end
 
     # Play the current note through the +UniMIDI+ output.
     def play
-      midi.puts ON, to_midi, to_velocity if pitch.present?
+      midi.puts ON, to_midi, to_velocity unless pitch.nil?
       sleep duration
-      midi.puts OFF, to_midi, to_velocity if pitch.present?
+      midi.puts OFF, to_midi, to_velocity unless pitch.nil?
+    end
+
+    private
+
+    def vpm
+      bpm / value
     end
   end
 end

data/lib/mass/pattern.rb

@@ -1,18 +1,22 @@
+require 'unimidi'
+require 'mass/note'
+
 module Mass
   # A single pattern written using the +Mass+ DSL. This is the
   # "collection"-style object which holds each +Note+ and plays
   # them in sequence, but has no control over their durations or
   # pitches.
   class Pattern
-    attr_reader :name, :bars, :notes
+    attr_reader :name, :bars, :notes, :sequence
 
     # @param [String] name
     # @param [Integer] bars
     # @param block
-    def initialize(name: '', bars: 4, &_block)
+    def initialize(name: '', bars: 4, sequence: nil)
       @name = name
       @bars = bars
       @notes = []
+      @sequence = sequence
       yield if block_given?
     end
 
@@ -21,9 +25,11 @@ module Mass
     # @param [String] name
     # @param [Integer] bars
     # @param block
-    def self.create(name: '', bars: 4, repeat: false, &block)
-      pattern = new(name: name, bars: bars, &block)
-      pattern.play! in_loop: repeat
+    def self.create(
+      name: '', bars: 4, repeat: false, sequence: nil, &block
+    )
+      pattern = new(name: name, bars: bars, sequence: sequence, &block)
+      pattern.play in_loop: repeat if pattern.notes.any?
       pattern
     end
 
@@ -31,9 +37,16 @@ module Mass
     # into it.
     #
     # @param [Boolean] in_loop - defaults to +false+.
-    def play!(in_loop: false)
-      _play_once unless in_loop
-      loop { _play_once }
+    def play(in_loop: false)
+      return _play_once unless in_loop
+      _play_in_loop
+    end
+
+    # Tests equivilance bases on name
+    #
+    # @return [Boolean] whether both patterns have the same name
+    def ==(other)
+      other.name == name
     end
 
     protected
@@ -53,7 +66,8 @@ module Mass
         value: value,
         pitch: pitch,
         exp: expression,
-        midi: _midi
+        midi: sequence._midi,
+        bpm: sequence._bpm
       )
     end
 
@@ -63,12 +77,12 @@ module Mass
 
     private
 
-    def _midi
-      @midi ||= UniMIDI::Output.gets
+    def _play_once
+      notes.all?(&:play)
     end
 
-    def _play_once
-      notes.map(&:play)
+    def _play_in_loop
+      loop { _play_once }
     end
   end
 end

data/lib/mass/pitch.rb

@@ -4,7 +4,10 @@ module Mass
   # calculating the proper duration and actually playing out
   # the note.
   class Pitch
-    attr_reader :id, :name, :value
+    attr_reader :id
+    attr_reader :name
+    attr_reader :octave
+    attr_reader :value
 
     # A dictionary of MIDI note values that are substituted
     # for a given String note value.
@@ -37,10 +40,10 @@ module Mass
     REQUIRED = %i(name octave value)
 
     # @param [String] id - Identifier string of this pitch.
-    def initialize(identifier)
-      @id = identifier.to_s
-      @name = id.gsub(/\d/, '').to_s
-      @octave = id.gsub(/#{name}/, '').to_i
+    def initialize(id: '')
+      @id = id.to_s
+      @name = @id.gsub(/\d/, '').to_s
+      @octave = @id.gsub(/#{name}/, '').to_i
       @value = begin
                  VALUES[name]
                rescue
@@ -50,12 +53,11 @@ module Mass
 
     # Find a +Pitch+ by its given +id+.
     #
+    # @param [String] by_id
     # @return [Pitch] when the id is valid
-    # @throw [Pitch::NotFound] when id is not valid
-    def self.find(id)
-      pitch = new(id)
-      fail NotFound, id unless pitch.valid?
-      pitch
+    def self.find(by_id = nil)
+      return if by_id.nil?
+      new id: by_id
     end
 
     # Make sure the +name+ and +octave+ attributes have
@@ -75,6 +77,13 @@ module Mass
       value + octave_modifier
     end
 
+    # Use the +id+ parameter to define equivalence.
+    #
+    # @return [Boolean] whether both pitches have the same ID.
+    def ==(other)
+      other.id == id
+    end
+
     private
 
     def required_params

data/lib/mass/sequence.rb

@@ -0,0 +1,70 @@
+module Mass
+  # A sequence of patterns that is played in order immediately
+  # as it is defined.
+  class Sequence
+    # Name of this sequence
+    #
+    # @attr_reader [String]
+    attr_reader :name
+
+    # Beats per minute speed of the sequence
+    #
+    # @attr_reader [Integer]
+    attr_reader :_bpm
+
+    # MIDI driver used to power all notes in the sequence.
+    #
+    # @attr_reader [UniMIDI::Output]
+    attr_reader :_midi
+
+    # @param [String] name
+    # @option [Integer] bpm - defaults to 100
+    def initialize(name, bpm: 100)
+      @name = name
+      @_bpm = bpm
+      @_midi ||= UniMIDI::Output.gets
+      yield if block_given?
+    end
+
+    # Define a new sequence into the global namespace
+    #
+    # @param [String] name
+    # @options [KeywordArguments] params
+    # @param [Proc] block
+    # @return [Mass::Sequence]
+    def self.define(name, **params, &block)
+      new name, **params, &block
+    end
+
+    # Change BPM.
+    #
+    # @param [Integer] new_bpm
+    # @example
+    #   bpm 128
+    #
+    def bpm(new_bpm)
+      @_bpm = new_bpm
+    end
+
+    # Create a pattern. See the docs on +Mass::Pattern+ for more
+    # information about its requirements.
+    #
+    # @options [KeywordArguments] params
+    # @options [Proc] block
+    # @example
+    #   pattern name: 'verse', bars: 1 do
+    #     note 8, pitch: 'C4'
+    #     note 8, pitch: 'C3'
+    #     note 8, pitch: 'A3'
+    #     note 8, pitch: 'B4'
+    #     note 8, pitch: 'C4'
+    #     note 8, pitch: 'Gb2'
+    #     note 8, pitch: 'C4'
+    #     rest 8
+    #   end
+    #
+    def pattern(**params, &block)
+      Pattern.create(**params.merge(sequence: self), &block)
+    end
+  end
+end

data/lib/mass/version.rb

@@ -3,5 +3,5 @@ module Mass
   # Version number
   #
   # @type [String]
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/mass.gemspec

@@ -28,5 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'travis', '~> 1.8'
   spec.add_development_dependency 'codeclimate-test-reporter', '~> 0'
 
-  spec.add_dependency 'unimidi'
+  spec.add_dependency 'unimidi', '~> 0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mass
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Tom Scott
@@ -98,14 +98,14 @@ dependencies:
   name: unimidi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0'
 description: Synth framework for Ruby. Build a cool synth!
@@ -143,7 +143,7 @@ files:
 - lib/mass/note.rb
 - lib/mass/pattern.rb
 - lib/mass/pitch.rb
-- lib/mass/pitch/not_found.rb
+- lib/mass/sequence.rb
 - lib/mass/version.rb
 - mass.gemspec
 homepage: https://github.com/tubbo/mass

data/lib/mass/pitch/not_found.rb

@@ -1,10 +0,0 @@
-module Mass
-  class Pitch
-    # Thrown when a +Pitch+ cannot be found, e.g. it is not valid.
-    class NotFound < RuntimeError
-      def initialize(name)
-        @message = "Invalid pitch '#{name}'"
-      end
-    end
-  end
-end