association_accessors 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 427e524e67a28002e3e0b010c7536c410597d3d23bdfbb8dd8375743124b4251
+  data.tar.gz: ec24e909df781cdd00d70035451aaec6420617827fa8244531faf2381b09633c
+SHA512:
+  metadata.gz: b787c454deb6947cd9f71f8fc7f710024dadebb8587e9ef6da762ca2124b463ef16e03c6b99897f09e28f9489bb3ca2166290d6e63cec81c9b27b8271da9f4d5
+  data.tar.gz: dae9c1963ff3c53f2aca2081b41b23e0a22d0e3b05a3ac63ed9363a4ca4631d8291a691880c9bdcd931fd54f77ba093f13f556662a7ec3985f08f35e78b3ca4b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Appraisals

@@ -0,0 +1,25 @@
+if RUBY_VERSION < '2.4'
+  appraise 'activerecord-4.1' do
+    gem 'activerecord', '4.1.7'
+  end
+end
+
+appraise 'activerecord-4.2' do
+  gem 'activerecord', '4.2.0'
+end
+
+appraise 'activerecord-5.0' do
+  gem 'activerecord', '5.0.3'
+end
+
+appraise 'activerecord-5.1' do
+  gem 'activerecord', '5.1.5'
+end
+
+appraise 'activerecord-5.2' do
+  gem 'activerecord', '5.2.2'
+end
+
+appraise 'rspec-2' do
+  gem 'rspec', '~> 2.0'
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in association_accessors.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Szijjártó Nagy Misu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,254 @@
+# AssociationAccessors
+
+**association_accessors** is a tool for generating accessors for `ActiveRecord` model associations based on columns other than the `id` (primary key).
+
+## Dependencies
+
+* **ruby** `'>=2.3'`
+* **activerecord** `'>=4.1', '<6.0'`
+* **rspec** `'>= 2.0'` (for the test matcher)
+
+## Table of Contents
+
+* [AssociationAccessors](#associationaccessors)
+  * [Dependencies](#dependencies)
+  * [Table of Contents](#table-of-contents)
+  * [The Challenge](#the-challenge)
+  * [Installation](#installation)
+  * [Config](#config)
+  * [Usage](#usage)
+    * [With belongs_to](#with-belongs_to)
+    * [With has_one](#with-has_one)
+    * [With has_many](#with-has_many)
+    * [With has_and_belongs_to_many](#with-has_and_belongs_to_many)
+    * [With custom association names](#with-custom-association-names)
+    * [With polymorphic associations](#with-polymorphic-associations)
+  * [Test matcher](#test-matcher)
+  * [Contributing](#contributing)
+  * [Development](#development)
+  * [License](#license)
+
+## The Challenge
+
+You have the following tables:
+
+```ruby
+ActiveRecord::Schema.define do
+  create_table :companies, force: true do |t|
+    t.string :serial
+    t.string :name
+    # ...
+  end
+
+  create_table :users, force: true do |t|
+    t.string :serial
+    t.integer :company_id
+    t.string :name
+    # ...
+  end
+end
+```
+
+For security reasons it is decided that the frontend must not see the `id`s, only the `serial`s. So, when you want to change the company of a user, `params` will contain something like this:
+
+```ruby
+# <ActionController::Parameters { "serial": "9jco5RMp4K", "user": { company_serial: "MbyDB18lCi" } } permitted: false>
+```
+
+Now, if the `User` model has `#company_serial=` method, you can simply permit `:company_serial`.
+
+Using **association_accessors** it amounts to this:
+
+```ruby
+class User < ActiveRecord::Base
+  include AssociationAccessors
+
+  belongs_to :company
+  association_accessor_for :company, with_attribute: :serial
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'association_accessors'
+```
+
+And then execute:
+
+    $ bundle
+
+## Config
+
+It is possible to set a default value for the keyword `with_attribute:`, for example in an initializer:
+
+```ruby
+# config/initializers/association_accessors.rb
+AssociationAccessors.default_attribute = :serial
+```
+
+## Usage
+
+1. include the module `AssociationAccessors`.
+2. define the associations
+3. call `.association_accessor_for` method with the association name and the identifier attribute to generate the accessor methods:
+    * for singular associations it will generate a reader and a writer along the rule `[association_name]_[attribute_name]`
+    * for collection associations it will generate the methods along the rule `[singular_association_name]_[plural_attribute_name]`
+
+These accessors work more or less the same way as the `id` accessors generated by default for the associations.
+
+There are a few exceptions and some gotchas, though.
+
+### With `belongs_to`
+
+```ruby
+# AssociationAccessors is included in the ApplicationRecord
+class User < ApplicationRecord
+  belongs_to :company, optional: true # only to demonstrate that it works with the association `nil`
+  association_accessor_for :company, with_attribute: :serial
+end
+```
+
+You have the methods `#company_id` and `#company_id=` because of the foreign key column. `association_accessors` generates the methods `#company_serial` and `#company_serial=`.
+
+These work in a similar way with the following differences:
+* `#company_id` is a column, `#company_serial` is a computed value (the `serial` of the `company`) - where `#company_id` can return value other than `nil` even without really having a `company`, `#company_serial` can only return the `serial` of the `company` (if any)
+* `#company_id=` does not break if there is no company with the given id, only `#company` will return `nil` - whereas calling `#company_serial=` with a not existing serial will raise `ActiveRecord::RecordNotFound`
+
+  ```ruby
+  user.company          # => #<Company id: 10, serial: "HVuPpK">
+  user.company_id       # => 10
+  user.company_serial   # => "HVuPpK"
+
+  user.company_id = 100 # there is no company with id=100
+  user.company          # => nil
+  user.company_id       # => 100
+  user.company_serial   # => nil
+
+  user.company_serial = 'EeNRM'
+  # ActiveRecord::RecordNotFound (Couldn't find Company)
+  ```
+
+### With `has_one`
+
+```ruby
+class User < ApplicationRecord
+  has_one :address
+  association_accessor_for :address, with_attribute: :serial
+end
+```
+
+There is no `#address_id` or `#address_id=` method for a `has_one` association. The generated methods (`#address_serial`, `#address_serial=`) behave the following way:
+* `#address_serial` returns the `serial` of the `address` if any
+* `#address_serial=`
+  * changes the `user_id` column of the `adress`(es) setting it to `null` or to the `id` of the user as required
+  * raises `ActiveRecord::RecordNotFound` if the given `serial` does not exist
+  * raises `ActiveRecord::HasOneThroughCantAssociateThroughHasOneOrManyReflection` if association is defined with `through:` option
+
+### With `has_many`
+
+```ruby
+class Company < ApplicationRecord
+  has_many :users
+  association_accessor_for :users, with_attribute: :serial
+end
+```
+
+The generated methods (`#user_serials` and `#user_serials=`) will behave exactly the same way the [`collection_singular_ids`](https://guides.rubyonrails.org/association_basics.html#methods-added-by-has-many) accessor generated by `rails`:
+* `#user_ids` will return the `id`s of the `users` - `#user_serials` will return the `serial`s of the `users`
+* `#user_ids=` and `#user_serials=` will both
+  * update the `company_id` column of the users: setting it to `null` or to the `id` of the company as required
+  * raise `ActiveRecord::RecordNotFound` if any of the given `id`s or `serial`s is non-existing
+  * raise `ActiveRecord::HasManyThroughCantAssociateThroughHasOneOrManyReflection` if association is defined with `:through` option
+
+### With `has_and_belongs_to_many`
+
+```ruby
+class User < ApplicationRecord
+  has_and_belongs_to_many :tasks
+  association_accessor_for :tasks, with_attribute: :serial
+end
+```
+
+The generated methods (`#task_serials` and `#task_serials=`) will behave exactly the same way the [`collection_singular_ids`](https://guides.rubyonrails.org/association_basics.html#methods-added-by-has-and-belongs-to-many) accessor generated by `rails`:
+* `#task_ids` will return the `id`s of the `tasks` - `#task_serials` will return the `serial`s of the `tasks`
+* `#task_ids=` and `#task_serials=` will both
+  * update the join table adding or deleting records as required
+  * raise `ActiveRecord::RecordNotFound` if any of the given `id`s or `serial`s is non-existing
+
+### With custom association names
+
+```ruby
+class Node < ApplicationRecord
+  belongs_to :parent, class_name: 'Node'
+  association_accessor_for :parent, with_attribute: :serial
+
+  has_many :children, class_name: 'Node', foreign_key: :parent_id
+  association_accessor_for :children, with_attribute: :serial
+end
+```
+
+The generated methods (`#parent_serial`, `#parent_serial=`, `#child_serials` and `#child_serials=`) work the same way, as they rely on the association, not the column.
+
+### With polymorphic associations
+
+```ruby
+class User < ApplicationRecord
+  has_one :image, as: :imageable
+  association_accessor_for :image, with_attribute: :serial
+end
+
+class Task < ApplicationRecord
+  has_many :images, as: :imageable
+  association_accessor_for :images, with_attribute: :serial
+end
+
+class Image < ApplicationRecord
+  belongs_to :imageable, polymorphic: true
+end
+```
+
+* The `has_one` and `has_many` parts work just fine, setting the `imageable_type` and `imageable_id` to `nil` or the class name and the `id` of the required record
+* It is **not** recommended to use `association_accessors` for the `belongs_to` part of polymorphic associations, as the associated class is derived from the actual value of `[association_name]_type` column, causing unpredictable behavior and raising `NoMethodError` when it is `nil`
+
+## Test matcher
+
+**association_accessors** ships a test matcher too: `#have_association_accessor_for`. It surely works with [rspec](https://relishapp.com/rspec).
+
+```ruby
+RSpec.configure do |config|
+  config.include AssociationAccessors::Test, type: :model
+end
+
+RSpec.describe User, type: :model do
+  it { should have_association_accessor_for(:company).with_attribute(:serial) }
+end
+```
+
+So far, it checks if the reader and writer methods are defined on the subject, nothing more.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SzNagyMisu/association_accessors.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To test against other `activerecord` or `rspec` versions, check the `./Appraisals` file and choose one:
+
+    $ bundle exec appraisal activerecord-5.0 bin/console
+    $ bundle exec appraisal activerecord-5.0 rspec
+
+To run a full test suite (including multiple ruby, activerecord and rspec versions), run:
+
+    $ rake full_test
+    $ RUBY_VERSIONS=2.5.3,2.6.1 rake full_test
+
+Setting the environment variable `RUBY_VERSIONS` overrides the default (`2.3.7`, `2.4.1`, `2.5.1`) ruby versions to test against. Note that while the ruby versions must be installed for the test to run, the gems are handled by [appraisal](https://github.com/thoughtbot/appraisal).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+DEFAULT_RUBY_VERSIONS = [ '2.3.7', '2.4.1', '2.5.1' ].freeze
+
+desc "Test against multiple ruby, activerecord and rspec versions - " +
+  "set RUBY_VERSIONS to the version(s) to test with (default: #{DEFAULT_RUBY_VERSIONS.join(',').inspect})"
+task :full_test do
+  versions = ENV['RUBY_VERSIONS'] ? ENV['RUBY_VERSIONS'].split(',') : DEFAULT_RUBY_VERSIONS
+  started_at = Time.now
+
+  versions.each do |version|
+    sh "./bin/test #{version}"
+  end
+
+  time_elapsed = (Time.now - started_at).to_i
+  hours = time_elapsed / 3600
+  minutes = time_elapsed / 60 % 60
+  seconds = time_elapsed % 60
+  puts "\nTest suit complete\n" +
+    "  ruby versions: #{versions.join(', ')}\n" +
+    "  run in #{hours}h #{minutes}m #{seconds}s\n"
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/association_accessors.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "association_accessors/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "association_accessors"
+  spec.version       = AssociationAccessors::VERSION
+  spec.authors       = ["Szijjártó Nagy Misu"]
+  spec.email         = ["szijjartonagy.misu@gmail.com"]
+
+  spec.summary       = 'Handling AR associations with other attributes than primary key'
+  spec.description   = 'Provides association accessors like `Company#user_serials` and `User#company_serial` where `Company.has_many :users` and `User.belongs_to :company`.'
+  spec.homepage      = 'https://github.com/SzNagyMisu/association_accessors'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"]    = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -- lib/*`.split("\n") + %w[ README.md LICENSE.txt association_accessors.gemspec ]
+  spec.test_files    = `git ls-files -- gemfiles/* spec/*`.split("\n") + %w[ Appraisals Gemfile Rakefile .rspec bin/test ]
+  spec.bindir        = "bin"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "activerecord", "~> 5.2"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "appraisal", "~> 2.2"
+end

data/bin/test

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -e
+
+if [ $1 ]; then
+  # see https://rvm.io/workflow/scripting
+  if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
+    source "$HOME/.rvm/scripts/rvm"
+  elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
+    source "/usr/local/rvm/scripts/rvm"
+  else
+    printf "ERROR: An RVM installation was not found."
+  fi
+  rvm use $1
+fi
+
+bundle install
+bundle exec appraisal install
+bundle exec appraisal rspec
+
+echo 'Success!'

data/gemfiles/activerecord_4.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "4.1.7"
+
+gemspec path: "../"

data/gemfiles/activerecord_4.1.gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: ..
+  specs:
+    association_accessors (1.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.7)
+      activesupport (= 4.1.7)
+      builder (~> 3.1)
+    activerecord (4.1.7)
+      activemodel (= 4.1.7)
+      activesupport (= 4.1.7)
+      arel (~> 5.0.0)
+    activesupport (4.1.7)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (5.0.1.20140414130214)
+    builder (3.2.3)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    json (1.8.6)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 4.1.7)
+  appraisal (~> 2.2)
+  association_accessors!
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3 (~> 1.3)
+
+BUNDLED WITH
+   1.16.6