billomat 1.3.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c167f4c07f96fd19717728953d62deb4185b99b3822a7ff5c45a022f133907a4
-  data.tar.gz: ddde00ee22f03f7c43e88b7350a865732e80f14f0f106834ab0ed1a1d4414c65
+  metadata.gz: 9285a437b3f48f934a29ba53fa604cb2e75c92f741f2d6a3efa5e6d66436faeb
+  data.tar.gz: fc53cadd50256ef7544af986467e95e53a4cc2fdf9921bf9f5902621068229c1
 SHA512:
-  metadata.gz: ffe859647dcaca71302a400bd25df857a9f4c790236ef59b699bf520adc6e8a9d1e909c4820feacb3d83f1734017ccbc8cd8ef6bbbc8a2663e9e70888b04447d
-  data.tar.gz: f14f878aa99ed33587124cbf33a8544e5a94e563b6f62788e24593ede62b1892cd15f0c9b9ae30308d76bf49cbcb99282e99fc7556f12c67f530c9d9d96dbe4e
+  metadata.gz: 7af2786d47172cc693d56979bb0edd737c13e2f314166b0a44c4f02d5115aff7f68a83d17607f010c8b5292987e67f1c101d576aaeb0951e865ca362e755c995
+  data.tar.gz: 7e9dfe58d19fc2eb391aa43683cd7ec4455931fd6b3392225d3d776eb25bef8fdb4845d8082d76ad9945e2a7f570069af13994106305e2498a239feecef3e03f

data/.github/workflows/test.yml

@@ -12,13 +12,16 @@ concurrency:
 
 jobs:
   test:
-    name: 'Test the gem (Ruby ${{ matrix.ruby }})'
+    name: 'Test the gem (Ruby ${{ matrix.ruby }}, Rails ${{ matrix.rails }})'
     runs-on: ubuntu-22.04
     timeout-minutes: 5
     strategy:
       fail-fast: false
       matrix:
         ruby: ['2.7', '3.0']
+        rails: ['6.1', '7.1']
+    env:
+      BUNDLE_GEMFILE: 'gemfiles/rails_${{ matrix.rails }}.gemfile'
     steps:
       - uses: actions/checkout@v4
 

data/Appraisals

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+appraise 'rails-6.1' do
+  gem 'activesupport', '~> 6.1.0'
+end
+
+appraise 'rails-7.1' do
+  gem 'activesupport', '~> 7.1.0'
+end

data/CHANGELOG.md

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

data/Gemfile

@@ -6,6 +6,7 @@ source 'https://rubygems.org'
 gemspec
 
 # Development dependencies
+gem 'appraisal', '~> 2.4'
 gem 'bundler', '~> 2.3'
 gem 'countless', '~> 1.1'
 gem 'guard-rspec', '~> 4.7'

data/Makefile

@@ -13,6 +13,7 @@ BASH_RUN_SHELL_FLAGS ?=
 
 # Directories
 VENDOR_DIR ?= vendor/bundle
+GEMFILES_DIR ?= gemfiles
 
 # Host binaries
 AWK ?= awk
@@ -20,14 +21,19 @@ BASH ?= bash
 COMPOSE ?= docker-compose
 CP ?= cp
 DOCKER ?= docker
+EXPORT ?= export
+FIND ?= find
 GREP ?= grep
+HEAD ?= head
 ID ?= id
 MKDIR ?= mkdir
 RM ?= rm
+SORT ?= sort
 TEST ?= test
 XARGS ?= xargs
 
 # Container binaries
+APPRAISAL ?= appraisal
 BUNDLE ?= bundle
 GEM ?= gem
 GUARD ?= guard
@@ -37,6 +43,12 @@ RUBOCOP ?= rubocop
 YARD ?= yard
 RUBY_VERSION := ruby-version
 
+# Files
+GEMFILES ?= $(subst _,-,$(patsubst $(GEMFILES_DIR)/%.gemfile,%,\
+	$(wildcard $(GEMFILES_DIR)/*.gemfile)))
+TEST_GEMFILES := $(GEMFILES:%=test-%)
+WATCH_GEMFILES := $(GEMFILES:%=watch-%)
+
 # Define a generic shell run wrapper
 # $1 - The command to run
 ifeq ($(MAKE_ENV),docker)
@@ -57,6 +69,7 @@ all:
 	# Billomat
 	#
 	# install            Install the dependencies
+	# update             Update the local Gemset dependencies
 	# clean              Clean the dependencies
 	#
 	# test               Run the whole test suite
@@ -78,16 +91,23 @@ install:
 	# Install the dependencies
 	@$(MKDIR) -p $(VENDOR_DIR)
 	@$(call run-shell,$(BUNDLE) check || $(BUNDLE) install --path $(VENDOR_DIR))
+	@$(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))
 
+$(WATCH_GEMFILES): GEMFILE=$(@:watch-%=%)
+$(WATCH_GEMFILES):
+	# Watch for code changes and rerun the test suite ($(GEMFILE))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(GUARD))
+
 test: \
 	test-specs \
 	test-style
@@ -96,6 +116,11 @@ test-specs:
 	# Run the whole test suite
 	@$(call run-shell,$(BUNDLE) exec $(RAKE) stats spec)
 
+$(TEST_GEMFILES): GEMFILE=$(@:test-%=%)
+$(TEST_GEMFILES):
+	# Run the whole test suite ($(GEMFILE))
+	@$(call run-shell,$(BUNDLE) exec $(APPRAISAL) $(GEMFILE) $(RSPEC))
+
 test-style: \
 	test-style-ruby
 
@@ -107,7 +132,9 @@ test-style-ruby:
 clean:
 	# Clean the dependencies
 	@$(RM) -rf $(VENDOR_DIR)
-	@$(RM) -rf $(VENDOR_DIR)/Gemfile.lock
+	@$(RM) -rf Gemfile.lock
+	@$(RM) -rf $(GEMFILES_DIR)/vendor
+	@$(RM) -rf $(GEMFILES_DIR)/*.lock
 	@$(RM) -rf .bundle .yardoc coverage pkg Gemfile.lock doc/api \
 		.rspec_status
 
@@ -127,11 +154,11 @@ endif
 
 distclean: clean clean-containers clean-images
 
-shell:
+shell: install
 	# Run an interactive shell on the container
 	@$(call run-shell,$(BASH) -i)
 
-shell-irb:
+shell-irb: install
 	# Run an interactive IRB shell on the container
 	@$(call run-shell,bin/console)
 

data/billomat.gemspec

@@ -33,5 +33,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.7'
 
+  spec.add_dependency 'activesupport', '>= 6.1'
   spec.add_dependency 'rest-client', '~> 2.1'
+  spec.add_dependency 'zeitwerk', '~> 2.6'
 end

data/gemfiles/rails_6.1.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.4"
+gem "bundler", "~> 2.3"
+gem "countless", "~> 1.1"
+gem "guard-rspec", "~> 4.7"
+gem "irb", "~> 1.2"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.28"
+gem "rubocop-rails", "~> 2.14"
+gem "rubocop-rspec", "~> 2.10"
+gem "simplecov", ">= 0.22"
+gem "yard", ">= 0.9.28"
+gem "yard-activesupport-concern", ">= 0.0.1"
+gem "activesupport", "~> 6.1.0"
+
+gemspec path: "../"

data/gemfiles/rails_7.1.gemfile

@@ -0,0 +1,20 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.4"
+gem "bundler", "~> 2.3"
+gem "countless", "~> 1.1"
+gem "guard-rspec", "~> 4.7"
+gem "irb", "~> 1.2"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.12"
+gem "rubocop", "~> 1.28"
+gem "rubocop-rails", "~> 2.14"
+gem "rubocop-rspec", "~> 2.10"
+gem "simplecov", ">= 0.22"
+gem "yard", ">= 0.9.28"
+gem "yard-activesupport-concern", ">= 0.0.1"
+gem "activesupport", "~> 7.1.0"
+
+gemspec path: "../"

data/lib/billomat/gateway.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require 'rest-client'
-require 'json'
-
 module Billomat
   # Raised if something goes wrong during an API call.
   class GatewayError < StandardError

data/lib/billomat/models/base.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'ostruct'
-
 module Billomat
   module Models
     # This class is the base for all other models (resources).

data/lib/billomat/search.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'uri'
-
 module Billomat
   # This class provides the possibility to query the resources.
   class Search

data/lib/billomat/version.rb

@@ -3,7 +3,7 @@
 # The gem version details.
 module Billomat
   # The version of the +billomat+ gem
-  VERSION = '1.3.0'
+  VERSION = '1.4.1'
 
   class << self
     # Returns the version of gem as a string.

data/lib/billomat.rb

@@ -1,14 +1,24 @@
 # frozen_string_literal: true
 
-require 'billomat/version'
-require 'billomat/configuration'
-require 'billomat/models'
-require 'billomat/actions'
-require 'billomat/search'
-require 'billomat/gateway'
+require 'zeitwerk'
+require 'logger'
+require 'active_support'
+require 'rest-client'
+require 'json'
+require 'ostruct'
+require 'uri'
 
 # An wrapper for the Billomat API.
 module Billomat
+  # Setup a Zeitwerk autoloader instance and configure it
+  loader = Zeitwerk::Loader.for_gem
+
+  # Finish the auto loader configuration
+  loader.setup
+
+  # Make sure to eager load all constants
+  loader.eager_load
+
   class << self
     attr_writer :configuration
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: billomat
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Hermann Mayer
@@ -9,8 +9,22 @@ authors:
 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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -25,6 +39,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !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: Wrapper for the Billomat API
 email:
 - hermann.mayer92@gmail.com
@@ -41,6 +69,7 @@ files:
 - ".rubocop.yml"
 - ".simplecov"
 - ".yardopts"
+- Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Dockerfile
@@ -59,8 +88,9 @@ files:
 - config/docker/.inputrc
 - doc/assets/project.svg
 - docker-compose.yml
+- gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.1.gemfile
 - lib/billomat.rb
-- lib/billomat/actions.rb
 - lib/billomat/actions/cancel.rb
 - lib/billomat/actions/complete.rb
 - lib/billomat/actions/email.rb
@@ -68,7 +98,6 @@ files:
 - lib/billomat/actions/uncancel.rb
 - lib/billomat/configuration.rb
 - lib/billomat/gateway.rb
-- lib/billomat/models.rb
 - lib/billomat/models/base.rb
 - lib/billomat/models/client.rb
 - lib/billomat/models/contact.rb

data/lib/billomat/actions.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require 'billomat/actions/complete'
-require 'billomat/actions/email'
-require 'billomat/actions/pdf'
-require 'billomat/actions/cancel'
-require 'billomat/actions/uncancel'
-
-module Billomat
-  # Actions are API calls that do not directly represent a resource.
-  # They are mostly non-RESTful actions that are called on a resources.
-  module Actions; end
-end

data/lib/billomat/models.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'billomat/models/base'
-require 'billomat/models/client'
-require 'billomat/models/credit_note'
-require 'billomat/models/credit_note_item'
-require 'billomat/models/invoice'
-require 'billomat/models/invoice_comment'
-require 'billomat/models/invoice_item'
-require 'billomat/models/invoice_payment'
-require 'billomat/models/contact'
-require 'billomat/models/tag'
-require 'billomat/models/template'
-
-module Billomat
-  # Models represent a resource in the API, e.g. invoices, clients.
-  module Models; end
-end