head_music 0.28.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ea2efb7d874b85dd67a1838102d76409ce6a1bf9989707af68ad4909eccc9e5
-  data.tar.gz: c45d1a2683f49adcadb70a0eb29965ad7af7e5fd9f1ec6966c1daacacb1ade95
+  metadata.gz: f33a752be0b413a020045e15277d598f679a99e8a02cff2e90d7678a8def945e
+  data.tar.gz: 69f384290299e50524c717f71baa2fa4760468553ef4b603c0303ddb75d364e0
 SHA512:
-  metadata.gz: '087c6dc3413b35fd1c1b4cb729630bb2c11b2497a5506aa1a7168df15878cce5732e831f04f165dcee32891b06c31d456bd08a758ba83ffc1e428882b7ac9970'
-  data.tar.gz: 23122c1670d39472bd93059b350520697f31abd5b2738b2738e07079b72abe3c44065d7d74a38568111399f3a646cc78264304c262e6501815f8dab478795773
+  metadata.gz: 9fa8bd4a2eae4959cd980a8865f88a367b2781df9836357b34b91f0d79cd6970dc71389f5e29c8b1b72cd0c68d633721da4a4e189bb8210193c41c12cc20bc0c
+  data.tar.gz: 9f953d75afacaccc35e8a688eeff8606ec854600281fb6636e44ed3fcd3155afefc5eb4ecf13a53a97b0facaf4e32d516b32c690b3d5653fa596dac2096ca914

data/.rubocop.yml

@@ -14,3 +14,16 @@ AllCops:
 
 RSpec:
   Enabled: true
+
+RSpec/ContextWording:
+  Prefixes:
+    - when
+    - with
+    - without
+    - given
+    - and
+    - for
+    - by
+
+RSpec/NestedGroups:
+  Max: 4

data/lib/head_music/content/bar.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+# A module for musical content
+module HeadMusic::Content; end
+
 # Representation of a bar in a composition
 # Encapsulates meter and key signature changes
-class HeadMusic::Bar
+class HeadMusic::Content::Bar
   attr_reader :composition
   attr_accessor :key_signature, :meter
 

data/lib/head_music/content/composition.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+# A module for musical content
+module HeadMusic::Content; end
+
 # A composition is musical content.
-class HeadMusic::Composition
+class HeadMusic::Content::Composition
   attr_reader :name, :key_signature, :meter, :voices
 
   def initialize(name: nil, key_signature: nil, meter: nil)
@@ -10,7 +13,7 @@ class HeadMusic::Composition
   end
 
   def add_voice(role: nil)
-    @voices << HeadMusic::Voice.new(composition: self, role: role)
+    @voices << HeadMusic::Content::Voice.new(composition: self, role: role)
     @voices.last
   end
 
@@ -27,7 +30,7 @@ class HeadMusic::Composition
   def bars(last = latest_bar_number)
     @bars ||= []
     (earliest_bar_number..last).each do |bar_number|
-      @bars[bar_number] ||= HeadMusic::Bar.new(self)
+      @bars[bar_number] ||= HeadMusic::Content::Bar.new(self)
     end
     @bars[earliest_bar_number..last]
   end

data/lib/head_music/content/note.rb

@@ -1,22 +1,25 @@
 # frozen_string_literal: true
 
+# A module for musical content
+module HeadMusic::Content; end
+
 # A note is a pitch with a duration.
 #
 # Note quacks like a placement, but requires a different set of construction arguments
 #   - always has a pitch
 #   - receives a voice and position if unspecified
-class HeadMusic::Note
+class HeadMusic::Content::Note
   attr_accessor :pitch, :rhythmic_value, :voice, :position
 
   def initialize(pitch, rhythmic_value, voice = nil, position = nil)
     @pitch = HeadMusic::Pitch.get(pitch)
-    @rhythmic_value = HeadMusic::RhythmicValue.get(rhythmic_value)
-    @voice = voice || HeadMusic::Voice.new
-    @position = position || HeadMusic::Position.new(@voice.composition, "1:1")
+    @rhythmic_value = HeadMusic::Content::RhythmicValue.get(rhythmic_value)
+    @voice = voice || HeadMusic::Content::Voice.new
+    @position = position || HeadMusic::Content::Position.new(@voice.composition, "1:1")
   end
 
   def placement
-    @placement ||= HeadMusic::Placement.new(voice, position, rhythmic_value, pitch)
+    @placement ||= HeadMusic::Content::Placement.new(voice, position, rhythmic_value, pitch)
   end
 
   def to_s

data/lib/head_music/content/placement.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+# A module for musical content
+module HeadMusic::Content; end
+
 # A placement is a note or rest at a position within a voice in a composition
-class HeadMusic::Placement
+class HeadMusic::Content::Placement
   include Comparable
 
   attr_reader :voice, :position, :rhythmic_value, :pitch
@@ -54,15 +57,15 @@ class HeadMusic::Placement
   def ensure_attributes(voice, position, rhythmic_value, pitch)
     @voice = voice
     ensure_position(position)
-    @rhythmic_value = HeadMusic::RhythmicValue.get(rhythmic_value)
+    @rhythmic_value = HeadMusic::Content::RhythmicValue.get(rhythmic_value)
     @pitch = HeadMusic::Pitch.get(pitch)
   end
 
   def ensure_position(position)
-    @position = if position.is_a?(HeadMusic::Position)
+    @position = if position.is_a?(HeadMusic::Content::Position)
       position
     else
-      HeadMusic::Position.new(composition, position)
+      HeadMusic::Content::Position.new(composition, position)
     end
   end
 end

data/lib/head_music/content/position.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+# A module for musical content
+module HeadMusic::Content; end
+
 # A position is a moment in time within the rhythmic framework of a composition.
-class HeadMusic::Position
+class HeadMusic::Content::Position
   include Comparable
 
   attr_reader :composition, :bar_number, :count, :tick
@@ -56,7 +59,7 @@ class HeadMusic::Position
   end
 
   def +(other)
-    other = HeadMusic::RhythmicValue.new(other) if [HeadMusic::RhythmicUnit, Symbol, String].include?(other.class)
+    other = HeadMusic::Content::RhythmicValue.new(other) if [HeadMusic::RhythmicUnit, Symbol, String].include?(other.class)
     self.class.new(composition, bar_number, count, tick + other.ticks)
   end
 

data/lib/head_music/content/rhythmic_value.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+# A module for musical content
+module HeadMusic::Content; end
+
 # A rhythmic value is a duration composed of a rhythmic unit, any number of dots, and a tied value.
-class HeadMusic::RhythmicValue
+class HeadMusic::Content::RhythmicValue
   attr_reader :unit, :dots, :tied_value
 
   delegate :name, to: :unit, prefix: true
@@ -9,7 +12,7 @@ class HeadMusic::RhythmicValue
 
   def self.get(identifier)
     case identifier
-    when HeadMusic::RhythmicValue
+    when HeadMusic::Content::RhythmicValue
       identifier
     when HeadMusic::RhythmicUnit
       new(identifier)

data/lib/head_music/content/voice.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
+# A module for musical content
+module HeadMusic::Content; end
+
 # A Voice is a stream of music with some indepedence that is conceptually one part or for one performer.
 # The melodic lines in counterpoint are each a voice.
-class HeadMusic::Voice
+class HeadMusic::Content::Voice
   include Comparable
 
   attr_reader :composition, :placements, :role
@@ -10,13 +13,13 @@ class HeadMusic::Voice
   delegate :key_signature, to: :composition
 
   def initialize(composition: nil, role: nil)
-    @composition = composition || HeadMusic::Composition.new
+    @composition = composition || HeadMusic::Content::Composition.new
     @role = role
     @placements = []
   end
 
   def place(position, rhythmic_value, pitch = nil)
-    HeadMusic::Placement.new(self, position, rhythmic_value, pitch).tap do |placement|
+    HeadMusic::Content::Placement.new(self, position, rhythmic_value, pitch).tap do |placement|
       insert_into_placements(placement)
     end
   end

data/lib/head_music/harmonic_interval.rb

@@ -7,7 +7,7 @@ class HeadMusic::HarmonicInterval
   def initialize(voice1, voice2, position)
     @voice1 = voice1
     @voice2 = voice2
-    @position = position.is_a?(String) ? HeadMusic::Position.new(voice1.composition, position) : position
+    @position = position.is_a?(String) ? HeadMusic::Content::Position.new(voice1.composition, position) : position
   end
 
   def diatonic_interval

data/lib/head_music/meter.rb

@@ -82,9 +82,9 @@ class HeadMusic::Meter
   def beat_unit
     @beat_unit ||=
       if compound?
-        HeadMusic::RhythmicValue.new(HeadMusic::RhythmicUnit.for_denominator_value(bottom_number / 2), dots: 1)
+        HeadMusic::Content::RhythmicValue.new(HeadMusic::RhythmicUnit.for_denominator_value(bottom_number / 2), dots: 1)
       else
-        HeadMusic::RhythmicValue.new(count_unit)
+        HeadMusic::Content::RhythmicValue.new(count_unit)
       end
   end
 

data/lib/head_music/style/guidelines/at_least_eight_notes.rb

@@ -17,8 +17,8 @@ class HeadMusic::Style::Guidelines::AtLeastEightNotes < HeadMusic::Style::Annota
 
   def no_placements_mark
     HeadMusic::Style::Mark.new(
-      HeadMusic::Position.new(composition, "1:1"),
-      HeadMusic::Position.new(composition, "2:1"),
+      HeadMusic::Content::Position.new(composition, "1:1"),
+      HeadMusic::Content::Position.new(composition, "2:1"),
       fitness: 0
     )
   end

data/lib/head_music/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HeadMusic
-  VERSION = "0.28.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: head_music
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rob Head