safe_polymorphic 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aaf728e17cf09be9b04b2a3465b43e089b3daeb0c61c69530f7a40cde085037
-  data.tar.gz: dcadfc2a11171a2aad8d269b672297606a05175de1200562b003219d2f1bb39e
+  metadata.gz: e2343d183e1afc06a3571606a2631753284c943eb1079fdd09498e8153b4e254
+  data.tar.gz: a6f105af6c4ac6ac1484f63339fc5bb71429a3f947bfc9a96b10ea7fce92893f
 SHA512:
-  metadata.gz: 21ead7903d65fd2cccf30325cd47069702ce44f385d949e45fc0f0d598f313db35d68026127e36433fb270b4d934703289294ba0118767e519151a28620bc473
-  data.tar.gz: 4b9cc16deef36d7b430c936a74f79562c0983a32ae500f4c65d6075f289b9d454305e2217fa49fe8b8ba2712cb393e4e128f342dc471cf0b18aa03000908166e
+  metadata.gz: 91a5dc3f1d3195a6ebf3fdc1a6c34a6c021a7685a46ac631859b9fcb9971864e374e50c9b6ba61941891346b47171ffa2d9d42d5ac5a0cfa39a6ec50cf4f6dce
+  data.tar.gz: ea87992a43a22e74d264112b5db178ccebd353d5ba18cd59ac8c21796904af6f69df23c90700656812ac1e389d0364af29bd46d56c9f8701b868a5c77616bea6

data/CHANGELOG.md

@@ -7,4 +7,8 @@
 
 ## [0.1.1] - 2022-12-28
 
-- Fix finder method bug when searching using an instance of a class
+- 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.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    safe_polymorphic (0.1.1)
-      activerecord (>= 5.2, < 7.1)
+    safe_polymorphic (0.1.3)
+      activerecord (>= 5.2, < 8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -76,6 +76,7 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -1,14 +1,27 @@
-# SafePolymorphic
-[![Gem Version](https://badge.fury.io/rb/safe_polymorphic.svg)](https://badge.fury.io/rb/safe_polymorphic)
+[![Gem Version](https://badge.fury.io/rb/safe_polymorphic.svg)](https://badge.fury.io/rb/safe_polymorphic.svg)
 [![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.
+# SafePolymorphic
+
+> The best way to keep your polymorphic relationships safe.
+
+<img align="right" width="150" title="SafePolymorphic logo" src="./logo.png">
+
+An ActiveRecord extension for polymorphic associations.
+
+* **Simple.** It is as easy to use as it is to update.
+* **Safe.** It helps you avoid unintended usage of polymorphic classes.
+* **Powerful.** It packages some helpful scopes and helper methods.
+
+<a href="https://gogrow.dev/?utm_source=github&utm_content=safe_polymorphic">
+<img src="https://www.gogrow.dev/_next/static/media/gogrow-logo.96254aba.svg" alt="Built by GoGrow" width="230"></a>
 
-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
+> Credits: [Improve ActiveRecord Polymorphic Associations](https://blog.rstankov.com/allowed-class-names-in-activerecord-polymorphic-associations/).
+
+## Install
 
 Install the gem and add to the application's Gemfile by executing:
 
@@ -23,23 +36,23 @@ If bundler is not being used to manage dependencies, install the gem by executin
 In your model you can do the following:
 
 ```ruby
-class Book < ActiveRecord::Base
-    belongs_to :owner, polymorphic: [User, Publisher]
+class Address < ActiveRecord::Base
+    belongs_to :addressabel, polymorphic: [User, Company]
 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:
+By using this, we will create a polymorphic relationship in `Address` called `addressable` which can only be a `User` or a `Company`.
+If we try to set an `addressable` 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.
+#ActiveRecord::RecordInvalid: Validation failed: Addressable 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']
+class Address < ActiveRecord::Base
+    belongs_to :addressable, polymorphic: [:user, 'Company']
 end
 ```
 Provided that the strings and symbols translate to existing classes when used with `.classify.constantize`.
@@ -47,27 +60,27 @@ Provided that the strings and symbols translate to existing classes when used wi
 ### Usage with namespaced models
 
 ```ruby
-class Book < ActiveRecord::Base
-    belongs_to :owner, polymorphic: [Publisher::User, Publisher]
+class Address < ActiveRecord::Base
+    belongs_to :addressable, polymorphic: [Company::User, Company]
 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
+- `Address.addressable_types`: returns the allowed classes
+- `Address.with_addressable(#{type})`: generic finder method
+- `Address.with_addressable_#{allowed_class_name}`: scope for each allowed class
 
 Instance methods:
--  `book.owner_type_#{allowed_class_name}?`: check if it is from that specific class
+-  `Address.addressable_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?`
+- `Address.with_addressable(Company::User)`
+- `Address.with_addressable_company_user`
+- `Address.addressable_type_company_user?`
 
 ## I18n
 
@@ -89,15 +102,4 @@ 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).
-
-## 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).
-
-## 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)
+Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](./CODE_OF_CONDUCT.md).

data/lib/safe_polymorphic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SafePolymorphic
-  VERSION = '0.1.1'
+  VERSION = '0.1.3'
 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.
@@ -29,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', '>= 5.2', '< 7.1'
+  spec.add_dependency 'activerecord', '>= 5.2', '< 8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safe_polymorphic
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Nicolas Erlichman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-28 00:00:00.000000000 Z
+date: 2024-08-13 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: '7.1'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,8 +29,10 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
-description:
+        version: '8.0'
+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,10 +48,11 @@ 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
+- logo.png
 - safe_polymorphic.gemspec
 homepage: https://github.com/gogrow-dev/safe_polymorphic
 licenses:
@@ -58,6 +61,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 +80,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: []