moulin_rouge 0.0.1.alpha → 0.0.1.beta

data/CHANGELOG.md

@@ -1,2 +1,6 @@
 CHANGELOG
-=========
+=========
+
+0.0.1.alpha (Mar 16, 2011)
+
+*   Alpha release, with all basic implementations, but without the generators.

data/lib/generators/moulin_rouge/install_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module MoulinRouge
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Installs the gem folder structure for the app"
+
+      def generate_folder_structure
+        directory("install")
+        invoke "moulin_rouge:permission admin"
+      end
+    end
+  end
+end

data/lib/generators/moulin_rouge/permission_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+module MoulinRouge
+  module Generators
+    class PermissionGenerator < ::Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Creates a new permission file inside the permission folder"
+
+      argument :name
+
+      def creates_a_permission_file
+        copy_file("permission.rb", "app/permissions/#{name}.rb")
+      end
+    end
+  end
+end

data/lib/generators/moulin_rouge/templates/install/config/initializers/moulin_rouge.rb

@@ -0,0 +1,15 @@
+MoulinRouge.configure do |config|
+  # Cache permissions
+  config.cache = Rails.env.production?
+  # The search path for permissions
+  config.path = 'app/permissions/**/*.rb'
+  # The method that will test the permission
+  config.test_method = :is?
+  # The class of the model
+  config.model = User
+  # How you like to call the active user model
+  config.model_instance = :current_user
+end
+
+# Creates the Ability class
+MoulinRouge.run!

data/lib/generators/moulin_rouge/templates/permission.rb

@@ -0,0 +1,19 @@
+# can :read, Post
+# can :read, Comment
+# can :manage, Comment do |comment|
+#   comment.user_id == current_user.id
+# end
+# 
+# role :admin do
+#   can :manage, :all
+# end
+# 
+# group :main do
+#   role :editor do
+#     can :manage, Post
+#   end
+# 
+#   role :author do
+#     can :manage, Post, :user_id => current_user.id
+#   end
+# end

data/lib/moulin_rouge/cancan/responder.rb

@@ -1,7 +1,66 @@
 module MoulinRouge
   module CanCan
+    # A cleaner implementation of CanCan #load_and_authorize_resource method.
+    # Everytime you use the #respond_with method, send the given resources to check
+    # the authorizations.
     class Responder # < ActionController::Responder
+      def initialize(controller, resources, options={})
+        super
+        @skip_authorization = options.delete(:skip_authorization)
+      end
 
+      def to_html
+        resources.each do |resource|
+          action = resources.last == resource ? controller.params[:action].to_sym : :show
+          controller.authorize!(action, resource_class_or_instace(resource)) unless skip?(resource)
+        end
+        super # Continue through method chain
+      end
+
+      private
+
+      # Returns the resource class or current instance.
+      #
+      # Try to return a valid class for this resource.
+      # It will try 3 strategies, in the following order:
+      #   1. If is an array and is not empty get the class name from first item
+      #   2. If is an empty array, tries to predict the class from variable name,
+      #      this strategy relies on Rails naming conventions
+      #   3. Just return the given resource, assuming that already is the class
+      def resource_class_or_instace(resource)
+        if resource.is_a? Array
+          if resource.empty?
+            variable_name(resource).classify.constantize # raises NameError when a match is not found
+          else
+            resource.first.class.name
+          end
+        else
+          resource
+        end
+      end
+
+      # Returns the variable name that contains that resource
+      def variable_name(resource)
+        name = controller.instance_variables.index { |var| controller.instance_variable_get(var) === resources.first }
+        name = controller.instance_variables[name].to_s.gsub(/@/, '') if name
+        name.to_s
+      end
+
+      # Return true or false if resource is matched to skip
+      # If skip is a symbol skip resource with same name
+      # If skip is a array see if includes the resouce
+      # Otherwise send the param through
+      def skip?(resource)
+        resource_name = variable_name(resource)
+
+        if @skip_authorization.is_a? Symbol
+          @skip_authorization == resource_name.to_sym
+        elsif @skip_authorization.is_a? Array
+          @skip_authorization.include?(resource_name, resource_name.to_sym)
+        else
+          @skip_authorization || false
+        end
+      end
     end
   end
-end
+end

data/lib/moulin_rouge/version.rb

@@ -1,3 +1,3 @@
 module MoulinRouge
-  VERSION = "0.0.1.alpha"
+  VERSION = "0.0.1.beta"
 end

data/spec/spec_helper.rb

@@ -9,8 +9,10 @@ require 'rspec'
 # in spec/support/ and its subdirectories.
 Dir[File.expand_path("spec/support/**/*.rb")].each {|f| require f}
 
-# Require all files from the project
-Dir[File.expand_path("lib/**/*.rb")].each {|f| require f}
+# Require all files from the project, except the generators
+Dir[File.expand_path("lib/**/*.rb")].each do |f| 
+  require f unless f =~ /lib\/generators/
+end
 
 def permission_file
   File.expand_path("spec/fixtures/spec_permission.rb")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: moulin_rouge
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.1.beta
   prerelease: 6
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-16 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cancan
-  requirement: &19713720 !ruby/object:Gem::Requirement
+  requirement: &20634180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19713720
+  version_requirements: *20634180
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &19713280 !ruby/object:Gem::Requirement
+  requirement: &20633640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19713280
+  version_requirements: *20633640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &19712860 !ruby/object:Gem::Requirement
+  requirement: &20633180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19712860
+  version_requirements: *20633180
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &19712420 !ruby/object:Gem::Requirement
+  requirement: &20632640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19712420
+  version_requirements: *20632640
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &19712000 !ruby/object:Gem::Requirement
+  requirement: &20632060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,9 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19712000
-description: A wrapper to CanCan authorization system, allowing you to define permissions
-  in many ruby files. Add new functionality allowing you do more with less.
+  version_requirements: *20632060
+description: A wrapper to CanCan authorization system, that lets you declare permissions
+  in many ruby files. Adds new functionalities allowing you do more with less code
+  and DRY.
 email:
 - edson.hilios@gmail.com
 executables: []
@@ -78,6 +79,10 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/tasks/moulin_rouge_tasks.rake
+- lib/generators/moulin_rouge/templates/install/config/initializers/moulin_rouge.rb
+- lib/generators/moulin_rouge/templates/permission.rb
+- lib/generators/moulin_rouge/permission_generator.rb
+- lib/generators/moulin_rouge/install_generator.rb
 - lib/moulin_rouge.rb
 - lib/moulin_rouge/model_double.rb
 - lib/moulin_rouge/permission.rb
@@ -119,7 +124,7 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Organize your CanCan permissions in many files.
+summary: Organize CanCan permissions in many files and DRY.
 test_files:
 - spec/fixtures/role.rb
 - spec/spec_helper.rb