may_may 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# MayMay
+
+## Installation
+
+gem install may_may
+
+## Usage
+
+MayMay automatically restricts access to actions on all controllers and then allows you to specify
+permitted actions. Because an action is restricted by default, you will never accidentally allow all
+users access to a new action that should have been restricted. Permitted actions are all listed in
+one place (a May model) for ease of maintenance.
+
+### No need to name roles in your views
+
+Simplify your views. Show/hide view elements based on intended action instead of current user's roles:
+
+    <% may? (:edit, :people) do %>
+      <%= link_to 'only visible if user may edit people', edit_people_path %>
+    <% end %>
+
+### 
+### Create a model named "may":
+
+    # in app/models/may.rb
+
+    class May
+      May.permission_setup do
+        controller :people do
+          may :index # anyone can execute the index action
+          may :create, :only => [:administrator] # only the administrator may create a person
+          may :edit, :except => [:guest] # everyone except guests may edit a person
+          may [:new, :update] do
+            # return true to allow these actions
+            # block executed in controller's scope
+          end
+        end # :destroy was never mentioned and so is not permitted for anyone
+      end
+    end
+
+### Add a current_roles method to your ApplicationController:
+
+Here is a simple example setup:
+
+    # in app/models/role.rb
+
+    class Role
+      # roles table should have a "name" column
+    end
+
+    # in app/models/user_role.rb
+
+    class UserRole
+      has_many :roles
+    end
+
+    # in app/models/user.rb
+
+    class User
+      has_many :user_roles
+      has_many :roles, through: :user_roles
+    end
+
+    # in app/controllers/application_controller.rb
+
+    class ApplicationController < ActionController::Base
+      def current_roles
+        current_user.roles.map {|role| role.name.to_sym }
+      end
+    end
+
+The important thing is to return an array of roles that can be matched against the roles specified in
+your May model. Your array may contain whatever types you'd like -- strings, symbols, models. Symbols
+are probably most readable, however, hence the example above.
+
+You could instead define permissions within the controller itself:
+
+    class UsersController
+      may :index, only: [:some, :roles]
+      may :show, method: [:may_show?]
+    end
+
+## Licence
+
+MIT-LICENSE

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MayMay'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/may_may/version.rb

@@ -0,0 +1,3 @@
+module MayMay
+  VERSION = "0.0.1"
+end

data/lib/may_may.rb

@@ -0,0 +1,102 @@
+module MayMay
+  class ::May
+    def self.permissions_setup(&block)
+      instance_eval(&block) if block
+    end
+
+    def self.may(actions, options = {}, &permission_block)
+      actions = [actions] unless actions.respond_to? :each
+      actions.each do |action|
+        define_singleton_method(get_permission_method(action, @controller)) do |contr, &block|
+          allowed = if only_roles = options[:only]
+            has_role?(contr, only_roles)
+          elsif except_roles = options[:except]
+            !has_role?(contr, except_roles)
+          elsif method = options[:method]
+            contr.send(method)
+          elsif permission_block
+            has_block_permission?(contr, &permission_block)
+          else
+            true # may :index # action permitted without exceptions
+          end
+          block.call if allowed && block
+          allowed
+        end
+      end
+    end
+
+    def self.permission_to?(action_name, controller_name, contr, &block)
+      method = get_permission_method(action_name, controller_name)
+      respond_to?(method) && send(method, contr, &block)
+    end
+
+    def self.has_role?(contr, roles)
+      roles = [roles] unless roles.respond_to? :include?
+      contr.current_roles.each {|role| return true if roles.include?(role) }
+      false
+    end
+
+    def self.get_permission_method(action_name, controller_name)
+      "#{action_name}_#{controller_name}?"
+    end
+
+    private
+
+    def self.controller(contr)
+      old_controller = @controller
+      @controller = contr
+      yield if block_given?
+      @controller = old_controller
+    end
+
+    def self.has_block_permission?(contr, &block)
+      contr.instance_eval(&block)
+    end
+  end
+
+  module MayMayACExtensions
+    module ClassMethods
+      def may(action_name, options, &block)
+        May.controller(self.name.gsub(/Controller$/, '').tableize.to_sym) { May.may action_name, options, &block }
+      end
+    end
+
+    def self.setup(klass)
+      klass.extend(MayMayACExtensions::ClassMethods)
+      klass.before_filter :may_may_setup
+      klass.helper_method :may?
+    end
+
+    def access_denied
+      response.status = 403
+      render :text => 'Access Denied'
+    end
+
+    def current_roles
+      (respond_to?(:current_user) && current_user.respond_to?(:role_names)) ? current_user.role_names : []
+    end
+
+    def may?(action_name, controller_name, &block)
+      May.permission_to?(action_name, controller_name, self, &block)
+    end
+
+
+    def has_role?(role)
+      May.has_role?(self, role)
+    end
+
+    private
+
+    def may_may_setup
+      May.permissions_setup
+      access_denied unless May.permission_to? params[:action], params[:controller].to_s.pluralize.to_sym, self
+    end
+  end
+
+  if defined? ActionController::Base
+    ActionController::Base.class_eval do
+      include MayMayACExtensions
+      MayMayACExtensions.setup(ActionController::Base)
+    end
+  end
+end

data/lib/tasks/may_may_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :may_may do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  def current_user
+    @current_user ||= User.send((params[:user] || 'guest').to_sym)
+  end
+end

data/test/dummy/app/controllers/may_mays_controller.rb

@@ -0,0 +1,27 @@
+class MayMaysController < ApplicationController
+  may :create, method: :can_create?
+
+  def index
+    render text: 'index'
+  end
+
+  def new
+    render layout: false
+  end
+
+  def show
+    render text: 'show'
+  end
+
+  def destroy
+    render text: 'destroy'
+  end
+
+  def create
+    render text: 'create'
+  end
+
+  def can_create?
+    current_user.name == 'admin'
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/may.rb

@@ -0,0 +1,9 @@
+class May
+  controller :may_mays do
+    may :index
+    may :new, only: [:standard]
+    may :show, except: [:admin]
+    may :edit, only: [:admin]
+    may(:destroy) { has_role? :admin }
+  end
+end

data/test/dummy/app/models/role.rb

@@ -0,0 +1,22 @@
+class Role < ActiveRecord::Base
+  attr_accessible :name
+
+  belongs_to :user_role
+
+  def name
+    nm = read_attribute(:name)
+    nm ? nm.to_sym : nil
+  end
+
+  def self.admin
+    new(name: :admin)
+  end
+
+  def self.standard
+    new(name: :standard)
+  end
+
+  def self.guest
+    new(name: :guest)
+  end
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,22 @@
+class User < ActiveRecord::Base
+  attr_accessible :name, :roles
+
+  has_many :user_roles
+  has_many :roles, through: :user_roles
+
+  def role_names
+    roles.map(&:name)
+  end
+
+  def self.admin
+    new(:name => 'admin', :roles => [Role.admin, Role.standard])
+  end
+
+  def self.standard
+    new(:name => 'standard', :roles => [Role.standard])
+  end
+
+  def self.guest
+    new(:name => 'guest', :roles => [Role.guest])
+  end
+end

data/test/dummy/app/models/user_role.rb

@@ -0,0 +1,4 @@
+class UserRole < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :role
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/may_mays/new.html.erb

@@ -0,0 +1,3 @@
+<% may?(:edit, :may_mays) do -%>
+Edit link
+<% end -%>