collection_json_rails 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 151057d40027eadc3ffb330c66b6be7b0f19f01b
-  data.tar.gz: e66f5b0774f6a3282b27f26ac27e38e10541f7b7
+  metadata.gz: e0acab955df5e8a66e5509f4d16de0509290c11c
+  data.tar.gz: 01a5073c1d15aa36e3d7da87457d56a1bdce86c3
 SHA512:
-  metadata.gz: dcb421e998e2710e24104ee5ca1c7caffe59b5eb8be631151ae6353910291d4868cd8d56956c95632a6f92ef3585bc3a64b4b127830dc6ddbb585dbeceb907aa
-  data.tar.gz: e545172d45e37f9d45f9e66d5ed6b1e608090bc931fb533ae61c8e89d11bc69bc9e73b81ec5bf1f47833a1daeab1c6d97242b616a0eec6015d94f69ec3fac1dc
+  metadata.gz: 7e43aa15b8063738c814b8ea27ef129485d504a0ca79e426f6a976f3af872d7571fefd00750c33d53c2eec6a5e27c83f3b66e62b0147ee2f8e36a13c861a5ac1
+  data.tar.gz: c8fb74497b2dbbab51e57942e6e2d49ba79daa9d30130c3681d00e3af62c050896833456b1cd3d6347c9abd423d6493dc9f39d80af469caa237bed210fb56125

data/README.md

@@ -89,19 +89,18 @@ class PostSerializer < CollectionJson::Serializer
 end
 ```
 
+#### URL helpers
 
-## TO-DO Features
-
-#### URLs helpers
-
-No more fighting with routes generation:
+Getting routes in your serializers is easy as shit. Simply pass the method name as a symbol. No need to reference the object.
 
 ```ruby
 class PostSerializer < CollectionJson::Serializer
   href :posts_url
+  links dashboard: { href: :dashboard_url }
 
   items do
-    href :post_url, :self
+    href :post_url
+    link comments: { href: :comments_url }
 ```
 
 ## Contributing

data/collection_json_rails.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "collection_json_serializer", "~> 0.3"
+  spec.add_runtime_dependency "collection_json_serializer", "~> 0.3.4"
 
   spec.add_dependency "actionpack", "~> 4.0"
   spec.add_dependency "railties", "~> 4.0"

data/lib/collection_json_rails.rb

@@ -1,9 +1,14 @@
 require "collection_json_serializer"
 
 require "collection_json_rails/version"
+require "collection_json_rails/support"
 
 require "collection_json_rails/action_controller/accept_template"
 require "collection_json_rails/action_controller/render"
 
+require "collection_json_rails/serializer/serializer"
+require "collection_json_rails/serializer/items"
+require "collection_json_rails/serializer/objects/item"
+
 require "collection_json_rails/generators/serializer/serializer_generator"
 

data/lib/collection_json_rails/serializer/items.rb

@@ -0,0 +1,13 @@
+module CollectionJson
+  class Serializer
+    class Items
+      include CollectionJson::Rails::Support
+
+      def link(hash)
+        @links = Array.new unless @links.is_a?(Array)
+        @links << rewrite_href_of(hash)
+      end
+    end
+  end
+end
+

data/lib/collection_json_rails/serializer/objects/item.rb

@@ -0,0 +1,8 @@
+class CollectionJson::Serializer::Objects::Item
+  private
+
+  def set_href
+    Rails.application.routes.url_helpers.send(@serializer.items.href, @resource)
+  end
+end
+

data/lib/collection_json_rails/serializer/serializer.rb

@@ -0,0 +1,13 @@
+class CollectionJson::Serializer
+  include CollectionJson::Rails::Support
+
+  def href
+    method = self.class.href.first
+    route(method)
+  end
+
+  def links
+    self.class.links.map {|link| rewrite_href_of(link) }
+  end
+end
+

data/lib/collection_json_rails/support.rb

@@ -0,0 +1,19 @@
+module CollectionJson::Rails
+  module Support
+    def route(href)
+      if href.is_a?(Symbol)
+        ::Rails.application.routes.url_helpers.send(href)
+      else
+        href
+      end
+    end
+
+    def rewrite_href_of(hash)
+      params = hash.extract_params
+      href = route(params[:properties][:href])
+      hash[params[:name]][:href] = href
+      hash
+    end
+  end
+end
+

data/lib/collection_json_rails/version.rb

@@ -1,5 +1,5 @@
 module CollectionJson
   module Rails
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/test/controller/render_test.rb

@@ -1,26 +1,6 @@
 require 'minitest_helper'
 
-class Post
-  attr_accessor :title, :body
-end
-
-class PostSerializer < CollectionJson::Serializer
-  items do
-    attributes :title, :body
-  end
-end
-
 class PostsController < ActionController::Base
-  include CollectionJson::Rails::Render
-
-  def index
-    post = Post.new
-    post.title = "My title"
-    post.body = "My first post"
-
-    render json: post, status: :ok
-  end
-
   def without_serializer
     render json: { my_hash: "should be jsonified too" }
   end
@@ -33,26 +13,6 @@ end
 class TestRender < ActionController::TestCase
   tests PostsController
 
-  def test_that_cj_responses_are_rendered
-    expected = {
-      collection: {
-        version: "1.0",
-        items: [
-          {
-            data: [
-              { name: "title", value: "My title" },
-              { name: "body", value: "My first post" }
-            ]
-          }
-        ]
-      }
-    }
-
-    get :index, {}
-
-    assert_equal expected.to_json, response.body
-  end
-
   def test_that_objects_without_serializer_are_rendered_as_plain_json
     get :without_serializer
 

data/test/minitest_helper.rb

@@ -7,6 +7,8 @@ require 'collection_json_rails'
 
 require 'minitest/autorun'
 
+require 'support/test_app'
+
 module ActionController
   SharedTestRoutes = ActionDispatch::Routing::RouteSet.new
   SharedTestRoutes.draw do

data/test/serializer_test.rb

@@ -0,0 +1,36 @@
+require 'minitest_helper'
+
+class TestSerializer < ActionController::TestCase
+  tests PostsController
+
+  def test_that_cj_responses_are_as_expected
+    expected = {
+      collection: {
+        version: "1.0",
+        href: "http://test.com/posts",
+        items: [
+          {
+            href: "http://test.com/posts/my-pretty-url",
+            data: [
+              { name: "title", value: "My title" },
+              { name: "body", value: "My first post" }
+            ],
+            links: [
+              { rel: "posts", href: "http://test.com/posts", name: "posts" },
+              { rel: "external", href: "http://example.com", name: "external" }
+            ]
+          }
+        ],
+        links: [
+          { rel: "posts", href: "http://test.com/posts", name: "posts" },
+          { rel: "external", href: "http://example.com", name: "external" }
+        ]
+      }
+    }
+
+    get :index, {}
+
+    assert_equal expected.to_json, response.body
+  end
+end
+

data/test/support/test_app.rb

@@ -0,0 +1,46 @@
+class TestApp < Rails::Application
+  config.secret_key_base = "milo_goes_to_college"
+end
+
+Rails.application = TestApp
+
+Rails.application.routes.default_url_options[:host] = "http://test.com"
+
+Rails.application.routes.draw do
+  resources :posts
+end
+
+class Post
+  attr_accessor :title, :body
+
+  def to_param
+    "my-pretty-url"
+  end
+end
+
+class PostSerializer < CollectionJson::Serializer
+  items do
+    href :post_url
+    attributes :title, :body
+    link posts: { href: :posts_url }
+    link external: { href: "http://example.com" }
+  end
+
+  href :posts_url
+  links posts: { href: :posts_url }
+  links external: { href: "http://example.com" }
+end
+
+class PostsController < ActionController::Base
+  include CollectionJson::Rails::Render
+
+  def index
+    post = Post.new
+    post.title = "My title"
+    post.body = "My first post"
+
+    render json: post, status: :ok
+  end
+end
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collection_json_rails
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Carles Jove i Buxeda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-05 00:00:00.000000000 Z
+date: 2015-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: collection_json_serializer
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.3.4
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -115,12 +115,18 @@ files:
 - lib/collection_json_rails/action_controller/render.rb
 - lib/collection_json_rails/generators/serializer/serializer_generator.rb
 - lib/collection_json_rails/generators/serializer/templates/serializer.rb
+- lib/collection_json_rails/serializer/items.rb
+- lib/collection_json_rails/serializer/objects/item.rb
+- lib/collection_json_rails/serializer/serializer.rb
+- lib/collection_json_rails/support.rb
 - lib/collection_json_rails/version.rb
 - test/controller/accept_template_test.rb
 - test/controller/render_test.rb
 - test/generators/serializer_generator_test.rb
 - test/generators/tmp/app/serializers/user_serializer.rb
 - test/minitest_helper.rb
+- test/serializer_test.rb
+- test/support/test_app.rb
 homepage: https://github.com/carlesjove/collection_json_rails
 licenses:
 - MIT
@@ -151,4 +157,6 @@ test_files:
 - test/generators/serializer_generator_test.rb
 - test/generators/tmp/app/serializers/user_serializer.rb
 - test/minitest_helper.rb
+- test/serializer_test.rb
+- test/support/test_app.rb
 has_rdoc: