safe_polymorphic 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdcf7aaf3518f1d4a718593cc9e384e2d867e8bc92a519d0ef192535ed754cbf
-  data.tar.gz: 0a9b9ab48c6efdda379cfc5956bf6579cf230bcb092c5f98df6225e76815314e
+  metadata.gz: 164e389f0104c35deef618728e27279f0f1efb563398cec61c4c4c6611972f1b
+  data.tar.gz: 9ee365c0242b60164baac2f00f338334f99c73b96e661eea11ffd3f60aa225d3
 SHA512:
-  metadata.gz: 4acc62a25aaf5cf4a3739f4578870555b1e85fac29d3058f358f51f0805c1857c8b4b31bf18b3b384c7591b3822e51599164c6e4420500ad7896faec5b6cc099
-  data.tar.gz: 036dba54db4d711e0e7b8319f383259c38717ac73b196fde6545082cc7168587af2aa429441409eb393eb6232f3af00c75f19412548a9d2636babad9c1c3023e
+  metadata.gz: c9f0e945aeabcf77b7cf35b7b491df63dc97e86fa0d30500d31b2424880bb42543b0310f8f1840e8a9dbab57088292670e36097e7e3c2be7f0b32959299e3074
+  data.tar.gz: 1c64d72005b5c64007a00286bca4ca9bab89753efff0636c33d5b1e103af5f3d5465ec777d87033eabf8372a38372a2973b7b57c6353f8d252d374eb64bab345

data/CHANGELOG.md

@@ -4,3 +4,11 @@
 
 - Initial release
 - Moved from [Belongs to Polymorphic](https://rubygems.org/gems/belongs_to_polymorphic)
+
+## [0.1.1] - 2022-12-28
+
+- Fix finder method bug when searching using an instance of a class
+
+## [0.1.2] - 2022-12-28
+
+- Fix issue that forced to declare the I18n locale (`class_not_allowed`) in each project using this gem instead of using the default locale included in the gem

data/Gemfile

@@ -5,9 +5,9 @@ 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 'database_cleaner-active_record', '~> 1.8.0', require: false, group: :test
 gem 'rake', '~> 13.0'
 gem 'rspec', '~> 3.0'
 gem 'rubocop', '~> 1.21'
-gem 'simplecov', '~> 0.17.1'
-gem 'sqlite3', '~> 1.4.2', require: false
+gem 'simplecov', '~> 0.17.1', require: false, group: :test
+gem 'sqlite3', '~> 1.4.2', require: false, group: :test

data/Gemfile.lock

@@ -1,22 +1,23 @@
 PATH
   remote: .
   specs:
-    safe_polymorphic (0.1.0)
+    safe_polymorphic (0.1.2)
       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)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
     concurrent-ruby (1.1.10)
     database_cleaner (1.8.5)
@@ -71,6 +72,7 @@ GEM
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
+    zeitwerk (2.6.0)
 
 PLATFORMS
   arm64-darwin-21
@@ -86,4 +88,4 @@ DEPENDENCIES
   sqlite3 (~> 1.4.2)
 
 BUNDLED WITH
-   2.3.7
+   2.4.1

data/README.md

@@ -1,6 +1,10 @@
 # SafePolymorphic
+[![Gem Version](https://badge.fury.io/rb/safe_polymorphic.svg)](https://badge.fury.io/rb/safe_polymorphic)
+[![Ruby](https://github.com/gogrow-dev/safe_polymorphic/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/gogrow-dev/safe_polymorphic/actions/workflows/main.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/1b0a4b92bbee2be50dc1/maintainability)](https://codeclimate.com/github/gogrow-dev/safe_polymorphic/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/1b0a4b92bbee2be50dc1/test_coverage)](https://codeclimate.com/github/gogrow-dev/safe_polymorphic/test_coverage)
 
-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.
+ActiveRecord extension which allows us to safely use polymorphic associations, by validating which classes are allowed to be related to, while also adding scopes and 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/).
 
@@ -32,6 +36,14 @@ If we try to set an `owner` from a class rather than the aforementioend ones, it
 #ActiveRecord::RecordInvalid: Validation failed: Owner type OtherThing class is not an allowed class.
 ```
 
+We can also use strings and symbols instead of the classes themselves:
+```ruby
+class Book < ActiveRecord::Base
+    belongs_to :owner, polymorphic: [:user, 'Publisher']
+end
+```
+Provided that the strings and symbols translate to existing classes when used with `.classify.constantize`.
+
 ### Usage with namespaced models
 
 ```ruby
@@ -77,8 +89,15 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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).
+Bug reports and pull requests are welcome on GitHub at https://github.com/gogrow-dev/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/gogrow-dev/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).
+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/gogrow-dev/safe_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/safe_polymorphic/associations.rb

@@ -49,7 +49,7 @@ module SafePolymorphic
         const_class = case klass
                       when String then klass
                       when Symbol then klass.to_s
-                      else type.class.name
+                      else klass.class.name
                       end
         const_class.classify.constantize
       end
@@ -63,12 +63,8 @@ module SafePolymorphic
       # 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)
+          type = constantize(type) unless type.is_a?(Class)
+          where("#{name}_type" => type.name)
         end
       end
 

data/lib/safe_polymorphic/version.rb

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

data/lib/safe_polymorphic.rb

@@ -4,11 +4,13 @@ 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
 
+ActiveSupport.on_load(:i18n) do
+  I18n.load_path << File.expand_path('safe_polymorphic/locales/en.yml', __dir__)
+end
+
 # Extend ActiveRecord::Base with belongs to polymorphic associations
 ActiveRecord::Base.include SafePolymorphic::Associations

data/safe_polymorphic.gemspec

@@ -9,14 +9,16 @@ Gem::Specification.new do |spec|
   spec.authors = ['Nicolas Erlichman']
   spec.email = ['nicolas@gogrow.dev']
 
-  spec.summary = 'ActiveRecord extension - ' \
-  'Polymorphic associations with restricted allowed classes.'
+  spec.summary = 'Safely use polymorphic associations by validating which classes are allowed to be related to.'
+  spec.description = 'ActiveRecord extension which allows us to safely use polymorphic associations, by validating' \
+   'which classes are allowed to be related to, while also adding scopes and helper methods.'
   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"
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # 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.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safe_polymorphic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Nicolas Erlichman
@@ -30,7 +30,9 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.1'
-description:
+description: ActiveRecord extension which allows us to safely use polymorphic associations,
+  by validatingwhich classes are allowed to be related to, while also adding scopes
+  and helper methods.
 email:
 - nicolas@gogrow.dev
 executables: []
@@ -46,9 +48,9 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
-- config/locales/en.yml
 - lib/safe_polymorphic.rb
 - lib/safe_polymorphic/associations.rb
+- lib/safe_polymorphic/locales/en.yml
 - lib/safe_polymorphic/version.rb
 - safe_polymorphic.gemspec
 homepage: https://github.com/gogrow-dev/safe_polymorphic
@@ -58,6 +60,7 @@ 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
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -76,6 +79,6 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: ActiveRecord extension - Polymorphic associations with restricted allowed
-  classes.
+summary: Safely use polymorphic associations by validating which classes are allowed
+  to be related to.
 test_files: []