self_enumerable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b69d1e85f92b518c2c93e8542f627f88e08a628
+  data.tar.gz: f204806b3600cf93306bb3d49fe538e5dd14359e
+SHA512:
+  metadata.gz: c935152429fc1b265254e453a1e0e9e748c1d31ed9dd26d80444bb5a52b201a69753c1d98a1017ce4548519cae0875a2969144471f51e903092d649304a3a626
+  data.tar.gz: e519d3c72be0eb4a50aaa82fa6372b527d330cd9ad6eb4c8bfd3242d7292699e74bbcbdf15482785224065b5251f393e00939c820be84b174404c67e74d75682

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "2.0"
+  - "2.1"
+  - "2.2"

data/Gemfile

@@ -0,0 +1,25 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in your gemspec
+gemspec
+
+group :development do
+  gem "bundler"
+  gem "rake"
+  gem "rspec",           ">= 3.0.0",  "< 4.0.0"
+  gem "simplecov",       ">= 0.8.0"
+
+  if !ENV["CI"]
+    gem "benchmark-ips"
+    gem "hashdiff"
+    gem "pry",                "~> 0.9.12.6"
+    gem "pry-byebug",         "<= 1.3.2"
+    gem "pry-rescue",         "~> 1.4.2"
+    gem "pry-stack_explorer", "~> 0.4.9.1"
+    gem "pry-syntax-hacks",   "~> 0.0.6"
+  end
+end
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Michael Sievers
+
+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,63 @@
+# SelfEnumerable
+
+## Usage
+
+```ruby
+require "self_enumerable"
+
+class DataSet
+  include SelfEnumerable
+  
+  # constructor needs to be able to handle array parameter
+  def initialize(values = [])
+    @values = values
+  end
+  
+  def each
+    return enum_for(__method__) unless block_given?
+    
+    @values.each do |value|
+      yield value
+    end
+  end
+end
+
+data_set = DataSet.new([1,2,3,4,5])
+
+#
+# instead of returning plain arrays, instances of objects class are returned
+#
+
+data_set.select { |element| element < 3 }
+# => #<DataSet:0x00000000f0f0a0 @values=[1, 2]>
+
+data_set.partition { |element| element <= 3 }
+# =>  [#<DataSet:0x00000000ed2c40 @values=[1, 2, 3]>, #<DataSet:0x00000000ed2c18 @values=[4, 5]>]
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'self_enumerable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install self_enumerable
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/msievers/self_enumerable.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+desc "Benchmark some methods against plain Enumerable"
+task :benchmark  do
+  load File.expand_path("./benchmark/benchmark_self_enumerable.rb")
+end

data/benchmark/benchmark_self_enumerable.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "self_enumerable"
+
+class BenchmarkSelfEnumerable
+  class DataSet
+    def initialize(values)
+      @values = values
+    end
+
+    def each
+      return enum_for(__method__) unless block_given?
+
+      @values.each do |_value|
+        yield _value
+      end
+    end
+  end
+
+  class EnumerableDataSet < DataSet
+    include Enumerable
+  end
+
+  class SelfEnumerableDataSet < DataSet
+    include SelfEnumerable
+  end
+
+  def call
+    require "benchmark/ips"
+
+    values = [1,2,3,4,5,6,7,8,9,10]
+
+    enumerable_data_set = EnumerableDataSet.new(values)
+    self_enumerable_data_set = SelfEnumerableDataSet.new(values)
+
+    Benchmark.ips do |x|
+      callable = -> (_el) { _el }
+
+      x.report("Enumerable#map") do
+        enumerable_data_set.map(&callable)
+      end
+
+      x.report("SelfEnumerable#map") do
+        self_enumerable_data_set.map(&callable)
+      end
+
+      x.compare!
+    end
+  end
+end
+  
+BenchmarkSelfEnumerable.new.call

data/bin/console

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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/self_enumerable/version.rb

@@ -0,0 +1,3 @@
+module SelfEnumerable
+  VERSION = "0.1.0"
+end

data/lib/self_enumerable.rb

@@ -0,0 +1,34 @@
+require "self_enumerable/version"
+
+module SelfEnumerable
+  WRAPPED_METHODS = [
+    :collect, :collect_concat, :drop, :drop_while, :first, :find_all, :flat_map,
+    :grep, :map, :max, :min, :min_by, :partition, :reject, :select, :sort, :sort_by,
+    :take, :take_while
+  ]
+
+  def self.included(klass)
+    klass.class_eval <<-eoruby
+      include Enumerable
+    eoruby
+
+    # for every Enumerable method, e.g. #map, #select ...
+    Enumerable.public_instance_methods.each do |_enum_method|
+      if WRAPPED_METHODS.include?(_enum_method)
+        if _enum_method == :partition # some special handling is needed
+          klass.class_eval <<-eoruby
+            def #{_enum_method}(*)
+              (result = super).is_a?(Array) ? [self.class.new(result[0]), self.class.new(result[1])] : result
+            end
+          eoruby
+        else
+          klass.class_eval <<-eoruby
+            def #{_enum_method}(*)
+              (result = super).is_a?(Array) ? self.class.new(result) : result
+            end
+          eoruby
+        end
+      end
+    end
+  end
+end

data/self_enumerable.gemspec

@@ -0,0 +1,18 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "self_enumerable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "self_enumerable"
+  spec.version       = SelfEnumerable::VERSION
+  spec.authors       = ["Michael Sievers"]
+  spec.summary       = %q{Extended Enumerable module which returns instances of an objects class instead of plain arrays.}
+  spec.licenses      = ["MIT"]
+  spec.homepage      = "https://github.com/msievers/self_enumerable"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: self_enumerable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Sievers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-28 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- benchmark/benchmark_self_enumerable.rb
+- bin/console
+- bin/setup
+- lib/self_enumerable.rb
+- lib/self_enumerable/version.rb
+- self_enumerable.gemspec
+homepage: https://github.com/msievers/self_enumerable
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Extended Enumerable module which returns instances of an objects class instead
+  of plain arrays.
+test_files: []