assigns_has_many_through_relations 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 091ce286a1c1e886f54fa1afaed43e33148ce45e
-  data.tar.gz: 9a97881cf7f3b91b55de3be7ce3378403518b319
+  metadata.gz: 6dcecc6ee346ff60b3d5c0a6ad374a84f301c2c8
+  data.tar.gz: 60c2dbbeb838b89b3227a825d8d090fea409f6de
 SHA512:
-  metadata.gz: 1c403f598488a5b190100f58bb6d1607b89fcd458ccefbb5b61f12ab03accc549224b7dc9e4f4db45bd507b528440a56033bda4abebac421fdcafe10f068869a
-  data.tar.gz: 4a072185ea985fc2bb3933b4a94de76de1395ad85b87c9a908129605574805d6ab1ea5ee48a8698fa63863c9dea7c257e58fe7986109d98c9455c913c5ebfb02
+  metadata.gz: 9f6d1da9e0651b8cec30fab4e4c74579e3559ea83b2d5c972afe8f09b849cdc62e03872c4827821e97340a89246113e1d61b2eb1e31e71614fa40a84c425e458
+  data.tar.gz: 1dab5c419ac3dfbb844c4077712175076fc863223d2a26ee0d530522a35c1ca2fd740ce1f4d1ffb6dfd38ccadd666d6d1910de935540468675acf5972810e723

data/README.md

@@ -4,10 +4,12 @@ Rails Engine that provides a management UI to assign models to each other in the
 
 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
+## What You Get
 ![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".
+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". 
+
+You'll notice there's a Filter text input, this will filter the corresponding list as you type. Hitting ESC will clear the text field.
 
 ## Installation
 
@@ -25,6 +27,11 @@ Or install it yourself as:
 
     $ gem install assigns_has_many_through_relations
 
+## Dependencies
+
+1. [Twitter Bootstrap](http://getbootstrap.com) (if you want the UI to be pre-styled).
+2. [jQuery](http://jquery.com/download) (for the list Filter).
+
 ## Usage
 
 Declare the routes:
@@ -70,11 +77,19 @@ Finally, render the management UI partial in a view template in `app/views/locat
 
 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.
 
+You can configure the engine to run a controller authorization method as you would a controller macro e.g like [Cancan's](https://github.com/CanCanCommunity/cancancan/wiki/Authorizing-Controller-Actions) `load_and_authorize_resource`:
+
+```ruby
+# config/initializers/assigns_has_many_through_relations.rb
+
+AHMTR.configure do
+  auth_filter :load_and_authorize_resource
+end
+```
+
 ## 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.
+1. Write specs.
 
 ## Contributing
 

data/app/assets/javascripts/assigns_has_many_through_relations/plugins.js

@@ -0,0 +1,59 @@
+// Call this jQuery plugin on a text input field used to filter a ul as the user types
+$.fn.quickListFilter = function(options) {
+  options = $.extend({
+    item: 'li'
+  }, options);
+  
+  return this.each(function() {
+    var filter = $(this),
+        target = filter.data('target'),
+        items = $(target).find(options.item);
+
+    function filterList() {
+      items.each(function() {
+        var regex = new RegExp(filter.val(), 'i'),
+            li = $(this).parent('li');
+
+        if (regex.test(this.innerText)) {
+          li.slideDown(200);
+        } else {
+          li.slideUp(200);
+        }
+      });
+    }
+
+    filter.on('keyup', function(e) {
+      if (e.which === 27) { filter.val(null); }
+      filterList();
+    });
+  });
+}
+
+// Call this jQuery plugin on an element that you want to show 
+// when the target element has scrollbars, and hide if no scrollbars.
+// Useful for a down arrow scroll indicator.
+$.fn.hideWhenNoScrollBars = function() {
+  return this.each(function() {
+    var el = $(this),
+        target = $(el.data('target'));
+
+    function hideWhenNoScrollbars(target, el) {
+      if (target.scrollHeight > target.clientHeight) { // has vertical scrollbars
+        el.show();
+      } else {
+        el.hide();
+      }
+    }
+
+    $(window).on('resize', function() {
+      hideWhenNoScrollbars(target[0], el);      
+    });
+
+    hideWhenNoScrollbars(target[0], el);
+  });
+}
+
+$(function() {
+  $('.quick-filter').quickListFilter({ item: 'li label, li a' });
+  $('.hide-when-no-scrollbars').hideWhenNoScrollBars();
+});

data/app/assets/stylesheets/assigns_has_many_through_relations/application.css.scss

@@ -0,0 +1,38 @@
+#ahmtr_wrap {
+  .nav {
+    font-size: 80%;
+
+    .active {
+      background-color: #ebebeb;
+    }
+  }
+
+  .fix-height {
+    max-height: 60vh;
+    overflow-y: scroll;
+  }
+
+  input[type="text"] {
+    width: 100%;
+  }
+  
+  li {
+    overflow: hidden;
+
+    &:hover {
+      background-color: #ebebeb;
+    }
+
+    label {
+      padding: 5px 7px;
+      cursor: pointer;
+      display: inline-block;
+      width: 95%;
+    }
+
+    input[type="checkbox"] {
+      width: auto;
+      cursor: pointer;
+    }
+  }
+}

data/app/views/_assigns_has_many_through_relations.html.erb

@@ -1,14 +1,17 @@
 <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 class="alert alert-<%= AssignsHasManyThroughRelations::BOOTSTRAP_FLASH_MAP[key] %> alert-dismissible" role="alert">
+        <button type="button" class="close" data-dismiss="alert" aria-label="Close">
+          <span aria-hidden="true">&times;</span>
+        </button>
+        <p><%= message %></p>
       </div>
     <% end %>
   </div>
 </div>
 
-<div id="roles" class="row">
+<div id="ahmtr_wrap" class="row">
   <div class="col-sm-3">
     <div class="panel panel-info">
       <div class="panel-heading">
@@ -44,15 +47,15 @@
     <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 panel-primary 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' %>
+              <%= render 'shared/quick_list_filter', target: '#selected-right-side' %>
 
-              <ul id="selected-users" class="list-unstyled fix-height">
+              <ul id="selected-right-side" 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| %>
@@ -64,28 +67,28 @@
                 <% end %>
               </ul>
 
-              <div class="text-center hide-when-no-scrollbars" data-target="#selected-users">
+              <div class="text-center hide-when-no-scrollbars" data-target="#selected-right-side">
                 <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' } %>
+              <%= f.submit 'Unassign Selected', class: 'btn btn-primary btn-xs' %>
+              <%= f.submit 'Unassign All', class: 'btn btn-primary btn-xs check-all-boxes', data: { target: '#selected-right-side :checkbox', confirm: "Are you sure you want to Unassign all Users from the \"#{@selected_left_side_model.name}\" #{@selected_left_side_model.class}?" } %>
             </div>
           </div>
         </div>
 
         <div class="col-sm-6">
-          <div class="panel panel-danger roles-users-list pull-left">
+          <div class="panel panel-danger 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' %>
+              <%= render 'shared/quick_list_filter', target: '#available-right-side' %>
 
-              <ul id="available-users" class="list-unstyled fix-height">
+              <ul id="available-right-side" 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| %>
@@ -96,14 +99,14 @@
                 <% end %>
               </ul>
 
-              <div class="text-center hide-when-no-scrollbars" data-target="#available-users">
+              <div class="text-center hide-when-no-scrollbars" data-target="#available-right-side">
                 <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' } %>
+              <%= f.submit 'Assign Selected', class: 'btn btn-primary btn-xs' %>
+              <%= f.submit 'Assign All', class: 'btn btn-primary btn-xs check-all-boxes', data: { target: '#available-right-side :checkbox', confirm: "Are you sure you want to Assign all Users to the \"#{@selected_left_side_model.name}\" #{@selected_left_side_model.class}?" } %>
             </div>
           </div>
         </div>

data/lib/assigns_has_many_through_relations.rb

@@ -1,5 +1,6 @@
 require "assigns_has_many_through_relations/version"
 require "assigns_has_many_through_relations/engine"
+require "assigns_has_many_through_relations/configuration"
 
 module AssignsHasManyThroughRelations
   BOOTSTRAP_FLASH_MAP = {
@@ -11,6 +12,16 @@ module AssignsHasManyThroughRelations
   autoload :ControllerConcern, 'assigns_has_many_through_relations/controller_concern'
   autoload :ModelConcern, 'assigns_has_many_through_relations/model_concern'
 
+  class << self
+    attr_reader :config
+    delegate :auth_filter, to: :config
+
+    def configure(&block)
+      @config ||= Configuration.new
+      @config.instance_exec &block
+    end
+  end
+
   module_function
 
   def join_name_for(left_relation, right_relation)
@@ -26,3 +37,6 @@ module AssignsHasManyThroughRelations
     routes.put "/#{left_name}/#{right_name}/:id", to: "#{name}#update", as: "assign_#{name}"
   end
 end
+
+AHMTR = AssignsHasManyThroughRelations
+AHMTR.configure {} # so that @config is never nil

data/lib/assigns_has_many_through_relations/configuration.rb

@@ -0,0 +1,10 @@
+module AssignsHasManyThroughRelations
+  class Configuration
+    # Assign the name of a controller class method that you want to run for authorization
+    # e.g. Cancan's :load_and_authorize_resource, or a custom method you define 
+    # in your ApplicationController
+    def auth_filter(val = nil)
+      @auth_filter ||= val
+    end
+  end
+end

data/lib/assigns_has_many_through_relations/controller_concern.rb

@@ -9,6 +9,8 @@ module AssignsHasManyThroughRelations
 
       include AssignsHasManyThroughRelations::ControllerInstanceMethods
       helper_method :left_relation_class_name, :join_name
+
+      send AHMTR.auth_filter if AHMTR.auth_filter
     end
 
     def left_relation_param_name; @left_relation_param_name end

data/lib/assigns_has_many_through_relations/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: assigns_has_many_through_relations
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Diego Salazar
@@ -64,10 +64,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- app/assets/.DS_Store
+- app/assets/javascripts/assigns_has_many_through_relations/plugins.js
+- app/assets/stylesheets/.DS_Store
+- app/assets/stylesheets/assigns_has_many_through_relations/application.css.scss
 - 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/configuration.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