approval 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1e5565e3f6c257574039cad1c483a21489d18c15
-  data.tar.gz: f51f115da397201f00071fe460e09f25d491ecbf
+SHA256:
+  metadata.gz: d170c89efb6ba5bbe4ce8133d3a147c2be3ed08f01565d6b4108a4f2adce5d3b
+  data.tar.gz: e9b81099a7b01e3c43ff49c68d81ac5924189234d6c24fe314726abd736538e1
 SHA512:
-  metadata.gz: 4b0f80d3cd453758bbc95b07f57e9b379940f61242e19dc348a5ad96c327f4599d5ad15a96b6f067dc2c9662632c3b1dd9a8eca73c7aad674abbf0bdc47cb883
-  data.tar.gz: 8613e89392f7b110b2871a1a8849ae0dbfa1f3c15121bc7f23c70ec1e0980e0447f56a024e57a5fbf782a1ac042e60ef85045cb60dd9128fa8d1f07878b64004
+  metadata.gz: 5444fc5b21bff736ea8a1459f24b6e79dac72f88748911fcdc94c464502c59b33691867e6bfa8d79f782ef0fcb297ce888d58295c9a37976371130cea8efec99
+  data.tar.gz: 01fb588b9092d6ed0515ef34e83e0ab545ae8b3ffb529b687909a54e7ed18613f8574d9c85913af5e249a8f2f82e47cd04b398082d83710672d96b7190e0f2c3

data/lib/approval/config.rb

@@ -1,10 +1,7 @@
 module Approval
   class Config
-    attr_accessor(
-      :user_class_name,
-      :comment_maximum,
-      :permit_to_respond_to_own_request,
-    )
+    attr_accessor :user_class_name, :comment_maximum,
+                  :permit_to_respond_to_own_request
 
     def initialize
       @user_class_name = "User"

data/lib/approval/engine.rb

@@ -1,11 +1,10 @@
+require "rails"
+
 module Approval
   class Engine < ::Rails::Engine
-    paths["app/models"] << "lib/approval/models"
-
-    initializer "approval" do
+    initializer "approval.mixins" do
       ActiveSupport.on_load :active_record do
-        require "approval/mixins"
-        ActiveRecord::Base.include ::Approval::Mixins
+        extend ::Approval::Mixins
       end
     end
 

data/lib/approval/version.rb

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

data/lib/approval.rb

@@ -1,6 +1,6 @@
 module Approval
   def self.config
-    @_config ||= Config.new
+    @config ||= Config.new
   end
 
   def self.configure
@@ -9,8 +9,11 @@ module Approval
 
   def self.init!
     user_model = Approval.config.user_class_name.safe_constantize
-    user_model.include ::Approval::Mixins::User if user_model
-    [Approval::Request, Approval::Comment].each(&:define_user_association)
+
+    if user_model
+      ::Approval::Request.define_user_association
+      ::Approval::Comment.define_user_association
+    end
   end
 end
 

data/lib/generators/approval/install_generator.rb

@@ -1,45 +1,13 @@
-require "rails/generators"
-require "rails/generators/active_record"
-
 module Approval
-  class InstallGenerator < ::Rails::Generators::Base
-    include ::Rails::Generators::Migration
+  class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path("templates", __dir__)
 
-    class << self
-      def next_migration_number(dirname)
-        ::ActiveRecord::Generators::Base.next_migration_number(dirname)
-      end
-    end
-
     def create_migration_file
-      add_migration_file("create_approval_requests")
-      add_migration_file("create_approval_comments")
-      add_migration_file("create_approval_items")
+      rake "approval_engine:install:migrations"
     end
 
     def create_initializer
-      copy_file("initializer.rb", "config/initializers/approval.rb")
+      copy_file "initializer.rb.tt", "config/initializers/approval.rb"
     end
-
-    private
-
-      def add_migration_file(template)
-        migration_dir = File.expand_path("db/migrate")
-
-        if self.class.migration_exists?(migration_dir, template)
-          ::Kernel.warn "Migration already exists: #{template}"
-        else
-          migration_template("#{template}.rb.tt", "db/migrate/#{template}.rb", migration_version: migration_version)
-        end
-      end
-
-      def migration_version
-        major = ActiveRecord::VERSION::MAJOR
-
-        if major >= 5
-          "[#{major}.#{ActiveRecord::VERSION::MINOR}]"
-        end
-      end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: approval
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Yoshiyuki Hirano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-17 00:00:00.000000000 Z
+date: 2018-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -37,29 +37,10 @@ files:
 - lib/approval.rb
 - lib/approval/config.rb
 - lib/approval/engine.rb
-- lib/approval/mixins.rb
-- lib/approval/mixins/resource.rb
-- lib/approval/mixins/user.rb
-- lib/approval/models/approval/comment.rb
-- lib/approval/models/approval/item.rb
-- lib/approval/models/approval/request.rb
-- lib/approval/models/approval/request_form.rb
-- lib/approval/models/approval/request_form/base.rb
-- lib/approval/models/approval/request_form/create.rb
-- lib/approval/models/approval/request_form/destroy.rb
-- lib/approval/models/approval/request_form/update.rb
-- lib/approval/models/approval/respond_form.rb
-- lib/approval/models/approval/respond_form/approve.rb
-- lib/approval/models/approval/respond_form/base.rb
-- lib/approval/models/approval/respond_form/cancel.rb
-- lib/approval/models/approval/respond_form/reject.rb
 - lib/approval/version.rb
 - lib/generators/approval/USAGE
 - lib/generators/approval/install_generator.rb
-- lib/generators/approval/templates/create_approval_comments.rb.tt
-- lib/generators/approval/templates/create_approval_items.rb.tt
-- lib/generators/approval/templates/create_approval_requests.rb.tt
-- lib/generators/approval/templates/initializer.rb
+- lib/generators/approval/templates/initializer.rb.tt
 homepage: https://github.com/yhirano55/approval
 licenses:
 - MIT
@@ -72,7 +53,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.2.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -80,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Approval flow for Rails

data/lib/approval/mixins/resource.rb

@@ -1,28 +0,0 @@
-module Approval
-  module Mixins
-    module Resource
-      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
-end

data/lib/approval/mixins/user.rb

@@ -1,36 +0,0 @@
-module Approval
-  module Mixins
-    module User
-      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
-end

data/lib/approval/mixins.rb

@@ -1,19 +0,0 @@
-module Approval
-  module Mixins
-    extend ActiveSupport::Concern
-
-    class_methods do
-      def acts_as_approval_resource(ignore_fields: [])
-        include ::Approval::Mixins::Resource
-        assign_ignore_fields(ignore_fields)
-      end
-
-      def acts_as_approval_user
-        include ::Approval::Mixins::User
-      end
-    end
-  end
-end
-
-require "approval/mixins/resource"
-require "approval/mixins/user"

data/lib/approval/models/approval/comment.rb

@@ -1,15 +0,0 @@
-module Approval
-  class Comment < ::ActiveRecord::Base
-    self.table_name_prefix = "approval_".freeze
-
-    class << self
-      def define_user_association
-        belongs_to :user, class_name: Approval.config.user_class_name
-      end
-    end
-
-    belongs_to :request, class_name: :"Approval::Request", inverse_of: :comments
-
-    validates :content, presence: true, length: { maximum: Approval.config.comment_maximum }
-  end
-end

data/lib/approval/models/approval/item.rb

@@ -1,66 +0,0 @@
-module Approval
-  class Item < ::ActiveRecord::Base
-    class UnexistResource < StandardError; end
-
-    EVENTS = %w[create update destroy].freeze
-
-    self.table_name_prefix = "approval_".freeze
-
-    belongs_to :request, class_name: :"Approval::Request", inverse_of: :items
-    belongs_to :resource, polymorphic: true, optional: true
-
-    serialize :params, Hash
-
-    with_options presence: true do
-      validates :resource_id, unless: :create_event?
-      validates :resource_type
-      validates :event, inclusion: { in: EVENTS }
-      validates :params, if: :update_event?
-    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/lib/approval/models/approval/request.rb

@@ -1,46 +0,0 @@
-module Approval
-  class Request < ::ActiveRecord::Base
-    self.table_name_prefix = "approval_".freeze
-
-    class << self
-      def define_user_association
-        with_options class_name: Approval.config.user_class_name do
-          belongs_to :request_user
-          belongs_to :respond_user, optional: true
-        end
-      end
-    end
-
-    with_options dependent: :destroy, inverse_of: :request do
-      has_many :comments, class_name: "::Approval::Comment"
-      has_many :items,    class_name: "::Approval::Item"
-    end
-
-    enum state: { pending: 0, cancelled: 1, approved: 2, rejected: 3 }
-
-    scope :recently, -> { order(id: :desc) }
-
-    with_options presence: true do
-      validates :state
-      validates :respond_user, unless: :pending?
-      validates :comments
-      validates :items
-    end
-
-    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/lib/approval/models/approval/request_form/base.rb

@@ -1,45 +0,0 @@
-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/lib/approval/models/approval/request_form/create.rb

@@ -1,21 +0,0 @@
-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/lib/approval/models/approval/request_form/destroy.rb

@@ -1,21 +0,0 @@
-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/lib/approval/models/approval/request_form/update.rb

@@ -1,22 +0,0 @@
-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/lib/approval/models/approval/request_form.rb

@@ -1,4 +0,0 @@
-module Approval
-  module RequestForm
-  end
-end

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

@@ -1,19 +0,0 @@
-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/lib/approval/models/approval/respond_form/base.rb

@@ -1,42 +0,0 @@
-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/lib/approval/models/approval/respond_form/cancel.rb

@@ -1,16 +0,0 @@
-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/lib/approval/models/approval/respond_form/reject.rb

@@ -1,18 +0,0 @@
-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/lib/approval/models/approval/respond_form.rb

@@ -1,4 +0,0 @@
-module Approval
-  module RespondForm
-  end
-end

data/lib/generators/approval/templates/create_approval_comments.rb.tt

@@ -1,14 +0,0 @@
-class CreateApprovalComments < ActiveRecord::Migration<%= migration_version %>
-  def change
-    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/generators/approval/templates/create_approval_items.rb.tt

@@ -1,17 +0,0 @@
-class CreateApprovalItems < ActiveRecord::Migration<%= migration_version %>
-  def change
-    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
-    end
-
-    add_index :approval_items, [:resource_id, :resource_type]
-  end
-end

data/lib/generators/approval/templates/create_approval_requests.rb.tt

@@ -1,19 +0,0 @@
-class CreateApprovalRequests < ActiveRecord::Migration<%= migration_version %>
-  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
-  end
-end