miracle_roles 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Mark Dodwell
+
+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/Manifest

@@ -0,0 +1,8 @@
+LICENSE
+Manifest
+README.md
+Rakefile
+lib/miracle.rb
+lib/miracle/roles.rb
+lib/miracle_roles.rb
+tasks/deployment.rake

data/README.md

@@ -0,0 +1,60 @@
+# Miracle Roles
+
+A dead simple roles plugin for Rails. 
+
+## Install
+
+### 1 — Get the gem
+
+Add the dependency to your config/environent.rb:
+
+    Rails::Initializer.run do |config|
+      ...
+      config.gem "miracle_roles"
+      ...
+    end
+  
+Now install it
+
+    sudo rake gems:install
+
+### 2 — Add :roles column to model
+
+Generate a migration to add column to your model (Users, in this example):
+
+    script/generate migration add_roles_to_users
+  
+Then in the migration that's generated, define the following:
+
+    class AddRolesToUsers < ActiveRecord::Migration
+      def self.up
+        add_column :users, :roles, :string
+      end
+  
+      def self.down
+        remove_column :users, :roles
+      end
+    end
+  
+### 3 &mdash; Include module and define roles
+
+Include the Miracle::Roles in your model:
+
+    class User < ActiveRecord::Base
+      include Miracle::Roles
+      define_roles :admin, :supervisior, ...
+      
+      ...
+    end
+  
+## Usage
+
+Now you can manage roles in any of the following ways:
+
+    @user.add_role(:admin)
+    @user.remove_role(:admin)
+    @user.roles = [:admin, :supervisor]
+  
+Enjoy!
+
+~ Mark Dodwell (<a href="http://twitter.com/madeofcode">@madeofcode</a>)

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('miracle_roles', '0.1.0') do |p|
+  p.description    = "A dead simple roles plugin for Rails."
+  p.url            = "http://github.com/mkdynamic/miracle_roles"
+  p.author         = 'Mark Dodwell'
+  p.email          = "http://twitter.com/madeofcode"
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/miracle.rb

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

data/lib/miracle/roles.rb

@@ -0,0 +1,67 @@
+module Miracle
+  module Roles
+
+    def self.included(base)
+      base.class_eval do
+        serialize :roles
+
+        def self.define_roles(*roles)
+          @@defined_roles = roles
+          @@defined_roles.each do |role|
+            class_eval %{
+              def #{role}?
+                self.roles.include?(:#{role})
+              end
+
+              # HAXX: Not the best code ever written...
+              named_scope :#{role.to_s.pluralize}, 
+                          :conditions => ['roles LIKE ?', "%\n-\s:#{role}\n%"]
+            }
+          end
+        end
+
+        def self.defined_roles
+          @@defined_roles
+        end
+      end
+    end
+
+    # NOTE: This may break something if it's already defined in the including class
+    # ...or if it's redefined later
+    def after_initialize
+      self.roles ||= []
+    end
+
+    def add_role(role)
+      role = role.to_sym
+      validate_role! role
+      self.roles << role
+      self.roles.uniq!
+    end
+
+    def remove_role(role)
+      self.roles.reject! { |r| r == role.to_sym }
+    end
+
+    def roles=(list)
+      list = list.reject(&:blank?).map { |r| r.to_sym }.reject { |r| !valid_role?(r) }
+      write_attribute(:roles, list.uniq)
+    end
+
+    # for declarative_authorization support
+    def role_symbols
+      self.roles
+    end
+
+  private
+
+    def validate_role!(role)
+      raise "Unknown role!" unless valid_role?(role)
+    end
+
+    def valid_role?(role)
+      self.class.defined_roles.include?(role)
+    end
+
+  end  
+end

data/lib/miracle_roles.rb

@@ -0,0 +1 @@
+require 'miracle/roles'

data/miracle_roles.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{miracle_roles}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Dodwell"]
+  s.date = %q{2010-01-21}
+  s.description = %q{A dead simple roles plugin for Rails.}
+  s.email = %q{http://twitter.com/madeofcode}
+  s.extra_rdoc_files = ["LICENSE", "README.md", "lib/miracle.rb", "lib/miracle/roles.rb", "lib/miracle_roles.rb", "tasks/deployment.rake"]
+  s.files = ["LICENSE", "Manifest", "README.md", "Rakefile", "lib/miracle.rb", "lib/miracle/roles.rb", "lib/miracle_roles.rb", "tasks/deployment.rake", "miracle_roles.gemspec"]
+  s.homepage = %q{http://github.com/mkdynamic/miracle_roles}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Miracle_roles", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{miracle_roles}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A dead simple roles plugin for Rails.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/tasks/deployment.rake

@@ -0,0 +1,2 @@
+desc "Build the manifest and gemspec files."
+task :build => [:build_manifest, :build_gemspec]

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: miracle_roles
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mark Dodwell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-21 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: A dead simple roles plugin for Rails.
+email: http://twitter.com/madeofcode
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+- lib/miracle.rb
+- lib/miracle/roles.rb
+- lib/miracle_roles.rb
+- tasks/deployment.rake
+files: 
+- LICENSE
+- Manifest
+- README.md
+- Rakefile
+- lib/miracle.rb
+- lib/miracle/roles.rb
+- lib/miracle_roles.rb
+- tasks/deployment.rake
+- miracle_roles.gemspec
+has_rdoc: true
+homepage: http://github.com/mkdynamic/miracle_roles
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Miracle_roles
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: miracle_roles
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A dead simple roles plugin for Rails.
+test_files: []
+