jsonapi-serializers 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: adb7f4634374e6733cd5a2e1dee11e7863b64922
-  data.tar.gz: 3d3d1a0225b0a96d681918dcc4fefde4e3df9668
+  metadata.gz: 492ef52b3e744f06e226ebe911fd6671dfc637b6
+  data.tar.gz: 19f25d49bb9bb8450b9538bdc31aaf6ee4bf3a12
 SHA512:
-  metadata.gz: fe35e4ad8cfa091a813fb5e30542482c5b4c9214b068cd5f490d4b71c4e155794c12d05be0ab17b95fc4c8ec7bd2f088c240c25727fc938c75df583596709791
-  data.tar.gz: 176d36a30d6165a1a7463d0cf87e36349fabb64bfdbeb09b7e67d5f86a1d3052610b8b870883426622a00e9018aabd47765bfc8546e6270a67e2be2e67f9567d
+  metadata.gz: 1ad6cd857ffccc11bccf9ee0d33aa0c35dddb8f6da4b188984ac56609c3e38d9373c66fb12518045dec75ebf26473a7624002dc8d1ecb16ea9eb784f0ace8dac
+  data.tar.gz: b6212c674cd0d71bf345aeca14c6e8215e13b9b06614a03510cee65311ef09164b8b7f7effa460a729083963c8d60ae141acf1a62650e4016aa705dd49e5c937

data/README.md

@@ -14,6 +14,7 @@ This library is up-to-date with the finalized v1 JSON API spec.
   * [Serialize an object](#serialize-an-object)
   * [Serialize a collection](#serialize-a-collection)
   * [Null handling](#null-handling)
+  * [Multiple attributes](#multiple-attributes)
   * [Custom attributes](#custom-attributes)
   * [More customizations](#more-customizations)
   * [Base URL](#base-url)
@@ -149,6 +150,13 @@ Returns:
 
 Note that the JSON:API spec distinguishes in how null/empty is handled for single objects vs. collections, so you must always provide `is_collection: true` when serializing multiple objects. If you attempt to serialize multiple objects without this flag (or a single object with it on) a `JSONAPI::Serializer::AmbiguousCollectionError` will be raised.
 
+### Multiple attributes
+You could declare multiple attributes at once:
+
+```ruby
+ attributes :title, :body, :contents
+```
+
 ### Custom attributes
 
 By default the serializer looks for the same name of the attribute on the object it is given. You can customize this behavior by providing a block to `attribute`, `has_one`, or `has_many`:
@@ -519,6 +527,7 @@ end
 
 ## Release notes
 
+* v0.4.0: Support for declaring multiple `attributes`.
 * v0.3.1: Improve performance of loading included relationships.
 * v0.3.0: Add top-level `meta` support.
 * v0.2.6: Add `base_url` support.

data/lib/jsonapi-serializers/attributes.rb

@@ -17,6 +17,10 @@ module JSONAPI
         add_attribute(name, options, &block)
       end
 
+      def attributes(*names)
+        names.each { |name| add_attribute(name) }
+      end
+
       def has_one(name, options = {}, &block)
         add_to_one_association(name, options, &block)
       end

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.3.1'
+    VERSION = '0.4.0'
   end
 end

data/spec/serializer_spec.rb

@@ -128,6 +128,21 @@ describe JSONAPI::Serializer do
           },
         })
       end
+      it 'serializes object when multiple attributes are declared once' do
+        post = create(:post)
+        primary_data = serialize_primary(post, {serializer: MyApp::MultipleAttributesSerializer})
+        expect(primary_data).to eq({
+          'id' => '1',
+          'type' => 'posts',
+          'attributes' => {
+            'title' => 'Title for Post 1',
+            'body' => 'Body for Post 1',
+          },
+          'links' => {
+            'self' => '/posts/1',
+          }
+        })
+      end
     end
     context 'with linkage includes' do
       it 'can serialize primary data for a null to-one relationship' do

data/spec/support/serializers.rb

@@ -134,4 +134,10 @@ module MyApp
   class EmptySerializer
     include JSONAPI::Serializer
   end
+
+  class MultipleAttributesSerializer
+    include JSONAPI::Serializer
+
+    attributes :title, :body
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Pure Ruby readonly serializers for the JSON:API spec.
@@ -132,3 +132,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/factory.rb
 - spec/support/serializers.rb
+has_rdoc: