rails_polymorphic_select 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 28c824dd9b61280b7557b2f27b86af716ce12970
+  data.tar.gz: b774ca1261b1c6da982faee850c52fdacbd26ae8
+SHA512:
+  metadata.gz: 8ff560f243aa824ccca4b186ef9c1dddf505360437abecb477593b48d0e443e799aafb05ffe561f9bd8a114b5e920e0ca5265ddeff6674ed8cd4f9a092799380
+  data.tar.gz: b45832487ed8ec86038280800578539b0257c15368b6ab41b1379b63c939670101907980d17d4cb87e996b24395258e6a56767f026089ce1c0f4bd4085735def

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Brian Landau (Viget Labs)
+
+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,86 @@
+# Rails Polymorphic Select
+
+[![Build Status](https://travis-ci.org/vigetlabs/rails_polymorphic_select.png?branch=master)](https://travis-ci.org/vigetlabs/rails_polymorphic_select) [![Code Climate](https://codeclimate.com/github/vigetlabs/rails_polymorphic_select.png)](https://codeclimate.com/github/vigetlabs/rails_polymorphic_select)
+
+This is a simple Rails extension that allows you to create polymorphic select inputs for relationships that are polymorphic.
+
+## Install
+
+Just add this to your `Gemfile` and then `bundle install`:
+
+```ruby
+gem 'rails_polymorphic_select'
+```
+
+## Usage
+
+When using any `ActionView::Helpers::FormBuilder` object (either from the `form_for` helper method or a custom `FormBuilder` object) you can now call the method `polymorphic_select` like so:
+
+```
+<%= form.polymorphic_select :association_name_global_id, [News, Event, Photo] %>
+```
+
+The first argument it accepts is a method name (like all `FormBuilder` input methods), except you'll notice it's a `*_global_id` method. This library will automatically add these methods on all polymorphic relationships you create in your app. So if I have a `Tagging` model and I have a polymorphic relationship named `taggable` like this:
+
+``ruby
+class Tagging
+  belongs_to :tag
+  belongs_to :taggable, :polymorphic => true
+end
+```
+
+This will create a `taggable_global_id` method and a `taggable_global_id=` method for reading and setting the taggable item by it's Global ID. However, it will not add these methods for non-polymorphic relationships (like `tag` in this case). Rails added [`GlobalID`](https://github.com/rails/globalid) functionality in 4.2, so now all ActiveRecord models have a `to_global_id` method that will return a `GlobalID` object that can be used to find the record.
+
+The second argument `polymorphic_select` takes is an `Array` of `ActiveRecord` model classes that are valid options for this polymorphic relationship.
+
+The third argument is an `options` argument and this gets passed to the [`FormBuilder#select`](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select). Before that however there's one extra option that `polymorphic_select` accepts: `:label_method`. This is used as the method to call on individual records to get the value that users would see on the form select input for each record. By default it tries to find a good method (name, title, to_s, etc). If you prefer you can define a `to_label` or `display_name` method on the model(s), and these will be used.
+
+The fourth argument is a `html_options` argument and this gets passed directly unaltered to [`FormBuilder#select`](http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select).
+
+Worth noting is this greats a grouped selct input. So the records will be grouped by model class. The `polymorphic_select` method will use `ModelClass.model_name.human` to label the group. You can modify the name it supplies by manually editing the i18n value for the model.
+
+
+### Advanced usage
+
+Perhaps you have a `Tag` model with `taggings` but you want to access and set the individual `taggables`. In this case you could create your own `*_global_ids` methods and use this on with `polymorphic_select`. Say your `Tag` model looks like this:
+
+```ruby
+class Tag
+  has_many :taggings
+
+  def taggables
+    taggings.map(&:taggable)
+  end
+
+  def taggable_global_ids
+    taggables.map(&:to_global_id)
+  end
+
+  def taggalbe_global_ids=(global_ids)
+    # your own code that at some point uses GlobalID::Locator.locate(global_id_value) to set the taggings
+  end
+end
+```
+
+Then in your form you could do:
+
+```
+<%= form.polymorphic_select :taggable_global_ids, [News, Event, Photo] %>
+```
+
+and it would just work!
+
+
+## Contributing to RailsPolymorphicSelect
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2015 Brian Landau (Viget Labs). See MIT_LICENSE for further details.

data/Rakefile

@@ -0,0 +1,21 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/lib/rails_polymorphic_select.rb

@@ -0,0 +1,6 @@
+require "rails_polymorphic_select/engine"
+
+module RailsPolymorphicSelect
+  autoload :FormBuilder, 'rails_polymorphic_select/form_builder'
+  autoload :BelongsToBuilderExtension, 'rails_polymorphic_select/belongs_to_builder_extension'
+end

data/lib/rails_polymorphic_select/belongs_to_builder_extension.rb

@@ -0,0 +1,25 @@
+module RailsPolymorphicSelect
+  module BelongsToBuilderExtension
+    def define_accessors(mixin, reflection)
+      super
+
+      if reflection.options[:polymorphic]
+        define_global_id_methods(mixin, reflection.name)
+      end
+    end
+
+    def define_global_id_methods(mixin, name)
+      mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
+        def #{name}_global_id
+          #{name}.try(:to_global_id)
+        end
+
+        def #{name}_global_id=(new_global_id)
+          self.#{name} = if new_global_id.present?
+            GlobalID::Locator.locate(new_global_id)
+          end
+        end
+      CODE
+    end
+  end
+end

data/lib/rails_polymorphic_select/engine.rb

@@ -0,0 +1,16 @@
+module RailsPolymorphicSelect
+  class Engine < ::Rails::Engine
+
+    config.generators do |g|
+      g.test_framework      :rspec,        :fixture => false
+      g.fixture_replacement :factory_girl, :dir => 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+
+    initializer "rails_polymorphic_select.include_extensions" do |app|
+      ActionView::Helpers::FormBuilder.send(:include, RailsPolymorphicSelect::FormBuilder)
+      ActiveRecord::Associations::Builder::BelongsTo.extend RailsPolymorphicSelect::BelongsToBuilderExtension
+    end
+  end
+end

data/lib/rails_polymorphic_select/form_builder.rb

@@ -0,0 +1,36 @@
+module RailsPolymorphicSelect
+  module FormBuilder
+    LABEL_NAME_METHODS = [
+      :to_label,
+      :display_name,
+      :label,
+      :name,
+      :title,
+      :username,
+      :login,
+      :value,
+      :to_s
+    ]
+
+    def polymorphic_select(method_name, models, options = {}, html_options = {})
+      label_method = options.delete(:label_method)
+
+      choices = models.map do |model_class|
+        [model_class.model_name.human, model_class.all.map { |record|
+          [label_for(record, label_method), record.to_global_id]
+        }]
+      end
+
+      select(method_name, choices, options, html_options)
+    end
+
+    private
+
+    def label_for(record, label_method)
+      unless label_method && record.respond_to?(label_method)
+        label_method = LABEL_NAME_METHODS.detect{|method_name| record.respond_to?(method_name) }
+      end
+      record.send(label_method)
+    end
+  end
+end

data/lib/rails_polymorphic_select/version.rb

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

data/spec/belongs_to_builder_extension_spec.rb

@@ -0,0 +1,46 @@
+require 'rails_helper'
+
+RSpec.describe RailsPolymorphicSelect::BelongsToBuilderExtension do
+  let(:zebra){ create(:animal, name: 'Zebra', scientific_name: 'Equus zebra') }
+  let(:cheetah){ create(:animal, eats: zebra)}
+
+  it 'creates a global id reader method for polymorphic belongs to relationships' do
+    expect(Animal.public_method_defined?(:eats_global_id)).to eql(true)
+  end
+
+  it 'creates a global id writer method for polymorphic belongs to relationships' do
+    expect(Animal.public_method_defined?(:eats_global_id=)).to eql(true)
+  end
+
+  it 'does not create a global id reader method for non-polymorphic belongs to relationships' do
+    expect(Planet.public_method_defined?(:star_global_id)).to eql(false)
+  end
+
+  it 'does not create a global id writer method for non-polymorphic belongs to relationships' do
+    expect(Planet.public_method_defined?(:star_global_id=)).to eql(false)
+  end
+
+  describe "#*_global_id" do
+    it "returns the related item's global id" do
+      expect(cheetah.eats_global_id).to eql(zebra.to_global_id)
+    end
+
+    it "returns nil if the relationship is not set" do
+      expect(zebra.eats_global_id).to be_nil
+    end
+  end
+
+  describe "#*_global_id=" do
+    it "relates the correct record" do
+      plant = create(:plant)
+      zebra.eats_global_id = plant.to_global_id
+      expect(zebra.eats).to eql(plant)
+    end
+
+    it "remove the relationship if the value is blank" do
+      cheetah.eats_global_id = ""
+      expect(cheetah.eats).to be_nil
+    end
+  end
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/animal.rb

@@ -0,0 +1,5 @@
+class Animal < ActiveRecord::Base
+  belongs_to :eats, polymorphic: true
+
+  validates :name, :scientific_name, presence: true
+end

data/spec/dummy/app/models/planet.rb

@@ -0,0 +1,5 @@
+class Planet < ActiveRecord::Base
+  belongs_to :star
+
+  validates :name, :star, presence: true
+end

data/spec/dummy/app/models/plant.rb

@@ -0,0 +1,3 @@
+class Plant < ActiveRecord::Base
+  validates :name, :scientific_name, presence: true
+end

data/spec/dummy/app/models/star.rb

@@ -0,0 +1,3 @@
+class Star < ActiveRecord::Base
+  validates :name, presence: true
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end