collection_json_rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ab90519f79112bd980f33d380daf05a4867014d
-  data.tar.gz: 48c259e4f6c18972ac7b2ffb580dddfe360d1041
+  metadata.gz: 151057d40027eadc3ffb330c66b6be7b0f19f01b
+  data.tar.gz: e66f5b0774f6a3282b27f26ac27e38e10541f7b7
 SHA512:
-  metadata.gz: a3c761a6aafae6e0f7df96485777cb414dce60bfc9b9e34631780781e67d060cc6e4d1fc181ae1f9756ba2810e5aba1178e840a96058ee37dea46546cbb482df
-  data.tar.gz: 4cc3269cac6da54a697dba4d7f9bf8ac1843b7f20004a59f8419b17aad3e0a62ab897d3c187c9140779a917f6034b2670892d43929de8bdb9de87193d48c8386
+  metadata.gz: dcb421e998e2710e24104ee5ca1c7caffe59b5eb8be631151ae6353910291d4868cd8d56956c95632a6f92ef3585bc3a64b4b127830dc6ddbb585dbeceb907aa
+  data.tar.gz: e545172d45e37f9d45f9e66d5ed6b1e608090bc931fb533ae61c8e89d11bc69bc9e73b81ec5bf1f47833a1daeab1c6d97242b616a0eec6015d94f69ec3fac1dc

data/README.md

@@ -1,42 +1,47 @@
-CollectionJson Rails
+Collection+Json Rails
 ====================
 
-This gem will add Rails specific features to [CollectionJson
+Add Rails specific features to [CollectionJson
 Serializer](https://github.com/carlesjove/collection_json_serializer).
 
-## Features
-
-#### Parsing of incoming templates:
+## Installation
 
-It integrates with strong parameters. `accept_template!` accepts one argument:
-the name of the model. That is what you would usually pass at the `require()`
-method of strong parameters. This will parse the incoming template as params,
-and return the result of `params.require(:model)`. Then, you can just proceed as
-usual.
+Add this line to your application's Gemfile:
 
 ```ruby
-class PostsController < ApplicationController
-  include CollectionJson::Rails::AcceptTemplate
+gem 'collection_json_rails'
+```
 
-  private
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install collection_json_rails
 
-  def post_params
-    accept_template!(:post).permit(:title)
-  end
-```
 
+That's all you need. CollectionJson::Serializer is included ;-)
 
-#### One step serialization:
+## Usage
 
-You can respond with Collection+JSON witho no effort, using `render`.
+You just need to create serializers for your models. Here's an example:
 
 ```ruby
 class PostSerializer < CollectionJson::Serializer
   items do
     attributes :title, :body
   end
+
+  template :title, :body
 end
+```
 
+#### Responding with Collection+JSON
+
+Now you can respond with Collection+JSON using the regular `render`:
+
+```ruby
 class PostsController < ApplicationController
   include CollectionJson::Rails::Render
 
@@ -48,45 +53,56 @@ class PostsController < ApplicationController
 end
 ```
 
-## TO-DO Features
-
-#### Generators:
 
-```bash
-$ rails g cj:serializer post
-# => app/serializers/post_serializer.rb
-```
+#### Accepting templates:
 
-Wonder: should be invocated by scaffold, models, etc. generators?
+Collection+JSON supports write templates (YEAH!). You can accept them easily by using `accept_template!` in a similar fashion as you'd use strong parameters.
 
-#### URLs helpers
+`accept_template!` takes one argument: the name of the model (that's what you'd usually pass to `require` when using strong parameters). Then, you can proceed as usual and whitelist attributes with `permit`.
 
-No more fighting with routes generation:
+Note: Noticed the exclamation mark? This means that `accept_template!` rewrites
+`params`. Should `params[:model]` be present, it'd be rewritten with template's
+attributes. All other attributes of `params` are untouched.
 
 ```ruby
-class PostSerializer < CollectionJson::Serializer
-  href :posts_url
+class PostsController < ApplicationController
+  include CollectionJson::Rails::AcceptTemplate
 
-  items do
-    href :post_url, :self
+  private
+
+  def post_params
+    accept_template!(:post).permit(:title, :body)
+  end
 ```
 
-## Installation
+#### Generators:
 
-Add this line to your application's Gemfile:
+`$ rails g cj serializer post title body`
 
 ```ruby
-gem 'collection_json_rails'
+# app/serializers/post_serializer.rb
+
+class PostSerializer < CollectionJson::Serializer
+  items do
+    attributes :title, :body
+  end
+end
 ```
 
-And then execute:
 
-    $ bundle
+## TO-DO Features
 
-Or install it yourself as:
+#### URLs helpers
 
-    $ gem install collection_json_rails
+No more fighting with routes generation:
 
+```ruby
+class PostSerializer < CollectionJson::Serializer
+  href :posts_url
+
+  items do
+    href :post_url, :self
+```
 
 ## Contributing
 

data/lib/collection_json_rails/generators/serializer/serializer_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+
+module Rails
+  module Generators
+    class SerializerGenerator < NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+      namespace "cj"
+
+      argument :attributes, type: :array, default: [], banner: "field"
+
+      def create_serializer
+        template "serializer.rb",
+                 File.join("app/serializers", class_path,
+                 "#{file_name}_serializer.rb")
+      end
+
+      private
+
+      def item_attributes
+        attributes.map { |a| ":#{a.name}" }
+      end
+    end
+  end
+end
+

data/lib/collection_json_rails/generators/serializer/templates/serializer.rb

@@ -0,0 +1,8 @@
+class <%= class_name %>Serializer < CollectionJson::Serializer
+  <% if attributes.any? -%>
+  items do
+    attributes <%= item_attributes.join(', ') %>
+  end
+  <% end -%>
+end
+

data/lib/collection_json_rails/version.rb

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

data/lib/collection_json_rails.rb

@@ -5,3 +5,5 @@ require "collection_json_rails/version"
 require "collection_json_rails/action_controller/accept_template"
 require "collection_json_rails/action_controller/render"
 
+require "collection_json_rails/generators/serializer/serializer_generator"
+

data/test/generators/serializer_generator_test.rb

@@ -0,0 +1,33 @@
+require 'minitest_helper'
+require 'rails/generators'
+
+class SerializerGeneratorTest < Rails::Generators::TestCase
+  destination File.expand_path("../tmp", __FILE__)
+  setup :prepare_destination
+  tests Rails::Generators::SerializerGenerator
+
+  def test_that_a_serializer_is_generated
+    run_generator %w(user)
+
+    assert_file "app/serializers/user_serializer.rb",
+                /class UserSerializer < CollectionJson::Serializer/
+  end
+
+  def test_that_attributes_can_be_passed
+    run_generator %w(user first_name email)
+
+    assert_file "app/serializers/user_serializer.rb" do |serializer|
+      assert_match /items do/, serializer
+      assert_match /attributes :first_name, :email/, serializer
+      assert_match /end/, serializer
+    end
+  end
+
+  def test_that_a_serializer_can_be_generated_in_a_namespace
+    run_generator %w(admin/user)
+
+    assert_file "app/serializers/admin/user_serializer.rb",
+                /class Admin::UserSerializer < CollectionJson::Serializer/
+  end
+end
+

data/test/generators/tmp/app/serializers/user_serializer.rb

@@ -0,0 +1,6 @@
+class UserSerializer < CollectionJson::Serializer
+    items do
+    attributes :first_name, :email
+  end
+  end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collection_json_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Carles Jove i Buxeda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: collection_json_serializer
@@ -113,9 +113,13 @@ files:
 - 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/generators/serializer/serializer_generator.rb
+- lib/collection_json_rails/generators/serializer/templates/serializer.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
 homepage: https://github.com/carlesjove/collection_json_rails
 licenses:
@@ -144,5 +148,7 @@ summary: Collection+JSON Serializers with the Rails touch
 test_files:
 - 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
 has_rdoc: