rbacfull 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d318bdc8ec82c96b5c5361388b94954d14899f4
-  data.tar.gz: 508a022297dea1fff6f90d2068bde42508821349
+  metadata.gz: 9b98292784d6cbfedd0e8fbf9b26b8683939c122
+  data.tar.gz: ce2a4276c4c35f6179b18413e20eebda2a6d05ee
 SHA512:
-  metadata.gz: c6c61b5cb72a7cce88254b79b6fe179511d74206e9fe9770e756f58546e641273f44d92c4e3b625b1703f60b97f722dbd3e6c97c2cba1993c59f3ba005fcd729
-  data.tar.gz: cd96419281b86241354bcdff3ba3b0d1149b855e9bba611856a8d1aa8aa71b8e828c76bd82a530a71c68a50d53d41cda32ff28961f5901b9c5592a74bdc47b0f
+  metadata.gz: 651e76febe2b91aa907ab2307f9b3df5a48f4818d8468c0c0d67fb81a6002d62120f011cb9776078e6f6feafb56cacabc2cf8ff4679a2c0b21e986b6b315252b
+  data.tar.gz: fca49e4e8d16f64a3166165aababadc32ee3ca87aac54956780034315362c13a2d998ad0f5352a391d15a9e13d9378b350845b1e5190f5438f4cddb415e95c7b

data/lib/generators/rbacfull/install_generator.rb

@@ -2,11 +2,66 @@ require 'rails/generators'
 
 module Rbacfull
   class InstallGenerator < ::Rails::Generators::Base
+  	include Rails::Generators::Migration
+
+
     desc "This generator installs rbacfull files to your rails project"
+  	source_root File.expand_path('../../templates', __FILE__)
 
     def install
-    	puts "HelloWorld"
+      puts "Install gem's files"
+
+    end
+
+    def copy_migrations
+      copy_migration "create_user_roles"
+      copy_migration "create_roles"
+      copy_migration "create_actions"
+  		copy_migration "create_permissions"
+    end	
+
+    def copy_models
+      copy_model "role"
+      copy_model "action"
+      copy_model "permission"
+      copy_model "user_role"
+    end
+
+
+    def copy_helpers
+      copy_helper "user_helper"
+
     end
 
+
+
+    protected
+	  def copy_migration(filename)
+	    if self.class.migration_exists?("db/migrate", "#{filename}")
+	      say_status("skipped", "Migration #{filename}.rb already exists")
+	    else
+	      migration_template "migrations/#{filename}.rb", "db/migrate/#{filename}.rb"
+	    end
+	  end
+
+    def copy_model(filename)
+      if self.class.migration_exists?("app/models", "#{filename}")
+        say_status("skipped", "Model #{filename}.rb already exists")
+      else
+        copy_file "models/#{filename}.rb", "app/models/#{filename}.rb"
+      end
+    end
+
+    def copy_helper(filename)
+      if self.class.migration_exists?("app/helpers", "#{filename}")
+        say_status("skipped", "Helper #{filename}.rb already exists")
+      else
+        copy_file "helpers/#{filename}.rb", "app/helpers/#{filename}.rb"
+      end
+    end
+
+    def self.next_migration_number(dir)
+      Time.now.utc.strftime("%Y%m%d%H%M%S%L")
+    end
   end
 end

data/lib/generators/templates/helpers/user_helper.rb

@@ -0,0 +1,33 @@
+
+  # That's it! Now you have access to some awesome RBAC helper functions.
+  module UserHelper
+    # Determines if the user has one or more of the given roles linked to it.
+    #
+    # @param [String] args an argument list of one or more roles to check for.
+    # @return [true|false] true if the user is linked to at least one of the
+    #   given roles.
+    def has_role?(*args)
+      throw Exception.new("Must supply at least one role.") if args.empty?
+      roles.where(name: args).count > 0
+    end
+
+    # Determines if the user has all of the given roles linked to it.
+    #
+    # @param [String] args an argument list of one or more roles to check for.
+    # @return [true|false] true if the user is linked to all of the given roles.
+    def has_roles?(*args)
+      throw Exception.new("Must supply at least one role.") if args.empty?
+      roles.where(name: args).count == args.count
+    end
+
+    # Determines if the user has permission to a given action. If the action
+    # does not exist at all, it is assumed the action is publicly available.
+    #
+    # @param [String] action name of the action to check permission for.
+    # @return [true|false] true if the user has at least one role linked to it
+    #   with permission to the given action.
+    def has_permission?(action)
+      return true if Action.where(name: action).count == 0
+      actions.where(name: action).count > 0
+    end
+  end

data/lib/generators/templates/initializer.rb

@@ -0,0 +1,7 @@
+Rbacfull.configure<%= "(\"#{class_name.camelize.to_s}\")" if class_name != "Role" %> do |config|
+  # By default ORM adapter is ActiveRecord. uncomment to use mongoid
+  <%= "# " if options.orm == :active_record || !options.orm %>config.use_mongoid
+
+  # Dynamic shortcuts for User class (user.is_admin? like methods). Default is: false
+  # config.use_dynamic_shortcuts
+end

data/lib/generators/templates/migrations/create_actions.rb

@@ -0,0 +1,10 @@
+class CreateActions < ActiveRecord::Migration
+  def change
+    create_table :actions do |t|
+      t.string :name
+      t.string :description
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/templates/migrations/create_permissions.rb

@@ -0,0 +1,14 @@
+class CreatePermissions < ActiveRecord::Migration
+   def change
+    create_table :permissions do |t|
+      t.integer :role_id
+      t.integer :action_id
+
+      t.timestamps
+    end
+
+    add_index :permissions, :role_id
+    add_index :permissions, :action_id
+    add_index :permissions, [:role_id, :action_id], unique: true
+  end
+end

data/lib/generators/templates/migrations/create_roles.rb

@@ -0,0 +1,10 @@
+class CreateRoles < ActiveRecord::Migration
+  def change
+    create_table :roles do |t|
+      t.string :name
+      t.string :description
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/templates/migrations/create_user_roles.rb

@@ -0,0 +1,14 @@
+class CreateUserRoles < ActiveRecord::Migration
+  def change
+    create_table :user_roles do |t|
+      t.integer :user_id
+      t.integer :role_id
+
+      t.timestamps
+    end
+
+    add_index :user_roles, :user_id
+    add_index :user_roles, :role_id
+    add_index :user_roles, [:user_id, :role_id], unique: true
+  end
+end

data/lib/generators/templates/models/action.rb

@@ -0,0 +1,3 @@
+class Action < ActiveRecord::Base
+  has_many :permissions
+end

data/lib/generators/templates/models/permission.rb

@@ -0,0 +1,4 @@
+class Permission < ActiveRecord::Base
+  belongs_to :role
+  belongs_to :action
+end

data/lib/generators/templates/models/role.rb

@@ -0,0 +1,3 @@
+class Role < ActiveRecord::Base
+  has_many :permissions
+end

data/lib/generators/templates/models/user_role.rb

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

data/lib/generators/templates/role-active_record.rb

@@ -0,0 +1,11 @@
+class <%= role_cname.camelize %> < ActiveRecord::Base
+<% if need_table_prefix?(role_cname) %>
+  def self.table_name_prefix
+    <%= table_prefix(role_cname) %>_
+  end
+<% end %>
+  has_and_belongs_to_many :<%= user_cname.tableize %>, :join_table => :<%= "#{table_name(user_cname, true)}_#{table_name(role_cname, true)}" %>
+  belongs_to :resource, :polymorphic => true
+  
+  scopify
+end

data/lib/rbacfull.rb

@@ -1,25 +1,68 @@
 require "rbacfull/version"
 
+
 module Rbacfull
-	module ShowText
-		class Hello
-			attr_accessor :name
+  extend Configure
+  attr_accessor :role_cname, :adapter, :resource_adapter, :role_join_table_name, :role_table_name
+    @@resource_types = []
+
+    def rbacfull(options = {})
+      include Role
+      extend Dynamic if Rbacfull.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]
+
+      rbacfull_options = { :class_name => options[:role_cname].camelize }
+      rbacfull_options.merge!({ :join_table => self.role_join_table_name }) if Rbacfull.orm == "active_record"
+      rbacfull_options.merge!(options.reject{ |k,v| ![ :before_add, :after_add, :before_remove, :after_remove ].include? k.to_sym })
+
+      has_and_belongs_to_many :roles, rbacfull_options
+
+      self.adapter = Rbacfull::Adapter::Base.create("role_adapter", self.role_cname, self.name)
+      load_dynamic_methods if Rbacfull.dynamic_shortcuts
+    end
+
+    def adapter
+      return self.superclass.adapter unless self.instance_variable_defined? '@adapter'
+      @adapter
+    end
+
+    def resourcify(association_name = :roles, options = {})
+      include Resource
 
-      def initialize(name)
-        @name = name
-      end
+      options.reverse_merge!({ :role_cname => 'Role', :dependent => :destroy })
+      resourcify_options = { :class_name => options[:role_cname].camelize, :as => :resource, :dependent => options[:dependent] }
+      self.role_cname = options[:role_cname]
+      self.role_table_name = self.role_cname.tableize.gsub(/\//, "_")
 
-      def generate_hello
-        "hello, #{@name}, from rbacfull!"
-      end
+      has_many association_name, resourcify_options
 
-      def say_hello
-        puts generate_hello
-      end
+      self.resource_adapter = Rbacfull::Adapter::Base.create("resource_adapter", self.role_cname, self.name)
+      @@resource_types << self.name
+    end
 
+    def resource_adapter
+      return self.superclass.resource_adapter unless self.instance_variable_defined? '@resource_adapter'
+      @resource_adapter
+    end
 
-		end
+    def scopify
+      require "rbacfull/adapters/#{Rbacfull.orm}/scopes.rb"
+      extend Rbacfull::Adapter::Scopes
+    end
 
+    def role_class
+      return self.superclass.role_class unless self.instance_variable_defined? '@role_cname'
+      self.role_cname.constantize
+    end
 
+    def self.resource_types
+      @@resource_types
+    end
 	end
-end

data/lib/rbacfull/version.rb

@@ -1,3 +1,3 @@
 module Rbacfull
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/rbacfull.gemspec

@@ -27,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
 
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'devise'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbacfull
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Tatarsky Vladimir
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: description
 email:
 - v.tatarsky@telefonn.ru
@@ -68,6 +82,17 @@ files:
 - bin/console
 - bin/setup
 - lib/generators/rbacfull/install_generator.rb
+- lib/generators/templates/helpers/user_helper.rb
+- lib/generators/templates/initializer.rb
+- lib/generators/templates/migrations/create_actions.rb
+- lib/generators/templates/migrations/create_permissions.rb
+- lib/generators/templates/migrations/create_roles.rb
+- lib/generators/templates/migrations/create_user_roles.rb
+- lib/generators/templates/models/action.rb
+- lib/generators/templates/models/permission.rb
+- lib/generators/templates/models/role.rb
+- lib/generators/templates/models/user_role.rb
+- lib/generators/templates/role-active_record.rb
 - lib/rbacfull.rb
 - lib/rbacfull/version.rb
 - rbacfull.gemspec