role_me 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 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.rdoc

@@ -0,0 +1,47 @@
+= RoleMe
+
+Adds simple role handling to model.
+
+== How to use
+
+Supose you have an User model:
+
+    class User < ActiveRecord::Base
+      include RoleMe::HasRoles
+      has_roles
+    end
+
+Then, you have:
+
+    user = User.first
+    user.has_role! :admin     # adds the admin role to the model
+    user.has_role? :admin     # checks if the model has the admin role
+
+== Installation
+
+Add to your `Gemfile`:
+
+    gem 'role_me'
+
+And use the role_me:role_migration generator to create the role migration, if you are using the gem's role model.
+
+    rails generator role_me:role_migration
+
+
+== Custom Role Model
+
+If you want to use a custom model for Roles, please make sure that:
+
+* It has a `with_name(role_name)` scope. This must filter the roles by their names.
+* It responds to `find_or_create_by_name(role_name)`. Implement this if you are not using AR.
+
+=== has_roles Options
+
+* :role_class_name
+
+  "RoleMe::Role" by default. You can use you own role model, just pass it through here.
+
+* :role_join_table
+
+  This is the name of the join table between the roled and the role model. By default "role_me_roles_join".
+

data/Rakefile

@@ -0,0 +1,42 @@
+#!/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    = 'RoleMe'
+  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
+
+require 'metric_fu'
+MetricFu::Configuration.run do |config|
+    config.rcov[:test_files] = ['spec/**/*_spec.rb']
+    config.rcov[:rcov_opts] << "-Ispec" # Needed to find spec_helper
+end
+
+task :default => :test

data/app/models/role_me/role.rb

@@ -0,0 +1,7 @@
+# Role Model
+#
+class RoleMe::Role < ActiveRecord::Base
+
+  scope :with_name, lambda { |role_name| where(:name => role_name).limit(1) }
+
+end

data/app/models/role_me.rb

@@ -0,0 +1,5 @@
+module RoleMe
+  def self.table_name_prefix
+    'role_me_'
+  end
+end

data/lib/generators/role_me/role_migration/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate role_migration Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/role_me/role_migration/role_migration_generator.rb

@@ -0,0 +1,27 @@
+module RoleMe
+  class RoleMigrationGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_role_migration
+      migration_template "create_role_me_roles.rb", File.join("db", "migrate", "create_role_me_roles.rb")
+      sleep(1)
+    end
+
+    def create_role_join_table_migration
+      migration_template "create_role_me_roles_join.rb", File.join("db", "migrate", "create_role_me_roles_join.rb")
+      sleep(1)
+    end
+
+    private
+
+    def self.next_migration_number(dirname) #:nodoc:
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+  end
+end

data/lib/generators/role_me/role_migration/templates/create_role_me_roles.rb

@@ -0,0 +1,9 @@
+class CreateRoleMeRoles < ActiveRecord::Migration
+  def change
+    create_table :role_me_roles do |t|
+      t.string :name
+      t.timestamps
+    end
+    add_index :role_me_roles, [:name], :unique => true
+  end
+end

data/lib/generators/role_me/role_migration/templates/create_role_me_roles_join.rb

@@ -0,0 +1,10 @@
+class CreateRoleMeRolesJoin < ActiveRecord::Migration
+  def change
+    create_table :role_me_roles_join, :id => false do |t|
+      t.integer :roled_id
+      t.integer :role_id
+      t.timestamps
+    end
+    add_index :role_me_roles_join, [:roled_id, :role_id], :unique => true, :name => "roled_roles"
+  end
+end

data/lib/role_me/engine.rb

@@ -0,0 +1,5 @@
+module RoleMe
+  class Engine < ::Rails::Engine
+
+  end
+end

data/lib/role_me/has_roles.rb

@@ -0,0 +1,105 @@
+module RoleMe
+  module HasRoles
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Adds roles to the model. options:
+      #
+      # * :role_class_name => "RoleMe::Role"
+      #
+      #   Sets the default model that holds roles.
+      #   Default: "RoleMe::Role"
+      #
+      # * :role_join_table => "role_me_roles_join"
+      #
+      #   Table to hold the has_and_belongs_to_many keys
+      #   Default : "role_me_roles_join"
+      #
+      # Examples:
+      #
+      #   * has_role
+      #   * has_role :role_class_name => "Role"
+      #
+      #
+      # If you are using a custom model for Role, please note:
+      #
+      # * Your model must respond to a scope `with_name` that selects
+      # a role by its name.
+      #
+      # * Your model must respond to `find_or_create_by_name`. If you are note using
+      # AR, you must implement this.
+      #
+      # The join table must have these columns:
+      #   `roled_id`  -> to store your "user" id
+      #   `role_id`   -> to store your "role" id
+      #
+      #
+      def has_roles(options = {})
+        return if self.included_modules.include?(RoleMe::HasRolesMethods)
+
+        cattr_accessor :role_me_options
+
+        options.reverse_merge!({
+          :role_class_name  => "::RoleMe::Role",
+          :role_join_table  => "role_me_roles_join"
+        })
+
+        self.role_me_options = options
+
+        self.send(:include, RoleMe::HasRolesMethods)
+      end
+    end
+
+  end
+
+  # Module included when you call the has_role in a model
+  #
+  module HasRolesMethods
+    extend ActiveSupport::Concern
+
+    included do
+
+      has_and_belongs_to_many :roles,
+        :class_name   => self.role_me_options[:role_class_name],
+        :join_table   => self.role_me_options[:role_join_table],
+        :foreign_key  => "roled_id",
+        :association_foreign_key => "role_id"
+
+    end
+
+    module InstanceMethods
+
+      # Adds the role to the model
+      #
+      # Example:
+      #
+      #   user.has_role! :admin
+      #   -> will add the admin role to user
+      #
+      def has_role!(role_name)
+        return if has_role?(role_name)
+        self.roles << find_or_create_role_by_name(role_name.to_s)
+      end
+
+      # Check if the model has the role
+      #
+      # Example:
+      #
+      #   user.has_role? :admin
+      #   -> will return true if the user has the admin role
+      #
+      def has_role?(role_name)
+        not self.roles.with_name(role_name.to_s).empty?
+      end
+
+      private
+
+      # Checks if the role exists or create a new one
+      # and returns it
+      def find_or_create_role_by_name(role_name)
+        self.class.role_me_options[:role_class_name].constantize.find_or_create_by_name(role_name)
+      end
+
+    end
+  end
+end

data/lib/role_me/version.rb

@@ -0,0 +1,3 @@
+module RoleMe
+  VERSION = "1.0.0"
+end

data/lib/role_me.rb

@@ -0,0 +1,7 @@
+module RoleMe
+
+  autoload 'HasRoles', 'role_me/has_roles'
+
+end
+
+require 'role_me/engine'

data/lib/tasks/role_me_tasks.rake

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

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: role_me
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tiago Scolari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-10-12 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2156007680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *2156007680
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &2156005720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2156005720
+description: An easy way to add roles to your model.
+email:
+- tscolari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/role_me/role.rb
+- app/models/role_me.rb
+- lib/generators/role_me/role_migration/role_migration_generator.rb
+- lib/generators/role_me/role_migration/templates/create_role_me_roles.rb
+- lib/generators/role_me/role_migration/templates/create_role_me_roles_join.rb
+- lib/generators/role_me/role_migration/USAGE
+- lib/role_me/engine.rb
+- lib/role_me/has_roles.rb
+- lib/role_me/version.rb
+- lib/role_me.rb
+- lib/tasks/role_me_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: https://github.com/tscolari/role_me
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -564280631143811076
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -564280631143811076
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Simple Role Handling to Models
+test_files: []