combinatorics 0.3.0 → 0.3.1

data/.document

@@ -1,4 +1,4 @@
-lib/**/*.rb
 - 
 LICENSE.txt
+Benchmarks.md
 ChangeLog.md

data/Benchmarks.md

@@ -0,0 +1,50 @@
+# Benchmarks
+
+Benchmarks for the {Combinatorics} code can be found in the `benchmarks/`
+directory.
+
+Benchmark machine specs:
+
+* CPU: AMD Athlon(tm) 64 Processor 3400+ (2202.785 MHz)
+* Cache Size: 1024 KB
+* Memory: 1 Gb
+
+## List Comprehensions:
+
+Ruby 1.9.2-p0 (2010-08-18 revision 29036) [x86_64-linux]:
+
+                      user     system      total        real
+    singleton:    0.060000   0.010000   0.070000 (  0.090075)
+    single-enum:  0.020000   0.000000   0.020000 (  0.035206)
+    depth 1:      0.000000   0.000000   0.000000 (  0.002489)
+    depth 2:      0.240000   0.000000   0.240000 (  0.306060)
+    depth 3:     40.090000   0.250000  40.340000 ( 51.830667)
+
+Ruby 1.8.7 (2010-08-16 patchlevel 302) [x86_64-linux]:
+
+                      user     system      total        real
+    singleton:    0.410000   0.290000   0.700000 (  0.929625)
+    single-enum:  0.050000   0.130000   0.180000 (  0.348974)
+    depth 1:      0.030000   0.050000   0.080000 (  0.111043)
+    depth 2:     15.650000   0.560000  16.210000 ( 23.012478)
+    depth 3:    3239.310000  15.950000 3255.260000 (3739.261379)
+
+JRuby 1.5.3 (ruby 1.8.7 patchlevel 249) (2010-09-28 7ca06d7)
+(OpenJDK 64-Bit Server VM 1.6.0_18) [amd64-java]:
+
+                      user     system      total        real
+    singleton:    1.019000   0.000000   1.019000 (  0.870000)
+    single-enum:  0.325000   0.000000   0.325000 (  0.325000)
+    depth 1:      0.088000   0.000000   0.088000 (  0.088000)
+    depth 2:      5.045000   0.000000   5.045000 (  5.044000)
+    depth 3:    275.765000   0.000000 275.765000 (275.765000)
+
+Rubinius 1.1.1dev (1.8.7 8bc2dc9a 2010-09-23 JI) [x86_64-unknown-linux-gnu]:
+
+                      user     system      total        real
+    singleton:    1.143827   0.088987   1.232814 (  1.523531)
+    single-enum:  0.313953   0.028996   0.342949 (  0.423621)
+    depth 1:      0.001999   0.000999   0.002998 (  0.003840)
+    depth 2:      1.051840   0.030996   1.082836 (  1.293856)
+    depth 3:     42.303569   5.777121  48.080690 ( 57.556785)
+

data/ChangeLog.md

@@ -1,3 +1,10 @@
+### 0.3.1 / 2010-10-26
+
+* Do not call `enum_for` on `Enumerator` objects passed to
+  {Array#comprehension}.
+* Improved {Array#comprehension} benchmarks.
+* Added [benchmark results] (see {file:Benchmarks.md}).
+
 ### 0.3.0 / 2010-10-17
 
 * Added {Combinatorics::Generator} which auto-detects the `Generator`

data/README.md

@@ -92,5 +92,7 @@ List comprehensions:
 
 ## License
 
+Copyright (c) 2010 Hal Brodigan
+
 See {file:LICENSE.txt} for license information.
 

data/Rakefile

@@ -2,35 +2,28 @@ require 'rubygems'
 require 'rake'
 
 begin
-  gem 'jeweler', '~> 1.4.0'
-  require 'jeweler'
+  require 'ore/tasks'
+  Ore::Tasks.new
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+end
 
-  Jeweler::Tasks.new do |gem|
-    gem.name = 'combinatorics'
-    gem.summary = %Q{Bringing (more) Combinatorics to Ruby}
-    gem.description = %Q{A collection of modules and methods for performing Combinatoric calculations.}
-    gem.email = 'postmodern.mod3@gmail.com'
-    gem.homepage = 'http://github.com/postmodern/combinatorics'
-    gem.authors = ['Postmodern']
-    gem.add_development_dependency 'rspec', '~> 2.0.0'
-    gem.add_development_dependency 'yard', '~> 0.6.0'
-    gem.add_development_dependency 'jeweler', '~> 1.4.0'
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
   end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
 end
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new
 task :default => :spec
 
 begin
   require 'yard'
-
-  YARD::Rake::YardocTask.new
-rescue LoadError
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
   task :yard do
-    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+    abort "Please run `gem install yard` to install YARD."
   end
 end

data/benchmarks/list_comprehension.rb

@@ -7,6 +7,25 @@ $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 require 'benchmark'
 require 'combinatorics/list_comprehension'
 
-list = [(1..200)] * 3
+Benchmark.bm(12) do |b|
+  singleton_list = ([1] * 500)
+  single_enum_list = [1..200, 1]
+  depth_list = [1..200]
 
-puts Benchmark.measure { list.comprehension.each { |list| } }
+  b.report('singleton:') do
+    singleton_list.comprehension.each { |list| list.last }
+  end
+
+
+  b.report('single-enum:') do
+    single_enum_list.comprehension.each { |list| list.last }
+  end
+
+  (1..3).each do |n|
+    deep_list = (depth_list * n)
+
+    b.report("depth #{n}:") do
+      deep_list.comprehension.each { |list| list.last }
+    end
+  end
+end

data/combinatorics.gemspec

@@ -1,90 +1,10 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
-Gem::Specification.new do |s|
-  s.name = %q{combinatorics}
-  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-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 = [
-    "ChangeLog.md",
-     "LICENSE.txt",
-     "README.md"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     ".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",
-     "lib/combinatorics/power_set/extensions/array.rb",
-     "lib/combinatorics/power_set/extensions/set.rb",
-     "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",
-     "spec/power_set/set_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/postmodern/combinatorics}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Bringing (more) Combinatorics to Ruby}
-  s.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",
-     "spec/power_set/array_spec.rb",
-     "spec/power_set/mixin_examples.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      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>, ["~> 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>, ["~> 2.0.0"])
-    s.add_dependency(%q<yard>, ["~> 0.6.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.4.0"])
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
   end
+rescue NameError
+  STDERR.puts "The 'combinatorics.gemspec' file requires Ore."
+  STDERR.puts "Run `gem install ore` to install Ore."
 end
-

data/gemspec.yml

@@ -0,0 +1,16 @@
+name: combinatorics
+summary: Bringing (more) Combinatorics to Ruby
+description:
+  A collection of modules and methods for performing Combinatoric
+  calculations.
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/combinatorics
+has_yard: true
+
+development_dependencies:
+  ore: ~> 0.1.0
+  ore-tasks: ~> 0.1.0
+  rspec: ~> 2.0.0
+  yard: ~> 0.6.0

data/lib/combinatorics.rb

@@ -1,3 +1,4 @@
 require 'combinatorics/extensions'
 require 'combinatorics/list_comprehension'
 require 'combinatorics/power_set'
+require 'combinatorics/version'

data/lib/combinatorics/extensions/range.rb

@@ -53,7 +53,7 @@ class Range
 
     self.first.upto(other.first) do |start|
       self.last.upto(other.last) do |stop|
-        yield (start..stop)
+        yield start..stop
       end
     end
   end
@@ -89,7 +89,7 @@ class Range
 
     self.first.downto(other.first) do |start|
       self.last.downto(other.last) do |stop|
-        yield (start..stop)
+        yield start..stop
       end
     end
   end

data/lib/combinatorics/list_comprehension.rb

@@ -1,3 +1,5 @@
+require 'combinatorics/enumerator'
+
 class Array
 
   #
@@ -48,7 +50,10 @@ class Array
     end
 
     enums = self.map do |value|
-      if value.kind_of?(Enumerable)
+      case value
+      when Combinatorics::Enumerator
+        value
+      when Enumerable
         value.enum_for
       else
         [value].enum_for

data/lib/combinatorics/version.rb

@@ -0,0 +1,4 @@
+module Combinatorics
+  # combinatorics version
+  VERSION = '0.3.1'
+end

data/spec/combinatorics_spec.rb

@@ -1,4 +1,8 @@
 require 'spec_helper'
+require 'combinatorics/version'
 
-describe "Combinatorics" do
+describe Combinatorics do
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
 end

data/spec/list_comprehension_spec.rb

@@ -54,7 +54,7 @@ describe "Array#comprehension" do
       [1,2],
       Combinatorics::Generator.new { |g|
         multiplier += 1
-        5.times { |i| g.yield (i * multiplier) }
+        5.times { |i| g.yield(i * multiplier) }
       }
     ]
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Postmodern
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-17 00:00:00 -07:00
+date: 2010-10-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: ore
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -26,14 +26,14 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 2
         - 0
+        - 1
         - 0
-        version: 2.0.0
+        version: 0.1.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: yard
+  name: ore-tasks
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -42,13 +42,13 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 6
+        - 1
         - 0
-        version: 0.6.0
+        version: 0.1.0
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -56,12 +56,27 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
-        - 4
+        - 2
         - 0
-        version: 1.4.0
+        - 0
+        version: 2.0.0
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id004
 description: A collection of modules and methods for performing Combinatoric calculations.
 email: postmodern.mod3@gmail.com
 executables: []
@@ -69,21 +84,22 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- ChangeLog.md
-- LICENSE.txt
 - README.md
+- LICENSE.txt
+- Benchmarks.md
+- ChangeLog.md
 files: 
 - .document
-- .gitignore
 - .rspec
 - .yardopts
+- Benchmarks.md
 - ChangeLog.md
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - benchmarks/list_comprehension.rb
 - combinatorics.gemspec
+- gemspec.yml
 - lib/combinatorics.rb
 - lib/combinatorics/enumerator.rb
 - lib/combinatorics/extensions.rb
@@ -95,6 +111,7 @@ files:
 - lib/combinatorics/power_set/extensions/array.rb
 - lib/combinatorics/power_set/extensions/set.rb
 - lib/combinatorics/power_set/mixin.rb
+- lib/combinatorics/version.rb
 - spec/.rspec
 - spec/combinatorics_spec.rb
 - spec/enumerator_spec.rb
@@ -105,13 +122,13 @@ files:
 - spec/power_set/mixin_examples.rb
 - spec/power_set/set_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
+has_rdoc: yard
 homepage: http://github.com/postmodern/combinatorics
-licenses: []
-
+licenses: 
+- MIT
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -143,7 +160,5 @@ test_files:
 - spec/list_comprehension_spec.rb
 - spec/generator_spec.rb
 - spec/extensions/range_spec.rb
-- spec/spec_helper.rb
 - spec/power_set/set_spec.rb
 - spec/power_set/array_spec.rb
-- spec/power_set/mixin_examples.rb

data/.gitignore

@@ -1,8 +0,0 @@
-pkg
-doc
-web
-tmp
-.DS_Store
-.yardoc
-*.swp
-*~

data/VERSION

@@ -1 +0,0 @@
-0.3.0