can_can_dry 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ba5f93e21814be7822e22ba164b093040ff81ce
-  data.tar.gz: 40b305c60398baa0de5d39a9593bb3554f33d2aa
+  metadata.gz: 2f4fdfc92a4f98f5752d1f712e3bb081fa438d36
+  data.tar.gz: a3b0b53fd3d4d914f6861259a72ad177212c5955
 SHA512:
-  metadata.gz: 2ab8fcf943b3e978c3c22858528e5af890bcd47fde4974acacb9e9354827b9e3531e846df473eef0f3971d66bae825fc70a45039e72c3c6cb0144b9f689c386a
-  data.tar.gz: 582812fde872b0c3494db9efb1525d0c3f04ff00c4a750015f13a52ea5795f5383bcf7a611b1d016bb12739b5b199342c2117881b822a957b0e98fc9343b6ca2
+  metadata.gz: 2adfde2986dc760cc6599164bfa022319c66c600b56b4f10d44f8137a49bdffd8279dbaad40c4427edab9af0bcb4843925aba9b787831c2cf3bfdf0ea89323d0
+  data.tar.gz: 41f3f66f35be65d19be64fb606bb52d6a41dac09b2f5057dba1e2e9e4a8d55a9519c16e58f7a035b5c06bcde1b764ae63fc830d696d3fbe3c4b313f8ca3287a3

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+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
+
+task default: :test

data/lib/can_can_dry/ability_mapping/action_mapping_not_found.rb

@@ -0,0 +1,10 @@
+module CanCanDry
+  module AbilityMapping
+    class ActionMappingNotFound < Exception
+      def initialize(controller, action)
+        super('Nenhum mapeamento de controle de acesso encontrado ' \
+            "para a action \"#{controller}##{action}\"")
+      end
+    end
+  end
+end

data/lib/can_can_dry/ability_mapping/path_mapping_not_found.rb

@@ -0,0 +1,9 @@
+module CanCanDry
+  module AbilityMapping
+    class PathMappingNotFound < Exception
+      def initialize(path, method, ex)
+        super("Falha ao tentar recuperar mapeamento \"#{path}\", método=#{method}: #{ex}")
+      end
+    end
+  end
+end

data/lib/can_can_dry/ability_mapping.rb

@@ -0,0 +1,84 @@
+module CanCanDry
+  module AbilityMapping
+    RESOURCES_ACTION_MAPPING = {
+      read: %w(index show),
+      create: %w(new create),
+      update: %w(update edit),
+      destroy: %w(destroy)
+    }
+    ALL_ACTION = 'ALL'
+
+    def mapping
+      @mapping ||= {}
+    end
+
+    def map_controller(controller, *can_actions)
+      map_action(controller, ALL_ACTION, *can_actions)
+    end
+
+    # 1. Encontra o controller associado a resource.
+    # 2. Mapeia:
+    # * map_action(controller, 'index', :read, resource)
+    # * map_action(controller, 'show', :read, resource)
+    # * map_action(controller, 'new', :create, resource)
+    # * map_action(controller, 'create', :create, resource)
+    # * map_action(controller, 'update', :update, resource)
+    # * map_action(controller, 'edit', :update, resource)
+    # * map_action(controller, 'destroy', :destroy, resource)
+    def map_resources(resource, controller = nil)
+      controller ||= controller_by_resource(resource)
+      RESOURCES_ACTION_MAPPING.each do |can_action, actions|
+        actions.each do |action|
+          map_action(controller, action, can_action, resource)
+        end
+      end
+    end
+
+    def map_action(controller, action, *can_args)
+      if can_args.count == 1
+        raise "\"can_args\" deve ter 0 ou 2 ou mais elementos (can_args.count=#{can_args.count})"
+      end
+      mapping[controller] ||= {}
+      mapping[controller][action] ||= []
+      mapping[controller][action] << can_args
+    end
+
+    def can_args_by_path(root_path, path, method)
+      can_args_by_path_hash(recognize_path(root_path, path, method))
+    rescue ActionMappingNotFound => ex
+      raise PathMappingNotFound.new(path, method, ex)
+    end
+
+    def can_args_by_path_hash(path_hash)
+      can_args_args = find_can_args_list(path_hash[:controller], path_hash[:action])
+      replace_model_by_record(can_args_args, path_hash[:id])
+    end
+
+    private
+
+    def replace_model_by_record(can_args_args, id)
+      can_args_args.map do |can_args|
+        ca = can_args.dup
+        ca[1] = ca[1].find_by_id(id) if id && ca[1].respond_to?(:find_by_id)
+        ca
+      end
+    end
+
+    def controller_by_resource(resource)
+      resource = resource.name if resource.is_a?(Class)
+      ActiveSupport::Inflector.pluralize(resource)
+    end
+
+    def find_can_args_list(controller, action)
+      controller = ActiveSupport::Inflector.camelize(controller)
+      raise ActionMappingNotFound.new(controller, action) unless mapping[controller]
+      return mapping[controller][action] if mapping[controller][action]
+      return mapping[controller][ALL_ACTION] if mapping[controller][ALL_ACTION]
+      raise ActionMappingNotFound.new(controller, action)
+    end
+
+    def recognize_path(root_path, path, method)
+      ::CanCanDry::PathRecognizer.recognize(root_path, path, method: method)
+    end
+  end
+end

data/lib/can_can_dry/ability_mapping_sets/devise.rb

@@ -0,0 +1,10 @@
+module CanCanDry
+  module AbilityMappingSets
+    module Devise
+      def map_devise
+        map_resources 'Devise::Session'
+        map_resources 'Devise::Password'
+      end
+    end
+  end
+end

data/lib/can_can_dry/ability_mapping_sets/devise_invitable.rb

@@ -0,0 +1,9 @@
+module CanCanDry
+  module AbilityMappingSets
+    module DeviseInvitable
+      def map_devise_invitable
+        map_resources 'DeviseInvitable::Registration'
+      end
+    end
+  end
+end

data/lib/can_can_dry/controller_authorization.rb

@@ -0,0 +1,22 @@
+require_dependency 'can_can_dry/helpers/can_can_dry_helper'
+
+module CanCanDry
+  module ControllerAuthorization
+    include CanCanDry::Helpers::CanCanDryHelper
+
+    def authorize_by_ability_mapping
+      fail CanCan::AccessDenied, "Falhou ao tentar acessar #{path_hash}" unless
+        can_by_path_hash?(path_hash)
+    end
+
+    private
+
+    def path_hash
+      params.select { |k, _v| %w(controller action id).include?(k) }
+    end
+
+    def ability_mapping
+      @ability_mapping ||= ::AbilityMapping.new
+    end
+  end
+end

data/lib/can_can_dry/helpers/can_can_dry_helper.rb

@@ -0,0 +1,54 @@
+module CanCanDry
+  module Helpers
+    module CanCanDryHelper
+      def ability_mapping
+        @ability_mapping ||= ::AbilityMapping.new
+      end
+
+      def can_by_path?(path, method = :get)
+        can_by_can_args(ability_mapping.can_args_by_path(root_path, path, method))
+      end
+
+      def can_by_path_hash?(path_hash)
+        can_by_can_args(ability_mapping.can_args_by_path_hash(path_hash))
+      end
+
+      def link_or_text(name = nil, options = nil, html_options = nil)
+        link_or_default(name, name, options, html_options)
+      end
+
+      def link_or_nil(name = nil, options = nil, html_options = nil)
+        link_or_default(name, nil, options, html_options)
+      end
+
+      private
+
+      def link_or_default(name, default, options, html_options)
+        if can_by_link_options?(options, html_options)
+          link_to(name, options, html_options)
+        else
+          default
+        end
+      end
+
+      def can_by_link_options?(options, html_options)
+        can_by_path?(url_for(options), link_method(options, html_options))
+      end
+
+      def link_method(*hashs)
+        hashs.each do |h|
+          return h[:method] if h.is_a?(Hash) && h[:method]
+        end
+        :get
+      end
+
+      def can_by_can_args(can_args_args)
+        can_args_args.each do |c|
+          next if c.empty?
+          return false unless can?(*c)
+        end
+        true
+      end
+    end
+  end
+end

data/lib/can_can_dry/path_recognizer.rb

@@ -0,0 +1,52 @@
+module CanCanDry
+  # Copiado de https://github.com/appirits/awesome_admin_layout
+  # /lib/awesome_admin_layout/recognize_path.rb
+  module PathRecognizer
+    class << self
+      def recognize(root_path, path, options = {})
+        path = remove_root_path(root_path, path)
+        return Rails.application.routes.recognize_path(path, options)
+      rescue ActionController::RoutingError
+        Rails::Engine.subclasses.each do |engine|
+          recognized_path = engine_recognize(engine, path, options)
+          return recognized_path if recognized_path
+        end
+        raise "Path not recognized: \"#{path}\" (Options: #{options})"
+      end
+
+      private
+
+      def remove_root_path(root_path, path)
+        path = path.gsub(/\A#{Regexp.quote(root_path)}/, '')
+        path.gsub(%r{\A/*}, '/')
+      end
+
+      def engine_recognize(engine, path, options)
+        engine_path = path_for_engine(engine.instance.class, path)
+        return unless engine_path
+        begin
+          return engine.instance.routes.recognize_path(engine_path, options)
+        rescue ActionController::RoutingError => e
+          Rails.logger.debug "[#{engine}] ActionController::RoutingError: #{e.message}"
+        end
+        nil
+      end
+
+      def path_for_engine(engine_class, path)
+        engine_route = Rails.application.routes.routes.find { |r| app_class_for(r) == engine_class }
+        return unless engine_route
+        path.gsub(/^#{engine_route.path.spec}/, '')
+      end
+
+      def app_class_for(route)
+        if Rails.version =~ /\A4\.2\./
+          # for Rails 4.2
+          route.app.app
+        else
+          # for Rails 4.1, 4.0, 3.2
+          route.app
+        end
+      end
+    end
+  end
+end

data/lib/can_can_dry/railtie.rb

@@ -0,0 +1,7 @@
+module CanCanDry
+  require 'rails'
+
+  class Railtie < Rails::Railtie
+    rake_tasks { load 'tasks/can_can_dry.rake' }
+  end
+end

data/lib/can_can_dry/version.rb

@@ -0,0 +1,3 @@
+module CanCanDry
+  VERSION = '0.0.5'
+end

data/lib/can_can_dry.rb

@@ -0,0 +1,17 @@
+require 'active_support/dependencies'
+require 'cancancan'
+
+module CanCanDry
+  require 'can_can_dry/railtie'
+  require_dependency 'can_can_dry/controller_authorization'
+  require_dependency 'can_can_dry/ability_mapping_sets/devise'
+  require_dependency 'can_can_dry/ability_mapping_sets/devise_invitable'
+  require_dependency 'can_can_dry/ability_mapping'
+  require_dependency 'can_can_dry/ability_mapping/path_mapping_not_found'
+  require_dependency 'can_can_dry/ability_mapping/action_mapping_not_found'
+  require_dependency 'can_can_dry/helpers/can_can_dry_helper'
+  require_dependency 'can_can_dry/path_recognizer'
+
+  require_dependency 'action_view'
+  ActionView::Base.send :include, CanCanDry::Helpers::CanCanDryHelper
+end

data/lib/tasks/can_can_dry.rake

@@ -0,0 +1,11 @@
+namespace :can_can_dry do
+  desc 'Mostra o mapeamento de CanCanDry'
+  task ability_mapping: :environment do
+    AbilityMapping.new.mapping.each do |controller, actions|
+      puts "#{controller} (#{actions.count})"
+      actions.each do |action|
+        puts "\t#{action}"
+      end
+    end
+  end
+end

data/test/can_can_dry_test.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+class CanCanDryTest < ActiveSupport::TestCase
+  test 'truth' do
+    assert_kind_of Module, CanCanDry
+  end
+end

data/test/lib/can_can_dry/path_recognizer_test.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+module CanCanDry
+  class PathRecognizerTest < ActiveSupport::TestCase
+    test 'remove_root_path' do
+      [%w(/path/to/action /prefix/ /prefix/path/to/action),
+       %w(/path/to/action /prefix /prefix/path/to/action),
+       %w(/path / /path),
+       ['/path', '', '/path'],
+       %w(/unknown/path /abc /unknown/path)].each do |s|
+        assert_equal s[0], ::CanCanDry::PathRecognizer.send(:remove_root_path, s[1], s[2]), s
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+ENV['RAILS_ENV'] = 'test'
+require 'minitest/autorun'
+require 'can_can_dry'

metadata

@@ -1,21 +1,79 @@
 --- !ruby/object:Gem::Specification
 name: can_can_dry
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
-- Agora Vai!
+- Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-07 00:00:00.000000000 Z
-dependencies: []
+date: 2017-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: cancancan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.1.0
 description: 
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- Rakefile
+- lib/can_can_dry.rb
+- lib/can_can_dry/ability_mapping.rb
+- lib/can_can_dry/ability_mapping/action_mapping_not_found.rb
+- lib/can_can_dry/ability_mapping/path_mapping_not_found.rb
+- lib/can_can_dry/ability_mapping_sets/devise.rb
+- lib/can_can_dry/ability_mapping_sets/devise_invitable.rb
+- lib/can_can_dry/controller_authorization.rb
+- lib/can_can_dry/helpers/can_can_dry_helper.rb
+- lib/can_can_dry/path_recognizer.rb
+- lib/can_can_dry/railtie.rb
+- lib/can_can_dry/version.rb
+- lib/tasks/can_can_dry.rake
+- test/can_can_dry_test.rb
+- test/lib/can_can_dry/path_recognizer_test.rb
+- test/test_helper.rb
 homepage: 
 licenses: []
 metadata: {}
@@ -35,8 +93,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: Autorização DRY com CanCanCan.
-test_files: []
+summary: DRY authorization with CanCanCan.
+test_files:
+- test/test_helper.rb
+- test/can_can_dry_test.rb
+- test/lib/can_can_dry/path_recognizer_test.rb