assigns_has_many_through_relations 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 091ce286a1c1e886f54fa1afaed43e33148ce45e
+  data.tar.gz: 9a97881cf7f3b91b55de3be7ce3378403518b319
+SHA512:
+  metadata.gz: 1c403f598488a5b190100f58bb6d1607b89fcd458ccefbb5b61f12ab03accc549224b7dc9e4f4db45bd507b528440a56033bda4abebac421fdcafe10f068869a
+  data.tar.gz: 4a072185ea985fc2bb3933b4a94de76de1395ad85b87c9a908129605574805d6ab1ea5ee48a8698fa63863c9dea7c257e58fe7986109d98c9455c913c5ebfb02

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in assigns_has_many_through_relations.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Diego Salazar
+
+MIT License
+
+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,85 @@
+# AssignsHasManyThroughRelations
+
+Rails Engine that provides a management UI to assign models to each other in the case where they are associated in a `has_many` `:through` style relationship. 
+
+For example, given a pair of models `Location` and `User`, we will consider `Location` to be the left side relation and `User` to be the right side relation. This UI provides a 3 column Bootstrap view where the left most column displays all `Location`s where the user can select one from the list. The 2 other columns are the Assigned and Unnassigned columns. These display `User`s that either have a join model with the selected `Location` or not, respectively. The user can then select `User`s from the Unnassigned column and the form PUT will create the join models necessary to move the Unnassigned `User`s to the middle Assigned column, effectively associating the selected `User`s from the right most column to the selected `Location`.
+
+## Example UI
+![assigns_has_many_through_relations_screenshot](https://cloud.githubusercontent.com/assets/89930/6175967/0d86cf9e-b2c9-11e4-85d8-79c58d8570d6.png)
+
+In the above example, clicking on "Assign Selected" will move the selected `User`s to the middle column by creating the `locations_user` join model between them and the selected `Location` "Home".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'assigns_has_many_through_relations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install assigns_has_many_through_relations
+
+## Usage
+
+Declare the routes:
+
+```ruby
+YourApp::Application.routes.draw do
+  AssignsHasManyThroughRelations.routes_for :locations, :users, self
+end
+```
+
+Declare the plugin and options in your models:
+
+```ruby
+class Location < ActiveRecord::Base
+  extend AssignsHasManyThroughRelations::ModelConcern
+  assigns_has_many_relationships_with :location, :user
+end
+
+class User < ActiveRecord::Base
+  has_many :locations_users, dependent: :delete_all
+  has_many :locations, through: :locations_users
+end
+```
+
+And a controller to handle the requests:
+
+```ruby
+class LocationsUsersController < ApplicationController
+  extend AssignsHasManyThroughRelations::ControllerConcern
+  assigns_has_many_relationships_with :location, :user
+end
+```
+
+Finally, render the management UI partial in a view template in `app/views/locations_users/index.html.erb`:
+
+```html
+<div id="locations_users">
+  <h1>Assign Users To Location</h1>
+
+  <%= render '/assigns_has_many_through_relations' %>
+</div>
+```
+
+You'll have to provide the user with a link to `locations_users_path`. And that's it. Now you'll be able to assign and unassign `User`s to `Location`s.
+
+## Todo
+
+1. Move the quick_list_filter.js file into the engine.
+2. Write specs.
+3. Clean up css classes and ids in the partial.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/assigns_has_many_through_relations/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/app/views/_assigns_has_many_through_relations.html.erb

@@ -0,0 +1,113 @@
+<div class="flash-messages row">
+  <div class="col-sm-12">
+    <% flash.each do |key, message| %>
+      <div class="alert alert-<%= AssignsHasManyThroughRelations::BOOTSTRAP_FLASH_MAP[key] %>" role="alert">
+        <%= message %>
+      </div>
+    <% end %>
+  </div>
+</div>
+
+<div id="roles" class="row">
+  <div class="col-sm-3">
+    <div class="panel panel-info">
+      <div class="panel-heading">
+        <%= pluralize @left_side_models.size + 1, left_relation_class_name.pluralize %>
+      </div>
+
+      <div id="role-nav-panel" class="panel-body">
+        <%= render 'shared/quick_list_filter', target: '#roles-nav' %>
+
+        <ul id="roles-nav" class="nav nav-stacked fix-height">
+          <li role="presentation" class="active">
+            <%= link_to send("#{join_name}_path", @selected_left_side_model) do %>
+              <%= @selected_left_side_model.name %>
+              <span class="glyphicon glyphicon-chevron-right pull-right"></span>
+            <% end %>
+          </li>
+
+          <% @left_side_models.each do |left_side_model| %>
+            <li role="presentation">
+              <%= link_to left_side_model.name, send("#{join_name}_path", left_side_model) %>
+            </li>
+          <% end %>
+        </ul>
+
+        <div class="text-center hide-when-no-scrollbars" data-target="#roles-nav">
+          <span class="glyphicon glyphicon-chevron-down disabled"></span>
+        </div>
+      </div>
+    </div>
+  </div>
+
+  <%= form_for @selected_left_side_model, url: send("assign_#{join_name}_path", @selected_left_side_model) do |f| %>
+    <div class="col-sm-9">
+      <div class="row">
+        <div class="col-sm-6">
+          <div class="panel panel-primary roles-users-list pull-left">
+            <div class="panel-heading">
+              <%= pluralize @selected_right_side_models.size, "#{@selected_left_side_model.name} User" %>
+            </div>
+
+            <div class="panel-body">
+              <%= render 'shared/quick_list_filter', target: '#selected-users' %>
+
+              <ul id="selected-users" class="list-unstyled fix-height">
+                <% @selected_right_side_models.each do |model| %>
+                  <li>
+                    <%= f.fields_for join_name, @selected_left_side_model.get_join_model_for(model) do |ruf| %>
+                      <%= ruf.hidden_field :id, class: 'pull-left' %>
+                      <%= ruf.check_box :_destroy, class: 'pull-left' %>
+                      <%= ruf.label :_destroy, model.full_name, class: 'pull-left' %>
+                    <% end %>
+                  </li>
+                <% end %>
+              </ul>
+
+              <div class="text-center hide-when-no-scrollbars" data-target="#selected-users">
+                <span class="glyphicon glyphicon-chevron-down disabled"></span>
+              </div>
+            </div>
+
+            <div class="panel-footer">
+              <%= f.submit 'Unassign Selected', class: 'btn btn-warning btn-sm' %>
+              <%= f.submit 'Unassign All', class: 'btn btn-danger btn-sm check-all-boxes', data: { target: '#selected-users :checkbox' } %>
+            </div>
+          </div>
+        </div>
+
+        <div class="col-sm-6">
+          <div class="panel panel-danger roles-users-list pull-left">
+            <div class="panel-heading">
+              <%= pluralize @available_right_side_models.size, "Non #{@selected_left_side_model.name} User" %>
+            </div>
+
+            <div class="panel-body">
+              <%= render 'shared/quick_list_filter', target: '#available-users' %>
+
+              <ul id="available-users" class="list-unstyled fix-height">
+                <% @available_right_side_models.each do |model| %>
+                  <li>
+                    <%= f.fields_for join_name, model.send(join_name).build do |ruf| %>
+                      <%= ruf.check_box "#{model.class.name.demodulize.underscore}_id", { checked: false }, model.id, nil %>
+                      <%= ruf.label "#{model.class.name.demodulize.underscore}_id", model.full_name %>
+                    <% end %>
+                  </li>
+                <% end %>
+              </ul>
+
+              <div class="text-center hide-when-no-scrollbars" data-target="#available-users">
+                <span class="glyphicon glyphicon-chevron-down disabled"></span>
+              </div>
+            </div>
+
+            <div class="panel-footer">
+              <%= f.submit 'Assign Selected', class: 'btn btn-success btn-sm' %>
+              <%= f.submit 'Assign All', class: 'btn btn-primary btn-sm check-all-boxes', data: { target: '#available-users :checkbox' } %>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  <% end %>
+</div>

data/assigns_has_many_through_relations.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'assigns_has_many_through_relations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "assigns_has_many_through_relations"
+  spec.version       = AssignsHasManyThroughRelations::VERSION
+  spec.authors       = ["Diego Salazar"]
+  spec.email         = ["diego@greyrobot.com"]
+  spec.summary       = %q{Rails Engine that provides a management UI to assign models to each other}
+  spec.description   = %q{Rails Engine that provides a management UI to assign models to each other}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/assigns_has_many_through_relations.rb

@@ -0,0 +1,28 @@
+require "assigns_has_many_through_relations/version"
+require "assigns_has_many_through_relations/engine"
+
+module AssignsHasManyThroughRelations
+  BOOTSTRAP_FLASH_MAP = {
+    notice: 'success',
+    error: 'danger'
+  }
+  BOOTSTRAP_FLASH_MAP.default = 'info'
+
+  autoload :ControllerConcern, 'assigns_has_many_through_relations/controller_concern'
+  autoload :ModelConcern, 'assigns_has_many_through_relations/model_concern'
+
+  module_function
+
+  def join_name_for(left_relation, right_relation)
+    "#{left_relation.to_s.pluralize}_#{right_relation.to_s.pluralize}"
+  end
+
+  def routes_for(left_relation, right_relation, routes)
+    name = join_name_for left_relation, right_relation
+    left_name = left_relation.to_s.pluralize
+    right_name = right_relation.to_s.pluralize
+
+    routes.get "/#{left_name}/#{right_name}/:id", to: "#{name}#index", as: name
+    routes.put "/#{left_name}/#{right_name}/:id", to: "#{name}#update", as: "assign_#{name}"
+  end
+end

data/lib/assigns_has_many_through_relations/controller_concern.rb

@@ -0,0 +1,47 @@
+module AssignsHasManyThroughRelations
+  module ControllerConcern
+    def assigns_has_many_relationships_with(left_relation, right_relation)
+      @left_relation_param_name = left_relation
+      @left_relation_class = left_relation.to_s.camelize.constantize
+      @left_relation_class_name = @left_relation_class.name
+      @right_relation_class = right_relation.to_s.camelize.constantize
+      @join_name = AssignsHasManyThroughRelations.join_name_for left_relation, right_relation
+
+      include AssignsHasManyThroughRelations::ControllerInstanceMethods
+      helper_method :left_relation_class_name, :join_name
+    end
+
+    def left_relation_param_name; @left_relation_param_name end
+    def left_relation_class; @left_relation_class end
+    def left_relation_class_name; @left_relation_class_name end
+    def right_relation_class; @right_relation_class end
+    def join_name; @join_name end
+  end
+
+  module ControllerInstanceMethods
+    def index
+      @left_side_models = self.class.left_relation_class.order :name
+      @selected_left_side_model = self.class.left_relation_class.find params[:id]
+      @left_side_models = @left_side_models - [@selected_left_side_model]
+      @selected_right_side_models = @selected_left_side_model.users
+      @available_right_side_models = User.active - @selected_right_side_models
+    end
+
+    def update
+      left_side_model = self.class.left_relation_class.find params[:id]
+
+      if left_side_model.update_attributes params[self.class.left_relation_param_name]
+        flash[:notice] = "Successfully set #{self.class.left_relation_param_name} assignments"
+      else
+        flash[:error] = left_side_model.errors.full_messages.to_sentence
+      end
+
+      redirect_to :back
+    end
+
+    private
+
+    def left_relation_class_name; self.class.left_relation_class_name end
+    def join_name; self.class.join_name end
+  end
+end

data/lib/assigns_has_many_through_relations/engine.rb

@@ -0,0 +1,4 @@
+module AssignsHasManyThroughRelations
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/assigns_has_many_through_relations/model_concern.rb

@@ -0,0 +1,22 @@
+module AssignsHasManyThroughRelations
+  module ModelConcern
+    def assigns_has_many_relationships_with(left_relation, right_relation)
+      @join_name = AssignsHasManyThroughRelations.join_name_for left_relation, right_relation
+
+      has_many @join_name.to_sym, dependent: :delete_all
+      has_many right_relation.to_s.pluralize.to_sym, through: @join_name.to_sym
+      accepts_nested_attributes_for @join_name.to_sym, allow_destroy: true
+      attr_accessible "#{@join_name}_attributes"
+
+      include AssignsHasManyThroughRelations::ModelInstanceMethods
+    end
+
+    def join_name; @join_name end
+  end
+
+  module ModelInstanceMethods
+    def get_join_model_for(relation)
+      send(self.class.join_name).where("#{relation.class.name.underscore}_id" => relation.id).first
+    end
+  end
+end

data/lib/assigns_has_many_through_relations/version.rb

@@ -0,0 +1,3 @@
+module AssignsHasManyThroughRelations
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: assigns_has_many_through_relations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Diego Salazar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Rails Engine that provides a management UI to assign models to each other
+email:
+- diego@greyrobot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/.DS_Store
+- app/views/_assigns_has_many_through_relations.html.erb
+- assigns_has_many_through_relations.gemspec
+- lib/assigns_has_many_through_relations.rb
+- lib/assigns_has_many_through_relations/controller_concern.rb
+- lib/assigns_has_many_through_relations/engine.rb
+- lib/assigns_has_many_through_relations/model_concern.rb
+- lib/assigns_has_many_through_relations/version.rb
+homepage: ''
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Rails Engine that provides a management UI to assign models to each other
+test_files: []