alephant-renderer 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9591905fd45c75107c668cd11a21c8beb281d83
-  data.tar.gz: 411a4f3a3b03a1f6adaf3aa78068bbeeb15b1e63
+  metadata.gz: ac57f02826b45a9bccb89bd778cbc9b5c997c42a
+  data.tar.gz: 2c294492baa6c21d5bd7d11fbd861587d5b34162
 SHA512:
-  metadata.gz: f568b783142251a21023d92f44daf86821c396c5c23b16baa5b2c512953a8fdb31a8dd364b1762cfaee8e6be4b984a41abd8f009ba63fd10a1deb999f27500e6
-  data.tar.gz: a7c27d89826d706bb0b414e7490b35cedf0f2811940106cd95377b93b938a75884539b9d2f37a69cc593438173df313c90b913dbd9534fbe43f1728e2c9a583c
+  metadata.gz: 0eea72adabbd3c187273ce615e2367a3085b6546a270738f59017b13d94093b151393db3edcc03267537d7221d8fb1905d226cbd3dfbaf4c106ac1a133e39704
+  data.tar.gz: 9e6529da65b64101c121373e5242b272270633b2bdfe843cb9b69427dd2381b1106df274cde63dcc669f8912b94791feb0741252521cabd924420f955a545262

data/Gemfile

@@ -1,3 +1,3 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 gemspec

data/Guardfile

@@ -1,6 +1,6 @@
-guard "rspec" do
+guard 'rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/.+\.rb$})
-  watch(%r{^spec/support/(.+)\.rb$}) { "spec" }
-  watch("spec/spec_helper.rb") { "spec" }
+  watch(%r{^spec/support/(.+)\.rb$}) { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
 end

data/README.md

@@ -20,47 +20,7 @@ Or install it yourself as:
 
 ## Setup
 
-This gem requires you to have at least one component, which has within it at least one view/template pair.
-
-```bash
-src
-├── components
-│   ├── weather
-│   │   ├── models
-│   │   │   ├── daily_summary.rb
-│   │   │   ├── weekly_summary.rb
-│   │   ├── templates
-│   │   │   ├── daily_summary.mustache
-│   │   │   ├── weekly_summary.mustache
-```
-
-> daily_summary.rb
-
-```ruby
-require 'alephant/renderer/views/html'
-require 'date'
-
-class DailySummary < Alephant::Renderer::Views::Html
-  def temp
-    @data[:time].round 0
-  end
-
-  def time
-    DateTime.now.strftime "%d/%m/%Y %H:%M"
-  end
-
-  def summary
-    @data[:summary].capitalize
-  end
-end
-```
-
-> daily_summary.mustache
-
-```mustache
-Weather for {{ time }}
-{{ summary }} - {{ temp }}°
-```
+Please see the wiki guide on [setting up a basic renderer](https://github.com/BBC-News/alephant-renderer/wiki/Setting-up-a-basic-renderer).
 
 ## Usage
 
@@ -85,6 +45,10 @@ Alephant::Renderer.create(
 
 **Note** - Within you application you will be most likely providing the *data* dynamically and thus will not require the JSON library.
 
+## Documentation
+
+We have a [wiki](https://github.com/BBC-News/alephant-renderer/wiki)!
+
 #### Example Application
 
 The [alephant-publisher-request](https://github.com/BBC-News/alephant-publisher-request) gem is an example of an application which utilises this gem. Overview of process:
@@ -94,164 +58,6 @@ The [alephant-publisher-request](https://github.com/BBC-News/alephant-publisher-
 3. Renders specified component using data.
 4. Returns rendered template.
 
-## Translations
-
-Currently there is a simple implementation of the [i18n](https://github.com/svenfuchs/i18n) library that allows templates to be translated.
-
-### Setup
-
-You need the following directory structure inside of the folder that relates to the `base_path`:
-
-```bash
-components
-├── locale
-│   ├── en.yml
-│   ├── cy.yml
-```
-
-The yaml configs must have the extension `.yml`.
-
-### Yaml structure
-
-The yaml translations files must follow the following structure:
-
-```yaml
-en:
-  template_name:
-    key: 'foo'
-    sub:
-      key: 'bar'
-
-  another_template:
-    key: 'baz'
-```
-
-The first node is the language code, then the next set of nodes are the names of the templates files that the translations apply to. This allows you to just reference the translation key in the templates without prefixing the name of the template.
-
-### Usage
-
-For each translation, a seperate model and view is needed.
-
-#### Model
-
-A model should override the `locale` method:
-
-```ruby
-class TestModel < Alephant::Views::HTML
-  def locale
-      :cy
-  end
-end
-```
-
-#### Translations
-
-The best approach with the templates when translations are needed, is to have a base template then a seperate one for each lanuage that's being translated.
-
-In each view model, the following method is available for translations:
-
-```ruby
-t 'my_key'
-```
-
-#### Example
-
-If we had a template called 'test_template.mustache' we would have the following in the model 'test_template.rb':
-
->test_template.rb
-
-```ruby
-def my_translation
-  t 'key'
-end
-```
-
->test_template.mustache
-
-```mustache
-{{ my_translation }}
-```
-
->locale/en.yml
-
-```yaml
-en:
-  test_template:
-    key: 'A translation!'
-```
-
-##### Other options
-
-The `t()` method takes a second hash argument for accessing other I18n features. Below are a few of the more common uses of this argument.
-
-By default, if the translation key doesn't exist then the translation key is used as the translation. You can override this behaviour and provide an explicit default:
-
-```ruby
-def my_translation
-  t 'missing_key', default: 'Some default'
-end
-```
-
-Plurality can also be handled, including support for languages with multiple pluralities. You would define your translation in the yaml file like this:
-
-```yaml
-en:
-    test_template:
-        pluralized_key:
-            one: 'Singular string'
-            other: 'Plural string'
-```
-and the code would look like:
-```ruby
-t 'pluralized_key', count: @num_of_things
-```
-
-You can force it to use a different locale if you need:
-```ruby
-t 'some_key', locale: :cy
-```
-
-You can use strings from another subsection of the translations. E.g. if your renderer was currently _myRenderer_ and your translations yaml looked like this:
-```yaml
-en:
-    myRenderer:
-        'some_key': 'some string'
-    general:
-        'another_key': 'another string'
-```
-You can do this in code:
-```ruby
-t 'another_key', scope: 'general'
-```
-
-You can do simple variable substitution, as often dynamic data can be in a different position in different strings. Your yaml might look like:
-```yaml
-en:
-    myRenderer:
-        'some_key': 'some %{insert} string'
-```
-and the code looks like:
-```ruby
-t 'some_key', insert: 'text inserted into a'
-```
-
-## Templates
-
-The template engine is built into the Alephant::Views::HTML class. Create methods that correspond to variables, and they will become available to the template.
-
-### Paths
-
-There are two template paths in Alephant, the template path and the partials path. By default in HTML renderers, the template path is `../templates/` from your model, and the partials path is `../../lib/templates` from your model. You can change either of these pathing strategies by overridding the default renderer_engine instantiation.
-
-```ruby
-def renderer_engine
-  partial_path = File.join(base_path, 'templates/')
-  Alephant::Renderer::Engine::Mustache.new(base_path, template_name, partial_path)
-end
-```
-In the above example, base_path is the parent of the current model folder, so this will make the partials path equal to the template path.
-
-
 ## Contributing
 
 1. [Fork it!](http://github.com/bbc-news/alephant-renderer/fork)
@@ -261,3 +67,9 @@ In the above example, base_path is the parent of the current model folder, so th
 5. Create new [Pull Request](https://github.com/BBC-News/alephant-renderer/pulls).
 
 Feel free to create an [issue](https://github.com/BBC-News/alephant-renderer/issues/new) if you find a bug.
+
+## Coding standards
+
+For any submission, please:
+1. Run rubocop against it, using [these standards](https://github.com/BBC-News/rubocop-config)
+2. Ensure all unit tests pass (these are also checked on pushing to your branch)

data/Rakefile

@@ -1,8 +1,8 @@
-$:.unshift File.join(File.dirname(__FILE__), "lib")
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), 'lib')
 
-require "rspec/core/rake_task"
-require "bundler/gem_tasks"
-require "alephant/renderer"
-require "rake/rspec"
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+require 'alephant/renderer'
+require 'rake/rspec'
 
-task :default => :spec
+task default: :spec

data/lib/alephant/renderer.rb

@@ -1,6 +1,6 @@
-require "alephant/renderer/version"
-require "alephant/renderer/view_mapper"
-require "alephant/logger"
+require 'alephant/renderer/version'
+require 'alephant/renderer/view_mapper'
+require 'alephant/logger'
 
 module Alephant
   module Renderer
@@ -25,16 +25,15 @@ module Alephant
       private
 
       def mapper
-        @mapper ||= ViewMapper.new(
-          config[:renderer_id],
-          config[:view_path]
-        ).tap do
+        @mapper ||= begin
           logger.info(
-            "event"      => "ViewMapperCreated",
-            "rendererId" => config[:renderer_id],
-            "viewPath"   => config[:view_path],
-            "method"     => "#{self.class}#mapper"
+            event:      :ViewMapperCreated,
+            rendererId: config[:renderer_id],
+            viewPath:   config[:view_path],
+            method:     "#{self.class}#mapper"
           )
+
+          ViewMapper.new(config[:renderer_id], config[:view_path])
         end
       end
     end

data/lib/alephant/renderer/i18n/json.rb

@@ -0,0 +1,29 @@
+require 'json'
+
+module Alephant
+  module Renderer
+    module I18n
+      class Json < LocaleComponentYaml
+        private
+
+        def load_translations
+          return unless i18n_lib.load_path.empty?
+          translations_files.map do |file|
+            store_translation(file)
+          end
+        end
+
+        def store_translation(file)
+          translations = JSON.parse(File.read(file))
+          translations.each do |locale, content|
+            i18n_lib.backend.store_translations(locale, content)
+          end
+        end
+
+        def translation_filename
+          File.join(translations_path, '*.json')
+        end
+      end
+    end
+  end
+end

data/lib/alephant/renderer/i18n/locale_component_yaml.rb

@@ -33,13 +33,11 @@ module Alephant
         end
 
         def translation_filename
-          File.join(
-            translations_path,
-            '*.yml')
+          File.join(translations_path, '*.yml')
         end
 
         def translations_path
-          @translations_path || './components/lib/locales'
+          @translations_path || './components/lib/locale'
         end
 
         def i18n_lib

data/lib/alephant/renderer/response.rb

@@ -1,10 +1,16 @@
-require "json"
+require 'json'
 
 module Alephant
   module Renderer
-    class Response < Struct.new(:content)
+    class Response
+      attr_accessor :content
+
+      def initialize(content)
+        @content = content
+      end
+
       def to_json
-        ::JSON.generate "content" => content
+        ::JSON.generate 'content' => content
       end
     end
   end

data/lib/alephant/renderer/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Renderer
-    VERSION = '3.0.0'.freeze
+    VERSION = '3.1.0'.freeze
   end
 end

data/lib/alephant/renderer/view_mapper.rb

@@ -1,17 +1,15 @@
-require "alephant/renderer/error/invalid_path"
-require "alephant/logger"
+require 'alephant/renderer/error/invalid_path'
+require 'alephant/logger'
 
 module Alephant
   module Renderer
     class ViewMapper
       include Logger
 
-      DEFAULT_LOCATION = "components"
+      DEFAULT_LOCATION = 'components'.freeze
 
-      def initialize(renderer_id, view_base_path=nil)
-        unless view_base_path.nil?
-          self.base_path = "#{view_base_path}/#{renderer_id}"
-        end
+      def initialize(renderer_id, view_base_path = nil)
+        self.base_path = "#{view_base_path}/#{renderer_id}" unless view_base_path.nil?
       end
 
       def base_path
@@ -24,24 +22,22 @@ module Alephant
 
       def generate(data)
         model_locations.reduce({}) do |obj, file|
-          obj.tap do |o|
-            model_id = model_id_for file
-            o[model_id] = model(model_id, data)
-          end
+          model_id      = model_id_for(file)
+          obj[model_id] = model(model_id, data)
+          obj
         end
       end
 
       private
 
       def raise_error(path)
-        fail(Error::InvalidBasePath.new(path)).tap do
-          logger.metric("ViewMapperInvalidPath")
-          logger.error(
-            "event"  => "ViewMapperBasePathInvalidFound",
-            "path"   => path,
-            "method" => "#{self.class}#raise_error"
-          )
-        end
+        logger.metric('ViewMapperInvalidPath')
+        logger.error(
+          event:  :ViewMapperBasePathInvalidFound,
+          path:   path,
+          method: "#{self.class}#raise_error"
+        )
+        raise(Error::InvalidBasePath.new(path))
       end
 
       def model(view_id, data)
@@ -50,7 +46,7 @@ module Alephant
       end
 
       def model_location_for(view_id)
-        File.join(base_path, "models", "#{view_id}.rb")
+        File.join(base_path, 'models', "#{view_id}.rb")
       end
 
       def model_locations
@@ -62,7 +58,7 @@ module Alephant
       end
 
       def model_id_for(location)
-        location.split("/").last.sub(/\.rb/, "")
+        location.split('/').last.sub(/\.rb/, '')
       end
     end
   end

data/lib/alephant/renderer/views.rb

@@ -1,22 +1,28 @@
 module Alephant
   module Renderer
     module Views
-      @@views = {}
+      class << self
+        def register(klass)
+          views[underscorify(klass.name.split('::').last)] = klass
+        end
 
-      def self.register(klass)
-        @@views[underscorify(klass.name.split("::").last)] = klass
-      end
+        def get_registered_class(id)
+          views[id.downcase]
+        end
 
-      def self.get_registered_class(id)
-        @@views[id.downcase]
-      end
+        def underscorify(str)
+          str.gsub(/::/, '/')
+             .gsub(/([A-Z]+)([A-Z][a-z])/, '\\1_\\2')
+             .gsub(/([a-z\d])([A-Z])/, '\\1_\\2')
+             .tr('-', '_')
+             .downcase
+        end
+
+        private
 
-      def self.underscorify(str)
-        str.gsub(/::/, "/").
-          gsub(/([A-Z]+)([A-Z][a-z])/,"\\1_\\2").
-          gsub(/([a-z\d])([A-Z])/,"\\1_\\2").
-          tr("-", "_").
-          downcase
+        def views
+          @views ||= {}
+        end
       end
     end
   end

data/lib/alephant/renderer/views/envelope.rb

@@ -0,0 +1,48 @@
+require_relative './json.rb'
+require 'json'
+
+module Alephant
+  module Renderer
+    module Views
+      class Envelope < Json
+        def head
+          []
+        end
+
+        def body_last
+          []
+        end
+
+        def locale
+          :en
+        end
+
+        def render
+          {
+            head:       head,
+            bodyInline: renderer_engine.render(self),
+            bodyLast:   body_last
+          }.to_json
+        end
+
+        private
+
+        def renderer_engine
+          Alephant::Renderer::Engine::Mustache.new(base_path, template_name)
+        end
+
+        def template_name
+          Mustache.underscore(self.class.to_s).split('/').last
+        end
+
+        def translator
+          @translator || Alephant::Renderer::I18n::LocaleComponentYaml.new(locale, template_name)
+        end
+
+        def t(key, params = {})
+          translator.t(key, params)
+        end
+      end
+    end
+  end
+end

data/lib/alephant/renderer/views/html.rb

@@ -29,13 +29,15 @@ module Alephant
           Alephant::Renderer::I18n::LocaleComponentYaml.new(
             locale,
             template_name,
-            translations_path)
+            translations_path
+          )
         end
 
         def translations_path
           File.join(
             Pathname.new(base_path).parent,
-            'locale')
+            'locale'
+          )
         end
 
         def renderer_engine

data/lib/alephant/renderer/views/json.rb

@@ -1,5 +1,5 @@
-require "alephant/renderer/views/base"
-require "json"
+require 'alephant/renderer/views/base'
+require 'json'
 
 module Alephant
   module Renderer
@@ -8,7 +8,7 @@ module Alephant
         include ::Alephant::Renderer::Views::Base
 
         def setup
-          @content_type = "application/json"
+          @content_type = 'application/json'
         end
 
         def render

data/spec/fixtures/components/foo-renderer/models/envelope.rb

@@ -0,0 +1,15 @@
+module MyApp
+  class Envelope < Alephant::Renderer::Views::Envelope
+    def head
+      ['some/css/asset/path','some/js/asset/path']
+    end
+
+    def body_last
+      ['some/thing/to/add/after/body', 'some/other/thing/to/add/after/body']
+    end
+
+    def greet
+      @data[:foo]
+    end
+  end
+end

data/spec/fixtures/components/foo-renderer/models/json.rb

@@ -1,7 +1,7 @@
 module MyApp
   class Json < Alephant::Renderer::Views::Json
     def whitelist
-      ["item1", "item2"]
+      %w(item1 item2)
     end
 
     def item1

data/spec/fixtures/components/foo-renderer/templates/envelope.mustache

@@ -0,0 +1 @@
+<h1>Hello, I'm a {{greet}} template</h1>

data/spec/integration/fixtures/translations.json

@@ -0,0 +1,15 @@
+{
+    "en": {
+        "my_namespace": {
+            "some_string": "some string"
+        }
+    },
+    "cy": {
+        "other_namespace": {
+            "some_string": {
+                "one": "another string",
+                "other": "another %{count} strings"
+            }
+        }
+    }
+}

data/spec/integration/i18n_json_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require File.dirname(__FILE__) + '/../../lib/alephant/renderer/i18n/json'
+
+describe Alephant::Renderer::I18n::Json do
+  let(:template_path) { File.join(File.dirname(__FILE__), 'fixtures') }
+  let(:locale) { 'en' }
+  let(:namespace) { 'my_namespace' }
+
+  subject { described_class.new(locale, namespace, template_path) }
+
+  describe 'json translations' do
+    let(:params) do
+      {
+        locale: 'cy',
+        count:  1,
+        scope:  'other_namespace'
+      }
+    end
+    it 'should translate a string held in a json document' do
+      expect(subject.t(:some_string, params)).to eq('another string')
+    end
+  end
+end

data/spec/integration/spec_helper.rb

@@ -1 +1 @@
-require_relative "../spec_helper"
+require_relative '../spec_helper'

data/spec/renderer_spec.rb

@@ -1,16 +1,16 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Alephant::Renderer do
-  let(:config) {
+  let(:config) do
     {
-      :renderer_id => "foo-renderer",
-      :view_path   => File.join(File.dirname(__FILE__), "fixtures/components"),
+      renderer_id: 'foo-renderer',
+      view_path:   File.join(File.dirname(__FILE__), 'fixtures/components')
     }
-  }
-  let(:data) { { :content => "test" } }
+  end
+  let(:data) { { content: 'test' } }
 
-  describe ".create" do
-    context "using valid params" do
+  describe '.create' do
+    context 'using valid params' do
       let(:expected) { Alephant::Renderer::Renderer }
 
       specify do
@@ -22,36 +22,40 @@ describe Alephant::Renderer do
   describe Alephant::Renderer::Renderer do
     subject { Alephant::Renderer::Renderer.new(config, data) }
 
-    describe "#config" do
+    describe '#config' do
       specify { expect(subject.config).to eql config }
     end
 
-    describe "#data" do
+    describe '#data' do
       specify { expect(subject.data).to eql data }
     end
 
-    describe "#views" do
-      it "returns a Hash" do
+    describe '#views' do
+      it 'returns a Hash' do
         expect(subject.views).to be_a Hash
       end
 
-      context "using three Models" do
-        it "returns three Views in Hash" do
-          expect(subject.views.length).to eql 3
+      context 'using four Models' do
+        it 'returns three Views in Hash' do
+          expect(subject.views.length).to eql 4
         end
       end
 
-      context "using `bar`, `foo`, `json` models" do
-        it "contains a View for `bar` model" do
-          expect(subject.views.key? "BAR_ABC").to be
+      context 'using `bar`, `foo`, `json` models' do
+        it 'contains a View for `bar` model' do
+          expect(subject.views.key?('BAR_ABC')).to be
+        end
+
+        it 'contains a View for `foo` model' do
+          expect(subject.views.key?('foo_xyz')).to be
         end
 
-        it "contains a View for `foo` model" do
-          expect(subject.views.key? "foo_xyz").to be
+        it 'contains a View for `json` model' do
+          expect(subject.views.key?('json')).to be
         end
 
-        it "contains a View for `json` model" do
-          expect(subject.views.key? "json").to be
+        it 'contains a View for `envelope` model' do
+          expect(subject.views.key?('envelope')).to be
         end
       end
     end

data/spec/response_spec.rb

@@ -1,14 +1,14 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Alephant::Renderer::Response do
   subject { described_class.new content }
-  let(:content) { "<h1>foo</h1>" }
+  let(:content) { '<h1>foo</h1>' }
 
-  describe "#to_json" do
-    let(:expected_structure) { { "content" => content } }
+  describe '#to_json' do
+    let(:expected_structure) { { 'content' => content } }
 
     specify do
-      expect(::JSON.parse subject.to_json).to eq expected_structure
+      expect(::JSON.parse(subject.to_json)).to eq expected_structure
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,12 +1,13 @@
-$LOAD_PATH << File.join(File.dirname(__FILE__),"..", "lib")
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 
-require "pry"
-require "json"
+require 'pry'
+require 'json'
 
-require "alephant/renderer"
-require "alephant/renderer/error/invalid_path"
-require "alephant/renderer/views"
-require "alephant/renderer/views/json"
-require "alephant/renderer/views/html"
-require "alephant/renderer/view_mapper"
-require "alephant/renderer/response"
+require 'alephant/renderer'
+require 'alephant/renderer/error/invalid_path'
+require 'alephant/renderer/views'
+require 'alephant/renderer/views/json'
+require 'alephant/renderer/views/envelope'
+require 'alephant/renderer/views/html'
+require 'alephant/renderer/view_mapper'
+require 'alephant/renderer/response'

data/spec/view_mapper_spec.rb

@@ -1,31 +1,31 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Alephant::Renderer::ViewMapper do
-  let(:renderer_id) { "foo-renderer" }
-  let(:data) {{ :foo => :bar }}
-  let(:path) { File.join(File.dirname(__FILE__), "fixtures/components") }
+  let(:renderer_id) { 'foo-renderer' }
+  let(:data) { { foo: :bar } }
+  let(:path) { File.join(File.dirname(__FILE__), 'fixtures/components') }
 
   subject { Alephant::Renderer::ViewMapper }
 
-  describe "initialize(view_base_path)" do
-    context "view_base_path = invalid_path" do
-      it "should raise an error" do
-        expect {
-          subject.new(renderer_id, "./invalid_path")
-        }.to raise_error ::Alephant::Renderer::Error::InvalidBasePath
+  describe 'initialize(view_base_path)' do
+    context 'view_base_path = invalid_path' do
+      it 'should raise an error' do
+        expect do
+          subject.new(renderer_id, './invalid_path')
+        end.to raise_error ::Alephant::Renderer::Error::InvalidBasePath
       end
     end
 
-    context "view_base_path = ." do
-      it "sets base_path" do
+    context 'view_base_path = .' do
+      it 'sets base_path' do
         expect(
           subject.new(renderer_id, path).base_path
         ).to eq("#{path}/#{renderer_id}")
       end
     end
 
-    context "view_base_path = nil" do
-      it "sets base_path" do
+    context 'view_base_path = nil' do
+      it 'sets base_path' do
         expect(
           subject.new(renderer_id).base_path
         ).to eq(Alephant::Renderer::ViewMapper::DEFAULT_LOCATION)
@@ -33,11 +33,11 @@ describe Alephant::Renderer::ViewMapper do
     end
   end
 
-  describe "generate(data)" do
-    it "calls create_renderer for each template found" do
+  describe 'generate(data)' do
+    it 'calls create_renderer for each template found' do
       expect(
         subject.new(renderer_id, path).generate(data).size
-      ).to eq(3)
+      ).to eq(4)
     end
   end
 end

data/spec/views_envelope_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'fixtures/components/foo-renderer/models/envelope'
+
+describe Alephant::Renderer::Views::Envelope do
+  let(:data) do
+    {
+      'foo' => 'envelope'
+    }
+  end
+
+  describe '#content_type' do
+    it 'sets the correct content type' do
+      expect(MyApp::Envelope.new(data).content_type).to eq('application/json')
+    end
+  end
+
+  describe '#render' do
+    it 'returns generated envelope' do
+      expected_result = '{"head":["some/css/asset/path","some/js/asset/path"],"bodyInline":"<h1>Hello, I\'m a envelope template</h1>","bodyLast":["some/thing/to/add/after/body","some/other/thing/to/add/after/body"]}'
+      expect(MyApp::Envelope.new(data).render).to eq(expected_result)
+    end
+  end
+
+end

data/spec/views_json_spec.rb

@@ -1,31 +1,31 @@
-require "spec_helper"
-require "fixtures/components/foo-renderer/models/json"
+require 'spec_helper'
+require 'fixtures/components/foo-renderer/models/json'
 
 describe Alephant::Renderer::Views::Json do
-  let(:data) {
+  let(:data) do
     {
-      "foo" => "a",
-      "bar" => "b",
-      "baz" => "c"
+      'foo' => 'a',
+      'bar' => 'b',
+      'baz' => 'c'
     }
-  }
+  end
 
-  describe "#content_type" do
-    it "sets the correct content type" do
-      expect(MyApp::Json.new(data).content_type).to eq("application/json")
+  describe '#content_type' do
+    it 'sets the correct content type' do
+      expect(MyApp::Json.new(data).content_type).to eq('application/json')
     end
   end
 
-  describe "#to_h" do
-    it "generates a hash based on the white list" do
-      expected_result = { "item1" => "a", "item2" => "b" }
+  describe '#to_h' do
+    it 'generates a hash based on the white list' do
+      expected_result = { 'item1' => 'a', 'item2' => 'b' }
       expect(MyApp::Json.new(data).to_h).to eq(expected_result)
     end
   end
 
-  describe "#render" do
-    it "returns generated json" do
-      expected_result = "{\"item1\":\"a\",\"item2\":\"b\"}"
+  describe '#render' do
+    it 'returns generated json' do
+      expected_result = '{"item1":"a","item2":"b"}'
       expect(MyApp::Json.new(data).render).to eq(expected_result)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alephant-renderer
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - BBC News
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -239,17 +239,21 @@ files:
 - lib/alephant/renderer.rb
 - lib/alephant/renderer/engine/mustache.rb
 - lib/alephant/renderer/error/invalid_path.rb
+- lib/alephant/renderer/i18n/json.rb
 - lib/alephant/renderer/i18n/locale_component_yaml.rb
 - lib/alephant/renderer/response.rb
 - lib/alephant/renderer/version.rb
 - lib/alephant/renderer/view_mapper.rb
 - lib/alephant/renderer/views.rb
 - lib/alephant/renderer/views/base.rb
+- lib/alephant/renderer/views/envelope.rb
 - lib/alephant/renderer/views/html.rb
 - lib/alephant/renderer/views/json.rb
 - spec/fixtures/components/foo-renderer/models/BAR_ABC.rb
+- spec/fixtures/components/foo-renderer/models/envelope.rb
 - spec/fixtures/components/foo-renderer/models/foo_xyz.rb
 - spec/fixtures/components/foo-renderer/models/json.rb
+- spec/fixtures/components/foo-renderer/templates/envelope.mustache
 - spec/integration/engine_mustache_spec.rb
 - spec/integration/fixtures/components/lib/templates/legacy_shared_template.mustache
 - spec/integration/fixtures/components/locale/translations.yml
@@ -260,7 +264,9 @@ files:
 - spec/integration/fixtures/components/test-renderer/templates/legacy_shared_module.mustache
 - spec/integration/fixtures/components/test-renderer/templates/translating_module.mustache
 - spec/integration/fixtures/templates/sample.mustache
+- spec/integration/fixtures/translations.json
 - spec/integration/fixtures/translations.yml
+- spec/integration/i18n_json_spec.rb
 - spec/integration/i18n_locale_component_yaml_spec.rb
 - spec/integration/spec_helper.rb
 - spec/integration/views_html_spec.rb
@@ -268,6 +274,7 @@ files:
 - spec/response_spec.rb
 - spec/spec_helper.rb
 - spec/view_mapper_spec.rb
+- spec/views_envelope_spec.rb
 - spec/views_json_spec.rb
 homepage: ''
 licenses:
@@ -295,8 +302,10 @@ specification_version: 4
 summary: Render HTML snippets
 test_files:
 - spec/fixtures/components/foo-renderer/models/BAR_ABC.rb
+- spec/fixtures/components/foo-renderer/models/envelope.rb
 - spec/fixtures/components/foo-renderer/models/foo_xyz.rb
 - spec/fixtures/components/foo-renderer/models/json.rb
+- spec/fixtures/components/foo-renderer/templates/envelope.mustache
 - spec/integration/engine_mustache_spec.rb
 - spec/integration/fixtures/components/lib/templates/legacy_shared_template.mustache
 - spec/integration/fixtures/components/locale/translations.yml
@@ -307,7 +316,9 @@ test_files:
 - spec/integration/fixtures/components/test-renderer/templates/legacy_shared_module.mustache
 - spec/integration/fixtures/components/test-renderer/templates/translating_module.mustache
 - spec/integration/fixtures/templates/sample.mustache
+- spec/integration/fixtures/translations.json
 - spec/integration/fixtures/translations.yml
+- spec/integration/i18n_json_spec.rb
 - spec/integration/i18n_locale_component_yaml_spec.rb
 - spec/integration/spec_helper.rb
 - spec/integration/views_html_spec.rb
@@ -315,4 +326,5 @@ test_files:
 - spec/response_spec.rb
 - spec/spec_helper.rb
 - spec/view_mapper_spec.rb
+- spec/views_envelope_spec.rb
 - spec/views_json_spec.rb