combinatorics 0.2.0 → 0.3.0

data/.document

@@ -1,10 +1,4 @@
-# .document is used by rdoc and yard to know how to generate documentation 
-# for example, it can be used to control how rdoc gets built when you do `gem install foo`
-
 lib/**/*.rb
-
-# Files below this - are treated as 'extra files', and aren't parsed for ruby code
 - 
-LICENSE.md
-README.md
+LICENSE.txt
 ChangeLog.md

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -1 +1 @@
---markup markdown --title 'Combinatorics Documentation' --protected --files ChangeLog.md,LICENSE.txt
+--markup markdown --title 'Combinatorics Documentation' --protected

data/ChangeLog.md

@@ -1,3 +1,25 @@
+### 0.3.0 / 2010-10-17
+
+* Added {Combinatorics::Generator} which auto-detects the `Generator`
+  class.
+* Added {Combinatorics::Enumerator} which auto-detects the `Enumerator`
+  class.
+* Better detection of when enumerable values passed to
+  {Array#comprehension} reach their last value. This allows using
+  `Generator` objects that yield different values for each cycle:
+
+      multiplier = 0
+      gen = Generator.new { |g|
+        multiplier += 1
+        5.times { |i| g.yield (i * multiplier) }
+      }
+  
+      [[1,2], gen].comprehension.to_a
+      # => [[1,0],[1,1],[1,2],[1,3],[1,4],[2,0],[2,2],[2,4],[2,6],[2,8]]
+
+* Added a benchmark for {Array#comprehension} (see the
+  [benchmarks](http://github.com/postmodern/combinatorics/tree/master/benchmarks) directory).
+
 ### 0.2.0 / 2010-10-03
 
 * Added {Range#&}.

data/Rakefile

@@ -12,7 +12,7 @@ begin
     gem.email = 'postmodern.mod3@gmail.com'
     gem.homepage = 'http://github.com/postmodern/combinatorics'
     gem.authors = ['Postmodern']
-    gem.add_development_dependency 'rspec', '~> 1.3.0'
+    gem.add_development_dependency 'rspec', '~> 2.0.0'
     gem.add_development_dependency 'yard', '~> 0.6.0'
     gem.add_development_dependency 'jeweler', '~> 1.4.0'
   end
@@ -21,14 +21,8 @@ rescue LoadError
   puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
 end
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs += %w[lib spec]
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-  spec.spec_opts = %w[--options .specopts]
-end
-
-task :spec => :check_dependencies
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 task :default => :spec
 
 begin

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/benchmarks/list_comprehension.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+root_dir = File.expand_path(File.join(File.dirname(__FILE__),'..'))
+lib_dir = File.join(root_dir,'lib')
+$LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+require 'benchmark'
+require 'combinatorics/list_comprehension'
+
+list = [(1..200)] * 3
+
+puts Benchmark.measure { list.comprehension.each { |list| } }

data/combinatorics.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{combinatorics}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Postmodern"]
-  s.date = %q{2010-10-03}
+  s.date = %q{2010-10-17}
   s.description = %q{A collection of modules and methods for performing Combinatoric calculations.}
   s.email = %q{postmodern.mod3@gmail.com}
   s.extra_rdoc_files = [
@@ -20,17 +20,20 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
-     ".specopts",
+     ".rspec",
      ".yardopts",
      "ChangeLog.md",
      "LICENSE.txt",
      "README.md",
      "Rakefile",
      "VERSION",
+     "benchmarks/list_comprehension.rb",
      "combinatorics.gemspec",
      "lib/combinatorics.rb",
+     "lib/combinatorics/enumerator.rb",
      "lib/combinatorics/extensions.rb",
      "lib/combinatorics/extensions/range.rb",
+     "lib/combinatorics/generator.rb",
      "lib/combinatorics/list_comprehension.rb",
      "lib/combinatorics/power_set.rb",
      "lib/combinatorics/power_set/extensions.rb",
@@ -39,7 +42,9 @@ Gem::Specification.new do |s|
      "lib/combinatorics/power_set/mixin.rb",
      "spec/.rspec",
      "spec/combinatorics_spec.rb",
+     "spec/enumerator_spec.rb",
      "spec/extensions/range_spec.rb",
+     "spec/generator_spec.rb",
      "spec/list_comprehension_spec.rb",
      "spec/power_set/array_spec.rb",
      "spec/power_set/mixin_examples.rb",
@@ -52,8 +57,10 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Bringing (more) Combinatorics to Ruby}
   s.test_files = [
-    "spec/combinatorics_spec.rb",
+    "spec/enumerator_spec.rb",
+     "spec/combinatorics_spec.rb",
      "spec/list_comprehension_spec.rb",
+     "spec/generator_spec.rb",
      "spec/extensions/range_spec.rb",
      "spec/spec_helper.rb",
      "spec/power_set/set_spec.rb",
@@ -66,16 +73,16 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.0"])
       s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.4.0"])
     else
-      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.0.0"])
       s.add_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
     end
   else
-    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.0.0"])
     s.add_dependency(%q<yard>, ["~> 0.6.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
   end

data/lib/combinatorics/enumerator.rb

@@ -0,0 +1,10 @@
+require 'enumerator'
+
+module Combinatorics
+  # auto-detects the `Enumerator` class.
+  Enumerator = if defined?(::Enumerator) # 1.9
+                 ::Enumerator
+               elsif defined?(::Enumerable::Enumerator) # 1.8.7
+                 ::Enumerable::Enumerator
+               end
+end

data/lib/combinatorics/generator.rb

@@ -0,0 +1,10 @@
+require 'generator'
+
+module Combinatorics
+  # auto-detects the `Generator` class.
+  Generator = if defined?(::Enumerator::Generator) # 1.9
+                ::Enumerator::Generator
+              elsif defined?(::Generator) # 1.8.7
+                ::Generator
+              end
+end

data/lib/combinatorics/list_comprehension.rb

@@ -49,22 +49,25 @@ class Array
 
     enums = self.map do |value|
       if value.kind_of?(Enumerable)
-        value
+        value.enum_for
       else
-        (value..value)
+        [value].enum_for
       end
     end
 
-    cycles = enums.map { |e| e.cycle }
-    start = cycles.map { |e| e.next }
-    iteration = start.dup
+    iteration = enums.map { |e| e.next }
 
     loop do
       yield iteration.dup
 
-      (cycles.length - 1).downto(0) do |index|
-        iteration[index] = cycles[index].next
-        break unless iteration[index] == start[index]
+      (enums.length - 1).downto(0) do |index|
+        begin
+          iteration[index] = enums[index].next
+          break
+        rescue StopIteration
+          enums[index].rewind
+          iteration[index] = enums[index].next
+        end
 
         return nil if index == 0
       end

data/spec/enumerator_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'combinatorics/enumerator'
+
+describe Combinatorics::Enumerator do
+  it "should auto-detect the Enumerator class" do
+    Combinatorics::Enumerator.should_not be_nil
+  end
+end

data/spec/generator_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'combinatorics/generator'
+
+describe Combinatorics::Generator do
+  it "should auto-detect the Generator class" do
+    Combinatorics::Generator.should_not be_nil
+  end
+end

data/spec/list_comprehension_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'combinatorics/list_comprehension'
+require 'combinatorics/generator'
 
 describe "Array#comprehension" do
   it "should return an Enumerator object if no block is given" do
@@ -28,10 +29,39 @@ describe "Array#comprehension" do
   end
 
   it "should iterate over the values within an enumerable value" do
-    range = (1..10)
+    range = (1..5)
+    a = [range]
+
+    a.comprehension.to_a.should == [[1],[2],[3],[4],[5]]
+  end
+
+  it "should iterate over repeating values" do
+    range = [1,2,3,1,2,4]
     a = [range]
 
-    a.comprehension.to_a.should == [[1],[2],[3],[4],[5],[6],[7],[8],[9],[10]]
+    a.comprehension.to_a.should == [[1],[2],[3],[1],[2],[4]]
+  end
+
+  it "should iterate over values from a generator" do
+    a = [Combinatorics::Generator.new { |g| 5.times { |i| g.yield i } }]
+
+    a.comprehension.to_a.should == [[0],[1],[2],[3],[4]]
+  end
+
+  it "should iterate over values from a non-repeating generator" do
+    multiplier = 0
+    a = [
+      [1,2],
+      Combinatorics::Generator.new { |g|
+        multiplier += 1
+        5.times { |i| g.yield (i * multiplier) }
+      }
+    ]
+
+    a.comprehension.to_a.should == [
+      [1,0],[1,1],[1,2],[1,3],[1,4],
+      [2,0],[2,2],[2,4],[2,6],[2,8]
+    ]
   end
 
   it "should ignore non-enumerable values" do

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
 require 'rubygems'
 
-gem 'rspec', '>= 1.3.0'
-require 'spec'
+gem 'rspec', '~> 2.0.0'
+require 'rspec'

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Postmodern
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-03 00:00:00 -07:00
+date: 2010-10-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,10 +26,10 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
-        - 3
+        - 2
+        - 0
         - 0
-        version: 1.3.0
+        version: 2.0.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -75,17 +75,20 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
-- .specopts
+- .rspec
 - .yardopts
 - ChangeLog.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - VERSION
+- benchmarks/list_comprehension.rb
 - combinatorics.gemspec
 - lib/combinatorics.rb
+- lib/combinatorics/enumerator.rb
 - lib/combinatorics/extensions.rb
 - lib/combinatorics/extensions/range.rb
+- lib/combinatorics/generator.rb
 - lib/combinatorics/list_comprehension.rb
 - lib/combinatorics/power_set.rb
 - lib/combinatorics/power_set/extensions.rb
@@ -94,7 +97,9 @@ files:
 - lib/combinatorics/power_set/mixin.rb
 - spec/.rspec
 - spec/combinatorics_spec.rb
+- spec/enumerator_spec.rb
 - spec/extensions/range_spec.rb
+- spec/generator_spec.rb
 - spec/list_comprehension_spec.rb
 - spec/power_set/array_spec.rb
 - spec/power_set/mixin_examples.rb
@@ -133,8 +138,10 @@ signing_key:
 specification_version: 3
 summary: Bringing (more) Combinatorics to Ruby
 test_files: 
+- spec/enumerator_spec.rb
 - spec/combinatorics_spec.rb
 - spec/list_comprehension_spec.rb
+- spec/generator_spec.rb
 - spec/extensions/range_spec.rb
 - spec/spec_helper.rb
 - spec/power_set/set_spec.rb

data/.specopts

@@ -1 +0,0 @@
---colour --format specdoc