association_accessors 1.3.0

data/lib/association_accessors/test/matcher.rb

@@ -0,0 +1,60 @@
+module AssociationAccessors
+  module Test
+    def have_association_accessor_for association
+      Matcher.new association
+    end
+
+    class Matcher
+      attr_reader :failure_message, :subject, :association_name, :attribute, :association
+
+      def initialize association_name
+        @association_name = association_name
+      end
+
+      def description
+        "have association accessor for #{association_name.inspect} with attribute #{attribute.inspect}."
+      end
+
+      def matches? subject
+        @subject = subject
+        @association = get_association
+
+        check_attribute!
+
+        has_accessors?
+      end
+
+      def with_attribute attribute
+        @attribute = attribute
+        self
+      end
+
+
+      private
+
+        def get_association
+          subject.association(association_name)
+        end
+
+        def check_attribute!
+          raise ArgumentError, "'with_attribute' is required" if attribute.nil?
+        end
+
+        def has_accessors?
+          accessor_name =
+            if association.reflection.collection?
+              :"#{association_name.to_s.singularize}_#{attribute.to_s.pluralize}"
+            else
+              :"#{association_name}_#{attribute}"
+            end
+
+          if subject.respond_to?(accessor_name) && subject.respond_to?(:"#{accessor_name}=")
+            true
+          else
+            @failure_message = "reader and/or writer `#{accessor_name}` not defined on #{subject.class.name}."
+            false
+          end
+        end
+    end
+  end
+end

data/lib/association_accessors/version.rb

@@ -0,0 +1,3 @@
+module AssociationAccessors
+  VERSION = "1.3.0"
+end

data/spec/association_accessors_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe AssociationAccessors do
+  it "has a version number" do
+    expect(AssociationAccessors::VERSION).to eq '1.3.0'
+  end
+end

data/spec/dummy.rb

@@ -0,0 +1,99 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+ActiveRecord::Schema.define do
+  create_table :authors, force: true do |t|
+    t.string :serial
+  end
+
+  create_table :books, force: true do |t|
+    t.string :serial
+    t.integer :author_id
+  end
+
+  create_table :addresses, force: true do |t|
+    t.string :serial
+    t.integer :author_id
+  end
+
+  create_table :chapters, force: true do |t|
+    t.string :serial
+    t.integer :book_id
+  end
+
+  create_table :publishers, force: true do |t|
+    t.string :uuid
+  end
+
+  create_join_table :authors, :publishers
+
+  create_table :images, force: true do |t|
+    t.string :serial
+    t.string :imageable_type
+    t.integer :imageable_id
+  end
+end
+
+class Serialable < ActiveRecord::Base
+  include AssociationAccessors
+  self.abstract_class = true
+  before_create do
+    send :serial=, SecureRandom.urlsafe_base64
+  end
+end
+
+class Author < Serialable
+  has_many :books
+  association_accessor_for :books, with_attribute: :serial
+
+  has_one :address
+  association_accessor_for :address, with_attribute: :serial
+
+  has_many :chapters, through: :books
+  association_accessor_for :chapters, with_attribute: :serial
+
+  has_and_belongs_to_many :publishers
+  association_accessor_for :publishers, with_attribute: :uuid
+
+  has_one :image, as: :imageable
+  association_accessor_for :image, with_attribute: :serial
+end
+
+class Book < Serialable
+  OPTIONAL = ActiveRecord.gem_version.segments.first == 5 ? { optional: true } : {}
+
+  belongs_to :author, OPTIONAL
+  association_accessor_for :author, with_attribute: :serial
+
+  belongs_to :writer, { class_name: 'Author', foreign_key: :author_id }.merge(OPTIONAL)
+  association_accessor_for :writer, with_attribute: :serial
+
+  has_one :address, through: :author
+  association_accessor_for :address, with_attribute: :serial
+
+  has_many :images, as: :imageable
+  association_accessor_for :images, with_attribute: :serial
+
+  has_many :chapters
+end
+
+class Address < Serialable
+  belongs_to :author
+end
+
+class Chapter < Serialable
+  belongs_to :book
+end
+
+class Publisher < ActiveRecord::Base
+  has_and_belongs_to_many :authors
+  before_create do
+    send :uuid=, SecureRandom.uuid
+  end
+end
+
+class Image < Serialable
+  belongs_to :imageable, polymorphic: true
+  association_accessor_for :imageable, with_attribute: :serial
+end

data/spec/matcher_spec.rb

@@ -0,0 +1,56 @@
+RSpec.configure do |config|
+  config.include AssociationAccessors::Test
+
+  # only the matcher should be tested against older version of RSpec
+  config.filter_run matcher: true if RSPEC_MAJOR_VERSION == 2
+end
+
+RSpec.describe 'the test matcher', matcher: true do
+  subject { Author.new }
+
+  it 'raises ActiveRecord::AssociationNotFoundError if the association does not exist on subject.' do
+    expect {
+      should have_association_accessor_for(:book).with_attribute(:serial)
+    }.to raise_exception ActiveRecord::AssociationNotFoundError, /Association named 'book' was not found on Author/
+  end
+
+  it 'raises ArgumentError if `with_attribute` is blank.' do
+    expect {
+      should have_association_accessor_for(:books)
+    }.to raise_exception ArgumentError, /'with_attribute' is required/
+  end
+
+  describe 'for singular association' do
+    it 'fails if subject does not respond to the reader or writer `[association]_[attribute]`.' do
+      expect {
+        should have_association_accessor_for(:address).with_attribute(:uuid)
+      }.to raise_exception RSpec::Expectations::ExpectationNotMetError, /reader and\/or writer `address_uuid` not defined on Author/
+    end
+
+    it 'passes if subject responds to the reader and writer `[association]_[attribute]`.' do
+      should have_association_accessor_for(:address).with_attribute(:serial)
+      should have_association_accessor_for(:image).with_attribute(:serial)
+      expect(Book.new).to have_association_accessor_for(:author).with_attribute(:serial)
+    end
+  end
+
+  describe 'for collection association' do
+    it 'fails if subject does not respond to the reader or writer `[association_singular]_[attribute_plural]`.' do
+      expect {
+        should have_association_accessor_for(:chapters).with_attribute(:uuid)
+      }.to raise_exception RSpec::Expectations::ExpectationNotMetError, /reader and\/or writer `chapter_uuids` not defined on Author/
+    end
+
+    it 'passes if subject responds to the reader and writer `[association_singular]_[attribute_plural]`.' do
+      should have_association_accessor_for(:books).with_attribute(:serial)
+      should have_association_accessor_for(:chapters).with_attribute(:serial)
+      should have_association_accessor_for(:publishers).with_attribute(:uuid)
+      expect(Book.new).to have_association_accessor_for(:images).with_attribute(:serial)
+    end
+  end
+
+  it 'has a concise but expressive default output.' do
+    expect(have_association_accessor_for(:books).with_attribute(:serial).description)
+      .to eq 'have association accessor for :books with attribute :serial.'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require "bundler/setup"
+require "association_accessors"
+require 'dummy'
+
+RSPEC_MAJOR_VERSION = RSpec::Core::Version::STRING.split('.').first.to_i
+
+RSpec.configure do |config|
+  if RSPEC_MAJOR_VERSION == 3
+    # Enable flags like --only-failures and --next-failure
+    config.example_status_persistence_file_path = ".rspec_status"
+
+    # Disable RSpec exposing methods globally on `Module` and `main`
+    config.disable_monkey_patching!
+  end
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.filter_run_excluding activerecord: proc { |versions|
+    versions.none? { |version| ActiveRecord.gem_version.to_s.include? version }
+  }
+end

data/spec/with_association/belongs_to_spec.rb

@@ -0,0 +1,33 @@
+RSpec.describe 'for `belongs_to` association' do
+  let!(:author) { Author.create! }
+  let!(:book)   { Book.create! author: author }
+
+  it 'generates `#[association_name]_[attribute_name]` accessor.' do
+    expect(book).to respond_to :author_serial, :author_serial=
+  end
+
+  describe '`#[association_name]_[attribute_name]`' do
+    it 'returns the value of the `[attribute]` of the associated record if there is any.' do
+      expect { book.author = nil }.to change(book, :author_serial).from(author.serial).to nil
+    end
+  end
+
+  describe '`#[association_name]_[attribute_name]=(value)`' do
+    it 'sets the association value to nil if `value` is nil.' do
+      expect { book.author_serial = nil }.to change(book, :author).from(author).to nil
+    end
+
+    it 'sets the association value to the record queried by its `[attribute]` having the value `value` if such record exists.' do
+      new_author = Author.create!
+      expect { book.author_serial = new_author.serial }.to change(book, :author).from(author).to new_author
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if record with `[attribute]` = `value` does not exist.', activerecord: [ '4.1' ] do
+      expect { book.author_serial = author.serial.next }.to raise_exception ActiveRecord::RecordNotFound
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if record with `[attribute]` = `value` does not exist.', activerecord: [ '4.2', '5' ] do
+      expect { book.author_serial = author.serial.next }.to raise_exception ActiveRecord::RecordNotFound, "Couldn't find Author"
+    end
+  end
+end

data/spec/with_association/has_and_belongs_to_many_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe 'for `has_and_belongs_to_many` association' do
+  let!(:author_1)    { Author.create! }
+  let!(:author_2)    { Author.create! }
+  let!(:publisher_1) { Publisher.create! authors: [ author_1 ] }
+  let!(:publisher_2) { Publisher.create! authors: [ author_2 ] }
+
+  it 'generates `#[association_name.singularize]_[attribute_name.pluralize]` accessor.' do
+    expect(author_1).to respond_to :publisher_uuids, :publisher_uuids=
+  end
+
+  describe '`#[association_name.singularize]_[attribute_name.pluralize]`' do
+    it 'returns an array with the values of `[attribute]` of the associated records.' do
+      expect(author_1.publisher_uuids).to eq [ publisher_1.uuid ]
+      expect(author_2.publisher_uuids).to eq [ publisher_2.uuid ]
+    end
+  end
+
+  describe '`#[association_name.singularize]_[attribute_name.pluralize]`=(values)' do
+    it 'sets the association value to the records queried by `[attribute]` = `value` if all exist.' do
+      expect { author_1.publisher_uuids = [] }.to change { author_1.publishers.ids }.from([ publisher_1.id ]).to []
+      expect { author_2.publisher_uuids = [ publisher_1.uuid ] }.to change { author_2.publishers.ids }.from([ publisher_2.id ]).to [ publisher_1.id ]
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if any of the given `values` has no record.', activerecord: [ '4' ] do
+      expect { author_2.publisher_uuids = [ publisher_1.uuid, publisher_2.uuid.next ] }
+        .to raise_exception(ActiveRecord::RecordNotFound,
+      %{Couldn't find all Publishers with 'id': ("#{publisher_1.uuid}", "#{publisher_2.uuid.next}")} +
+      %{ (found 1 results, but was looking for 2)})
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if any of the given `values` has no record.', activerecord: [ '5.0', '5.1' ] do
+      expect { author_2.publisher_uuids = [ publisher_1.uuid, publisher_2.uuid.next ] }
+        .to raise_exception(ActiveRecord::RecordNotFound,
+      %{Couldn't find all Publishers with 'uuid': ("#{publisher_1.uuid}", "#{publisher_2.uuid.next}")} +
+      %{ (found 1 results, but was looking for 2)})
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if any of the given `values` has no record.', activerecord: [ '5.2' ] do
+      expect { author_2.publisher_uuids = [ publisher_1.uuid, publisher_2.uuid.next ] }
+        .to raise_exception(ActiveRecord::RecordNotFound,
+      %{Couldn't find all Publishers with 'uuid': ("#{publisher_1.uuid}", "#{publisher_2.uuid.next}")} +
+      %{ (found 1 results, but was looking for 2). Couldn't find Publisher with uuid "#{publisher_2.uuid.next}".})
+    end
+  end
+end

data/spec/with_association/has_many_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe 'for `has_many` association' do
+  let!(:author_1) { Author.create! }
+  let!(:author_2) { Author.create! }
+  let!(:book_1)   { Book.create! author: author_1 }
+  let!(:book_2)   { Book.create! author: author_1 }
+
+  it 'generates `#[association_name.singularize]_[attribute_name.pluralize]` accessor.' do
+    expect(author_1).to respond_to :book_serials, :book_serials=
+  end
+
+  describe '`#[association_name.singularize]_[attribute_name.pluralize]`' do
+    it 'returns an array with the values of `[attribute]` of the associated records.' do
+      expect(author_1.book_serials).to match_array [ book_1.serial, book_2.serial ]
+      expect(author_2.book_serials).to eq []
+    end
+  end
+
+  describe '`#[association_name.singularize]_[attribute_name.pluralize]`=(values)' do
+    it 'sets the association value to the records queried by `[attribute]` = `value` if all exist.' do
+      expect { author_1.book_serials = [] }.to change { author_1.books.ids }.from([ book_1.id, book_2.id ]).to []
+      expect { author_2.book_serials = [ book_1.serial ] }.to change { author_2.books.ids }.from([]).to [ book_1.id ]
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if any of the given `values` has no record.', activerecord: [ '4' ] do
+      expect { author_2.book_serials = [ book_1.serial, book_2.serial.next ] }
+        .to raise_exception(ActiveRecord::RecordNotFound,
+      %{Couldn't find all Books with 'id': ("#{book_1.serial}", "#{book_2.serial.next}")} +
+      %{ (found 1 results, but was looking for 2)})
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if any of the given `values` has no record.', activerecord: [ '5.0', '5.1' ] do
+      expect { author_2.book_serials = [ book_1.serial, book_2.serial.next ] }
+        .to raise_exception(ActiveRecord::RecordNotFound,
+      %{Couldn't find all Books with 'serial': ("#{book_1.serial}", "#{book_2.serial.next}")} +
+      %{ (found 1 results, but was looking for 2)})
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if any of the given `values` has no record.', activerecord: [ '5.2' ] do
+      expect { author_2.book_serials = [ book_1.serial, book_2.serial.next ] }
+        .to raise_exception(ActiveRecord::RecordNotFound,
+      %{Couldn't find all Books with 'serial': ("#{book_1.serial}", "#{book_2.serial.next}")} +
+      %{ (found 1 results, but was looking for 2). Couldn't find Book with serial "#{book_2.serial.next}".})
+    end
+  end
+end

data/spec/with_association/has_many_through_spec.rb

@@ -0,0 +1,27 @@
+RSpec.describe 'for `has_many through:` association' do
+  let!(:author_1)  { Author.create! }
+  let!(:author_2)  { Author.create! }
+  let!(:book_1)    { Book.create! author: author_1 }
+  let!(:book_2)    { Book.create! author: author_2 }
+  let!(:chapter_1) { Chapter.create! book: book_1 }
+  let!(:chapter_2) { Chapter.create! book: book_2 }
+
+  it 'generates `#[association_name.singularize]_[attribute_name.pluralize]` accessor.' do
+    expect(author_1).to respond_to :chapter_serials, :chapter_serials=
+  end
+
+  describe '`#[association_name.singularize]_[attribute_name.pluralize]`' do
+    it 'returns an array with the values of `[attribute]` of the associated records.' do
+      expect(author_1.chapter_serials).to eq [ chapter_1.serial ]
+      expect(author_2.chapter_serials).to eq [ chapter_2.serial ]
+    end
+  end
+
+  describe '`#[association_name.singularize]_[attribute_name.pluralize]`=(values)' do
+    it 'raises ActiveRecord::HasManyThroughCantAssociateThroughHasOneOrManyReflection.' do
+      expect { author_1.chapter_serials = [] }
+        .to raise_exception(ActiveRecord::HasManyThroughCantAssociateThroughHasOneOrManyReflection,
+      %{Cannot modify association 'Author#chapters' because the source reflection class 'Chapter' is associated to 'Book' via :has_many.})
+    end
+  end
+end

data/spec/with_association/has_one_spec.rb

@@ -0,0 +1,33 @@
+RSpec.describe 'for `has_one` association' do
+  let!(:author)  { Author.create! }
+  let!(:address) { Address.create! author: author }
+
+  it 'generates `#[association_name]_[attribute_name]` accessor.' do
+    expect(author).to respond_to :address_serial, :address_serial=
+  end
+
+  describe '`#[association_name]_[attribute_name]`' do
+    it 'returns the value of the `[attribute]` of the associated record if there is any.' do
+      expect { author.address = nil }.to change(author, :address_serial).from(address.serial).to nil
+    end
+  end
+
+  describe '`#[association_name]_[attribute_name]=(value)`' do
+    it 'sets the association value to nil if `value` is nil.' do
+      expect { author.address_serial = nil }.to change(author, :address).from(address).to nil
+    end
+
+    it 'sets the association value to the record queried by its `[attribute]` having the value `value` if such record exists.' do
+      new_address = Address.create!
+      expect { author.address_serial = new_address.serial }.to change(author, :address).from(address).to new_address
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if record with `[attribute]` = `value` does not exist.', activerecord: [ '4.1' ] do
+      expect { author.address_serial = address.serial.next }.to raise_exception ActiveRecord::RecordNotFound
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if record with `[attribute]` = `value` does not exist.', activerecord: [ '4.2', '5' ] do
+      expect { author.address_serial = address.serial.next }.to raise_exception ActiveRecord::RecordNotFound, "Couldn't find Address"
+    end
+  end
+end