nested_store_attributes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: 77ec0ac6acc18a674c3943d7e3aff59c10e8f8b2
+  data.tar.gz: 23c9447ceca1d84c635e3dcc59d05a58c8387ba0
+SHA512:
+  metadata.gz: 24efa0ff30e400a89957e6fb79134fe6320da481c0ba0930226d059f85fa3f548015318889db5816881278dbd3411ea707ac6772260a9146d8bfb569c739e92d
+  data.tar.gz: c2395cbe5c420d0a905994578dbacdb137c5973ae885a5d4beb590f9ca243bc4cb63b0b6213abb885b2078a36398aeca480f3b4c593fb45ef04a112a3c565bec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= NestedStoreAttributes
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NestedStoreAttributes'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/nested_store_attributes.rb

@@ -0,0 +1,3 @@
+require 'nested_store_attributes/accepts_store_attributes'
+module NestedStoreAttributes
+end

data/lib/nested_store_attributes/accepts_store_attributes.rb

@@ -0,0 +1,248 @@
+require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/object/try'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module NestedStoreAttributes
+  module AcceptsStoreAttributes #:nodoc:
+    class TooManyRecords < ActiveRecord::ActiveRecordError
+    end
+
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :store_attributes_options, instance_writer: false
+      self.store_attributes_options = {}
+    end
+
+    module ClassMethods
+      REJECT_ALL_BLANK_PROC = proc { |attributes| attributes.all? { |key, value| key == '_destroy' || value.blank? } }
+
+      # Defines an attributes writer for the specified serialized attribute(s).
+      #
+      # Supported options:
+      # [:allow_destroy]
+      #   If true, destroys any members from the attributes hash with a
+      #   <tt>_destroy</tt> key and a value that evaluates to +true+
+      #   (eg. 1, '1', true, or 'true'). This option is off by default.
+      # [:reject_if]
+      #   Allows you to specify a Proc or a Symbol pointing to a method
+      #   that checks whether a record should be built for a certain attribute
+      #   hash. The hash is passed to the supplied Proc or the method
+      #   and it should return either +true+ or +false+. When no :reject_if
+      #   is specified, a record will be built for all attribute hashes that
+      #   do not have a <tt>_destroy</tt> value that evaluates to true.
+      #   Passing <tt>:all_blank</tt> instead of a Proc will create a proc
+      #   that will reject a record where all the attributes are blank excluding
+      #   any value for _destroy.
+      # [:limit]
+      #   Allows you to specify the maximum number of the nested records that
+      #   can be processed with the nested attributes. Limit also can be specified as a
+      #   Proc or a Symbol pointing to a method that should return number. If the size of the
+      #   nested attributes array exceeds the specified limit, NestedAttributes::TooManyRecords
+      #   exception is raised. If omitted, any number nested records can be processed.
+      # [:primary_key]
+      #   Allows you to specify the primary key to use when checking for existing objects. This
+      #   defaults to :id.
+      #
+      # Examples:
+      #   # creates subscribers_attributes=
+      #   accepts_store_attributes_for :subscribers, primary_key: :email
+      #   # creates books_attributes=
+      #   accepts_store_attributes_for :books, reject_if: proc { |attributes| attributes['name'].blank? }
+      #   # creates books_attributes=
+      #   accepts_store_attributes_for :books, reject_if: :all_blank
+      #   # creates books_attributes= and posts_attributes=
+      #   accepts_store_attributes_for :books, :posts, allow_destroy: true
+      def accepts_store_attributes_for(*attr_names)
+        options = { :allow_destroy => false, :update_only => false, :primary_key => :id }
+        options.update(attr_names.extract_options!)
+        options.assert_valid_keys(:allow_destroy, :reject_if, :limit, :update_only, :primary_key)
+        options[:reject_if] = REJECT_ALL_BLANK_PROC if options[:reject_if] == :all_blank
+
+        attr_names.each do |attribute_name|
+          if self.attribute_names.include?(attribute_name.to_s)
+
+            store_attributes_options = self.store_attributes_options.dup
+            store_attributes_options[attribute_name] = options
+            self.store_attributes_options = store_attributes_options
+
+            store_generate_collection_writer(attribute_name)
+          else
+            raise ArgumentError, "No column found for name `#{attribute_name}'. Has it been added yet?"
+          end
+        end
+      end
+
+      private
+
+      # Generates a writer method for this attribute. Serves as a point for
+      # accessing the hashes in the attribute. For example, this method
+      # could generate the following:
+      #
+      #   def pirate_attributes=(attributes)
+      #     store_assign_nested_attributes_for_collection_association(:pirate, attributes)
+      #   end
+      #
+      # This redirects the attempts to write objects in an association through
+      # the helper methods defined below. Makes it seem like the nested
+      # associations are just regular associations.
+      def store_generate_collection_writer(attribute_name)
+        generated_association_methods.module_eval <<-eoruby, __FILE__, __LINE__ + 1
+          if method_defined?(:#{attribute_name}_attributes=)
+            remove_method(:#{attribute_name}_attributes=)
+          end
+          def #{attribute_name}_attributes=(attributes)
+            store_assign_nested_attributes_for_collection(:#{attribute_name}, attributes)
+          end
+        eoruby
+      end
+    end
+
+    def _destroy
+      nil?
+    end
+
+    private
+
+    # Attribute hash keys that should not be assigned as normal attributes.
+    # These hash keys are nested attributes implementation details.
+    UNASSIGNABLE_KEYS = %w( id _destroy )
+
+
+    # Assigns the given attributes to the collection attribute.
+    #
+    # Hashes with an primary_key (by default <tt>:id</tt>) value matching an existing nested record
+    # will update that record. Hashes without an primary_key value will build
+    # a new record for the association. Hashes with a matching primary_key
+    # value and a <tt>:_destroy</tt> key set to a truthy value will mark the
+    # matched record for destruction.
+    #
+    # For example:
+    #
+    #   store_assign_nested_attributes_for_collection_association(:people, {
+    #     '1' => { id: '1', name: 'Peter' },
+    #     '2' => { name: 'John' },
+    #     '3' => { id: '2', _destroy: true }
+    #   })
+    #
+    # Will update the name of the Person with ID 1, add a new record for
+    # person with the name 'John', and remove the Person with ID 2.
+    #
+    # Also accepts an Array of attribute hashes:
+    #
+    #   store_assign_nested_attributes_for_collection_association(:people, [
+    #     { id: '1', name: 'Peter' },
+    #     { name: 'John' },
+    #     { id: '2', _destroy: true }
+    #   ])
+    def store_assign_nested_attributes_for_collection(attribute_name, attributes_collection)
+      options = self.store_attributes_options[attribute_name]
+
+      unless attributes_collection.is_a?(Hash) || attributes_collection.is_a?(Array)
+        raise ArgumentError, "Hash or Array expected, got #{attributes_collection.class.name} (#{attributes_collection.inspect})"
+      end
+
+      store_check_record_limit!(options[:limit], attributes_collection)
+      primary_key = options[:primary_key].to_s
+      new_collection = []
+
+      if attributes_collection.is_a? Hash
+        keys = attributes_collection.keys
+        attributes_collection = if keys.include?(primary_key) || keys.include?(primary_key.to_sym)
+          [attributes_collection]
+        else
+          attributes_collection.values
+        end
+      end
+
+      existing_records = self.send(attribute_name) || []
+      existing_records.map!(&:with_indifferent_access)
+
+      attributes_collection.each do |attributes|
+        attributes = attributes.with_indifferent_access
+  
+        if attributes[primary_key].present? && existing_record = existing_records.delete_at(existing_records.index { |record| record[primary_key].to_s == attributes[primary_key].to_s } || existing_records.length)
+          unless store_call_reject_if(attribute_name, attributes)
+            new_collection << store_add_or_destroy(existing_record, attributes, options[:allow_destroy])
+          end
+        else
+          unless store_reject_new_record?(attribute_name, attributes)
+            new_collection << attributes.except(*UNASSIGNABLE_KEYS)
+          end
+        end
+      end
+      
+      new_collection += existing_records
+      new_collection.reject!(&:nil?)
+      self.assign_attributes(attribute_name => new_collection)
+    end
+
+    # Takes in a limit and checks if the attributes_collection has too many
+    # records. It accepts limit in the form of symbol, proc, or
+    # number-like object (anything that can be compared with an integer).
+    #
+    # Raises TooManyRecords error if the attributes_collection is
+    # larger than the limit.
+    def store_check_record_limit!(limit, attributes_collection)
+      if limit
+        limit = case limit
+        when Symbol
+          send(limit)
+        when Proc
+          limit.call
+        else
+          limit
+        end
+
+        if limit && attributes_collection.size > limit
+          raise TooManyRecords, "Maximum #{limit} records are allowed. Got #{attributes_collection.size} records instead."
+        end
+      end
+    end
+
+    # Updates a record with the +attributes+ or returns nil if
+    # +allow_destroy+ is +true+ and has_destroy_flag? returns +true+.
+    def store_add_or_destroy(hash, attributes, allow_destroy)
+      hash.merge!(attributes.except(*UNASSIGNABLE_KEYS))
+      unless store_has_destroy_flag?(attributes) && allow_destroy
+        return hash
+      else
+        return nil
+      end
+    end
+
+    # Determines if a hash contains a truthy _destroy key.
+    def store_has_destroy_flag?(hash)
+      hash.stringify_keys!
+      ActiveRecord::ConnectionAdapters::Column.value_to_boolean(hash['_destroy'])
+    end
+
+    # Determines if a new record should be rejected by checking
+    # has_destroy_flag? or if a <tt>:reject_if</tt> proc exists for this
+    # attribute and evaluates to +true+.
+    def store_reject_new_record?(attribute_name, attributes)
+      store_has_destroy_flag?(attributes) || store_call_reject_if(attribute_name, attributes)
+    end
+
+    # Determines if a record with the particular +attributes+ should be
+    # rejected by calling the reject_if Symbol or Proc (if defined).
+    # The reject_if option is defined by +accepts_nested_attributes_for+.
+    #
+    # Returns false if there is a +destroy_flag+ on the attributes.
+    def store_call_reject_if(attribute_name, attributes)
+      return false if store_has_destroy_flag?(attributes)
+      case callback = self.store_attributes_options[attribute_name][:reject_if]
+      when Symbol
+        method(callback).arity == 0 ? send(callback) : send(callback, attributes)
+      when Proc
+        callback.call(attributes)
+      end
+    end
+
+    def store_raise_nested_attributes_record_not_found!(attribute_name, record_id)
+      raise RecordNotFound, "Couldn't find #{attribute_name} with ID=#{record_id} for #{self.class.name} with ID=#{id}"
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, NestedStoreAttributes::AcceptsStoreAttributes

data/lib/nested_store_attributes/version.rb

@@ -0,0 +1,3 @@
+module NestedStoreAttributes
+  VERSION = "0.0.1"
+end

data/lib/tasks/nested_json_attributes_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :store_attributes do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/person.rb

@@ -0,0 +1,9 @@
+class Person < ActiveRecord::Base
+  
+  serialize :books, JSON
+  serialize :cars, JSON
+  
+  accepts_store_attributes_for :books, primary_key: :isbn, allow_destroy: true
+  
+  accepts_store_attributes_for :cars
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')