immoscout 1.3.2 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc74f7180d13859dedf5b42a8502e6d679b6c7348622c5f92de6a41c9daba822
-  data.tar.gz: 39c5063180247dfe8e9e279c0b0dc9f20d7a4204127ee763dd50690c92013fb7
+  metadata.gz: '0963b01092150e79cbf300a7431858238be834bb8c20a433614ed1077079108c'
+  data.tar.gz: d723c91babe0517162622c82a5b9574f29e5bb2cce2ae495684585539c6f6d2c
 SHA512:
-  metadata.gz: 277085348b99e2e1cc4e58157f067a874f78a8fb008970eeb50ca290d121008a8ab2613fc08475ba276d94ca7c62a05236cc68aeabf8cce782742892412639f2
-  data.tar.gz: 0fcd17a5e12f726a74268e270c9e9113c6ba8d455086e764d503c49bc8897d77b2d3e6071fd36d661fb5bd8ca10e5fee70e5a7bebf77a5e17dc108ddedf55e3c
+  metadata.gz: c5107284073b8c5ef76026e1fa3da07cb82866925a03e980e91fdeb8df63a252309a787b008fe111c7a07eb84f7fb362150f29638222cf4a9b0f8703c60e87e5
+  data.tar.gz: 14739b826ef34d6f0560dd6cc6fe2b708973af48db972298bb4110902b1831ccff4e0c8bc4af9472113c70f6a0a6588ab027677ecf4e5d315c3a5400953abe99

data/.github/workflows/documentation.yml

@@ -9,16 +9,17 @@ concurrency:
 jobs:
   docs:
     name: Build gem documentation
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Install the correct Ruby version
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.5
           bundler-cache: true
+          rubygems: '3.3.26'
 
       - name: Prepare the virtual environment
         uses: hausgold/actions/ci@master

data/.github/workflows/release.yml

@@ -0,0 +1,47 @@
+name: Release
+run-name: Release ${{ github.event.inputs.VERSION }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      VERSION:
+        description: The new version to release. (eg. `1.0.0`) Check the
+          changelog for the latest version.
+
+concurrency:
+  group: '${{ github.event.inputs.VERSION }}'
+  cancel-in-progress: true
+
+jobs:
+  docs:
+    name: Release the gem
+    runs-on: ubuntu-22.04
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Ruby 2.5
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.5
+          bundler-cache: true
+          rubygems: '3.3.26'
+
+      - name: Prepare the virtual environment
+        uses: hausgold/actions/ci@master
+        with:
+          clone_token: '${{ secrets.CLONE_TOKEN }}'
+          settings: '${{ github.repository }}'
+          target: ci/gem-test
+
+      - name: Switch to SSH remotes for the Git repository
+        run: git-ssh-remotes
+
+      - name: Enforce version '${{ github.event.inputs.VERSION }}'
+        run: set-gem-version '${{ github.event.inputs.VERSION }}'
+
+      - name: Prepare the Git release commit
+        run: git-release-commit '${{ github.event.inputs.VERSION }}'
+
+      - name: Push the release Git commit/tag and package to the registry
+        run: make release

data/.github/workflows/test.yml

@@ -13,23 +13,24 @@ concurrency:
 jobs:
   test:
     name: 'Test the gem (Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }})'
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 5
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5, 2.6, 2.7]
-        rails: [5.2, '6.0']
+        ruby: ['2.5', '2.7']
+        rails: ['5.2']
     env:
       BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Install the correct Ruby version
         uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
+          rubygems: '3.3.26'
 
       - name: Prepare the virtual environment
         uses: hausgold/actions/ci@master
@@ -46,7 +47,7 @@ jobs:
 
   trigger-docs:
     name: Trigger the documentation upload
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     timeout-minutes: 2
     needs: test
     if: github.ref == 'refs/heads/master'

data/.rspec

@@ -1,2 +1,3 @@
+--backtrace
+--force-color
 --format documentation
---color

data/.rubocop.yml

@@ -1,14 +1,24 @@
-Documentation:
-  Enabled: false
+require:
+  - rubocop-rspec
+  - rubocop-rails
+
+Rails:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: true
 
 AllCops:
+  NewCops: enable
+  SuggestExtensions: false
   DisplayCopNames: true
   TargetRubyVersion: 2.5
+  TargetRailsVersion: 5.2
   Exclude:
     - bin/**/*
     - vendor/**/*
     - build/**/*
-    - gemfiles/vendor/**/*
+    - gemfiles/**/*
 
 Metrics/BlockLength:
   Exclude:
@@ -20,5 +30,14 @@ Metrics/BlockLength:
 
 # We stay at 80 characters per line.
 # See: https://rubystyle.guide/#max-line-length
-Metrics/LineLength:
+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:
+  Enabled: false

data/.simplecov

@@ -1,3 +1,15 @@
+# frozen_string_literal: true
+
+require 'simplecov-html'
+require 'simplecov_json_formatter'
+
+SimpleCov.formatters = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::JSONFormatter
+  ]
+)
+
 SimpleCov.start 'test_frameworks' do
   add_filter '/vendor/bundle/'
 end

data/Appraisals

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
 appraise 'rails-5.2' do
-  gem 'activesupport', '~> 5.2.2'
-end
-
-appraise 'rails-6.0' do
-  gem 'activesupport', '~> 6.0.0'
+  gem 'activesupport', '~> 5.2.0'
 end

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+### next
+
+* TODO: Replace this bullet point with an actual description of a change.
+
+### 1.5.0
+
+* Added support for Gem release automation
+
+### 1.4.0
+
+* Bundler >= 2.3 is from now on required as minimal version (#10)
+* Dropped support for Ruby < 2.5 (#10)
+* Dropped support for Rails < 5.2 (#10)
+* Updated all development/runtime gems to their latest
+  Ruby 2.5 compatible version (#10)
+
 ### 1.3.2
 
 * Migrated to Github Actions

data/Dockerfile

@@ -2,7 +2,7 @@ FROM hausgold/ruby:2.5
 MAINTAINER Hermann Mayer <hermann.mayer@hausgold.de>
 
 # Update system gem
-RUN gem update --system
+RUN gem update --system '3.3.26'
 
 # Install system packages and the latest bundler
 RUN apt-get update -yqqq && \
@@ -11,8 +11,7 @@ RUN apt-get update -yqqq && \
     ca-certificates \
     bash-completion inotify-tools && \
   echo 'en_US.UTF-8 UTF-8' >> /etc/locale.gen && /usr/sbin/locale-gen && \
-  gem install bundler -v '~> 2.0' --no-document --no-prerelease && \
-  gem install bundler -v '~> 1.0' --no-document --no-prerelease
+  gem install bundler -v '~> 2.3.0' --no-document --no-prerelease
 
 # Add new web user
 RUN mkdir /app && \

data/Envfile

@@ -1,6 +1,3 @@
 LANG=en_US.UTF-8
 LANGUAGE=en_US.UTF-8
 LC_ALL=en_US.UTF-8
-
-# Just fix this, so Appraisals with Rails 4 are working fine
-BUNDLER_VERSION=1.17.3

data/Guardfile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+(directories %w[lib spec]).select do |d|
+  if Dir.exist?(d)
+    d
+  else
+    UI.warning("Directory #{d} does not exist")
+  end
+end
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# NOTE: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch('spec/spec_helper.rb') { 'spec' }
+  watch(%r{^lib/immoscout.rb}) { 'spec' }
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/immoscout/([^\\]+)\.rb$}) do |m|
+    "spec/immoscout/#{m[1]}_spec.rb"
+  end
+  watch(%r{^lib/immoscout/([^\\]+)/(.*)\.rb$}) do |m|
+    "spec/#{m[1]}/#{m[2]}_spec.rb"
+  end
+end

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 HAUSGOLD
+Copyright (c) 2023 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/Makefile

@@ -9,6 +9,7 @@ SHELL := bash
 # Environment switches
 MAKE_ENV ?= docker
 COMPOSE_RUN_SHELL_FLAGS ?= --rm
+BASH_RUN_SHELL_FLAGS ?=
 
 # Directories
 VENDOR_DIR ?= vendor/bundle
@@ -26,12 +27,14 @@ RM ?= rm
 XARGS ?= xargs
 
 # Container binaries
-BUNDLE ?= bundle
 APPRAISAL ?= appraisal
+BUNDLE ?= bundle
 GEM ?= gem
+GUARD ?= guard
 RAKE ?= rake
-YARD ?= yard
+RSPEC ?= rspec
 RUBOCOP ?= rubocop
+YARD ?= yard
 
 # Files
 GEMFILES ?= $(subst _,-,$(patsubst $(GEMFILES_DIR)/%.gemfile,%,\
@@ -45,7 +48,8 @@ define run-shell
 	$(COMPOSE) run $(COMPOSE_RUN_SHELL_FLAGS) \
 		-e LANG=en_US.UTF-8 -e LANGUAGE=en_US.UTF-8 -e LC_ALL=en_US.UTF-8 \
 		-e HOME=/home/web -e BUNDLE_APP_CONFIG=/app/.bundle \
-		-u `$(ID) -u` test bash -c 'sleep 0.1; echo; $(1)'
+		-u `$(ID) -u` test \
+		bash $(BASH_RUN_SHELL_FLAGS) -c 'sleep 0.1; echo; $(1)'
 endef
 else ifeq ($(MAKE_ENV),baremetal)
 define run-shell
@@ -57,9 +61,13 @@ all:
 	# Immoscout
 	#
 	# install            Install the dependencies
-	# test               Run the whole test suite
+	# update             Update the local Gemset dependencies
 	# clean              Clean the dependencies
 	#
+	# test               Run the whole test suite
+	# test-style         Test the code styles
+	# watch              Watch for code changes and rerun the test suite
+	#
 	# docs               Generate the Ruby documentation of the library
 	# stats              Print the code statistics (library and test suite)
 	# notes              Print all the notes from the code
@@ -68,19 +76,25 @@ all:
 	# shell              Run an interactive shell on the container
 	# shell-irb          Run an interactive IRB shell on the container
 
+.interactive:
+	@$(eval BASH_RUN_SHELL_FLAGS = --login)
+
 install:
 	# Install the dependencies
 	@$(MKDIR) -p $(VENDOR_DIR)
 	@$(call run-shell,$(BUNDLE) check || $(BUNDLE) install --path $(VENDOR_DIR))
-	@$(call run-shell,GEM_HOME=vendor/bundle/ruby/$${RUBY_MAJOR}.0 \
-		$(GEM) install bundler -v "~> 1.0")
 	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) install)
 
 update:
 	# Install the dependencies
 	@$(MKDIR) -p $(VENDOR_DIR)
+	@$(call run-shell,$(BUNDLE) update)
 	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) update)
 
+watch: install .interactive
+	# Watch for code changes and rerun the test suite
+	@$(call run-shell,$(BUNDLE) exec $(GUARD))
+
 test: \
 	test-specs \
 	test-style
@@ -92,7 +106,7 @@ test-specs:
 $(TEST_GEMFILES): GEMFILE=$(@:test-%=%)
 $(TEST_GEMFILES):
 	# Run the whole test suite ($(GEMFILE))
-	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RAKE))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RSPEC))
 
 test-style: \
 	test-style-ruby
@@ -107,8 +121,8 @@ clean:
 	@$(RM) -rf $(VENDOR_DIR)/Gemfile.lock
 	@$(RM) -rf $(GEMFILES_DIR)/vendor
 	@$(RM) -rf $(GEMFILES_DIR)/*.lock
-	@$(RM) -rf pkg
-	@$(RM) -rf coverage
+	@$(RM) -rf .bundle .yardoc coverage pkg Gemfile.lock doc/api \
+		.rspec_status
 
 clean-containers:
 	# Clean running containers
@@ -119,7 +133,7 @@ endif
 clean-images:
 	# Clean build images
 ifeq ($(MAKE_ENV),docker)
-	@-$(DOCKER) images | $(GREP) immoscout \
+	@-$(DOCKER) images | $(GREP) $(shell basename "`pwd`") \
 		| $(AWK) '{ print $$3 }' \
 		| $(XARGS) -rn1 $(DOCKER) rmi -f
 endif

data/README.md

@@ -28,9 +28,9 @@ the well known _ActiveRecord-like_ model methods.
     - [Attachment (Picture & Document)](#attachment-picture--document)
       - [Overview supported actions](#overview-supported-actions-3)
 - [Development](#development)
-- [Contributing](#contributing)
-- [License](#license)
 - [Code of Conduct](#code-of-conduct)
+- [Contributing](#contributing)
+- [Releasing](#releasing)
 
 ## Installation
 
@@ -217,34 +217,32 @@ picture.destroy # attachment destroy!
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`rake spec` to run the tests. You can also run `bin/console` for an interactive
-prompt that will allow you to experiment.
+After checking out the repo, run `make install` to install dependencies. Then,
+run `make test` to run the tests. You can also run `make shell-irb` for an
+interactive prompt that will allow you to experiment.
 
 To run specs against the immobilienscout24 sandbox api, you need to create some
 keys and tokens. Copy the `spec/test_config.yml.example` to
 `spec/test_config.yml` and fill in your generated values.
 
-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 tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
+## Code of Conduct
+
+Everyone interacting in the project codebase, issue tracker, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](./CODE_OF_CONDUCT.md).
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at
-https://github.com/hausgold/immoscout. This project is intended to be a safe,
-welcoming space for collaboration, and contributors are expected to adhere to
-the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## License
-
-The gem is available as open source under the terms of the [MIT
-License](http://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Immoscout project’s codebases, issue trackers, chat
-rooms and mailing lists is expected to follow the [code of
-conduct](https://github.com/hausgold/immoscout/blob/master/CODE_OF_CONDUCT.md).
+https://github.com/hausgold/immoscout. Make sure that every pull request adds
+a bullet point to the [changelog](./CHANGELOG.md) file with a reference to the
+actual pull request.
+
+## Releasing
+
+The release process of this Gem is fully automated. You just need to open the
+Github Actions [Release
+Workflow](https://github.com/hausgold/immoscout/actions/workflows/release.yml)
+and trigger a new run via the **Run workflow** button. Insert the new version
+number (check the [changelog](./CHANGELOG.md) first for the latest release) and
+you're done.

data/Rakefile

@@ -2,76 +2,23 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'rails/code_statistics'
-require 'pp'
+require 'countless/rake_tasks'
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
 
-# Load some railties tasks
-load 'rails/tasks/statistics.rake'
-load 'rails/tasks/annotations.rake'
-
-# Clear the default statistics directory constant
-#
-# rubocop:disable Style/MutableConstant because we define it
-Object.send(:remove_const, :STATS_DIRECTORIES)
-::STATS_DIRECTORIES = []
-# rubocop:enable Style/MutableConstant
-
-# Monkey patch the Rails +CodeStatistics+ class to support configurable
-# patterns per path. This is reuqired to support top-level only file matches.
-class CodeStatistics
-  DEFAULT_PATTERN = /^(?!\.).*?\.(rb|js|coffee|rake)$/.freeze
-
-  # Pass the possible +pattern+ argument down to the
-  # +calculate_directory_statistics+ method call.
-  def calculate_statistics
-    Hash[@pairs.map do |pair|
-      [pair.first, calculate_directory_statistics(*pair[1..-1])]
-    end]
-  end
-
-  # Match the pattern against the individual file name and the relative file
-  # path. This allows top-level only matches.
-  def calculate_directory_statistics(directory, pattern = DEFAULT_PATTERN)
-    stats = CodeStatisticsCalculator.new
-
-    Dir.foreach(directory) do |file_name|
-      path = "#{directory}/#{file_name}"
-
-      if File.directory?(path) && (/^\./ !~ file_name)
-        stats.add(calculate_directory_statistics(path, pattern))
-      elsif file_name =~ pattern || path =~ pattern
-        stats.add_by_file_path(path)
-      end
-    end
-
-    stats
-  end
-end
-
 # Configure all code statistics directories
-vendors = [
-  [:unshift, 'Top-levels', 'lib', %r{lib(/immoscout)?/[^/]+\.rb$}],
-  [:unshift, 'Top-levels specs', 'spec', %r{spec/_spec\.rb$}],
-
-  [:unshift, 'API', 'lib/immoscout/api'],
-  [:unshift, 'Errors', 'lib/immoscout/errors'],
-
-  [:unshift, 'Models', 'lib/immoscout/models'],
-  [:unshift, 'Models specs', 'spec/models']
-].reverse
-
-vendors.each do |method, type, dir, pattern|
-  ::STATS_DIRECTORIES.send(method, [type, dir, pattern].compact)
-  ::CodeStatistics::TEST_TYPES << type if type.include? 'specs'
-end
-
-# Setup annotations
-ENV['SOURCE_ANNOTATION_DIRECTORIES'] = 'spec,doc'
-desc 'Enumerate all annotations'
-task :notes do
-  SourceAnnotationExtractor.enumerate '@?OPTIMIZE|@?FIXME|@?TODO', tag: true
+Countless.configure do |config|
+  config.stats_base_directories = [
+    { name: 'Top-levels', dir: 'lib',
+      pattern: %r{/lib(/immoscout)?/[^/]+\.rb$} },
+    { name: 'Top-levels specs', test: true, dir: 'spec',
+      pattern: %r{/spec(/immoscout)?/[^/]+_spec\.rb$} },
+    { name: 'APIs', pattern: 'lib/immoscout/api/**/*.rb' },
+    { name: 'Errors', pattern: 'lib/immoscout/errors/**/*.rb' },
+    { name: 'Models', pattern: 'lib/immoscout/models/**/*.rb' },
+    { name: 'Models specs', test: true,
+      pattern: 'spec/models/**/*_spec.rb' }
+  ]
 end

data/gemfiles/rails_5.2.gemfile

@@ -1,9 +1,7 @@
-# frozen_string_literal: true
-
 # This file was generated by Appraisal
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'activesupport', '~> 5.2.2'
+gem "activesupport", "~> 5.2.0"
 
-gemspec path: '../'
+gemspec path: "../"