rollable 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rollable.gemspec
+gemspec

data/LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Timon Vonk
+
+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.textile

@@ -0,0 +1,67 @@
+h1. Rollable
+
+Rollable is a Rails gem that adds agnostic roles to your application. The core principle is that a role should not
+be coupled to any object, but is nothing more than a relationship. Rollable does not define semantics, you can use
+cancan or some similar gem to do just that.
+
+h2. Installation
+
+Add to your gemfile
+
+bq. gem 'rollable'
+
+And run
+
+bq. bundle install
+
+h2. Setup
+
+Rollable is ment to be easy and maintainable, with a minimal amount of configuration nescecary.
+
+Setup the role model and migration, where <user> is the model name you want to be able to have roles
+
+bq. rails generate rollable:setup
+rake db:migrate
+
+h2. Configuration
+
+Just two lines!
+    
+In the model you defined during setup:
+
+bq. include Rollable::Base
+rollables model names, option hash
+
+Currently, the available options are:
+
+bq. :roles => [Array of Strings] # Role names
+    :allow_nil => false # If true, you can create generic roles (like 'admin')
+
+h2. Features
+
+* Hardly any configuration
+* Validates role names, role types by inclusion and user presence on Role (all dynamic)
+* Much more!
+
+h2. Usage
+
+Rollable provides helpers based on role names to check whether a user has a role on an object:
+
+bq. user.is_owner_of?(horse) # => true
+
+You can also request all possible roles
+
+bq. User.role_names
+
+Lastly, if you use nil roles, you can also do
+
+bq. user.is_admin?
+
+h2. Limitations
+
+* Its the first release, don't whine.
+* Role names can only be single words (so no underscores), but keep it simple, right?
+
+Questions? Comments? Contribute? All welcome!
+
+- Timon Vonk

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/generators/rollable/setup/setup_generator.rb

@@ -0,0 +1,55 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Rollable
+  module Generators
+    class SetupGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      desc "Sets up rollable, creates model and migration"
+      source_root(File.expand_path('../templates', __FILE__))
+
+      def copy_role_model_template
+        template 'role.rb', 'app/models/role.rb'
+      end
+
+      def copy_role_migration_template
+        migration_template 'migration.rb', "db/migrate/create_roles.rb"
+      end
+
+      def some_notes
+        puts <<-END
+        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+        Rollable has been succesfully installed!
+
+        Note that rollable is still in its early stages. Rollable does not
+        and will not ever define authorization semantics.
+        Its purely intended for agnostic roles between objects only.
+
+        If you like it, leave a note or feel free to contribute!
+
+        To use rollable, make sure you add:
+
+          include Rollable::Base
+          rollables <model names>, <options>
+
+        in #{class_name}!
+
+        Have fun,
+        Timon Vonk
+        END
+      end
+
+      private
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.new.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+    end
+  end
+end
+
+

data/lib/generators/rollable/setup/templates/migration.rb

@@ -0,0 +1,15 @@
+class CreateRoles < ActiveRecord::Migration
+  def self.up
+    create_table :roles do |t|
+      t.string :name
+      t.references :<%= plural_name.singularize %>
+      t.references :rollable, :polymorphic => true
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :roles
+  end
+end
+

data/lib/generators/rollable/setup/templates/role.rb

@@ -0,0 +1,4 @@
+class Role < ActiveRecord::Base
+  belongs_to :<%= plural_name.singularize %>
+  belongs_to :rollable, :polymorphic => true
+end

data/lib/rollable.rb

@@ -0,0 +1,3 @@
+require 'rollable/base.rb'
+require 'rollable/version.rb'
+require 'rollable'

data/lib/rollable/base.rb

@@ -0,0 +1,92 @@
+module Rollable
+  module Base
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send(:has_many, :roles)
+    end
+
+    module ClassMethods
+      def rollables(*models, opts)
+        # So we can access it in respond_to?
+        @rollables = models.collect { |m| m.to_s.camelize }#Accepting symbols looks nicer than constants, so we need to convert them
+        @role_names = opts[:roles] if opts.has_key?(:roles)
+
+        if opts.has_key?(:allow_nil) && opts[:allow_nil]
+          @rollables << nil
+        end
+
+        self.class_eval do
+          # Hackety hack.
+          class << self; attr_reader :rollables, :role_names; end;
+        end
+
+        set_relations_on_rollables
+        set_role_validations
+      end
+
+      private
+      def set_role_validations
+        # Yugh, scope and self, ugly but it works.
+        rollables = @rollables
+        roles = @role_names
+        other = self
+        Role.class_eval do
+          validates_presence_of other.to_s.downcase + "_id"
+          validates_inclusion_of :rollable_type, :in => rollables # Programmers are stupid, so lets help them out.
+          if roles.any?
+            validates_inclusion_of :name, :in => roles
+          end
+        end
+      end
+
+      def set_relations_on_rollables
+        @rollables.select { |r| r.is_a?(String) }.each do |model|
+          model = model.constantize
+          if model.ancestors.include?(ActiveRecord::Base)  #Check if it is an actual rails model, just to be sure
+            model.class_eval do # Enter the given models class
+              has_many :roles, :as => 'rollable'  # Define the relationship <img src="http://www.timonv.nl/wp-includes/images/smilies/icon_smile.gif" alt=":-)" class="wp-smiley">
+            end
+          else
+            raise "#{model} is not an ActiveRecord object!"  #Again, just to be sure and nice.
+          end
+        end
+      end
+    end
+
+    def method_missing(method, *args)
+      if method =~ /^is_([a-z]+)(?:_(?:on|of))?\?$/ #Common spell to match against regex
+        role = $1
+        that_thing = args.first.presence
+        object = that_thing.class.to_s if that_thing
+        self.class_eval do #Open my class definition
+          if that_thing
+            define_method(method) do |thing| # Define the method. Helps a lot in performance
+              self.roles.where("rollable_type = ? AND name = ?", object, role).inject(false) do |v,o| # You can't do an inner join on polymorphic relationships, unfortunately.
+                v ||= (o.rollable == thing)
+              end
+            end
+          else
+            define_method(method) do
+              self.roles.where("name = ?", role).count > 0
+            end
+          end
+        end
+        if that_thing
+          self.public_send(method, that_thing) # And of course, call the method.
+        else
+          self.public_send(method)
+        end
+      else
+        super
+      end
+    end
+
+    def respond_to?(method, include_private=false)
+      if method =~ /^is_([a-z]+)(?:_(?:on|of))?\?$/
+        self.class.role_names.include?($1)
+      else
+        super
+      end
+    end
+  end
+end

data/lib/rollable/railtie.rb

@@ -0,0 +1,7 @@
+require 'rollable'
+require 'rails'
+
+module Rollable
+  class Railtie < Rails::Railtie
+  end
+end

data/lib/rollable/version.rb

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

data/rollable.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rollable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rollable"
+  s.version     = Rollable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Timon Vonk"]
+  s.email       = ["mail@timonv.nl"]
+  s.homepage    = "http://www.timonv.nl"
+  s.summary     = %q{Agnostic roles for rails}
+  s.description = %q{This gem adds agnostic roles for authorization to Rails.}
+
+  s.rubyforge_project = "rollable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency "rails", ">= 3.0.0"
+  s.add_dependency "rspec"
+end

data/spec/rollable_test/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/

data/spec/rollable_test/.rspec

@@ -0,0 +1 @@
+--colour

data/spec/rollable_test/Gemfile

@@ -0,0 +1,32 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.7'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+gem 'rollable', :path => '../../'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19', :require => 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+ group :development, :test do
+   gem 'rspec-rails'
+ end

data/spec/rollable_test/README

@@ -0,0 +1,256 @@
+== 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.find(: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.com/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
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |   |-- images
+  |   |-- javascripts
+  |   `-- stylesheets
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+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. Contains subdirectories for
+  images, stylesheets, and javascripts. 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.