riffle 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0a462eefd0ef7b1494eec7847a0518a34dd3876
+  data.tar.gz: 47e2520de2f35d39da9eabf321e333c2281ad5e4
+SHA512:
+  metadata.gz: 84210dd35055df948f24c8c34c8754458da764227f0cee4c58b0ade7a8b91679dd009f4209596bff8dc1f78695f514381102502b583101d3129a933868cea7ec
+  data.tar.gz: ad6d5c63e120fb904e81489895d4cb0ed9d6b32729166c4aeb2f12e56d06a43443f5ad5ab7ac05c1a180cef76d7e77ad4c50b9b1f7cf9cbdb2420930f300dd74

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in riffle.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jordan Stephens
+
+MIT License
+
+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,66 @@
+# riffle
+
+Extends `Array` by defining `Array#riffle` to merge multiple arrays as if
+[riffling a deck of cards](http://en.wikipedia.org/wiki/Shuffling#Riffle).
+
+**Algorithm Description**
+
+`Array#riffle` iterates over argument arrays and selects a random number
+of items from each to remove from the front (this default subsequence
+length, or *group size* is in `(1..3)`). The removed items are then
+appended to a new array which is returned as the result after all items
+from each argument array have been merged. This iteration continues
+until all argument arrays are empty and all items have been merged.
+
+The order of items in each argument array is preserved in the resulting
+array relative to other items originating from the same argument array.
+
+## Usage
+
+### Basic Usage
+
+    numbers = [1, 2, 3, 4, 5, 6]
+    letters = %w(a b c d e f)
+
+    numbers.riffle(letters) # => [1, 2, "a", "b", 3, 4, "c", 5, 6, "d", "e", "f"]
+
+### Modifying the Possible *Group Size* Range
+You may also pass an options `Hash` as the last argument to define the
+possible range of the randomly determined *group size* at each iteration:
+
+    numbers.riffle(letters, { min_group_size: 2, max_group_size: 8 })
+
+**Note on Random Subsequence Lengths**
+
+The resulting subsequence length from any given argument is *random*,
+so it is very likely that consecutive runs will produce
+different results.
+
+    numbers.riffle(letters) # => [1, "a", "b", 2, 3, "c", 4, 5, 6, "d", "e", "f"]
+    numbers.riffle(letters) # => [1, 2, 3, "a", "b", 4, 5, "c", "d", "e", 6, "f"]
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'riffle'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install riffle
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Running Tests
+
+    $ rspec spec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/riffle/core_ext/array/riffle.rb

@@ -0,0 +1,35 @@
+
+class Array
+  def riffle(*args)
+    result = []
+
+    return self if args.empty?
+
+    opts = args.pop if args.length > 1 && args.last.is_a?(Hash)
+
+    min_group_size = (opts && opts[:min_group_size]) || 1
+    max_group_size = (opts && opts[:max_group_size]) || 3
+
+    # insert self at front of args list
+    args.unshift self
+
+    unless args.select { |a| !a.is_a? Array }.empty?
+      raise ArgumentError, "All arguments must be of type `Array`"
+    end
+
+    until args.flatten.empty?
+      args.each_with_index do |arg, i|
+        group_size = rand(min_group_size..max_group_size)
+        if arg.length < group_size
+          result.concat arg
+          args[i] = []
+        else
+          result.concat arg.take(group_size)
+          args[i] = arg.drop group_size
+        end
+      end
+    end
+
+    result
+  end
+end

data/lib/riffle/version.rb

@@ -0,0 +1,3 @@
+module Riffle
+  VERSION = "0.0.1"
+end

data/lib/riffle.rb

@@ -0,0 +1,2 @@
+require "riffle/version"
+require "riffle/core_ext/array/riffle"

data/riffle.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'riffle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "riffle"
+  spec.version       = Riffle::VERSION
+  spec.authors       = ["Jordan Stephens"]
+  spec.email         = ["iam@jordanstephens.net"]
+  spec.description   = %q{defines Array#riffle to merge multiple arrays as if riffling a deck of cards. }
+  spec.summary       = %q{riffle multiple Arrays by selecting a random number of items from each and appending to a new result Array until all arugment Arrays are empty and all elements have been merged. }
+  spec.homepage      = "http://github.com/jordanstephens/riffle"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/array_spec.rb

@@ -0,0 +1,81 @@
+require "spec_helper"
+
+describe Array do
+  it "Array#riffle should be defined" do
+    [].respond_to?(:riffle).should be_true
+  end
+
+  it "returns self if no args are passed" do
+    a = [1, 2, 3]
+    a.riffle.should == a
+  end
+
+  it "requires all arguments to be of type `Array`, except when the last arg is an opts Hash" do
+    expect { [].riffle 1 }.to raise_error(ArgumentError)
+    expect { [].riffle [1], :foo }.to raise_error(ArgumentError)
+    expect { [].riffle({}, [1]) }.to raise_error(ArgumentError)
+
+    # allow an opts Hash to be passed as the last arg
+    expect { [].riffle [1], { min_group_size: 1 } }.to_not raise_error
+  end
+
+  it "does not raise exceptions when empty args are passed" do
+    expect { [].riffle [], [] }.to_not raise_error
+    [].riffle([], []).should be_empty
+  end
+
+  it "supports more than two arguments" do
+    numbers = [1, 2, 3, 4, 5, 6]
+    letters = %w(a b c d e f)
+    symbols = [:foo, :bar, :baz, :qux]
+    result = numbers.riffle letters, symbols
+
+    result.length.should == numbers.length +
+                            letters.length +
+                            symbols.length
+
+    # filtering out integers from the result should be exactly equal to the
+    # original `numbers` array. particularly the order should be the same
+    result.select { |r| r.is_a? Integer }.should.eql? numbers
+
+    # filtering out strings from the result should be exactly equal to the
+    # original `letters` array. particularly the order should be the same
+    result.select { |r| r.is_a? String }.should.eql? letters
+
+    # filtering out strings from the result should be exactly equal to the
+    # original `letters` array. particularly the order should be the same
+    result.select { |r| r.is_a? Symbol }.should.eql? symbols
+  end
+
+  it "merges all argument arrays while maintaining the order of the original arrays in relation to themselves" do
+    numbers = [1, 2, 3, 4, 5, 6]
+    letters = %w(a b c d e f)
+    result = numbers.riffle letters
+
+    result.length.should == numbers.length + letters.length
+
+    # filtering out integers from the result should be exactly equal to the
+    # original `numbers` array. particularly the order should be the same
+    result.select { |r| r.is_a? Integer }.should.eql? numbers
+
+    # filtering out strings from the result should be exactly equal to the
+    # original `letters` array. particularly the order should be the same
+    result.select { |r| r.is_a? String }.should.eql? letters
+  end
+
+  it "maintains the first element in the array on which `riffle` was called" do
+    a = [1, 2, 3]
+    b = %w(a b c)
+    a.riffle(b).first.should == a.first
+  end
+
+  it "supports defining a min and max group size through an opts Hash passed as the last arg" do
+    a = [1, 2, 3, 4, 5, 6, 7, 8]
+    b = %w(a b c d e f g h)
+    r = a.riffle(b, { min_group_size: 2, max_group_size: 2 })
+    r.slice(0..1).each { |x| x.is_a?(Integer).should be_true }
+    r.slice(2..3).each { |x| x.is_a?(String).should be_true }
+    r.slice(6..7).each { |x| x.is_a?(String).should be_true }
+    r.slice(8..9).each { |x| x.is_a?(Integer).should be_true }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "rspec"
+require "riffle"

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: riffle
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jordan Stephens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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
+  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: 'defines Array#riffle to merge multiple arrays as if riffling a deck
+  of cards. '
+email:
+- iam@jordanstephens.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/riffle.rb
+- lib/riffle/core_ext/array/riffle.rb
+- lib/riffle/version.rb
+- riffle.gemspec
+- spec/array_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jordanstephens/riffle
+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.0.0
+signing_key: 
+specification_version: 4
+summary: riffle multiple Arrays by selecting a random number of items from each and
+  appending to a new result Array until all arugment Arrays are empty and all elements
+  have been merged.
+test_files:
+- spec/array_spec.rb
+- spec/spec_helper.rb
+has_rdoc: