concord 0.1.1 → 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 00e1baf3ada59ca39db75ee30475ab7f0cee4de044b7e3656f9de5265e7468a9
+  data.tar.gz: 709c2cce624598048899d5335dc45d1922caccb4aa9347bbf010477de9145496
+SHA512:
+  metadata.gz: 6e79d310bb26e6291a5935d1dbe5a91dce9cac422cd9922971b14dc5429e6c284aaa4f5777fc42a506599b79a0034275377d514f15c42b152282dc0651ffb551
+  data.tar.gz: 9211e15e7bf7ccfa4dd7c20f1768cf72c6362a82e0066a308c0342cae2eabd5ea29efed345c27ab0c0d5250b208a7c7f27e3d2e38b03fc1e8577778d6054f476

data/lib/concord.rb

@@ -5,6 +5,9 @@ require 'equalizer'
 class Concord < Module
   include Adamantium::Flat, Equalizer.new(:names)
 
+  # The maximum number of objects the hosting class is composed of
+  MAX_NR_OF_OBJECTS = 3
+
   # Return names
   #
   # @return [Enumerable<Symbol>]
@@ -13,7 +16,7 @@ class Concord < Module
   #
   attr_reader :names
 
-private
+  private
 
   # Initialize object
   #
@@ -22,68 +25,70 @@ private
   # @api private
   #
   def initialize(*names)
-    if names.length > 3
-      raise 'Composition of more than three objects is not allowed'
+    if names.length > MAX_NR_OF_OBJECTS
+      fail "Composition of more than #{MAX_NR_OF_OBJECTS} objects is not allowed"
     end
 
-    @names = names
+    @names, @module = names, Module.new
+    define_initialize
+    define_readers
+    define_equalizer
   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)
+    descendant.send(:include, @module)
   end
 
   # Define equalizer
   #
-  # @param [Class|Module] descendant
-  #
   # @return [undefined]
   #
   # @api private
   #
-  def define_equalizer(descendant)
-    descendant.send(:include, Equalizer.new(*@names))
+  def define_equalizer
+    @module.send(:include, Equalizer.new(*@names))
   end
 
   # Define readers
   #
-  # @param [Class|Module] descendant
-  #
   # @return [undefined]
   #
   # @api private
   #
-  def define_readers(descendant)
+  def define_readers
     attribute_names = names
-    descendant.send(:attr_reader, *attribute_names)
-    descendant.send(:protected, *attribute_names)
+    @module.class_eval do
+      attr_reader(*attribute_names)
+      protected(*attribute_names)
+    end
   end
 
-  # Define initializer
-  #
-  # @param [Class|Module] descendant
+  # Define initialize method
   #
   # @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
+  # rubocop:disable MethodLength
+  #
+  def define_initialize
+    ivars, size = instance_variable_names, names.size
+    @module.class_eval do
+      define_method :initialize do |*args|
+        args_size = args.size
+        if args_size != size
+          fail ArgumentError, "wrong number of arguments (#{args_size} for #{size})"
+        end
+        ivars.zip(args) { |ivar, arg| instance_variable_set(ivar, arg) }
+      end
+      private :initialize
+    end
   end
 
   # Return instance variable names
@@ -93,23 +98,13 @@ private
   # @api private
   #
   def instance_variable_names
-    names.map { |name| "@#{name}" }.join(', ')
-  end
-
-  # Return param names
-  #
-  # @return [String]
-  #
-  # @api private
-  #
-  def argument_names
-    names.join(', ')
+    names.map { |name| "@#{name}" }
   end
 
   # Mixin for public attribute readers
   class Public < self
 
-    # Hook called when module is included 
+    # Hook called when module is included
     #
     # @param [Class,Module] descendant
     #

metadata

@@ -1,98 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: concord
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.6
 platform: ruby
 authors:
 - Markus Schirp
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-05-21 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: adamantium
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: equalizer
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.9
+- !ruby/object:Gem::Dependency
+  name: devtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.26
 description: Helper for object composition
 email:
-- mbj@seonic.net
+- mbj@schirp-dso.com
 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/reek.yml
-- config/roodi.yml
-- 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: 
+homepage: https://github.com/mbj/concord
+licenses:
+- MIT
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 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
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
 summary: Helper for object composition
 test_files: []
-has_rdoc: 

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -1,18 +0,0 @@
-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

@@ -1,19 +0,0 @@
-# v0.1.1 2013-05-15
-
-+ Add Concord::Public mixin defaulting to public attr_readers
-
-# v0.1.0 2013-05-15
-
-* [change] Set default attribute visibility to protected
-
-# v0.0.3 2013-03-08
-
-* [fix] 1.9.2 visibility problem
-
-# v0.0.2 2013-03-07
-
-* [change] remove unneded backports dependency
-
-# v0.0.1 2013-03-06
-
-* First public release!

data/Gemfile

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

data/Gemfile.devtools

@@ -1,60 +0,0 @@
-# encoding: utf-8
-
-group :development do
-  gem 'rake',  '~> 10.0.4'
-  gem 'rspec', '~> 2.13.0'
-  gem 'yard',  '~> 0.8.6.1'
-end
-
-group :yard do
-  gem 'kramdown', '~> 1.0.1'
-end
-
-group :guard do
-  gem 'guard',         '~> 1.8.0'
-  gem 'guard-bundler', '~> 1.0.0'
-  gem 'guard-rspec',   '~> 2.5.4'
-
-  # file system change event handling
-  gem 'listen',     '~> 1.0.2'
-  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 'backports',       '~> 3.3', '>= 3.3.0'
-  gem 'coveralls',       '~> 0.6.6'
-  gem 'flay',            '~> 2.2.0'
-  gem 'flog',            '~> 4.0.0'
-  gem 'reek',            '~> 1.3.1', :git => 'https://github.com/troessner/reek.git'
-  gem 'simplecov',       '~> 0.7.1'
-  gem 'yardstick',       '~> 0.9.6'
-
-  platforms :ruby_19 do
-    gem 'yard-spellcheck', '~> 0.1.5'
-  end
-
-  platforms :mri_19, :rbx do
-    gem 'mutant', '~> 0.2.20'
-  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.5'
-  end
-end

data/Guardfile

@@ -1,8 +0,0 @@
-# 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

@@ -1,20 +0,0 @@
-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

@@ -1,81 +0,0 @@
-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
-  protected :foo
-
-  # Return bar
-  #
-  # @return [Bar]
-  #
-  # @api private
-  #
-  attr_reader :bar
-  protected :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

@@ -1,29 +0,0 @@
-require 'devtools'
-Devtools.init_rake_tasks
-
-class Rake::Task
-  def overwrite(&block)
-    @actions.clear
-    enhance(&block)
-  end
-end
-
-Rake.application.load_imports
-
-begin
-  require 'mutant'
-rescue LoadError
-end
-
-mutant_present = defined?(Mutant)
-
-allowed_versions = %w(mri-1.9.3 rbx-1.9.3)
-
-if allowed_versions.include?(Devtools.rvm) and mutant_present and !ENV['DEVTOOLS_SELF']
-  Rake::Task['metrics:mutant'].overwrite do
-    status = Mutant::CLI.run(%W(--rspec-full -r ./spec/spec_helper.rb ::Concord))
-    unless status.zero?
-      fail "Not mutation covered :("
-    end
-  end
-end

data/concord.gemspec

@@ -1,19 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name        = 'concord'
-  s.version     = '0.1.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('adamantium',          '~> 0.0.7')
-  s.add_dependency('equalizer',           '~> 0.0.5')
-end

data/config/flay.yml

@@ -1,3 +0,0 @@
----
-threshold: 5
-total_score: 13.0

data/config/flog.yml

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

data/config/mutant.yml

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

data/config/reek.yml

@@ -1,90 +0,0 @@
-UncommunicativeParameterName:
-  accept: []
-  exclude: []
-  enabled: true
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-TooManyMethods:
-  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
-TooManyStatements:
-  max_statements: 5
-  exclude: []
-  enabled: true
-DuplicateMethodCall:
-  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]/
-RepeatedConditional:
-  enabled: true
-  max_ifs: 1
-DataClump:
-  exclude: []
-  enabled: true
-  max_copies: 0
-  min_clump_size: 2
-ControlParameter:
-  exclude: []
-  enabled: true
-LongYieldList:
-  max_params: 0
-  exclude: []
-  enabled: true

data/config/roodi.yml

@@ -1,20 +0,0 @@
----
-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/yardstick.yml

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

data/spec/spec_helper.rb

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

data/spec/unit/concord/universal_spec.rb

@@ -1,77 +0,0 @@
-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
-        # Nicer 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(83)
-        end
-        klass.send(:include, Concord.new)
-      end
-    end
-  end
-
-  context 'visibiluty' do
-    it 'should set attribute readers to public' do
-      klass = Class.new
-      klass.send(:include, Concord.new(:foo))
-      klass.protected_instance_methods.map(&:to_sym).should == [:foo]
-    end
-  end
-
-  context 'attribute behavior' do
-    subject { instance_a }
-
-    specify { subject.send(:foo).should be(foo) }
-    specify { subject.send(: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
-
-  context Concord::Public do
-    let(:class_under_test) do
-      Class.new do
-        include Concord::Public.new(:foo, :bar)
-      end
-    end
-
-    it 'should create public attr readers' do
-      object = class_under_test.new(:foo, :bar)
-      object.foo.should eql(:foo)
-      object.bar.should eql(:bar)
-    end
-  end
-end