banken-dsl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3edb938e54606119cee460e75f0e7f11aa4e4a52
+  data.tar.gz: 2ed831955290e554210e0fbf43b354fa5256c895
+SHA512:
+  metadata.gz: 733797495d20baa17cca40b315c843b71d3210cca2c4e6d4817d8255a105355134985fdee1ff6f22ded7d211de9c08ec2370e69f9b460eb9b1264a120889d849
+  data.tar.gz: 80cd6bb91b1797aa171a5e330a3d783002e02bc18e94e83b593936909ee4f1382ab4afded6ea0edbbbd38da07c39105656aa8ad1fabdf9e7fb5855dc9ab5c601

data/README.md

@@ -0,0 +1,86 @@
+# Banken::DSL
+
+This plugin gives directly define query methods to the controller for a Banken loyalty class by DSL
+
+## Installation
+
+``` ruby
+gem "banken-dsl"
+```
+
+Include Banken in your application controller:
+
+``` ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  include Banken
+  protect_from_forgery
+end
+```
+
+Optionally, you can run the generator, which will set up an application loyalty
+with some useful defaults for you:
+
+``` sh
+rails g banken:install
+```
+
+After generating your application loyalty, restart the Rails server so that Rails
+can pick up any classes in the new `app/loyalties/` directory.
+
+## Usage
+
+This plugin provides DSL to define query methods to the Controller without creating a loyalty class:
+
+``` ruby
+# app/controllers/posts_controller.rb
+class PostsController < ApplicationController
+  authorization_policy do
+    index   { true }
+    show    { true }
+    create  { user.admin? }
+    update  { user.admin? && record.unpublished? }
+    destroy { user.admin? && record.unpublished? }
+  end
+
+  before_action :set_post, only: [:show, :edit, :update, :destroy]
+
+  def index
+    @posts = Post.all
+  end
+
+  def show
+  end
+end
+```
+
+You can define the loyalty class by `authorization_policy` method as same as this code:
+
+```ruby
+# app/loyalties/posts_loyalty.rb
+class PostsLoyalty < ApplicationLoyalty
+  def index?
+    true
+  end
+
+  def show?
+    true
+  end
+
+  def create?
+    user.admin?
+  end
+
+  def update?
+    user.admin? && record.unpublished?
+  end
+
+  def destroy?
+    user.admin? && record.unpublished?
+  end
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/banken/dsl.rb

@@ -0,0 +1,31 @@
+require "banken"
+
+module Banken
+  module DSL
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def authorization_policy(&block)
+        banken_dsl_proxy.instance_eval(&block)
+      end
+
+      def define_banken_query_method_for(action_name, &block)
+        banken_dsl_proxy.define_banken_query_method_for(action_name, &block)
+      end
+
+      private
+
+        def banken_dsl_proxy
+          @_banken_dsl_proxy ||= ::Banken::DSL::Proxy.new(self)
+        end
+    end
+  end
+end
+
+require "banken/dsl/base_loyalty"
+require "banken/dsl/error"
+require "banken/dsl/factory"
+require "banken/dsl/proxy"
+require "banken/dsl/version"
+
+Banken.send(:include, ::Banken::DSL)

data/lib/banken/dsl/base_loyalty.rb

@@ -0,0 +1,40 @@
+module Banken
+  module DSL
+    class BaseLoyalty
+      attr_reader :user, :record
+
+      def initialize(user, record)
+        @user = user
+        @record = record
+      end
+
+      def index?
+        false
+      end
+
+      def show?
+        false
+      end
+
+      def create?
+        false
+      end
+
+      def new?
+        create?
+      end
+
+      def update?
+        false
+      end
+
+      def edit?
+        update?
+      end
+
+      def destroy?
+        false
+      end
+    end
+  end
+end

data/lib/banken/dsl/error.rb

@@ -0,0 +1,5 @@
+module Banken
+  module DSL
+    UndefinedAction = Class.new(NameError)
+  end
+end

data/lib/banken/dsl/factory.rb

@@ -0,0 +1,42 @@
+module Banken
+  module DSL
+    class Factory
+      SUFFIX = "Loyalty".freeze
+
+      attr_reader :controller_name, :base_controller_name
+
+      def initialize(controller)
+        @controller_name      = extract_controller_name(controller)
+        @base_controller_name = extract_controller_name(controller.superclass)
+      end
+
+      def create
+        Object.const_set(loyalty_name, loyalty_klass)
+      end
+
+      private
+
+        def extract_controller_name(controller)
+          controller.controller_path if controller.to_s.end_with?("Controller")
+        end
+
+        def loyalty_name
+          "#{controller_name.camelize}#{SUFFIX}"
+        end
+
+        def loyalty_klass
+          if base_controller_name
+            Class.new(base_loyalty)
+          else
+            Class.new(::Banken::DSL::BaseLoyalty)
+          end
+        end
+
+        def base_loyalty
+          ::Banken::LoyaltyFinder.new(base_controller_name).loyalty!
+        rescue ::Banken::NotDefinedError
+          ::Banken::DSL::BaseLoyalty
+        end
+    end
+  end
+end

data/lib/banken/dsl/proxy.rb

@@ -0,0 +1,59 @@
+module Banken
+  module DSL
+    class Proxy
+      PERMIT_ATTRIBUTES_METHOD_NAME = "permitted_attributes".freeze
+
+      attr_reader :controller
+
+      def initialize(controller)
+        @controller = controller
+      end
+
+      def define_banken_query_method_for(action_name, &block)
+        banken_loyalty.class_eval do
+          define_method("#{action_name}?", &block)
+        end
+      end
+
+      def define_banken_permit_attributes_method(&block)
+        banken_loyalty.class_eval do
+          define_method(PERMIT_ATTRIBUTES_METHOD_NAME, &block)
+        end
+      end
+
+      private
+
+        def banken_loyalty
+          ::Banken::LoyaltyFinder.new(banken_controller_name).loyalty!
+        rescue ::Banken::NotDefinedError
+          ::Banken::DSL::Factory.new(controller).create
+        end
+
+        def banken_controller_name
+          controller.controller_path
+        end
+
+        def method_missing(method_name, *arguments, &block)
+          if action_method?(method_name)
+            define_banken_query_method_for(method_name, &block)
+          elsif permit_attributes_method?(method_name)
+            define_banken_permit_attributes_method(&block)
+          else
+            raise ::Banken::DSL::UndefinedAction, "#{controller}##{method_name} is undefined"
+          end
+        end
+
+        def respond_to_missing?(method_name, include_private = false)
+          action_method?(method_name) || permit_attributes_method?(method_name) || super
+        end
+
+        def action_method?(method_name)
+          controller.action_methods.include?(method_name.to_s)
+        end
+
+        def permit_attributes_method?(method_name)
+          method_name.to_s == PERMIT_ATTRIBUTES_METHOD_NAME
+        end
+    end
+  end
+end

data/lib/banken/dsl/version.rb

@@ -0,0 +1,5 @@
+module Banken
+  module DSL
+    VERSION = "0.1.0".freeze
+  end
+end

data/spec/banken_spec.rb

@@ -0,0 +1,151 @@
+require "spec_helper"
+
+describe Banken do
+  let(:user) { double }
+  let(:post) { Post.new(user, 1) }
+  let(:post2) { Post.new(user, 2) }
+  let(:comment) { Comment.new }
+  let(:article) { Article.new }
+  let(:posts_controller) { PostsController.new(user, { :action => 'update', :controller => 'posts' }) }
+  let(:users_controller) { UsersController.new(user, { :action => 'index', :controller => 'users' }) }
+
+  describe ".loyalty!" do
+    it "returns an instantiated loyalty given a controller name" do
+      loyalty = Banken.loyalty!('posts', user, post)
+      expect(loyalty.user).to eq user
+      expect(loyalty.record).to eq post
+      expect(loyalty.class.name).to eq 'PostsLoyalty'
+    end
+
+    it "returns an instantiated loyalty given a controller name of symbol" do
+      loyalty = Banken.loyalty!(:posts, user, post)
+      expect(loyalty.user).to eq user
+      expect(loyalty.record).to eq post
+      expect(loyalty.class.name).to eq 'PostsLoyalty'
+    end
+
+    it "returns an instantiated loyalty given record is nil" do
+      loyalty = Banken.loyalty!(:posts, user)
+      expect(loyalty.user).to eq user
+      expect(loyalty.record).to eq nil
+      expect(loyalty.class.name).to eq 'PostsLoyalty'
+    end
+
+    it "throws an exception if the given loyalty can't be found" do
+      expect { Banken.loyalty!('articles', user, article) }.to raise_error(Banken::NotDefinedError)
+    end
+  end
+
+  describe ".define_banken_query_method_for" do
+    it "defines banken query method to the loyalty class with the same name as the Controller" do
+      UsersController.define_banken_query_method_for(:index) { true }
+      loyalty = Banken.loyalty!('users', user)
+      expect(loyalty.class.name).to eq 'UsersLoyalty'
+      expect(loyalty.class.superclass.name).to eq 'Banken::DSL::BaseLoyalty'
+      expect(users_controller.authorize!).to be true
+    end
+  end
+
+  describe "#verify_authorized" do
+    it "does nothing when authorized" do
+      posts_controller.authorize!(post)
+      posts_controller.verify_authorized
+    end
+
+    it "raises an exception when not authorized" do
+      expect { posts_controller.verify_authorized }.to raise_error(Banken::AuthorizationNotPerformedError)
+    end
+  end
+
+  describe "#banken_loyalty_authorized?" do
+    it "is true when authorized!" do
+      posts_controller.authorize!(post)
+      expect(posts_controller.banken_loyalty_authorized?).to be true
+    end
+
+    it "is false when not authorized!" do
+      expect(posts_controller.banken_loyalty_authorized?).to be false
+    end
+  end
+
+  describe "#skip_authorization" do
+    it "disables authorization verification" do
+      posts_controller.skip_authorization
+      expect { posts_controller.verify_authorized }.not_to raise_error
+    end
+  end
+
+  describe "#authorize!" do
+    context 'with action returning true' do
+      it "infers the loyalty name and authorizes based on it" do
+        expect(posts_controller.authorize!(post)).to be true
+      end
+    end
+
+    context 'with action returning false' do
+      before { posts_controller.params[:action] = 'destroy' }
+
+      it "throws an exception of Banken::NotAuthorizedError" do
+        expect { posts_controller.authorize!(post) }.to raise_error(Banken::NotAuthorizedError)
+      end
+    end
+
+    context 'with nothing loyalty' do
+      before { posts_controller.params[:controller] = 'articles' }
+
+      it "throws an exception of Banken::NotDefinedError" do
+        expect { posts_controller.authorize!(article) }.to raise_error(Banken::NotDefinedError)
+      end
+    end
+
+    context 'with nothing action in loyalty' do
+      before { posts_controller.params[:action] = 'update_all' }
+
+      it "throws an exception of NoMethodError" do
+        expect { posts_controller.authorize!(post) }.to raise_error(NoMethodError)
+      end
+    end
+  end
+
+  describe "#banken_user" do
+    it 'returns the same thing as current_user' do
+      expect(posts_controller.banken_user).to eq posts_controller.current_user
+    end
+  end
+
+  describe "#loyalty" do
+    it "returns an instantiated loyalty" do
+      loyalty = posts_controller.loyalty(post, 'posts')
+      expect(loyalty.user).to eq user
+      expect(loyalty.record).to eq post
+    end
+
+    it "returns an different loyalty each record" do
+      loyalty = posts_controller.loyalty(post, 'posts')
+      loyalty2 = posts_controller.loyalty(post2, 'posts')
+
+      expect(loyalty).not_to eq loyalty2
+    end
+
+
+    it "throws an exception if the given loyalty can't be found" do
+      expect { posts_controller.loyalty('articles', article) }.to raise_error(Banken::NotDefinedError)
+    end
+  end
+
+  describe "#permitted_attributes" do
+    it "checks loyalty for permitted attributes" do
+      params = ActionController::Parameters.new({ controller: 'posts', action: 'update', post: { title: 'Hello', votes: 5, admin: true } })
+
+      expect(PostsController.new(user, params).permitted_attributes(post)).to eq({ 'title' => 'Hello', 'votes' => 5 })
+      expect(PostsController.new(double, params).permitted_attributes(post)).to eq({ 'votes' => 5 })
+    end
+  end
+
+  describe "Banken::NotAuthorizedError" do
+    it "can be initialized with a string as message" do
+      error = Banken::NotAuthorizedError.new("must be logged in")
+      expect(error.message).to eq "must be logged in"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "bundler/setup"
+
+require "banken/dsl"
+
+require "rack"
+require "rack/test"
+require "active_support"
+require "active_support/core_ext"
+require "action_controller/metal/strong_parameters"
+
+require "pry"
+
+I18n.enforce_available_locales = false
+
+$:.unshift File.expand_path('../support', __FILE__)
+Dir["#{File.dirname(__FILE__)}/support/**/**/*.rb"].each { |f| require f }

data/spec/support/controllers/application_controller.rb

@@ -0,0 +1,26 @@
+class ApplicationController
+  include Banken
+
+  attr_accessor :current_user, :params
+
+  def initialize(current_user, params={})
+    @current_user = current_user
+    @params = params
+  end
+
+  def show; end
+
+  def update; end
+
+  def destroy; end
+
+  class << self
+    def controller_path
+      name.sub(/Controller$/, '').underscore
+    end
+
+    def action_methods
+      @_action_methods ||= public_instance_methods(true).map(&:to_s) - [Banken::DSL::Proxy::PERMIT_ATTRIBUTES_METHOD_NAME]
+    end
+  end
+end

data/spec/support/controllers/posts_controller.rb

@@ -0,0 +1,15 @@
+class PostsController < ApplicationController
+  authorization_policy do
+    update  { record.user == user }
+    destroy { false }
+    show    { true }
+
+    permitted_attributes do
+      if record.user == user
+        [:title, :votes]
+      else
+        [:votes]
+      end
+    end
+  end
+end

data/spec/support/controllers/users_controller.rb

@@ -0,0 +1 @@
+class UsersController < ApplicationController; end

data/spec/support/models/article.rb

@@ -0,0 +1 @@
+class Article; end

data/spec/support/models/post.rb

@@ -0,0 +1,7 @@
+class Post < Struct.new(:user, :id)
+  def self.published
+    :published
+  end
+  def to_s; "Post"; end
+  def inspect; "#<Post>"; end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: banken-dsl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshiyuki Hirano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: banken
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+description: This plugin gives directly define query methods to the controller for
+  a Banken loyalty class by DSL
+email:
+- yhirano@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/banken/dsl.rb
+- lib/banken/dsl/base_loyalty.rb
+- lib/banken/dsl/error.rb
+- lib/banken/dsl/factory.rb
+- lib/banken/dsl/proxy.rb
+- lib/banken/dsl/version.rb
+- spec/banken_spec.rb
+- spec/spec_helper.rb
+- spec/support/controllers/application_controller.rb
+- spec/support/controllers/posts_controller.rb
+- spec/support/controllers/users_controller.rb
+- spec/support/models/article.rb
+- spec/support/models/post.rb
+homepage: https://github.com/yhirano55/banken-dsl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: DSL for Banken
+test_files:
+- spec/banken_spec.rb
+- spec/spec_helper.rb
+- spec/support/controllers/application_controller.rb
+- spec/support/controllers/posts_controller.rb
+- spec/support/controllers/users_controller.rb
+- spec/support/models/article.rb
+- spec/support/models/post.rb