immoscout 2.0.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e32ead7d9ecbf21a77e5d6fa74e2139732c2bc45c6d717dbe2e15fc4d83decc
-  data.tar.gz: a09b9b72b25701703612f2ae1e6c0fff912713616e34a0e8fcee993c4324a41e
+  metadata.gz: 9b64222a9f90cd7ab67e2dd7d3720c65259089e840d65c5546917a40f96249d0
+  data.tar.gz: 15b72fdf189ebcbafb710d044fea76cdb1f61a83294008f7c68ec3bcc0d5debd
 SHA512:
-  metadata.gz: 4dd40628d8b6f0e70840cb0020e527fe34b397c49fa1f4fca7a2f30dbbb173ba4d336ea73cebd83661959fbe481bfca4c8735b80e6386d335050c71335b15587
-  data.tar.gz: 5dcaa0ce884b9338208bdd43b544350da6ee775ff2434a2bb203ef1cc7c8427bb109fc9858b590dabdbdfecc148146392039f62db711bc8a80c5f16dc298b725
+  metadata.gz: 74a153dd522c08b0a0c6326cd707253612b1278ed05e5f5f84a20eee0cd0352f58b4e36cf55f52056896e0cda9dda3cfe6b82fc8ab9936151dfcb46c88e12a52
+  data.tar.gz: 1c672a2cf0e9cde9d5998b3a74a65b49e7616fa6d47325f8c28e75dc6bddedec6aa90108a88ec8f6ca4ed4ef0fe4b80e74293617c11daad1496d5df5b60c0ac0

data/.github/workflows/release.yml

@@ -16,7 +16,7 @@ jobs:
   docs:
     name: Release the gem
     runs-on: ubuntu-22.04
-    timeout-minutes: 5
+    timeout-minutes: 10
     steps:
       - uses: actions/checkout@v4
 

data/.github/workflows/test.yml

@@ -19,7 +19,7 @@ jobs:
       fail-fast: false
       matrix:
         ruby: ['3.2', '3.3', '3.4']
-        rails: ['7.1', '7.2', '8.0']
+        rails: ['7.1', '7.2', '8.0', '8.1']
     env:
       BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
     steps:

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,39 +9,20 @@ plugins:
 Rails:
   Enabled: true
 
-Style/Documentation:
-  Enabled: true
-
 AllCops:
   NewCops: enable
   SuggestExtensions: false
   DisplayCopNames: true
   TargetRubyVersion: 3.2
-  TargetRailsVersion: 6.1
+  TargetRailsVersion: 7.1
   Exclude:
     - bin/**/*
     - vendor/**/*
     - build/**/*
     - gemfiles/**/*
 
-Metrics/BlockLength:
-  Exclude:
-    - Rakefile
-    - '*.gemspec'
-    - spec/**/*.rb
-    - '**/*.rake'
-    - doc/**/*.rb
-
-# We stay at 80 characters per line.
-# See: https://rubystyle.guide/#max-line-length
-Layout/LineLength:
-  Max: 80
-
-# MFA is not yet enabled for our gems yet.
-Gemspec/RequireMFA:
-  Enabled: false
-
-# We use memoized helpers all over the place to construct inputs and output
-# which can be customized at nested contexts easily.
-RSpec/MultipleMemoizedHelpers:
+# Document all the things.
+# TODO: Add missing documentations for all methods.
+Style/DocumentationMethod:
   Enabled: false
+  RequireForNonPublicMethods: false

data/Appraisals

@@ -11,3 +11,7 @@ end
 appraise 'rails-8.0' do
   gem 'activesupport', '~> 8.0.0'
 end
+
+appraise 'rails-8.1' do
+  gem 'activesupport', '~> 8.1.0'
+end

data/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 * 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 ([#26](https://github.com/hausgold/immoscout/pull/26))
+
+### 2.1.0 (23 October 2025)
+
+* Dropped Reek ([#23](https://github.com/hausgold/immoscout/pull/23))
+* Added support for Rails 8.1 ([#24](https://github.com/hausgold/immoscout/pull/24))
+* Switched from `ActiveSupport::Configurable` to a custom implementation based
+  on `ActiveSupport::OrderedOptions` ([#25](https://github.com/hausgold/immoscout/pull/25))
+
 ### 2.0.0 (28 June 2025)
 
 * Corrected some RuboCop glitches ([#21](https://github.com/hausgold/immoscout/pull/21))

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/Gemfile

@@ -10,7 +10,7 @@ gemspec
 # Development dependencies
 gem 'appraisal', '~> 2.4'
 gem 'bundler', '~> 2.6'
-gem 'countless', '~> 2.0'
+gem 'countless', '~> 2.2'
 gem 'factory_bot', '~> 6.2'
 gem 'guard-rspec', '~> 4.7'
 gem 'railties', '>= 7.1'

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/gemfiles/rails_7.1.gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "appraisal", "~> 2.4"
 gem "bundler", "~> 2.6"
-gem "countless", "~> 2.0"
+gem "countless", "~> 2.2"
 gem "factory_bot", "~> 6.2"
 gem "guard-rspec", "~> 4.7"
 gem "railties", ">= 7.1"

data/gemfiles/rails_7.2.gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "appraisal", "~> 2.4"
 gem "bundler", "~> 2.6"
-gem "countless", "~> 2.0"
+gem "countless", "~> 2.2"
 gem "factory_bot", "~> 6.2"
 gem "guard-rspec", "~> 4.7"
 gem "railties", ">= 7.1"

data/gemfiles/rails_8.0.gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 
 gem "appraisal", "~> 2.4"
 gem "bundler", "~> 2.6"
-gem "countless", "~> 2.0"
+gem "countless", "~> 2.2"
 gem "factory_bot", "~> 6.2"
 gem "guard-rspec", "~> 4.7"
 gem "railties", ">= 7.1"

data/gemfiles/rails_8.1.gemfile

@@ -0,0 +1,27 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.4"
+gem "bundler", "~> 2.6"
+gem "countless", "~> 2.2"
+gem "factory_bot", "~> 6.2"
+gem "guard-rspec", "~> 4.7"
+gem "railties", ">= 7.1"
+gem "rake", "~> 13.0"
+gem "redcarpet", "~> 3.5"
+gem "rspec", "~> 3.12"
+gem "rspec-json_expectations", "~> 2.2"
+gem "rubocop"
+gem "rubocop-rails"
+gem "rubocop-rspec"
+gem "simplecov", ">= 0.22"
+gem "terminal-table", "~> 3.0"
+gem "timecop", ">= 0.9.6"
+gem "vcr", "~> 6.0"
+gem "webmock", "~> 3.18"
+gem "yard", ">= 0.9.28"
+gem "yard-activesupport-concern", ">= 0.0.1"
+gem "activesupport", "~> 8.1.0"
+
+gemspec path: "../"

data/lib/immoscout/api/request.rb

@@ -20,7 +20,6 @@ module Immoscout
         request(:delete, path, payload, multipart)
       end
 
-      # rubocop:disable Metrics/MethodLength -- because of the header handling
       def request(method, path, payload = nil, multipart = nil)
         connection.send(method, path, multipart) do |request|
           if multipart
@@ -34,7 +33,6 @@ module Immoscout
             "RubyImmoscout/#{Immoscout::VERSION}"
         end
       end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/immoscout/configuration.rb

@@ -2,8 +2,46 @@
 
 module Immoscout
   # The configuration object of the +immoscout+ gem.
-  class Configuration
-    include ActiveSupport::Configurable
+  class Configuration < ActiveSupport::OrderedOptions
+    # Track our configurations settings (+Symbol+ keys) and their defaults as
+    # lazy-loaded +Proc+'s values
+    class_attribute :defaults,
+                    instance_reader: true,
+                    instance_writer: false,
+                    instance_predicate: false,
+                    default: {}
+
+    # Create a new +Configuration+ instance with all settings populated with
+    # their respective defaults.
+    #
+    # @param args [Hash{Symbol => Mixed}] additional settings which
+    #   overwrite the defaults
+    # @return [Configuration] the new configuration instance
+    def initialize(**args)
+      super()
+      defaults.each { |key, default| self[key] = instance_exec(&default) }
+      merge!(**args)
+    end
+
+    # A simple DSL method to define new configuration accessors/settings with
+    # their defaults. The defaults can be retrieved with
+    # +Configuration.defaults+ or +Configuration.new.defaults+.
+    #
+    # @param name [Symbol, String] the name of the configuration
+    #   accessor/setting
+    # @param default [Mixed, nil] a non-lazy-loaded static value, serving as a
+    #   default value for the setting
+    # @param block [Proc] when given, the default value will be lazy-loaded
+    #   (result of the Proc)
+    def self.config_accessor(name, default = nil, &block)
+      # Save the given configuration accessor default value
+      defaults[name.to_sym] = block || -> { default }
+
+      # Compile reader/writer methods so we don't have to go through
+      # +ActiveSupport::OrderedOptions#method_missing+.
+      define_method(name) { self[name] }
+      define_method("#{name}=") { |value| self[name] = value }
+    end
 
     config_accessor(:consumer_key) { ENV.fetch('IMMOSCOUT_CONSUMER_KEY', nil) }
     config_accessor(:consumer_secret) do

data/lib/immoscout/models/actions/attachment.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/BlockLength -- because this is how an ActiveSupport
-#   concern looks like
 module Immoscout
   module Models
     module Actions
@@ -19,9 +17,6 @@ module Immoscout
               .fetch('attachment')
           end
 
-          # rubocop:disable Metrics/AbcSize -- because this is the bare minimum
-          #   logic
-          # rubocop:disable Metrics/MethodLength -- ditto
           def save
             attachable_id = attachable.try(:id) || attachable
             response = api.post(
@@ -38,8 +33,6 @@ module Immoscout
             self.id = id_from_response(response)
             self
           end
-          # rubocop:enable Metrics/AbcSize
-          # rubocop:enable Metrics/MethodLength
 
           def destroy
             attachable_id = attachable.try(:id) || attachable
@@ -93,4 +86,3 @@ module Immoscout
     end
   end
 end
-# rubocop:enable Metrics/BlockLength

data/lib/immoscout/models/actions/real_estate.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/BlockLength -- because this is how an ActiveSupport
-#   concern looks like
 module Immoscout
   module Models
     module Actions
@@ -115,4 +113,3 @@ module Immoscout
     end
   end
 end
-# rubocop:enable Metrics/BlockLength

data/lib/immoscout/models/concerns/propertiable.rb

@@ -13,8 +13,6 @@ module Immoscout
             {}
           end
 
-          # :reek:ControlParameter - standard stuff, reek!
-          # :reek:TooManyStatements
           def method_missing(method_name, *arguments, &)
             if method_name =~ /build_(\w+)/
               match         = Regexp.last_match(1).intern
@@ -32,7 +30,6 @@ module Immoscout
             self.class.properties.keys.sort
           end
 
-          # :reek:BooleanParameter - standard stuff, reek!
           def respond_to_missing?(method_name, include_private = false)
             method_name.to_s.start_with?('build_') || super
           end

data/lib/immoscout/models/concerns/renderable.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/BlockLength -- because this is how an ActiveSupport
-#   concern looks like
 module Immoscout
   module Models
     module Concerns
@@ -25,11 +23,6 @@ module Immoscout
             self.class.try(:json_wrapper)
           end
 
-          # rubocop:disable Metrics/PerceivedComplexity -- because this is the
-          #   bare minimum logic
-          # rubocop:disable Metrics/MethodLength -- ditto
-          # rubocop:disable Metrics/CyclomaticComplexity -- ditto
-          # rubocop:disable Metrics/AbcSize -- ditto
           def to_h
             self.class.properties.each_with_object({}) do |(key, value), memo|
               # skip if it's readonly and should not be exposed in #as_json
@@ -51,10 +44,6 @@ module Immoscout
               memo
             end
           end
-          # rubocop:enable Metrics/PerceivedComplexity
-          # rubocop:enable Metrics/MethodLength
-          # rubocop:enable Metrics/CyclomaticComplexity
-          # rubocop:enable Metrics/AbcSize
 
           def to_json_wrapped
             { self.class.try(:json_wrapper) => to_json_unwrapped }
@@ -71,4 +60,3 @@ module Immoscout
     end
   end
 end
-# rubocop:enable Metrics/BlockLength

data/lib/immoscout/version.rb

@@ -3,7 +3,7 @@
 # The gem version details.
 module Immoscout
   # The version of the +immoscout+ gem
-  VERSION = '2.0.0'
+  VERSION = '2.2.0'
 
   class << self
     # Returns the version of gem as a string.

data/lib/immoscout.rb

@@ -2,8 +2,10 @@
 
 require 'zeitwerk'
 require 'logger'
+require 'active_support'
 require 'active_support/concern'
-require 'active_support/configurable'
+require 'active_support/ordered_options'
+require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/module'
 require 'singleton'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immoscout
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Marcus Geissler
@@ -116,6 +116,7 @@ files:
 - gemfiles/rails_7.1.gemfile
 - gemfiles/rails_7.2.gemfile
 - gemfiles/rails_8.0.gemfile
+- gemfiles/rails_8.1.gemfile
 - immoscout.gemspec
 - lib/immoscout.rb
 - lib/immoscout/api/client.rb