polymorphic_aliases 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d96cf37a68602af11b72c0de1f86d336cf7e3e1f195b55ae5a21885dbe18989
+  data.tar.gz: 60b19a2810a6eaf70022c6acae62849405e5506bdca6581e04ce11f462f2dbbc
+SHA512:
+  metadata.gz: 15e7e4eb46cf0b0858ee7be71e0e9c74df973cfa4dbcdb81e7d90046f0846726e6c3d1ab01685d1a2a2ef46551ea9917907db7b37c7f431ec3491ab38ba12fbf
+  data.tar.gz: b475361f2f228e2df591ee830479f305b30e8d22742dfe208c5a898778be614b729f07234d581cf456efa70329485a0f1d46b18fe17321244630f6cf20933d3d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 mansakondo
+
+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,64 @@
+# polymorphic_aliases
+An ActiveRecord extension to use aliases for your polymorphic associations.
+
+## Usage
+Your model code:
+```ruby    
+# app/models/comment.rb    
+class Comment < ApplicationRecord    
+  belongs_to :commentable, polymorphic: true, types: %w( Post Picture )    
+end    
+    
+# app/models/post.rb    
+class Post < ApplicationRecord    
+  has_many :comments, as: :commentable    
+end    
+    
+# app/models/picture.rb    
+class Picture < ApplicationRecord    
+  has_many :comments, as: :commentable    
+end
+```
+In the console:
+```ruby
+post    = Post.create(title: "Polymorphic Aliases", content: "...")
+picture = Picture.create(legend: "Here's my code.", url: "https://avatars.githubusercontent.com/u/47113995?v=4")
+
+comment_from_post    = Comment.create(content: "...", commentable: post)
+comment_from_picture = Comment.create(content: "...", commentable: picture)
+
+comment_from_post.post.title
+# => "Polymorphic Aliases"
+
+comment_from_picture.picture.legend
+# => "Here's my code."
+
+comment_from_post.picture
+# => nil
+
+comment_from_picture.post
+# => nil
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "polymorphic_aliases"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install polymorphic_aliases
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/polymorphic_aliases/active_model/attribute_methods/polymorphic_attribute_aliases.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module PolymorphicAttributeAliases
+  VALID_PREFIXES  = %w( reload_ ).freeze
+  VALID_SUFFIXES  = %w( = ).freeze
+
+  private_constant :VALID_PREFIXES, :VALID_SUFFIXES
+
+  def method_missing(method, *args, &block)
+    prefix, attribute_name, suffix = decompose_method_name(method)
+
+    self.class.reflect_on_all_associations(:belongs_to).each do |reflection|
+      begin
+        next unless (types = reflection.options[:types])
+        next unless (target_type = attributes["#{reflection.name}_type"])
+        next unless types.any? { |type| type.to_s.constantize == target_type.constantize }
+        next unless target_type.constantize == attribute_name.camelize.constantize
+
+        association_method_name = prefix + reflection.name.to_s + suffix
+        return send(:"#{association_method_name}", *args, &block)
+      rescue
+        return super
+      end
+    end
+
+    super
+  end
+
+  private
+
+  def decompose_method_name(method_name)
+    method_name = method_name.to_s
+
+    prefix = ""
+    affix  = method_name
+    suffix = ""
+
+    VALID_PREFIXES.each do |valid_prefix|
+      next unless method_name.start_with?(valid_prefix)
+      prefix = valid_prefix
+      affix  = method_name.delete_prefix(valid_prefix)
+
+      break
+    end
+
+    VALID_SUFFIXES.each do |valid_suffix|
+      next unless method_name.ends_with?(valid_suffix)
+      suffix = valid_suffix
+      affix  = affix.delete_suffix(valid_suffix)
+
+      break
+    end
+
+    return prefix, affix, suffix
+  end
+end
+
+ActiveModel::AttributeMethods.prepend(PolymorphicAttributeAliases)

data/lib/polymorphic_aliases/active_record/associations/builder/belongs_to_polymorphic_association.rb

@@ -0,0 +1,52 @@
+module BelongsToPolymorphicAssociation
+  extend ActiveSupport::Concern
+
+  class_methods do
+    private
+
+    def valid_options(options)
+      valid = super
+      valid += [:types] if options[:polymorphic]
+      valid
+    end
+
+    def define_accessors(model, reflection)
+      super
+
+      mixin = model.generated_association_methods
+
+      if reflection.polymorphic? && reflection.options[:types].present?
+        define_aliases(mixin, reflection)
+      end
+    end
+
+    def define_aliases(mixin, reflection)
+      types            = reflection.options[:types]
+      association_name = reflection.name
+
+      types.each do |type|
+        name = type.tableize.tr("/", "_").singularize
+        type = type.inspect
+
+        mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
+          def #{name}
+            if #{type} == self["#{association_name}_type"]
+              association(:#{association_name}).reader
+            end
+          end
+          def #{name}=(value)
+            if #{type} == self["#{association_name}_type"]
+              association(:#{association_name}).writer(value)
+            end
+          end
+          def reload_#{name}
+            if #{type} == self["#{association_name}_type"]
+              association(:#{association_name}).force_reload_reader
+            end
+          end
+        CODE
+      end
+    end
+  end
+end
+ActiveRecord::Associations::Builder::BelongsTo.prepend(BelongsToPolymorphicAssociation)

data/lib/polymorphic_aliases/railtie.rb

@@ -0,0 +1,4 @@
+module PolymorphicAliases
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/polymorphic_aliases/version.rb

@@ -0,0 +1,3 @@
+module PolymorphicAliases
+  VERSION = '0.2.0'
+end

data/lib/polymorphic_aliases.rb

@@ -0,0 +1,6 @@
+require "polymorphic_aliases/version"
+require "polymorphic_aliases/railtie"
+
+module PolymorphicAliases
+  require "polymorphic_aliases/active_record/associations/builder/belongs_to_polymorphic_association.rb"
+end

data/lib/tasks/polymorphic_aliases_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :polymorphic_aliases do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: polymorphic_aliases
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- mansakondo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.3.1
+description: 
+email:
+- mansakondo22@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/polymorphic_aliases.rb
+- lib/polymorphic_aliases/active_model/attribute_methods/polymorphic_attribute_aliases.rb
+- lib/polymorphic_aliases/active_record/associations/builder/belongs_to_polymorphic_association.rb
+- lib/polymorphic_aliases/railtie.rb
+- lib/polymorphic_aliases/version.rb
+- lib/tasks/polymorphic_aliases_tasks.rake
+homepage: https://github.com/mansakondo/polymorphic_aliases
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/mansakondo/polymorphic_aliases
+  source_code_uri: https://github.com/mansakondo/polymorphic_aliases
+  changelog_uri: https://github.com/mansakondo/polymorphic_aliases/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: An ActiveRecord extension to use aliases for your polymorphic associations.
+test_files: []