belongs_to_one_of 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c859bd77b3e7ba52dae74536ea9f93ee9a1e9c4d6a76cc535094a37c176e856a
-  data.tar.gz: 4ac6d7b3a889e9089d2237067eb3f8a15b326bb4be3019102f194c281d74aed3
+  metadata.gz: dbd36b371bf0f376c5c9a5b4c112f200eda2a5c47e9da5e2aa35c6a02c973233
+  data.tar.gz: c5ea5abc93e38741455991599720be1d08b0d3a8df986a2757cc9260c883411d
 SHA512:
-  metadata.gz: c07f2b4d2a28862e96e2a784294d25f364a64bee26ae7f1c96da3ac9ce46ca01e0b222155b429f630afd669ce750a4ec8830b0f000ccd7aae0164e97e10f7027
-  data.tar.gz: b7b56824e7b1d1cf8809b739babb31c8adcc1a7e9d40b4ade605694b7a3119bb8c5a7dad83fe465a200347708a22c99f56182e63fcbf7614038823cf6667e0eb
+  metadata.gz: 599c6afe2cc5998c6d934c0048daf2cf7f74162a834a62e5b6a9cdb22deb870e86b32b43c43ebb0b6288ed37a5e07b2a108b8973ee5620da93c42841d02588ad
+  data.tar.gz: 8c55f5eae719ccc790dcd35b9f7b8ec08724ea71ddb64252105fec1e41ca0a13cf7192df79a383966b45544ad1ba23255ab56cdff65fbe7df384a4cf9d86ed08

data/.github/dependabot.yml

@@ -1,7 +1,7 @@
 version: 2
 updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: weekly
-  open-pull-requests-limit: 10
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10

data/.github/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: tests
+
+on:
+  push:
+    branches:
+      - "master"
+  pull_request:
+
+jobs:
+  tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ["3.1", "3.2", "3.3", "3.4"]
+        rails-version: ["7.0", "7.1", "7.2", "8.0"]
+        exclude:
+          - ruby-version: "3.1"
+            rails-version: "8.0"
+    runs-on: ubuntu-latest
+    env:
+      RAILS_VERSION: ${{ matrix.rails-version }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: "${{ matrix.ruby-version }}"
+      - name: Run tests
+        run: bundle exec rspec
+      - name: Run rubocop
+        run: bundle exec rubocop --parallel --extra-details --display-style-guide

data/.rubocop.yml

@@ -1,16 +1,9 @@
-inherit_from: .rubocop_todo.yml
-
 inherit_gem:
   gc_ruboconfig: rubocop.yml
 
 AllCops:
   TargetRubyVersion: 3.1
-
-Style/CaseLikeIf:
-  Enabled: false
+  NewCops: enable
 
 Gemspec/RequiredRubyVersion:
   Enabled: false
-
-Style/HashSyntax:
-  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-3.1.0
+3.4.1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [v1.0.0] - 2025-01-30
+
+- Drop support for Ruby < 3.1
+- Add support for Rails < 9, drop support for Rails < 7
+
 ## [v0.3.0] - 2022-02-09
 
 - Add Ruby 3.1 support

data/Gemfile

@@ -5,3 +5,14 @@ source "https://rubygems.org"
 gemspec
 
 gem "activerecord", "~> #{ENV['RAILS_VERSION']}" if ENV["RAILS_VERSION"]
+
+group :test, :development do
+  gem "bundler"
+  gem "gc_ruboconfig", "~> 5"
+  gem "pry-byebug"
+  gem "rspec", "~> 3.9"
+  gem "rspec_junit_formatter", "~> 0.4"
+
+  # For integration testing
+  gem "sqlite3", "~> 2"
+end

data/README.md

@@ -1,4 +1,5 @@
 # belongs_to_one_of
+
 Gem to support activemodel relations where one model can be a child of one of many models.
 In our examples, we will be targeting a class `Competitor` which can either belong to a `School` or a `College`.
 We will consider this more general concept an `organisation`.
@@ -8,22 +9,23 @@ and some helper functions to safely set and get the associated model.
 
 ## What about rails polymorphic relations?
 
-Unlike rails polymorphic relations, this supports having a separate `id` column for each parent 
+Unlike rails polymorphic relations, this supports having a separate `id` column for each parent
 model type (e.g. `school_id` and `college_id` instead of just `organisation_id`). This is desirable
 (in some cases) to enable the database to use foreign keys.
 
 The gem will also error if you try to set a resource which isn't one of the specified classes, unlike
 a rails polymorphic relation which will accept any model class.
 
-
 ## Installation
 
 Install the package from Rubygems:
+
 ```shell script
 gem install belongs_to_one_of
 ```
 
 Or add it to your gemfile
+
 ```
 gem 'belongs_to_one_of'
 ```
@@ -37,7 +39,7 @@ Our code will say:
 > This model belongs to an organisation, which might be a School or might be a College
 
 This allows us to store the association in the columns `school_id` and `college_id`, which can use foreign keys,
-but for the 99% of your code which doesn't care which is which, they can just call a method `organisation` or 
+but for the 99% of your code which doesn't care which is which, they can just call a method `organisation` or
 `organisation_id` to access the resource.
 
 The library adds a new association to `ActiveRecord` called `belongs_to_one_of :organisation, `. To use it, simply call this
@@ -50,11 +52,11 @@ end
 
 class School < ActiveRecord::Base
   has_many :competitors
-end 
+end
 
 class College < ActiveRecord::Base
   has_many :competitors
-end 
+end
 
 school = School.new
 
@@ -64,7 +66,7 @@ my_competitor.organisation
 # => school
 
 my_competitor.organisation_id == school.id
-# => true 
+# => true
 ```
 
 Note that this helper calls `belongs_to :school, optional:true` and `belongs_to :college, optional:true`, so you don't have to.
@@ -77,18 +79,22 @@ The hook defines a few methods on your class. The names are dynamic, we will use
 ### Validators
 
 #### `belongs_to_exactly_one_[organisation]`
+
 A validator that can be used to check that a model belongs to exactly one organisation
 
 #### `belongs_to_at_most_one_[organisation]`
+
 A validator that can be used to check that a model belongs to either no organisations or one organisation
 
 #### `[organisation_type]_matches_[organisation]`
-A validator that can be used to check that the type of model matches the model. Only relevant when 
+
+A validator that can be used to check that the type of model matches the model. Only relevant when
 `include_type_column` is true
 
 ### Getters & Setters
 
 #### `[organisation]=`
+
 Allows you to create a new instance of the model with the interface:
 
 ```ruby
@@ -101,23 +107,30 @@ Competitor.new(
 This will raise a `ModelNotFound` exception if the organisation is not one of the permitted model types
 
 #### `[organisation]`
+
 Allows you to get the linked resource via `.organisation` e.g.:
+
 ```ruby
 my_competitor.organisation
 ```
+
 #### `[organisation]_id`
+
 Allows you to get the linked resource's id via `.organisation_id` e.g.:
+
 ```ruby
 my_competitor.organisation_id
-``` 
+```
 
 #### `[organisation]_type`
+
 This is only set when the associations are configured with `include_type_column` (see below). This allows you to access the resource type via
 `.organisation_type` e.g.:
+
 ```ruby
 my_competitor.organisation_type
 # => 'School'
-``` 
+```
 
 ## Configuration Options
 
@@ -125,10 +138,10 @@ my_competitor.organisation_type
 
 By default, the library assumes that the underlying table looks like:
 
-`id` | `name` | `school_id` | `college_id`
-----|----|---|---
-1 | Aaron J Aaronson | | COL123
-2 | Betty F Parker | SCH456 | 
+| `id` | `name`           | `school_id` | `college_id` |
+| ---- | ---------------- | ----------- | ------------ |
+| 1    | Aaron J Aaronson |             | COL123       |
+| 2    | Betty F Parker   | SCH456      |
 
 however you can set `include_type_column: true` to explicitly store what type of model is connected, e.g.:
 
@@ -136,10 +149,10 @@ however you can set `include_type_column: true` to explicitly store what type of
   belongs_to_one_of :organisation, %i[school college], include_type_column: true
 ```
 
-`id` | `name` | `organisation_type` | `school_id` | `college_id`
-----|----|---|---|---
-1 | Aaron J Aaronson | College | | COL123
-2 | Betty F Parker | School | SCH456 | 
+| `id` | `name`           | `organisation_type` | `school_id` | `college_id` |
+| ---- | ---------------- | ------------------- | ----------- | ------------ |
+| 1    | Aaron J Aaronson | College             |             | COL123       |
+| 2    | Betty F Parker   | School              | SCH456      |
 
 if the column is not called `[organisation]_type`, you can specify the column name e.g.
 
@@ -147,16 +160,15 @@ if the column is not called `[organisation]_type`, you can specify the column na
   belongs_to_one_of :organisation, %i[school college], include_type_column: :type_of_organisation
 ```
 
-`id` | `name` | `type_of_organisation` | `school_id` | `college_id`
-----|----|---|---|---
-1 | Aaron J Aaronson | College | | COL123
-2 | Betty F Parker | School | SCH456 | 
-
+| `id` | `name`           | `type_of_organisation` | `school_id` | `college_id` |
+| ---- | ---------------- | ---------------------- | ----------- | ------------ |
+| 1    | Aaron J Aaronson | College                |             | COL123       |
+| 2    | Betty F Parker   | School                 | SCH456      |
 
 ### `type_column_value`
 
 If you have `include_type_column: true` set, by default we assume you want to store the classname in the db.
-However, there may be some logic that you want to apply. If you pass a Proc to `type_column_value` 
+However, there may be some logic that you want to apply. If you pass a Proc to `type_column_value`
 you can add your own logic to determine what goes into the db.
 
 ```ruby
@@ -164,15 +176,14 @@ you can add your own logic to determine what goes into the db.
                                                        type_column_value: ->(resource) { resource.class.downcase }
 ```
 
-`id` | `name` | `organisation_type` | `school_id` | `college_id`
-----|----|---|---|---
-1 | Aaron J Aaronson | college | | COL123
-2 | Betty F Parker | school | SCH456 | 
-
+| `id` | `name`           | `organisation_type` | `school_id` | `college_id` |
+| ---- | ---------------- | ------------------- | ----------- | ------------ |
+| 1    | Aaron J Aaronson | college             |             | COL123       |
+| 2    | Betty F Parker   | school              | SCH456      |
 
 ## License & Contributing
 
-* BelongsToOneOf is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-* Bug reports and pull requests are welcome on GitHub at https://github.com/gocardless/belongs-to-one-of.
+- BelongsToOneOf is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+- Bug reports and pull requests are welcome on GitHub at https://github.com/gocardless/belongs-to-one-of.
 
 GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/about/careers/).

data/belongs_to_one_of.gemspec

@@ -23,17 +23,9 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.6"
+  spec.required_ruby_version = ">= 3.1"
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "gc_ruboconfig", "~> 2.31.0"
-  spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rspec", "~> 3.9"
-  spec.add_development_dependency "rspec_junit_formatter", "~> 0.4"
-
-  # For integration testing
-  spec.add_development_dependency "sqlite3", "~> 1.4.1"
-
-  spec.add_dependency "activerecord", ">= 5.2", "< 8"
-  spec.add_dependency "activesupport", ">= 5.2", "< 8"
+  spec.add_dependency "activerecord", ">= 7.0", "< 9"
+  spec.add_dependency "activesupport", ">= 7.0", "< 9"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/docs/COMPATABILITY.md

@@ -1,13 +1,9 @@
 # Compatibility
 
 Our goal as maintainers is for the library to be compatible with all supported
-versions of Ruby.
+versions of CRuby/MRI Ruby listed [here](https://endoflife.date/ruby).
 
-Specifically, any CRuby/MRI version that has not received an End of Life notice
-([e.g. this notice for Ruby 2.1](https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/))
-is supported.
-
-To that end, [our build matrix](../.circleci/config.yml) includes all these versions.
+To that end, [our build matrix](../.github/tests.yml) includes all these versions.
 
 Any time BelongsToOneOf doesn't work on a supported version of Ruby, it's a bug, and can be
 reported [here](https://github.com/gocardless/belongs-to-one-of/issues).

data/lib/belongs_to_one_of/belongs_to_one_of_model.rb

@@ -55,15 +55,15 @@ module BelongsToOneOf
       return if resource.nil?
 
       possible_resource_types.each_key do |resource_type|
-        model.public_send("#{resource_type}=", nil)
+        model.public_send(:"#{resource_type}=", nil)
       end
 
-      model.instance_variable_set("@#{resource_key}", resource)
+      model.instance_variable_set(:"@#{resource_key}", resource)
       resource_type_accessor = find_resource_accessor(resource, model)
 
       unless resource_type_accessor
-        message = "one of #{possible_resource_types.keys.join(', ')} expected, "\
-                  "got #{resource.inspect} which is an instance of "\
+        message = "one of #{possible_resource_types.keys.join(', ')} expected, " \
+                  "got #{resource.inspect} which is an instance of " \
                   "#{resource.class}(##{resource.class.object_id})"
         raise ActiveRecord::AssociationTypeMismatch, message
       end
@@ -132,7 +132,7 @@ module BelongsToOneOf
             raise InvalidParamsException, "expected a symbol, received #{classname}"
           end
 
-          hash[classname] = "#{classname.to_s.underscore}_id".to_sym
+          hash[classname] = :"#{classname.to_s.underscore}_id"
         end
       elsif raw_possible_resource_types.is_a?(Hash)
         raw_possible_resource_types

data/lib/belongs_to_one_of/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BelongsToOneOf
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/lib/belongs_to_one_of.rb

@@ -32,22 +32,22 @@ module ActiveRecord
         )
 
         # validators
-        define_method "belongs_to_exactly_one_#{resource_key}" do
+        define_method :"belongs_to_exactly_one_#{resource_key}" do
           config_model.validate_exactly_one_resource(self)
         end
 
-        define_method "belongs_to_at_most_one_#{resource_key}" do
+        define_method :"belongs_to_at_most_one_#{resource_key}" do
           config_model.validate_at_most_one_resource(self)
         end
 
         if include_type_column
-          define_method "#{resource_type_field}_matches_#{resource_key}" do
+          define_method :"#{resource_type_field}_matches_#{resource_key}" do
             config_model.validate_correct_resource_type(self)
           end
         end
 
         # setters
-        define_method "#{resource_key}=" do |resource|
+        define_method :"#{resource_key}=" do |resource|
           config_model.resource_setter(resource, self)
         end
 
@@ -56,12 +56,12 @@ module ActiveRecord
           config_model.resource_getter(self)
         end
 
-        define_method "#{resource_key}_id" do
+        define_method :"#{resource_key}_id" do
           config_model.resource_id_getter(self)
         end
 
         unless include_type_column
-          define_method "#{resource_key}_type" do
+          define_method :"#{resource_key}_type" do
             config_model.resource_type_getter(self)
           end
         end

metadata

@@ -1,151 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: belongs_to_one_of
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - GoCardless Engineering
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-09 00:00:00.000000000 Z
+date: 2025-01-30 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: gc_ruboconfig
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.31.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.31.0
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '7.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
-description:
+        version: '9'
 email:
 - engineering@gocardless.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".github/dependabot.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".ruby-version"
 - CHANGELOG.md
 - Gemfile
@@ -159,8 +72,8 @@ files:
 homepage: https://github.com/gocardless/belongs-to-one-of
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -168,15 +81,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A small library that helps with models which can have multiple parent model
   types

data/.circleci/config.yml

@@ -1,57 +0,0 @@
-version: 2.1
-
-jobs:
-  test:
-    parameters:
-      ruby-version:
-        type: string
-      rails-version:
-        type: string
-
-    docker:
-      - image: cimg/ruby:<<parameters.ruby-version>>
-        environment:
-          - RAILS_VERSION=<<parameters.rails-version>>
-    steps:
-      - checkout
-
-      - run: gem install bundler
-      - run: bundle install
-
-      - run: |
-          bundle exec rspec --profile 10 \
-                            --format RspecJunitFormatter \
-                            --out /tmp/test-results/rspec.xml \
-                            --format progress \
-                            spec
-      - store_test_results:
-          path: /tmp/test-results
-
-  rubocop:
-    docker:
-      - image: cimg/ruby:3.1
-    steps:
-      - checkout
-      - run: gem install bundler -v 2.3.4
-      - run: bundle install
-      - run:
-          name: Rubocop
-          command: bundle exec rubocop --parallel --extra-details --display-style-guide
-
-workflows:
-  version: 2
-  tests:
-    jobs:
-      - test:
-          matrix:
-            parameters:
-              ruby-version: ["2.6", "2.7", "3.0", "3.1"]
-              rails-version: ["5.2", "6.0", "6.1", "7.0"]
-            exclude:
-              - ruby-version: "3.0"
-                rails-version: "5.2"
-              - ruby-version: "3.1"
-                rails-version: "5.2"
-              - ruby-version: "2.6"
-                rails-version: "7.0"
-      - rubocop

data/.rubocop_todo.yml

@@ -1,16 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2020-04-17 14:28:59 +0100 using RuboCop version 0.80.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 2
-Metrics/AbcSize:
-  Max: 22
-
-# Offense count: 3
-# Configuration parameters: CountComments, ExcludedMethods.
-Metrics/MethodLength:
-  Max: 37