granola-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8563859c55e7e38a16263a1b06c620b36bbe099b
+  data.tar.gz: 2cfaa303a65ebc7d1ce909faeff653b2df73b3f2
+SHA512:
+  metadata.gz: 01a368327ebd252226fb9f9307caadf84048736cc4d6a2e2767b508ef0fa14bdcd0fb7e35b21d1ba6a5b678868f22ea61f1673e74d249d5036eb4fc64f578814
+  data.tar.gz: 0b98441bf576d117e30d9f22183c0ee6702bb0ee0f889c0fc9a2e5ef15368442be517679e809b99ac68dd5de08937454c2a797dff295ccdf5b86e400d468b284

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Nicolas Sanguinetti
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# Granola::Rails [![Build Status](https://img.shields.io/travis/foca/granola-rails.svg)](https://travis-ci.org/foca/granola-rails) [![RubyGem](https://img.shields.io/gem/v/granola-rails.svg)](https://rubygems.org/gems/granola-rails)
+
+Integrate [Granola](https://github.com/foca/granola) into Rails' rendering.
+
+## Usage
+
+Once you install it, you can just use `render` to use Granola serializers:
+
+``` ruby
+class UsersController < ApplicationController
+  def show
+    user = User.find(params[:id])
+    render json: user
+  end
+end
+```
+
+This would infer a `UserSerializer` (in `app/serializers/user_serializer.rb`).
+You can pass any options to this method that you could pass to
+[`Granola::Rack#granola`][granola-rack]. For example, to use a different
+serializer:
+
+``` ruby
+class UsersController < ApplicationController
+  def show
+    user = User.find(params[:id])
+    render json: user, with: DetailedUserSerializer
+  end
+end
+```
+
+[granola-rack]: https://github.com/foca/granola/blob/master/lib/granola/rack.rb
+
+### Serialization formats
+
+Any serialization format you add to Granola via `Granola.render` will be
+available to render through rails. For example:
+
+``` ruby
+# config/initializers/granola.rb
+Granola.render :yaml, via: YAML.method(:dump), content_type: Mime[:yaml].to_s
+
+# app/controllers/users_controller.rb
+class UsersController < ApplicationController
+  def show
+    user = User.find(params[:id])
+
+    respond_to do |format|
+      format.json { render json: user }
+      format.yaml { render yaml: user }
+    end
+  end
+end
+```
+
+## Rails Generators
+
+This library provides a `serializer` generator:
+
+``` bash
+$ rails generate serializer user
+      create  app/serializers/user_serializer.rb
+      invoke  test_unit
+      create    test/serializers/user_serializer_test.rb
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'granola-rails'
+```
+
+And then execute:
+
+``` sh
+$ bundle
+```
+
+Or install it yourself as:
+
+``` sh
+$ gem install granola-rails
+```
+
+## License
+
+The gem is available as open source under the terms of the MIT License. See the
+[LICENSE](./LICENSE) for detjsonails.

data/lib/granola/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Granola
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/granola/rails.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "rails/version"
+
+require "granola/rack"
+require "rails/railtie"
+require "active_support/concern"
+
+module Granola
+  # Helpers to integrate Granola into Rails' rendering flow.
+  #
+  # Example:
+  #
+  #   class API::UsersController < ApplicationController
+  #     def show
+  #       user = User.find(params[:id])
+  #       render json: user, with: API::UserSerializer
+  #     end
+  #   end
+  module Rails
+    # Internal: Let ActionController know about any renderers you add to Granola
+    # by defining an ActionController::Renderer based on Granola's.
+    #
+    # format - A Symbol with a rendering format (e.g. `:json`).
+    #
+    # Returns nothing.
+    def self.install_renderer(format)
+      ActionController::Renderers.remove(format)
+      ActionController::Renderers.add(format) do |object, options|
+        granola(object, **options.merge(as: format))
+      end
+    end
+
+    include Granola::Rack
+
+    # Public: Low-level API to respond with a serialized object. You should
+    # prefer using ActionController's `render` with the serialization format
+    # (e.g. `render json: object, with: SomeSerializer`).
+    #
+    # object    - An Object to be passed to a Granola::Serializer.
+    # **options - Keywords to configure this response. See
+    #             `Granola::Rack#granola` for a full list.
+    #
+    # Returns nothing.
+    def granola(object, **options)
+      options = { status: self.status, env: request.env }.update(options)
+      status, headers, body = super(object, **options)
+
+      response.status = status
+      response.headers.update(headers)
+      self.response_body = body
+    end
+  end
+
+  module RendererRegistration # :nodoc:
+    def self.render(format, *) # :nodoc:
+      super.tap { Granola::Rails.install_renderer(format) }
+    end
+  end
+
+  class << self
+    # Defining a new rendering format should add it to Rails' rendering.
+    prepend RendererRegistration
+  end
+
+  class Railtie < ::Rails::Railtie # :nodoc:
+    initializer "granola.action_controller" do
+      ActiveSupport.on_load(:action_controller) do
+        include Granola::Rails
+
+        Granola.renderable_formats.each do |format|
+          Granola::Rails.install_renderer(format)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: granola-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Sanguinetti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: granola
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Granola provides a simple and fast API to serialize objects into multiple
+  formats.
+  Granola::Rails just simplifies using Granola from Rails apps.
+email:
+- contacto@nicolassanguinetti.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/granola/rails.rb
+- lib/granola/rails/version.rb
+homepage: https://github.com/foca/granola-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Rails interface to Granola serializers.
+test_files: []