ivar_equatable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b276b45a3ef1e65428e5748139a67361eb10d1dd1275c4a7907945f171202ca
+  data.tar.gz: 9561022fa9dd03dbc7b01ffb91e168aaaafb4c041ded1baff13e26515882fe6e
+SHA512:
+  metadata.gz: a08b829d40cbd66599cd8e471153e735493e855ab755980531fe03006cdf92a8eb5ec7b32853e9859c3ef37c43ba173c33d14ccc41504f626cb74da1ee602c0c
+  data.tar.gz: 4cb9b95f370cffbeab8cf99631c50639cd89692c310a2414f15b0a67b418bcd6e96249502ddb8e9524d0d24bf6d03903768b85afa1ac197f5dea18d8ef6adeed

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  rubocop-espago: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-21
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in diggable.gemspec
+gemspec
+
+gem 'minitest', '~> 5.0' # test framework
+gem 'rake', '~> 13.0' # automation tasks
+gem 'rubocop-espago', '~> 1.0' # ruby linter
+gem 'shoulda-context', '~> 2.0' # more pleasant test syntax
+gem 'solargraph', '~> 0.48'  # language server

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    ivar_equatable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.1)
+    diff-lcs (1.5.0)
+    e2mmap (0.1.0)
+    jaro_winkler (1.5.4)
+    json (2.6.3)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    minitest (5.17.0)
+    nokogiri (1.14.2-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.14.2-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    racc (1.6.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rubocop (1.45.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    rubocop-espago (1.0.2)
+      rubocop
+    ruby-progressbar (1.11.0)
+    shoulda-context (2.0.0)
+    solargraph (0.48.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.2.1)
+    tilt (2.1.0)
+    unicode-display_width (2.4.2)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  arm64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  ivar_equatable!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rubocop-espago (~> 1.0)
+  shoulda-context (~> 2.0)
+  solargraph (~> 0.48)
+
+BUNDLED WITH
+   2.4.7

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Mateusz Drewniak
+
+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,92 @@
+# IvarEquatable
+
+This Ruby gem which adds a module which when included to a class enables its instances to be compared based on their instance variables.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add ivar_equatable
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install ivar_equatable
+
+## Usage
+
+Include the `IvarEquatable` module in your class to make its
+instances capable of comparing themselves with the `==` and `eql?` methods.
+
+In order for two objects to be equal, they've got to have
+the same instance variables, and the values stored in them have to return
+`true` when compared using the `==` operator.
+
+```rb
+class MyClass
+    include IvarEquatable
+
+    attr_accessor :foo, :bar
+
+    def initialize(foo: nil, bar: nil)
+        @foo = foo
+        @bar = bar
+    end
+end
+
+obj1 = MyClass.new foo: :some_value
+obj2 = MyClass.new foo: :some_value
+obj1 == obj2 #=> true
+
+obj1 = MyClass.new foo: :some_value
+obj2 = MyClass.new foo: :other_value
+obj1 == obj2 #=> false
+
+obj1 = MyClass.new foo: :some_value
+obj2 = MyClass.new foo: :some_value, bar: 2
+obj1 == obj2 #=> false
+
+obj1 = MyClass.new foo: { some: { nested: [:hash, :and, :array] } }
+obj2 = MyClass.new foo: { some: { nested: [:hash, :and, :array] } }
+obj1 == obj2 #=> true
+
+obj1 = MyClass.new foo: { some: { nested: [:hash, :and, :array] } }
+obj2 = MyClass.new foo: { some: { nested: :different } }
+obj1 == obj2 #=> false
+
+# works on subclasses
+class ChildClass < MyClass; end
+
+obj1 = MyClass.new foo: :some_value
+obj2 = ChildClass.new foo: :some_value
+obj1 == obj2 #=> true
+
+# comparing instances of unrelated classes always returns `false`
+class NonRelatedClass
+    include IvarEquatable
+
+    attr_accessor :foo, :bar
+
+    def initialize(foo: nil, bar: nil)
+        @foo = foo
+        @bar = bar
+    end
+end
+
+obj1 = MyClass.new foo: :some_value
+obj2 = NonRelatedClass.new foo: :some_value
+obj1 == obj2 #=> false
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Verseth/ivar_equatable.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+::Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = ::FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+::RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/ivar_equatable/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module IvarEquatable
+  # @return [String]
+  VERSION = '0.1.0'
+end

data/lib/ivar_equatable.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'set'
+
+require_relative 'ivar_equatable/version'
+
+# Include in a class to make its instances capable
+# of comparing themselves with other objects of the same class
+# by calling `==` on their instance variables.
+#
+# Example:
+#
+#     class MyClass
+#       include IvarEquatable
+#
+#       attr_accessor :foo, :bar
+#
+#       def initialize(foo: nil, bar: nil)
+#         @foo = foo
+#         @bar = bar
+#       end
+#     end
+#
+#     obj1 = MyClass.new foo: :some_value
+#     obj2 = MyClass.new foo: :some_value
+#     obj1 == obj2 #=> true
+#
+#     obj1 = MyClass.new foo: :some_value
+#     obj2 = MyClass.new foo: :other_value
+#     obj1 == obj2 #=> false
+#
+#     obj1 = MyClass.new foo: :some_value
+#     obj2 = MyClass.new foo: :some_value, bar: 2
+#     obj1 == obj2 #=> false
+#
+module IvarEquatable
+  # @param other [Object]
+  # @return [Boolean]
+  def eql?(other)
+    return true if equal?(other)
+    return false unless other.is_a?(self.class) || is_a?(other.class)
+
+    # @type [Set<Symbol>]
+    self_ivars = instance_variables.to_set
+    # @type [Set<Symbol>]
+    other_ivars = other.instance_variables.to_set
+
+    return false unless self_ivars == other_ivars
+
+    self_ivars.each do |ivar|
+      return false if instance_variable_get(ivar) != other.instance_variable_get(ivar)
+    end
+
+    true
+  end
+
+  alias == eql?
+end

data/sig/ivar_equatable.rbs

@@ -0,0 +1,4 @@
+module IvarEquatable
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: ivar_equatable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mateusz Drewniak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-21 00:00:00.000000000 Z
+dependencies: []
+description: A Ruby gem which adds a module which when includedin a class enables
+  its instances to be compared based on their instance variables.
+email:
+- matmg24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/ivar_equatable.rb
+- lib/ivar_equatable/version.rb
+- sig/ivar_equatable.rbs
+homepage: https://github.com/Verseth/ruby-ivar_equatable
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Verseth/ruby-ivar_equatable
+  source_code_uri: https://github.com/Verseth/ruby-ivar_equatable
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.7
+signing_key:
+specification_version: 4
+summary: A Ruby gem which adds a module which when includedin a class enables its
+  instances to be compared based on their instance variables.
+test_files: []