accepts_nested_ids 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17cafe27c546d2cba99337b3fe75a190805c048a
+  data.tar.gz: ccc40cfda5235a83e9ecc0cc036e5a01d809462b
+SHA512:
+  metadata.gz: fb214073171ad689b195d39c159eed73555ed42080a84726b53863790a6e535a4f8c666605884dc802b76b25a388ea36bda61b01e9d7bb39e35cd311f3cf6ee0
+  data.tar.gz: c02d8406d6aa4dc8ce0f4e532b9cd9799b66a7c1f5c1556773c31397c9808a089f6fcc2b8ac3c78a4c050d2cdcb4eb5a954e2c7727bbbf959cbed3d8499381c8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in accepts_nested_ids.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Little Blimp Ltd.
+
+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,129 @@
+# AcceptsNestedIds
+
+## Conundrum:
+
+You want to save associations (`has_many` or `has_many :through`) by ID, but Rails is totally not doing what you expect it to.
+
+## Solution:
+
+This gem.
+
+## What the hell am I talking about?
+
+Let's take a typical scenario.
+
+```ruby
+class Project < ActiveRecord::Base
+  has_many :project_users
+  has_many :users, through: :project_users
+  validates :name, presence: true
+end
+
+class User < ActiveRecord::Base
+  has_many :project_users
+  has_many :projects, through: :project_users
+end
+```
+
+When creating or updating a Project, you can select a list of User IDs from a select list. Great.
+
+```ruby
+project = Project.first
+project.name = ""
+project.user_ids = [1,2,3]
+project.save!
+```
+
+Oh shit.
+
+Thats right: Rails went ahead and associated those Users, even through the save failed. Because it didn't even wait until the `save!` to associate them. It happened right here: `project.user_ids = [1,2,3]`
+
+No one wants this. But it happens all the time.
+
+## Get to the point already
+
+AcceptsNestedIds defers the saving of ID-based associations to a model's `after_save` callback. In the example above, no User associations would have been created when using this gem.
+
+## Bonus
+
+Ever need audit trail functionality? Its easy, using ActiveModel::Dirty and its related methods (`changes?`, etc). However, what you won't get out-of-the-box is dirty tracking for associated attributes. Because why would you?
+
+AcceptsNestedIds adds dirty tracking for ID-based associations:
+
+```ruby
+project = Project.first
+project.user_ids = [1,2,3]
+project.changes # => "user_ids" => [[], [1,2,3]]
+```
+
+Beauty.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'accepts_nested_ids'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install accepts_nested_ids
+
+## Usage
+
+### When your association is conventionally named:
+
+```ruby
+class Project < ActiveRecord::Base
+  include AcceptsNestedIds
+  has_many :project_users
+  has_many :users, through: :project_users
+  accepts_nested_ids_for :users
+end
+```
+
+### When your association has a custom name:
+
+```ruby
+class Project < ActiveRecord::Base
+  include AcceptsNestedIds
+  has_many :project_users
+  has_many :included_users, through: :project_users, source: :user
+  accepts_nested_ids_for included_users: "User"
+end
+```
+
+### Mix and match as desired:
+
+```ruby
+class Project < ActiveRecord::Base
+  include AcceptsNestedIds
+  has_many :documents
+  has_many :project_users
+  has_many :included_users, through: :project_users, source: :user
+  accepts_nested_ids_for :documents, included_users: "User"
+end
+```
+
+You can now comfortably set `document_ids` or `user_ids` on a `Project` without making a mess of things.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/uberllama/accepts_nested_ids.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/accepts_nested_ids.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'accepts_nested_ids/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "accepts_nested_ids"
+  spec.version       = AcceptsNestedIds::VERSION
+  spec.authors       = ["Yuval Kordov", "Little Blimp"]
+  spec.email         = ["yuval@littleblimp.com"]
+  spec.summary       = "Predictable nesting of associations via ID"
+  spec.description   = "Defers saving of nested associations by ID, and adds dirty tracking of said associations to parent model"
+  spec.homepage      = "http://github.com/uberllama/accepts_nested_ids"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "activesupport", ">= 3.0.0"
+  spec.add_development_dependency "activerecord", ">= 4.2.3"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "accepts_nested_ids"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/accepts_nested_ids/version.rb

@@ -0,0 +1,3 @@
+module AcceptsNestedIds
+  VERSION = "0.1.0"
+end

data/lib/accepts_nested_ids.rb

@@ -0,0 +1,135 @@
+require "accepts_nested_ids/version"
+require "active_support/concern"
+require "active_support/core_ext/string/inflections"
+
+# Allows a model to accept nested association IDs as an attribute.
+# Normally these associations would be immediately saved, even if
+# the parent model transaction failed. This class defers saving to
+# after_save, and also provides dirty attribute tracking on the
+# parent model.
+#
+module AcceptsNestedIds
+  extend ActiveSupport::Concern
+
+    included do
+      after_save :save_nested_id_associations
+    end
+
+    # Defered association setter
+    #
+    # @example Method definition
+    #   if @document_ids
+    #     self.documents = Document.where(id: document_ids)
+    #   end
+    #
+    def save_nested_id_associations
+      self.class.nested_id_associations.each do |nested_id_association|
+        if instance_variable_get("@#{nested_id_association.ids_attr}")
+          association_class = nested_id_association.class_name.constantize
+          ids               = send(nested_id_association.ids_attr)
+          send("#{nested_id_association.attr}=", association_class.where(id: ids))
+        end
+      end
+    end
+
+    module ClassMethods
+
+      # Simple object that contains information about a nested ID association
+      #
+      # @param attr [Symbol]       association attribute (ex: :documents)
+      # @param ids_attr [String]   ids association attribute (ex: 'document_ids')
+      # @param class_name [String] association class name (ex: 'Document')
+      class NestedIdAssociation < Struct.new(:attr, :ids_attr, :class_name); end
+
+      # Sets up defered save and dirty tracking for the specified associations
+      #
+      # @example When class_name can be inferred from association name
+      #   include AcceptsNestedIds
+      #   accepts_nested_ids_for :documents, :carrier_companies
+      #
+      # @example When class_name is different from association name
+      #   include AcceptsNestedIds
+      #   accepts_nested_ids_for :documents, included_carrier_companies: "CarrierCompany"
+      #
+      # @param args [Array]
+      def accepts_nested_ids_for(*args)
+        @_nested_id_associations = map_nested_id_associations(*args)
+
+        nested_id_associations.each do |nested_id_association|
+
+          # Define ids_attr getter
+          #
+          # @example Method definition
+          #   def document_ids
+          #     @document_ids || (documents.loaded? ? documents.map(&:id) : documents.pluck(:id))
+          #   end
+          #
+          define_method("#{nested_id_association.ids_attr}") do
+            association = send(nested_id_association.attr)
+            instance_variable_get("@#{nested_id_association.ids_attr}") ||
+              (association.loaded? ? association.map(&:id) : association.pluck(:id))
+          end
+
+          # Define ids_attr setter
+          #
+          # @example Method definition
+          #   def document_ids=(value)
+          #     return if document_ids == value
+          #     attribute_will_change!('document_ids')
+          #     @document_ids = value
+          #   end
+          #
+          define_method("#{nested_id_association.ids_attr}=") do |value|
+            return if send(nested_id_association.ids_attr) == value
+            attribute_will_change!(nested_id_association.ids_attr)
+            instance_variable_set("@#{nested_id_association.ids_attr}", value)
+          end
+
+        end
+      end
+
+      def nested_id_associations
+        @_nested_id_associations
+      end
+
+      private
+
+      # Map module args into array of NestedIdAssociation objects with supporting properties
+      #
+      # @example
+      #   accepts_nested_ids_for :documents, included_carrier_companies: "CarrierCompany"
+      #   =>
+      #   [
+      #     { attr: :documents:, ids_attr: "document_ids", class_name: "Document"},
+      #     { attr: :included_carrier_companies, ids_attr: "included_carrier_company_ids", class_name: "CarrierCompany" }
+      #   ]
+      #
+      # @param args [Array]
+      # @return [Array]
+      def map_nested_id_associations(*args)
+        args.inject([]) do |array, arg|
+          if arg.is_a?(Hash)
+            attr        = arg.keys.first
+            ids_attr    = get_ids_attr(attr)
+            class_name  = arg[attr]
+          else
+            attr        = arg
+            ids_attr    = get_ids_attr(attr)
+            class_name  = arg.to_s.classify
+          end
+          array << NestedIdAssociation.new(attr, ids_attr, class_name)
+          array
+        end
+      end
+
+      # @example
+      #   get_ids_attr(:documents) => "document_ids"
+      #
+      # @param attr [Symbol] Association attribute name
+      # @return [String]
+      def get_ids_attr(attr)
+        "#{attr.to_s.singularize}_ids"
+      end
+
+    end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: accepts_nested_ids
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuval Kordov
+- Little Blimp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Defers saving of nested associations by ID, and adds dirty tracking of
+  said associations to parent model
+email:
+- yuval@littleblimp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- accepts_nested_ids.gemspec
+- bin/console
+- bin/setup
+- lib/accepts_nested_ids.rb
+- lib/accepts_nested_ids/version.rb
+homepage: http://github.com/uberllama/accepts_nested_ids
+licenses:
+- MIT
+metadata: {}
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Predictable nesting of associations via ID
+test_files: []