RubyGems - quickening - Versions diffs - 0.1.1 - Mend

quickening 0.1.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 (60) hide show

checksums.yaml +7 -0
data/CHANGELOG.rdoc +54 -0
data/MIT-LICENSE +20 -0
data/README.md +145 -0
data/Rakefile +36 -0
data/app/assets/javascripts/quickening/application.js +15 -0
data/app/assets/stylesheets/quickening/application.css +13 -0
data/app/controllers/quickening/application_controller.rb +4 -0
data/app/helpers/quickening/application_helper.rb +4 -0
data/app/views/layouts/quickening/application.html.erb +14 -0
data/config/routes.rb +2 -0
data/lib/quickening/engine.rb +16 -0
data/lib/quickening/model.rb +178 -0
data/lib/quickening/orm/active_record.rb +36 -0
data/lib/quickening/version.rb +5 -0
data/lib/quickening.rb +17 -0
data/lib/tasks/quickening_tasks.rake +8 -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/models/admin.rb +3 -0
data/spec/dummy/app/models/user.rb +6 -0
data/spec/dummy/app/views/layouts/application.html.erb +14 -0
data/spec/dummy/config/application.rb +65 -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 +37 -0
data/spec/dummy/config/environments/production.rb +67 -0
data/spec/dummy/config/environments/test.rb +38 -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 +4 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/migrate/20130302150624_create_users.rb +12 -0
data/spec/dummy/db/migrate/20130302153106_create_admins.rb +12 -0
data/spec/dummy/db/schema.rb +36 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/development.log +404 -0
data/spec/dummy/log/test.log +67550 -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/factories/admin_factory.rb +13 -0
data/spec/factories/user_factory.rb +13 -0
data/spec/quickening_spec.rb +309 -0
data/spec/spec_helper.rb +50 -0
data/spec/support/shared_examples.rb +156 -0
metadata +301 -0

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/factories/admin_factory.rb ADDED Viewed

@@ -0,0 +1,13 @@
+# encoding: utf-8
+FactoryGirl.define do
+  factory :admin do
+    email { Faker::Internet.email }
+    first_name { Faker::Name.first_name }
+    middle_name { Faker::Name.first_name }
+    last_name { Faker::Name.last_name }
+    birthdate '1985-01-29'
+  end
+end

data/spec/factories/user_factory.rb ADDED Viewed

@@ -0,0 +1,13 @@
+# encoding: utf-8
+FactoryGirl.define do
+  factory :user do
+    email { Faker::Internet.email }
+    first_name { Faker::Name.first_name }
+    middle_name { Faker::Name.first_name }
+    last_name { Faker::Name.last_name }
+    birthdate '1985-01-29'
+  end
+end

data/spec/quickening_spec.rb ADDED Viewed

@@ -0,0 +1,309 @@
+# encoding: utf-8
+require 'spec_helper'
+describe Quickening do
+  subject(:mod) { described_class }
+  it { should be_a Module }
+  describe Quickening::VERSION do
+    subject(:konstant) { Quickening::VERSION }
+    it { should be_a String }
+    it { should =~ /^(\d+\.){2,}\d+$/ }
+    it { should be > '0.0.0' }
+  end
+  describe Quickening::Model do
+    subject(:mod) { described_class }
+    it { should be_a Module }
+  end
+  describe Quickening::ORM::ActiveRecord do
+    subject(:mod) { described_class }
+    it { should be_a Module }
+  end
+end
+describe 'Dummy App' do
+  [Admin].each do |k|
+    describe k do
+      let(:klass) { k }
+      subject { klass }
+      its(:superclass) { should be ActiveRecord::Base }
+      it { should respond_to :quickening }
+      it { should_not include Quickening::Model }
+      it { should_not respond_to :duplicate_matchers }
+      it { should_not respond_to :duplicate_matchers= }
+      it { should_not respond_to :duplicate }
+      it { should_not respond_to :find_duplicates_for }
+      it 'does not make available the instance methods' do
+        [:duplicates, :_duplicate_conditions].each do |method|
+          klass.instance_methods.should_not include method
+        end
+      end
+      describe 'Instance thereof' do
+        subject(:user) { klass.new }
+        it { should be_a klass }
+        it { should be_a ActiveRecord::Base }
+        it { should_not be_a Quickening::Model }
+        it { should_not respond_to :duplicate_matchers }
+        it { should_not respond_to :duplicate_matchers= }
+        it { should_not respond_to :duplicates }
+      end
+    end
+  end
+  context 'when quickening is called in the class' do
+    let(:klass) { User }
+    describe 'the enabled class' do
+      subject { klass }
+      it { should respond_to :quickening }
+      it { should include Quickening::Model }
+      it { should respond_to :duplicate_matchers }
+      it { should respond_to :duplicate_matchers= }
+      it { should respond_to :duplicate }
+      its(:duplicate) { should respond_to :originals }
+      its(:duplicate) { should respond_to :copies }
+      it { should respond_to :find_duplicates_for }
+      it 'makes available the instance methods' do
+        [:duplicates, :_duplicate_conditions].each do |method|
+          klass.instance_methods.should include method
+        end
+      end
+      its(:duplicate_matchers) { should eq [:first_name, :last_name] }
+      describe 'Instance thereof' do
+        subject(:user) { klass.new }
+        it { should be_a klass }
+        it { should be_a ActiveRecord::Base }
+        it { should be_a Quickening::Model }
+        it { should respond_to :duplicate_matchers }
+        it { should_not respond_to :duplicate_matchers= }
+        it { should respond_to :duplicates }
+      end
+    end
+  end
+  let(:klass) { described_class }
+  let(:null_relation) { klass.limit(0) }
+  let(:mock_relation) { mock('Relation') }
+  let(:returned) {}
+  context 'when there are no duplicates' do
+    before(:all) do
+      User.delete_all
+      @users = 10.times.map { FactoryGirl.create(:user) }
+    end
+    after(:all) { User.delete_all }
+    describe User do
+      let(:user) { @users[0] }
+      subject { returned }
+      describe '.duplicate' do
+        include_context 'Proper .duplicate results'
+        it_behaves_like 'Empty relational collections'
+        describe '.originals' do
+          include_context 'Proper .originals results'
+          it_behaves_like 'Empty relational collections'
+        end
+        describe '.copies' do
+          include_context 'Proper .copies results'
+          it_behaves_like 'Empty relational collections'
+        end
+      end
+      describe '.find_duplicates_for' do
+        include_context 'Proper .find_duplicates_for results'
+        it_behaves_like 'Empty relational collections'
+      end
+      describe '#duplicates' do
+        include_context 'Proper #duplicates results'
+        it_behaves_like 'Empty relational collections'
+      end
+      describe '#_duplicate_conditions' do
+        include_context 'Proper #_duplicate_conditions results'
+      end
+    end
+  end
+  context 'when half are duplicates of the other half' do
+    before(:all) do
+      User.delete_all
+      @users1 = 5.times.map { FactoryGirl.create(:user) }
+      @users2 = @users1.map { |u| FactoryGirl.create(:user, first_name: u.first_name,
+                                                             last_name: u.last_name) }
+      @users = @users1 + @users2
+    end
+    after(:all) { User.delete_all }
+    describe User do
+      let(:user) { @users[0] }
+      subject { returned }
+      describe '.duplicate' do
+        include_context 'Proper .duplicate results'
+        it_behaves_like 'Empty relational collections'
+        context 'but this time, with force: true' do
+          let(:returned) { User.duplicate(force: true) }
+          it_behaves_like 'Non-empty relational collections'
+          it { should have(10).records }
+        end
+        describe '.originals' do
+          include_context 'Proper .originals results'
+          it_behaves_like 'Non-empty relational collections'
+          it { should have(5).records }
+          it 'is composed of records for which exactly one counterpart exists outside of this set' do
+            returned.each do |record|
+              dupe, * = dupes = record.duplicates
+              expect(dupes).to have(1).record
+              expect(dupe).not_to be_in returned
+              expect(dupe).to be_in User.duplicate.copies
+            end
+          end
+        end
+        describe '.copies' do
+          include_context 'Proper .copies results'
+          it_behaves_like 'Non-empty relational collections'
+          it { should have(5).records }
+          it 'is composed of records for which exactly one counterpart exists outside of this set' do
+            returned.each do |record|
+              dupe, * = dupes = record.duplicates
+              expect(dupes).to have(1).record
+              expect(dupe).not_to be_in returned
+              expect(dupe).to be_in User.duplicate.originals
+            end
+          end
+        end
+      end
+      describe '.find_duplicates_for' do
+        include_context 'Proper .find_duplicates_for results'
+        it_behaves_like 'Non-empty relational collections'
+        it { should have(1).record }
+        it { should_not include user }
+      end
+      describe '#duplicates' do
+        include_context 'Proper #duplicates results'
+        it_behaves_like 'Non-empty relational collections'
+        it { should have(1).record }
+        it { should_not include user }
+        its('first.duplicates') { should have(1).record }
+        its('first.duplicates.first') { should == user }
+      end
+      describe '#_duplicate_conditions' do
+        include_context 'Proper #_duplicate_conditions results'
+      end
+    end
+  end
+  context 'when there are 10 items, all a duplicate of one another' do
+    before(:all) do
+      User.delete_all
+      @users = FactoryGirl.create_list(:user, 10, first_name: 'John',
+                                                   last_name: 'Malkovich')
+    end
+    after(:all) { User.delete_all }
+    describe User do
+      let(:user) { @users[0] }
+      subject { returned }
+      describe '.duplicate' do
+        include_context 'Proper .duplicate results'
+        it_behaves_like 'Empty relational collections'
+        context 'but this time, with force: true' do
+          let(:returned) { User.duplicate(force: true) }
+          it_behaves_like 'Non-empty relational collections'
+          it { should have(10).records }
+        end
+        describe '.originals' do
+          include_context 'Proper .originals results'
+          it_behaves_like 'Non-empty relational collections'
+          it 'is composed of one record for which exactly nine counterparts exist outside of this set' do
+            returned.each do |record|
+              dupe, * = dupes = record.duplicates
+              expect(dupes).to have(9).records
+              expect(dupe).not_to be_in returned
+              expect(dupe).to be_in User.duplicate.copies
+            end
+          end
+        end
+        describe '.copies' do
+          include_context 'Proper .copies results'
+          it_behaves_like 'Non-empty relational collections'
+          it { should have(9).records }
+          it 'is composed of records for which exactly one counterpart exists outside of this set' do
+            returned.each do |record|
+              dupe, * = dupes = record.duplicates
+              expect(dupes).to have(9).records
+              expect(record).not_to be_in User.duplicate.originals
+            end
+          end
+        end
+      end
+      describe '.find_duplicates_for' do
+        include_context 'Proper .find_duplicates_for results'
+        it_behaves_like 'Non-empty relational collections'
+        it { should have(9).records }
+        it { should_not include user }
+      end
+      describe '#duplicates' do
+        include_context 'Proper #duplicates results'
+        it_behaves_like 'Non-empty relational collections'
+        it { should have(9).records }
+        it { should_not include user }
+        it 'contains records, each of which refer this record as one of its duplicates' do
+          returned.each do |record|
+            expect(record.duplicates).to have(9).records
+            expect(record.duplicates).to include user
+          end
+        end
+      end
+      describe '#_duplicate_conditions' do
+        include_context 'Proper #_duplicate_conditions results'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,50 @@
+# encoding: utf-8
+def setup_environment
+  ENV["RAILS_ENV"] ||= 'test'
+  require File.expand_path("../dummy/config/environment", __FILE__)
+  require 'rspec/rails'
+  require 'rspec/autorun'
+  require 'faker'
+  require 'factory_girl_rails'
+  # Rails.backtrace_cleaner.remove_silencers!
+  Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
+  RSpec.configure do |config|
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+    config.run_all_when_everything_filtered = true
+    config.filter_run :focus
+    config.mock_with :rspec
+    config.use_transactional_fixtures = true
+    config.infer_base_class_for_anonymous_controllers = true
+    config.order = "random"
+    config.fixture_path = "#{::Rails.root}/spec/fixtures"
+    config.include FactoryGirl::Syntax::Methods
+  end
+end
+def each_run
+end
+if(begin; require 'spork'; rescue LoadError; nil end).nil? || !Spork.using_spork?
+  # require 'simplecov'
+  setup_environment
+  each_run
+else
+  # require 'spork/ext/ruby-debug'
+  Spork.prefork do
+    ENV['DRB'] = 'true'
+    setup_environment
+    # ActiveSupport::Dependencies.clear
+  end
+  Spork.each_run do
+    # require 'simplecov'
+    each_run
+  end
+end

data/spec/support/shared_examples.rb ADDED Viewed

@@ -0,0 +1,156 @@
+# encoding: utf-8
+shared_examples 'Relational collections' do
+  specify { expect { returned }.not_to raise_error }
+  it { should be_a ActiveRecord::Relation }
+end
+shared_examples 'Empty relational collections' do
+  include_examples 'Relational collections'
+  it { should be_empty }
+end
+shared_examples 'Non-empty relational collections' do
+  include_examples 'Relational collections'
+  it { should_not be_empty }
+end
+shared_context 'Proper .duplicate results' do
+  let(:returned) { User.duplicate }
+  it 'only returns unique rows' do
+    expect(returned.to_sql).to match(/ DISTINCT/)
+  end
+  it 'returns the results in an ascending order by id' do
+    klass.stub_chain(:select, :uniq, :joins, :where) { mock_relation.as_null_object }
+    mock_relation.should_receive(:order).with(/id/) { null_relation }
+    returned
+  end
+  it 'limits the result size to 0 by default' do
+    klass.stub_chain(:select, :uniq, :joins, :where, :order) { mock_relation.as_null_object }
+    mock_relation.should_receive(:limit).with(0)
+    returned
+  end
+  context 'with force: true' do
+    subject(:returned) { klass.duplicate(force: true) }
+    it 'only returns unique rows' do
+      expect(returned.to_sql).to match(/ DISTINCT/)
+    end
+    it 'returns the results in an ascending order by id' do
+      klass.stub_chain(:select, :uniq, :joins, :where) { mock_relation.as_null_object }
+      mock_relation.should_receive(:order).with(/id/) { null_relation }
+      returned
+    end
+    it 'does not limit the result size to 0' do
+      klass.stub_chain(:select, :uniq, :joins, :where, :order) { mock_relation.as_null_object }
+      mock_relation.should_receive(:limit).with(nil)
+      returned
+    end
+  end
+end
+shared_examples 'Proper .originals results' do
+  subject(:returned) { klass.duplicate.originals }
+  it 'removes the default limit of 0' do
+    ActiveRecord::Relation.any_instance.should_receive(:except).with(:limit) { null_relation }
+    returned
+  end
+  it 'restricts the results to those which are the earliest created records' do
+    ActiveRecord::Relation.any_instance.should_receive(:except).with(:limit) { mock_relation.as_null_object }
+    mock_relation.stub(:where) do |arg|
+      sql = arg
+      expect(sql).to match(/HAVING.* MIN.*=/)
+    end
+    returned
+  end
+  it 'has no element for which even older duplicates can be found' do
+    returned.each do |original|
+      original.duplicates.each do |dupe|
+        dupe.id.should be > original.id
+      end
+    end
+  end
+end
+shared_context 'Proper .copies results' do
+  subject(:returned) { klass.duplicate.copies }
+  it 'removes the default limit of 0' do
+    ActiveRecord::Relation.any_instance.should_receive(:except).with(:limit) { null_relation }
+    returned
+  end
+  it 'restricts the results to those which are not the earliest created records' do
+    ActiveRecord::Relation.any_instance.should_receive(:except).with(:limit) { mock_relation.as_null_object }
+    # This tests things at too low a level; breaks everytime a tiny thing changes.
+    # mock_relation.stub(:where) do |arg|
+    #   sql = arg
+    #   expect(sql).to match(/ < /)
+    #   expect(sql).not_to match(/ > /)
+    # end
+    returned
+  end
+  it 'has no element for which a older duplicates canNOT be found' do
+    expect(returned).to satisfy do |copies|
+      (copies & klass.duplicate.originals).empty?
+    end
+  end
+end
+shared_context 'Proper .find_duplicates_for results' do
+  subject(:returned) { klass.find_duplicates_for(user) }
+  it 'utilizes the instance-level conditions helper' do
+    user.should_receive(:_duplicate_conditions) { :helper_return }
+    klass.should_receive(:where).with(:helper_return) { null_relation.as_null_object }
+    returned
+  end
+  it 'makes sure not to return the original item among results' do
+    klass.stub_chain(:where, :where) do |arg|
+      sql = arg
+      expect(sql).to match %r{ != }
+    end
+    returned
+  end
+end
+shared_context 'Proper #duplicates results' do
+  subject(:returned) { user.duplicates }
+  it 'calls the proxy class method' do
+    klass.should_receive(:find_duplicates_for).with(user)
+    returned
+  end
+end
+shared_context 'Proper #_duplicate_conditions results' do
+  subject(:returned) { user._duplicate_conditions }
+  it 'calls the class-level list of matcher attributes' do
+    user.should_receive(:duplicate_matchers).and_call_original
+    klass.should_receive(:duplicate_matchers) { [] }
+    returned
+  end
+  it 'iterates through matcher attributes to construct a key-val composition' do
+    Hash.should_receive(:[]).with(instance_of Array)
+    returned
+  end
+  it 'returns a hash composed of keys from the class-level list' do
+    expect(returned).to be_a Hash
+    expect(returned.keys).to eq klass.duplicate_matchers
+  end
+end