pricehubble 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9efa889dd5ba50585f840c63123cca87ae54fdf1730d730d1e63406c6272250
-  data.tar.gz: 7290470461e267bbbc0d427b0cbbb79daf87e3b8e12746e0fd05a97289b252ee
+  metadata.gz: 07e1e5efe0a100babe39f157a02b4068af1fad0ea51a08106660d37fa7b00fe8
+  data.tar.gz: 18b62eddc0faa937a242132836be220fe36e6519b2a7c71947fb7f13b9a82702
 SHA512:
-  metadata.gz: 7512e734fc788465d8f61cd36d71fe50686f4f855e8de0be3ea996c0866668fd9594162c09d75bbc3155542d879378f74d1d37fb797a6dfebb1c8a2f4c02d870
-  data.tar.gz: b8a638e5ac5f70ceeb56b25ba2a63a77a41880990a6503553e37eebf32f69e13467307114a57e2bd082e41d78c0c6e4488d3d3b2115bf01362a20f797c321387
+  metadata.gz: ad7fad7e5697d103a3c574e8bf1cf23852861876fc5ac413b62c8a26f478a3f7830210ebe7ed0739eae68f6e5af68a2dcc1e67d71da0b18d34f6ae7bb1c87b7a
+  data.tar.gz: 0f844faeeaedb2ed00172e5accfaee4b244f0ccfdf7eea6e4300980ded042888717d93e9a0c3fc0e028e4b443189887c9981e039cb41bcae1dff85eab26248b8

data/.rubocop.yml

@@ -1,3 +1,7 @@
+inherit_from:
+  - https://potpourri.hausgold.de/config/rubocop.yml
+  - https://potpourri.hausgold.de/config/rubocop-gem.yml
+
 plugins:
   - rubocop-rspec
   - rubocop-rails
@@ -5,9 +9,6 @@ plugins:
 Rails:
   Enabled: true
 
-Style/Documentation:
-  Enabled: true
-
 AllCops:
   NewCops: enable
   SuggestExtensions: false
@@ -20,48 +21,17 @@ AllCops:
     - build/**/*
     - gemfiles/**/*
 
-Metrics/BlockLength:
-  Exclude:
-    - Rakefile
-    - '*.gemspec'
-    - spec/**/*.rb
-    - '**/*.rake'
-    - doc/**/*.rb
-    # Concerns and middlewares contain by nature long blocks
-    - lib/price*hubble/entity/concern/**/*.rb
-    - lib/price*hubble/client/request/**/*.rb
-    - lib/price*hubble/client/response/**/*.rb
-
 # Our examples use +pp+ a lot
 Lint/Debugger:
   Exclude:
     - doc/examples/**/*.rb
 
-# MFA is not yet enabled for our gems yet.
-Gemspec/RequireMFA:
-  Enabled: false
-
-# Document all the things.
-Style/DocumentationMethod:
-  Enabled: true
-  RequireForNonPublicMethods: true
-
 # It's a deliberate idiom in RSpec.
 # See: https://github.com/bbatsov/rubocop/issues/4222
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - "spec/**/*"
 
-# Because +expect_any_instance_of().to have_received()+ is not
-# supported with the +with(hash_including)+ matchers
-RSpec/MessageSpies:
-  EnforcedStyle: receive
-
-# Because nesting makes sense here to group the feature tests
-# more effective. This increases maintainability.
-RSpec/NestedGroups:
-  Max: 4
-
 # Disable regular Rails spec paths.
 Rails/FilePath:
   Enabled: false
@@ -75,26 +45,11 @@ Lint/ShadowingOuterLocalVariable:
   Exclude:
     - "doc/**/*"
 
-# We stay at 80 characters per line.
-# See: https://rubystyle.guide/#max-line-length
-Layout/LineLength:
-  Max: 80
-
-# We use memoized helpers all over the place to construct inputs and output
-# which can be customized at nested contexts easily.
-RSpec/MultipleMemoizedHelpers:
-  Enabled: false
-
 # That are false-positives because we implement similar working
 # helpers for associations like +.has_one+.
 Rails/ReflectionClassName:
   Enabled: false
 
-# A very nice feature, but it does not work for non-method code parts atow.
-# So just disabling it for now.
-Style/DocumentDynamicEvalDefinition:
-  Enabled: false
-
 # For our examples it's fine to use +pp+ and +puts+,
 # as they are living examples.
 Rails/Output:

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 2.2.0 (19 December 2025)
+
+* Migrated to a shared Rubocop configuration for HAUSGOLD gems ([#21](https://github.com/hausgold/pricehubble/pull/21))
+
 ### 2.1.0 (23 October 2025)
 
 * Added support for Rails 8.1 ([#19](https://github.com/hausgold/pricehubble/pull/19))

data/Envfile

@@ -1,3 +1,4 @@
 LANG=en_US.UTF-8
 LANGUAGE=en_US.UTF-8
 LC_ALL=en_US.UTF-8
+RUBOCOP_CACHE_ROOT=/app/tmp

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 HAUSGOLD | talocasa GmbH
+Copyright (c) 2025 HAUSGOLD | talocasa GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -123,7 +123,7 @@ PriceHubble.identity.expires_at
 
 The pricehubble gem allows you to decide how to react on errors on a
 per-request basis. (except the transparent authentication) All request
-performing methods are shiped in a bang and non-bang variant.
+performing methods are shipped in a bang and non-bang variant.
 
 The bang variants (eg. `PriceHubble::ValuationRequest#perform!`, mind
 the exclamation mark at the end) will raise an child instance of the
@@ -133,7 +133,7 @@ occur. This comes in handy on asynchronous jobs which are retried on
 exceptions.
 
 The non-bang variants (eg. `PriceHubble::ValuationRequest#perform`,
-without the exclamation mark) wont raise and just return empty results
+without the exclamation mark) won't raise and just return empty results
 (eg. `false` or `[]`). This might me comfortable in complex control
 flows or when you do not care if one out of 100 times the data is
 missing. But watch out for bad/invalid requests you might mask with

data/lib/price_hubble/client/base.rb

@@ -23,8 +23,6 @@ module PriceHubble
       #   end
       #
       # @param con [Faraday::Connection] the connection object
-      #
-      # rubocop:disable Metrics/MethodLength -- because of the middleware list
       def configure(con)
         con.use :instrumentation
 
@@ -44,7 +42,6 @@ module PriceHubble
 
         con.adapter Faraday.default_adapter
       end
-      # rubocop:enable Metrics/MethodLength
 
       # Create a new Faraday connection on the first shot, and pass the cached
       # connection object on subsequent calls.

data/lib/price_hubble/client/dossiers.rb

@@ -10,9 +10,6 @@ module PriceHubble
       # @param args [Hash{Symbol => Mixed}] additional arguments
       # @return [PriceHubble::Dossier, nil] the PriceHubble dossier,
       #   or +nil+ on error
-      #
-      # rubocop:disable Metrics/MethodLength -- because thats the bare minimum
-      #   handling is quite complex
       def create_dossier(entity, **args)
         res = connection.post do |req|
           req.path = '/api/v1/dossiers'
@@ -26,7 +23,6 @@ module PriceHubble
           successful?(res)
         end
       end
-      # rubocop:enable Metrics/MethodLength
 
       # Generates a permalink for the specified dossier which will expire after
       # the set number of days.
@@ -35,10 +31,6 @@ module PriceHubble
       # @param ttl [ActiveSupport::Duration] the time to live for the new link
       # @param locale [String] the user frontend locale
       # @param args [Hash{Symbol => Mixed}] additional arguments
-      #
-      # rubocop:disable Metrics/MethodLength -- because thats the bare minimum
-      # rubocop:disable Metrics/AbcSize -- because the decission handling is
-      #   quite complex
       def share_dossier(entity, ttl:, locale:, **args)
         res = connection.post do |req|
           req.path = '/api/v1/dossiers/links'
@@ -57,16 +49,11 @@ module PriceHubble
           successful?(res)
         end
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
 
       # Delete a dossier entity.
       #
       # @param entity [PriceHubble::Dossier] the entity to delete
       # @param args [Hash{Symbol => Mixed}] additional arguments
-      #
-      # rubocop:disable Metrics/MethodLength -- because thats the bare
-      #   minimumbecause the decission handling is quite complex
       def delete_dossier(entity, **args)
         res = connection.delete do |req|
           req.path = "/api/v1/dossiers/#{entity.id}"
@@ -82,7 +69,6 @@ module PriceHubble
         end
       end
 
-      # rubocop:enable Metrics/MethodLength
       # Update a dossier entity.
       #
       # TODO: Implement this.

data/lib/price_hubble/client/utils/response.rb

@@ -4,9 +4,6 @@ module PriceHubble
   module Client
     module Utils
       # Some helpers to work with responses in a general way.
-      #
-      # rubocop:disable Metrics/BlockLength -- because of
-      #   ActiveSupport::Concern
       module Response
         extend ActiveSupport::Concern
 
@@ -82,7 +79,6 @@ module PriceHubble
           end
         end
       end
-      # rubocop:enable Metrics/BlockLength
     end
   end
 end

data/lib/price_hubble/client/valuation.rb

@@ -10,9 +10,6 @@ module PriceHubble
       # @param args [Hash{Symbol => Mixed}] the authentication credentials
       # @return [Array<PriceHubble::Valuation>, nil] the valuation results,
       #   or +nil+ on error
-      #
-      # rubocop:disable Metrics/MethodLength -- because of the request handling
-      # rubocop:disable Metrics/AbcSize -- ditto
       def property_value(request, **args)
         data = request.attributes(sanitize: true)
         res = connection.post do |req|
@@ -27,8 +24,6 @@ module PriceHubble
           successful?(res)
         end
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
 
       # Map and assign the valuation response to our local
       # +PriceHubble::Valuation+ representation. While taking care of the
@@ -41,10 +36,6 @@ module PriceHubble
       #   valuations data
       # @param request [PriceHubble::ValuationRequest] the original request
       # @return [Proc] the valuation mapping code
-      #
-      # rubocop:disable Metrics/MethodLength -- because of the request to
-      #   response mapping
-      # rubocop:disable Metrics/AbcSize -- ditto
       def assign_valuations(data, request)
         lambda do
           # valuations[i][j] contains the valuation for property i on date j
@@ -62,8 +53,6 @@ module PriceHubble
           end.flatten
         end
       end
-      # rubocop:enable Metrics/MethodLength
-      # rubocop:enable Metrics/AbcSize
 
       # Generate bang method variants
       bangers :property_value

data/lib/price_hubble/client.rb

@@ -7,7 +7,7 @@ module PriceHubble
 
     class_methods do
       # Get a low level client for the requested application. This returns an
-      # already instanciated client object, ready to use.
+      # already instantiated client object, ready to use.
       #
       # @param name [Symbol, String] the client name
       # @return [PriceHubble::Client::Base] a compatible client instance

data/lib/price_hubble/core_ext/hash.rb

@@ -3,7 +3,7 @@
 # All our Ruby core extensions for the +Hash+ class.
 class Hash
   # Perform the regular +Hash#compact+ method on the object but takes care of
-  # deeply nested hashs.
+  # deeply nested hashes.
   #
   # @return [Hash]
   def deep_compact
@@ -32,9 +32,6 @@ class Hash
   #
   # @param object [Mixed] the object to compact
   # @return [Mixed] the compacted object
-  #
-  # rubocop:disable Metrics/MethodLength -- because of the extra empty hash
-  #   compaction logic
   def deep_compact_in_object(object)
     case object
     when Hash
@@ -48,5 +45,4 @@ class Hash
       object
     end
   end
-  # rubocop:enable Metrics/MethodLength
 end

data/lib/price_hubble/entity/authentication.rb

@@ -6,7 +6,7 @@ module PriceHubble
   #
   # @see https://docs.pricehubble.com/#introduction-authentication
   class Authentication < BaseEntity
-    # The expiration leeway to substract to guarantee
+    # The expiration leeway to subtract to guarantee
     # acceptance on remote application calls
     EXPIRATION_LEEWAY = 5.minutes
 

data/lib/price_hubble/entity/concern/associations.rb

@@ -8,7 +8,7 @@ module PriceHubble
       extend ActiveSupport::Concern
 
       included do
-        # Collect all the registed association configurations
+        # Collect all the registered association configurations
         class_attribute :associations
 
         private
@@ -37,9 +37,6 @@ module PriceHubble
         # @param hash [Hash{Symbol => Mixed}] all the data as hash
         # @return [Array<RecursiveOpenStruct, Hash{Symbol => Mixed}>] the
         #   left over data
-        #
-        # rubocop:disable Metrics/AbcSize -- because of the complex logic
-        # rubocop:disable Metrics/MethodLength -- because of the complex logic
         def map_has_one_association(attribute, opts, struct, hash)
           # Early exit when the source key is missing on the given data
           key = opts[:from]
@@ -62,8 +59,6 @@ module PriceHubble
           # Pass back the new data
           [struct, hash]
         end
-        # rubocop:enable Metrics/AbcSize
-        # rubocop:enable Metrics/MethodLength
 
         # Map an simple has_many association to the resulting entity attribute.
         # The source key is stripped off according to the association
@@ -76,13 +71,6 @@ module PriceHubble
         # @param hash [Hash{Symbol => Mixed}] all the data as hash
         # @return [Array<RecursiveOpenStruct, Hash{Symbol => Mixed}>] the
         #   left over data
-        #
-        # rubocop:disable Metrics/AbcSize -- because of the complex logic
-        # rubocop:disable Metrics/CyclomaticComplexity -- because of the
-        #   complex logic
-        # rubocop:disable Metrics/PerceivedComplexity -- because of the complex
-        #   logic
-        # rubocop:disable Metrics/MethodLength -- because of the complex logic
         def map_has_many_association(attribute, opts, struct, hash)
           # Early exit when the source key is missing on the given data
           key = opts[:from]
@@ -114,10 +102,6 @@ module PriceHubble
           # Pass back the new data
           [struct, hash]
         end
-        # rubocop:enable Metrics/AbcSize
-        # rubocop:enable Metrics/CyclomaticComplexity
-        # rubocop:enable Metrics/PerceivedComplexity
-        # rubocop:enable Metrics/MethodLength
       end
 
       class_methods do

data/lib/price_hubble/entity/concern/attributes.rb

@@ -5,7 +5,6 @@ module PriceHubble
     # An ActiveRecord-like attribute management feature, with the exception
     # that the attributes are not generated through a schema file, but are
     # defined inline the entity class.
-    #
     module Attributes
       extend ActiveSupport::Concern
 
@@ -16,7 +15,7 @@ module PriceHubble
         include Attributes::Range
         include Attributes::StringInquirer
 
-        # Collect all registed attribute names as symbols
+        # Collect all registered attribute names as symbols
         class_attribute :attribute_names
 
         # Export all attributes as data hash, as requested by the ActiveModel
@@ -24,9 +23,6 @@ module PriceHubble
         #
         # @param sanitize [Boolean] whenever to sanitize the data for transport
         # @return [Hash{String => Mixed}] the attribute data
-        #
-        # rubocop:disable Metrics/MethodLength -- because of the key/value
-        #   sanitization handling
         def attributes(sanitize: false)
           attribute_names.each_with_object({}) do |key, memo|
             reader = key
@@ -44,7 +40,6 @@ module PriceHubble
           end
         end
 
-        # rubocop:enable Metrics/MethodLength
         # A wrapper for the +ActiveModel#assign_attributes+ method with support
         # for unmapped attributes. These attributes are put into the
         # +_unmapped+ struct and all the known attributes are assigned like
@@ -73,9 +68,6 @@ module PriceHubble
         # @param obj [Mixed] the object to resolve its attributes
         # @param sanitize [Boolean] whenever to sanitize the data for transport
         # @return [Mixed] the attribute(s) data
-        #
-        # rubocop:disable Metrics/MethodLength -- because thats the pure
-        #   minimum
         def resolve_attributes(obj, sanitize: false)
           if obj.respond_to? :attributes
             obj = if obj.method(:attributes).arity == 1
@@ -93,7 +85,6 @@ module PriceHubble
 
           obj
         end
-        # rubocop:enable Metrics/MethodLength
 
         # Explicitly convert the given struct to an +RecursiveOpenStruct+ and a
         # deep symbolized key copy for further usage.
@@ -122,7 +113,7 @@ module PriceHubble
         # @param hash [Hash{Symbol => Mixed}] all the data as hash
         # @return [Hash{Symbol => Mixed}] the known attributes
         def initialize_attributes(struct, hash)
-          # Substract known keys, to move them to the +_unmapped+ variable
+          # Subtract known keys, to move them to the +_unmapped+ variable
           attribute_names.each { |key| struct.delete_field(key) }
           # Merge the previous unmapped struct and the given data
           self._unmapped =

data/lib/price_hubble/identity.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PriceHubble
-  # Handles all the identity retrival high-level logic.
+  # Handles all the identity retrieval high-level logic.
   #
   # rubocop:disable Style/ClassVars -- because we split module code
   module Identity

data/lib/price_hubble/utils/bangers.rb

@@ -14,13 +14,10 @@ module PriceHubble
         # @param methods [Array<Symbol>] the source method names
         # @raise [NoMethodError] when a source method is not defined
         # @raise [ArgumentError] when a source method does not accept arguments
-        #
-        # rubocop:disable Metrics/MethodLength -- because the method template
-        #   is better inlined
         def bangers(*methods)
           methods.each do |meth|
             raise NoMethodError, "#{self}##{meth} does not exit" \
-              unless instance_methods(false).include? meth
+              unless method_defined?(meth, false)
 
             if instance_method(meth).arity.zero?
               raise ArgumentError,
@@ -34,7 +31,6 @@ module PriceHubble
             RUBY
           end
         end
-        # rubocop:enable Metrics/MethodLength
       end
     end
   end

data/lib/price_hubble/utils/decision.rb

@@ -25,7 +25,7 @@ module PriceHubble
         # switch statement. It contains three decision result paths, the happy
         # case (good), an error case for regular issues (fail) and a error case
         # for fatal issues (bang). You can configure the decision which error
-        # behaiviour you prefer by setting the +bang+ argument to true or
+        # behaviour you prefer by setting the +bang+ argument to true or
         # false.
         #
         # @param bang [Boolean] whenever to bang or not
@@ -73,7 +73,7 @@ module PriceHubble
           @good_proc = block
         end
 
-        # Returns the prefered error method block, based on the +on_error+
+        # Returns the preferred error method block, based on the +on_error+
         # setting.
         #
         # @return [Proc] the error block we should use

data/lib/price_hubble/version.rb

@@ -3,7 +3,7 @@
 # The gem version details.
 module PriceHubble
   # The version of the +price-hubble+ gem
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 
   class << self
     # Returns the version of gem as a string.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pricehubble
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Hermann Mayer