role_making 0.0.2.next1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f7d437e91d318c7c0cba0319e7d5423edefddf7
+  data.tar.gz: 04b37ad153193005fb9a10a8b7ed995292652f10
+SHA512:
+  metadata.gz: ab18b5e6c3bcde0775735f114d54a8e5f2b0d317842e0170cc800ddbb184b0b9548ef7e2b32fc99d044ae92611ec53d0676449cb9d3e86c403bf37c81a5f6b9b
+  data.tar.gz: 52a48cf43847b5a2f37b1a031e7e3f49ed47d671b9a71f3333e37cd2fef0d6f406a2c61d4a97b8c5b170fbc9b17ca4dccaec903ab0974f986920042b2193dad4

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.swp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 qmliu
+
+MIT License
+
+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,73 @@
+# RoleMaking 
+  Used for role-based resource management, based on the gem cancancan,
+  like the ability.rb,you need define resource in resource.rb
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'role_making'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install role_making
+
+## Usage
+
+  ```
+  rails generate role_making NAME [ROLE_CNAME] [options]
+  ```
+
+  for user ability you can add following in cancancan ability.rb:
+  ```ruby
+    user ||= User.new
+
+    if user.has_role?(:admin)
+      can :manager,:all
+    end
+
+    Role.all_without_reserved.each do |role|
+      next unless user.has_role?(role.name)
+      role.role_resources.each do |role_resource|
+        resource = Resource.find_by_name(role_resource.resource_name)
+        if resource[:behavior]
+          block = resource[:behavior]
+          can resource[:verb],resource[:object] do |object|
+            block.call(user,object)
+          end
+        else
+          can resource[:verb],resource[:object]
+        end
+      end
+
+    end
+
+ ```
+
+  Example:
+  ```
+    rails generate role_making user
+    or
+    rails generate role_making user Role
+  ```
+
+  This will create:
+
+    db/migrate/201506250001_role_making_create_roles_create.rb
+    db/migrate/201506250002_role_making_create_role_resources.rb
+    app/models/role.rb
+    app/models/role_resource.rb
+    add "role_making" to user.rb
+## Contributing
+
+1. Fork it ( https://github.com/javyliu/role_making/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/USAGE

@@ -0,0 +1,40 @@
+Description:
+  generate a role migration and set the user
+Usage:
+  rails generate role_making NAME [ROLE_CNAME] [options]
+
+  in cancancan ability.rb you can add following:
+    user ||= User.new
+
+    if user.has_role?(:admin)
+      can :manager,:all
+    end
+
+    Role.all_without_reserved.each do |role|
+      next unless user.has_role?(role.name)
+      role.role_resources.each do |role_resource|
+        resource = Resource.find_by_name(role_resource.resource_name)
+        if resource[:behavior]
+          block = resource[:behavior]
+          can resource[:verb],resource[:object] do |object|
+            block.call(user,object)
+          end
+        else
+          can resource[:verb],resource[:object]
+        end
+      end
+
+    end
+
+Example:
+  rails generate role_making user
+
+    This will create:
+      db/migrate/201506250001_role_making_create_roles_create.rb
+      db/migrate/201506250002_role_making_create_role_resources.rb
+      app/models/role.rb
+      app/models/role_resource.rb
+      add "role_making" to user.rb
+
+
+

data/lib/generators/role_making_generator.rb

@@ -0,0 +1,158 @@
+module RoleMaking
+  module Generators
+    class RoleMakingGenerator < Rails::Generators::NamedBase
+
+      source_root File.expand_path('../templates', __FILE__)
+      argument :role_cname, :type => :string, :default => "Role"
+
+      namespace :role_making
+
+      desc "Generates a model with the given NAME and a migration file."
+
+      def inject_user_class
+        model_path = File.join("app", "models", "#{name.underscore}.rb")
+
+        insert_into_file(model_path,after: "ActiveRecord::Base\n") do
+          "  role_making role_cname: '#{role_cname.classify}'\n"
+        end
+
+      end
+
+      def copy_resource_file
+        copy_file "resource.rb",File.join("app","models","resource.rb")
+      end
+
+      def create_role_model
+        Rails::Generators.invoke "active_record:model",["RoleResource","--no-migration","--no-fixture"], behavior: behavior
+        Rails::Generators.invoke "active_record:model",[role_cname,"--no-migration","--no-fixture"], behavior: behavior
+        inject_role_class if behavior == :invoke
+        inject_role_resource_class if behavior == :invoke
+        create_migration
+      end
+
+      #add ability files
+      def create_ability_model
+        Rails::Generators.invoke "cancan:ability",["-s"],behavior: behavior
+        model_path = File.join("app", "models", "ability.rb")
+        insert_into_file(model_path, after: "    #   end\n") do
+          <<-EOF
+    #{role_cname.classify}.all_without_reserved.each do |role|
+      next unless user.has_role?(role.name)
+      role.role_resources.each do |res|
+        resource = Resource.find_by_name(res.resource_name)
+        if block = resource.behavior
+          can resource.verb,resource.object do |obj|
+            block.call(user,obj)
+          end
+        elsif resource.hash
+          eval_con = resource.hash.delete(:con).try(:inject,{}) do |r,(k,v)|
+            r[k] = eval(v)
+            r
+          end
+          can resource[:verb],resource[:object],resource[:hash].merge(eval_con)
+        else
+          can resource[:verb],resource[:object]
+        end
+      end
+    end \n
+          EOF
+
+
+        end if behavior == :invoke
+
+      end
+
+
+      def show_readme
+        if behavior == :invoke
+          readme "../USAGE"
+        end
+      end
+
+      private
+      def inject_role_class
+        model_path = File.join("app", "models", "#{role_cname.underscore}.rb")
+
+        join_table = "#{name.tableize}_#{role_cname.tableize}"
+        insert_into_file(model_path,after: "ActiveRecord::Base\n") do
+          <<-EOF
+            RESERVED = [:admin,:guest]
+            has_and_belongs_to_many :#{name}, join_table: :#{join_table}
+            has_many :role_resources, dependent: :destroy
+
+            def self.all_with_reserved
+              self.all.where("name not in ?",RESERVED)
+            end
+          EOF
+        end
+
+      end
+
+
+      def inject_role_resource_class
+        model_path = File.join("app", "models", "role_resource.rb")
+
+        insert_into_file(model_path,after: "ActiveRecord::Base\n") do
+          <<-EOF
+            validates_uniqueness_of :resource_name, scope: :#{role_cname.underscore}_id
+
+            belongs_to :#{role_cname.underscore}
+          EOF
+        end
+      end
+
+
+      def create_migration
+        role_table = role_cname.tableize
+        join_table = "#{name.tableize}_#{role_table}"
+        user_reference = name.underscore
+        role_reference = role_cname.underscore
+        role_file = "db/migrate/201506250001_role_making_create_#{role_table}.rb"
+        role_resource_file = "db/migrate/201506250002_role_making_create_role_resources.rb"
+
+        create_file role_file do
+          <<-EOF
+          class RoleMakingCreate#{role_table.camelize} < ActiveRecord::Migration
+            def change
+              create_table(:#{role_table}) do |t|
+                t.string :name
+                t.string :display_name
+
+                t.timestamps
+              end
+
+              create_table(:#{join_table}, :id => false) do |t|
+                t.references :#{user_reference}
+                t.references :#{role_reference}
+              end
+
+              add_index(:#{role_table}, :name)
+              add_index(:#{join_table}, [ :#{user_reference}_id, :#{role_reference}_id ])
+            end
+          end
+          EOF
+
+        end
+        create_file role_resource_file do
+          <<-EOF
+          class RoleMakingCreateRoleResources < ActiveRecord::Migration
+            def change
+              create_table(:role_resources) do |t|
+                t.references :#{role_reference}
+                t.string :resource_name
+
+                t.timestamps
+              end
+
+              add_index(:role_resources, :#{role_reference}_id)
+            end
+          end
+          EOF
+      end
+      end
+
+
+
+    end
+  end
+end

data/lib/generators/templates/migrate.rb

@@ -0,0 +1,18 @@
+class RoleMakingCreateRoles < ActiveRecord::Migration
+  def change
+    create_table(:roles) do |t|
+      t.string :name
+      t.string :display_name
+
+      t.timestamps
+    end
+
+    create_table(:users_roles, :id => false) do |t|
+      t.integer :user_id
+      t.integer :role_id
+    end
+
+    add_index(:roles, :name)
+    add_index(:users_roles, [ :user_id, :role_id ])
+  end
+end

data/lib/generators/templates/resource.rb

@@ -0,0 +1,18 @@
+class Resource
+  include RoleMaking::Resourcing
+
+  #group :user do
+  #  resource [:read,:update,:destroy], User do |admin,user|
+  #    admin != user
+  #  end
+
+  #  resource :create,User
+
+  #end
+
+  #group :post do
+  #  resource :read,Post
+  #  resource [:update,:destroy,:create],Post
+  #end
+
+end

data/lib/role_making/railtie.rb

@@ -0,0 +1,12 @@
+require 'role_making'
+require 'rails'
+
+module RoleMaking
+  class Railtie < ::Rails::Railtie
+    initializer 'rolify.initialize' do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :extend, RoleMaking
+      end
+    end
+  end
+end

data/lib/role_making/resourcing.rb

@@ -0,0 +1,60 @@
+module RoleMaking
+  module Resourcing
+    extend ActiveSupport::Concern
+
+    included do
+      @groups = []
+      @current_group = nil
+      @resources = []
+      Res = Struct.new(:name,:group,:verb,:hash,:object,:behavior)
+    end
+
+    module ClassMethods
+      attr_reader :resources,:groups
+      def group(name,&block)
+        @groups << name
+        @groups.uniq!
+        @current_group = name
+        block.call
+      end
+
+      def resource(verb_or_verbs,object,hash=nil,&block)
+        raise "Need define group first" if @current_group.nil?
+        group = @current_group
+        behavior = block
+        Array.wrap(verb_or_verbs).each do |verb|
+          add_resource(group,verb,object,hash,behavior)
+        end
+      end
+
+      def add_resource(group,verb,object,hash,behavior)
+        name = "#{verb}_#{object.to_s.underscore}"
+        resource = Res.new(name,group,verb,hash,object,behavior)
+        @resources << resource
+      end
+
+      def each_group(&block)
+        @groups.each do |group|
+          block.call(group)
+        end
+      end
+
+      def each_resource(&block)
+        @resources.group_by(&:group).each(&block)
+      end
+
+      def each_resources_by(group,&block)
+        @resources.find_all{|r| r.group == group}.each(&block)
+      end
+
+      def find_by_name(name)
+        resource = @resources.detect { |e| e.name == name.to_s }
+        raise "not found resources by name: #{name}" unless resource
+        resource
+
+      end
+    end
+
+
+  end
+end

data/lib/role_making/role.rb

@@ -0,0 +1,46 @@
+require 'role_making/resourcing'
+module RoleMaking
+  module Role
+
+    def add_role(role_name)
+      role = self.roles.where(name: role_name).first
+      unless role
+        role = self.class.role_cname.constantize.where(name: role_name.to_s).first_or_initialize
+        self.roles << role
+      end
+      role
+    end
+    alias_method :grant, :add_role
+
+    def has_role?(role_name)
+      role_array = if new_record?
+                     self.roles.detect { |r| r.name.to_s == role_name.to_s }
+                   else
+                     self.roles.exists?( name: role_name)
+                   end
+      !!role_array
+    end
+
+    def has_all_roles?(*args)
+      args.all? do |item|
+        self.has_role?(item)
+      end
+    end
+
+    def has_any_role?(*args)
+      args.any? { |r| self.has_role?(r) }
+    end
+
+
+    def remove_role(roles_name)
+      self.roles.delete(self.class.role_cname.constantize.where(name: roles_name))
+    end
+
+    alias_method :revoke, :remove_role
+
+    def roles_name
+      self.roles.select(:name).map { |r| r.name }
+    end
+
+  end
+end

data/lib/role_making/version.rb

@@ -0,0 +1,3 @@
+module RoleMaking
+  VERSION = "0.0.2.next1"
+end

data/lib/role_making.rb

@@ -0,0 +1,32 @@
+require 'role_making/railtie' if defined?(Rails)
+require 'role_making/role'
+
+module RoleMaking
+
+  attr_accessor :role_cname, :role_join_table_name, :role_table_name
+
+  def role_making(options = {})
+    include Role
+    #extend Dynamic if RoleMaking.dynamic_shortcuts
+
+    options.reverse_merge!({:role_cname => 'Role'})
+    self.role_cname = options[:role_cname]
+    self.role_table_name = self.role_cname.tableize.gsub(/\//, "_")
+
+    default_join_table = "#{self.to_s.tableize.gsub(/\//, "_")}_#{self.role_table_name}"
+    options.reverse_merge!({:role_join_table_name => default_join_table})
+    self.role_join_table_name = options[:role_join_table_name]
+
+    rolify_options = { :class_name => options[:role_cname].camelize }
+    rolify_options.merge!({ :join_table => self.role_join_table_name })
+    rolify_options.merge!(options.reject{ |k,v| ![ :before_add, :after_add, :before_remove, :after_remove ].include? k.to_sym })
+
+    has_and_belongs_to_many :roles, rolify_options
+
+    #load_dynamic_methods if RoleMaking.dynamic_shortcuts
+  end
+
+
+
+
+end

data/role_making.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'role_making/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "role_making"
+  spec.version       = RoleMaking::VERSION
+  spec.authors       = ["javy_liu"]
+  spec.email         = ["javy_liu@163.com"]
+  spec.summary       = %q{for custom defined role to manage the resources}
+  spec.description   = %q{A gem for resource manage based on role}
+  spec.homepage      = "https://github.com/javyliu/role_making"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'cancancan', '~> 1.10','>= 1.10.1'
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: role_making
+version: !ruby/object:Gem::Version
+  version: 0.0.2.next1
+platform: ruby
+authors:
+- javy_liu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cancancan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.10.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A gem for resource manage based on role
+email:
+- javy_liu@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/USAGE
+- lib/generators/role_making_generator.rb
+- lib/generators/templates/migrate.rb
+- lib/generators/templates/resource.rb
+- lib/role_making.rb
+- lib/role_making/railtie.rb
+- lib/role_making/resourcing.rb
+- lib/role_making/role.rb
+- lib/role_making/version.rb
+- role_making.gemspec
+homepage: https://github.com/javyliu/role_making
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: for custom defined role to manage the resources
+test_files: []
+has_rdoc: