nested_attributes_serializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 79ce523f7782beec5f14b496862227f28ba22bfc
+  data.tar.gz: bda14744d95a5e516bd95c142b33c4d0b56ec18b
+SHA512:
+  metadata.gz: e435bf8c30db9f8d346150704e4f5ec5e4e61876bfba979c820e3809ee6aa16364baffe8e779c61197b0df691ecb9dbb530c0b5f722cc07e27d984a3462ed630
+  data.tar.gz: ca271b438c4f43eb6ff24972df7ffe3fa33b35911554c6220a4c4a91ec72afc601515bfb0ad9f523bb2ffe73d21059b199a4eaaa29f23d78d14709891fd06ab4

data/.gitignore

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

data/.jrubyrc

@@ -0,0 +1 @@
+debug.fullTrace=true

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,22 @@
+Metrics/LineLength:
+  Max: 140
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  SupportedStyles:
+    - double_quotes
+
+Style/UnlessElse:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  #- 1.9.3
+  #- 2.0.0
+  #- 2.1.10
+  #- 2.2.5
+  - 2.3.1
+  #- jruby-1.7
+  #- jruby
+  #- rbx
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,23 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "activerecord"
+  gem "bundler"
+  gem "rake"
+  gem "rubocop", "~> 0.41.1", require: false
+  gem "rspec", "~> 3.0"
+  gem "simplecov"
+  gem "sqlite3"
+
+  if !ENV["CI"] && RUBY_ENGINE == "ruby"
+    gem "pry"
+
+    if RUBY_VERSION < "2.0.0"
+      gem "pry-nav"
+    else
+      gem "pry-byebug"
+    end
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michael Sievers
+
+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,75 @@
+# NestedAttributesSerializer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nested_attributes_serializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nested_attributes_serializer
+
+## Usage
+
+```ruby
+class Search < ApplicationRecord
+  include NestedAttributesSerializer
+
+  has_many :queries
+
+  accepts_nested_attributes_for :queries
+end
+```
+
+```ruby
+class Query < ApplicationRecord
+  belongs_to :search
+end
+```
+
+```ruby
+search = Search.new(queries_attributes: [{query: "foo"}, {query: "bar"}])
+search.queries
+# [
+#   #<Query:0x000000043e02e8 id: nil, query: "foo", created_at: nil, updated_at: nil, search_id: nil>,
+#   #<Query:0x000000043cdd00 id: nil, query: "bar", created_at: nil, updated_at: nil, search_id: nil>
+# ]
+
+serialized_search = search.to_nested_attributes(include: :queries)
+# {
+#   "id"=>nil, "created_at"=>nil, "updated_at"=>nil,
+#   "queries_attributes"=>[
+#     {"id"=>nil, "query"=>"foo", "created_at"=>nil, "updated_at"=>nil, "search_id"=>nil},
+#     {"id"=>nil, "query"=>"bar", "created_at"=>nil, "updated_at"=>nil, "search_id"=>nil}
+#   ]
+# }
+
+deserialized_search = Search.new(serialized_search)
+deserialized_search.queries
+
+# [
+#   #<Query:0x00000003c59ee8 id: nil, query: "foo", created_at: nil, updated_at: nil, search_id: nil>,
+#   #<Query:0x00000003c3f5e8 id: nil, query: "bar", created_at: nil, updated_at: nil, search_id: nil>
+# ]
+```
+
+## 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 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/msievers/nested_attributes_serializer.
+
+## 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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nested_attributes_serializer"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nested_attributes_serializer.rb

@@ -0,0 +1,35 @@
+require "nested_attributes_serializer/version"
+
+module NestedAttributesSerializer
+  # Returns a hash representing the model. It accepts the some options
+  # as serializable_hash.
+  def as_nested_attributes(options = {})
+    hash = serializable_hash(options)
+    NestedAttributesSerializer.rename_includes(hash, options)
+    hash
+  end
+
+  # see #as_nested_attributes
+  def to_nested_attributes(*args)
+    as_nested_attributes(*args)
+  end
+
+  # Renames the keys of associations to conform to rails nested attributes
+  # naming convention. This is a implemented as a module method in order
+  # to not pollute the method namespace of the including class/module.
+  def self.rename_includes(hash, options)
+    # inspired by activemodel/lib/active_model/serialization.rb
+    return unless includes = options[:include]
+
+    unless includes.is_a?(Hash)
+      includes = Hash[Array(includes).map { |n| n.is_a?(Hash) ? n.to_a.first : [n, {}] }]
+    end
+
+    includes.each do |association, opts|
+      old_key = association.to_s
+      new_key = "#{old_key}_attributes"
+      hash[new_key] = hash.delete(old_key)
+      rename_includes(hash[new_key], opts)
+    end
+  end
+end

data/lib/nested_attributes_serializer/version.rb

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

data/nested_attributes_serializer.gemspec

@@ -0,0 +1,19 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nested_attributes_serializer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nested_attributes_serializer"
+  spec.version       = NestedAttributesSerializer::VERSION
+  spec.authors       = ["Michael Sievers"]
+
+  spec.summary       = %q{ActiveModel serializer which returns hashes according to Rails nested attributes naming convention.}
+  spec.homepage      = "https://github.com/msievers/nested_attributes_serializer"
+  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"]
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: nested_attributes_serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Sievers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-07 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".jrubyrc"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nested_attributes_serializer.rb
+- lib/nested_attributes_serializer/version.rb
+- nested_attributes_serializer.gemspec
+homepage: https://github.com/msievers/nested_attributes_serializer
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveModel serializer which returns hashes according to Rails nested attributes
+  naming convention.
+test_files: []