lupo 0.0.1

data/.gitignore

@@ -0,0 +1,37 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+.rbx
+
+## PROJECT::GENERAL
+*.gem
+coverage
+profiling
+turbulence
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.lock
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--profile
+--order random
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+lupo

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+before_install: gem install bundler
+bundler_args: --without yard guard benchmarks
+script: "bundle exec rake ci"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - rbx-19mode
+matrix:
+  include:
+    - rvm: jruby-19mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-head
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+  allow_failures:
+    - rvm: ruby-head

data/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+Contributing
+------------
+
+* If you want your code merged into the mainline, please discuss the proposed changes with me before doing any work on it.
+* Fork the project.
+* Make your feature addition or bug fix.
+  * Follow this [style guide](https://github.com/dkubb/styleguide).
+* Add specs for it. This is important so I don't break it in a future version unintentionally. Tests must cover all branches within the code, and code must be fully covered.
+* Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Run "rake ci". This must pass and not show any regressions in the metrics for the code to be merged.
+* Send me a pull request. Bonus points for topic branches.

data/Gemfile

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'devtools', git: 'https://github.com/rom-rb/devtools.git'
+end
+
+# added by devtools
+eval_gemfile 'Gemfile.devtools'

data/Gemfile.devtools

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',  '~> 10.1.0'
+  gem 'rspec', '~> 2.14.1'
+  gem 'yard',  '~> 0.8.7'
+
+  platform :rbx do
+    gem 'rubysl-singleton', '~> 2.0.0'
+  end
+end
+
+group :yard do
+  gem 'kramdown', '~> 1.3.0'
+end
+
+group :guard do
+  gem 'guard',         '~> 2.2.4'
+  gem 'guard-bundler', '~> 2.0.0'
+  gem 'guard-rspec',   '~> 4.2.0'
+  gem 'guard-rubocop', '~> 1.0.0'
+
+  # file system change event handling
+  gem 'listen',     '~> 2.4.0'
+  gem 'rb-fchange', '~> 0.0.6', require: false
+  gem 'rb-fsevent', '~> 0.9.3', require: false
+  gem 'rb-inotify', '~> 0.9.0', require: false
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.0', require: false
+  gem 'rb-notifu',               '~> 0.0.4', require: false
+  gem 'terminal-notifier-guard', '~> 1.5.3', require: false
+end
+
+group :metrics do
+  gem 'coveralls', '~> 0.7.0'
+  gem 'flay',      '~> 2.4.0'
+  gem 'flog',      '~> 4.2.0'
+  gem 'reek',      '~> 1.3.2'
+  gem 'rubocop',   '~> 0.15.0'
+  gem 'simplecov', '~> 0.8.2'
+  gem 'yardstick', '~> 0.9.7', git: 'https://github.com/dkubb/yardstick.git'
+
+  platforms :ruby_19, :ruby_20 do
+    gem 'mutant',          '~> 0.3.0', git: 'https://github.com/mbj/mutant.git'
+    gem 'unparser',        '~> 0.1.5', git: 'https://github.com/mbj/unparser.git'
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platform :rbx do
+    gem 'json',               '~> 1.8.1'
+    gem 'racc',               '~> 1.4.10'
+    gem 'rubysl-logger',      '~> 2.0.0'
+    gem 'rubysl-open-uri',    '~> 2.0.0'
+    gem 'rubysl-prettyprint', '~> 2.0.2'
+  end
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.8.5'
+  end
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Martin Gamsjaeger (snusnu)
+
+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,64 @@
+# lupo
+
+[![Gem Version](https://badge.fury.io/rb/lupo.png)][gem]
+[![Build Status](https://secure.travis-ci.org/snusnu/lupo.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/snusnu/lupo.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/snusnu/lupo.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/snusnu/lupo/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/lupo
+[travis]: https://travis-ci.org/snusnu/lupo
+[gemnasium]: https://gemnasium.com/snusnu/lupo
+[codeclimate]: https://codeclimate.com/github/snusnu/lupo
+[coveralls]: https://coveralls.io/r/snusnu/lupo
+
+## Usage
+
+```ruby
+require 'lupo'
+
+class TaskList
+  include Lupo.enumerable(:tasks)
+
+  def initialize(name, tasks)
+    @name, @tasks = name, tasks
+  end
+end
+
+list = TaskList.new('secret', %w[this and that])
+
+list.each { |t| puts(t) }     # => list
+list.each.to_a                # => ['this', 'and', 'that']
+list.is_a?(Enumerable)        # => true
+list.methods.include?(:tasks) # => false
+
+class ItemList
+  include Lupo.collection(:items)
+end
+
+list = ItemList.new(%w[this and that])
+
+list.each { |i| puts(i) }               # => list
+list.each.to_a                          # => ['this', 'and', 'that']
+list.is_a?(Enumerable)                  # => true
+list.protected_methods.include?(:items) # => true
+
+other = ItemList.new(%w[this and that])
+
+# see equalizer for detailed docs
+list.equal?(other) # => false
+list.eql?(other)   # => true
+list == other      # => true
+```
+
+## Credits
+
+* [snusnu](https://github.com/snusnu)
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## Copyright
+
+Copyright © 2013 Martin Gamsjaeger (snusnu). See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require 'rake'
+require 'devtools'
+
+Devtools.init_rake_tasks

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 0.1

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 2
+total_score: 4

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 11.8

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: lupo
+namespace: Lupo

data/config/reek.yml

@@ -0,0 +1,103 @@
+---
+Attribute:
+  enabled: true
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 1
+  overrides:
+    initialize:
+      max_params: 2
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 1
+NestedIterators:
+  enabled: true
+  exclude:
+  - Lupo#included # 2
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 1
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 2
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 2
+TooManyStatements:
+  enabled: true
+  exclude: []
+  max_statements: 6
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 0

data/config/rubocop.yml

@@ -0,0 +1,78 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+    - 'Gemfile'
+    - 'Gemfile.devtools'
+  Excludes:
+    - '**/vendor/**'
+    - '**/benchmarks/**'
+
+# Avoid parameter lists longer than five parameters.
+ParameterLists:
+  Max: 2
+  CountKeywordArgs: true
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessModifierIndentation:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Max: 80
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Do not favor modifier if/unless usage when you have a single-line body
+IfUnlessModifier:
+  Enabled: false
+
+# Allow case equality operator (in limited use within the specs)
+CaseEquality:
+  Enabled: false
+
+# Constants do not always have to use SCREAMING_SNAKE_CASE
+ConstantName:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false
+
+# Do not prefer do/end over {} for multiline blocks
+Blocks:
+  Enabled: false
+
+# Do not favor aligned parameters in method calls
+AlignParameters:
+  Enabled: false
+
+HashSyntax:
+  Enabled: false
+
+SpaceInsideBrackets:
+  Enabled: false
+
+Lambda:
+  Enabled: false # i personally like the look of multiline ->(arg) {} lambdas
+
+AndOr:
+  Enabled: false # we agree to use and/or for control flow

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/lib/lupo.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+
+require 'concord'
+
+# Includes Enumerable and provides #each.
+# Optionally includes Concord to provide
+# #initialize and Equalizer for equality
+# methods
+class Lupo < Module
+  private_class_method :new
+
+  # Build a module providing #each, Enumerable and Concord
+  #
+  # @example
+  #
+  #   class Collection
+  #     include Lupo.enumerable(:entries)
+  #
+  #     def initialize(entries)
+  #       @entries = entries
+  #     end
+  #   end
+  #
+  #   collection = Collection.new([1,2,3])
+  #
+  #   collection.each { |i| puts(i) } # => collection
+  #   collection.each.to_a            # => [1,2,3]
+  #   collection.is_a?(Enumerable)    # => true
+  #
+  # @param [#to_s] name
+  #   the name of the enumerable
+  #
+  # @return [undefined]
+  #
+  # @api public
+  def self.enumerable(name)
+    new(name, [Enumerable])
+  end
+
+  # Build a module providing #each and Enumerable
+  #
+  # @example
+  #
+  #   class Collection
+  #     include Lupo.collection(:entries)
+  #   end
+  #
+  #   collection = Collection.new([1,2,3])
+  #
+  #   collection.each { |i| puts(i) } # => collection
+  #   collection.each.to_a            # => [1,2,3]
+  #   collection.is_a?(Enumerable)    # => true
+  #
+  #   other = Collection.new([1,2,3])
+  #
+  #   # see equalizer for detailed docs
+  #   collection.equal?(other) # => false
+  #   collection.eql?(other)   # => true
+  #   collection == other      # => true
+  #
+  # @param [#to_s] name
+  #   the name of the enumerable
+  #
+  # @return [undefined]
+  #
+  # @api public
+  def self.collection(name)
+    new(name, [Enumerable, Concord.new(name)])
+  end
+
+  # Initialize a new instance
+  #
+  # @param [#to_s] name
+  #   the name of the enumerable
+  #
+  # @param [#each] modules
+  #   the modules to include into a host
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def initialize(name, modules)
+    @modules, @body = modules, ->(&block) {
+      return to_enum unless block
+      instance_variable_get(:"@#{name}").each(&block)
+      self
+    }
+  end
+
+  private
+
+  # Define the #each method on the host and include modules
+  #
+  # @param [Object] host
+  #   the hosting object
+  #
+  # @return [undefined]
+  #
+  # @api private
+  def included(host)
+    host.instance_exec(@modules, @body) do |modules, body|
+      include(*modules)
+      define_method(:each, &body)
+    end
+  end
+end # Lupo

data/lib/lupo/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+class Lupo < Module
+  # Gem version
+  VERSION = '0.0.1'.freeze
+end

data/lupo.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+require File.expand_path('../lib/lupo/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "lupo"
+  gem.version     = Lupo::VERSION.dup
+  gem.authors     = [ 'Martin Gamsjaeger (snusnu)' ]
+  gem.email       = [ 'gamsnjaga@gmail.com' ]
+  gem.description = 'Adds an #each method to your objects'
+  gem.summary     = 'A module that installs an #each method and includes Enumerable'
+  gem.homepage    = 'https://github.com/snusnu/lupo'
+
+  gem.require_paths    = [ 'lib' ]
+  gem.files            = `git ls-files`.split("\n")
+  gem.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  gem.extra_rdoc_files = %w[LICENSE README.md CONTRIBUTING.md]
+  gem.license          = 'MIT'
+
+  gem.add_dependency 'concord', '~> 0.1.4'
+
+  gem.add_development_dependency 'bundler', '~> 1.3.5'
+end

data/spec/lupo_spec.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+shared_context 'lupo' do
+  subject { klass.new(entries) }
+
+  let(:entries) { [42] }
+
+  it 'provides an #each method' do
+    expect { |b| subject.each(&b) }.to yield_successive_args(*entries)
+  end
+
+  it 'includes Enumerable' do
+    expect(subject).to be_kind_of(Enumerable)
+  end
+
+  it 'works without a block' do
+    expect(subject.each).to be_instance_of(Enumerator)
+  end
+
+  it 'returns self from #each' do
+    expect(subject.each {}).to be(subject)
+  end
+end
+
+describe Lupo do
+  context '.enumerable' do
+    include_context 'lupo'
+
+    let(:klass) do
+      Class.new do
+        include Lupo.enumerable(:entries)
+        def initialize(entries)
+          @entries = entries
+        end
+      end
+    end
+  end
+
+  context '.collection' do
+    include_context 'lupo'
+
+    let(:klass) do
+      Class.new do
+        include Lupo.collection(:entries)
+      end
+    end
+
+    it 'should include a concord instance' do
+      expect(klass.ancestors).to include(Concord.new(:entries))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name     'spec:unit'
+    add_filter       'config'
+    add_filter       'spec'
+    minimum_coverage 100
+  end
+end
+
+require 'lupo'
+require 'devtools/spec_helper'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: lupo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Martin Gamsjaeger (snusnu)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+description: ! 'Adds an #each method to your objects'
+email:
+- gamsnjaga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- CONTRIBUTING.md
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.devtools
+- LICENSE
+- README.md
+- Rakefile
+- config/devtools.yml
+- config/flay.yml
+- config/flog.yml
+- config/mutant.yml
+- config/reek.yml
+- config/rubocop.yml
+- config/yardstick.yml
+- lib/lupo.rb
+- lib/lupo/version.rb
+- lupo.gemspec
+- spec/lupo_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/snusnu/lupo
+licenses:
+- MIT
+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.23
+signing_key: 
+specification_version: 3
+summary: ! 'A module that installs an #each method and includes Enumerable'
+test_files: []
+has_rdoc: