equalizer 0.0.1

data/tasks/metrics/heckle.rake

@@ -0,0 +1,208 @@
+# encoding: utf-8
+
+$LOAD_PATH.unshift(File.expand_path('../../../lib', __FILE__))
+
+# original code by Ashley Moran:
+# http://aviewfromafar.net/2007/11/1/rake-task-for-heckling-your-specs
+
+begin
+  require 'pathname'
+  require 'heckle'
+  require 'mspec'
+  require 'mspec/utils/name_map'
+
+  SKIP_METHODS = %w[ blank_slate_method_added ].freeze
+
+  class NameMap
+    def file_name(method, constant)
+      map  = MAP[method]
+      name = if map
+        map[constant] || map[:default]
+      else
+        method.gsub(/[?!=]\z/, '')
+      end
+      "#{name}_spec.rb"
+    end
+  end
+
+  namespace :metrics do
+    desc 'Heckle each module and class'
+    task :heckle => :coverage do
+      unless Ruby2Ruby::VERSION == '1.2.2'
+        raise "ruby2ruby version #{Ruby2Ruby::VERSION} may not work properly, 1.2.2 *only* is recommended for use with heckle"
+      end
+
+      require 'equalizer'
+
+      root_module_regexp = Regexp.union('Equalizer')
+
+      spec_dir = Pathname('spec/unit')
+
+      NameMap::MAP.each do |op, method|
+        next if method.kind_of?(Hash)
+        NameMap::MAP[op] = { :default => method }
+      end
+
+      aliases = Hash.new { |h,mod| h[mod] = Hash.new { |h,method| h[method] = method } }
+      map     = NameMap.new
+
+      heckle_caught_modules = Hash.new { |hash, key| hash[key] = [] }
+      uncovered_methods = 0
+
+      ObjectSpace.each_object(Module) do |mod|
+        next unless mod.name =~ /\A#{root_module_regexp}(?::|\z)/
+
+        spec_prefix = spec_dir.join(mod.name.underscore)
+
+        specs = []
+
+        # get the public class methods
+        metaclass  = class << mod; self end
+        ancestors  = metaclass.ancestors
+
+        spec_class_methods = mod.singleton_methods(false)
+
+        spec_class_methods.reject! do |method|
+          %w[ yaml_new yaml_tag_subclasses? included nesting constants ].include?(method.to_s)
+        end
+
+        if mod.ancestors.include?(Singleton)
+          spec_class_methods.reject! { |method| method.to_s == 'instance' }
+        end
+
+        # get the protected and private class methods
+        other_class_methods = metaclass.protected_instance_methods(false) |
+                              metaclass.private_instance_methods(false)
+
+        ancestors.each do |ancestor|
+          other_class_methods -= ancestor.protected_instance_methods(false) |
+                                 ancestor.private_instance_methods(false)
+        end
+
+        other_class_methods.reject! do |method|
+          method.to_s == 'allocate' || SKIP_METHODS.include?(method.to_s)
+        end
+
+        other_class_methods.reject! do |method|
+          next unless spec_class_methods.any? { |specced| specced.to_s == $1 }
+
+          spec_class_methods << method
+        end
+
+        spec_class_methods -= other_class_methods
+
+        # get the instances methods
+        spec_methods = mod.public_instance_methods(false)
+
+        other_methods = mod.protected_instance_methods(false) |
+                        mod.private_instance_methods(false)
+
+        other_methods.reject! do |method|
+          next unless spec_methods.any? { |specced| specced.to_s == $1 }
+
+          spec_methods << method
+        end
+
+        # map the class methods to spec files
+        spec_class_methods.each do |method|
+          method = aliases[mod.name][method]
+          next if SKIP_METHODS.include?(method.to_s)
+
+          spec_file = spec_prefix.join('class_methods').join(map.file_name(method, mod.name))
+
+          unless spec_file.file?
+            raise "No spec file #{spec_file} for #{mod}.#{method}"
+          end
+
+          specs << [ ".#{method}", [ spec_file ] ]
+        end
+
+        # map the instance methods to spec files
+        spec_methods.each do |method|
+          method = aliases[mod.name][method]
+          next if SKIP_METHODS.include?(method.to_s)
+
+          spec_file = spec_prefix.join(map.file_name(method, mod.name))
+
+          unless spec_file.file?
+            raise "No spec file #{spec_file} for #{mod}##{method}"
+          end
+
+          specs << [ "##{method}", [ spec_file ] ]
+        end
+
+        # non-public methods are considered covered if they can be mutated
+        # and any spec fails for the current or descendant modules
+        other_methods.each do |method|
+          descedant_specs = []
+
+          ObjectSpace.each_object(Module) do |descedant|
+            next unless descedant.name =~ /\A#{root_module_regexp}(?::|\z)/ && mod >= descedant
+            descedant_spec_prefix = spec_dir.join(descedant.name.underscore)
+            descedant_specs << descedant_spec_prefix
+
+            if method.to_s == 'initialize'
+              descedant_specs.concat(Pathname.glob(descedant_spec_prefix.join('class_methods/new_spec.rb')))
+            end
+          end
+
+          specs << [ "##{method}", descedant_specs ]
+        end
+
+        other_class_methods.each do |method|
+          descedant_specs = []
+
+          ObjectSpace.each_object(Module) do |descedant|
+            next unless descedant.name =~ /\A#{root_module_regexp}(?::|\z)/ && mod >= descedant
+            descedant_specs << spec_dir.join(descedant.name.underscore).join('class_methods')
+          end
+
+          specs << [ ".#{method}", descedant_specs ]
+        end
+
+        specs.sort.each do |(method, spec_files)|
+          puts "Heckling #{mod}#{method}"
+          IO.popen("spec #{spec_files.join(' ')} --heckle '#{mod}#{method}'") do |pipe|
+            while line = pipe.gets
+              case line = line.chomp
+                when "The following mutations didn't cause test failures:"
+                  heckle_caught_modules[mod.name] << method
+                  uncovered_methods += 1
+              end
+            end
+          end
+        end
+      end
+
+      if uncovered_methods > 0
+        error_message_lines = [ "*************\n" ]
+
+        error_message_lines << "Heckle found #{uncovered_methods} " \
+          "method#{"s" unless uncovered_methods == 1} " \
+          "where mutations didn't cause spec violations\n"
+
+        heckle_caught_modules.each do |mod, methods|
+          error_message_lines << "#{mod} contains the following " \
+            'poorly-specified methods:'
+          methods.each do |method|
+            error_message_lines << " - #{method}"
+          end
+          error_message_lines << ''
+        end
+
+        error_message_lines << 'Get your act together and come back ' \
+          'when your specs are doing their job!'
+
+        raise error_message_lines.join("\n")
+      else
+        puts 'Well done! Your code withstood a heckling.'
+      end
+    end
+  end
+rescue LoadError
+  namespace :metrics do
+    task :heckle => :coverage do
+      $stderr.puts 'Heckle or mspec is not available. In order to run heckle, you must: gem install heckle mspec'
+    end
+  end
+end

data/tasks/metrics/metric_fu.rake

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+begin
+  require 'metric_fu'
+  require 'json'
+
+  # XXX: temporary hack until metric_fu is fixed
+  MetricFu::Saikuro.class_eval { include FileUtils }
+
+  MetricFu::Configuration.run do |config|
+    config.rcov = {
+      :environment => 'test',
+      :test_files  => %w[ spec/**/*_spec.rb ],
+      :rcov_opts   => %w[
+        --sort coverage
+        --no-html
+        --text-coverage
+        --no-color
+        --profile
+        --exclude spec/,^/
+        --include lib:spec
+      ],
+    }
+  end
+rescue LoadError
+  namespace :metrics do
+    task :all do
+      $stderr.puts 'metric_fu is not available. In order to run metrics:all, you must: gem install metric_fu'
+    end
+  end
+end

data/tasks/metrics/reek.rake

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+begin
+  require 'reek/rake/task'
+
+  RBX_18_MODE = RUBY_VERSION < '1.9' && defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+
+  namespace :metrics do
+    Reek::Rake::Task.new do |t|
+      # reek has some problems under rbx in 1.8 mode that cause the underlying
+      # script to raise an exception. Rather than halt the "rake ci" process due
+      # to one bug, we choose to ignore it in this specific case until reek can be
+      # fixed.
+      t.fail_on_error = ! RBX_18_MODE  # always true, except under rbx 18 mode
+    end
+  end
+rescue LoadError
+  task :reek do
+    $stderr.puts 'Reek is not available. In order to run reek, you must: gem install reek'
+  end
+end

data/tasks/metrics/roodi.rake

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+begin
+  require 'roodi'
+  require 'rake/tasklib'
+  require 'roodi_task'
+
+  namespace :metrics do
+    RoodiTask.new do |t|
+      t.verbose  = false
+      t.config   = File.expand_path('../../../config/roodi.yml', __FILE__)
+      t.patterns = %w[ lib/**/*.rb ]
+    end
+  end
+rescue LoadError
+  task :roodi do
+    $stderr.puts 'Roodi is not available. In order to run roodi, you must: gem install roodi'
+  end
+end

data/tasks/metrics/yardstick.rake

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+begin
+  require 'yardstick/rake/measurement'
+  require 'yardstick/rake/verify'
+  require 'yaml'
+
+  config = YAML.load_file(File.expand_path('../../../config/yardstick.yml', __FILE__))
+
+  namespace :metrics do
+    # yardstick_measure task
+    Yardstick::Rake::Measurement.new
+
+    # verify_measurements task
+    Yardstick::Rake::Verify.new do |verify|
+      verify.threshold = config.fetch('threshold')
+    end
+  end
+rescue LoadError
+  %w[ yardstick_measure verify_measurements ].each do |name|
+    task name.to_s do
+      $stderr.puts "Yardstick is not available. In order to run #{name}, you must: gem install yardstick"
+    end
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+spec_defaults = lambda do |spec|
+  spec.ruby_opts = %w[ -r./spec/support/config_alias ]
+  spec.spec_opts << '--options' << 'spec/spec.opts'
+end
+
+begin
+  require 'spec/rake/spectask'
+
+  desc 'Run all specs'
+  task :spec => %w[ spec:unit spec:integration ]
+
+  namespace :spec do
+    desc 'Run unit specs'
+    Spec::Rake::SpecTask.new(:unit) do |unit|
+      spec_defaults.call(unit)
+      unit.pattern = 'spec/unit/**/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    Spec::Rake::SpecTask.new(:integration) do |integration|
+      spec_defaults.call(integration)
+      integration.pattern = 'spec/integration/**/*_spec.rb'
+    end
+  end
+rescue LoadError
+  %w[ spec spec:unit spec:integration ].each do |name|
+    task name do
+      $stderr.puts "rspec is not available. In order to run #{name}, you must: gem install rspec"
+    end
+  end
+end
+
+namespace :metrics do
+  begin
+    if RUBY_VERSION < '1.9'
+      desc 'Generate code coverage'
+      Spec::Rake::SpecTask.new(:coverage) do |rcov|
+        spec_defaults.call(rcov)
+        rcov.rcov      = true
+        rcov.pattern   = 'spec/unit/**/*_spec.rb'
+        rcov.rcov_opts = File.read('spec/rcov.opts').split(/\s+/)
+      end
+    else
+      desc 'Generate code coverage'
+      task :coverage do
+        ENV['COVERAGE'] = 'true'
+        Rake::Task['spec:unit'].execute
+      end
+    end
+  rescue LoadError
+    task :coverage do
+      lib = RUBY_VERSION < '1.9' ? 'rcov' : 'simplecov'
+      $stderr.puts "coverage is not available. In order to run #{lib}, you must: gem install #{lib}"
+    end
+  end
+end
+
+task :test => :spec

data/tasks/yard.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    $stderr.puts 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification 
+name: equalizer
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dan Kubb
+- Markus Schirp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-11-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: backports
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 2
+        - 6
+        - 4
+        version: 2.6.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: adamantium
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 75
+        segments: 
+        - 10
+        - 0
+        - 2
+        version: 10.0.2
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
+  type: :development
+  version_requirements: *id004
+description: Module to define equality, equivalence and inspection methods
+email: 
+- dan.kubb@gmail.com
+- mbj@seonic.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+- TODO
+files: 
+- .gitignore
+- .rvmrc
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO
+- config/flay.yml
+- config/flog.yml
+- config/roodi.yml
+- config/site.reek
+- config/yardstick.yml
+- equalizer.gemspec
+- lib/equalizer.rb
+- lib/equalizer/version.rb
+- spec/rcov.opts
+- spec/shared/command_method_behavior.rb
+- spec/shared/each_method_behaviour.rb
+- spec/shared/hash_method_behavior.rb
+- spec/shared/idempotent_method_behavior.rb
+- spec/shared/invertible_method_behaviour.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/support/config_alias.rb
+- spec/unit/equalizer/class_method/new_spec.rb
+- spec/unit/equalizer/methods/eql_spec.rb
+- spec/unit/equalizer/methods/equal_value_spec.rb
+- tasks/metrics/ci.rake
+- tasks/metrics/flay.rake
+- tasks/metrics/flog.rake
+- tasks/metrics/heckle.rake
+- tasks/metrics/metric_fu.rake
+- tasks/metrics/reek.rake
+- tasks/metrics/roodi.rake
+- tasks/metrics/yardstick.rake
+- tasks/spec.rake
+- tasks/yard.rake
+homepage: https://github.com/dkubb/equalizer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Module to define equality, equivalence and inspection methods
+test_files: []
+
+has_rdoc: