approval 0.1.0 → 0.2.0

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

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

data/lib/generators/approval/templates/initializer.rb

@@ -0,0 +1,4 @@
+Approval.configure do |config|
+  config.user_class_name = "User"
+  config.comment_maximum = 2000
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,10 @@
+require "spec_helper"
+
+RSpec.describe Approval::Config do
+  let(:config) { described_class.new }
+
+  describe "#permit_to_respond_to_own_request?" do
+    subject { config.permit_to_respond_to_own_request? }
+    it { is_expected.to eq false }
+  end
+end

data/spec/lib/version_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+RSpec.describe Approval do
+  it "has a version number" do
+    expect(Approval::VERSION).not_to be nil
+  end
+end

data/spec/models/book_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+
+RSpec.describe Book, type: :model do
+  it { is_expected.to have_many(:approval_items).class_name("Approval::Item") }
+
+  describe ".append_ignore_fields" do
+    subject { described_class.append_ignore_fields(ignore_fields) }
+
+    context "when ignore_fields are blank" do
+      let(:ignore_fields) { [] }
+      it { is_expected.to match_array Approval::Mixins::Resource::DEFAULT_IGNORE_FIELDS }
+    end
+
+    context "when ignore_fields are present" do
+      let(:ignore_fields) { ["published_at"] }
+      it { is_expected.to match_array Approval::Mixins::Resource::DEFAULT_IGNORE_FIELDS.dup.concat(["published_at"]) }
+    end
+  end
+
+  describe "#params_for_approval" do
+    let(:book) { build :book }
+    let(:result) { book.attributes.except("id", "created_at", "updated_at") }
+
+    subject { book.params_for_approval }
+    it { is_expected.to eq result }
+  end
+end

data/spec/models/comment_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+RSpec.describe Approval::Comment, type: :model do
+  it { is_expected.to belong_to(:request).class_name("Approval::Request").inverse_of(:comments) }
+  it { is_expected.to belong_to(:user).class_name(Approval.config.user_class_name) }
+
+  it { is_expected.to validate_presence_of(:content) }
+  it { is_expected.to validate_length_of(:content).is_at_most(Approval.config.comment_maximum) }
+end

data/spec/models/item_spec.rb

@@ -0,0 +1,114 @@
+require "spec_helper"
+
+RSpec.describe Approval::Item, type: :model do
+  describe "Association" do
+    it { is_expected.to belong_to(:request).class_name("Approval::Request").inverse_of(:items) }
+    it { is_expected.to belong_to(:resource) }
+  end
+
+  describe "Association" do
+    it { is_expected.to validate_presence_of(:resource_type) }
+    it { is_expected.to validate_presence_of(:event) }
+    it { is_expected.to validate_inclusion_of(:event).in_array(described_class::EVENTS) }
+
+    context "when event is create" do
+      subject { build :item, :update }
+      it { is_expected.to validate_presence_of(:event) }
+    end
+  end
+
+  describe "#create_event?" do
+    subject { item.create_event? }
+
+    context "when event is create" do
+      let(:item) { build :item, :create }
+      it { is_expected.to eq true }
+    end
+
+    context "when event is update" do
+      let(:item) { build :item, :update }
+      it { is_expected.to eq false }
+    end
+
+    context "when event is destroy" do
+      let(:item) { build :item, :destroy }
+      it { is_expected.to eq false }
+    end
+  end
+
+  describe "#update_event?" do
+    subject { item.update_event? }
+
+    context "when event is create" do
+      let(:item) { build :item, :create }
+      it { is_expected.to eq false }
+    end
+
+    context "when event is update" do
+      let(:item) { build :item, :update }
+      it { is_expected.to eq true }
+    end
+
+    context "when event is destroy" do
+      let(:item) { build :item, :destroy }
+      it { is_expected.to eq false }
+    end
+  end
+
+  describe "#destroy_event?" do
+    subject { item.destroy_event? }
+
+    context "when event is create" do
+      let(:item) { build :item, :create }
+      it { is_expected.to eq false }
+    end
+
+    context "when event is update" do
+      let(:item) { build :item, :update }
+      it { is_expected.to eq false }
+    end
+
+    context "when event is destroy" do
+      let(:item) { build :item, :destroy }
+      it { is_expected.to eq true }
+    end
+  end
+
+  describe "#apply" do
+    let(:request) { build :request, :pending }
+    let(:comment) { build :comment, request: request, user: request.request_user }
+    let(:item) { build :item, event, request: request }
+
+    before do
+      request.comments << comment
+      request.items << item
+      request.save!
+    end
+
+    subject { item.apply }
+
+    context "when event is create" do
+      let(:event) { :create }
+
+      it "creates book" do
+        expect { subject }.to change { Book.count }.by(1)
+      end
+    end
+
+    context "when event is update" do
+      let(:event) { :update }
+
+      it "updates book" do
+        expect { subject }.to change { Book.first.updated_at }
+      end
+    end
+
+    context "when event is destroy" do
+      let(:event) { :destroy }
+
+      it "destroys book" do
+        expect { subject }.to change { Book.count }.by(-1)
+      end
+    end
+  end
+end

data/spec/models/request_form/base_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+RSpec.describe Approval::RequestForm::Base, type: :model do
+  let(:form) { described_class.new(user: user, reason: reason, records: records) }
+
+  describe "Validation" do
+    let(:user) { create :user }
+    let(:reason) { "reason" }
+    let(:records) { build :book }
+
+    subject { form }
+
+    it { is_expected.to validate_presence_of(:user) }
+    it { is_expected.to validate_presence_of(:reason) }
+    it { is_expected.to validate_length_of(:reason).is_at_most(Approval.config.comment_maximum) }
+    it { is_expected.to validate_presence_of(:records) }
+  end
+
+  describe "#save" do
+    context "when invalid" do
+      let(:user) { nil }
+      let(:reason) { nil }
+      let(:records) { nil }
+
+      it { expect(form.save).to eq false }
+    end
+
+    context "when valid" do
+      let(:user) { create :user }
+      let(:reason) { "reason" }
+      let(:records) { build :book }
+
+      it { expect { form.save }.to raise_error(NotImplementedError) }
+    end
+  end
+
+  describe "#save!" do
+    context "when invalid" do
+      let(:user) { nil }
+      let(:reason) { nil }
+      let(:records) { nil }
+
+      it { expect { form.save! }.to raise_error(::ActiveRecord::RecordInvalid) }
+    end
+
+    context "when valid" do
+      let(:user) { create :user }
+      let(:reason) { "reason" }
+      let(:records) { build :book }
+
+      it { expect { form.save! }.to raise_error(NotImplementedError) }
+    end
+  end
+end

data/spec/models/request_form/create_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+RSpec.describe Approval::RequestForm::Create do
+  describe "#save" do
+    let(:user) { create :user }
+    let(:reason) { "reason" }
+    let(:form) { described_class.new(user: user, reason: reason, records: records) }
+
+    subject { form.save }
+
+    context "when records is single" do
+      let(:records) { build :book }
+      it { expect { subject }.not_to raise_error }
+      it { expect { subject }.to change { Approval::Item.count }.from(0).to(1) }
+    end
+
+    context "when records is multiple" do
+      let(:records) { build_list :book, 3 }
+      it { expect { subject }.not_to raise_error }
+      it { expect { subject }.to change { Approval::Item.count }.from(0).to(3) }
+    end
+  end
+end

data/spec/models/request_form/destroy_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+RSpec.describe Approval::RequestForm::Destroy do
+  describe "#save" do
+    let(:user) { create :user }
+    let(:reason) { "reason" }
+    let(:form) { described_class.new(user: user, reason: reason, records: records) }
+
+    subject { form.save }
+
+    context "when records is single" do
+      let(:records) { create :book }
+      it { expect { subject }.not_to raise_error }
+      it { expect { subject }.to change { Approval::Item.count }.from(0).to(1) }
+    end
+
+    context "when records is multiple" do
+      let(:records) { create_list :book, 3 }
+      it { expect { subject }.not_to raise_error }
+      it { expect { subject }.to change { Approval::Item.count }.from(0).to(3) }
+    end
+  end
+end

data/spec/models/request_form/update_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+RSpec.describe Approval::RequestForm::Update do
+  describe "#save" do
+    let(:user) { create :user }
+    let(:reason) { "reason" }
+    let(:form) { described_class.new(user: user, reason: reason, records: records) }
+
+    subject { form.save }
+
+    context "when records is single" do
+      let(:records) { create :book }
+      it { expect { subject }.not_to raise_error }
+      it { expect { subject }.to change { Approval::Item.count }.from(0).to(1) }
+    end
+
+    context "when records is multiple" do
+      let(:records) { create_list :book, 3 }
+      it { expect { subject }.not_to raise_error }
+      it { expect { subject }.to change { Approval::Item.count }.from(0).to(3) }
+    end
+  end
+end

data/spec/models/request_form_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+RSpec.describe Approval::RequestForm do
+end

data/spec/models/request_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+RSpec.describe Approval::Request, type: :model do
+  describe "Association" do
+    it { is_expected.to belong_to(:request_user).class_name(Approval.config.user_class_name) }
+    it { is_expected.to belong_to(:respond_user).class_name(Approval.config.user_class_name) }
+    it { is_expected.to have_many(:comments).class_name("::Approval::Comment").dependent(:destroy) }
+    it { is_expected.to have_many(:items).class_name("::Approval::Item").dependent(:destroy) }
+  end
+
+  it { is_expected.to define_enum_for(:state).with(described_class.states) }
+
+  describe "Validation" do
+    it { is_expected.to validate_presence_of(:state) }
+    it { is_expected.to validate_presence_of(:request_user) }
+    it { is_expected.to validate_presence_of(:comments) }
+    it { is_expected.to validate_presence_of(:items) }
+
+    context "when request not pending" do
+      subject { build :request, :cancelled }
+      it { is_expected.to validate_presence_of(:respond_user) }
+    end
+  end
+
+  describe "Callback" do
+    context "before create" do
+      let(:request) { build :request, :pending }
+      let(:comment) { build :comment, request: request, user: request.request_user }
+      let(:item) { build :item, :create, request: request }
+
+      it "set requested_at" do
+        expect(request.requested_at).to be_nil
+        request.comments << comment
+        request.items << item
+        request.save!
+        expect(request.requested_at).to be_present
+      end
+    end
+  end
+end

data/spec/models/respond_form/approve_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+RSpec.describe Approval::RespondForm::Approve do
+end

data/spec/models/respond_form/base_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+RSpec.describe Approval::RespondForm::Base, type: :model do
+  let(:form) { described_class.new(user: user, reason: reason, request: request) }
+
+  describe "Validation" do
+    let(:user) { create :user }
+    let(:reason) { "reason" }
+    let(:request) do
+      build(:request, :pending).tap do |request|
+        request.comments << build(:comment, user: request.request_user)
+        request.items << build(:item, :create)
+        request.save!
+      end
+    end
+
+    subject { form }
+
+    it { is_expected.to validate_presence_of(:user) }
+    it { is_expected.to validate_presence_of(:reason) }
+    it { is_expected.to validate_length_of(:reason).is_at_most(Approval.config.comment_maximum) }
+    it { is_expected.to validate_presence_of(:request) }
+  end
+
+  describe "#save" do
+    context "when invalid" do
+      let(:user) { create :user }
+      let(:reason) { "" }
+      let(:request) do
+        build(:request, :pending).tap do |request|
+          request.comments << build(:comment, user: request.request_user)
+          request.items << build(:item, :create)
+          request.save!
+        end
+      end
+
+      it { expect(form.save).to eq false }
+    end
+
+    context "when valid" do
+      let(:user) { create :user }
+      let(:reason) { "reason" }
+      let(:request) do
+        build(:request, :pending).tap do |request|
+          request.comments << build(:comment, user: request.request_user)
+          request.items << build(:item, :create)
+          request.save!
+        end
+      end
+
+      it { expect { form.save }.to raise_error(NotImplementedError) }
+    end
+  end
+
+  describe "#save!" do
+    context "when invalid" do
+      let(:user) { create :user }
+      let(:reason) { "" }
+      let(:request) do
+        build(:request, :pending).tap do |request|
+          request.comments << build(:comment, user: request.request_user)
+          request.items << build(:item, :create)
+          request.save!
+        end
+      end
+
+      it { expect { form.save! }.to raise_error(::ActiveRecord::RecordInvalid) }
+    end
+
+    context "when valid" do
+      let(:user) { create :user }
+      let(:reason) { "reason" }
+      let(:request) do
+        build(:request, :pending).tap do |request|
+          request.comments << build(:comment, user: request.request_user)
+          request.items << build(:item, :create)
+          request.save!
+        end
+      end
+
+      it { expect { form.save! }.to raise_error(NotImplementedError) }
+    end
+  end
+end

data/spec/models/respond_form/cancel_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+RSpec.describe Approval::RespondForm::Cancel do
+end

data/spec/models/respond_form/reject_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+RSpec.describe Approval::RespondForm::Reject do
+end

data/spec/models/respond_form_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+RSpec.describe Approval::RespondForm do
+end

data/spec/models/user_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+RSpec.describe User, type: :model do
+  it { is_expected.to have_many(:approval_requests).class_name("Approval::Request").with_foreign_key(:request_user_id) }
+  it { is_expected.to have_many(:approval_comments).class_name("Approval::Comment").with_foreign_key(:user_id) }
+
+  describe "RequestForm" do
+    let(:user) { build :user }
+    let(:records) { build_list :book, 3 }
+    let(:reason) { "reason" }
+
+    describe "#request_for_create" do
+      subject { user.request_for_create(records, reason: reason) }
+      it { is_expected.to be_a(Approval::RequestForm::Create) }
+    end
+
+    describe "#request_for_update" do
+      subject { user.request_for_update(records, reason: reason) }
+      it { is_expected.to be_a(Approval::RequestForm::Update) }
+    end
+
+    describe "#request_for_destroy" do
+      subject { user.request_for_destroy(records, reason: reason) }
+      it { is_expected.to be_a(Approval::RequestForm::Destroy) }
+    end
+  end
+
+  describe "RespondForm" do
+    let(:user) { build :user }
+    let(:request) { build :request }
+    let(:reason) { "reason" }
+
+    describe "#cancel_request" do
+      subject { user.cancel_request(request, reason: reason) }
+      it { is_expected.to be_a(Approval::RespondForm::Cancel) }
+    end
+
+    describe "#approve_request" do
+      subject { user.approve_request(request, reason: reason) }
+      it { is_expected.to be_a(Approval::RespondForm::Approve) }
+    end
+
+    describe "#reject_request" do
+      subject { user.reject_request(request, reason: reason) }
+      it { is_expected.to be_a(Approval::RespondForm::Reject) }
+    end
+  end
+end

data/spec/rails/rails-4.2.9/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/rails/rails-4.2.9/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/rails/rails-4.2.9/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/spec/rails/rails-4.2.9/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/rails/rails-4.2.9/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/rails/rails-4.2.9/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/rails/rails-4.2.9/app/models/book.rb

@@ -0,0 +1,3 @@
+class Book < ActiveRecord::Base
+  acts_as_approval_resource
+end

data/spec/rails/rails-4.2.9/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  acts_as_approval_user
+end

data/spec/rails/rails-4.2.9/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Rails429</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/rails/rails-4.2.9/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/rails/rails-4.2.9/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/rails/rails-4.2.9/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run