accepts_nested_serialized_attributes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5b1940475b622c6225080765c6e1edaf9ca7b034
+  data.tar.gz: a2fd850fc13cb62a6182fbee1f659431c30fb3e7
+SHA512:
+  metadata.gz: 11dc0e8d40cdec1e7fb7b1b0a6acf159a7da3e95387bead7be58bb2c24ead729a7d81df302db0c0f29dae14ec44867e36fb8e866961ed042fd79dce98f8ba71d
+  data.tar.gz: cbbb3ef526be55361fb98f6ab0976bfc13d93d00d4eeed4f6b1a5c8417ed3c396f638813fabf795e3277e297c879aa4f760a38a405b9375bd53cdba4df8620ee

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Diego Salazar
+
+MIT License
+
+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,70 @@
+# AcceptsNestedSerializedAttributes
+
+Writing an API? Serializing your objects between Rails powered apps? Want to use nested associations without writing extra (de)serialization code? Want to get away with just using `ActiveModel#as_json`? Do your models declare `accepts_nested_attributes_for`?
+
+You might have noticed how calling `@model.as_json include: :association` will return a hash that includes the association but the name isn't suffixed with `_attributes` which `accepts_nested_attributes_for` needs in order to build the association from those nested attributes. Well, the API consumer could worry about it, but what if the API consumer is another Rails app? Why not make it as easy as possible for them and just send the association through with the correct key so they can just use `Model.new.from_json params[:model]` and have ActiveModel build the associations automatically given that they declare `accepts_nested_attributes_for :association`? 
+
+This tiny gem is the answer. It monkey patches `ActiveModel::Serialization#serializable_hash` and renames nested attributes keys if they are declared as such via `accepts_nested_attributes_for` in the given model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'accepts_nested_serialized_attributes'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install accepts_nested_serialized_attributes
+
+## Usage
+
+Adding the Gem to your Gemfile is enough to make this work. Given:
+
+```ruby
+class Model < ActiveRecord::Base
+  has_many :associations
+  accepts_nested_attributes_for :associations
+end
+```
+
+Then:
+
+```ruby
+@model = Model.first
+@model.as_json include: :associations
+```
+
+Will return:
+
+```ruby
+{
+  id: 1
+  associations_attributes: {
+    attribute_1: 'value'
+  }
+}
+```
+
+If you don't declare `accepts_nested_attributes_for` then the attributes won't be renamed in the serialized hash.
+
+Only the API producer needs this Gem, the consumer just needs to declare `accepts_nested_attributes_for` and they can just:
+
+```ruby
+@model = Model.new.from_json params[:model]
+```
+
+And the association will be built automatically as you'd expect.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/accepts_nested_serialized_attributes/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/accepts_nested_serialized_attributes.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'accepts_nested_serialized_attributes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "accepts_nested_serialized_attributes"
+  spec.version       = AcceptsNestedSerializedAttributes::VERSION
+  spec.authors       = ["Diego Salazar"]
+  spec.email         = ["diego@greyrobot.com"]
+  spec.summary       = %q{Adds support for serializing nested associations that work with accepts_nested_attributes_for.}
+  spec.description   = %q{A tiny hack for Rails to make Model#as_json(include: :association) return a hash with association keys suffixed with _attributes.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec"
+end

data/db/migrate/20141211145336_create_model.rb

@@ -0,0 +1,7 @@
+class CreateModel < ActiveRecord::Migration
+  def change
+    create_table :models do |t|
+      t.string :status
+    end
+  end
+end

data/db/migrate/20141211145337_create_association.rb

@@ -0,0 +1,8 @@
+class CreateAssociation < ActiveRecord::Migration
+  def change
+    create_table :associations do |t|
+      t.references :model
+      t.string :status
+    end
+  end
+end

data/lib/accepts_nested_serialized_attributes/version.rb

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

data/lib/accepts_nested_serialized_attributes.rb

@@ -0,0 +1,19 @@
+require "accepts_nested_serialized_attributes/version"
+
+module AcceptsNestedSerializedAttributes
+  module ActiveModel::Serialization
+    alias_method :original_serializable_hash, :serializable_hash
+
+    def serializable_hash(options = nil)
+      original_serializable_hash(options).tap do |hash|
+        hash.symbolize_keys!
+
+        self.class.nested_attributes_options.keys.each do |nested_attributes_key|
+          if (records = hash.delete nested_attributes_key)
+            hash["#{nested_attributes_key}_attributes".to_sym] = records
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,89 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/the_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'active_record'
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+ActiveRecord::Migrator.up 'db/migrate'
+require 'accepts_nested_serialized_attributes'
+
+class Association < ActiveRecord::Base
+  belongs_to :model
+end
+
+describe AcceptsNestedSerializedAttributes do
+  before :each do # Allow clean redefinition of Model
+    Object.send :remove_const, :Model rescue nil
+  end
+
+  it 'renames nested attributes' do
+    class Model < ActiveRecord::Base
+      has_many :associations
+      accepts_nested_attributes_for :associations
+    end
+    
+    model = Model.new
+    model.associations << Association.new
+
+    expect(model.as_json(include: :associations)).to eq({
+      id: nil, status: nil, associations_attributes: [{ id: nil, model_id: nil, status: nil }]
+    })
+  end
+
+  it "doesn't rename an attribute if it is not declared as nested" do
+    class Model < ActiveRecord::Base
+      has_many :associations
+    end
+
+    model = Model.new
+    model.associations << Association.new
+
+    expect(model.as_json(include: :associations)).to eq({
+      id: nil, status: nil, associations: [{ id: nil, model_id: nil, status: nil }]
+    })
+  end
+
+  it 'symbolizes keys in serialized hash' do
+    class Model < ActiveRecord::Base
+      has_many :associations
+      accepts_nested_attributes_for :associations
+    end
+
+    model = Model.new
+    model.associations << Association.new
+
+    all_symbols = model.as_json(include: :associations).keys.all? { |k| k.is_a? Symbol }
+    expect(all_symbols).to be true
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: accepts_nested_serialized_attributes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Diego Salazar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: activerecord
+  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'
+- !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'
+description: 'A tiny hack for Rails to make Model#as_json(include: :association) return
+  a hash with association keys suffixed with _attributes.'
+email:
+- diego@greyrobot.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- accepts_nested_serialized_attributes.gemspec
+- db/migrate/20141211145336_create_model.rb
+- db/migrate/20141211145337_create_association.rb
+- lib/accepts_nested_serialized_attributes.rb
+- lib/accepts_nested_serialized_attributes/version.rb
+- spec/spec_helper.rb
+- spec/the_spec.rb
+homepage: ''
+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.3
+signing_key: 
+specification_version: 4
+summary: Adds support for serializing nested associations that work with accepts_nested_attributes_for.
+test_files:
+- spec/spec_helper.rb
+- spec/the_spec.rb