safe_polymorphic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cdcf7aaf3518f1d4a718593cc9e384e2d867e8bc92a519d0ef192535ed754cbf
+  data.tar.gz: 0a9b9ab48c6efdda379cfc5956bf6579cf230bcb092c5f98df6225e76815314e
+SHA512:
+  metadata.gz: 4acc62a25aaf5cf4a3739f4578870555b1e85fac29d3058f358f51f0805c1857c8b4b31bf18b3b384c7591b3822e51599164c6e4420500ad7896faec5b6cc099
+  data.tar.gz: 036dba54db4d711e0e7b8319f383259c38717ac73b196fde6545082cc7168587af2aa429441409eb393eb6232f3af00c75f19412548a9d2636babad9c1c3023e

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: disable
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-28
+
+- Initial release
+- Moved from [Belongs to Polymorphic](https://rubygems.org/gems/belongs_to_polymorphic)

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 nicolas@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/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    safe_polymorphic (0.1.0)
+      activerecord (>= 5.2, < 7.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    database_cleaner (1.8.5)
+    database_cleaner-active_record (1.8.0)
+      activerecord
+      database_cleaner (~> 1.8.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sqlite3 (1.4.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  database_cleaner-active_record (~> 1.8.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  safe_polymorphic!
+  simplecov (~> 0.17.1)
+  sqlite3 (~> 1.4.2)
+
+BUNDLED WITH
+   2.3.7

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Nicolas Erlichman, 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,84 @@
+# SafePolymorphic
+
+An ActiveRecord extension which allows us to safely use polymorphic associations, by 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/).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add safe_polymorphic
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install safe_polymorphic
+
+## Usage
+
+In your model you can do the following:
+
+```ruby
+class Book < ActiveRecord::Base
+    belongs_to :owner, polymorphic: [User, Publisher]
+end
+```
+
+Define a `belongs_to` relatinoship and instead of just adding the option `polymorphic: true`, we are able to specify the allowed polymorphic classes.
+
+By using this, we will create a polymorphic relationship in `Book` called `owner` which can only be a `User` or a `Publisher`.
+If we try to set an `owner` from a class rather than the aforementioend ones, it will return the following error:
+```ruby
+#ActiveRecord::RecordInvalid: Validation failed: Owner type OtherThing class is not an allowed class.
+```
+
+### Usage with namespaced models
+
+```ruby
+class Book < ActiveRecord::Base
+    belongs_to :owner, polymorphic: [Publisher::User, Publisher]
+end
+```
+
+### Helper methods
+
+Class methods:
+- `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 methods:
+-  `book.owner_type_#{allowed_class_name}?`: check if it is from that specific class
+
+### Helper methods with namespaced models
+
+Class methods:
+- `Book.with_owner(Publisher::User)`
+- `Book.with_owner_publisher_user`
+- `book.owner_type_publisher_user?`
+
+## I18n
+
+Safe Polymoprhic uses I18n to define the not allowed class error. To customize it, you can set up your locale file:
+
+```yaml
+en:
+  safe_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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/safe_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/[USERNAME]/safe_polymorphic/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the SafePolymorphic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/safe_polymorphic/blob/main/CODE_OF_CONDUCT.md).

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:
+  safe_polymorphic:
+    errors:
+      messages:
+        class_not_allowed: "%{class} is not an allowed class"

data/lib/safe_polymorphic/associations.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module SafePolymorphic
+  module Associations
+    def self.included(base)
+      base.extend ClassMethods
+      class << base
+        alias_method :unsafe_polymorphic, :belongs_to
+        alias_method :belongs_to, :safe_polymorphic
+      end
+    end
+
+    module ClassMethods
+      def safe_polymorphic(name, **options)
+        unsafe_polymorphic name, **options
+        polymorphic = options[:polymorphic]
+
+        return unless polymorphic.present? && polymorphic.class != TrueClass
+
+        allowed_classes = classify(polymorphic)
+
+        validates "#{name}_type", inclusion: inclusion_validation(allowed_classes, options[:optional])
+
+        define_singleton_method("#{name}_types") { allowed_classes }
+        define_generic_finder_method(name)
+        define_scopes_and_instance_methods(name, allowed_classes)
+      end
+
+      private
+
+      def inclusion_validation(allowed_classes, optional)
+        {
+          in: inclusion_classes(allowed_classes, optional),
+          message: I18n.t('safe_polymorphic.errors.messages.class_not_allowed',
+                          class: '%<value>s')
+        }
+      end
+
+      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 optional.present?
+        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/safe_polymorphic/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SafePolymorphic
+  VERSION = '0.1.0'
+end

data/lib/safe_polymorphic.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'safe_polymorphic/version'
+require 'active_record'
+require_relative 'safe_polymorphic/associations'
+
+I18n.load_path << File.expand_path('config/locales/en.yml')
+
+module SafePolymorphic
+  class Error < StandardError; end
+end
+
+# Extend ActiveRecord::Base with belongs to polymorphic associations
+ActiveRecord::Base.include SafePolymorphic::Associations

data/safe_polymorphic.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/safe_polymorphic/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'safe_polymorphic'
+  spec.version = SafePolymorphic::VERSION
+  spec.licenses = ['MIT']
+  spec.authors = ['Nicolas Erlichman']
+  spec.email = ['nicolas@gogrow.dev']
+
+  spec.summary = 'ActiveRecord extension - ' \
+  'Polymorphic associations with restricted allowed classes.'
+  spec.homepage = 'https://github.com/gogrow-dev/safe_polymorphic'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 5.2', '< 7.1'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: safe_polymorphic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Erlichman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-28 00:00:00.000000000 Z
+dependencies:
+- !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:
+email:
+- nicolas@gogrow.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- config/locales/en.yml
+- lib/safe_polymorphic.rb
+- lib/safe_polymorphic/associations.rb
+- lib/safe_polymorphic/version.rb
+- safe_polymorphic.gemspec
+homepage: https://github.com/gogrow-dev/safe_polymorphic
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gogrow-dev/safe_polymorphic
+  source_code_uri: https://github.com/gogrow-dev/safe_polymorphic
+  changelog_uri: https://github.com/gogrow-dev/safe_polymorphic/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: ActiveRecord extension - Polymorphic associations with restricted allowed
+  classes.
+test_files: []