belongs_to_polymorphic 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12a886ce1619050030e07557b2fa3c005b9a26ce8b0d9738b21cfa62c7a505fe
-  data.tar.gz: 7714ae16a60d00ddb42e22233f7bcbf8853902f7a6e0aab7f920d8a1f898e898
+  metadata.gz: 5d1c2af190a259601a400ab83fc7878d3ba1e9ba155d08920b687d41b551f2af
+  data.tar.gz: e00c21112f674af04124f846d56b9d5c611f29038490aa021ceba0bef87abdd6
 SHA512:
-  metadata.gz: 2394b5c7083898163b35f2fa5850c7fa1a5b7ecd80567a1e9855aee1ff72f660aebe83836a0e270cbac169a437953e96621d4cb8852e212a7590e6e8454df453
-  data.tar.gz: 6c9f165512366489fc10dd436c277c48e8fe971cac8ae3befa87c6479f647bdab0074775ab2d738251b97913d2c11c81e2fa024ea8d6008cb2c6c5404559018d
+  metadata.gz: 7a3212e59e3449e9f2da0038cb45bb73b6d9ff212624145ee73a3b98f7f40933c774803008ee8581d6074fdef6aa5bef6d2985c30b3e1e0796daf8999d794ab0
+  data.tar.gz: bb848815e83b195207af66184440442f70416eaf09d90cf054c3a54ea96266d3812873f8ec81dae3567c82df5bf9164fbadb84ceb1cf995aaf43ef7c74c2a3c2

data/README.md

@@ -3,7 +3,7 @@
 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/).
+The base idea 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
 
@@ -27,16 +27,16 @@ In your model you can do the following:
 
 ```ruby
 class Book < ActiveRecord::Base
-    belongs_to_polymorphic :owner, allowed_classes: [Person, Publisher]
+    belongs_to_polymorphic :owner, allowed_classes: [User, 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`.
+By using this you create a polymorphic relationship in `Book` called `owner` which can be a `User` 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"}>
+#ActiveRecord::RecordInvalid: Validation failed: Owner type OtherThing class is not an allowed class.
 ```
 
 It also automatically adds some helpers
@@ -53,15 +53,46 @@ Instance:
 
 ```ruby
 class Book < ActiveRecord::Base
-    belongs_to_polymorphic :owner, allowed_classes: [Publisher::Person, Publisher]
+    belongs_to_polymorphic :owner, allowed_classes: [Publisher::User, Publisher]
 end
 ```
 
 It will allow you to use:
-- `Book.with_owner(Publisher::Person)`
-- `Book.with_owner_publisher_person`
-- `book.owner_type_publisher_person?`
+- `Book.with_owner(Publisher::User)`
+- `Book.with_owner_publisher_user`
+- `book.owner_type_publisher_user?`
+
+## I18n
+
+Belongs to Polymoprhic uses I18n to define the not allowed class error. To customize it, you can set up your locale file:
+
+```yaml
+en:
+  belongs_to_polymoprhic:
+    errors:
+      messages:
+        class_not_allowed: "%{class} is not an allowed class"
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gogrow-dev/belongs_to_polymorphic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/gogrow-dev/belongs_to_polymorphic/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the belongs_to_polymorphic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gogrow-dev/belongs_to_polymorphic/blob/main/CODE_OF_CONDUCT.md).
+
+## Credits
+
+belongs_to_polymorphic is maintained by [GoGrow](https://gogrow.dev) with the help of our
+[contributors](https://github.com/gogrow-dev/belongs_to_polymorphic/contributors).
+
+[<img src="https://user-images.githubusercontent.com/9309458/180014465-00477428-fd76-48f6-b984-5b401b8ce241.svg" height="50"/>](https://gogrow.dev)

data/lib/belongs_to_polymorphic/associations.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module BelongsToPolymorphic
+  module Associations
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def belongs_to_polymorphic(name, allowed_classes:, **options)
+        allowed_classes = Array.wrap(allowed_classes)
+        belongs_to name, polymorphic: true, **options
+
+        validates "#{name}_type", inclusion: {
+          in: classes(allowed_classes, options),
+          message: I18n.t('belongs_to_polymorphic.errors.messages.class_not_allowed',
+                          class: '%<value>s')
+        }
+
+        define_singleton_method("#{name}_types") { allowed_classes }
+        define_generic_finder_method(name)
+        define_scopes_and_instance_methods(name, allowed_classes)
+      end
+
+      private
+
+      def classes(allowed_classes, options)
+        classes = allowed_classes.map(&:name)
+        classes << nil if options[:optional]
+        classes
+      end
+
+      # Generates a generic finder method
+      def define_generic_finder_method(name)
+        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
+      end
+
+      def define_scopes_and_instance_methods(name, allowed_classes)
+        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
+    end
+  end
+end

data/lib/belongs_to_polymorphic/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BelongsToPolymorphic
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.3'
 end

data/lib/belongs_to_polymorphic.rb

@@ -1,44 +1,12 @@
-require 'belongs_to_polymorphic/version'
-require 'active_support/concern'
-
-module BelongsToPolymorphic
-  extend ActiveSupport::Concern
+# frozen_string_literal: true
 
-  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
+require 'active_record'
+require 'belongs_to_polymorphic/version'
+require 'belongs_to_polymorphic/associations'
 
-      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) }
+I18n.load_path << File.expand_path('config/locales/en.yml')
 
-        # 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
+module BelongsToPolymorphic; end
 
-ActiveRecord::Base.include BelongsToPolymorphic
+# Extend ActiveRecord::Base with belongs to polymorphic associations
+ActiveRecord::Base.include BelongsToPolymorphic::Associations

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belongs_to_polymorphic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Nicolas Erlichman
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,70 +16,62 @@ dependencies:
     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:
-    - - ">="
+        version: '5.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '8.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: reek
+  name: database_cleaner-active_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
-  name: rubocop-rootstrap
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -95,25 +87,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.17.1
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
-  type: :runtime
+        version: 1.4.2
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: 1.4.2
 description: ActiveRecord extension - Polymorphic associations with restricted allowed
   classes.
 email:
@@ -125,13 +111,15 @@ files:
 - LICENSE.txt
 - README.md
 - lib/belongs_to_polymorphic.rb
+- lib/belongs_to_polymorphic/associations.rb
 - lib/belongs_to_polymorphic/version.rb
-homepage: https://github.com/gogrow-dev/belongs_to_polymorphic
+homepage: https://gogrow.dev
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/gogrow-dev/belongs_to_polymorphic
-post_install_message: 
+  source_code_uri: https://gogrow.dev
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,8 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: ActiveRecord extension - Polymorphic associations with restricted allowed
   classes.