RubyGems - HornsAndHooves-moribus - Versions diffs - 0.1.0 - Mend

HornsAndHooves-moribus 0.1.0

Files changed (63) hide show

checksums.yaml +7 -0
data/.gitignore +35 -0
data/.rspec +4 -0
data/.ruby-gemset +1 -0
data/.ruby-version +1 -0
data/.simplecov +42 -0
data/.travis.yml +8 -0
data/Gemfile +17 -0
data/HornsAndHooves-moribus.gemspec +31 -0
data/LICENSE +21 -0
data/README.md +110 -0
data/Rakefile +15 -0
data/lib/colorized_text.rb +33 -0
data/lib/moribus.rb +138 -0
data/lib/moribus/aggregated_behavior.rb +80 -0
data/lib/moribus/aggregated_cache_behavior.rb +76 -0
data/lib/moribus/alias_association.rb +111 -0
data/lib/moribus/extensions.rb +37 -0
data/lib/moribus/extensions/delegate_associated.rb +48 -0
data/lib/moribus/extensions/has_aggregated_extension.rb +94 -0
data/lib/moribus/extensions/has_current_extension.rb +17 -0
data/lib/moribus/macros.rb +135 -0
data/lib/moribus/tracked_behavior.rb +91 -0
data/lib/moribus/version.rb +3 -0
data/spec/dummy/README.rdoc +261 -0
data/spec/dummy/Rakefile +7 -0
data/spec/dummy/app/assets/javascripts/application.js +15 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +3 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/mailers/.gitkeep +0 -0
data/spec/dummy/app/models/.gitkeep +0 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/config/application.rb +53 -0
data/spec/dummy/config/boot.rb +10 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +31 -0
data/spec/dummy/config/environments/production.rb +70 -0
data/spec/dummy/config/environments/test.rb +34 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/inflections.rb +15 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/secret_token.rb +7 -0
data/spec/dummy/config/initializers/session_store.rb +8 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +5 -0
data/spec/dummy/config/routes.rb +58 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/lib/assets/.gitkeep +0 -0
data/spec/dummy/log/.gitkeep +0 -0
data/spec/dummy/public/404.html +26 -0
data/spec/dummy/public/422.html +26 -0
data/spec/dummy/public/500.html +25 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/dummy/script/rails +6 -0
data/spec/moribus/alias_association_spec.rb +88 -0
data/spec/moribus/macros_spec.rb +7 -0
data/spec/moribus_spec.rb +332 -0
data/spec/spec_helper.rb +15 -0
data/spec/support/moribus_spec_model.rb +57 -0
metadata +247 -0

data/spec/dummy/db/test.sqlite3 ADDED Viewed

File without changes

data/spec/dummy/lib/assets/.gitkeep ADDED Viewed

File without changes

data/spec/dummy/log/.gitkeep ADDED Viewed

File without changes

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

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <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>
+</body>
+</html>

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

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

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

@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+</body>
+</html>

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

File without changes

data/spec/dummy/script/rails ADDED Viewed

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/spec/moribus/alias_association_spec.rb ADDED Viewed

@@ -0,0 +1,88 @@
+require 'spec_helper'
+describe Moribus::AliasAssociation do
+  before do
+    class SpecPost < MoribusSpecModel(:spec_author_id => :integer, :body => :string)
+      belongs_to :spec_author   , :alias => :creator
+      has_many   :spec_comments , :alias => :remarks
+      has_one    :spec_post_info, :alias => :information
+      alias_association :author   , :spec_author
+      alias_association :comments , :spec_comments
+      alias_association :post_info, :spec_post_info
+    end
+    class SpecAuthor < MoribusSpecModel(:name => :string)
+      has_many :spec_posts
+    end
+    class SpecPostInfo < MoribusSpecModel(:spec_post_id => :integer, :ip => :string)
+      belongs_to :spec_post, :alias => :note
+    end
+    class SpecComment < MoribusSpecModel(:spec_post_id => :integer, :body => :string)
+      belongs_to :spec_post
+    end
+  end
+  after do
+    MoribusSpecModel.cleanup!
+  end
+  before do
+    author = SpecAuthor.create(:name => 'John')
+    @post = author.spec_posts.create(:body => 'Post Body')
+    @post.spec_comments.create(:body => 'Fabulous!')
+    @post.create_spec_post_info(:ip => '127.0.0.1')
+  end
+  describe "reflection aliasing" do
+    it "alias association name in reflections" do
+      SpecPost.reflect_on_association(:author).should_not be_nil
+    end
+    it "should not raise error when using aliased name in scopes" do
+      expect{
+        SpecPost.includes(:comments).first
+      }.to_not raise_error
+    end
+  end
+  describe "association accessor alias methods" do
+    subject{ @post }
+    it{ should respond_to :author }
+    it{ should respond_to :author= }
+    it{ should respond_to :comments }
+    it{ should respond_to :comments= }
+    it{ should respond_to :post_info }
+    it{ should respond_to :post_info= }
+  end
+  describe "singular association alias method" do
+    subject{ @post }
+    it{ should respond_to :build_author }
+    it{ should respond_to :create_author }
+    it{ should respond_to :create_author! }
+    it{ should respond_to :build_post_info }
+    it{ should respond_to :create_post_info }
+    it{ should respond_to :create_post_info! }
+  end
+  describe "collection association alias method" do
+    subject{ @post }
+    it{ should respond_to :comment_ids }
+    it{ should respond_to :comment_ids= }
+  end
+  describe ":alias => alias_name shortcuts" do
+    subject{ @post }
+    it { should respond_to :creator }
+    it { should respond_to :remarks }
+    it { should respond_to :information }
+  end
+end

data/spec/moribus/macros_spec.rb ADDED Viewed

@@ -0,0 +1,7 @@
+require 'spec_helper'
+# Some of the Moribus::Macros methods are tested in
+# spec/lib/moribus_spec.rb.
+describe Moribus::Macros do
+end

data/spec/moribus_spec.rb ADDED Viewed

@@ -0,0 +1,332 @@
+require 'spec_helper'
+describe Moribus do
+  before do
+    class SpecStatus < MoribusSpecModel(:name => :string, :description => :string)
+      acts_as_enumerated
+      self.enumeration_model_updates_permitted = true
+      create!(:name => 'inactive', :description => 'Inactive')
+      create!(:name => 'active', :description => 'Active')
+    end
+    class SpecType < MoribusSpecModel(:name => :string, :description => :string)
+      acts_as_enumerated
+      self.enumeration_model_updates_permitted = true
+      create!(:name => 'important', :description => 'Important')
+      create!(:name => 'unimportant', :description => 'Unimportant')
+    end
+    class SpecSuffix < MoribusSpecModel(:name => :string, :description => :string)
+      acts_as_enumerated
+      self.enumeration_model_updates_permitted = true
+      create!(:name => 'none', :description => '')
+      create!(:name => 'jr', :description => 'Junior')
+    end
+    class SpecPersonName < MoribusSpecModel(:first_name => :string, :last_name => :string, :spec_suffix_id => :integer)
+      acts_as_aggregated
+      has_enumerated :spec_suffix, :default => ''
+      validates_presence_of :first_name, :last_name
+      # custom writer that additionally strips first name
+      def first_name=(value)
+        self[:first_name] = value.strip
+      end
+    end
+    class SpecCustomerFeature < MoribusSpecModel(:feature_name => :string)
+      acts_as_aggregated :cache_by => :feature_name
+    end
+    class SpecCustomerInfo < MoribusSpecModel( :spec_customer_id    => :integer!,
+                                        :spec_person_name_id => :integer,
+                                        :spec_status_id      => :integer,
+                                        :spec_type_id        => :integer,
+                                        :is_current          => :boolean,
+                                        :lock_version        => :integer,
+                                        :created_at          => :datetime,
+                                        :updated_at          => :datetime,
+                                        :previous_id         => :integer )
+      attr :custom_field
+      belongs_to :spec_customer, :inverse_of => :spec_customer_info, :touch => true
+      has_aggregated :spec_person_name
+      has_enumerated :spec_status
+      has_enumerated :spec_type
+      acts_as_tracked :preceding_key => :previous_id
+    end
+    class SpecCustomer < MoribusSpecModel(:spec_status_id => :integer)
+      has_one_current :spec_customer_info, :inverse_of => :spec_customer
+      has_enumerated :spec_status, :default => 'inactive'
+      delegate_associated :spec_person_name, :custom_field, :spec_type, :to => :spec_customer_info
+    end
+    class SpecCustomerEmail < MoribusSpecModel(:spec_customer_id => :integer, :email => :string, :is_current => :boolean, :status => :string)
+      connection.add_index table_name, [:email, :is_current], :unique => true
+      belongs_to :spec_customer
+      acts_as_tracked
+    end
+  end
+  after do
+    MoribusSpecModel.cleanup!
+  end
+  describe "common behavior" do
+    before do
+      @info = SpecCustomerInfo.create(
+        :spec_customer_id => 1,
+        :spec_person_name_id => 1,
+        :is_current => true,
+        :created_at => 5.days.ago,
+        :updated_at => 5.days.ago
+      )
+    end
+    it "should revert changes if exception is raised" do
+      old_id = @info.id
+      old_updated_at = @info.updated_at
+      old_created_at = @info.created_at
+      suppress(Exception) do
+        expect {
+          @info.update_attributes :spec_customer_id => nil, :spec_person_name_id => 2
+        }.not_to change(SpecCustomerInfo, :count)
+      end
+      expect(@info.new_record?).to eq false
+      @info.id.should == old_id
+      @info.updated_at.should == old_updated_at
+      @info.created_at.should == old_created_at
+    end
+  end
+  describe 'Aggregated' do
+    context "definition" do
+      it "should raise an error on an unknown option" do
+        expect{
+          Class.new(ActiveRecord::Base).class_eval do
+            acts_as_aggregated :invalid_key => :error
+          end
+        }.to raise_error(ArgumentError)
+      end
+      it "should raise an error when including AggregatedCacheBehavior without AggregatedBehavior" do
+        expect{
+          Class.new(ActiveRecord::Base).class_eval do
+            include Moribus::AggregatedCacheBehavior
+          end
+        }.to raise_error(Moribus::AggregatedCacheBehavior::NotAggregatedError)
+      end
+    end
+    before do
+      @existing = SpecPersonName.create! :first_name => 'John', :last_name => 'Smith'
+    end
+    it "should not duplicate records" do
+      expect {
+        SpecPersonName.create :first_name => ' John ', :last_name => 'Smith'
+      }.not_to change(SpecPersonName, :count)
+    end
+    it "should lookup self and replace id with existing on create" do
+      name = SpecPersonName.new :first_name => 'John', :last_name => 'Smith'
+      name.save
+      name.id.should == @existing.id
+    end
+    it "should create a new record if lookup fails" do
+      expect {
+        SpecPersonName.create :first_name => 'Alice', :last_name => 'Smith'
+      }.to change(SpecPersonName, :count).by(1)
+    end
+    it "should lookup self and replace id with existing on update" do
+      name = SpecPersonName.create :first_name => 'Alice', :last_name => 'Smith'
+      name.update_attributes :first_name => 'John'
+      name.id.should == @existing.id
+    end
+    context "with caching" do
+      before do
+        @existing = SpecCustomerFeature.create(:feature_name => 'Pays')
+        SpecCustomerFeature.clear_cache
+      end
+      it "should lookup the existing value and add it to the cache" do
+        feature = SpecCustomerFeature.new :feature_name => @existing.feature_name
+        expect{ feature.save }.to change(SpecCustomerFeature.aggregated_records_cache, :length).by(1)
+        feature.id.should == @existing.id
+      end
+      it "should add the freshly-created record to the cache" do
+        expect{ SpecCustomerFeature.create(:feature_name => 'Fraud') }.to change(SpecCustomerFeature.aggregated_records_cache, :length).by(1)
+      end
+      it "should freeze the cached object" do
+        feature = SpecCustomerFeature.create(:feature_name => 'Cancelled')
+        SpecCustomerFeature.aggregated_records_cache[feature.feature_name].should be_frozen
+      end
+      it "should cache the clone of the record, not the record itself" do
+        feature = SpecCustomerFeature.create(:feature_name => 'Returned')
+        SpecCustomerFeature.aggregated_records_cache[feature.feature_name].object_id.should_not == feature.object_id
+      end
+    end
+  end
+  describe 'Tracked' do
+    before do
+      @customer = SpecCustomer.create
+      @info = @customer.create_spec_customer_info :spec_person_name_id => 1
+    end
+    it "should create a new current record if updated" do
+      expect {
+        @info.update_attributes(:spec_person_name_id => 2)
+      }.to change(SpecCustomerInfo, :count).by(1)
+    end
+    it "should replace itself with new id" do
+      old_id = @info.id
+      @info.update_attributes(:spec_person_name_id => 2)
+      @info.id.should_not == old_id
+    end
+    it "should set is_current record to false for superseded record" do
+      old_id = @info.id
+      @info.update_attributes(:spec_person_name_id => 2)
+      expect(SpecCustomerInfo.find(old_id).is_current).to eq false
+    end
+    it "should set previous_id to the id of the previous record" do
+      old_id = @info.id
+      @info.update_attributes(:spec_person_name_id => 2)
+      @info.previous_id.should == old_id
+    end
+    it "assigning a new current record should change is_current to false for previous one" do
+      new_info = SpecCustomerInfo.new :spec_person_name_id => 2, :is_current => true
+      @customer.spec_customer_info = new_info
+      new_info.spec_customer_id.should == @customer.id
+      expect(@info.is_current).to eq false
+    end
+    it "should not crash on superseding with 'is_current' conditional constraint" do
+      email = SpecCustomerEmail.create(:spec_customer => @customer, :email => 'foo@bar.com', :status => 'unverified', :is_current => true)
+      expect{ email.update_attributes(:status => 'verified') }.not_to raise_error
+    end
+    describe 'updated_at and created_at' do
+      let(:first_time)  { Time.zone.parse('2012-07-16 00:00:00') }
+      let(:second_time) { Time.zone.parse('2012-07-17 08:10:15') }
+      before { Timecop.freeze(first_time) }
+      after  { Timecop.return             }
+      it "should be updated on change" do
+        info = @customer.create_spec_customer_info :spec_person_name_id => 1
+        info.updated_at.should == first_time
+        info.created_at.should == first_time
+        Timecop.freeze(second_time)
+        info.spec_person_name_id = 2
+        info.save!
+        info.updated_at.should == second_time
+        info.created_at.should == second_time
+      end
+    end
+    describe "Optimistic Locking" do
+      before do
+        @info1 = @customer.reload.spec_customer_info
+        @info2 = @customer.reload.spec_customer_info
+      end
+      it "should raise stale object error" do
+        @info1.update_attributes(:spec_person_name_id => 3)
+        expect{ @info2.update_attributes(:spec_person_name_id => 4) }.to raise_error(ActiveRecord::StaleObjectError)
+      end
+      it "should not fail if no locking_column present" do
+        email = SpecCustomerEmail.create(:spec_customer_id => 1, :email => 'foo@bar.com')
+        expect{ email.update_attributes(:email => 'foo2@bar.com') }.not_to raise_error
+      end
+    end
+    describe 'with Aggregated' do
+      before do
+        @info.spec_person_name = SpecPersonName.create(:first_name => 'John', :last_name => 'Smith')
+        @info.save
+        @info.reload
+      end
+      it "should supersede when nested record changes" do
+        old_id = @info.id
+        @customer.spec_customer_info.spec_person_name.first_name = 'Alice'
+        expect{ @customer.save }.to change(@info, :spec_person_name_id)
+        @info.id.should_not == old_id
+        @info.is_current.should == true
+        expect(SpecCustomerInfo.find(old_id).is_current).to eq false
+      end
+    end
+  end
+  describe 'Delegations' do
+    before do
+      @customer = SpecCustomer.create(
+        :spec_customer_info_attributes => {
+          :spec_person_name_attributes => {:first_name => ' John ', :last_name => 'Smith'} } )
+      @info = @customer.spec_customer_info
+    end
+    it "should have delegated column information" do
+      @customer.column_for_attribute(:first_name).should_not be_nil
+    end
+    it "should not delegate special methods" do
+      @customer.should_not respond_to(:reset_first_name)
+      @customer.should_not respond_to(:first_name_was)
+      @customer.should_not respond_to(:first_name_before_type_cast)
+      @customer.should_not respond_to(:first_name_will_change!)
+      @customer.should_not respond_to(:first_name_changed?)
+      @customer.should_not respond_to(:lock_version)
+    end
+    it "should delegate methods to aggregated parts" do
+      @info.should respond_to(:first_name)
+      @info.should respond_to(:first_name=)
+      @info.should respond_to(:spec_suffix)
+      @info.last_name.should == 'Smith'
+    end
+    it "should delegate methods to representation" do
+      @customer.should respond_to(:first_name)
+      @customer.should respond_to(:first_name=)
+      @customer.should respond_to(:spec_suffix)
+      @customer.last_name.should == 'Smith'
+      @customer.should respond_to(:custom_field)
+      @customer.should respond_to(:custom_field=)
+    end
+    it 'should properly delegate enumerated attributes' do
+      @customer.should respond_to(:spec_type)
+      @customer.should respond_to(:spec_type=)
+      @customer.spec_type = :important
+      @customer.spec_type.should === :important
+    end
+    it "should raise NoMethodError if unknown method received" do
+      expect{ @customer.impossibru }.to raise_error(NoMethodError)
+    end
+  end
+end