is_positionable 0.0.0 → 0.1.0

data/README.rdoc

@@ -1,17 +1,88 @@
-= ip
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-   bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+= Is Positionable
+
+== What is "Is Positionable"?
+
+Is Positionable handles the positioning (ordering) your ActiveRecord Objects. It makes use of the "Acts As List" gem to do it the most efficient way. Is Positionable basically creates a front-end (dynamically generates buttons and actions) for moving ActiveRecord Objects "up", "down", to the "top" and to the "bottom". Doing the simplest set up takes just 1 word: "is_positionable".
+
+=== Quick and Simple Example
+
+==== config/environment.rb
+
+  config.gem "is_positionable", :source => "http://gemcutter.org/"
+
+==== app/controllers/posts_controller.rb
+
+  PostsController < ApplicationController
+    is_positionable
+    
+    def index
+      @posts = Post.all
+    end
+    ...
+  end
+
+==== app/models/post.rb
+
+  class Post < ActiveRecord::Base
+    default_scope :order => :position
+  end
+
+==== app/views/posts/index.html.erb
+
+  for post in @posts
+    <%= up_button_for_posts(@posts, post) %>
+    <%= down_button_for_posts(@posts, post) %>
+    <%= top_button_for_posts(@posts, post) %>
+    <%= bottom_button_for_posts(@posts, post) %>
+    ...
+    # Other Stuff like post.name post.user.name etc.
+  end
+
+With just this bit of code, you now enabled positioning with "posts".
+This might already be obvious, but the following 4 buttons are generated per post:
+- Up Button
+- Down Button
+- To Top Button
+- To Bottom Button
+
+Now, this is the most basic setup. You might have "users" manage posts. So that'd mean "User has_many :posts".
+In this case you can add a "scope" and "scope_object" so that one user cannot conflict with another user's post positions.
+
+This would look something like this
+
+  is_listable :scope        => :user_id,
+              :scope_object => current_user
+  
+  # Assuming that "current_user" is the currently logged in use
+
+The above will ensure that, not only will one users' post NOT conflict with another users' post,
+but if one user tries to be hack-ish and try to attempt to change post position of a different user through cURL or the AddressBar
+it will be out of scope cause of the :scope_object attribute, restricting access to any other user, but the owner of the post. 
+
+==== Of course, these are not the only options you can set, for more information, see the Wiki pages!
+
+==== Setting all this up takes me about 1-2 minutes
+
+
+== Interested in trying out "Is Positionable"?
+
+=== Check out the following Wiki pages:
+
+=== Installation
+
+http://wiki.github.com/meskyanichi/is_positionable/installation
+
+
+=== Getting Started
+
+http://wiki.github.com/meskyanichi/is_positionable/getting-started
+
+
+=== Options
+
+http://wiki.github.com/meskyanichi/is_positionable/options
+
+
 
 == Copyright
 

data/is_positionable.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{is_positionable}
-  s.version = "0.0.0"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["meskyanichi"]

data/lib/is_positionable.rb

@@ -43,7 +43,7 @@ module IsPositionable
         end
         
         # Sets the default scope to order by the specified column
-        default_scope :order => interface.column if interface.set_default_scope?
+        # default_scope :order => interface.column if interface.set_default_scope?
                 
       end
       
@@ -112,7 +112,7 @@ module IsPositionable
     
       # Injects the "UP" button for the view helpers into the controller
       # This will be available to all views within the specified controller
-      define_method "up_button_for_#{interface.controller_name}" do |object, *options|
+      define_method "up_button_for_#{interface.controller_name}" do |objects, object, *options|
       
         # Set default options and overwrite the existing ones with
         # possible user input
@@ -128,13 +128,13 @@ module IsPositionable
             :id             => "up_button_for_#{interface.controller_name.singularize}_#{object.id}",
             :class          => "up_button_for_#{interface.controller_name}" }
         }.update(options.empty? ? {} : options.first)
-      
-        button_to(options[:name], options[:url], options[:html]) unless object.first?
+        
+        button_to(options[:name], options[:url], options[:html]) unless objects.first.eql?(object)
       end
       
       # Injects the "DOWN" button for the view helpers into the controller
       # This will be available to all views within the specified controller
-      define_method "down_button_for_#{interface.controller_name}" do |object, *options|
+      define_method "down_button_for_#{interface.controller_name}" do |objects, object, *options|
       
         # Set default options and overwrite the existing ones with
         # possible user input
@@ -151,22 +151,12 @@ module IsPositionable
             :class          => "down_button_for_#{interface.controller_name}" }
         }.update(options.empty? ? {} : options.first)
         
-        # Ensures that the last id will only be found once
-        # and not for each object that comes through the loop
-        unless defined?(@ip_last)
-          @ip_last = interface.find_last_id
-        end
-        
-        # Ensures that the last "Down" button will not be displayed
-        # since you can't go lower than the lowest position
-        unless @ip_last.eql?(object.id)
-          button_to(options[:name], options[:url], options[:html])
-        end
+        button_to(options[:name], options[:url], options[:html]) unless objects.last.eql?(object)
       end
     
       # Injects the "TOP" button for the view helpers into the controller
       # This will be available to all views within the specified controller
-      define_method "top_button_for_#{interface.controller_name}" do |object, *options|
+      define_method "top_button_for_#{interface.controller_name}" do |objects, object, *options|
       
         # Set default options and overwrite the existing ones with
         # possible user input
@@ -183,12 +173,12 @@ module IsPositionable
             :class          => "top_button_for_#{interface.controller_name}" }
         }.update(options.empty? ? {} : options.first)
       
-        button_to(options[:name], options[:url], options[:html]) unless object.first?
+        button_to(options[:name], options[:url], options[:html]) unless objects.first.eql?(object)
       end
            
       # Injects the "BOTTOM" button for the view helpers into the controller
       # This will be available to all views within the specified controller
-      define_method "bottom_button_for_#{interface.controller_name}" do |object, *options|
+      define_method "bottom_button_for_#{interface.controller_name}" do |objects, object, *options|
       
         # Set default options and overwrite the existing ones with
         # possible user input
@@ -204,18 +194,8 @@ module IsPositionable
             :id             => "bottom_button_for_#{interface.controller_name.singularize}_#{object.id}",
             :class          => "bottom_button_for_#{interface.controller_name}" }
         }.update(options.empty? ? {} : options.first)
-        
-        # Ensures that the last id will only be found once
-        # and not for each object that comes through the loop
-        unless defined?(@ip_last)
-          @ip_last = interface.find_last_id
-        end
-        
-        # Ensures that the last "Down" button will not be displayed
-        # since you can't go lower than the lowest position
-        unless @ip_last.eql?(object.id)
-          button_to(options[:name], options[:url], options[:html])
-        end
+
+        button_to(options[:name], options[:url], options[:html]) unless objects.last.eql?(object)
       end
       
       # Makes the buttons available to the views that belong to the

data/lib/is_positionable/interface.rb

@@ -8,9 +8,10 @@ module IsPositionable
         :model              => options[:controller] || controller_name,
         :action             => :positionable,
         :scope              => nil,
+        :scope_object       => nil,
         :redirect_to        => :back,
-        :param              => :move,
-        :set_default_scope  => true
+        :param              => :move
+      #  :set_default_scope  => true
       }.update(options))
     end
     
@@ -22,34 +23,27 @@ module IsPositionable
     # It will determine whether to use a plain find
     # or whether to use a find through an association
     def find(id)
-      if scope.nil?
+      if scope_object.nil?
         model.find(id)
       else
-        scope.send(model_association_name).find(id)
+        scope_object.send(model_association_name).find(id)
       end
     end
-    
-    # Finds the last id of a list of records
-    # It will determine whether to use a plain find
-    # or whether to use a find through an association
-    def find_last_id
-      if scope.nil?
-        model.all.last.id 
-      else
-        scope.send(model_association_name).last.id
-      end
-    end
-    
+
     # Returns the value of the :redirect_to attribute
     def redirect
       options[:redirect_to]
     end
-    
+        
     # Returns the value of the :scope attribute
     def scope
       options[:scope]
     end
     
+    def scope_object
+      options[:scope_object]
+    end
+    
     # Returns the model Class which can be invoked using class methods    
     def model
       Kernel.const_get(options[:model].singularize.camelize)
@@ -95,9 +89,9 @@ module IsPositionable
     
     # Returns a boolean
     # Determines whether the :set_default_scope attribute was set
-    def set_default_scope?
-      true if options[:set_default_scope].eql?(true)
-    end
+    #def set_default_scope?
+    #  true if options[:set_default_scope].eql?(true)
+    #end
     
     # Require additional gems
     # When the "ignore_error" argument is set to "true" (default)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: is_positionable
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors: 
 - meskyanichi