collection_json_rails 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 240dd9d091a8eb659286c677b94d636751e337aa
-  data.tar.gz: 147e1d601de30be39add7146439d904f16d690e8
+  metadata.gz: 6ab90519f79112bd980f33d380daf05a4867014d
+  data.tar.gz: 48c259e4f6c18972ac7b2ffb580dddfe360d1041
 SHA512:
-  metadata.gz: 8a726a16a1b3090e749d53bb2e35b21de897c98615aa1124a6193db1141c88e0fa0f2048a6983b76584af30e891e5f06ce1481119b89dc2cebe060478d6e0c8b
-  data.tar.gz: c51c2ceca97f4348e4404a029d78cd914471121553c78e22c22f9090f6145231fe0e09a6a2f5afbc6bd7a438378f120706f2c94ae8f36b9f2cee2081b47107e0
+  metadata.gz: a3c761a6aafae6e0f7df96485777cb414dce60bfc9b9e34631780781e67d060cc6e4d1fc181ae1f9756ba2810e5aba1178e840a96058ee37dea46546cbb482df
+  data.tar.gz: 4cc3269cac6da54a697dba4d7f9bf8ac1843b7f20004a59f8419b17aad3e0a62ab897d3c187c9140779a917f6034b2670892d43929de8bdb9de87193d48c8386

data/README.md

@@ -25,11 +25,18 @@ class PostsController < ApplicationController
   end
 ```
 
-## TO-DO Features
 
 #### One step serialization:
 
+You can respond with Collection+JSON witho no effort, using `render`.
+
 ```ruby
+class PostSerializer < CollectionJson::Serializer
+  items do
+    attributes :title, :body
+  end
+end
+
 class PostsController < ApplicationController
   include CollectionJson::Rails::Render
 
@@ -38,8 +45,11 @@ class PostsController < ApplicationController
 
     render json: @posts, status: :ok
   end
+end
 ```
 
+## TO-DO Features
+
 #### Generators:
 
 ```bash

data/collection_json_rails.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Collection+JSON Serializers with the Rails touch}
   spec.description   = %q{Adds Rails specific funcionalitaties for an enjoyable
   experience}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/carlesjove/collection_json_rails"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -19,10 +19,12 @@ 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_dependency "actionpack", "~> 4.0"
   spec.add_dependency "railties", "~> 4.0"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest", "~> 5.0"
 end

data/lib/collection_json_rails.rb

@@ -1,4 +1,7 @@
+require "collection_json_serializer"
+
 require "collection_json_rails/version"
 
 require "collection_json_rails/action_controller/accept_template"
+require "collection_json_rails/action_controller/render"
 

data/lib/collection_json_rails/action_controller/render.rb

@@ -0,0 +1,47 @@
+module CollectionJson::Rails
+  module Render
+
+    def render(options)
+      super options_for_render(options)
+    end
+
+    private
+
+    def options_for_render(options)
+      result = options
+      if options[:json]
+        result[:json] = serialize(options[:json])
+        result[:status] = options[:status] || :ok
+      end
+
+      result
+    end
+
+    def serialize(resource)
+      serializer_class = serializer_class_of(resource)
+
+      if serializer_class.respond_to?(:new)
+        serializer = serializer_class.new(resource)
+        collection = CollectionJson::Serializer::Builder.new(serializer)
+        collection.pack
+      else
+        resource
+      end
+    end
+
+    # This should probably live at CollectionJson::Serializer
+    def serializer_for(resource)
+      if resource.respond_to?(:to_ary)
+        resource.first.class.name
+      else
+        resource.class.name
+      end
+    end
+
+    def serializer_class_of(resource)
+      resource_class = serializer_for(resource)
+      "#{resource_class}Serializer".safe_constantize
+    end
+  end
+end
+

data/lib/collection_json_rails/version.rb

@@ -1,5 +1,5 @@
 module CollectionJson
   module Rails
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/test/controller/render_test.rb

@@ -0,0 +1,68 @@
+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
+
+  def without_json
+    render nothing: true
+  end
+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
+
+    assert_response :ok
+  end
+
+  def test_that_render_behaves_as_usual
+    get :without_json
+
+    assert_response :ok
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: collection_json_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Carles Jove i Buxeda
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: collection_json_serializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +84,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5.0'
 description: |-
   Adds Rails specific funcionalitaties for an enjoyable
     experience
@@ -98,10 +112,12 @@ files:
 - collection_json_rails.gemspec
 - lib/collection_json_rails.rb
 - lib/collection_json_rails/action_controller/accept_template.rb
+- lib/collection_json_rails/action_controller/render.rb
 - lib/collection_json_rails/version.rb
 - test/controller/accept_template_test.rb
+- test/controller/render_test.rb
 - test/minitest_helper.rb
-homepage: ''
+homepage: https://github.com/carlesjove/collection_json_rails
 licenses:
 - MIT
 metadata: {}
@@ -127,5 +143,6 @@ specification_version: 4
 summary: Collection+JSON Serializers with the Rails touch
 test_files:
 - test/controller/accept_template_test.rb
+- test/controller/render_test.rb
 - test/minitest_helper.rb
 has_rdoc: