belongs_to_polymorphic 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72a7fc1cfa599890817ed887d3026bfe38a379e04011086704e9c011d493cacb
-  data.tar.gz: 2d4f9da5474e4c6832f5bfd8c3414392f979018b3474c817ca65ab57a708c1fc
+  metadata.gz: 29a354017463f28f8c39642be9e2dfbbf597768a8b2d4f3591f4b1e8a1470931
+  data.tar.gz: d4f65459c4a69796525cc7f9a80dbca787fda27065f8424ac3c62938181185d4
 SHA512:
-  metadata.gz: 281b3a89834676d4e7b70d8349be4a235b79de2933f5dd4e930fda96f84f7d3c3ed442ba089077afa56786bc8b1c21374fea0e0fcadcea5f2eac52fbefd560bc
-  data.tar.gz: a97f89bc4f284cb7cb0eeacc339461ac5b329a937bfd919156da702fd1507234567154488faf42ef41edcaa0bb8f5e48c909baeee10f5b309752e7c301c72efc
+  metadata.gz: 28d1f1b80203ef6b8876ac112ca5e0142f98e0b12b6c31bd804b28bd0e6ed96b4b5720db71b5d69320f50cacc038838635945d0c8aee1e3482aee8f09c9debd3
+  data.tar.gz: 2fa3373ed9d6480668d473a752eca867b6ce3355704145ea83025c40e8e636ec3909277f873682e4e25793c228bcaea490970834fcf8e7c658ad17ed6b4a75bf

data/.reek.yml

@@ -0,0 +1,127 @@
+detectors:
+  Attribute:
+    enabled: false
+    exclude: []
+  BooleanParameter:
+    enabled: true
+    exclude: []
+  ClassVariable:
+    enabled: false
+    exclude: []
+  ControlParameter:
+    enabled: true
+    exclude: []
+  DataClump:
+    enabled: true
+    exclude: []
+    max_copies: 2
+    min_clump_size: 2
+  DuplicateMethodCall:
+    enabled: true
+    exclude: []
+    max_calls: 1
+    allow_calls: []
+  FeatureEnvy:
+    enabled: true
+    exclude: []
+  InstanceVariableAssumption:
+    enabled: false
+  IrresponsibleModule:
+    enabled: false
+    exclude: []
+  LongParameterList:
+    enabled: true
+    exclude: []
+    max_params: 4
+    overrides:
+      initialize:
+        max_params: 5
+  LongYieldList:
+    enabled: true
+    exclude: []
+    max_params: 3
+  ManualDispatch:
+    enabled: true
+    exclude: []
+  MissingSafeMethod:
+    enabled: false
+    exclude: []
+  ModuleInitialize:
+    enabled: true
+    exclude: []
+  NestedIterators:
+    enabled: true
+    exclude: []
+    max_allowed_nesting: 2
+    ignore_iterators: []
+  NilCheck:
+    enabled: false
+    exclude: []
+  RepeatedConditional:
+    enabled: true
+    exclude: []
+    max_ifs: 3
+  SubclassedFromCoreClass:
+    enabled: true
+    exclude: []
+  TooManyConstants:
+    enabled: true
+    exclude: []
+    max_constants: 5
+  TooManyInstanceVariables:
+    enabled: true
+    exclude: []
+    max_instance_variables: 9
+  TooManyMethods:
+    enabled: true
+    exclude: []
+    max_methods: 25
+  TooManyStatements:
+    enabled: true
+    exclude:
+      - initialize
+    max_statements: 12
+  UncommunicativeMethodName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^[a-z]$/"
+      - "/[0-9]$/"
+      - "/[A-Z]/"
+    accept: []
+  UncommunicativeModuleName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^.$/"
+      - "/[0-9]$/"
+    accept:
+      - Inline::C
+      - "/V[0-9]/"
+  UncommunicativeParameterName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^.$/"
+      - "/[0-9]$/"
+      - "/[A-Z]/"
+    accept: []
+  UncommunicativeVariableName:
+    enabled: true
+    exclude: []
+    reject:
+      - "/^.$/"
+      - "/[0-9]$/"
+      - "/[A-Z]/"
+    accept:
+      - _
+  UnusedParameters:
+    enabled: true
+    exclude: []
+  UnusedPrivateMethod:
+    enabled: false
+  UtilityFunction:
+    enabled: false
+
+exclude_paths:
+  - config

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,86 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false
+
+Layout/SpaceBeforeFirstArg:
+  Exclude:
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - spec/**/*
+
+Metrics/AbcSize:
+  # The ABC size is a calculated magnitude, so this number can be an Integer or
+  # a Float.
+  Max: 15
+
+Metrics/BlockLength:
+  CountComments: false
+  Max: 25
+  Exclude:
+    - '*.gemspec'
+    - config/**/*
+    - spec/**/*
+  IgnoredMethods:
+    - class_methods
+
+Metrics/BlockNesting:
+  Max: 4
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 200
+
+# Avoid complex methods.
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 24
+
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 200
+
+Layout/LineLength:
+  Max: 100
+  # To make it possible to copy or click on URIs in the code, we allow lines
+  # containing a URI to be longer than Max.
+  AllowURI: true
+  URISchemes:
+    - http
+    - https
+
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: true
+
+Metrics/PerceivedComplexity:
+  Max: 12
+
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/RescueModifier:
+  Exclude:
+    - spec/**/*
+
+Naming/PredicateName:
+  Enabled: false
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+## [Unreleased]
+
+## [0.1.1] - 2022-03-14
+
+- Initial release
+
+## [0.1.2] - 2022-07-20
+
+- Added necessary specs
+
+## [0.1.3] - 2022-07-20
+
+- Fixed issue with I18n load path
+
+## [0.2.0] - 2022-12-27
+
+- This version is a refactor with a breaking change into how the gem is used.
+
+### Breaking Changes
+
+- Drop usage of the keyword `belongs_to_polymorphic` in favor of `belongs_to`.
+- Drop usage of the option `allowed_classes` in favor of reusing the `polymorphic` option.
+- As an example, in previous versions, you would have:
+
+```ruby
+class User < ApplicationRecord
+  belongs_to_polymorphic :profile, allowed_classes: [Person, Company]
+end
+```
+Whereas in this version, you would have:
+
+```ruby
+class User < ApplicationRecord
+  belongs_to :profile, polymorphic: [Person, Company]
+end
+```

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at hello@gogrow.dev. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/CONTRIBUTORS

@@ -0,0 +1 @@
+Nicolas Erlichman <nicolas@gogrow.dev>

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in belongs_to_polymorphic.gemspec
+gemspec
+
+gem 'database_cleaner-active_record', '~> 1.8.0', require: false
+gem 'rake', '~> 13.0.6'
+gem 'rspec', '~> 3.11.0'
+gem 'rubocop', '~> 1.28'
+gem 'simplecov', '~> 0.17.1'
+gem 'sqlite3', '~> 1.4.2', require: false

data/README.md

@@ -1,6 +1,10 @@
 # Belongs to Polymorphic
+[![Gem Version](https://badge.fury.io/rb/belongs_to_polymorphic.svg)](https://badge.fury.io/rb/belongs_to_polymorphic)
+[![Ruby](https://github.com/gogrow-dev/belongs_to_polymorphic/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/gogrow-dev/belongs_to_polymorphic/actions/workflows/main.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/1e3960d9aa00b8328a30/maintainability)](https://codeclimate.com/github/gogrow-dev/belongs_to_polymorphic/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/1e3960d9aa00b8328a30/test_coverage)](https://codeclimate.com/github/gogrow-dev/belongs_to_polymorphic/test_coverage)
 
-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.
+An ActiveRecord extension which allows us to use polymorphic associations (belongs_to) and validating which classes are allowed to be related to, while also adding some helper methods.
 
 
 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/).
@@ -27,11 +31,11 @@ In your model you can do the following:
 
 ```ruby
 class Book < ActiveRecord::Base
-    belongs_to_polymorphic :owner, allowed_classes: [User, Publisher]
+    belongs_to :owner, polymorphic: [User, Publisher]
 end
 ```
 
-You can also add any options that a regular `belongs_to` with `polymorphic: true` could use.
+You will use a `belongs_to` relatinoship as always, with the only change being that besides just indicating `polymorphic: true` you could specify the allowed polymorphic classes.
 
 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:
@@ -53,7 +57,7 @@ Instance:
 
 ```ruby
 class Book < ActiveRecord::Base
-    belongs_to_polymorphic :owner, allowed_classes: [Publisher::User, Publisher]
+    belongs_to :owner, polymorphic: [Publisher::User, Publisher]
 end
 ```
 
@@ -74,6 +78,25 @@ en:
         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/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  belongs_to_polymorphic:
+    errors:
+      messages:
+        class_not_allowed: "%{class} is not an allowed class"

data/lib/belongs_to_polymorphic/associations.rb

@@ -4,14 +4,23 @@ module BelongsToPolymorphic
   module Associations
     def self.included(base)
       base.extend ClassMethods
+      class << base
+        alias_method :default_belongs_to, :belongs_to
+        alias_method :belongs_to, :belongs_to_polymorphic
+      end
     end
 
     module ClassMethods
-      def belongs_to_polymorphic(name, allowed_classes:, **options)
-        allowed_classes = Array.new(allowed_classes)
-        belongs_to name, polymorphic: true, **options
+      def belongs_to_polymorphic(name, **options)
+        default_belongs_to name, **options
+        polymorphic = options[:polymorphic]
+
+        return unless polymorphic.present? && polymorphic.class != TrueClass
+
+        allowed_classes = classify(polymorphic)
+
         validates "#{name}_type", inclusion: {
-          in: classes(allowed_classes, options),
+          in: inclusion_classes(allowed_classes, options[:optional]),
           message: I18n.t('belongs_to_polymorphic.errors.messages.class_not_allowed',
                           class: '%<value>s')
         }
@@ -23,9 +32,27 @@ module BelongsToPolymorphic
 
       private
 
-      def classes(allowed_classes, options)
+      def classify(classes)
+        Array.wrap(classes).map do |klass|
+          case klass
+          when Class then klass
+          else constantize(klass)
+          end
+        end
+      end
+
+      def constantize(klass)
+        const_class = case klass
+                      when String then klass
+                      when Symbol then klass.to_s
+                      else type.class.name
+                      end
+        const_class.classify.constantize
+      end
+
+      def inclusion_classes(allowed_classes, optional)
         classes = allowed_classes.map(&:name)
-        classes << nil if options[:optional]
+        classes << nil if optional.present?
         classes
       end
 

data/lib/belongs_to_polymorphic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BelongsToPolymorphic
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/belongs_to_polymorphic.rb

@@ -4,7 +4,7 @@ require 'active_record'
 require 'belongs_to_polymorphic/version'
 require 'belongs_to_polymorphic/associations'
 
-I18n.load_path << Dir["#{File.expand_path('config/locales')}/*.yml"]
+I18n.load_path << File.expand_path('config/locales/en.yml')
 
 module BelongsToPolymorphic; end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: belongs_to_polymorphic
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Nicolas Erlichman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2022-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -19,7 +19,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,87 +29,28 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
-- !ruby/object:Gem::Dependency
-  name: database_cleaner-active_record
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.8.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 13.0.6
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.11.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.11.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: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-description: ActiveRecord extension - Polymorphic associations with restricted allowed
-  classes.
+        version: '7.1'
+description:
 email:
 - hello@gogrow.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTORS
+- Gemfile
 - LICENSE.txt
 - README.md
+- Rakefile
+- config/locales/en.yml
+- gemfiles/belongs_to_polymorphic-0.1.2.gem
+- gemfiles/belongs_to_polymorphic-0.1.3.gem
+- gemfiles/belongs_to_polymorphic-0.2.0.gem
 - lib/belongs_to_polymorphic.rb
 - lib/belongs_to_polymorphic/associations.rb
 - lib/belongs_to_polymorphic/version.rb
@@ -118,6 +59,7 @@ licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/gogrow-dev/belongs_to_polymorphic
+  changelog_uri: https://github.com/gogrow-dev/belongs_to_polymorphic/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -127,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="