belongs_to_polymorphic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 12a886ce1619050030e07557b2fa3c005b9a26ce8b0d9738b21cfa62c7a505fe
+  data.tar.gz: 7714ae16a60d00ddb42e22233f7bcbf8853902f7a6e0aab7f920d8a1f898e898
+SHA512:
+  metadata.gz: 2394b5c7083898163b35f2fa5850c7fa1a5b7ecd80567a1e9855aee1ff72f660aebe83836a0e270cbac169a437953e96621d4cb8852e212a7590e6e8454df453
+  data.tar.gz: 6c9f165512366489fc10dd436c277c48e8fe971cac8ae3befa87c6479f647bdab0074775ab2d738251b97913d2c11c81e2fa024ea8d6008cb2c6c5404559018d

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 GoGrow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Belongs to Polymorphic
+
+An ActiveRecord extension defining the concept *belongs to polymorphic*, which allows us to use polymorphic associations (belongs_to) and restrict which classes are allowed to be related to.
+
+
+The base idea and code was taken from this blogpost: [Improve ActiveRecord Polymorphic Associations - Head of engineering at Product Hunt](https://blog.rstankov.com/allowed-class-names-in-activerecord-polymorphic-associations/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'belongs_to_polymorphic'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install belongs_to_polymorphic
+
+## Usage
+
+In your model you can do the following:
+
+```ruby
+class Book < ActiveRecord::Base
+    belongs_to_polymorphic :owner, allowed_classes: [Person, Publisher]
+end
+```
+
+You can also add any options that a regular `belongs_to` with `polymorphic: true` could use.
+
+By using this you create a polymorphic relationship in `Book` called `contents` which can be a `Person` or a `Publisher`.
+If you try to set an `owner` from a class rather than the aforementioend ones, it will return the following error:
+```ruby
+#<ActiveModel::Error attribute=profile_type, type=inclusion, options={:value=>"IncorrectModel"}>
+```
+
+It also automatically adds some helpers
+
+Class:
+- `Book.owner_types`: returns the allowed classes
+- `Book.with_owner(#{type})`: generic finder method
+- `Book.with_owner_#{allowed_class_name}`: scope for each allowed class
+
+Instance:
+-  `book.owner_type_#{allowed_class_name}?`: check if it is from that specific class
+
+### Usage with namespaced models
+
+```ruby
+class Book < ActiveRecord::Base
+    belongs_to_polymorphic :owner, allowed_classes: [Publisher::Person, Publisher]
+end
+```
+
+It will allow you to use:
+- `Book.with_owner(Publisher::Person)`
+- `Book.with_owner_publisher_person`
+- `book.owner_type_publisher_person?`
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/belongs_to_polymorphic/version.rb

@@ -0,0 +1,3 @@
+module BelongsToPolymorphic
+  VERSION = '0.1.0'.freeze
+end

data/lib/belongs_to_polymorphic.rb

@@ -0,0 +1,44 @@
+require 'belongs_to_polymorphic/version'
+require 'active_support/concern'
+
+module BelongsToPolymorphic
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # rubocop:disable Metrics/AbcSize
+    def belongs_to_polymorphic(name, allowed_classes:, **options)
+      allowed_classes = Array.new(allowed_classes)
+      belongs_to name, polymorphic: true, **options
+      classes = allowed_classes.map(&:name)
+      classes << nil if options[:optional]
+      validates "#{name}_type", inclusion: { in: classes }
+      define_singleton_method("#{name}_types") { allowed_classes }
+
+      # generates a generic finder method
+      define_singleton_method("with_#{name}") do |type|
+        type = case type
+               when Class then type.name
+               when String then type
+               else type.class.name
+               end
+        where("#{name}_type" => type)
+      end
+
+      allowed_classes.each do |model|
+        model_name = model.name
+        model_name_sanitized = model_name.underscore.tr('/', '_')
+        # generates scope for each allowed class
+        scope "with_#{name}_#{model_name_sanitized}",
+              -> { where("#{name}_type" => model_name) }
+
+        # generates instance method for each allowed class to check if type is that class
+        define_method("#{name}_type_#{model_name_sanitized}?") do
+          public_send("#{name}_type") == model_name
+        end
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+  end
+end
+
+ActiveRecord::Base.include BelongsToPolymorphic

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: belongs_to_polymorphic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Erlichman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: reek
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rootstrap
+  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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description: ActiveRecord extension - Polymorphic associations with restricted allowed
+  classes.
+email:
+- hello@gogrow.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/belongs_to_polymorphic.rb
+- lib/belongs_to_polymorphic/version.rb
+homepage: https://github.com/gogrow-dev/belongs_to_polymorphic
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/gogrow-dev/belongs_to_polymorphic
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: ActiveRecord extension - Polymorphic associations with restricted allowed
+  classes.
+test_files: []