collection_json_serializer 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0663e720fc3843ee8c028d9d3d6dc8e060792217
-  data.tar.gz: 8a789413bcff39e3d7df648b027472a5b568a2a5
+  metadata.gz: a3261f2fef5892978bcfe9c28b592538995524b2
+  data.tar.gz: 006a703ad51bc4914e2bbc3c6d6199c9c5d0789a
 SHA512:
-  metadata.gz: 059b0bd27cd307e3347e9699829daeafbb16a96d6819216cdfe899c8c42ff2e9897f3bb069bc190608dcf46ba7831a74468294716adbb9047307e841bbe48c1f
-  data.tar.gz: e2bc1b7708f4f7f69bfb25329e0394e0bdc5ffff6b067b3e0857110749cae802a30b07dc1ea535814bd727fcc42030a10771089e096cdf4ca0d20910c9f6b0fc
+  metadata.gz: c72dd15101792c1773f136d6ec5f954b2b42b28d9aaec2b7e269885dd8a2c4bd53635dc5af1193552f7e910da4c0dd748d2257a0d90c70c943803ee7b0143710
+  data.tar.gz: dc76bbc18ec5c33fd613624553cb9927d300a0ff8285ea5d872d769821c71296fbfad6873538da0b7e94c70661b0bb669cec9bd636dc0f6c63543160cfa5b043

data/README.md

@@ -4,11 +4,16 @@
 
 | :warning: This is _not finished_ yet, so use it at your own risk. |
 --------------------------------------------------------------------
+| :warning: Until version 1.X breaking changes might happen |
+-------------------------------------------------------------
 
 CollectionJson::Serializer serializes Ruby objects to Collection+JSON, the hypermedia type by Mike Amudsen.
 
 Please note that CollectionJson::Serializer _only serializes data_. You still need to set the proper Headers or media-types in your app.
 
+If you're working on a Rails app, you might want to use [Collection+JSON
+Rails](https://github.com/carlesjove/collection_json_rails) instead.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -32,16 +37,14 @@ class UserSerializer < CollectionJson::Serializer
 
   template :name
   template email: { prompt: "My email" }
-  # This could be written in a single line, too, wrapping the hash:
-  # template :name, { email: { ... } }
 
-  # Please note that links can only be passed as hashes
-  links dashboard: { href: "http://example.com/my-dashboard" }
+  link dashboard: { href: "http://example.com/my-dashboard" }
 
-  queries search: {
+  query search: {
     href: "http://example.com/search",
     name: false # Don't automatically include the name attribute
-  }, pagination: {
+  }
+  query pagination: {
     rel: "page",
     href: "http://example.com/page",
     prompt: "Select a page number",
@@ -50,9 +53,13 @@ class UserSerializer < CollectionJson::Serializer
     ]
   }
 
-  item do
-    attributes :id, name: { prompt: "Your full name" }, :email
+  items do
+    attribute :id
+    attribute name: { prompt: "Your full name" }}
+    attribute :email
+
     href "http://example.com/users/{id}"
+
     link avatar: { href: "http://assets.example.com/avatar.jpg", render: "image" }
   end
 end
@@ -67,7 +74,7 @@ Then, you pass your objects to the serializer:
 user_serializer = UserSerializer.new(@user)
 
 # You can also pass an array of objects
-# user_serializer = UserSerializer.new([@user1, @user2, etc])
+# user_serializer = UserSerializer.new([@user1, @user2])
 
 # Pass the serializer to the builder
 collection = CollectionJson::Serializer::Builder.new(user_serializer)
@@ -139,10 +146,10 @@ All placeholders will be called, so you can use more than one if necessary, but
 ```ruby
 class UserSerializer < CollectionJson::Serializer
   items do
-    # This is ok
+    # This will work
     href "http://example.com/users/{id}/{username}"
 
-    # This is wrong
+    # This won't work
     href "http://example.com/users/{id}-{username}"
   end
 end
@@ -163,19 +170,16 @@ class UserSerializer < CollectionJson::Serializer
 
   # Now you can use your crazy properties everywhere
   items do
-    attributes :id, name: { css_class: "people" }
+    attribute name: { css_class: "people" }
   end
 
   template name: { regex: "/\A[a-zA-Z0-9_]*\z/" }
 
-  links profile: { on_click: "reboot_universe" }
+  link profile: { on_click: "reboot_universe" }
 end
 ```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/collection_json_serializer/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
+Please, all Pull Request should point to the `dev` branch. `master` is for the
+latest release only.

data/lib/collection_json_serializer/items.rb

@@ -18,6 +18,11 @@ module CollectionJson
         @attributes ||= args
       end
 
+      def attribute(args)
+        @attributes = Array.new unless @attributes.is_a?(Array)
+        @attributes << args
+      end
+
       def link(args)
         @links = Array.new unless @links.is_a?(Array)
         @links << args

data/lib/collection_json_serializer/objects/query.rb

@@ -4,9 +4,9 @@ module CollectionJson
       class Query
         def initialize(serializer, item: 0)
           @serializer = serializer
-          @index = item >= 0 ? item : 0
-          @key = @serializer.queries.first.keys[@index]
-          @resource = @serializer.queries.first[@key]
+          index = item >= 0 ? item : 0
+          @key = @serializer.queries[index].keys.first
+          @resource = @serializer.queries[index].fetch(@key)
           @query = Hash.new
         end
 

data/lib/collection_json_serializer/serializer.rb

@@ -1,40 +1,53 @@
 module CollectionJson
   class Serializer
     class << self
-      attr_accessor :extensions
-      attr_accessor :href
-      attr_accessor :template
-      attr_accessor :links
-      attr_accessor :queries
+      attr_accessor :_extensions
+      attr_accessor :_href
+      attr_accessor :_template
+      attr_accessor :_links
+      attr_accessor :_queries
       attr_accessor :_items
     end
 
     def self.inherited(base)
-      base.extensions = []
-      base.href = []
-      base.template = []
-      base.links = []
-      base.queries = []
+      base._extensions = []
+      base._href = []
+      base._template = []
+      base._links = []
+      base._queries = []
     end
 
     def self.extensions(*attrs)
-      @extensions.concat attrs
+      @_extensions.concat attrs
     end
 
     def self.href(*attrs)
-      @href.concat attrs
+      @_href.concat attrs
     end
 
     def self.template(*attrs)
-      @template.concat attrs
+      @_template.concat attrs
     end
 
+    def self.link(*attrs)
+      @_links.concat attrs
+    end
+
+    # DEPRECATED
     def self.links(*attrs)
-      @links.concat attrs
+      warn "links has been deprecated and will be removed soon. " <<
+           "Please, use `link` instead"
+      @_links.concat attrs
+    end
+
+    def self.query(*attrs)
+      @_queries.concat attrs
     end
 
     def self.queries(*attrs)
-      @queries.concat attrs
+      warn "`queries` has been deprecated and will be removed soon. " <<
+           "Please, use `query` instead"
+      @_queries.concat attrs
     end
 
     def self.items(&block)
@@ -53,35 +66,35 @@ module CollectionJson
     end
 
     def extensions
-      self.class.extensions
+      self.class._extensions
     end
 
     def href
-      self.class.href.first
+      self.class._href.first
     end
 
     def template
-      self.class.template
+      self.class._template
     end
 
     def template?
-      self.class.template.present?
+      self.class._template.present?
     end
 
     def links
-      self.class.links
+      self.class._links
     end
 
     def links?
-      self.class.links.present?
+      self.class._links.present?
     end
 
     def queries
-      self.class.queries
+      self.class._queries
     end
 
     def queries?
-      self.class.queries.present?
+      self.class._queries.present?
     end
 
     def items

data/lib/collection_json_serializer/version.rb

@@ -1,5 +1,5 @@
 module CollectionJson
   class Serializer
-    VERSION = "0.3.6"
+    VERSION = "0.4.0"
   end
 end

data/test/builder/builder_test.rb

@@ -73,6 +73,15 @@ module CollectionJson
                 {
                   rel: "search",
                   href: "http://example.com/search"
+                },
+                {
+                  rel: "page",
+                  href: "http://example.com/page",
+                  name: "pagination",
+                  prompt: "Select a page number",
+                  data: [
+                    { name: "page", value: "" }
+                  ]
                 }
               ]
             }
@@ -168,6 +177,15 @@ module CollectionJson
                 {
                   rel: "search",
                   href: "http://example.com/search"
+                },
+                {
+                  rel: "page",
+                  href: "http://example.com/page",
+                  name: "pagination",
+                  prompt: "Select a page number",
+                  data: [
+                    { name: "page", value: "" }
+                  ]
                 }
               ]
             }

data/test/extensions/open_attrs_test.rb

@@ -8,8 +8,8 @@ module CollectionJson
       def setup
         @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
         @serializer = empty_serializer_for(@user)
-        @serializer.class.extensions = [:open_attrs]
-        @serializer.class.template = [
+        @serializer.class._extensions = [:open_attrs]
+        @serializer.class._template = [
           email: {
             prompt: "My email",
             anything: "at all"
@@ -27,13 +27,13 @@ module CollectionJson
             anything: "at all"
           }
         ]
-        @serializer.class.links = [
+        @serializer.class._links = [
           dashboard: {
             href: "http://example.com/my-dashboard",
             anything: "at all"
           }
         ]
-        @serializer.class.queries = [
+        @serializer.class._queries = [
           search: {
             href: "http://example.com/search",
             rel: "search",

data/test/fixtures/serializers/invalid_serializer.rb

@@ -1,4 +1,4 @@
 class InvalidSerializer < CollectionJson::Serializer
   href self: "/users/1", collection: "www.users.com"
-  links dashboard: { href: "/my-dashboard" }
+  link dashboard: { href: "/my-dashboard" }
 end

data/test/fixtures/serializers/user_serializer.rb

@@ -5,12 +5,13 @@ class UserSerializer < CollectionJson::Serializer
   template email: { prompt: "My email" }
   template :password
 
-  links dashboard: { href: "http://example.com/my-dashboard" }
+  link dashboard: { href: "http://example.com/my-dashboard" }
 
-  queries search: {
+  query search: {
     href: "http://example.com/search",
     name: false
-  }, pagination: {
+  }
+  query pagination: {
     rel: "page",
     href: "http://example.com/page",
     prompt: "Select a page number",
@@ -22,6 +23,7 @@ class UserSerializer < CollectionJson::Serializer
   items do
     href "http://example.com/users/{id}"
     attributes :name, :email
+    attribute date_created: { prompt: "Member since" }
     link avatar: { href: "http://assets.example.com/avatar.jpg" }
     link bio: { href: "http://example.com/bio" }
   end

data/test/fixtures/serializers/valid_serializer.rb

@@ -1,5 +1,5 @@
 class ValidSerializer < CollectionJson::Serializer
   href self: "http://example.com/users/1",
        collection: "http://example.com/users"
-  links dashboard: { href: "http://example.com/my-dashboard" }
+  link dashboard: { href: "http://example.com/my-dashboard" }
 end

data/test/minitest_helper.rb

@@ -10,11 +10,11 @@ Dir.glob(File.dirname(__FILE__) + "/fixtures/serializers/**/*.rb") { |file| requ
 module TestHelper
   def empty_serializer_for(object)
     serializer = CollectionJson::Serializer.new(object)
-    serializer.class.extensions = []
-    serializer.class.href = []
-    serializer.class.links = []
-    serializer.class.template = []
-    serializer.class.queries = []
+    serializer.class._extensions = []
+    serializer.class._href = []
+    serializer.class._links = []
+    serializer.class._template = []
+    serializer.class._queries = []
     serializer.class.items {}
     serializer.items.attributes = []
     serializer

data/test/objects/item_test.rb

@@ -8,8 +8,10 @@ module CollectionJson
           include TestHelper
 
           def setup
-            @user1 = User.new(name: "Carles Jove", email: "hola@carlus.cat")
-            @user2 = User.new(name: "Aina Jove", email: "hola@example.com")
+            @user1 = User.new(name: "Carles Jove", email: "hola@carlus.cat",
+                              date_created: "2015-02-01")
+            @user2 = User.new(name: "Aina Jove", email: "hola@example.com",
+                              date_created: "2015-02-02")
             @user_serializer = UserSerializer.new(@user1)
             @item = Item.new(@user_serializer)
           end
@@ -19,7 +21,12 @@ module CollectionJson
               href: "http://example.com/users/#{@user1.id}",
               data: [
                 { name: "name", value: "Carles Jove" },
-                { name: "email", value: "hola@carlus.cat" }
+                { name: "email", value: "hola@carlus.cat" },
+                {
+                  name: "date_created",
+                  value: "2015-02-01",
+                  prompt: "Member since"
+                }
               ],
               links: [
                 {
@@ -46,7 +53,12 @@ module CollectionJson
               href: "http://example.com/users/#{@user2.id}",
               data: [
                 { name: "name", value: "Aina Jove" },
-                { name: "email", value: "hola@example.com" }
+                { name: "email", value: "hola@example.com" },
+                {
+                  name: "date_created",
+                  value: "2015-02-02",
+                  prompt: "Member since"
+                }
               ],
               links: [
                 {

data/test/serializer/dsl_test.rb

@@ -4,7 +4,8 @@ module CollectionJson
   class Serializer
     class TestDSL < Minitest::Test
       def setup
-        @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+        @user = User.new(name: "Carles Jove", email: "hola@carlus.cat",
+                         date_created: "2015-02-01")
         @serializer = Serializer.new(@user)
       end
 

data/test/serializer/href_test.rb

@@ -11,14 +11,14 @@ module CollectionJson
       end
 
       def test_href_object
-        assert_equal ["http://example.com/users"], @user_serializer.class.href
+        assert_equal ["http://example.com/users"], @user_serializer.class._href
       end
 
       def test_that_only_one_href_value_is_passed_to_builder
         serializer = empty_serializer_for(@user)
-        serializer.class.href = %w(/a /b /c)
+        serializer.class._href = %w(/a /b /c)
 
-        assert_equal %w(/a /b /c), serializer.class.href
+        assert_equal %w(/a /b /c), serializer.class._href
         assert_equal "/a", serializer.href
       end
     end

data/test/serializer/items/attributes_test.rb

@@ -4,12 +4,14 @@ module CollectionJson
   class Serializer
     class TestAttributes < Minitest::Test
       def setup
-        @user = User.new(name: "Carles Jove", email: "hola@carlus.cat")
+        @user = User.new(name: "Carles Jove", email: "hola@carlus.cat",
+                         date_created: "2015-02-01")
         @user_serializer = UserSerializer.new(@user)
       end
 
       def test_attributes_properties
-        assert_equal [:name, :email], @user_serializer.items.attributes
+        expected_attributes = [:name, :email, { date_created: { prompt: "Member since" } }]
+        assert_equal expected_attributes, @user_serializer.items.attributes
       end
     end
   end

data/test/serializer/links_test.rb

@@ -12,7 +12,7 @@ module CollectionJson
 
       def test_item_links_attributes
         expected = [dashboard: { href: "http://example.com/my-dashboard" }]
-        assert_equal expected, @user_serializer.class.links
+        assert_equal expected, @user_serializer.class._links
       end
     end
   end

data/test/serializer/queries_test.rb

@@ -10,21 +10,23 @@ module CollectionJson
 
       def test_template_attributes
         expected = [
-          search: {
-            href: "http://example.com/search",
-            name: false
+          { search: {
+              href: "http://example.com/search",
+              name: false
+            }
           },
-          pagination: {
-            rel: "page",
-            href: "http://example.com/page",
-            prompt: "Select a page number",
-            data: [
-              { name: "page" }
-            ]
+          { pagination: {
+              rel: "page",
+              href: "http://example.com/page",
+              prompt: "Select a page number",
+              data: [
+                { name: "page" }
+              ]
+            }
           }
         ]
 
-        assert_equal expected, @user_serializer.class.queries
+        assert_equal expected, @user_serializer.class._queries
       end
     end
   end

data/test/serializer/spec_test.rb

@@ -10,16 +10,16 @@ module CollectionJson
         serializer.items.attributes = [
           name: { unknown: "this should not be valid" }
         ]
-        serializer.items.links = serializer.class.links = [
+        serializer.items.links = serializer.class._links = [
           dashboard: {
             href: "http://example.com",
             unknown: "this should not be valid"
           }
         ]
-        serializer.class.template = [
+        serializer.class._template = [
           name: { whatever: "this should not be valid" }
         ]
-        serializer.class.queries = [
+        serializer.class._queries = [
           name: {
             href: "http://example.com",
             whatever: "this should be invalid",

data/test/validator/invalid_test.rb

@@ -23,7 +23,7 @@ module CollectionJson
 
         # Href
         def test_that_href_generates_errors
-          @invalid.class.href = [self: "/users/1", collection: "www.users.com"]
+          @invalid.class._href = [self: "/users/1", collection: "www.users.com"]
 
           assert @invalid.invalid?
           assert @invalid.errors.include? :href
@@ -32,7 +32,7 @@ module CollectionJson
           assert @invalid.errors[:href][1].
                   include? "href:collection is an invalid URL"
 
-          @invalid.class.href = ["/users/1"]
+          @invalid.class._href = ["/users/1"]
 
           assert @invalid.invalid?
           assert @invalid.errors.include? :href
@@ -42,13 +42,13 @@ module CollectionJson
 
         # Links
         def test_that_links_generates_errors
-          @invalid.class.links = [dashboard: { href: "/my-dashboard" }]
+          @invalid.class._links = [dashboard: { href: "/my-dashboard" }]
           assert @invalid.invalid?
           assert @invalid.errors.include? :links
           assert @invalid.errors[:links].first.
                   include? "links:dashboard:href is an invalid URL"
 
-          @invalid.class.links = [
+          @invalid.class._links = [
             dashboard: {
               href: "http://valid.url.com",
               prompt: /invalid/
@@ -61,7 +61,7 @@ module CollectionJson
         end
 
         def test_that_links_missing_href_generates_error
-          @invalid.class.links = [dashboard: {}]
+          @invalid.class._links = [dashboard: {}]
           assert @invalid.invalid?
           assert @invalid.errors.include? :links
           assert @invalid.errors[:links].first.
@@ -103,7 +103,7 @@ module CollectionJson
         # Template
         def test_that_template_values_validate
           values_for_test(:invalid).each do |invalidate|
-            @invalid.class.template = [
+            @invalid.class._template = [
               name: {
                 prompt: invalidate,
                 name: invalidate
@@ -123,7 +123,7 @@ module CollectionJson
 
         # Queries
         def test_that_queries_validate_href_format
-          @invalid.class.queries = [
+          @invalid.class._queries = [
             search: {
               href: "not-valid"
             }
@@ -138,7 +138,7 @@ module CollectionJson
         end
 
         def test_that_queries_href_is_required
-          @invalid.class.queries = [
+          @invalid.class._queries = [
             search: {
               name: "missing href"
             }
@@ -153,7 +153,7 @@ module CollectionJson
 
         def test_that_queries_values_are_validated
           values_for_test(:invalid).each do |invalidate|
-            @invalid.class.queries = [
+            @invalid.class._queries = [
               search: {
                 href: "http://example.com/",
                 name: invalidate,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collection_json_serializer
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Carles Jove i Buxeda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport