hashes_equal 0.1.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25706f6a131ad3135e14aae02f1c5d5afc3a60a2ed6286246ec0393f3e5aae13
-  data.tar.gz: dbf294af717937e6168a52c074e604afbd47d5e372285b9795e5ed3edceba73a
+  metadata.gz: 8447faaa13a7be85fdfb87288c12e005213add0fd43a1f0e9e9e29a037558b9e
+  data.tar.gz: c6a84ead82b663be2760573db2f392daf293e2167909a7adbc235b81706da484
 SHA512:
-  metadata.gz: 2bd45079a7d9a351f005fe39cee4ed1af442a28bab7e4375089cdd5db6d90e831a183a6c8b2e0721069f46683ea14c7ffc282ed78721ee50a14c067d581bc601
-  data.tar.gz: 4a7bcc44a3dd668bde4140428d8cfa9bee262137d6b5fad48afb7e5d11499f2900e6ca5ae50120b168e39146675d2e1be4fd4cf24af7db0af3bafcf1c0f13e21
+  metadata.gz: 4798ab8bc1b7b3734d57e27c1c3977376da8626637a97c5c9325e7eab4bdea19853035af3d4c39ae2b9b657242998e97c5a1ff88fb9994f5be55af3bbb9b0f2a
+  data.tar.gz: 21cb0631f064810aa7f1023e15748d01bd6d27165c9314406d01c85eacf72cd0986b292701facc00b520581d82ac3fcf58e7238d320c2165f099f4a98787bf53

data/.circleci/config.yml

@@ -0,0 +1,54 @@
+version: 2.1
+
+executors:
+  ruby:
+    docker:
+      - image: cimg/ruby:3.4.6
+    working_directory: ~/project
+
+commands:
+  bundle_install:
+    steps:
+      - restore_cache:
+          keys:
+            - v1-bundle-{{ checksum "Gemfile.lock" }}
+            - v1-bundle-
+      - run:
+          name: Bundle install
+          command: |
+            bundle config set path vendor/bundle
+            bundle install --jobs=4 --retry=3
+      - save_cache:
+          key: v1-bundle-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+
+jobs:
+  lint:
+    executor: ruby
+    steps:
+      - checkout
+      - bundle_install
+      - run:
+          name: Rubocop
+          command: make lint
+
+  test:
+    executor: ruby
+    steps:
+      - checkout
+      - bundle_install
+      - run:
+          name: Tests
+          command: make tests
+      - store_test_results:
+          path: tmp/tests/reports
+      - store_artifacts:
+          path: coverage/
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - lint
+      - test

data/.rubocop.yml

@@ -3,6 +3,7 @@ require:
 
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
 
 Layout/EmptyLinesAroundAttributeAccessor:
   Enabled: true
@@ -94,6 +95,9 @@ Style/RedundantRegexpEscape:
 Style/SlicingWithRange:
   Enabled: true
 
+Style/StringConcatenation:
+  Enabled: false
+
 # Metrics/ClassLength:
 #   Max: 250
 

data/.travis.yml

@@ -5,7 +5,6 @@ language: ruby
 cache: bundler
 rvm:
   - 2.6.6
-  - 2.7.0
 before_install:
   - gem install bundler -v 2.1.4
   - bundle --version

data/Dockerfile

@@ -0,0 +1,26 @@
+FROM ruby:3.4.6-bookworm AS base
+
+ENV LANG=C.UTF-8
+ENV BUNDLE_PATH=/usr/local/bundle
+
+WORKDIR /app
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+      build-essential \
+      git \
+      libsodium23 \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN gem install bundler -v 2.7.2 --no-document
+RUN bundler _2.7.2_ --version
+
+COPY *.gemspec ./
+COPY Gemfile Gemfile.lock* ./
+
+RUN bundler _2.7.2_ install
+
+RUN bundle install
+
+COPY . .
+
+CMD ["bash"]

data/Gemfile

@@ -5,5 +5,16 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in hashes_equal.gemspec
 gemspec
 
-gem 'minitest', '~> 5.0'
-gem 'rake', '~> 12.0'
+gem 'base64'
+gem 'bundler', '~> 2.1', '>= 2.1.4'
+gem 'byebug', '~> 11.1'
+gem 'guard', '~> 2.16'
+gem 'guard-minitest', '~> 2.4'
+gem 'minitest', '~> 6.0'
+gem 'minitest-reporters', '~> 1.7'
+gem 'mocha', '~> 3.0'
+gem 'pry', '~> 0.13'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.86'
+gem 'rubocop-performance', '~> 1.5'
+gem 'simplecov', '~> 0.19.0'

data/Makefile

@@ -1,5 +1,12 @@
 build:
 	gem build hashes_equal.gemspec
+	echo ">> gem push_hashes_equal-x.y.z.gem, to release this new version!"
+
+docker_bash:
+	docker compose run --rm hashes_equal_gem bash
+
+docker_build:
+	docker compose up --build
 
 lint:
 	bundle exec rubocop

data/docker-compose.yaml

@@ -0,0 +1,15 @@
+services:
+  hashes_equal_gem:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    working_dir: /app
+    volumes:
+      - .:/app
+      - bundle_cache:/usr/local/bundle
+    tty: true
+    stdin_open: true
+    command: echo 'ok'
+
+volumes:
+  bundle_cache:

data/hashes_equal.gemspec

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'lib/hashes_equal/version'
+# require_relative 'lib/hashes_equal/version'
 
+# rubocop:disable Gemspec/RequireMFA
 Gem::Specification.new do |spec|
   spec.name          = 'hashes_equal'
-  spec.version       = HashesEqual::VERSION
+  spec.version       = '0.3.1'
   spec.authors       = ['Shippingbo']
   spec.email         = ['tech@facilecomm.com']
 
@@ -20,6 +21,8 @@ Gem::Specification.new do |spec|
   # spec.metadata["source_code_uri"] = "Put your gem's public repo URL here."
   # spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
 
+  # spec.metadata['rubygems_mfa_required'] = 'true'
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files
   # in the RubyGem that have been added into git.
@@ -37,16 +40,17 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'hashdiff', '~> 1.0', '>= 1.0.1'
 
-  spec.add_development_dependency 'bundler', '~> 2.1', '>= 2.1.4'
-  spec.add_development_dependency 'byebug', '~> 11.1'
-  spec.add_development_dependency 'guard', '~> 2.16'
-  spec.add_development_dependency 'guard-minitest', '~> 2.4'
-  spec.add_development_dependency 'minitest', '~> 5.11'
-  spec.add_development_dependency 'minitest-reporters', '~> 1.4'
-  spec.add_development_dependency 'mocha', '~> 1.11'
-  spec.add_development_dependency 'pry', '~> 0.13'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rubocop', '~> 0.85'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
-  spec.add_development_dependency 'simplecov', '~> 0.18.5'
+  # spec.add_development_dependency 'bundler', '~> 2.1', '>= 2.1.4'
+  # spec.add_development_dependency 'byebug', '~> 11.1'
+  # spec.add_development_dependency 'guard', '~> 2.16'
+  # spec.add_development_dependency 'guard-minitest', '~> 2.4'
+  # spec.add_development_dependency 'minitest', '~> 6.0'
+  # spec.add_development_dependency 'minitest-reporters', '~> 1.7'
+  # spec.add_development_dependency 'mocha', '~> 3.0'
+  # spec.add_development_dependency 'pry', '~> 0.13'
+  # spec.add_development_dependency 'rake', '~> 13.0'
+  # spec.add_development_dependency 'rubocop', '1.86'
+  # spec.add_development_dependency 'rubocop-performance', '~> 1.5'
+  # spec.add_development_dependency 'simplecov', '~> 0.19.0'
 end
+# rubocop:enable Gemspec/RequireMFA

data/lib/hashes_equal/enumerable_compare_helper.rb

@@ -1,9 +1,27 @@
 # frozen_string_literal: true
 
 require 'hashes_equal/enumerable_diff_displayer'
+require 'hashes_equal/time_coarsener'
 
 module HashesEqual
   module EnumerableCompareHelper
+    def assert_time_aware_enumerable_equal(
+      expected,
+      actual,
+      time_granularity:,
+      verbose: true
+    )
+      time_coarsener = TimeCoarsener.new(time_granularity)
+      time_coarsened_expected = time_coarsener.call(expected)
+      time_coarsened_actual = time_coarsener.call(actual)
+
+      assert_enumerable_equal(
+        time_coarsened_expected,
+        time_coarsened_actual,
+        verbose: verbose
+      )
+    end
+
     def assert_enumerable_equal(expected, actual, verbose: true)
       displayable_diff = EnumerableDiffDisplayer.new(
         expected: expected,

data/lib/hashes_equal/generic_diff_displayer.rb

@@ -10,35 +10,50 @@ module HashesEqual
 
     class UnprocessableHashdiff < ArgumentError; end
 
-    def initialize(expected:, actual:)
+    def initialize(expected:, actual:, diff_options: {}, &comparison_block)
       @expected = expected
       @actual = actual
+      @diff_options = diff_options
+      @comparison_block = comparison_block
       assert_send :expected
       assert_send :actual
+      assert_send :diff_options
       check_args
     end
 
     def call
-      compute_diff
+      diff # compute it
+
       ANSI.white do
         formatted_diff
       end
     end
 
+    def diff
+      @diff ||= compute_diff
+    end
+
     private
 
-    attr_reader :expected, :actual, :diff
+    attr_reader(
+      :expected,
+      :actual,
+      :diff_options,
+      :comparison_block
+    )
 
     def check_args
       # Add specific checks if needed
     end
 
     def compute_diff
-      @diff = perform_diff_computation
+      perform_diff_computation.tap do |res|
+        assert_kind_of Array, res
+      end
     end
 
     def perform_diff_computation
-      Hashdiff.diff(expected, actual)
+      Hashdiff.diff(expected, actual, diff_options, &comparison_block)
     end
 
     def formatted_diff

data/lib/hashes_equal/hash_almost_diff_displayer.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'hashes_equal/hash_diff_displayer'
+
+module HashesEqual
+  class HashAlmostDiffDisplayer < HashDiffDisplayer
+    class ToleranceMustBeNonNegativeNumeric < ArgumentError; end
+
+    def initialize(expected:, actual:, tolerance:, strict: false)
+      @tolerance = tolerance
+      @strict = strict
+
+      super(
+        expected: expected,
+        actual: actual,
+        diff_options: {
+          numeric_tolerance: tolerance,
+          strict: strict
+        }
+      )
+    end
+
+    private
+
+    attr_reader :tolerance, :strict
+
+    def check_args
+      super
+      return if tolerance.is_a?(Numeric) && tolerance >= 0
+
+      raise(
+        ToleranceMustBeNonNegativeNumeric,
+        "tolerance was #{tolerance.inspect}"
+      )
+    end
+  end
+end

data/lib/hashes_equal/hash_compare_helper.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'hashes_equal/hash_diff_displayer'
+require 'hashes_equal/hash_almost_diff_displayer'
+require 'hashes_equal/hash_rounded_diff_displayer'
 
 module HashesEqual
   module HashCompareHelper
@@ -15,5 +17,30 @@ module HashesEqual
         assert expected == actual, displayable_diff
       end
     end
+
+    def assert_hashes_almost_equal(expected, actual, tolerance:, strict: false)
+      displayer = HashAlmostDiffDisplayer.new(
+        expected: expected,
+        actual: actual,
+        tolerance: tolerance,
+        strict: strict
+      )
+
+      result = displayer.call
+
+      assert displayer.diff.empty?, result
+    end
+
+    def assert_rounded_hashes_equal(expected, actual, precision:)
+      displayer = HashRoundedDiffDisplayer.new(
+        expected: expected,
+        actual: actual,
+        precision: precision
+      )
+
+      result = displayer.call
+
+      assert displayer.diff.empty?, result
+    end
   end
 end

data/lib/hashes_equal/hash_rounded_diff_displayer.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'hashes_equal/hash_diff_displayer'
+
+module HashesEqual
+  class HashRoundedDiffDisplayer < HashDiffDisplayer
+    class PrecisionMustBeNonNegativeInteger < ArgumentError; end
+
+    def initialize(expected:, actual:, precision:)
+      @precision = precision
+
+      super(expected: expected, actual: actual) do |_path, left, right|
+        next unless left.is_a?(Numeric) && right.is_a?(Numeric)
+
+        left.round(precision) == right.round(precision)
+      end
+    end
+
+    private
+
+    attr_reader :precision
+
+    def check_args
+      super
+      return if precision.is_a?(Integer) && precision >= 0
+
+      raise(
+        PrecisionMustBeNonNegativeInteger,
+        "precision was #{precision.inspect}"
+      )
+    end
+  end
+end

data/lib/hashes_equal/time_coarsener.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'ansi'
+require 'assertable'
+require 'hashdiff'
+
+module HashesEqual
+  class TimeCoarsener
+    include Assertable
+
+    class InvalidTimeGranularity < ArgumentError; end
+
+    VALID_TIME_GRANULARITY = %i[
+      sec
+      usec
+    ].freeze
+
+    def initialize(time_granularity)
+      @time_granularity = time_granularity
+      assert_send :time_granularity
+      check_valid_granularity_for_time_aware_comparison
+    end
+
+    # Either an enumerable or a Time object
+    def call(object_to_convert)
+      @object_to_convert = object_to_convert
+      assert_send :object_to_convert
+
+      convert_object(object_to_convert)
+    end
+
+    private
+
+    attr_reader :object_to_convert, :time_granularity
+
+    def convert_object(object)
+      return convert_hash(object) if object.is_a?(Hash)
+      return convert_enumerable(object) if object.is_a?(Enumerable)
+      return convert_time(object) if object.is_a?(Time)
+
+      object
+    end
+
+    def convert_hash(hash_to_convert)
+      hash_to_convert.transform_values do |value|
+        convert_object(value)
+      end
+    end
+
+    def convert_enumerable(enumerable_to_convert)
+      enumerable_to_convert.map do |value|
+        convert_object value
+      end
+    end
+
+    def convert_time(time_to_convert)
+      send(coarsening_method_name, time_to_convert)
+    end
+
+    def coarsen_to_sec(time_to_convert)
+      Time.at(
+        time_to_convert.to_i
+      )
+    end
+
+    def coarsen_to_usec(time_to_convert)
+      Time.at(
+        time_to_convert.to_i, time_to_convert.usec, :usec
+      )
+    end
+
+    def coarsening_method_name
+      "coarsen_to_#{time_granularity}"
+    end
+
+    def check_valid_granularity_for_time_aware_comparison
+      return if VALID_TIME_GRANULARITY.include?(time_granularity.to_sym)
+
+      raise(
+        InvalidTimeGranularity,
+        [
+          "#{time_granularity.inspect} is not a valid time_granularity.",
+          "Valid values are: #{VALID_TIME_GRANULARITY.inspect}"
+        ].join(' ')
+      )
+    end
+  end
+end

data/lib/hashes_equal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HashesEqual
-  VERSION = '0.1.3'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: hashes_equal
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Shippingbo
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
@@ -58,180 +57,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.4
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.16'
-- !ruby/object:Gem::Dependency
-  name: guard-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.11'
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.11'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.85'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.85'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.18.5
 description: Provides an assertion to test for hashes equality.
 email:
 - tech@facilecomm.com
@@ -239,11 +64,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby_version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -252,19 +79,22 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yaml
 - hashes_equal.gemspec
 - lib/hashes_equal.rb
 - lib/hashes_equal/enumerable_compare_helper.rb
 - lib/hashes_equal/enumerable_diff_displayer.rb
 - lib/hashes_equal/generic_diff_displayer.rb
+- lib/hashes_equal/hash_almost_diff_displayer.rb
 - lib/hashes_equal/hash_compare_helper.rb
 - lib/hashes_equal/hash_diff_displayer.rb
+- lib/hashes_equal/hash_rounded_diff_displayer.rb
+- lib/hashes_equal/time_coarsener.rb
 - lib/hashes_equal/version.rb
 homepage: https://github.com/Facilecomm/hashes_equal
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -279,8 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: MiniTest style assertion to compare hashes.
 test_files: []