approval 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d170c89efb6ba5bbe4ce8133d3a147c2be3ed08f01565d6b4108a4f2adce5d3b
-  data.tar.gz: e9b81099a7b01e3c43ff49c68d81ac5924189234d6c24fe314726abd736538e1
+  metadata.gz: 036447a5b614f818fa6a3ace7ee80d56c736d307bf1b8020cca81c2e6458ac07
+  data.tar.gz: 95feed0024428c045f96adaa675618751481ac9111f3aeafb79e02d6d9e17856
 SHA512:
-  metadata.gz: 5444fc5b21bff736ea8a1459f24b6e79dac72f88748911fcdc94c464502c59b33691867e6bfa8d79f782ef0fcb297ce888d58295c9a37976371130cea8efec99
-  data.tar.gz: 01fb588b9092d6ed0515ef34e83e0ab545ae8b3ffb529b687909a54e7ed18613f8574d9c85913af5e249a8f2f82e47cd04b398082d83710672d96b7190e0f2c3
+  metadata.gz: afdc581773b236d893187061146bbb58e4c3e5760eda31b74a73105c52ee22b3647ad2400f5b31421cf3224b9c5920fcc0f4ae572101721f741e746fd567f19b
+  data.tar.gz: 05a14a3c41748d87ecbdc9365b3198a7f750be241385966c5a5b55cc53c7c7874fdcb4092c933195a1f43b01dff5c81c91fbdd4ceb5c5e81c4df50fd67f58f8b

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 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/app/models/approval/application_record.rb

@@ -0,0 +1,5 @@
+module Approval
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/approval/comment.rb

@@ -0,0 +1,12 @@
+module Approval
+  class Comment < ApplicationRecord
+    self.table_name = :approval_comments
+
+    def self.define_user_association
+      belongs_to :user, class_name: Approval.config.user_class_name
+    end
+
+    belongs_to :request, class_name: :"Approval::Request", inverse_of: :comments
+    validates :content, presence: true, length: { maximum: Approval.config.comment_maximum }
+  end
+end

data/app/models/approval/item.rb

@@ -0,0 +1,72 @@
+module Approval
+  class Item < ApplicationRecord
+    class UnexistResource < StandardError; end
+
+    self.table_name = :approval_items
+    EVENTS = %w[create update destroy].freeze
+
+    belongs_to :request, class_name: :"Approval::Request", inverse_of: :items
+    belongs_to :resource, polymorphic: true, optional: true
+
+    serialize :params, Hash
+
+    validates :resource_type, presence: true
+    validates :event,         presence: true, inclusion: { in: EVENTS }
+
+    with_options unless: :create_event? do
+      validates :resource_id, presence: true
+    end
+
+    with_options if: :update_event? do
+      validates :params, presence: true
+    end
+
+    validate :ensure_resource_be_valid
+
+    EVENTS.each do |event_name|
+      define_method "#{event_name}_event?" do
+        event_name.to_s == event.to_s
+      end
+    end
+
+    def apply
+      case event
+      when "create"
+        resource_model.create!(params).tap do |created_resource|
+          update!(resource_id: created_resource.id)
+        end
+      when "update"
+        raise UnexistResource unless resource
+
+        resource.update!(params)
+      when "destroy"
+        raise UnexistResource unless resource
+
+        resource.destroy
+      end
+    end
+
+    private
+
+      def resource_model
+        @resource_model ||= resource_type.to_s.safe_constantize
+      end
+
+      def ensure_resource_be_valid
+        return if resource_model.nil? || destroy_event?
+
+        record = if resource_id.present?
+                   resource_model.find(resource_id).tap {|m| m.assign_attributes(params) }
+                 else
+                   resource_model.new(params || {})
+                 end
+
+        unless record.valid?
+          errors.add(:base, :invalid)
+          record.errors.full_messages.each do |message|
+            request.errors.add(:base, message)
+          end
+        end
+      end
+  end
+end

data/app/models/approval/request.rb

@@ -0,0 +1,39 @@
+module Approval
+  class Request < ApplicationRecord
+    self.table_name = :approval_requests
+
+    def self.define_user_association
+      belongs_to :request_user, class_name: Approval.config.user_class_name
+      belongs_to :respond_user, class_name: Approval.config.user_class_name, optional: true
+    end
+
+    has_many :comments, class_name: :"Approval::Comment", inverse_of: :request, dependent: :destroy
+    has_many :items,    class_name: :"Approval::Item",    inverse_of: :request, dependent: :destroy
+
+    enum state: { pending: 0, cancelled: 1, approved: 2, rejected: 3 }
+
+    scope :recently, -> { order(id: :desc) }
+
+    validates :state,        presence: true
+    validates :respond_user, presence: true, unless: :pending?
+    validates :comments,     presence: true
+    validates :items,        presence: true
+
+    validates_associated :comments
+    validates_associated :items
+
+    validate :ensure_state_was_pending
+
+    before_create do
+      self.requested_at = Time.current
+    end
+
+    private
+
+      def ensure_state_was_pending
+        return unless persisted?
+
+        errors.add(:base, :already_performed) if state_was != "pending"
+      end
+  end
+end

data/app/models/approval/request_form/base.rb

@@ -0,0 +1,47 @@
+module Approval
+  module RequestForm
+    class Base
+      include ::ActiveModel::Model
+
+      attr_accessor :user, :reason, :records
+
+      def initialize(user:, reason:, records:)
+        @user    = user
+        @reason  = reason
+        @records = records
+      end
+
+      with_options presence: true do
+        validates :user
+        validates :reason, length: { maximum: Approval.config.comment_maximum }
+        validates :records
+      end
+
+      def save
+        return false unless valid?
+
+        prepare(&:save)
+      end
+
+      def save!
+        raise ::ActiveRecord::RecordInvalid unless valid?
+
+        prepare(&:save!)
+      end
+
+      def request
+        @request ||= user.approval_requests.new
+      end
+
+      def error_full_messages
+        [errors, request.errors].flat_map(&:full_messages)
+      end
+
+      private
+
+        def prepare
+          raise NotImplementedError, "you must implement #{self.class}##{__method__}"
+        end
+    end
+  end
+end

data/app/models/approval/request_form/create.rb

@@ -0,0 +1,21 @@
+module Approval
+  module RequestForm
+    class Create < Base
+      private
+
+        def prepare
+          ::Approval::Request.transaction do
+            request.comments.new(user_id: user.id, content: reason)
+            Array(records).each do |record|
+              request.items.new(
+                event: "create",
+                resource_type: record.class.to_s,
+                params: record.create_params_for_approval,
+              )
+            end
+            yield(request)
+          end
+        end
+    end
+  end
+end

data/app/models/approval/request_form/destroy.rb

@@ -0,0 +1,21 @@
+module Approval
+  module RequestForm
+    class Destroy < Base
+      private
+
+        def prepare
+          ::Approval::Request.transaction do
+            request.comments.new(user_id: user.id, content: reason)
+            Array(records).each do |record|
+              request.items.new(
+                event: "destroy",
+                resource_type: record.class.to_s,
+                resource_id: record.id,
+              )
+            end
+            yield(request)
+          end
+        end
+    end
+  end
+end

data/app/models/approval/request_form/update.rb

@@ -0,0 +1,22 @@
+module Approval
+  module RequestForm
+    class Update < Base
+      private
+
+        def prepare
+          ::Approval::Request.transaction do
+            request.comments.new(user_id: user.id, content: reason)
+            Array(records).each do |record|
+              request.items.new(
+                event: "update",
+                resource_type: record.class.to_s,
+                resource_id: record.id,
+                params: record.update_params_for_approval,
+              )
+            end
+            yield(request)
+          end
+        end
+    end
+  end
+end

data/app/models/approval/respond_form/approve.rb

@@ -0,0 +1,19 @@
+module Approval
+  module RespondForm
+    class Approve < Base
+      validate :ensure_user_cannot_respond_to_my_request
+
+      private
+
+        def prepare
+          ::Approval::Request.transaction do
+            request.lock!
+            request.assign_attributes(state: :approved, approved_at: Time.current, respond_user_id: user.id)
+            request.comments.new(user_id: user.id, content: reason)
+            request.items.each(&:apply)
+            yield(request)
+          end
+        end
+    end
+  end
+end

data/app/models/approval/respond_form/base.rb

@@ -0,0 +1,45 @@
+module Approval
+  module RespondForm
+    class Base
+      include ::ActiveModel::Model
+
+      attr_accessor :user, :reason, :request
+
+      def initialize(user:, reason:, request:)
+        @user    = user
+        @reason  = reason
+        @request = request
+      end
+
+      with_options presence: true do
+        validates :user
+        validates :reason, length: { maximum: Approval.config.comment_maximum }
+        validates :request
+      end
+
+      def save
+        return false unless valid?
+
+        prepare(&:save)
+      end
+
+      def save!
+        raise ::ActiveRecord::RecordInvalid unless valid?
+
+        prepare(&:save!)
+      end
+
+      private
+
+        def prepare
+          raise NotImplementedError, "you must implement #{self.class}##{__method__}"
+        end
+
+        def ensure_user_cannot_respond_to_my_request
+          return if Approval.config.permit_to_respond_to_own_request?
+
+          errors.add(:user, :cannot_respond_to_own_request) if user.try(:id) == request.request_user_id
+        end
+    end
+  end
+end

data/app/models/approval/respond_form/cancel.rb

@@ -0,0 +1,16 @@
+module Approval
+  module RespondForm
+    class Cancel < Base
+      private
+
+        def prepare
+          ::Approval::Request.transaction do
+            request.lock!
+            request.assign_attributes(state: :cancelled, cancelled_at: Time.current, respond_user_id: user.id)
+            request.comments.new(user_id: user.id, content: reason)
+            yield(request)
+          end
+        end
+    end
+  end
+end

data/app/models/approval/respond_form/reject.rb

@@ -0,0 +1,18 @@
+module Approval
+  module RespondForm
+    class Reject < Base
+      validate :ensure_user_cannot_respond_to_my_request
+
+      private
+
+        def prepare
+          ::Approval::Request.transaction do
+            request.lock!
+            request.assign_attributes(state: :rejected, rejected_at: Time.current, respond_user_id: user.id)
+            request.comments.new(user_id: user.id, content: reason)
+            yield(request)
+          end
+        end
+    end
+  end
+end

data/app/models/concerns/approval/acts_as_resource.rb

@@ -0,0 +1,26 @@
+module Approval
+  module ActsAsResource
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :approval_ignore_fields
+      self.approval_ignore_fields = %w[id created_at updated_at]
+
+      has_many :approval_items, class_name: :"Approval::Item", as: :resource
+    end
+
+    class_methods do
+      def assign_ignore_fields(ignore_fields = [])
+        self.approval_ignore_fields = approval_ignore_fields.concat(ignore_fields).map(&:to_s).uniq
+      end
+    end
+
+    def create_params_for_approval
+      attributes.except(*approval_ignore_fields).compact
+    end
+
+    def update_params_for_approval
+      changes.except(*approval_ignore_fields).each_with_object({}) {|(k, v), h| h[k] = v.last }.compact
+    end
+  end
+end

data/app/models/concerns/approval/acts_as_user.rb

@@ -0,0 +1,34 @@
+module Approval
+  module ActsAsUser
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :approval_requests, class_name: :"Approval::Request", foreign_key: :request_user_id
+      has_many :approval_comments, class_name: :"Approval::Comment", foreign_key: :user_id
+    end
+
+    def request_for_create(records, reason:)
+      Approval::RequestForm::Create.new(user: self, reason: reason, records: records)
+    end
+
+    def request_for_update(records, reason:)
+      Approval::RequestForm::Update.new(user: self, reason: reason, records: records)
+    end
+
+    def request_for_destroy(records, reason:)
+      Approval::RequestForm::Destroy.new(user: self, reason: reason, records: records)
+    end
+
+    def cancel_request(request, reason:)
+      Approval::RespondForm::Cancel.new(user: self, reason: reason, request: request)
+    end
+
+    def approve_request(request, reason:)
+      Approval::RespondForm::Approve.new(user: self, reason: reason, request: request)
+    end
+
+    def reject_request(request, reason:)
+      Approval::RespondForm::Reject.new(user: self, reason: reason, request: request)
+    end
+  end
+end

data/app/models/concerns/approval/mixins.rb

@@ -0,0 +1,12 @@
+module Approval
+  module Mixins
+    def acts_as_approval_resource(ignore_fields: [])
+      include ::Approval::ActsAsResource
+      assign_ignore_fields(ignore_fields)
+    end
+
+    def acts_as_approval_user
+      include ::Approval::ActsAsUser
+    end
+  end
+end

data/db/migrate/20180409000000_create_approval_tables.rb

@@ -0,0 +1,43 @@
+class CreateApprovalTables < ActiveRecord::Migration[5.0]
+  def change
+    create_table :approval_requests do |t|
+      t.integer  :request_user_id, null: false
+      t.integer  :respond_user_id
+      t.integer  :state,           null: false, limit: 1, default: 0
+      t.datetime :requested_at,    null: false
+      t.datetime :cancelled_at
+      t.datetime :approved_at
+      t.datetime :rejected_at
+
+      t.timestamps
+
+      t.index :request_user_id
+      t.index :respond_user_id
+      t.index :state
+    end
+
+    create_table :approval_items do |t|
+      t.integer :request_id,    null: false
+      t.integer :resource_id
+      t.string  :resource_type, null: false
+      t.string  :event,         null: false
+      t.text    :params
+
+      t.timestamps
+
+      t.index :request_id
+      t.index [:resource_id, :resource_type]
+    end
+
+    create_table :approval_comments do |t|
+      t.integer :request_id, null: false
+      t.integer :user_id,    null: false
+      t.text    :content,    null: false
+
+      t.timestamps
+
+      t.index :request_id
+      t.index :user_id
+    end
+  end
+end

data/lib/approval/version.rb

@@ -1,3 +1,3 @@
 module Approval
-  VERSION = "0.3.6".freeze
+  VERSION = "0.3.7".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: approval
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Yoshiyuki Hirano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-09 00:00:00.000000000 Z
+date: 2018-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,9 +31,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
 - README.md
+- app/models/approval/application_record.rb
+- app/models/approval/comment.rb
+- app/models/approval/item.rb
+- app/models/approval/request.rb
+- app/models/approval/request_form/base.rb
+- app/models/approval/request_form/create.rb
+- app/models/approval/request_form/destroy.rb
+- app/models/approval/request_form/update.rb
+- app/models/approval/respond_form/approve.rb
+- app/models/approval/respond_form/base.rb
+- app/models/approval/respond_form/cancel.rb
+- app/models/approval/respond_form/reject.rb
+- app/models/concerns/approval/acts_as_resource.rb
+- app/models/concerns/approval/acts_as_user.rb
+- app/models/concerns/approval/mixins.rb
 - config/locales/en.yml
 - config/locales/ja.yml
+- db/migrate/20180409000000_create_approval_tables.rb
 - lib/approval.rb
 - lib/approval/config.rb
 - lib/approval/engine.rb