dry-equalizer 0.1.0 → 0.3.0

data/Rakefile

@@ -1,5 +1,8 @@
 require 'bundler'
-require 'devtools'
 
 Bundler::GemHelper.install_tasks
-Devtools.init_rake_tasks
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: [:spec]

data/docsite/source/index.html.md

@@ -0,0 +1,86 @@
+---
+title: Introduction & Usage
+description: Simple mixin providing equality, equivalence and inspection methods
+layout: gem-single
+order: 5
+type: gem
+name: dry-equalizer
+---
+
+`dry-equalizer` is a simple mixin that can be used to add instance variable based equality, equivalence and inspection methods to your objects.
+
+### Usage
+
+```ruby
+require 'dry-equalizer'
+
+class GeoLocation
+  include Dry::Equalizer(:latitude, :longitude)
+
+  attr_reader :latitude, :longitude
+
+  def initialize(latitude, longitude)
+    @latitude, @longitude = latitude, longitude
+  end
+end
+
+point_a = GeoLocation.new(1, 2)
+point_b = GeoLocation.new(1, 2)
+point_c = GeoLocation.new(2, 2)
+
+point_a.inspect    # => "#<GeoLocation latitude=1 longitude=2>"
+
+point_a == point_b           # => true
+point_a.hash == point_b.hash # => true
+point_a.eql?(point_b)        # => true
+point_a.equal?(point_b)      # => false
+
+point_a == point_c           # => false
+point_a.hash == point_c.hash # => false
+point_a.eql?(point_c)        # => false
+point_a.equal?(point_c)      # => false
+```
+
+### Configuration options
+
+#### `inspect`
+
+Use `inspect` option to skip `#inspect` method overloading:
+
+```ruby
+class Foo
+  include Dry::Equalizer(:a, inspect: false)
+
+  attr_reader :a, :b
+
+  def initialize(a, b)
+    @a, @b = a, b
+  end
+end
+
+Foo.new(1, 2).inspect
+# => "#<Foo:0x00007fbc9c0487f0 @a=1, @b=2>"
+```
+
+#### `immutable`
+
+For objects that are immutable it doesn't make sense to calculate `#hash` every time it's called. To memoize hash use `immutable` option:
+
+```ruby
+class ImmutableHash
+  include Dry::Equalizer(:foo, :bar, immutable: true)
+
+  attr_accessor :foo, :bar
+
+  def initialize(foo, bar)
+    @foo, @bar = foo, bar
+  end
+end
+
+obj = ImmutableHash.new('foo', 'bar')
+old_hash = obj.hash
+obj.foo = 'changed'
+old_hash == obj.hash
+# => true
+```
+

data/dry-equalizer.gemspec

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require File.expand_path('../lib/dry/equalizer/version', __FILE__)
 
 Gem::Specification.new do |gem|
@@ -9,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.email       = %w[dan.kubb@gmail.com mbj@schirp-dso.com]
   gem.description = 'Module to define equality, equivalence and inspection methods'
   gem.summary     = gem.description
-  gem.homepage    = 'https://github.com/dkubb/equalizer'
+  gem.homepage    = 'https://github.com/dry-rb/dry-equalizer'
   gem.licenses    = 'MIT'
 
   gem.require_paths    = %w[lib]
@@ -17,7 +15,5 @@ Gem::Specification.new do |gem|
   gem.test_files       = `git ls-files -- spec/{unit,integration}`.split("\n")
   gem.extra_rdoc_files = %w[LICENSE README.md CONTRIBUTING.md]
 
-  gem.required_ruby_version = '>= 2.1.0'
-
-  gem.add_development_dependency('bundler', '~> 1.3', '>= 1.3.5')
+  gem.required_ruby_version = '>= 2.4.0'
 end

data/lib/dry/equalizer.rb

@@ -1,11 +1,9 @@
-# encoding: utf-8
-
 module Dry
   # Build an equalizer module for the inclusion in other class
   #
   # @api public
-  def self.Equalizer(*keys)
-    Dry::Equalizer.new(*keys)
+  def self.Equalizer(*keys, **options)
+    Dry::Equalizer.new(*keys, **options)
   end
 
   # Define equality, equivalence and inspection methods
@@ -16,13 +14,16 @@ module Dry
     # #hash, and #inspect
     #
     # @param [Array<Symbol>] keys
+    # @param [Hash] options
+    # @option options [Boolean] :inspect whether to define #inspect method
+    # @option options [Boolean] :immutable whether to memoize #hash method
     #
     # @return [undefined]
     #
     # @api private
-    def initialize(*keys)
-      @keys = keys
-      define_methods
+    def initialize(*keys, **options)
+      @keys = keys.uniq
+      define_methods(**options)
       freeze
     end
 
@@ -43,13 +44,16 @@ module Dry
 
     # Define the equalizer methods based on #keys
     #
+    # @param [Boolean] inspect whether to define #inspect method
+    # @param [Boolean] immutable whether to memoize #hash method
+    #
     # @return [undefined]
     #
     # @api private
-    def define_methods
+    def define_methods(inspect: true, immutable: false)
       define_cmp_method
-      define_hash_method
-      define_inspect_method
+      define_hash_method(immutable: immutable)
+      define_inspect_method if inspect
     end
 
     # Define an #cmp? method based on the instance's values identified by #keys
@@ -72,10 +76,20 @@ module Dry
     # @return [undefined]
     #
     # @api private
-    def define_hash_method
-      keys = @keys
-      define_method(:hash) do | |
-        keys.map(&method(:send)).push(self.class).hash
+    def define_hash_method(immutable:)
+      calculate_hash = ->(obj) { @keys.map { |key| obj.__send__(key) }.push(obj.class).hash }
+      if immutable
+        define_method(:hash) do
+          @__hash__ ||= calculate_hash.call(self)
+        end
+        define_method(:freeze) do
+          hash
+          super()
+        end
+      else
+        define_method(:hash) do
+          calculate_hash.call(self)
+        end
       end
     end
 
@@ -86,10 +100,10 @@ module Dry
     # @api private
     def define_inspect_method
       keys = @keys
-      define_method(:inspect) do | |
+      define_method(:inspect) do
         klass = self.class
-      name  = klass.name || klass.inspect
-      "#<#{name}#{keys.map { |key| " #{key}=#{__send__(key).inspect}" }.join}>"
+        name  = klass.name || klass.inspect
+        "#<#{name}#{keys.map { |key| " #{key}=#{__send__(key).inspect}" }.join}>"
       end
     end
 
@@ -122,8 +136,8 @@ module Dry
       #
       # @api public
       def ==(other)
-        other.kind_of?(self.class) && cmp?(__method__, other)
+        other.is_a?(self.class) && cmp?(__method__, other)
       end
-    end # module Methods
-  end # class Equalizer
+    end
+  end
 end

data/lib/dry/equalizer/version.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
-
 module Dry
   class Equalizer < Module
     # Gem version
-    VERSION = '0.1.0'.freeze
-  end # class Equalizer
+    VERSION = '0.3.0'.freeze
+  end
 end

data/spec/spec_helper.rb

@@ -1,26 +1,20 @@
-# encoding: utf-8
-
 if ENV['COVERAGE'] == 'true'
   require 'simplecov'
-
   SimpleCov.start do
-    command_name 'spec:unit'
-
-    add_filter 'config'
-    add_filter 'spec'
-    add_filter 'vendor'
-
-    minimum_coverage 100
+    add_filter '/spec/'
   end
 end
 
-require 'devtools/spec_helper'
 require 'dry-equalizer'
 
 RSpec.configure do |config|
   config.raise_errors_for_deprecations!
 
+  config.disable_monkey_patching!
+
   config.expect_with :rspec do |expect_with|
     expect_with.syntax = :expect
   end
+
+  config.warnings = true
 end

data/spec/support/config_alias.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'rbconfig'
 
 ::Config = RbConfig unless defined?(::Config)

data/spec/unit/equalizer/included_spec.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
-
 require 'spec_helper'
 
-describe Dry::Equalizer, '#included' do
+RSpec.describe Dry::Equalizer, '#included' do
   subject { descendant.instance_exec(object) { |mod| include mod } }
 
   let(:object)     { described_class.new        }

data/spec/unit/equalizer/methods/eql_predicate_spec.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
-
 require 'spec_helper'
 
-describe Dry::Equalizer::Methods, '#eql?' do
+RSpec.describe Dry::Equalizer::Methods, '#eql?' do
   subject { object.eql?(other) }
 
   let(:object) { described_class.new(true) }

data/spec/unit/equalizer/methods/equality_operator_spec.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
-
 require 'spec_helper'
 
-describe Dry::Equalizer::Methods, '#==' do
+RSpec.describe Dry::Equalizer::Methods, '#==' do
   subject { object == other }
 
   let(:object)          { described_class.new(true) }

data/spec/unit/equalizer/universal_spec.rb

@@ -1,9 +1,6 @@
-# encoding: utf-8
-
 require 'spec_helper'
 
-describe Dry::Equalizer do
-  let(:object) { described_class }
+RSpec.describe Dry::Equalizer do
   let(:name)   { 'User'          }
   let(:klass)  { ::Class.new     }
 
@@ -13,12 +10,12 @@ describe Dry::Equalizer do
     before do
       # specify the class #name method
       allow(klass).to receive(:name).and_return(name)
-      klass.send(:include, subject)
+      klass.include(subject)
     end
 
     let(:instance) { klass.new }
 
-    it { should be_instance_of(object) }
+    it { should be_instance_of(described_class) }
 
     it { should be_frozen }
 
@@ -83,6 +80,7 @@ describe Dry::Equalizer do
     let(:klass) do
       ::Class.new do
         attr_reader :firstname, :lastname
+        attr_writer :firstname
         private :firstname, :lastname
 
         def initialize(firstname, lastname)
@@ -95,10 +93,10 @@ describe Dry::Equalizer do
     before do
       # specify the class #inspect method
       allow(klass).to receive_messages(name: nil, inspect: name)
-      klass.send(:include, subject)
+      klass.include(subject)
     end
 
-    it { should be_instance_of(object) }
+    it { should be_instance_of(described_class) }
 
     it { should be_frozen }
 
@@ -154,5 +152,87 @@ describe Dry::Equalizer do
           .to eql('#<User firstname="John" lastname="Doe">')
       end
     end
+
+    context 'when immutable' do
+      describe '#hash' do
+
+        subject { Dry::Equalizer(*keys, immutable: true) }
+
+        it 'returns memoized hash' do
+          expect { instance.firstname = 'Changed' }.not_to(change { instance.hash })
+        end
+        
+        context 'when frozen' do
+          it 'returns memoized hash' do
+            instance.freeze
+
+            expect(instance.hash)
+              .to eql([firstname, lastname, klass].hash)
+          end
+        end
+      end
+    end
+  end
+
+  context 'with duplicate keys' do
+    subject { Dry::Equalizer(*keys) }
+
+    let(:keys)       { %i[firstname firstname lastname].freeze  }
+    let(:firstname)  { 'John'                                   }
+    let(:lastname)   { 'Doe'                                    }
+    let(:instance)   { klass.new(firstname, lastname)           }
+
+    let(:klass) do
+      ::Class.new do
+        attr_reader :firstname, :lastname
+        private :firstname, :lastname
+
+        def initialize(firstname, lastname)
+          @firstname = firstname
+          @lastname = lastname
+        end
+      end
+    end
+
+    before do
+      # specify the class #inspect method
+      allow(klass).to receive_messages(name: nil, inspect: name)
+      klass.include(subject)
+    end
+
+    it { should be_instance_of(described_class) }
+
+    it { should be_frozen }
+
+    describe '#inspect' do
+      it 'returns the expected string' do
+        expect(instance.inspect)
+          .to eql('#<User firstname="John" lastname="Doe">')
+      end
+    end
+  end
+
+  context 'with options' do
+    context 'w/o inspect' do
+      subject { Dry::Equalizer(*keys, inspect: false) }
+
+      let(:keys)       { %i[firstname lastname].freeze  }
+      let(:firstname)  { 'John'                         }
+      let(:lastname)   { 'Doe'                          }
+      let(:instance)   { klass.new(firstname, lastname) }
+
+      let(:klass) do
+        ::Struct.new(:firstname, :lastname)
+      end
+
+      before { klass.include(subject) }
+
+      describe '#inspect' do
+        it 'returns the default string' do
+          expect(instance.inspect).to eql('#<struct firstname="John", lastname="Doe">')
+          expect(instance.to_s).to eql('#<struct firstname="John", lastname="Doe">')
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-equalizer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Dan Kubb
@@ -9,28 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.5
+date: 2019-11-07 00:00:00.000000000 Z
+dependencies: []
 description: Module to define equality, equivalence and inspection methods
 email:
 - dan.kubb@gmail.com
@@ -42,24 +22,24 @@ extra_rdoc_files:
 - README.md
 - CONTRIBUTING.md
 files:
+- ".codeclimate.yml"
+- ".github/ISSUE_TEMPLATE/----please-don-t-ask-for-support-via-issues.md"
+- ".github/ISSUE_TEMPLATE/---bug-report.md"
+- ".github/ISSUE_TEMPLATE/---feature-request.md"
+- ".github/workflows/docsite.yml"
+- ".github/workflows/sync_configs.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - ".yardstick.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Gemfile
 - 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
+- docsite/source/index.html.md
 - dry-equalizer.gemspec
 - lib/dry-equalizer.rb
 - lib/dry/equalizer.rb
@@ -70,7 +50,7 @@ files:
 - spec/unit/equalizer/methods/eql_predicate_spec.rb
 - spec/unit/equalizer/methods/equality_operator_spec.rb
 - spec/unit/equalizer/universal_spec.rb
-homepage: https://github.com/dkubb/equalizer
+homepage: https://github.com/dry-rb/dry-equalizer
 licenses:
 - MIT
 metadata: {}
@@ -82,15 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Module to define equality, equivalence and inspection methods
@@ -99,4 +78,3 @@ test_files:
 - spec/unit/equalizer/methods/eql_predicate_spec.rb
 - spec/unit/equalizer/methods/equality_operator_spec.rb
 - spec/unit/equalizer/universal_spec.rb
-has_rdoc: