activerecord-polymorph 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52c2f6317a218c26936a2cc6b637b992cfddd239
+  data.tar.gz: dd2c70fc9f51e69f4bdf8813a910a6879913c5a2
+SHA512:
+  metadata.gz: 1d004e0abd6224692cb789738c6c8fcb5552ab901bbc4c9423453c1db5aa8d559d775aac75945073dcdfae38be4a4e6637a53ae241e3917f7fde5822fd83ba57
+  data.tar.gz: 9a0a30ca6bcfd69db7bac4eecb2ca3970b6e7f9e48c65dff9edc9bb1017c0efc68e8652de7d51689b2f97a445c208e266d8a3ac81896f79c84eca214b27a01e0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at james.kiesel@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 James Kiesel
+
+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,123 @@
+# Polymorph
+
+Polymorph provides a dead simple interface for providing some limited functionality for polymorphic has_many :through relations. Why would we use this?
+
+Say we have a schema like this:
+```ruby
+class Discussion
+  has_many :comments
+end
+
+class Comment
+  belongs_to :discussion
+  belongs_to :participant, polymorphic: true
+end
+
+class User
+  belongs_to :comment, as: :participant
+end
+
+class Robot
+  belongs_to :comment, as: :participant
+end
+```
+
+Sure would be cool here to call `discussion.participants`, and get back an `ActiveRecord::Relation` that we could play with, which had both Users and Robots in it. But, if we try this in rails:
+
+```
+ActiveRecord::HasManyThroughAssociationPolymorphicSourceError: Cannot have a has_many :through association
+```
+(ಠ_ಠ)
+
+But with Polymorph, we can write a line of code like this:
+
+```ruby
+polymorph :participants, through: :comments, source_types: [:users, :robots], fields: [:id, :name]
+```
+
+And get a polymorphic `ActiveRecord::Relation` back:
+
+```
+#<ActiveRecord::AssociationRelation [
+  #<User  id: 1, name: "Fry">,
+  #<User  id: 2, name: "Leela">,
+  #<Robot id: 1, name: "Bender">
+]>
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-polymorph'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install polymorph
+
+## Usage
+
+Polymorph does one thing and one thing only, and that is define the `polymorph` method on `ActiveRecord::Base`.
+
+Available options:
+
+- **through**:      (required) The name of the relation you'd like to construct
+- **source_types**: (required) A list of classes that could be returned by this polymorphic relationship
+- **fields**:       (optional, default: [:id]) A list of fields the polymorphic classes have in common (these are also the fields which you can do 'where' queries on)
+- **through_class**: (optional) The name of the class the relationship reaches through. Is inferred by `through` by default.
+- **source_column**: (optional) The name of the polymorphic association columns (ie, this is the 'participant' in `participant_type` and `participant_id`). Inferred from the relation name by default.
+
+So, as a default, we could write
+```ruby
+polymorph :participants, through: :comments, source_types: [:users, :robots]
+```
+
+Which would work perfectly if we're reaching for Users and Robots through Comments, and Users and Robots don't share any field names.
+
+If Users and Robots share a 'name' field, we write:
+
+```ruby
+polymorph :participants, through: :comments, source_types: [:users, :robots], fields: [:id, :name]
+```
+
+If we want to call these 'participants', but our database columns are already set to 'commenter_id' and 'commenter_type', we can invoke the `source_column` method:
+
+```ruby
+polymorph :commenters, through: :comments, source_types: [:users, :robots], source_column: :commenter
+```
+
+If the ruby class cannot be inferred by the 'through' option, we can point it to the right place with `through_class`:
+
+```ruby
+polymorph :commenters, through: :comments, source_types: [:users, :robots], through_class: Comments::Base
+```
+
+NB that this relation has somewhat limited support for further querying! Currently, we support count, pluck, and simple where clauses on common keys:
+
+```
+discussion.participants.count # => 3
+discussion.participants.pluck(:name) # => ["Fry, Leela", "Bender"]
+discussion.participants.where(name: "Bender") # => #<ActiveRecord::Relation [ #<Robot id: 1, name: "Bender" ]>
+```
+
+Using additional things like joins or where clauses for columns that aren't shared by the source tables will probably end in pain. I am open to extending this in the future, but it works for what I need it for for now. :D
+
+I built this so that I could use it in [Loomio](https://github.com/loomio/loomio). Please use it if you think it's helpful; and I'm happy to hear about any troubles you come across.
+
+## Development
+
+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 tags, 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/gdpelican/activerecord-polymorph. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/activerecord-polymorph.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'polymorph/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-polymorph"
+  spec.version       = Polymorph::VERSION
+  spec.authors       = ["James Kiesel"]
+  spec.email         = ["james.kiesel@gmail.com"]
+
+  spec.summary       = "Allows polymorphic loading of has_many through objects"
+  spec.homepage      = "https://www.github.com/gdpelican/activerecord-polymorph"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activerecord", "~> 4.1"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/polymorph.rb

@@ -0,0 +1,5 @@
+require "polymorph/version"
+require "polymorph/methods"
+require "active_record"
+
+ActiveRecord::Base.extend(Polymorph::Methods)

data/lib/polymorph/methods.rb

@@ -0,0 +1,47 @@
+require "polymorph/relation"
+require "byebug"
+
+module Polymorph
+  module Methods
+    def polymorph(method_name,
+      through:,
+      source_types:,
+      fields: [:id],
+      through_class: through.to_s.singularize.camelize.constantize,
+      source_column: method_name.to_s.singularize,
+      source_type:   "#{source_column}_type")
+
+      define_method method_name, -> {
+
+        query = send(through).select([
+          source_types.map { |t| "#{t}.*" },
+          source_types.product(fields).map { |a| "#{a[0]}.#{a[1]} AS #{a[0].to_s.singularize}_#{a[1]}" },
+          "#{through}.#{source_column}_type",
+          "'true'::boolean as polymorph_query"
+        ].flatten.join(', '))
+
+        source_types.each do |type|
+          query = query.joins(%{
+            LEFT OUTER JOIN #{type}
+            ON #{type}.id = #{through}.#{source_column}_id
+            AND '#{type.to_s.singularize.camelize}' = #{through}.#{source_type}
+          })
+        end
+
+        Polymorph::Relation.new(query, fields: fields, source_types: source_types)
+      }
+
+      through_class.define_singleton_method :instantiate, ->(attrs, column_types) {
+        super(attrs, column_types).tap do |record|
+          transfer_fields = fields.map { |field| [field, attrs["#{attrs[source_type].downcase}_#{field}"]] }.to_h
+          record.assign_attributes(transfer_fields)
+        end
+      }
+
+      through_class.define_singleton_method :discriminate_class_for_record, ->(attributes) {
+        return super(attributes) unless attributes['polymorph_query'].present?
+        attributes["#{source_column}_type"].camelize.constantize
+      }
+    end
+  end
+end

data/lib/polymorph/relation.rb

@@ -0,0 +1,33 @@
+module Polymorph
+  class Relation < SimpleDelegator
+
+    def initialize(query, source_types:, fields:)
+      @source_types, @fields = source_types, fields
+      super(query)
+    end
+
+    def count
+      self.to_a.length
+    end
+
+    def pluck(field)
+      self.to_a.map(&field)
+    end
+
+    def where(hash = {})
+      fields = hash.slice(*@fields)
+      fields.map do |field|
+        %{(
+          #{@source_types.map { |type| "#{type}.#{field[0]} = :#{field[0]}" }.join(" OR ")}
+        )}
+      end.join(" AND ")
+      rebuild(super(clause, fields))
+    end
+
+    private
+
+    def rebuild(query)
+      self.class.new(query, source_types: @source_types, fields: @fields)
+    end
+  end
+end

data/lib/polymorph/version.rb

@@ -0,0 +1,3 @@
+module Polymorph
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-polymorph
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Kiesel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- james.kiesel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-polymorph.gemspec
+- lib/polymorph.rb
+- lib/polymorph/methods.rb
+- lib/polymorph/relation.rb
+- lib/polymorph/version.rb
+homepage: https://www.github.com/gdpelican/activerecord-polymorph
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Allows polymorphic loading of has_many through objects
+test_files: []