assigns_has_many_through_relations 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9051aa8468b71a40fe4182504535bb1a88c3353b
-  data.tar.gz: 44885213a703333b2b7a31383d1e028f86e2ee6d
+  metadata.gz: 308f5f480e2b83971454b1f22f1117aa9b704ba2
+  data.tar.gz: 87e6562f11300bcea323e389237ceed5c8911a91
 SHA512:
-  metadata.gz: a8958ba48851003d24e46c4005d8805d3c9ed3756f61fd1990a71a6e17c92d5b8f6be648a561c408199acd61f0a1895f427e5df244b76d03d06aac7b65d848f2
-  data.tar.gz: 31fe8c803af72c0b924360d4ffb20ce80390db5d6c7bfc18467b074c2de444662fdd5c1300b701cef36f063fe81975612b04a4e6f9ecd8c5645ce72d5bd5413c
+  metadata.gz: 2a7375183004ea1e720ce949abe702219b362ea53d99132a02dad725c3f1de5a1117196303f9e6055cf03e60647422b04a87c2888647b0606fd07ce02476e36d
+  data.tar.gz: 6d2a10591c8580f78d43839e6ba9eaf087e19a711a49f59abeb2d883eb4b26cde2282d4aba4f4c73be5aea53269a30c4f38d9cc38041a53cb94390a05ae883f8

data/README.md

@@ -77,19 +77,54 @@ 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) `authorize_resource`:
+**Note:** _currently the left side model has to respond_to `name` for a nice display name, and the right side model has to respond to `full_name`. This will be configurable soon._
+
+## Configuration
+
+You can configure the engine in an initializer. The given examples are the defaults except for `auth_filter`. That won't run if you don't set it.
 
 ```ruby
 # config/initializers/assigns_has_many_through_relations.rb
 
 AHMTR.configure do
+  # A controller authorization method to call as you would a controller macro.
+  #
+  # e.g like Cancan's authorize_resource (https://github.com/CanCanCommunity/cancancan/wiki/Authorizing-Controller-Actions)
   auth_filter :authorize_resource
+
+  # The scope that loads the left side models.
+  #
+  # e.g. in the case where you declare assigns_has_many_relationships_with :location, :user
+  # then this scope would essentially load:
+  #   Location.all
+  left_relation_scope do |left_relation_class, current_user|
+    left_relation_class.all
+  end
+
+  # The scope that loads the selected left side model's right relations.
+  #
+  # e.g. in the case where you declare assigns_has_many_relationships_with :location, :user
+  # then this scope would essentially load:
+  #   @location.users
+  selected_right_relation_scope do |left_side_model, right_relation_class, current_user|
+    left_side_model.users
+  end
+
+  # The scope that loads all the non selected left side model's right relations.
+  #
+  # e.g. in the case where you declare assigns_has_many_relationships_with :location, :user
+  # then this scope would essentially load:
+  #   User.all - @location.users
+  available_right_relation_scope do |right_relation_class, right_models, current_user|
+    right_relation_class.all - right_models
+  end
 end
 ```
 
 ## Todo
 
 1. Write specs.
+2. Configurable model name method.
 
 ## Contributing
 

data/lib/assigns_has_many_through_relations.rb

@@ -13,7 +13,7 @@ module AssignsHasManyThroughRelations
 
   class << self
     attr_reader :config
-    delegate :auth_filter, to: :config
+    delegate *Configuration::PROPERTIES, to: :config
 
     def configure(&block)
       @config ||= Configuration.new

data/lib/assigns_has_many_through_relations/configuration.rb

@@ -1,10 +1,70 @@
 module AssignsHasManyThroughRelations
   class Configuration
+    PROPERTIES = %w[
+      auth_filter
+      left_relation_scope
+      selected_right_relation_scope
+      available_right_relation_scope
+    ]
+
     # 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
+
+    # Set a block that will return an ActiveRecord scope of the left side models.
+    # the block will receive 2 arguments when it is called in the index action: 
+    #   left_relation_class: class of the left side relation
+    #   user: the current user
+    def left_relation_scope(&block)
+      @left_relation_scope ||= block_given? ? block : method(:default_left_relation_scope)
+    end
+
+    # Set a block that will return an ActiveRecord scope of the selected left side model's
+    # right side relations. The block will receive 2 arguments when it is called in the 
+    # index action: 
+    #   left_side_model: the selected left side model
+    #   right_relation_class: class of the right side relation
+    #   user: the current user
+    def selected_right_relation_scope(&block)
+      @selected_right_relation_scope ||= block_given? ? block : method(:default_selected_right_relation_scope)
+    end
+
+    def available_right_relation_scope(&block)
+      @available_right_relation_scope ||= block_given? ? block : method(:default_available_right_relation_scope)
+    end
+
+    private
+
+    # The default scope just loads all of the left side models
+    #
+    # e.g. n the case where you declare assigns_has_many_relationships_with :location, :user
+    # then the scope would essentially load:
+    #   Location.all
+    def default_left_relation_scope(left_relation_class, user)
+      left_relation_class.all
+    end
+
+    # The default selected right relation  scope loads all of the selected left model's 
+    # right side relations.
+    #
+    # e.g. in the case where you declare assigns_has_many_relationships_with :location, :user
+    # then this scope would essentially load:
+    #   @location.users
+    def default_selected_right_relation_scope(left_side_model, right_relation_class, user)
+      left_model.send right_relation_class.name.demodulize.underscore.pluralize
+    end
+
+    # The default available right relation scope loads all of the right relation model
+    # except for the selected right models returned by selected_right_relation_scope
+    #
+    # e.g. in the case where you declare assigns_has_many_relationships_with :location, :user
+    # then this scope would essentially load:
+    #   User.all - @location.users
+    def default_available_right_relation_scope(right_relation_class, right_models, user)
+      right_relation_class.all - right_models
+    end
   end
 end

data/lib/assigns_has_many_through_relations/controller_concern.rb

@@ -22,11 +22,24 @@ module AssignsHasManyThroughRelations
 
   module ControllerInstanceMethods
     def index
-      @left_side_models = self.class.left_relation_class.order :name
+      @left_side_models = AHMTR.left_relation_scope.call(
+        self.class.left_relation_class,
+        current_user
+      )
       @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
+      
+      @selected_right_side_models = AHMTR.selected_right_relation_scope.call(
+        @selected_left_side_model,
+        self.class.right_relation_class,
+        current_user
+      )
+
+      @available_right_side_models = AHMTR.available_right_relation_scope.call(
+        self.class.right_relation_class,
+        @selected_right_side_models,
+        current_user 
+      )
     end
 
     def update

data/lib/assigns_has_many_through_relations/version.rb

@@ -1,3 +1,3 @@
 module AssignsHasManyThroughRelations
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assigns_has_many_through_relations
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Diego Salazar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails