can_self_do_it 0.0.1 → 0.0.2

data/README.rdoc

@@ -4,26 +4,83 @@
 
 == Description:
 
-Generate a simple interface to works with users CRUD rights.
+Generate a simple interface to work with user CRUD permissions.
 
 
 == Features:
 
-* Allows check permissions for CRUD actions can_create?, can_see?, can_edit? and can_delete?
-* Allows check permissions for general actions responding to can_.+? regular expresion
-* Add an interface for known users with a default implementation of the CRUD action permissions.
-* Add an interface for unknown users with a default implementation of the CRUD action permissions.
-* Allows add custom behaviors for especific objects instead of the default implementation
+* Allows to check permissions for CRUD actions: +can_create?+, +can_see?+, +can_edit?+ and +can_delete?+
+* Allows to check permissions for general actions responding to arbitrary +can_*?+ methods
+* Provides an interface for known users with a default implementation of the CRUD action permissions.
+* Provides an interface for unknown users with a default implementation of the CRUD action permissions.
+* Allows to add custom behaviors for especific target objects to replace the default implementation
 
 == Synopsis:
 
-Despite the fact that this gems hasn't any dependency with others gems, it arises from the double
-permission checking in rails.  We have to check action rights in controllers, and in the other hand
-we have to check rights to show actions in views.
+The need for this gem arises from the double
+permission checking in rails:  we have to check action rights in controllers, and also check rights to show actions
+in the views. i.e:
+
+  # View code
+  link_to('edit',   @post) if session_user == @post.owner || session_user.administrator?
+
+  # Controller code
+  def edit
+    render(:status => :unauthorized) unless session_user == @post.owner || session_user.administrator?
+    ...
+  end
+
 
 This gem allows you to add the permission logic in one place and use it in both, views and controllers.
-Also, this gem add default behaviors for common cases. And overwrite the default behavior using  custom
-implementations.
+This is done by a intuitive interface. i.e:
+
+  # View code
+  link_to('edit',   @post) if session_user.can_edit?(@post)
+
+  # Controller code
+  def edit
+    render(:status => :unauthorized) unless session_user.can_edit?(@post)
+    ...
+  end
+
+The logic is added simply defining a method concatenating the undercored class name of the target object to the base method name.
+ie. The logic of:
+
+  can_edit?(post)
+
+can be implemented for all instance of the class +Post+ in a method named:
+
+  can_edit_post?(post)
+
+To get the +post+ substring of the method name from the class named Post we use the
++underscore+ method defined in ActiveSupport::Inflector. In addition we remplace '/' by '_' and '::' by '__'.
+Examples:
+
+  # Implement can_edit? for instances of the class PostComment
+  def can_edit_post_comment?(o)
+
+  # Implement can_see? for instances of the class Shop::Item
+  def can_see_shop__item?(o)
+
+  # Implement can_delete? for instances of the class Invoice
+  def can_delete_invoice(o)
+
+if there is not method can_edit_post?(post) defined, the default version is used:
+  # Default method for can_edit?. It is called when the especific method is not defined
+  def can_edit_default?(an_object)
+
+Similar to the other methods:
+
+  def can_see_default?(an_object)
+
+  def can_create_default?(an_object)
+
+  def can_delete_default?(an_object)
+
+Also, this gem adds the above default implementations for common cases and allows overwriting that default behavior as needed.
+
+This gem has no dependencies on other gems, it can be used in the context of a Rails application or any other
+Ruby application
 
 == Basic usage in a Rails app:
 
@@ -59,29 +116,29 @@ implementations.
 
 === Application permissions management
 
-Module for custom permissions for Guest (unknown user)
+Module for custom permissions for a Guest user (unknown user)
 
   module GuestCustomPermissions
    # Ovewrite default CanSelfDoIt::Unknown implementation.
-   # Guest only can see admin comments.
+   # Guests can only see admin comments.
    # This method overrides
-   # can_see? method for objects of Comment class.
+   # can_see? method for Comment objects.
    # i.e. this method is called when can_see?(comment) is
-   # called and comment is a Comment
+   # called and comment is an instance of Comment class
    def can_see_comment?(comment); comment.user.admin?; end
   end
 
 Module for custom permissions for User (known user)
 
   module UserCustomPermissions
-    # CanSelfDoIt::Known check this method for default implementation.
+    # CanSelfDoIt::Known checks this method for default implementation.
     def admin?; false;end
 
     # Ovewrite default CanSelfDoIt::Known implementation
-    # Users can comment any post
+    # Users can comment on any post
     # This method overrides
-    # can_create? method for objects of Comment class.
-    # i.e. this method is called when can_create?(Comment, post)
+    # can_create? method for Comment objects.
+    # i.e. this method is called when can_create?(Comment, post) is called
     # The post param is the post in which the comment will be written
     def can_create_comment?(post); true; end
   end
@@ -95,7 +152,7 @@ Module for custom permissions for Admin (admin like user)
 
 === Application classes
 
-  # Represent an unidentified user of the application
+  # Represents an unidentified user of the application
   class Guest
     acts_as_can_self_do_it(:as => [CanSelfDoIt::Unknown, GuestCustomPermissions])
     ...
@@ -108,7 +165,7 @@ Module for custom permissions for Admin (admin like user)
     ...
   end
 
-  # Represent the application admin
+  # Represents the application admin
   class Admin
     acts_as_can_self_do_it(:as => [CanSelfDoIt::Known, AdminCustomPermissions])
     attr_accessor :blogs
@@ -134,7 +191,7 @@ Module for custom permissions for Admin (admin like user)
 === CanSelfDoIt working
 
 
-Working for an instance of Admin
+On an instance of Admin
 
   an_admin.can_see?(admin_blog).should_be true
   an_admin.can_see?(other_user_blog).should_be true
@@ -143,7 +200,7 @@ Working for an instance of Admin
   an_admin.can_create?(Post, admin_blog).should_be true
   an_admin.can_create?(Post, other_user_blog).should_be true
 
-Working for an instance of User
+On an instance of User
 
   an_user.can_see?(user_blog).should_be true
   an_user.can_see?(other_user_blog).should_be true
@@ -155,7 +212,7 @@ Working for an instance of User
   an_user.can_create?(Comment, user_post).should_be true
   an_user.can_create?(Comment, other_user_post).should_be true
 
-Working for an instance of Guest
+On an instance of Guest
   a_guest.can_see?(user_blog).should_be true
   a_guest.can_see?(user_post).should_be true
   a_guest.can_edit?(user_blog).should_be false
@@ -170,12 +227,12 @@ Working for an instance of Guest
 
 == Requirements:
 
-This gems hasn't dependencies
+This gems has no dependencies
 
 
 == Install:
 
-sudo gem install can_self_do_it
+gem install can_self_do_it
 
 == License:
 

data/lib/can_self_do_it/auto.rb

@@ -6,25 +6,20 @@ module Auto
   # Everything defined as /can_.+\?/ that does not exists get name from param type
   # i.e methods like can_do_something?(project) => can_do_something_project
   def method_missing(symbol, *args, &block)
-    if symbol.to_s == 'can_modify_default?'
-      raise NotImplementedError.new("You must implement can_modify_default?.")
-    elsif can_self_do_it_method?(symbol)
+    if can_self_do_it_method?(symbol)
       raise ArgumentError, "wrong number of arguments(#{args.size}1 for 1)"  unless args.size == 1
       obj = args[0]
-      new_symbol = "#{symbol.to_s[0..-2]}_#{CanSelfDoIt::Helper.class_2_method_sub_str(obj.class)}?"
-      respond_to_without_can_self_do_it_method?(new_symbol) ? send(new_symbol, obj) : can_modify_default?(obj)
+      new_symbol = "#{symbol.to_s[0..-2]}_#{CanSelfDoIt::Helper.class_2_method_sub_str(obj.class)}?".to_sym
+      self.public_methods.include?(new_symbol) ? send(new_symbol, obj) : can_modify_default?(obj)
     else
       super
     end
   end
 
-
-  def respond_to_with_can_self_do_it_method?(*args)
-    can_self_do_it_method?(*args) || respond_to_without_can_self_do_it_method?(*args)
+  def respond_to_missing?(symbol, include_all)
+    can_self_do_it_method?(symbol) || super
   end
 
-  alias_method :respond_to?, :respond_to_with_can_self_do_it_method?
-
   protected
 
   def can_modify_default?(obj);  raise NotImplementedError.new("You must implement can_modify_default?.") ; end

data/lib/can_self_do_it/base.rb

@@ -4,12 +4,12 @@ module Base
 
   def can_see?(obj)
     method = "can_see_#{CanSelfDoIt::Helper.class_2_method_sub_str(obj.class)}?"
-    respond_to_without_can_self_do_it_method?(method) ?  self.send(method,obj) : can_see_default?(obj)
+    self.public_methods.include?(method.to_sym) ?  self.send(method,obj) : can_see_default?(obj)
   end
 
   def can_edit?(obj)
     method = "can_edit_#{CanSelfDoIt::Helper.class_2_method_sub_str(obj.class)}?"
-    respond_to_without_can_self_do_it_method?(method) ?  send(method,obj) : can_edit_default?(obj)
+    self.public_methods.include?(method.to_sym) ? send(method,obj) : can_edit_default?(obj)
   end
 
   # parent: parent of the object created
@@ -18,15 +18,17 @@ module Base
   # - session_user.can_create?(Project)
   def can_create?(obj_class, parent = self)
     method = "can_create_#{CanSelfDoIt::Helper.class_2_method_sub_str(obj_class)}?"
-    respond_to_without_can_self_do_it_method?(method) ?  send(method,parent) : can_create_default?(parent)
+    self.public_methods.include?(method.to_sym) ?  send(method,parent) : can_create_default?(parent)
   end
 
   def can_delete?(obj)
     method = "can_delete_#{CanSelfDoIt::Helper.class_2_method_sub_str(obj.class)}?"
-    respond_to_without_can_self_do_it_method?(method) ?  send(method,obj) : can_delete_default?(obj)
+    self.public_methods.include?(method.to_sym) ?  send(method,obj) : can_delete_default?(obj)
   end
 
-  alias_method :respond_to_without_can_self_do_it_method?, :respond_to?
+  def respond_to_without_can_self_do_it_method?(sym)
+    self.public_methods.include?(sym.to_sym)
+  end
 
 protected
 
@@ -35,6 +37,5 @@ protected
   def can_create_default?(parent);     raise NotImplementedError.new("You must implement can_create_default?.") ; end
   def can_delete_default?(obj);        raise NotImplementedError.new("You must implement can_delete_default?.") ; end
 
-
 end
 end

data/lib/can_self_do_it/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: can_self_do_it
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-02 00:00:00.000000000 Z
+date: 2013-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &8556920 !ruby/object:Gem::Requirement
+  requirement: &17941000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8556920
+  version_requirements: *17941000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &8556500 !ruby/object:Gem::Requirement
+  requirement: &17940580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *8556500
+  version_requirements: *17940580
 description: Provide modules to work with sereveral permission policies
 email:
 - mbuceta@grantaire.com.ar