sm808 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0da6fb6718ce4352bac3f03dd75498a6d84c8cc1
+  data.tar.gz: fc0fd1708c2d680d1786d5cce60c2e9a22b81395
+SHA512:
+  metadata.gz: 214891d70bee594f228ef1c2429a3e3dc8f1929cada36b39a90313a025c591848f4c6058ec3c0247a2a9495b8d9a45d54da9ed6d8decc42aaa6a53b687150c50
+  data.tar.gz: bb219c906914b00a7dbf0539e7740c36ea93c2c20ce62f56730df2daaade088f9020454fd1fe336717595ee16b6b9eaff729c71af283af513f44928750b3599f

data/.byebug_history

@@ -0,0 +1,9 @@
+continue
+Music.kick_pattern
+Cli.kick_pattern
+::kick_pattern
+continue
+Music.kick_pattern
+Music.artii
+self
+self.artii

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.byebug_history/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

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 arbonap@gmail.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,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    sm808 (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    artii (2.1.2)
+    byebug (10.0.2)
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  artii
+  bundler (~> 1.16)
+  byebug
+  rake (~> 10.0)
+  rspec-core
+  rspec-expectations
+  rspec-mocks
+  sm808!
+  thor (= 0.20.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Patricia Arbona
+
+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,25 @@
+# Sm-808
+  - Programming a Sequencer for a Drum Machine: A Ruby Implementation of the famous "four on the floor" rhythm pattern
+
+
+## Setting up Sm-808
+
+1. Download the gem locally
+2. `gem install bundler`
+3. `bundle install`
+
+##
+
+- Run `ruby lib/sm808/cli.rb` from the root directory to go through the interactive
+terminal-based Drum Machine Sequencer
+- For testing:
+  - run `rspec spec` for the entire test-suite
+  - run `rspec spec/music_spec.rb` to run `music_spec.rb` file
+
+## Development
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+# If you want to make this the default task
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sm808"
+
+# 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/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/exe/sm808

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'sm808/cli'
+
+Sm808::CLI.start

data/lib/sm808/cli.rb

@@ -0,0 +1,28 @@
+require "byebug"
+require_relative "music"
+require_relative "pattern"
+require_relative "score"
+  class Cli
+    extend Score
+    extend Pattern
+    kick = Pattern.kick
+
+    snare = Pattern.snare
+
+    hihat = Pattern.hihat
+    puts Music.welcome
+    puts "Welcome to SM808 Drum Machine Sequencer!"
+    puts "Let's implement the famous Four on the Floor rhythm pattern."
+
+    puts "What's the title of the song you'd like to compose?"
+    title = gets.chomp.to_s
+    puts "You've chose '#{title}' as your song title. Amazing!"
+    puts "What is the tempo (beats per minute) you want for your song? Enter an integer that is at least 30 BPM."
+    bpm = Score.validate_bpm
+    puts "You've chosen #{bpm} beats per minute in 4/4 time signature. Great!"
+    puts "How many measures of music (loops) would you like to play?"
+    num = Score.validate_measure
+    puts "You've chosen to loop #{num} times. Let's play!"
+    num.times { Score.calculate_music_measure(kick, snare, hihat, bpm) }
+    puts "Good-bye for now! Have a musical day. Ciao."
+  end

data/lib/sm808/music.rb

@@ -0,0 +1,7 @@
+module Music
+  def self.welcome
+    # the artii gem creates ascii text
+    # this method shells it out
+    `artii Sm-808`
+  end
+end

data/lib/sm808/pattern.rb

@@ -0,0 +1,34 @@
+module Pattern
+  def self.snare
+    # this string represents one measure (or one line) of the snare pattern
+    # the 1 represents a snare beat
+    # the _ represents musical rests
+    '_|_|_|_|1|_|_|_|'
+      .split('|')
+      .map do |note|
+        note == "1" ? "snare": note
+      end
+  end
+
+  def self.hihat
+    # this string represents one measure (or one line) of the hihat pattern
+    # the 1 represents a hihat beat
+    # the _ represents musical rests
+    '_|_|1|_|_|_|1|_|'
+      .split('|')
+      .map do
+        |note| note == "1" ? "hihat": note
+      end
+  end
+
+  def self.kick
+    # this string represents one measure (or one line) of the kick pattern
+    # the 1 represents a kick beat
+    # the _ represents musical rests
+    '1|_|_|_|1|_|_|_|'
+      .split('|')
+      .map do |note|
+        note == '1' ? 'kick' : note
+      end
+  end
+end

data/lib/sm808/score.rb

@@ -0,0 +1,66 @@
+# module that computes Musical Score output
+module Score
+  def self.validate_bpm
+    # asks the user for the tempo (or BPM) of their music composition
+    # and provides some validation on the BPM they input
+    # prevents user from inputting a slow BPM, where the song must be at least 30 BPM
+    bpm = gets.chomp.to_i
+    if bpm.to_i < 30
+      puts "Your BPM has to be at least 30 BPM and cannot be 0. Let's try something else:"
+      # if the BPM isn't at least 30, recurse & give the user another chance
+      self.validate_bpm
+    end
+    bpm
+  end
+
+  def self.validate_measure
+    # asks the user for how many music measures they want in their music composition
+    # and provides some validation on the number of loops they input
+    # prevents user from inputting 0 or a negative number
+    measure_num = gets.chomp.to_i
+    if measure_num.to_i <= 0
+      puts "You must enter an integer atleast 1 or higher to create a music score:"
+      # if there isn't at least 1 music measure, recurse & give the user another chance
+      self.validate_measure
+    end
+    measure_num
+  end
+  def self.calculate_interval(bpm)
+    # calculate the amount of time each step in a pattern takes based on tempo
+    # must use Rational class to handle repeating decimals
+    # then finally convert the result into a float
+    # learn more here: https://ruby-doc.org/core-2.5.0/Rational.html
+    (((60r / bpm.to_r) * 4r) / 8r).to_f
+  end
+
+
+  def self.calculate_music_measure(kick, snare, hihat, bpm)
+    # .zip converts 3 arrays into a 2-D array of arrays
+    # with this shape:
+    # [
+    #  ["kick", "_", "_"],
+    #  ["_", "_", "_"],
+    #  ["_", "_", "hihat"],
+    #  ["_", "_", "_"],
+    #  ["kick", "snare", "_"],
+    #  ["_", "_", "_"],
+    #  ["_", "_", "hihat"],
+    #  ["_", "_", "_"]
+    # ]
+    kick.zip(snare, hihat)
+      .map(&:uniq)
+      .map(&:join)
+      .each do |note|
+        # delete any underscores if the array contains any music notes (besides rests)
+        note.gsub!("_",'') if note.size > 1
+      end
+      .map.with_index do |note, index|
+        # wait one beat before printing the music note or music rest
+        sleep self.calculate_interval(bpm)
+        print "|#{note}| "
+        # for every 8 music notes, begin a new line
+        # to represent each new measure ( or musical loop )
+        puts "\n" if index % 7 == 0  && index != 0
+      end
+  end
+end

data/lib/sm808/version.rb

@@ -0,0 +1,3 @@
+module Sm808
+  VERSION = "0.1.2"
+end

data/lib/sm808.rb

@@ -0,0 +1,2 @@
+require "sm808/version"
+require "sm808/music"

data/sm808.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sm808/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sm808"
+  spec.version       = Sm808::VERSION
+  spec.authors       = ["Anonymous Backend Splice Applicant"]
+  spec.email         = ["anonymous@example.com"]
+
+  spec.summary       = %q{Drum Machine Sequencer}
+  spec.description   = %q{Implements sequence for the famous four on the floor rhythm pattern.}
+  spec.homepage      = "https://github.com/arbonap/sm-808"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "thor", "0.20.0"
+  spec.add_development_dependency "rspec-core"
+  spec.add_development_dependency "rspec-mocks"
+  spec.add_development_dependency "rspec-expectations"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "artii"
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: sm808
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Anonymous Backend Splice Applicant
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-07 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'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: artii
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Implements sequence for the famous four on the floor rhythm pattern.
+email:
+- anonymous@example.com
+executables:
+- sm808
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sm808
+- lib/sm808.rb
+- lib/sm808/cli.rb
+- lib/sm808/music.rb
+- lib/sm808/pattern.rb
+- lib/sm808/score.rb
+- lib/sm808/version.rb
+- sm808.gemspec
+homepage: https://github.com/arbonap/sm-808
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Drum Machine Sequencer
+test_files: []