approval 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '09dc3ed589e3cbfc30969832927f5f3e08560e2f'
-  data.tar.gz: 5941a088abc4e8603a56112e4105a2e4a11f0d93
+  metadata.gz: ec9655c12fc1e790936193dfe16b35b3e2352dd7
+  data.tar.gz: 4ab7e5d9dd38039a91391cfdc6c0f1665938c44f
 SHA512:
-  metadata.gz: 78f368c57bf25e07f8f4151a056802c530039cade42d93055606bbf5691230e8425bd53f856fa5ded3b204558a5a2e921192e573c1e7020771894180434ca022
-  data.tar.gz: 3b2f2bf914d919d7c1c2e0509bddddeb927f7449ba7a5e9c30c7ef8b68764df255aa4975a4b9986119fae93aa54f41ab5c760b7c5f1a9e02625a0bf5f497677d
+  metadata.gz: ea6dea2cfe991bf86765c405926af2ae6d13d5422fb2f115c11907a29166edd729cb061d58a2bf40cf73c712927526032fa9369a2afaf8bc9a93b0a4a1a90328
+  data.tar.gz: c6b4fcdf006136b9288cceb8c2b67291873b2e9f41e378cc60ed46c33e0752fa5e5107d27801e706fff9f7d67ee0718feb312d942f45deb37946d62cc0a136bd

data/README.md

@@ -1,38 +1,60 @@
 # Approval
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/approval`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+:ok_woman::no_good:Approval workflow for Rails
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
 gem 'approval'
 ```
 
-And then execute:
+Optionally, you can run the generator, which will set up approval models with some useful defaults for you:
+
+```bash
+$ bin/rails g approval:install
+```
 
-    $ bundle
+## Usage
 
-Or install it yourself as:
+### Prepare
 
-    $ gem install approval
+Call `acts_as_approval_user` in your resource of user model (`User`, `AdminUser`, `Member` etc):
 
-## Usage
+```ruby
+class User
+  acts_as_approval_user
+end
+```
 
-TODO: Write usage instructions here
+Call `acts_as_approval_resource` in your resource:
 
-## Development
+```ruby
+class Book < ApplicationRecord
+  acts_as_approval_resource
+end
+```
+
+### Request
+
+```ruby
+staff   = User.find_or_create_by(email: "staff@example.com")
+book    = 10.times.map { |n| Book.new(name: "my_book_#{n}") }
+request = staff.request_for_create(records, reason: "something")
+request.save!
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+You send request, but resources aren't created.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Respond
 
-## Contributing
+```ruby
+admin   = User.find_or_create_by(email: "admin@example.com")
+request = Approval::Request.first
+respond = admin.approve_request(request, reason: "something")
+respond.save!
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/yhirano55/approval.
+Then resources are created, if respond user have approved the request.
 
 ## License
 

data/Rakefile

@@ -1,6 +1,12 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+desc "Creates a test rails app for the specs to run against"
+task :setup do
+  require "rails/version"
+  system("mkdir spec/rails") unless File.exist?("spec/rails")
+  system "bundle exec rails new spec/rails/rails-#{Rails::VERSION::STRING} -m spec/support/rails_template.rb -T -B --skip-spring --skip-listen --skip-sprockets"
+end
 
-task :default => :spec
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/lib/approval/config.rb

@@ -0,0 +1,19 @@
+module Approval
+  class Config
+    attr_accessor(
+      :comment_maximum,
+      :user_class_name,
+      :permit_to_respond_to_own_request,
+    )
+
+    def initialize
+      @comment_maximum = 2000
+      @user_class_name = "User"
+      @permit_to_respond_to_own_request = false
+    end
+
+    def permit_to_respond_to_own_request?
+      !!permit_to_respond_to_own_request
+    end
+  end
+end

data/lib/approval/engine.rb

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

data/lib/approval/mixins/resource.rb

@@ -0,0 +1,24 @@
+module Approval
+  module Mixins
+    module Resource
+      extend ActiveSupport::Concern
+
+      DEFAULT_IGNORE_FIELDS = %w[id created_at updated_at].freeze
+
+      included do
+        class_attribute :approval_ignore_fields
+        has_many :approval_items, class_name: :"Approval::Item", as: :resource
+      end
+
+      class_methods do
+        def append_ignore_fields(ignore_fields = [])
+          self.approval_ignore_fields = DEFAULT_IGNORE_FIELDS.dup.concat(ignore_fields).map(&:to_s).uniq
+        end
+      end
+
+      def params_for_approval
+        attributes.except(*approval_ignore_fields).compact
+      end
+    end
+  end
+end

data/lib/approval/mixins/user.rb

@@ -0,0 +1,36 @@
+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

@@ -0,0 +1,19 @@
+module Approval
+  module Mixins
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def acts_as_approval_resource(ignore_fields: [])
+        include ::Approval::Mixins::Resource
+        append_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

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

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

@@ -0,0 +1,60 @@
+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 }
+    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 = resource_model.new(params || {})
+
+        unless record.valid?
+          record.errors.full_messages.each do |_message|
+            errors.add(:base, "message")
+          end
+        end
+      end
+  end
+end

data/lib/approval/models/approval/request.rb

@@ -0,0 +1,43 @@
+module Approval
+  class Request < ::ActiveRecord::Base
+    self.table_name_prefix = "approval_".freeze
+
+    with_options class_name: Approval.config.user_class_name do
+      belongs_to :request_user
+      belongs_to :respond_user, optional: true
+    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 :request_user
+      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

@@ -0,0 +1,37 @@
+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
+
+      private
+
+        def prepare
+          raise NotImplementedError, "you must implement #{self.class}##{__method__}"
+        end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,22 @@
+module Approval
+  module RequestForm
+    class Destroy < Base
+      private
+
+        def prepare
+          ::ActiveRecord::Base.transaction do
+            request = user.approval_requests.new
+            request.comments.new(user: user, 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

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

data/lib/approval/models/approval/request_form.rb

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

data/lib/approval/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
+          ::ActiveRecord::Base.transaction do
+            request.lock!
+            request.assign_attributes(state: :approved, approved_at: Time.current, respond_user: user)
+            request.comments.new(user: user, content: reason)
+            request.items.each(&:apply)
+            yield(request)
+          end
+        end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+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, :invalid) if user == request.request_user
+        end
+    end
+  end
+end

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

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

data/lib/approval/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
+          ::ActiveRecord::Base.transaction do
+            request.lock!
+            request.assign_attributes(state: :rejected, rejected_at: Time.current, respond_user: user)
+            request.comments.new(user: user, content: reason)
+            yield(request)
+          end
+        end
+    end
+  end
+end

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

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

data/lib/approval/version.rb

@@ -1,3 +1,3 @@
 module Approval
-  VERSION = "0.1.0"
+  VERSION = "0.2.0".freeze
 end

data/lib/approval.rb

@@ -1,5 +1,13 @@
-require "approval/version"
-
 module Approval
-  # Your code goes here...
+  def self.config
+    @_config ||= Config.new
+  end
+
+  def self.configure
+    yield config
+  end
 end
+
+require "approval/config"
+require "approval/engine" if defined?(::Rails)
+require "approval/version"

data/lib/generators/approval/install_generator.rb

@@ -0,0 +1,45 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Approval
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+    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")
+    end
+
+    def create_initializer
+      copy_file("initializer.rb", "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

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

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,17 @@
+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