jbuilder_serializer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36be22338d778f94c7d1ace10fecf99e9a4773c9
+  data.tar.gz: 17df7d38e3053f72ad641eea495062bc4c5d36bf
+SHA512:
+  metadata.gz: ecab5ff70cda045f9ac6abc3e0c567bf0fafe98ae2d4417212c851b49d45f0c0c3ff6a8459166ad352eec2d9b5761081e710f527131988ee1ceaa4f22c781c10
+  data.tar.gz: 55a259fa910258fd6585534357f6a1c5238caa98cd020cce7277acdaeb4791253b8bc585a4698ba4bea79a37b904f20053aca8e086052fd93770b6efe2b50c15

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jeckle.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    jbuilder_serializer (0.0.1)
+      actionpack (~> 4.0)
+      jbuilder (~> 2.2.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.1.6)
+      actionview (= 4.1.6)
+      activesupport (= 4.1.6)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.6)
+      activesupport (= 4.1.6)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activesupport (4.1.6)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    i18n (0.6.11)
+    jbuilder (2.2.2)
+      activesupport (>= 3.0.0, < 5)
+      multi_json (~> 1.2)
+    json (1.8.1)
+    minitest (5.4.2)
+    multi_json (1.10.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.3.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  jbuilder_serializer!
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Mateus Gomes
+
+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,5 @@
+# Jbuilder Serializer
+
+Serializers integrated with jbuilder views.
+
+Provides a class to handle variables assignment and uses a jbuilder view to define the JSON structure. Useful for using jbuilder outside of a controller `render` call.

data/jbuilder_serializer.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'jbuilder/serializer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jbuilder_serializer'
+  spec.version       = Jbuilder::Serializer::VERSION
+  spec.authors       = ['Mateus Gomes']
+  spec.email         = ['mateusg.18@gmail.com']
+  spec.description   = 'Allows creation of serializer classes integrated with jbuilder views'
+  spec.summary       = 'Allows creation of serializer classes integrated with jbuilder views'
+  spec.homepage      = 'https://github.com/mateusg/jbuilder_serializer'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'actionpack', '~> 4.0'
+  spec.add_dependency 'jbuilder', '~> 2.2.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/jbuilder/serializer.rb

@@ -0,0 +1,86 @@
+require 'active_support'
+require 'action_controller'
+
+# Wraps jbuilder into a serializer class, so it can be used outside of a controller action.
+#
+# == Usage
+#
+#   Create a serializer and define the `template_path` and `locals` for jbuilder view.
+#
+#   # app/serializers/order_create_serializer.rb
+#   class OrderCreateSerializer < Jbuilder::Serializer
+#     set_template_path File.expand_path('views', __dir__)
+#
+#     locals do |attrs|
+#       @order = attrs[:order]
+#       @author = attrs[:user]
+#       @items = @order.items.select &:active?
+#     end
+#   end
+#
+#   Create your jbuilder view file and place it on the folder specified through `template_path`.
+#
+#   # app/serializers/views/order_create.json.jbuilder
+#   json.order do
+#     json.created_by @author.username
+#     json.id @order.id
+#     json.items @items do |item|
+#       json.id item.id
+#       json.quantity item.quantity
+#     end
+#   end
+#
+#   Then instantiate the serializer, providing its args for `locals` assignment.
+#
+#   serializer = OrderCreateSerializer.new(order: @order, user: current_user)
+#   serializer.to_json
+#   => "{\"order\": {\"created_by\": \"donald-duck\", \"id\":34, \"items\": [{\"id\": 78, \"quantity\": 1},{\"id\": 94, \"quantity\": 3}]}}"
+#
+module Jbuilder
+  class Serializer
+    class_attribute :locals_block, :template_path
+
+    # Sets locals (instance variables) to be used within the jbuilder template.
+    def self.locals(&block)
+      raise ArgumentError, 'no block given' unless block_given?
+
+      self.locals_block = block
+    end
+
+    # Sets path to look for jbuilder templates.
+    def self.set_template_path(path)
+      self.template_path = path
+    end
+
+    def self.inherited(base)
+      base.class_eval do
+        @locals_block = superclass.locals_block
+        @template_path = superclass.template_path
+      end
+    end
+
+    def initialize(*args)
+      renderer.instance_exec *args, &locals_block if locals_block
+    end
+
+    # Jbuilder view name. By default, it has the same name as the serializer.
+    def template_name
+      self.class.name.demodulize.underscore.gsub '_serializer', ''
+    end
+
+    # Returns resulting json as string.
+    def to_json
+      renderer.render_to_string template: template_name, handler: :jbuilder
+    end
+
+    private
+
+    def renderer
+      @renderer ||= ActionController::Base.new.tap do |r|
+        r.prepend_view_path template_path
+        r.lookup_context.formats = [:json]
+        r.lookup_context.handlers = [:jbuilder]
+      end
+    end
+  end
+end

data/lib/jbuilder/serializer/version.rb

@@ -0,0 +1,5 @@
+module Jbuilder
+  class Serializer
+    VERSION = '0.0.1'
+  end
+end

data/spec/serializers/jbuilder/serializer.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+RSpec.describe Jbuilder::Serializer do
+  subject(:serializer) { serializer_class.new }
+
+  let(:serializer_class) { Class.new described_class }
+  let(:renderer) { serializer.send :renderer }
+
+  before do
+    allow(serializer_class).to receive(:name).and_return 'SampleSerializer'
+  end
+
+  describe '.set_template_path' do
+    let(:template_path) { 'name' }
+
+    it 'sets template_path for instances' do
+      serializer_class.set_template_path template_path
+
+      expect(serializer_class.new.template_path).to eq template_path
+    end
+  end
+
+  describe '.locals' do
+    context 'when no block is given' do
+      it 'raises error' do
+        expect {
+          serializer_class.locals
+        }.to raise_error ArgumentError, /no block given/
+      end
+    end
+
+    context 'when a block is given' do
+      before { serializer_class.locals { 1 } }
+
+      it 'assigns it into @locals_block for later evaluation' do
+        expect(serializer_class.locals_block).to be_a Proc
+      end
+    end
+  end
+
+  describe '#initialize' do
+    before do
+      serializer_class.locals do
+        @name = 'Daenerys Targaryen'
+        @polemicos = 'name'
+      end
+    end
+
+    it 'executes locals block on renderer context' do
+      expect(renderer.instance_variable_get('@name')).to eq 'Daenerys Targaryen'
+      expect(renderer.instance_variable_get('@polemicos')).to eq 'name'
+    end
+  end
+
+  describe '#to_json' do
+    it 'renders jbuilder template as string' do
+      expect(renderer).to receive(:render_to_string).with handler: :jbuilder, template: serializer.template_name
+
+      serializer.to_json
+    end
+  end
+
+  describe '#template_name' do
+    it 'returns class name without _serializer suffix' do
+      expect(serializer.template_name).to eq 'sample'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'jbuilder/serializer'
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: jbuilder_serializer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mateus Gomes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows creation of serializer classes integrated with jbuilder views
+email:
+- mateusg.18@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- jbuilder_serializer.gemspec
+- lib/jbuilder/serializer.rb
+- lib/jbuilder/serializer/version.rb
+- spec/serializers/jbuilder/serializer.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mateusg/jbuilder_serializer
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Allows creation of serializer classes integrated with jbuilder views
+test_files:
+- spec/serializers/jbuilder/serializer.rb
+- spec/spec_helper.rb
+has_rdoc: