rhythmruby 0.1.1 → 0.1.2

data/README.md

@@ -1,9 +1,11 @@
 RhythmRuby: Midi rhythms through String manipulation 
 ====================================================
 
-**Author**:         Luuk van der Velden, (Amsterdam, 2013)                                                                         
-**Website**:                                                                                                                      
+**Author**:         Luuk van der Velden, (Amsterdam, 2013)                                                                           
+**Website**:       http://rubygems.org/gems/rhythmruby                                                                               
 **Git**:            https://github.com/Lvelden/rhythmruby.git                                                                        
+**Docs**:           http://rubydoc.info/gems/rhythmruby/0.1.2/frames                                                                 
+**Dependency**:    midilib by Jim Menard                                                                                            
 
 Synopsis
 --------
@@ -26,18 +28,19 @@ StringCompiler Class allows the creation of rhythm snippets and compiles them in
 These snippets capture the repetitive aspects of most rhythms.
 
 **3. countBase** is the rhythmical length that is assigned to one symbol in a string.
-It is measured in quartenote lengths (relative to bpm), thus countBase: 1.0, means one quarter note per symbol. 
+It is measured in quarter note lengths (relative to bpm), thus countBase: 1.0, means one quarter note per symbol. 
 
 Classes
 -------
 The **RhythmCompiler** (class) generates rhythm snippets and combines these into rhythm strings.
+**LogicalRhythms** (class) allows logical interaction between different rhythm strings.
 These can be parsed to MIDI ready data by the **RhythmParser** (class).
 The parsed output can be written to a MIDI file by the **MidiWriter** (class instance). 
 
 Examples and Docs
 -----------------
 
-Check out the examples provided and the documentation based on YARD. The examples are aimed at 
+Check out the examples provided and the documentation. The examples are aimed at 
 creating single and multi instrument rhythms. For instance **Meshuggah_example.rb** explains the creation of the
 intro rhythm of 'Perpetual Black Second' by Meshuggah (Nothing, 2002), using ruby scripting.
 
@@ -73,7 +76,7 @@ pmidi. pmidi can send the MIDI events to any ALSA channel f.i. the MIDI-in of th
 is a nice drum sampler and sequencer. In this way you can listen to the rhythms you create without leaving your
 IDE or editor.
 
-Rational
+Rationale
 --------
 
 RhythmRuby's strength lies in the rhythm string abstraction. It allows easy computer

data/lib/rhythmruby.rb

@@ -1,5 +1,6 @@
-# main file to load seperate class files
+# main file to load separate class files
 
 require "rhythmruby/RhythmParser"
 require "rhythmruby/RhythmCompiler"
 require "rhythmruby/MidiWriter"  
+require "rhythmruby/LogicalRhythms"

data/lib/rhythmruby/LogicalRhythms.rb

@@ -0,0 +1,76 @@
+class LogicalRhythms
+  @@eventMarker = '#' # symbol which denotes event or hit
+  @@silenceMarker = '-' # symbol that denotes silence
+  
+  # logical exlusion of two rhythms, removes events from slave simultaneous
+  # with an event in the master rhythm
+  # @param [String] masterRhythm rhythm to intersect with
+  # @param [String] slaveRhythm rhythm to intersect
+  # @return [String] intersected slaveRhythm
+  def self.Exclusion(masterRhythm, slaveRhythm)
+    masterRhythm.split("").zip(slaveRhythm.split("")).each_with_index do
+      |symbols, index|
+      master,slave = symbols
+      if master == @@eventMarker && slave == @@eventMarker # if both have an event
+        slaveRhythm[index] = @@silenceMarker # replace event with silence
+      end
+    end
+    return slaveRhythm
+  end  
+
+  # logical XOR of two rhythms, true except both true
+  # @param [String] masterRhythm rhythm to intersect with
+  # @param [String] slaveRhythm rhythm to intersect
+  # @return [String] intersected slaveRhythm
+  def self.XOR(rhythmA, rhythmB)
+    resultRhythm = ""
+    rhythmA.split("").zip(rhythmB.split("")).each do
+      |symA, symB|
+      if symA == @@eventMarker && symB == @@eventMarker # if both have an event
+        resultRhythm += @@silenceMarker # replace event with silence
+      elsif symA == @@eventMarker or symB == @@eventMarker
+        resultRhythm += @@eventMarker
+      else
+        resultRhythm += @@silenceMarker
+      end
+    end
+    return resultRhythm
+  end  
+  
+  # logical OR of two rhythms, thus event in result rhythm, when at least one
+  # of two original rhythms has an event (functionally the same as addition)
+  # @param [String] rhythmA, one of the rhythms to or
+  # @param [String] rhythmB, one of the rhythms to or
+  # @return [String] resultRhyhtm, result of logical or 
+  def self.OR(rhythmA, rhythmB)
+    resultRhythm = ""
+        
+    rhythmA.split("").zip(rhythmB.split("")).each do
+      |symA, symB|
+      if symA == @@eventMarker or symB == @@eventMarker
+        resultRhythm += @@eventMarker
+      else
+        resultRhythm += @@silenceMarker
+      end
+    end
+    return resultRhythm    
+  end
+  
+  #  logical AND of two rhythms, returns only events present in both rhythms
+  # @param [String] rhythmA, one of the rhythms to and
+  # @param [String] rhythmB, one of the rhythms to and
+  # @return [String] resultRhythm, result of logical and
+  def self.AND(rhythmA, rhythmB)
+    resultRhythm = ""
+    rhythmA.split("").zip(rhythmB.split("")).each do
+      |symA, symB|
+      if symA == @@eventMarker and symB == @@eventMarker
+        resultRhythm += @@eventMarker
+       else
+         resultRhythm += @@silenceMarker       
+      end
+    end
+    return resultRhythm
+  end
+ 
+end

data/lib/rhythmruby/version.rb

@@ -1,3 +1,3 @@
 module Rhythmruby
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rhythmruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-06 00:00:00.000000000 Z
+date: 2013-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: midilib
@@ -44,6 +44,7 @@ files:
 - examples/drum_kit_example.rb
 - examples/single_rhythm_example.rb
 - lib/rhythmruby.rb
+- lib/rhythmruby/LogicalRhythms.rb
 - lib/rhythmruby/MidiWriter.rb
 - lib/rhythmruby/RhythmCompiler.rb
 - lib/rhythmruby/RhythmParser.rb