euclidean_sequencer 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 053bb9f403f5cd1d59f741481089e2a5eedbd9dd36fe36189aa9bf091daaae48
+  data.tar.gz: e3d899f5b7a330ea914f4901d8ca0a4b3a17e6b2b1fe09953c014cbb7c28c667
+SHA512:
+  metadata.gz: 2ba12fc5f791f382d0d2e75a3505daa6366fa45d915410265fc9aa5e8b8ceca6619c1f34ab4575201f3ad580d9ace66bb4c1f0930377f47cdef1dc1aa12c9107
+  data.tar.gz: 3628217ac93721fcb5f20268594b2ced2621c0deb25b6f79b92f2926829dcc3ef3ee4c6315437d1fe7ea2179a8706ec3bb641f6a5a205a440c964d8f2fb9fb23

data/.envrc

@@ -0,0 +1,3 @@
+PATH_add bin
+
+export RUBYGEM_USERNAME='Mattbot'

data/.envrc.example

@@ -0,0 +1,4 @@
+PATH_add bin
+
+export RUBYGEM_USERNAME='your username here'
+export VERSION='x.x.x'

data/.gitignore

@@ -0,0 +1,8 @@
+.envrc
+.DS_Store
+.git
+
+/.bundle/
+
+# No Gem builds:
+euclidean_sequencer-*.gem

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at matt@goodguide.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+git_source(:gitlab) {|repo_name| "https://gitlab.com/#{repo_name}" }
+
+gem 'guard-rspec', require: false
+gem 'rspec'
+
+
+
+# Specify your gem's dependencies in euclidean_sequencer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    euclidean_sequencer (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.23)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  euclidean_sequencer!
+  guard-rspec
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.16.1

data/Guardfile

@@ -0,0 +1,48 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Euclidean Sequencer files
+  watch(%r{^(.+)\.rb$})
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})
+  watch(%r{^lib/euclidean_sequencer(.+)\.rb$})
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Euclidean Sequencer
+
+by Matt Ridenour (mattridenour@gmail.com)
+Created on Sun Oct 26 2008 (Updated at Wed May 2 2018)
+
+A class for spaceing a number of ones over a range of zeros as evenly as possible using the Euclidean algorithm.
+
+For more information on using the Euclidean algorithm in the context of music, please read:
+[The Euclidean Algorithm Generates Traditional Musical Rhythms by Godfried Toussaint][toussaint].
+
+Special thanks to Wesen for bringing Euclidean sequencing to my attention and [forging the way using Lisp][wesen].
+
+## Usage:
+
+Command Line:
+```bash
+$> ./bin/euclidean_sequence --help
+```
+Ruby:
+```ruby
+require "./lib/sequencer.rb"
+pulses = 8
+hits = 5
+p Sequencer.generate(hits: hits ,pulses: pulses, options: {array: true, offset: 2})
+```
+
+Oontz!
+
+## License
+[MIT][mit]
+]
+## Code of Conduct
+[Code of Conduct][code_of_conduct]
+
+[code_of_conduct]: CODE_OF_CONDUCT.md
+[mit]: LICENSE.txt
+[toussaint]: http://cgm.cs.mcgill.ca/~godfried/publications/banff.pdf
+[wesen]: http://ruinwesen.com/blog?id=216
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/build_and_push_gem

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+username = ENV.fetch("RUBYGEM_USERNAME")
+gemfile_path = './euclidean_sequencer.gemspec'
+gem = Gem::Specification.load(gemfile_path)
+
+# Login to Rubygems.org:
+login = `gem signin; echo $?`.chop.to_i
+unless login == 0
+  p `curl -u #{username} https://rubygems.org/api/v1/api_key.yaml > \
+  ~/.gem/credentials; \
+  chmod 0600 ~/.gem/credentials`
+end
+
+# Delete old builds:
+`rm -rf euclidean_sequencer-*.gem`
+
+# Build gem:
+build_result = `gem build ./euclidean_sequencer.gemspec`
+printf("%s", build_result)
+
+# Yank old gem:
+# yank_result =`gem yank euclidean_sequencer`
+# printf("%s", yank_result)
+
+# Push gem:
+push_result =`gem push ./euclidean_sequencer-#{gem.version}.gem`
+printf("%s", push_result)
+
+
+
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "euclidean_sequencer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/euclidean_sequencer

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'pathname'
+require './lib/euclidean_sequencer/parser.rb'
+require './lib/euclidean_sequencer/sequencer.rb'
+
+load Pathname.new(__FILE__).dirname.parent.join('lib/sequencer.rb')
+
+options = Parser.parse(ARGV)
+sequence = Sequencer.generate(hits: options[:hits], pulses: options[:pulses], options: options)
+
+printf("%s", sequence)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/euclidean_sequencer.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |spec|
+  spec.name        = 'euclidean_sequencer'
+  spec.version     = '0.0.2'
+  spec.date        = '2018-05-04'
+  spec.summary     = "Generates sequences of hits spaced as evenly as possible \
+    across given pulses."
+  spec.description = "Generates sequences of hits spaced as evenly as possible \
+    across given pulses using the Euclidean algorithm."
+  spec.authors     = ["Matt Ridenour"]
+  spec.email       = 'mattridenour@gmail.com'
+  spec.homepage    = 'https://gitlab.com/Mattbot/gem-euclidean-sequencer'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/euclidean_sequencer/engine.rb

@@ -0,0 +1,88 @@
+class Engine
+  # The magickal euclidean algorithmical engine!
+
+  def self.run(hits:, pulses:)
+    euclid(hits, pulses)
+  end
+
+  private
+
+  def self.euclid(hits, pulses, sequence = nil)
+    # Contruct the sequence if new otherwise continue with current sequence:
+    sequence ||= generate_sequence(hits, pulses)
+
+    # Determine if the algorithm has concluded or another iteration is neccessy:
+    return sequence.sum('') if hits == 0
+
+    # Count the sequence element types (remainder or denominator) for distribution:
+    remainder, denominator = find_remainder_and_denominator(sequence)
+
+    # Determine how many sets of zeros can be nabbed from the pulses at a time,
+    # insuring all the zeros get used up before the algorithm ends.
+    zero_sets = find_zero_sets(hits, pulses, remainder, denominator, sequence.length)
+
+    # Distribute the remainder into the denominator and pop the unnecessary elements:
+    sequence = distribute_and_pop_sequence(sequence, zero_sets, remainder, denominator)
+
+    # Recursion:
+    return euclid(pulses % hits, hits, sequence)
+  end
+
+  def self.generate_sequence(hits, pulses)
+    sequence = []
+    pulses.times {|pulse| sequence[pulse] = "0"}
+    hits.times { |hit| sequence[hit] = "1" }
+    sequence
+  end
+
+  def self.find_remainder_and_denominator(sequence)
+  remainder, denominator = [0,0]
+   sequence.each do |element|
+      if element == sequence.last
+        remainder = remainder + 1
+      else
+        denominator = denominator + 1
+      end
+    end
+    [remainder,denominator]
+  end
+
+  def self.find_zero_sets(hits, pulses, remainder, denominator, sequence_length)
+    if pulses > hits * 2
+      # Must avoid division by zero:
+      unless hits == 0
+        if denominator == 0
+          zero_sets = 1
+        else
+          # Grab as many zeros as possible:
+          zero_sets = remainder / denominator
+        end
+        # But don't grab as many zeros as impossible:
+        if zero_sets > sequence_length
+          zero_sets = 0
+        end
+        # Scrapping the bottom of the zero barrel:
+        if zero_sets == 0 and remainder > 1
+          zero_sets = 1
+        end
+      end
+    else
+      # The ratio of hits to pulses isn't so low as to start hording zeros:
+      zero_sets = 1
+    end
+    zero_sets
+  end
+
+  def self.distribute_and_pop_sequence(sequence, zero_sets, remainder, denominator)
+    # Choose the approiate counter for the current size of the sequence:
+    distributions = (remainder > denominator) ? denominator : remainder
+
+    distributions.times do |distribution|
+      zero_sets.times do
+        sequence[distribution] << sequence.pop unless sequence[distribution].nil?
+      end
+    end
+    sequence
+  end
+
+end

data/lib/euclidean_sequencer/formator.rb

@@ -0,0 +1,39 @@
+class Formator
+
+  def self.format_sequence(sequence:, options: {array: nil, offset: nil})
+    if options[:array] && !options[:offset]
+      return convert_to_array(sequence)
+    end
+
+    if options[:array] && options[:offset]
+      return offset(convert_to_array(sequence), options[:offset])
+    end
+
+    if options[:offset] && !options[:array]
+      return offset(sequence, options[:offset])
+    end
+
+    return sequence
+  end
+
+  private
+
+  def self.convert_to_array(sequence)
+    array = []
+    sequence.length.times { |element| array[element] = sequence[element].to_i }
+    array
+  end
+
+  def self.offset(sequence, offset)
+    if sequence.is_a?(String)
+      return offset_array(sequence.split(//), offset).join
+    end
+    return offset_array(sequence, offset)
+  end
+
+  def self.offset_array(array, offset)
+    offset.times { array << array.shift }
+    return array
+  end
+
+end

data/lib/euclidean_sequencer/parser.rb

@@ -0,0 +1,44 @@
+require 'optparse'
+
+class Parser
+  def self.parse(argv)
+    options = Struct.new(:hits, :pulses, :array, :offset)
+    args = options.new()
+
+    opt_parser = OptionParser.new do |opts|
+      opts.banner = "Usage: euclidean_sequncer [options]"
+
+      opts.on("-h", "--hits=HITS", Integer, "Number of 'on' elements in the sequncer: INTEGER") do |hits|
+        args.hits = hits
+      end
+
+      opts.on("-pPULSES", "--pulses=PULSES", Integer,  "Total number of elements in the sequncer: INTEGER") do |pulses|
+        raise Exception if pulses.nil?
+        args.pulses = pulses
+      end
+
+      opts.on("-a", "--array=TRUE", FalseClass, "Output as array (optional): BOOLEAN") do |array|
+        args.array = array
+      end
+
+      opts.on("-o", "--offset=OFFSET", Integer, "Number elements left shifted in the sequence (optional): INTEGER") do |offset|
+        args.offset = offset
+      end
+
+      opts.on("-?", "--help", "Prints this help") do
+        puts opts
+        exit
+      end
+    end
+
+    begin
+      opt_parser.parse!(argv)
+    rescue Exception => error
+      printf("ERROR: %s \n", error)
+      opt_parser.parse!(["--help"])
+      exit 1
+    end
+
+    return args
+  end
+end

data/lib/euclidean_sequencer/sequencer.rb

@@ -0,0 +1,18 @@
+require './lib/euclidean_sequencer/engine'
+require './lib/euclidean_sequencer/formator'
+
+class Sequencer
+  def self.generate(hits: 0, pulses: 0, options: {array: nil, offset: nil})
+    format_sequence(run(hits, pulses), options)
+  end
+
+  private
+
+  def self.run(hits, pulses)
+    Engine.run(hits: hits, pulses: pulses)
+  end
+
+  def self.format_sequence(sequence, options)
+    Formator.format_sequence(sequence: sequence, options: options)
+  end
+end

data/lib/euclidean_sequencer.rb

@@ -0,0 +1,14 @@
+require './lib/euclidean_sequencer/sequencer.rb'
+
+module EuclideanSequencer
+  def self.generate(hits: 0, pulses: 0, options: {array: nil, offset: nil})
+    sequence = run(hits, pulses, options)
+  end
+
+  private
+
+  def self.run(hits, pulses, options)
+    Sequencer.generate(hits: hits, pulses: pulses, options: options)
+  end
+end
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: euclidean_sequencer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Matt Ridenour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Generates sequences of hits spaced as evenly as possible     across given
+  pulses using the Euclidean algorithm.
+email: mattridenour@gmail.com
+executables:
+- build_and_push_gem
+- console
+- euclidean_sequencer
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".envrc.example"
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/build_and_push_gem
+- bin/console
+- bin/euclidean_sequencer
+- bin/setup
+- euclidean_sequencer.gemspec
+- lib/euclidean_sequencer.rb
+- lib/euclidean_sequencer/engine.rb
+- lib/euclidean_sequencer/formator.rb
+- lib/euclidean_sequencer/parser.rb
+- lib/euclidean_sequencer/sequencer.rb
+homepage: https://gitlab.com/Mattbot/gem-euclidean-sequencer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Generates sequences of hits spaced as evenly as possible     across given
+  pulses.
+test_files: []