concord 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+/tmp
+/Gemfile.lock
+/.bundle
+/vendor

data/.rspec

@@ -0,0 +1,5 @@
+--color
+--format progress
+--profile
+--order random
+--fail-fast

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+script: 'bundle exec rake ci'
+rvm:
+  - ree
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-18mode
+  - jruby-19mode
+  - jruby-head
+  - rbx-18mode
+  - rbx-19mode
+notifications:
+  irc: "irc.freenode.org#datamapper"
+  email:
+    - mbj@seonic.net

data/Changelog.md

@@ -0,0 +1,3 @@
+# v0.0.1 2013-03-06
+
+* First public release!

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'devtools', :git => 'https://github.com/datamapper/devtools.git'
+eval File.read('Gemfile.devtools')

data/Gemfile.devtools

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',  '~> 10.0.3'
+  gem 'rspec', '~> 2.13.0'
+  gem 'yard',  '~> 0.8.5'
+end
+
+group :yard do
+  gem 'kramdown', '~> 0.14.2'
+end
+
+group :guard do
+  gem 'guard',         '~> 1.6.2'
+  gem 'guard-bundler', '~> 1.0.0'
+  gem 'guard-rspec',   '~> 2.4.1'
+
+  # file system change event handling
+  gem 'rb-fchange', '~> 0.0.6', :require => false
+  gem 'rb-fsevent', '~> 0.9.3', :require => false
+  gem 'rb-inotify', '~> 0.9.0', :require => false
+
+  gem 'listen', '~> 0.7.3'
+
+  # 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 'flay',            '~> 2.1.0'
+  gem 'flog',            '~> 3.2.2'
+  gem 'reek',            '~> 1.3.1', :git => 'https://github.com/troessner/reek.git'
+  gem 'metric_fu-roodi', '~> 2.2.1'
+  gem 'yardstick',       '~> 0.9.4'
+
+  platforms :ruby_18, :ruby_19 do
+    # this indirectly depends on ffi which does not build on ruby-head
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platforms :mri_19, :rbx do
+    gem 'mutant', '~> 0.2.20'
+  end
+
+  platforms :mri_19 do
+    gem 'simplecov', '~> 0.7.1'
+  end
+
+  platforms :rbx do
+    gem 'pelusa', '~> 0.2.2'
+  end
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.8.2'
+  end
+end

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Markus Schirp
+
+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,79 @@
+concord
+=======
+
+[![Build Status](https://secure.travis-ci.org/mbj/concord.png?branch=master)](http://travis-ci.org/mbj/concord)
+[![Dependency Status](https://gemnasium.com/mbj/concord.png)](https://gemnasium.com/mbj/concord)
+[![Code Climate](https://codeclimate.com/github/mbj/concord.png)](https://codeclimate.com/github/mbj/concord)
+
+Library to transform this:
+
+```ruby
+class ComposedObject
+  include Equalizer.new(:foo, :bar)
+
+  # Return foo
+  # 
+  # @return [Foo]
+  #
+  # @api private
+  #
+  attr_reader :foo
+
+  # Return bar
+  #
+  # @return [Bar]
+  #
+  # @api private
+  #
+  attr_reader :bar
+
+  # Initialize object
+  #
+  # @param [Foo] foo
+  # @param [Bar] bar
+  #
+  # @return [undefined]
+  #
+  # @api private
+  #
+  def initialize(foo, bar)
+    @foo, @bar = foo, bar
+  end
+end
+```
+
+Into shorter and easier to parse by eyes:
+
+```ruby
+class ComposedObject
+  include Concord.new(:foo, :bar)
+end
+```
+
+Sure the replacement is missing YARD docs, but IMHO it is better.
+
+Installation
+------------
+
+Install the gem `concord` via your prefered method.
+
+Credits
+-------
+
+* [mbj](https://github.com/mbj)
+
+Contributing
+-------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with Rakefile or version
+  (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)
+* Send me a pull request. Bonus points for topic branches.
+
+License
+-------
+
+See LICENSE

data/Rakefile

@@ -0,0 +1,2 @@
+require 'devtools'
+Devtools.init_rake_tasks

data/concord.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = 'concord'
+  s.version     = '0.0.1'
+  s.authors     = ['Markus Schirp']
+  s.email       = ['mbj@seonic.net']
+  s.homepage    = 'https://github.com/mbj/composition'
+  s.summary     = %q{Helper for object composition}
+  s.description = s.summary
+
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ['lib']
+
+  s.add_dependency('backports',           '~> 3.0.3')
+  s.add_dependency('adamantium',          '~> 0.0.7')
+  s.add_dependency('equalizer',           '~> 0.0.5')
+end

data/config/flay.yml

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

data/config/flog.yml

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

data/config/mutant.yml

@@ -0,0 +1,2 @@
+name: concord
+namespace: Concord

data/config/roodi.yml

@@ -0,0 +1,20 @@
+---
+AbcMetricMethodCheck:           
+  score: 25.1
+AssignmentInConditionalCheck:    { }
+CaseMissingElseCheck:            { }
+ClassLineCountCheck:             { line_count: 317 }
+ClassNameCheck:                  
+  pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/
+ClassVariableCheck:              { }
+CyclomaticComplexityBlockCheck:  { complexity: 3 }
+CyclomaticComplexityMethodCheck: { complexity: 4 }
+EmptyRescueBodyCheck:            { }
+ForLoopCheck:                    { }
+MethodLineCountCheck:            { line_count: 14 }
+MethodNameCheck:                 
+  pattern: !ruby/regexp /\A(?:[a-z\d](?:_?[a-z\d])+[?!=]?|\[\]=?|==|<=>|<<|[+*&|-])\z/
+ModuleLineCountCheck:            { line_count: 320 }
+ModuleNameCheck:                 
+  pattern: !ruby/regexp /\A(?:[A-Z]+|[A-Z][a-z](?:[A-Z]?[a-z])+)\z/
+ParameterNumberCheck:            { parameter_count: 3 }

data/config/site.reek

@@ -0,0 +1,90 @@
+UncommunicativeParameterName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LargeClass:
+  max_methods: 14
+  enabled: true
+  exclude: []
+  max_instance_variables: 4
+UncommunicativeMethodName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+LongParameterList:
+  max_params: 2
+  exclude: []
+  enabled: true
+  overrides: {}
+FeatureEnvy:
+  exclude:
+  - Concord#define_readers
+  enabled: true
+ClassVariable:
+  exclude: []
+  enabled: true
+BooleanParameter:
+  exclude: []
+  enabled: true
+IrresponsibleModule:
+  exclude: []
+  enabled: true
+UncommunicativeModuleName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+NestedIterators:
+  ignore_iterators: []
+  exclude: []
+  enabled: true
+  max_allowed_nesting: 1
+LongMethod:
+  max_statements: 5
+  exclude: []
+  enabled: true
+Duplication:
+  allow_calls: []
+  exclude: []
+  enabled: true
+  max_calls: 1
+UtilityFunction:
+  max_helper_calls: 0
+  exclude: []
+  enabled: true
+Attribute:
+  exclude: []
+  enabled: false
+UncommunicativeVariableName:
+  accept: []
+  exclude: []
+  enabled: true
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+SimulatedPolymorphism:
+  enabled: true
+  max_ifs: 1
+DataClump:
+  exclude: []
+  enabled: true
+  max_copies: 0
+  min_clump_size: 2
+ControlCouple:
+  exclude: []
+  enabled: true
+LongYieldList:
+  max_params: 0
+  exclude: []
+  enabled: true

data/config/yardstick.yml

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

data/lib/concord.rb

@@ -0,0 +1,108 @@
+require 'adamantium'
+require 'equalizer'
+
+# A mixin to define a composition
+class Concord < Module
+  include Adamantium::Flat, Equalizer.new(:names)
+
+  # Return names
+  #
+  # @return [Enumerable<Symbol>]
+  #
+  # @api private
+  #
+  attr_reader :names
+
+private
+
+  # Initialize object
+  #
+  # @return [undefined]
+  #
+  # @api private
+  #
+  def initialize(*names)
+    if names.length > 3
+      raise 'Composition of more than three objects is not allowed'
+    end
+
+    @names = names
+  end
+
+  # Hook run when module is included
+  #
+  # @param [Class|Module] descendant
+  #
+  # @return [undefined]
+  #
+  # @api private
+  #
+  def included(descendant)
+    define_initializer(descendant)
+    define_readers(descendant)
+    define_equalizer(descendant)
+  end
+
+  # Define equalizer
+  #
+  # @param [Class|Module] descendant
+  #
+  # @return [undefined]
+  #
+  # @api private
+  #
+  def define_equalizer(descendant)
+    descendant.send(:include, Equalizer.new(*@names))
+  end
+
+  # Define readers
+  #
+  # @param [Class|Module] descendant
+  #
+  # @return [undefined]
+  #
+  # @api private
+  #
+  def define_readers(descendant)
+    attribute_names = names
+    descendant.send(:attr_reader, *attribute_names)
+  end
+
+  # Define initializer
+  #
+  # @param [Class|Module] descendant
+  #
+  # @return [undefined]
+  #
+  # @api private
+  #
+  def define_initializer(descendant)
+    names = argument_names
+    descendant.class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+      def initialize(#{names})                # def initialize(foo, bar)
+        #{instance_variable_names} = #{names} #   @foo, @bar = foo, bar
+      end                                     # end
+    RUBY
+  end
+
+  # Return instance variable names
+  #
+  # @return [String]
+  #
+  # @api private
+  #
+  def instance_variable_names
+    names.map { |name| "@#{name}" }.join(', ')
+  end
+
+  # Return param names
+  #
+  # @return [String]
+  #
+  # @api private
+  #
+  def argument_names
+    names.join(', ')
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'devtools'
+require 'concord'
+Devtools.init_spec_helper

data/spec/unit/concord/universal_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Concord do
+
+  let(:class_under_test) do
+    Class.new do
+      include Concord.new(:foo, :bar)
+    end
+  end
+
+  let(:instance_a) { class_under_test.new(foo, bar) }
+  let(:instance_b) { class_under_test.new(foo, bar) }
+  let(:instance_c) { class_under_test.new(foo, mock('Baz')) }
+
+  let(:foo) { mock('Foo') }
+  let(:bar) { mock('Bar') }
+
+  context 'initializer lines' do
+    unless Devtools.jruby?
+      it 'sets initializer correctly' do
+        klass = Class.new
+        # Nicher way to assert this?
+        klass.should_receive(:class_eval) do |code, file, line|
+          file.should eql(File.expand_path('../../../../lib/concord.rb', __FILE__))
+          line.should be(82)
+        end
+        klass.send(:include, Concord.new)
+      end
+    end
+  end
+
+  context 'attribute behavior' do
+    subject { instance_a }
+
+    its(:foo) { should be(foo) }
+    its(:bar) { should be(bar) }
+  end
+
+  context 'equalization behavior' do
+    specify 'composed objects are equalized on attributes' do
+      instance_a.should      == instance_b
+      instance_a.hash.should == instance_b.hash
+      instance_a.should      eql(instance_b)
+
+      instance_a.should_not  == instance_c
+      instance_a.should_not  eql(instance_c)
+    end
+  end
+
+  context 'to much composition behavior' do
+    specify 'it raises an error' do
+      expect { Concord.new(:a, :b, :c, :d) }.to raise_error(RuntimeError, 'Composition of more than three objects is not allowed')
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: concord
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Markus Schirp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: backports
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: adamantium
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: equalizer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+description: Helper for object composition
+email:
+- mbj@seonic.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Changelog.md
+- Gemfile
+- Gemfile.devtools
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- concord.gemspec
+- config/flay.yml
+- config/flog.yml
+- config/mutant.yml
+- config/roodi.yml
+- config/site.reek
+- config/yardstick.yml
+- lib/concord.rb
+- spec/spec_helper.rb
+- spec/unit/concord/universal_spec.rb
+homepage: https://github.com/mbj/composition
+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.23
+signing_key: 
+specification_version: 3
+summary: Helper for object composition
+test_files: []
+has_rdoc: