comprise 1.0.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Chris Lowder
+
+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,52 @@
+# Comprise
+
+Comprise brings basic List Comprehension functionality to Ruby.
+
+> “A list comprehension is a syntactic construct available in some programming languages for creating a list based on existing lists. It follows the form of the mathematical set-builder notation (set comprehension) as distinct from the use of map and filter functions.” - Wikipedia
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'comprise'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install comprise
+
+## Usage
+
+Building a comprehension goes something like:
+
+```ruby
+comp = Comprise::ListComprehension.new(y: -> { (1..5).map { |i| i * 2 } }, x: 1..2)
+# => #<Comprise::ListComprehension:70101319648040>
+
+comp.to_a
+# => [[2, 1], [2, 2], [4, 1], [4, 2], [6, 1], [6, 2], [8, 1], [8, 2], [10, 1], [10, 2]]
+
+comp.map { x * y }.to_a # to_a to trigger lazy enumeration in Ruby 2.0
+# => [2, 4, 4, 8, 6, 12, 8, 16, 10, 20]
+```
+
+Comprise also adds the Kernel method `listcomp`, so all that could be done more simply with the
+one-liner:
+
+```ruby
+listcomp(y: -> { (1..5).map { |i| i * 2 } }, x: 1..2) { x * y }.to_a
+=> [2, 4, 4, 8, 6, 12, 8, 16, 10, 20]
+```
+
+*Important note: In Ruby 2.0.x Comprise makes use of Lazy emuerators.*
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/comprise.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/comprise/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Chris Lowder"]
+  gem.email         = ["clowder@gmail.com"]
+  gem.description   = %q{Comprise brings basic List Comprehension functionality to Ruby.}
+  gem.summary       = %q{List Comprehension for Ruby.}
+  gem.homepage      = "https://clowder.github.com/comprise"
+
+  gem.files         = %w{LICENSE
+                         README.md
+                         comprise.gemspec
+                         lib/comprise.rb
+                         lib/comprise/list_comprehension.rb
+                         lib/comprise/version.rb
+                         spec/comprise/list_comprehension_spec.rb}
+  gem.test_files    = %w{spec/comprise/list_comprehension_spec.rb}
+  gem.name          = "comprise"
+  gem.require_paths = ["lib"]
+  gem.version       = Comprise::VERSION
+end

data/lib/comprise/list_comprehension.rb

@@ -0,0 +1,48 @@
+module Comprise
+  class ListComprehension
+    def initialize(lists)
+      vars = lists.values
+      enum = init_enum(vars.shift)
+
+      @context    = Struct.new(*lists.keys)
+      @enumerator = vars.inject(enum) do |enum, var|
+        if var.respond_to? :call
+          enum.flat_map { |other| var.call.map { |x| other + [x] } }
+        else
+          enum.flat_map { |other| var.map { |x| other + [x] } }
+        end
+      end
+    end
+
+    def to_a
+      @enumerator.to_a
+    end
+
+    def map
+      @enumerator.map { |values| @context.new(*values).instance_eval(&Proc.new) }
+    end
+
+    def inspect
+      "#<#{self.class.name}:#{self.object_id}>"
+    end
+
+    private
+    def init_enum(var)
+      var = var.respond_to?(:call) ? var.call : var
+      var = var.lazy if var.respond_to? :lazy
+      var.map { |x| [x] }
+    end
+  end
+end
+
+module Kernel
+  def listcomp(lists)
+    comprehension = Comprise::ListComprehension.new(lists)
+
+    if block_given?
+      comprehension.map(&Proc.new)
+    else
+      comprehension
+    end
+  end
+end

data/lib/comprise/version.rb

@@ -0,0 +1,3 @@
+module Comprise
+  VERSION = "1.0.0"
+end

data/lib/comprise.rb

@@ -0,0 +1,2 @@
+require File.expand_path('../comprise/version', __FILE__)
+require File.expand_path('../comprise/list_comprehension.rb', __FILE__)

data/spec/comprise/list_comprehension_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path('../../../lib/comprise', __FILE__)
+
+describe Comprise::ListComprehension do
+  it "works" do
+    listcomp(x: -> { [1,2,3] }, y: -> { [4,5,6] }).to_a.should == [
+      [1,4], [1,5], [1,6],
+      [2,4], [2,5], [2,6],
+      [3,4], [3,5], [3,6]
+    ]
+  end
+
+  it "yields to a block if passed" do
+    listcomp(x: -> { [1,2,3] }, y: -> { [4,5,6] }) do
+      [x,y]
+    end.to_a.should == [[1, 4], [1, 5], [1, 6],
+                        [2, 4], [2, 5], [2, 6],
+                        [3, 4], [3, 5], [3, 6]]
+  end
+
+  it "returns an enumerable" do
+    listcomp(y: -> { 1..3 }, x: -> { 4..6 }) { x*y }.select { |i| i%6==0 }.to_a.should == [6,12,12,18]
+  end
+
+  it "works with enumerable objects" do
+    listcomp(x: 1..2, y: [3,4]).to_a.should == [[1,3], [1,4],
+                                               [2,3], [2,4]]
+  end
+
+  it "doesn't explode on more complex examples" do
+    expect {
+      listcomp(y: -> { (1..5).map { |i| i * 2 } },
+               x: -> { (1..10).select { |i| i % 2 > 0 } },
+               z: 1..10) do
+        x+y+z
+      end.to_a
+    }.not_to raise_error
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: comprise
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris Lowder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-08 00:00:00.000000000 Z
+dependencies: []
+description: Comprise brings basic List Comprehension functionality to Ruby.
+email:
+- clowder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- comprise.gemspec
+- lib/comprise.rb
+- lib/comprise/list_comprehension.rb
+- lib/comprise/version.rb
+- spec/comprise/list_comprehension_spec.rb
+homepage: https://clowder.github.com/comprise
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: List Comprehension for Ruby.
+test_files:
+- spec/comprise/list_comprehension_spec.rb
+has_rdoc: