pricehubble 1.4.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33987d92db690afe5bda03fb225a11915166847840da54779347bace0d2fb6ae
-  data.tar.gz: 263b4b48cebe63c82ba29ef27c12fbb136c81124f86dd3281c06442794695dae
+  metadata.gz: ca74576289a2d5c061f6b2dac3ddb4d6fa077934e95ea9b8bcf94eb1b9a54d9a
+  data.tar.gz: d33c524b50b308f86e8205363fc3f9ab30c775b5ac9795edf8c7aa706403f96d
 SHA512:
-  metadata.gz: 2dd1447b16620cb4920c875a9ad5dfdb8b30e56db3a3958f80f43493e679c8abd5b9e0a81cd069511867fc76ba885fd95615f30b02c7210a77184ab8734f5bff
-  data.tar.gz: 3f16a3a4de7f81c71ac4e5c944390d8c6c628831eeded218f022e5f615a1166091911922d99fcdafcb60438f0976dab10f720afbd3b3abab223a47fcb53dcd3e
+  metadata.gz: 961026ab2f5102b5066e1351da519788e0d23b6d29fb232b691345f1cf9561ac589e65469c424e0ed1d19c36a2be741cf75fbdf83ec26f78a384468305a8eff0
+  data.tar.gz: a610548c3064c6c98a711dcb5b3763bef901dc8be8b45ec6aa3e345e2d839018aeb1d2156bc7548078eecd34457947a32a2b5ddfd02daa6eb31d503ab951ab0d

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 1.5.1 (17 January 2025)
+
+* Added the logger dependency (#13)
+
+### 1.5.0 (12 January 2025)
+
+* Switched to Zeitwerk as autoloader (#12)
+
 ### 1.4.0 (3 January 2025)
 
 * Raised minimum supported Ruby/Rails version to 2.7/6.1 (#11)

data/lib/price_hubble/{entity/base_entity.rb → base_entity.rb}

@@ -13,11 +13,11 @@ module PriceHubble
       include PriceHubble::Utils::Bangers
     end
 
-    include PriceHubble::EntityConcern::Callbacks
-    include PriceHubble::EntityConcern::Attributes
-    include PriceHubble::EntityConcern::Associations
-    include PriceHubble::EntityConcern::Client
-    include PriceHubble::EntityConcern::Persistence
+    include Concern::Callbacks
+    include Concern::Attributes
+    include Concern::Associations
+    include Concern::Client
+    include Concern::Persistence
 
     # We collect all unknown attributes instead of raising while creating a new
     # instance. The unknown attributes are wrapped inside a

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PriceHubble
-  module EntityConcern
+  module Concern
     # Allow simple association mappings like ActiveRecord supports (eg.
     # +has_one+, +has_many+).
     module Associations

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PriceHubble
-  module EntityConcern
+  module Concern
     module Attributes
       # A separated date array typed attribute helper.
       module DateArray

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PriceHubble
-  module EntityConcern
+  module Concern
     module Attributes
       # A separated enum typed attribute helper.
       module Enum

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PriceHubble
-  module EntityConcern
+  module Concern
     module Attributes
       # A separated range typed attribute helper.
       module Range

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PriceHubble
-  module EntityConcern
+  module Concern
     module Attributes
       # A separated string inquirer typed attribute helper.
       module StringInquirer

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PriceHubble
-  module EntityConcern
+  module Concern
     # 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.

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PriceHubble
-  module EntityConcern
+  module Concern
     # Define all the base callbacks of a common entity.
     module Callbacks
       extend ActiveSupport::Concern

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PriceHubble
-  module EntityConcern
+  module Concern
     # Allow entities to define their low level HTTP client to use.
     module Client
       extend ActiveSupport::Concern

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PriceHubble
-  module EntityConcern
+  module Concern
     # Map some of the ActiveRecord::Persistence API methods for an entity
     # instance for good compatibility. See: http://bit.ly/2W1rjfF and
     # http://bit.ly/2ARRFYB

data/lib/price_hubble/version.rb

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

data/lib/price_hubble.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'zeitwerk'
+require 'logger'
 require 'active_support'
 require 'active_support/concern'
 require 'active_support/configurable'
@@ -14,100 +16,44 @@ require 'recursive-open-struct'
 require 'faraday'
 require 'faraday_middleware'
 
-# Load polyfills if needed
-require 'price_hubble/core_ext/hash'
-
 # The top level namespace for the PriceHubble gem.
 module PriceHubble
-  # Top level elements
-  autoload :Configuration, 'price_hubble/configuration'
-  autoload :ConfigurationHandling, 'price_hubble/configuration_handling'
-  autoload :Client, 'price_hubble/client'
-  autoload :Identity, 'price_hubble/identity'
-  autoload :Instrumentation, 'price_hubble/instrumentation'
-
-  # Entities
-  autoload :BaseEntity, 'price_hubble/entity/base_entity'
-  autoload :Authentication, 'price_hubble/entity/authentication'
-  autoload :Valuation, 'price_hubble/entity/valuation'
-  autoload :ValuationScores, 'price_hubble/entity/valuation_scores'
-  autoload :ValuationRequest, 'price_hubble/entity/valuation_request'
-  autoload :Property, 'price_hubble/entity/property'
-  autoload :PropertyConditions, 'price_hubble/entity/property_conditions'
-  autoload :PropertyQualities, 'price_hubble/entity/property_qualities'
-  autoload :PropertyType, 'price_hubble/entity/property_type'
-  autoload :Location, 'price_hubble/entity/location'
-  autoload :Address, 'price_hubble/entity/address'
-  autoload :Coordinates, 'price_hubble/entity/coordinates'
-  autoload :Dossier, 'price_hubble/entity/dossier'
-
-  # Some general purpose utilities
-  module Utils
-    autoload :Decision, 'price_hubble/utils/decision'
-    autoload :Bangers, 'price_hubble/utils/bangers'
-  end
-
-  # Instrumentation
-  module Instrumentation
-    autoload :LogSubscriber, 'price_hubble/instrumentation/log_subscriber'
-  end
-
-  # Dedicated application HTTP (low level) client
-  module Client
-    # All our utilities used for the low level client
-    module Utils
-      autoload :Request, 'price_hubble/client/utils/request'
-      autoload :Response, 'price_hubble/client/utils/response'
-    end
+  # Configure the relative gem code base location
+  root_path = Pathname.new("#{__dir__}/price_hubble")
 
-    # Faraday request middlewares
-    module Request
-      autoload :DataSanitization,
-               'price_hubble/client/request/data_sanitization'
-      autoload :DefaultHeaders, 'price_hubble/client/request/default_headers'
-    end
+  # Setup a Zeitwerk autoloader instance and configure it
+  loader = Zeitwerk::Loader.for_gem
 
-    # Faraday response middlewares
-    module Response
-      autoload :DataSanitization,
-               'price_hubble/client/response/data_sanitization'
-      autoload :RecursiveOpenStruct,
-               'price_hubble/client/response/recursive_open_struct'
-    end
+  # Do not auto load some parts of the gem
+  loader.ignore("#{__dir__}/pricehubble*")
+  loader.ignore(root_path.join('core_ext'))
+  loader.ignore(root_path.join('initializers*'))
+  loader.ignore(root_path.join('railtie.rb'))
 
-    autoload :Base, 'price_hubble/client/base'
-    autoload :Authentication, 'price_hubble/client/authentication'
-    autoload :Valuation, 'price_hubble/client/valuation'
-    autoload :Dossiers, 'price_hubble/client/dossiers'
-  end
+  # Entity definitions, based on core functionalities,
+  # all entities are directly located at the namespace root,
+  # together with their shared concerns
+  loader.push_dir(root_path.join('entity'), namespace: PriceHubble)
 
-  # Separated features of an entity instance
-  module EntityConcern
-    autoload :Callbacks, 'price_hubble/entity/concern/callbacks'
-    autoload :Attributes, 'price_hubble/entity/concern/attributes'
-    autoload :Associations, 'price_hubble/entity/concern/associations'
-    autoload :Client, 'price_hubble/entity/concern/client'
-    autoload :Persistence, 'price_hubble/entity/concern/persistence'
-
-    # Some custom typed attribute helpers
-    module Attributes
-      base = 'price_hubble/entity/concern/attributes'
-      autoload :DateArray, "#{base}/date_array"
-      autoload :Enum, "#{base}/enum"
-      autoload :Range, "#{base}/range"
-      autoload :StringInquirer, "#{base}/string_inquirer"
-    end
-  end
+  # Finish the auto loader configuration
+  loader.setup
 
   # Load standalone code
   require 'price_hubble/version'
-  require 'price_hubble/errors'
-  require 'price_hubble/faraday'
   require 'price_hubble/railtie' if defined? Rails
 
+  # Load all core extension of the gem
+  Dir[root_path.join('core_ext/**/*.rb')].sort.each { |path| require path }
+
+  # Load all initializers of the gem
+  Dir[root_path.join('initializers/**/*.rb')].sort.each { |path| require path }
+
   # Include top-level features
   include PriceHubble::ConfigurationHandling
   include PriceHubble::Client
   include PriceHubble::Identity
   include PriceHubble::Instrumentation
+
+  # Make sure to eager load all constants
+  loader.eager_load
 end

data/pricehubble.gemspec

@@ -38,4 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'faraday', '~> 1.0'
   spec.add_dependency 'faraday_middleware', '~> 1.0'
   spec.add_dependency 'recursive-open-struct', '~> 2.0'
+  spec.add_dependency 'zeitwerk', '~> 2.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pricehubble
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Hermann Mayer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-01-03 00:00:00.000000000 Z
+date: 2025-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 description: Ruby client for the PriceHubble REST API
 email:
 - hermann.mayer92@gmail.com
@@ -123,6 +137,7 @@ files:
 - gemfiles/rails_6.1.gemfile
 - gemfiles/rails_7.1.gemfile
 - lib/price_hubble.rb
+- lib/price_hubble/base_entity.rb
 - lib/price_hubble/client.rb
 - lib/price_hubble/client/authentication.rb
 - lib/price_hubble/client/base.rb
@@ -139,7 +154,6 @@ files:
 - lib/price_hubble/core_ext/hash.rb
 - lib/price_hubble/entity/address.rb
 - lib/price_hubble/entity/authentication.rb
-- lib/price_hubble/entity/base_entity.rb
 - lib/price_hubble/entity/concern/associations.rb
 - lib/price_hubble/entity/concern/attributes.rb
 - lib/price_hubble/entity/concern/attributes/date_array.rb
@@ -159,9 +173,9 @@ files:
 - lib/price_hubble/entity/valuation.rb
 - lib/price_hubble/entity/valuation_request.rb
 - lib/price_hubble/entity/valuation_scores.rb
-- lib/price_hubble/errors.rb
-- lib/price_hubble/faraday.rb
 - lib/price_hubble/identity.rb
+- lib/price_hubble/initializers/errors.rb
+- lib/price_hubble/initializers/faraday.rb
 - lib/price_hubble/instrumentation.rb
 - lib/price_hubble/instrumentation/log_subscriber.rb
 - lib/price_hubble/railtie.rb