RubyGems - approvable - Versions diffs - 0.0.1 - Mend

approvable 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (56) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.rdoc +3 -0
data/Rakefile +21 -0
data/app/models/approvable/change_request.rb +57 -0
data/db/migrate/20140807145534_create_approvable_change_requests.rb +14 -0
data/lib/approvable/acts_as_approvable.rb +85 -0
data/lib/approvable/engine.rb +41 -0
data/lib/approvable/version.rb +3 -0
data/lib/approvable.rb +4 -0
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +15 -0
data/spec/dummy/app/controllers/application_controller.rb +5 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/models/listing.rb +3 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/config/application.rb +29 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/database.yml +85 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +37 -0
data/spec/dummy/config/environments/production.rb +82 -0
data/spec/dummy/config/environments/test.rb +39 -0
data/spec/dummy/config/initializers/assets.rb +8 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +4 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +23 -0
data/spec/dummy/config/routes.rb +4 -0
data/spec/dummy/config/secrets.yml +22 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/db/migrate/20140807144654_create_listings.rb +12 -0
data/spec/dummy/db/schema.rb +28 -0
data/spec/dummy/log/development.log +339 -0
data/spec/dummy/log/test.log +33704 -0
data/spec/dummy/public/404.html +67 -0
data/spec/dummy/public/422.html +67 -0
data/spec/dummy/public/500.html +66 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/factories/change_requests.rb +50 -0
data/spec/factories/listing.rb +15 -0
data/spec/models/acts_as_approvable_spec.rb +192 -0
data/spec/models/approvable/change_request_spec.rb +61 -0
data/spec/rails_helper.rb +52 -0
data/spec/spec_helper.rb +78 -0
data/spec/support/factory_girl.rb +5 -0
metadata +228 -0

data/spec/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/factories/change_requests.rb ADDED Viewed

@@ -0,0 +1,50 @@
+# Read about factories at https://github.com/thoughtbot/factory_girl
+FactoryGirl.define do
+  factory :change_request, :class => 'Approvable::ChangeRequest' do
+    association :approvable, factory: [:listing, :approved]
+    requested_changes {{title: "new_#{approvable.title}"}}
+    trait :approved do
+      after(:create) {|c| c.submit; c.approve}
+    end
+    trait :pending do
+    end
+    trait :submitted do
+      after(:create) {|c| c.submit}
+    end
+    trait :rejected do
+      after(:create) {|c| c.submit; c.reject}
+    end
+    # trait :pending do
+    #   submitted_at nil
+    #   approved_at nil
+    #   rejected_at nil
+    # end
+    #
+    # trait :submitted do
+    #   submitted_at {Time.now}
+    #   approved_at nil
+    #   rejected_at nil
+    # end
+    #
+    # trait :approved do
+    #   submitted_at {Time.now}
+    #   approved_at {Time.now}
+    #   rejected_at nil
+    # end
+    #
+    # trait :rejected do
+    #   submitted_at {Time.now}
+    #   approved_at nil
+    #   rejected_at {Time.now}
+    # end
+  end
+end

data/spec/factories/listing.rb ADDED Viewed

@@ -0,0 +1,15 @@
+FactoryGirl.define do
+  factory :listing do
+    sequence(:title) {|n| "Title #{n}"}
+    sequence(:description) {|n| "A long description #{n}"}
+    trait :approved do
+      after(:create) do |listing|
+        listing.submit_changes
+        listing.approve_changes
+        listing.reload
+      end
+    end
+  end
+end

data/spec/models/acts_as_approvable_spec.rb ADDED Viewed

@@ -0,0 +1,192 @@
+require 'rails_helper'
+module Approvable
+  describe ActsAsApprovable do
+    before do
+      @listing = create(:listing, :approved)
+    end
+    it 'responds to acts_as_approvable to class' do
+      expect(Listing).to respond_to :acts_as_approvable
+    end
+    it 'responds to with_changes method' do
+      expect(@listing).to respond_to :with_changes
+    end
+    it 'has_many change_requests' do
+      expect(@listing).to respond_to :change_requests
+    end
+    it 'has_one current_change_request' do
+      expect(@listing).to respond_to :current_change_request
+    end
+    it 'returns last unapproved change request' do
+      create(:change_request, :approved, approvable: @listing )
+      create(:change_request, :approved, approvable: @listing )
+      change_request = create(:change_request, :submitted, approvable: @listing )
+      @listing.reload
+      expect(@listing.current_change_request).to eq change_request
+    end
+    it 'returns nil if no unapproved change request' do
+      create(:change_request, :approved, approvable: @listing )
+      create(:change_request, :approved, approvable: @listing )
+      expect(@listing.current_change_request).to be nil
+    end
+    it 'delegates change_status to current_change_request' do
+      create(:change_request, :approved, approvable: @listing )
+      create(:change_request, :submitted, approvable: @listing )
+      @listing.reload
+      expect(@listing.change_status).to eq 'submitted'
+    end
+    it 'returns nil if no current_change_request' do
+      create(:change_request, :approved, approvable: @listing )
+      create(:change_request, :approved, approvable: @listing )
+      expect(@listing.change_status).to be nil
+    end
+    it 'wont create a new change request if there is a current one' do
+      create(:change_request, :approved, approvable: @listing )
+      create(:change_request, :approved, approvable: @listing )
+      create(:change_request, :submitted, approvable: @listing )
+      expect{
+        create(:change_request, :submitted, approvable: @listing )
+      }.to raise_error ActiveRecord::RecordInvalid
+    end
+    it 'creates a new change request for an new listing' do
+      expect{
+        @listing.update(title: 'a brand new title')
+      }.to change {@listing.change_requests.count}.by(1)
+    end
+    it 'returns listing with requested changes' do
+      @listing.update(title: 'a brand new title')
+      expect(@listing.title).not_to eq 'a brand new title'
+      expect(@listing.with_changes.title).to eq 'a brand new title'
+    end
+    it 'creates a new change request for an approved listing and doesnt change exiting' do
+      change_request = create(:change_request, :approved, approvable: @listing )
+      expect{
+        @listing.update(title: 'a brand new title')
+      }.to change {@listing.change_requests.count}.by(1)
+      change_request.reload
+      expect(change_request.changed_attributes).not_to match title: 'a brand new title'
+    end
+    it 'updates a pending change request for a pending listing' do
+      change_request = create(:change_request, :pending, approvable: @listing )
+      @listing.reload
+      expect{
+        @listing.update(title: 'a brand new title')
+      }.not_to change {@listing.change_requests.count}
+      change_request.reload
+      expect(change_request.requested_changes).to match "title" => 'a brand new title'
+      expect(change_request.state).to eq 'pending'
+    end
+    it 'keeps previous changes and adds new changes' do
+      change_request = create(:change_request, :pending, requested_changes: {"title" => 'a brand new title'}, approvable: @listing )
+      @listing.reload
+      expect{
+        @listing.update(description: 'a hot bod')
+      }.not_to change {@listing.change_requests.count}
+      change_request.reload
+      expect(change_request.requested_changes).to match "title" => 'a brand new title', "description" => 'a hot bod'
+      expect(change_request.state).to eq 'pending'
+    end
+    it 'cant update an existing listing if a change is already submitted' do
+      change_request = create(:change_request, :submitted, approvable: @listing )
+      @listing.reload
+      expect{
+        @listing.update!(title: 'a brand new title')
+        puts change_request.errors.full_messages.inspect
+        puts @listing.errors.full_messages.inspect
+      }.to raise_error ActiveRecord::RecordInvalid
+      change_request.reload
+      expect(change_request.requested_changes).not_to match "title" => 'a brand new title'
+      expect(change_request.state).to eq 'submitted'
+    end
+    it 'updates an existing change request for a rejected listing and changes the status to pending' do
+      change_request = create(:change_request, :rejected, approvable: @listing )
+      @listing.reload
+      expect{
+        @listing.update!(title: 'a brand new title')
+      }.not_to change {@listing.change_requests.count}
+      change_request.reload
+      expect(change_request.requested_changes).to match "title" => 'a brand new title'
+      expect(change_request.state).to eq 'pending'
+    end
+    it 'submits changes' do
+      @listing.update(title: 'a brand new title')
+      @listing.submit_changes
+      expect(@listing.change_status).to eq 'submitted'
+      @listing.reload
+      expect(@listing.title).not_to eq 'a brand new title'
+    end
+    it 'unsubmits changes' do
+      @listing.update(title: 'a brand new title')
+      @listing.submit_changes
+      @listing.unsubmit_changes
+      expect(@listing.change_status).to eq 'pending'
+      @listing.reload
+      expect(@listing.title).not_to eq 'a brand new title'
+    end
+    it 'approves changes' do
+      @listing.update(title: 'a brand new title')
+      @listing.submit_changes
+      @listing.approve_changes
+      @listing.reload
+      expect(@listing.title).to eq 'a brand new title'
+      expect(@listing.current_change_request).to be nil
+      expect(@listing.change_status).to be nil
+    end
+    it 'rejects changes' do
+      @listing.update(title: 'a brand new title')
+      @listing.submit_changes
+      @listing.reject_changes
+      @listing.reload
+      expect(@listing.title).not_to eq 'a brand new title'
+      expect(@listing.change_status).to eq 'rejected'
+    end
+  end
+end

data/spec/models/approvable/change_request_spec.rb ADDED Viewed

@@ -0,0 +1,61 @@
+require 'rails_helper'
+module Approvable
+  describe ChangeRequest, :type => :model do
+    before {@request = create(:change_request)}
+    it 'creates a change request as pending' do
+      expect(@request.state).to eq 'pending'
+    end
+    it 'wont create new request unless all others are approved' do
+      approvable = @request.approvable
+      expect{create(:change_request, approvable: approvable)}.to raise_error ActiveRecord::RecordInvalid
+      @request.submit
+      expect{create(:change_request, approvable: approvable)}.to raise_error ActiveRecord::RecordInvalid
+      @request.reject
+      expect{create(:change_request, approvable: approvable)}.to raise_error ActiveRecord::RecordInvalid
+      @request.submit
+      @request.approve
+      expect{create(:change_request, approvable: approvable)}.not_to raise_error
+    end
+    it 'cannot update requested_changes once submitted' do
+      @request.submit
+      expect{
+        @request.update!(requested_changes: {title: 'a brand new title'})
+      }.to raise_error ActiveRecord::RecordInvalid
+    end
+    it 'cannot update requested_changes once approved' do
+      @request.submit
+      @request.approve
+      expect{
+        @request.update!(requested_changes: {title: 'a brand new title'})
+      }.to raise_error ActiveRecord::RecordInvalid
+    end
+    it 'cannot transition out of approved' do
+      @request.submit
+      @request.approve
+      expect{@request.reject!}.to raise_error StateMachine::InvalidTransition
+      expect{@request.submit!}.to raise_error StateMachine::InvalidTransition
+      expect{@request.unreject!}.to raise_error StateMachine::InvalidTransition
+    end
+    it 'rejected reverts to pending after changed_attributes change' do
+      @request.submit
+      @request.reject
+      @request.update(requested_changes: {title: 'a brand new title'})
+      expect(@request.state).to eq 'pending'
+    end
+  end
+end

data/spec/rails_helper.rb ADDED Viewed

@@ -0,0 +1,52 @@
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'spec_helper'
+require 'rspec/rails'
+require 'rspec/autorun'
+require 'factory_girl_rails'
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+Rails.backtrace_cleaner.remove_silencers!
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  # config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.mock_with :rspec
+  config.infer_base_class_for_anonymous_controllers = false
+  config.order = "random"
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,78 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end

data/spec/support/factory_girl.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require 'factory_girl_rails'
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end