active_admin_role 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19b1f254b92b8095871aeed483aa900a0d946976
+  data.tar.gz: c316f53a4ae5e9bdd97713b251c56e2c323ad3f9
+SHA512:
+  metadata.gz: 3f620d97e1248ccd49aa487376652bd8f85ad186068529a939f942ce4971f38fd47467c5080f6a83d755131eb21cc02b3d822353c3a933de9c55f9b9919c644a
+  data.tar.gz: 181eea908a807136570b767cde786d0df6805148e1861f45d8466455a528d5bc3139a59a011832861c92238aea2af11dff928c7bf90ca1571c610ceaf0b17a17

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/rails/
+/spec/reports/
+/tmp/
+/gemfiles/*.gemfile.lock
+/gemfiles/vendor/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,17 @@
+inherit_from:
+  - .ruby-style.yml
+
+AllCops:
+  Exclude:
+    - "bin/*"
+    - "vendor/**/*"
+    - "gemfiles/**/*"
+    - "spec/rails/**/*"
+    - "lib/generators/active_admin_role/templates/**/*"
+    - Gemfile
+    - Rakefile
+  DisplayCopNames: true
+  TargetRubyVersion: 2.1
+
+Metrics/LineLength:
+  Enabled: false

data/.ruby-style.yml

@@ -0,0 +1,242 @@
+AllCops:
+  Exclude:
+    - "vendor/**/*"
+  UseCache: false
+Style/CollectionMethods:
+  Description: Preferred collection methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size
+  Enabled: true
+  PreferredMethods:
+    collect: map
+    collect!: map!
+    find: detect
+    find_all: select
+    reduce: inject
+Style/DotPosition:
+  Description: Checks the position of the dot in multi-line method calls.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-multi-line-chains
+  Enabled: true
+  EnforcedStyle: trailing
+  SupportedStyles:
+  - leading
+  - trailing
+Style/FileName:
+  Description: Use snake_case for source file names.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#snake-case-files
+  Enabled: false
+  Exclude: []
+Style/GuardClause:
+  Description: Check for conditionals that can be replaced with guard clauses
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-nested-conditionals
+  Enabled: false
+  MinBodyLength: 1
+Style/IfUnlessModifier:
+  Description: Favor modifier if/unless usage when you have a single-line body.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#if-as-a-modifier
+  Enabled: false
+  MaxLineLength: 80
+Style/OptionHash:
+  Description: Don't use option hashes when you can use keyword arguments.
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    "%": "()"
+    "%i": "()"
+    "%q": "()"
+    "%Q": "()"
+    "%r": "{}"
+    "%s": "()"
+    "%w": "()"
+    "%W": "()"
+    "%x": "()"
+Style/PredicateName:
+  Description: Check the names of predicate methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#bool-methods-qmark
+  Enabled: true
+  NamePrefix:
+  - is_
+  - has_
+  - have_
+  NamePrefixBlacklist:
+  - is_
+  Exclude:
+  - spec/**/*
+Style/RaiseArgs:
+  Description: Checks the arguments passed to raise/fail.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#exception-class-messages
+  Enabled: false
+  EnforcedStyle: exploded
+  SupportedStyles:
+  - compact
+  - exploded
+Style/SignalException:
+  Description: Checks for proper usage of fail and raise.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#fail-method
+  Enabled: false
+  EnforcedStyle: semantic
+  SupportedStyles:
+  - only_raise
+  - only_fail
+  - semantic
+Style/SingleLineBlockParams:
+  Description: Enforces the names of some block params.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#reduce-blocks
+  Enabled: false
+  Methods:
+  - reduce:
+    - a
+    - e
+  - inject:
+    - a
+    - e
+Style/SingleLineMethods:
+  Description: Avoid single-line methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-single-line-methods
+  Enabled: false
+  AllowIfMethodIsEmpty: true
+Style/StringLiterals:
+  Description: Checks if uses of quotes match the configured preference.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
+  Enabled: true
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/StringLiteralsInInterpolation:
+  Description: Checks if uses of quotes inside expressions in interpolated strings
+    match the configured preference.
+  Enabled: true
+  EnforcedStyle: single_quotes
+  SupportedStyles:
+  - single_quotes
+  - double_quotes
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+Style/TrailingCommaInLiteral:
+  Description: 'Checks for trailing comma in array and hash literals.'
+  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-trailing-array-commas'
+  Enabled: false
+  EnforcedStyleForMultiline: no_comma
+  SupportedStyles:
+  - comma
+  - consistent_comma
+  - no_comma
+Metrics/AbcSize:
+  Description: A calculated magnitude based on number of assignments, branches, and
+    conditions.
+  Enabled: false
+  Max: 15
+Metrics/ClassLength:
+  Description: Avoid classes longer than 100 lines of code.
+  Enabled: false
+  CountComments: false
+  Max: 100
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 100
+  Description: Avoid modules longer than 100 lines of code.
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Description: A complexity metric that is strongly correlated to the number of test
+    cases needed to validate a method.
+  Enabled: false
+  Max: 6
+Metrics/MethodLength:
+  Description: Avoid methods longer than 10 lines of code.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#short-methods
+  Enabled: false
+  CountComments: false
+  Max: 10
+Metrics/ParameterLists:
+  Description: Avoid parameter lists longer than three or four parameters.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#too-many-params
+  Enabled: false
+  Max: 5
+  CountKeywordArgs: true
+Metrics/PerceivedComplexity:
+  Description: A complexity metric geared towards measuring complexity for a human
+    reader.
+  Enabled: false
+  Max: 7
+Lint/AssignmentInCondition:
+  Description: Don't use assignment in conditions.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#safe-assignment-in-condition
+  Enabled: false
+  AllowSafeAssignment: true
+Style/InlineComment:
+  Description: Avoid inline comments.
+  Enabled: false
+Style/AccessorMethodName:
+  Description: Check the naming of accessor methods for get_/set_.
+  Enabled: false
+Style/Alias:
+  Description: Use alias_method instead of alias.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#alias-method
+  Enabled: false
+Style/Documentation:
+  Description: Document classes and non-namespace modules.
+  Enabled: false
+Style/DoubleNegation:
+  Description: Checks for uses of double negation (!!).
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-bang-bang
+  Enabled: false
+Style/EachWithObject:
+  Description: Prefer `each_with_object` over `inject` or `reduce`.
+  Enabled: false
+Style/EmptyLiteral:
+  Description: Prefer literals to Array.new/Hash.new/String.new.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#literal-array-hash
+  Enabled: false
+Style/ModuleFunction:
+  Description: Checks for usage of `extend self` in modules.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#module-function
+  Enabled: false
+Style/OneLineConditional:
+  Description: Favor the ternary operator(?:) over if/then/else/end constructs.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#ternary-operator
+  Enabled: false
+Style/PerlBackrefs:
+  Description: Avoid Perl-style regex back references.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-perl-regexp-last-matchers
+  Enabled: false
+Style/Send:
+  Description: Prefer `Object#__send__` or `Object#public_send` to `send`, as `send`
+    may overlap with existing methods.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#prefer-public-send
+  Enabled: false
+Style/SpecialGlobalVars:
+  Description: Avoid Perl-style global variables.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#no-cryptic-perlisms
+  Enabled: false
+Style/VariableInterpolation:
+  Description: Don't interpolate global, instance and class variables directly in
+    strings.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#curlies-interpolate
+  Enabled: false
+Style/WhenThen:
+  Description: Use when x then ... for one-line cases.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#one-line-cases
+  Enabled: false
+Lint/EachWithObjectArgument:
+  Description: Check for immutable argument given to each_with_object.
+  Enabled: true
+Lint/HandleExceptions:
+  Description: Don't suppress exception.
+  StyleGuide: https://github.com/bbatsov/ruby-style-guide#dont-hide-exceptions
+  Enabled: false
+Lint/LiteralInCondition:
+  Description: Checks of literals used in conditions.
+  Enabled: false
+Lint/LiteralInInterpolation:
+  Description: Checks for literals used in interpolation.
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.12.1

data/Appraisals

@@ -0,0 +1,12 @@
+appraise 'rails42' do
+  gem 'rails',       '~> 4.2.0'
+  gem 'devise',      '~> 4.2.0'
+  gem 'activeadmin', '1.0.0.pre4'
+end
+
+appraise 'rails50' do
+  gem 'rails',       '~> 5.0.0'
+  gem 'devise',      '~> 4.2.0'
+  gem 'inherited_resources', github: 'activeadmin/inherited_resources'
+  gem 'activeadmin',         github: 'activeadmin/activeadmin'
+end

data/Gemfile

@@ -0,0 +1,24 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "rails",       "~> 4.2.0"
+gem "activeadmin", "1.0.0.pre4"
+gem "devise",      "~> 4.2.0"
+gem "pry"
+gem "appraisal"
+
+group :development do
+  gem "bundler", "~> 1.13.0"
+  gem "rake",    "~> 10.0"
+  gem "rubocop", "~> 0.40.0"
+end
+
+group :test do
+  gem "capybara"
+  gem "rspec-rails"
+  gem "database_cleaner"
+  gem "shoulda-matchers"
+  gem "sqlite3", platforms: :mri
+  gem "poltergeist"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Yoshiyuki Hirano
+
+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,79 @@
+# ActiveAdminRole
+
+Role based authorization with CanCanCan for Active Admin
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_admin_role'
+```
+
+And run `bundle`
+
+## Dependencies
+
+- rails (>= 4.2)
+- activeadmin (>= 1.0.0.pre4)
+- cancancan (>= 1.15.0)
+
+## Usage
+
+1. Run this command after `rails generate active_admin:install`:
+
+```sh
+$ bin/rails generate active_admin_role:install
+  create  config/initializers/active_admin_role.rb
+  insert  app/models/admin_user.rb
+  create  db/migrate/20161128090641_add_role_to_admin_users.rb
+  create  db/migrate/20161128090642_create_active_admin_managed_resources.rb
+  create  db/migrate/20161128090643_create_active_admin_permissions.rb
+  create  app/models/ability.rb
+    gsub  config/initializers/active_admin.rb
+  create  app/admin/permission.rb
+  insert  app/admin/admin_user.rb
+
+$ bin/rails db:migrate
+```
+
+2. You have to login as **admin** after migration.
+
+3. You have to **Reload** permissions.
+
+![](https://cloud.githubusercontent.com/assets/15371677/20662507/015c877c-b597-11e6-82dc-bf80dac8c6e9.png)
+
+4. Edit permissions however you like.
+
+![](https://cloud.githubusercontent.com/assets/15371677/20662765/2a8be9c0-b598-11e6-88c5-b9b7c018c876.png)
+
+5. Of course, you can edit AdminUser's roles.
+
+![](https://cloud.githubusercontent.com/assets/15371677/20662882/ba2f9f18-b598-11e6-8a4b-ed7c6d5b1246.png)
+
+## Configuration
+
+```ruby
+ActiveAdminRole.configure do |config|
+  # [Required:Hash]
+  # == Role | default: { guest: 0, support: 1, staff: 2, manager: 3, admin: 99 }
+  config.roles = { guest: 0, support: 1, staff: 2, manager: 3, admin: 99 }
+
+  # [Optional:Array]
+  # == Special roles which don't need to manage on database
+  config.super_user_roles = [:admin]
+  config.guest_user_roles = [:guest]
+
+  # [Optional:String]
+  # == User class name | default: 'AdminUser'
+  config.user_class_name = "AdminUser"
+
+  # [Optional:Symbol]
+  # == Default permission | default: :cannot
+  config.default_state = :cannot
+end
+```
+
+## License
+
+[MIT License](http://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rake'
+
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+FileList['tasks/**/*.rake'].each { |task| import task }

data/active_admin_role.gemspec

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), "lib", "active_admin_role", "version")
+
+Gem::Specification.new do |gem|
+  gem.name          = "active_admin_role"
+  gem.version       = ActiveAdminRole::VERSION
+  gem.authors       = ["Yoshiyuki Hirano"]
+  gem.email         = ["yhirano@me.com"]
+
+  gem.summary       = "Role based authorization with CanCanCan for Active Admin"
+  gem.description   = gem.summary
+  gem.homepage      = "https://github.com/yhirano55/active_admin_role"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = ">= 2.1.0"
+
+  gem.add_dependency "activeadmin", ">= 1.0.0.pre4"
+  gem.add_dependency "cancancan",   ">= 1.15.0"
+end

data/app/models/active_admin/managed_resource.rb

@@ -0,0 +1,64 @@
+module ActiveAdmin
+  class ManagedResource < ActiveRecord::Base
+    self.table_name = :active_admin_managed_resources
+
+    has_many :permissions, dependent: :destroy
+
+    with_options presence: true do
+      validates :class_name
+      validates :action
+    end
+
+    def const
+      @_const ||= class_name.try(:safe_constantize)
+    end
+
+    def active?
+      !const.nil?
+    end
+
+    def for_active_admin_page?
+      class_name == "ActiveAdmin::Page"
+    end
+
+    class << self
+      def reload
+        ActiveRecord::Base.transaction do
+          clear_cache
+          update_managed_resources
+          cleanup_managed_resources
+          update_permissions
+        end
+      end
+
+      private
+
+      def update_managed_resources
+        manageable_resources.each(&method(:find_or_create_by!))
+      end
+
+      def cleanup_managed_resources
+        (persisted_resources - manageable_resources).each do |condition|
+          where(condition).destroy_all
+        end
+      end
+
+      def update_permissions
+        ::ActiveAdmin::Permission.clear_cache
+        ::ActiveAdmin::Permission.update_all_from_managed_resources(all)
+      end
+
+      def persisted_resources
+        all.map(&:attributes).map { |attribute| attribute.slice(*%w(class_name action name)).symbolize_keys }
+      end
+
+      def manageable_resources
+        @_manageable_resources ||= ::ActiveAdminRole::ManageableResource.new.call
+      end
+
+      def clear_cache
+        @_manageable_resources = nil
+      end
+    end
+  end
+end

data/app/models/active_admin/permission.rb

@@ -0,0 +1,59 @@
+module ActiveAdmin
+  class Permission < ActiveRecord::Base
+    self.table_name = :active_admin_permissions
+
+    role_based_authorizable
+
+    enum state: { cannot: 0, can: 1 }
+
+    belongs_to :managed_resource
+
+    delegate :class_name, :action, :name, :const, :active?, :for_active_admin_page?, to: :managed_resource
+    delegate :clear_cache, to: :class
+
+    after_update :clear_cache
+
+    with_options presence: true do
+      validates :managed_resource_id
+      validates :role
+      validates :state
+    end
+
+    validates :managed_resource_id, uniqueness: { scope: [:role] }
+
+    def to_condition
+      [].tap do |cond|
+        cond << state
+        cond << action.to_sym
+        cond << const
+        cond << { name: name } if for_active_admin_page?
+      end
+    end
+
+    class << self
+      def update_all_from_managed_resources(managed_resources)
+        managed_resources.each do |managed_resource|
+          manageable_roles.values.each do |value_of_role|
+            find_or_create_by!(managed_resource_id: managed_resource.id, role: value_of_role) do |permission|
+              permission.state = default_state
+            end
+          end
+        end
+      end
+
+      def indexed_cache
+        @_indexed_cache ||= eager_load(:managed_resource).all.group_by(&:role)
+      end
+
+      def clear_cache
+        @_indexed_cache = nil
+      end
+
+      private
+
+      def default_state
+        @_default_state ||= ::ActiveAdminRole.config.default_state
+      end
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,40 @@
+en:
+  activerecord:
+    models:
+      active_admin/managed_resource: Managed Resource
+      active_admin/permission: Permission
+    attributes:
+      base: &base
+        id: ID
+        created_at: Created at
+        updated_at: Updated at
+      managed_resource: &managed_resource
+        class_name: Class Name
+        action: Action
+        name: Name
+      active_admin/managed_resource:
+        <<: *base
+        <<: *managed_resource
+      active_admin/permission:
+        <<: *base
+        <<: *managed_resource
+        managed_resource_id: Managed Resource
+        role: Role
+        state: State
+
+  views:
+    admin_user:
+      notice:
+        assigned: "Selected records have assigned as %{role}"
+    permission:
+      notice:
+        state_changed: "Selected records have changed to %{state}"
+        reloaded: "Reloaded"
+      action_item:
+        reload: "Reload"
+
+  active_admin:
+    batch_actions:
+      labels:
+        can: "Enable"
+        cannot: "Disable"

data/config/locales/ja.yml

@@ -0,0 +1,37 @@
+ja:
+  activerecord:
+    models:
+      active_admin/managed_resource: リソース
+      active_admin/permission: 権限
+    attributes:
+      base: &base
+        id: ID
+        created_at: 作成日時
+        updated_at: 更新日時
+      managed_resource: &managed_resource
+        class_name: クラス
+        action: 操作
+        name: ページ名称
+      active_admin/managed_resource:
+        <<: *base
+        <<: *managed_resource
+      active_admin/permission:
+        <<: *base
+        <<: *managed_resource
+        managed_resource_id: リソース
+        role: 役割
+        state: 状態
+
+  views:
+    permission:
+      notice:
+        state_changed: "選択した行を%{state}に変更しました"
+        reloaded: "再読込しました"
+      action_item:
+        reload: "再読込"
+
+  active_admin:
+    batch_actions:
+      labels:
+        can: "有効にする"
+        cannot: "無効にする"

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_DISABLE_SHARED_GEMS: "true"