association_accessors 1.3.0

data/spec/with_association/has_one_through_spec.rb

@@ -0,0 +1,43 @@
+RSpec.describe 'for `has_one :through` association' do
+  let!(:author)  { Author.create! }
+  let!(:book)    { author.books.create! }
+  let!(:address) { author.create_address! }
+
+  it 'generates `#[association_name]_[attribute_name]` accessor.' do
+    expect(book).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 { book.address = nil }.to change(book, :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 { book.address_serial = nil }.to change(book, :address).from(address).to nil
+    end
+
+    it 'raises ActiveRecord::HasManyThroughCantAssociateThroughHasOneOrManyReflection.', activerecord: [ '4' ] do
+      new_address = Address.create!
+      expect { book.address_serial = new_address.serial }
+        .to raise_exception(ActiveRecord::HasManyThroughCantAssociateThroughHasOneOrManyReflection,
+      %{Cannot modify association 'Book#address' because the source reflection class 'Address' is associated to 'Author' via :has_one.})
+    end
+
+    it 'raises ActiveRecord::HasOneThroughCantAssociateThroughHasOneOrManyReflection.', activerecord: [ '5' ] do
+      new_address = Address.create!
+      expect { book.address_serial = new_address.serial }
+        .to raise_exception(ActiveRecord::HasOneThroughCantAssociateThroughHasOneOrManyReflection,
+      %{Cannot modify association 'Book#address' because the source reflection class 'Address' is associated to 'Author' via :has_one.})
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if record with `[attribute]` = `value` does not exist.', activerecord: [ '4.1' ] do
+      expect { book.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 { book.address_serial = address.serial.next }.to raise_exception ActiveRecord::RecordNotFound, "Couldn't find Address"
+    end
+  end
+end

data/spec/with_association/polymorphic/belongs_to_spec.rb

@@ -0,0 +1,38 @@
+RSpec.describe 'for polymorphic `belongs_to` association' do
+  let!(:author) { Author.create! }
+  let!(:image)  { author.create_image! }
+
+  it 'generates `#[association_name]_[attribute_name]` accessor.' do
+    expect(image).to respond_to :imageable_serial, :imageable_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 { image.imageable = nil }.to change(image, :imageable_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 { image.imageable_serial = nil }.to change(image, :imageable).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 { image.imageable_serial = new_author.serial }.to change(image, :imageable).from(author).to new_author
+    end
+
+    it 'raises NoMethodError if `[association_name]_type` is not set.' do
+      image.imageable = nil
+      expect { image.imageable_serial = author.serial }.to raise_exception NoMethodError, %{undefined method `find_by!' for nil:NilClass}
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if record with `[attribute]` = `value` does not exist.', activerecord: [ '4.1' ] do
+      expect { image.imageable_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 { image.imageable_serial = author.serial.next }.to raise_exception ActiveRecord::RecordNotFound, "Couldn't find Author"
+    end
+  end
+end

data/spec/with_association/polymorphic/has_many_spec.rb

@@ -0,0 +1,44 @@
+RSpec.describe 'for polymorphic `has_many` association' do
+  let!(:book)    { Book.create! }
+  let!(:image_1) { book.images.create! }
+  let!(:image_2) { book.images.create! }
+
+  it 'generates `#[association_name.singularize]_[attribute_name.pluralize]` accessor.' do
+    expect(book).to respond_to :image_serials, :image_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(book.image_serials).to match_array [ image_1.serial, image_2.serial ]
+      expect { book.images = [] }.to change(book, :image_serials).to []
+    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 { book.image_serials = [] }.to change { book.images.ids }.from([ image_1.id, image_2.id ]).to []
+      expect { book.image_serials = [ image_1.serial ] }.to change { book.images.ids }.from([]).to [ image_1.id ]
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if any of the given `values` has no record.', activerecord: [ '4' ] do
+      expect { book.image_serials = [ image_1.serial, image_2.serial.next ] }
+        .to raise_exception(ActiveRecord::RecordNotFound,
+      %{Couldn't find all Images with 'id': ("#{image_1.serial}", "#{image_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 { book.image_serials = [ image_1.serial, image_2.serial.next ] }
+        .to raise_exception(ActiveRecord::RecordNotFound,
+      %{Couldn't find all Images with 'serial': ("#{image_1.serial}", "#{image_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 { book.image_serials = [ image_1.serial, image_2.serial.next ] }
+        .to raise_exception(ActiveRecord::RecordNotFound,
+      %{Couldn't find all Images with 'serial': ("#{image_1.serial}", "#{image_2.serial.next}")} +
+      %{ (found 1 results, but was looking for 2). Couldn't find Image with serial "#{image_2.serial.next}".})
+    end
+  end
+end

data/spec/with_association/polymorphic/has_one_spec.rb

@@ -0,0 +1,33 @@
+RSpec.describe 'for polymorphic `has_one` association' do
+  let!(:author) { Author.create! }
+  let!(:image)  { author.create_image! }
+
+  it 'generates `#[association_name]_[attribute_name]` accessor.' do
+    expect(author).to respond_to :image_serial, :image_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.image = nil }.to change(author, :image_serial).from(image.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.image_serial = nil }.to change(author, :image).from(image).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_image = Image.create!
+      expect { author.image_serial = new_image.serial }.to change(author, :image).from(image).to new_image
+    end
+
+    it 'raises ActiveRecord::RecordNotFound if record with `[attribute]` = `value` does not exist.', activerecord: [ '4.1' ] do
+      expect { author.image_serial = image.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.image_serial = image.serial.next }.to raise_exception ActiveRecord::RecordNotFound, "Couldn't find Image"
+    end
+  end
+end

data/spec/with_association/with_custom_name_spec.rb

@@ -0,0 +1,33 @@
+RSpec.describe 'for association with custom name' do
+  let!(:author) { Author.create! }
+  let!(:book)   { Book.create! author: author }
+
+  it 'generates `#[association_name]_[attribute_name]` accessor.' do
+    expect(book).to respond_to :writer_serial, :writer_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, :writer_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.writer_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.writer_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.writer_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.writer_serial = author.serial.next }.to raise_exception ActiveRecord::RecordNotFound, "Couldn't find Author"
+    end
+  end
+end

data/spec/with_attribute_spec.rb

@@ -0,0 +1,47 @@
+RSpec.describe 'the `with_attribute:` key' do
+  context 'if default is not set' do
+    it 'cannot be nil.' do
+      expect { Book.association_accessor_for :chapters }
+        .to raise_exception ArgumentError, 'missing keyword: with_attribute'
+    end
+
+    it 'can be a string.' do
+      expect(Book.new).not_to respond_to :chapter_serials, :chapter_serials=
+      expect { Book.association_accessor_for :chapters, with_attribute: 'serial' }.not_to raise_exception
+      expect(Book.new).to respond_to :chapter_serials, :chapter_serials=
+    end
+
+    it 'can be a symbol.' do
+      expect(Book.new).not_to respond_to :chapter_uuids, :chapter_uuids=
+      expect { Book.association_accessor_for :chapters, with_attribute: :uuid }.not_to raise_exception
+      expect(Book.new).to respond_to :chapter_uuids, :chapter_uuids=
+    end
+  end
+
+  context 'if default is set' do
+    before :all do
+      AssociationAccessors.default_attribute = :serial
+    end
+    after :all do
+      AssociationAccessors.default_attribute = nil
+    end
+
+    it 'can be nil, and default will be used.' do
+      expect(Address.new).not_to respond_to :author_serial, :author_serial=
+      expect { Address.association_accessor_for :author }.not_to raise_exception
+      expect(Address.new).to respond_to :author_serial, :author_serial=
+    end
+
+    it 'can be string to override default' do
+      expect(Address.new).not_to respond_to :author_uuid, :author_uuid=
+      expect { Address.association_accessor_for :author, with_attribute: 'uuid' }.not_to raise_exception
+      expect(Address.new).to respond_to :author_uuid, :author_uuid=
+    end
+
+    it 'can be symbol to override default' do
+      expect(Address.new).not_to respond_to :author_guuid, :author_guuid=
+      expect { Address.association_accessor_for :author, with_attribute: :guuid }.not_to raise_exception
+      expect(Address.new).to respond_to :author_guuid, :author_guuid=
+    end
+  end
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: association_accessors
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Szijjártó Nagy Misu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: Provides association accessors like `Company#user_serials` and `User#company_serial`
+  where `Company.has_many :users` and `User.belongs_to :company`.
+email:
+- szijjartonagy.misu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- association_accessors.gemspec
+- bin/test
+- gemfiles/activerecord_4.1.gemfile
+- gemfiles/activerecord_4.1.gemfile.lock
+- gemfiles/activerecord_4.2.gemfile
+- gemfiles/activerecord_4.2.gemfile.lock
+- gemfiles/activerecord_5.0.gemfile
+- gemfiles/activerecord_5.0.gemfile.lock
+- gemfiles/activerecord_5.1.gemfile
+- gemfiles/activerecord_5.1.gemfile.lock
+- gemfiles/activerecord_5.2.gemfile
+- gemfiles/activerecord_5.2.gemfile.lock
+- gemfiles/rspec_2.gemfile
+- gemfiles/rspec_2.gemfile.lock
+- lib/association_accessors.rb
+- lib/association_accessors/collection_association.rb
+- lib/association_accessors/singular_association.rb
+- lib/association_accessors/test/matcher.rb
+- lib/association_accessors/version.rb
+- spec/association_accessors_spec.rb
+- spec/dummy.rb
+- spec/matcher_spec.rb
+- spec/spec_helper.rb
+- spec/with_association/belongs_to_spec.rb
+- spec/with_association/has_and_belongs_to_many_spec.rb
+- spec/with_association/has_many_spec.rb
+- spec/with_association/has_many_through_spec.rb
+- spec/with_association/has_one_spec.rb
+- spec/with_association/has_one_through_spec.rb
+- spec/with_association/polymorphic/belongs_to_spec.rb
+- spec/with_association/polymorphic/has_many_spec.rb
+- spec/with_association/polymorphic/has_one_spec.rb
+- spec/with_association/with_custom_name_spec.rb
+- spec/with_attribute_spec.rb
+homepage: https://github.com/SzNagyMisu/association_accessors
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SzNagyMisu/association_accessors
+  source_code_uri: https://github.com/SzNagyMisu/association_accessors
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Handling AR associations with other attributes than primary key
+test_files:
+- gemfiles/activerecord_4.1.gemfile
+- gemfiles/activerecord_4.1.gemfile.lock
+- gemfiles/activerecord_4.2.gemfile
+- gemfiles/activerecord_4.2.gemfile.lock
+- gemfiles/activerecord_5.0.gemfile
+- gemfiles/activerecord_5.0.gemfile.lock
+- gemfiles/activerecord_5.1.gemfile
+- gemfiles/activerecord_5.1.gemfile.lock
+- gemfiles/activerecord_5.2.gemfile
+- gemfiles/activerecord_5.2.gemfile.lock
+- gemfiles/rspec_2.gemfile
+- gemfiles/rspec_2.gemfile.lock
+- spec/association_accessors_spec.rb
+- spec/dummy.rb
+- spec/matcher_spec.rb
+- spec/spec_helper.rb
+- spec/with_association/belongs_to_spec.rb
+- spec/with_association/has_and_belongs_to_many_spec.rb
+- spec/with_association/has_many_spec.rb
+- spec/with_association/has_many_through_spec.rb
+- spec/with_association/has_one_spec.rb
+- spec/with_association/has_one_through_spec.rb
+- spec/with_association/polymorphic/belongs_to_spec.rb
+- spec/with_association/polymorphic/has_many_spec.rb
+- spec/with_association/polymorphic/has_one_spec.rb
+- spec/with_association/with_custom_name_spec.rb
+- spec/with_attribute_spec.rb
+- Appraisals
+- Gemfile
+- Rakefile
+- ".rspec"
+- bin/test