activerecord-chemistry 0.1.0

data/lib/activerecord/chemistry/representable/relation.rb

@@ -0,0 +1,49 @@
+require 'activerecord/chemistry/representable/instance_methods'
+require 'activerecord/chemistry/representable/class_methods'
+
+module ActiveRecord
+  module Chemistry
+    module Representable
+      module Relation
+        extend ActiveSupport::Concern
+
+        included do
+        end
+
+        class_methods do
+          def represents(name, scope = nil, options = {})
+            if Hash === scope
+              options = scope
+              scope = nil
+            end
+            reflections = belongs_to(name, scope, options)
+            default_scope -> { includes(name) }
+            validate :representable_must_be_valid
+            
+            before_validation :find_by_or_keep_representable, on: :create
+            before_validation :update_or_instantiate_representable, on: :update
+
+            after_destroy do
+              representing.destroy if representing && representing.send(representing_model.representable_reflection.name).count == 0 && !representing.destroyed?
+            end
+
+            cattr_reader(:representing_reflection) { reflections.stringify_keys[name.to_s] }
+            cattr_reader(:representing_model) { (options[:class_name] || name.to_s.camelize).constantize }
+            class_eval "def #{name}; super || build_#{name}(representing_model.representable_reflection.name => [self]); end"
+            alias_method :representing, name
+            alias_method :representing=, "#{name}=".to_sym
+            include Representable::InstanceMethods
+            singleton_class.module_eval do
+              include Representable::ClassMethods
+            end
+          end
+
+          def representable(name, scope = nil, options = {})
+            reflections = has_many(name, scope, options.merge(dependent: :destroy))
+            cattr_reader(:representable_reflection) { reflections.stringify_keys[name.to_s] }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord/chemistry/representable.rb

@@ -0,0 +1,11 @@
+require 'activerecord/chemistry/representable/migration'
+require 'activerecord/chemistry/representable/relation'
+
+module ActiveRecord
+  module Chemistry
+    module Representable
+      include ActiveRecord::Chemistry::Representable::Migration
+      include ActiveRecord::Chemistry::Representable::Relation
+    end
+  end
+end

data/lib/activerecord/chemistry/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Chemistry
+    VERSION = "0.1.0"
+  end
+end

data/lib/activerecord/chemistry.rb

@@ -0,0 +1,30 @@
+require 'active_support'
+require 'active_record'
+require 'activerecord/chemistry/version'
+require 'activerecord/chemistry/actable'
+require 'activerecord/chemistry/extendable'
+require 'activerecord/chemistry/representable'
+
+module ActiveRecord
+  class Base
+    include ActiveRecord::Chemistry::Actable::Relation
+    include ActiveRecord::Chemistry::Extendable::Relation
+    include ActiveRecord::Chemistry::Representable::Relation
+  end
+
+  module ConnectionAdapters
+    class TableDefinition
+      include ActiveRecord::Chemistry::Actable::Migration::TableDefinition
+      include ActiveRecord::Chemistry::Extendable::Migration::TableDefinition
+      include ActiveRecord::Chemistry::Representable::Migration::TableDefinition
+    end
+  end
+
+  module ConnectionAdapters
+    class Table
+      include ActiveRecord::Chemistry::Actable::Migration::Table
+      include ActiveRecord::Chemistry::Extendable::Migration::Table
+      include ActiveRecord::Chemistry::Representable::Migration::Table
+    end
+  end
+end

data/spec/actable/actable_spec.rb

@@ -0,0 +1,5 @@
+require 'models'
+
+RSpec.describe "ActiveRecord::Base subclass with #actable" do
+  subject { Person }
+end

data/spec/actable/acts_as_spec.rb

@@ -0,0 +1,63 @@
+require 'models'
+
+RSpec.describe "ActiveRecord::Base subclass with #acts_as" do
+  before { initialize_schema }
+
+  context 'new' do
+    let(:user) { create(:user) }
+    it 'is valid with valid attributes for actable' do
+      expect(user).to be_valid
+    end
+
+    it 'is not valid with invalid actable attributes' do
+      user.slug = 2
+      expect(user).to_not be_valid
+    end
+  end
+
+  context 'create' do
+    let(:user) { create(:user, slug: 'username') }
+    context 'without existing actable' do
+      it 'creates a new actable object' do
+        expect(user.acting_as).to be
+        expect(user.acting_as).to be_a(Person)
+        expect(user.acting_as.slug).to eq('username')
+      end
+    end
+    context 'with existing actable' do
+      before { @person = create(:person, slug: 'username') }
+      it 'creates a new actable object' do
+        expect(user.acting_as).to be
+        expect(user.acting_as).to be_a(Person)
+        expect(user.acting_as.slug).to eq('username')
+        expect(user.acting_as).not_to eq(@person)
+      end
+    end
+  end
+
+  context 'destroy' do
+    before do
+      @user = create(:user, slug: 'username')
+      @person = @user.acting_as
+      @user.destroy
+    end
+
+    it 'destroys the actable object' do
+      expect(@user).to be_destroyed
+      expect(@person).to be_destroyed
+    end
+  end
+
+  context 'update' do
+    before do
+      @user = create(:user, slug: 'username')
+      @person = @user.acting_as
+      @user.update_attributes(slug: 'newname')
+    end
+
+    it 'changes the actable object' do
+      expect(@user.slug).to eq('newname')
+      expect(@person.slug).to eq('newname')
+    end
+  end
+end

data/spec/database_helper.rb

@@ -0,0 +1,26 @@
+require 'active_record'
+
+def connect_to_database
+  ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+end
+
+def clear_database
+  ActiveRecord::Base.descendants.each do |model|
+    model.delete_all if model.table_exists?
+  end
+end
+
+def reset_database
+  ActiveRecord::Base.descendants.map(&:reset_column_information)
+  ActiveRecord::Base.connection.disconnect!
+  connect_to_database
+end
+
+def initialize_database(&block)
+  reset_database
+  ActiveRecord::Schema.define(&block)
+end
+
+I18n.enforce_available_locales = false
+ActiveRecord::Migration.verbose = false
+connect_to_database

data/spec/extendable/extendable_by_spec.rb

@@ -0,0 +1,5 @@
+require 'models'
+
+RSpec.describe "ActiveRecord::Base subclass with #extendable_by" do
+  subject { Email }
+end

data/spec/extendable/extends_spec.rb

@@ -0,0 +1,63 @@
+require 'models'
+
+RSpec.describe "ActiveRecord::Base subclass with #extends" do
+  before { initialize_schema }
+
+  context 'new' do
+    let(:confirmable) { create(:confirmable) }
+    it 'is valid with valid attributes for extendable' do
+      expect(confirmable).to be_valid
+    end
+
+    it 'is not valid with invalid extendable attributes' do
+      confirmable.address = 2
+      expect(confirmable).to_not be_valid
+    end
+  end
+
+  context 'create' do
+    let(:confirmable) { create(:confirmable, address: 'test@email.com') }
+    context 'without existing extendable' do
+      it 'creates a new extendable object' do
+        expect(confirmable.extendable).to be
+        expect(confirmable.extendable).to be_a(Email)
+        expect(confirmable.extendable.address).to eq('test@email.com')
+      end
+    end
+    context 'with existing extendable' do
+      before { @email = create(:email, address: 'test@email.com') }
+      it 'creates a new extendable object' do
+        expect(confirmable.extendable).to be
+        expect(confirmable.extendable).to be_a(Email)
+        expect(confirmable.extendable.address).to eq('test@email.com')
+        expect(confirmable.extendable).not_to eq(@email)
+      end
+    end
+  end
+
+  context 'destroy' do
+    before do
+      @confirmable = create(:confirmable, address: 'test@email.com')
+      @email = @confirmable.extendable
+      @confirmable.destroy
+    end
+
+    it 'does not destroy the extendable object' do
+      expect(@confirmable).to be_destroyed
+      expect(@email).to_not be_destroyed
+    end
+  end
+
+  context 'update' do
+    before do
+      @confirmable = create(:confirmable, address: 'test@email.com')
+      @email = @confirmable.extendable
+      @confirmable.update_attributes(address: 'newname')
+    end
+
+    it 'changes the extendable object' do
+      expect(@confirmable.address).to eq('newname')
+      expect(@email.address).to eq('newname')
+    end
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,22 @@
+FactoryGirl.define do
+  factory :person do
+  end
+
+  factory :user do
+    slug 'username'
+  end
+
+  factory :personal_name do
+  end
+
+  factory :display_name do
+    appellation 'John Doe'
+  end
+
+  factory :confirmable do
+    address 'test@email.com'
+  end
+
+  factory :email do
+  end
+end

data/spec/migrations_spec.rb

@@ -0,0 +1,128 @@
+require 'database_helper'
+require 'activerecord/chemistry'
+
+class User < ActiveRecord::Base
+end
+
+class DisplayName < ActiveRecord::Base
+end
+
+class Email < ActiveRecord::Base
+end
+
+class RemoveActsAsFromUsers < ActiveRecord::Migration[5.1]
+  def change
+    change_table :users do |t|
+      t.remove_acts_as :person
+    end
+  end
+end
+
+class RemoveRepresentsFromDisplayNames < ActiveRecord::Migration[5.1]
+  def change
+    change_table :display_names do |t|
+      t.remove_represents :personal_name
+    end
+  end
+end
+
+class RemoveExtendedByFromEmails < ActiveRecord::Migration[5.1]
+  def change
+    change_table :emails do |t|
+      t.remove_extended_by :confirmable
+    end
+  end
+end
+
+RSpec.describe ".acts_as" do
+  context "in .create_table block" do
+    # after { initialize_schema }
+
+    it "creates reference columns with given names" do
+      initialize_database do
+        create_table(:people) { |t| t.string :name }
+        create_table(:users) { |t| t.acts_as :person }
+      end
+      expect(User.column_names).to include('person_id')
+    end
+  end
+end
+
+RSpec.describe ".remove_acts_as" do
+  context 'in .modify_table block' do
+    before do
+      initialize_database do
+        create_table(:people) { |t| t.string :name }
+        create_table(:users) { |t| t.acts_as :person }
+      end
+    end
+    it 'removes reference columns with given names' do
+      migration = RemoveActsAsFromUsers.new
+      migration.exec_migration(ActiveRecord::Base.connection, :up)
+      User.reset_column_information
+      expect(User.column_names).not_to include('person_id')
+    end
+  end
+end
+
+RSpec.describe ".represents" do
+  context "in .create_table block" do
+    # after { initialize_schema }
+
+    it "creates reference columns with given names" do
+      initialize_database do
+        create_table(:personal_names) { |t| t.string :name }
+        create_table(:display_names) { |t| t.represents :personal_name }
+      end
+      expect(DisplayName.column_names).to include('personal_name_id')
+    end
+  end
+end
+
+RSpec.describe ".remove_represents" do
+  context 'in .modify_table block' do
+    before do
+      initialize_database do
+        create_table(:personal_names) { |t| t.string :name }
+        create_table(:display_names) { |t| t.represents :personal_name }
+      end
+    end
+    it 'removes reference columns with given names' do
+      migration = RemoveRepresentsFromDisplayNames.new
+      migration.exec_migration(ActiveRecord::Base.connection, :up)
+      DisplayName.reset_column_information
+      expect(DisplayName.column_names).not_to include('personal_name_id')
+    end
+  end
+end
+
+RSpec.describe ".extended_by" do
+  context "in .create_table block" do
+    # after { initialize_schema }
+
+    it "creates reference columns with given names" do
+      initialize_database do
+        create_table(:confirmables) { |t| t.string :name }
+        create_table(:emails) { |t| t.extended_by :confirmable }
+      end
+      expect(Email.column_names).to include('confirmable_id')
+    end
+  end
+end
+
+RSpec.describe ".remove_extended_by" do
+  context 'in .modify_table block' do
+    before do
+      initialize_database do
+        create_table(:confirmables) { |t| t.string :name }
+        create_table(:emails) { |t| t.extended_by :confirmable }
+      end
+    end
+    it 'removes reference columns with given names' do
+      migration = RemoveExtendedByFromEmails.new
+      migration.exec_migration(ActiveRecord::Base.connection, :up)
+      Email.reset_column_information
+      expect(Email.column_names).not_to include('confirmable_id')
+    end
+  end
+end

data/spec/models.rb

@@ -0,0 +1,56 @@
+require_relative 'database_helper'
+
+require 'activerecord/chemistry'
+
+class Person < ActiveRecord::Base
+  actable :user
+  validates_format_of :slug, with: /\A[a-z]+\z/i
+end
+
+class User < ActiveRecord::Base
+  acts_as :person
+end
+
+class PersonalName < ActiveRecord::Base
+  representable :display_names
+  validates_format_of :appellation, with: /\A[a-z ]+\z/i
+end
+
+class DisplayName < ActiveRecord::Base
+  represents :personal_name
+end
+
+class Email < ActiveRecord::Base
+  extendable_by :confirmable
+  validates_format_of :address, with: /@/
+end
+
+class Confirmable < ActiveRecord::Base
+  extends :email
+end
+
+def initialize_schema
+  initialize_database do
+    create_table :people do |t|
+      t.string :slug
+      t.timestamps null: true
+    end
+    create_table :users do |t|
+      t.acts_as :person
+    end
+    create_table :personal_names do |t|
+      t.string :appellation 
+      t.timestamps null: true
+    end
+    create_table :display_names do |t|
+      t.represents :personal_name
+    end
+    create_table :confirmables do |t|
+    end
+    create_table :emails do |t|
+      t.string :address
+      t.extended_by :confirmable
+      t.timestamps null: true
+    end
+  end
+end

data/spec/representable/representable_spec.rb

@@ -0,0 +1,5 @@
+require 'models'
+
+RSpec.describe "ActiveRecord::Base subclass with #representable" do
+  subject { PersonalName }
+end

data/spec/representable/represents_spec.rb

@@ -0,0 +1,91 @@
+require 'models'
+
+RSpec.describe "ActiveRecord::Base subclass with #represents" do
+  before { initialize_schema }
+
+  context 'new' do
+    let(:display_name) { create(:display_name) }
+    it 'is valid with valid attributes for representable' do
+      expect(display_name).to be_valid
+    end
+
+    it 'is not valid with invalid representable attributes' do
+      display_name.appellation = 2
+      expect(display_name).to_not be_valid
+    end
+  end
+
+  context 'create' do
+    let(:display_name) { create(:display_name, appellation: 'John Doe') }
+    context 'without existing representable' do
+      it 'creates a new representable object' do
+        expect(display_name.representing).to be
+        expect(display_name.representing).to be_a(PersonalName)
+        expect(display_name.representing.appellation).to eq('John Doe')
+      end
+    end
+    context 'with existing representable' do
+      before { @personal_name = create(:personal_name, appellation: 'John Doe') }
+      it 'associates with existing representable object' do
+        expect(display_name.representing).to be
+        expect(display_name.representing).to be_a(PersonalName)
+        expect(display_name.representing.appellation).to eq('John Doe')
+        expect(display_name.representing).to eq(@personal_name)
+      end
+    end
+  end
+
+  context 'destroy' do
+    before do
+      @display_name = create(:display_name, appellation: 'John Doe')
+      @personal_name = @display_name.representing
+    end
+
+    context 'with no other representatives' do
+      before { @display_name.destroy }
+      it 'destroys the representable object' do
+        expect(@display_name).to be_destroyed
+        expect(@personal_name).to be_destroyed
+      end
+    end
+
+    context 'with other representatives' do
+      before do
+        create(:display_name, appellation: 'John Doe')
+        @display_name.destroy
+      end
+      it 'does not destroy the representable object' do
+        expect(@display_name).to be_destroyed
+        expect(@personal_name).to_not be_destroyed
+      end
+    end
+  end
+
+  context 'update' do
+    before do
+      @display_name = create(:display_name, appellation: 'John Doe')
+      @personal_name = @display_name.representing
+    end
+
+    context 'with no other representatives' do
+      before { @display_name.update_attributes(appellation: 'Dave Jones') }
+      it 'changes the representable object' do
+        expect(@display_name.appellation).to eq('Dave Jones')
+        expect(@personal_name.appellation).to eq('Dave Jones')
+      end
+    end
+
+    context 'with other representatives' do
+      before do
+        create(:display_name, appellation: 'John Doe')
+        @display_name.update_attributes(appellation: 'Dave Jones')
+      end
+      it 'does not change the representable object' do
+        expect(@display_name.appellation).to eq('Dave Jones')
+        @personal_name.reload
+        expect(@personal_name.appellation).to_not eq('Dave Jones')
+        expect(@personal_name.appellation).to eq('John Doe')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+require 'simplecov'
+
+require 'coveralls'
+# Coveralls.wear!
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter 'spec/'
+end
+
+require 'factory_girl'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.include FactoryGirl::Syntax::Methods
+
+  config.before(:suite) do
+    FactoryGirl.find_definitions
+  end
+end
+
+require 'active_record'
+if ActiveRecord::Base.respond_to?(:raise_in_transactional_callbacks=)
+  ActiveRecord::Base.raise_in_transactional_callbacks = true
+end
+