alephant-renderer 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3a19d1c9984aaa9611fd279466b0bece188defc
-  data.tar.gz: 5f1cbd5a69a99ef540f905f0ce5f6546d58d1a97
+  metadata.gz: 1e810f8be3ddd542c6219561717aeceecea23909
+  data.tar.gz: 56fd9b04bd5d18e30a32ada542b7d437e3ea3e30
 SHA512:
-  metadata.gz: 17202ed45634156e75927102101e38c17817ce92ee2e357e3332bb651d69c876a2d81e6cfde9bc191ecaf6dd5ef98e47959477207e0172de8e136b0f8e6810ea
-  data.tar.gz: 5dd4f2dba0fe09db89eacf1b4772b1edb27ec48385e4b0506e4f8198f3234f099a1cb66dfe3ae21849cd445aa530f54978696523d8d524d0d55dc2ea4ff4b0af
+  metadata.gz: a613fcbdd71910ee54e81cf8a7dbd533bf0ceaac761b755c045a899e6eed493e88911bf78a5a80fa41e7aa1412abafe4ff1c355d6421af5f0a5c67900ef5eee0
+  data.tar.gz: 6098e5d61ab2bd4dce6e489a2dd659f3e9b81b2497ebd02bc73ef8a4ecae3d6799dfe9e9a91b9d6d1800e5988954ddcb0436c1dfc218de73491ee8996ec0904f

data/.gitignore

@@ -9,3 +9,4 @@ Gemfile.lock
 /tmp
 /components
 
+app.log

data/Gemfile

@@ -1,4 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in alephant-renderer.gemspec
 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/Rakefile

@@ -1,8 +1,8 @@
-$:.unshift File.join(File.dirname(__FILE__), 'lib')
+$:.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

data/alephant-renderer.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'alephant/renderer/version'
+require "alephant/renderer/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "alephant-renderer"
@@ -29,8 +28,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rake-rspec"
 
-  spec.add_runtime_dependency 'i18n'
-  spec.add_runtime_dependency 'mustache', '~> 0.99.5'
-  spec.add_runtime_dependency 'alephant-logger'
-  spec.add_runtime_dependency 'hashie'
+  spec.add_runtime_dependency "i18n"
+  spec.add_runtime_dependency "mustache", "~> 0.99.5"
+  spec.add_runtime_dependency "alephant-logger"
+  spec.add_runtime_dependency "hashie"
 end

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

data/lib/alephant/renderer/error/invalid_path.rb

@@ -0,0 +1,11 @@
+module Alephant
+  module Renderer
+    module Error
+      class InvalidBasePath < StandardError
+        def initialize(path)
+          super "Path '#{path}' to renderer/queue directory is invalid"
+        end
+      end
+    end
+  end
+end

data/lib/alephant/renderer/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Renderer
-    VERSION = "2.0.1"
+    VERSION = "2.0.2"
   end
 end

data/lib/alephant/renderer/view_mapper.rb

@@ -1,15 +1,17 @@
-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"
 
-      def initialize(component_id, view_base_path=nil)
-        self.base_path = "#{view_base_path}/#{component_id}" unless view_base_path.nil?
-        @component_id = component_id
+      def initialize(renderer_id, view_base_path=nil)
+        unless view_base_path.nil?
+          self.base_path = "#{view_base_path}/#{renderer_id}"
+        end
       end
 
       def base_path
@@ -32,7 +34,7 @@ module Alephant
       private
 
       def raise_error(path)
-        raise("Invalid path: '#{path}'").tap do
+        fail(Error::InvalidBasePath.new(path)).tap do
           logger.metric("ViewMapperInvalidPath")
           logger.error(
             "event"  => "ViewMapperBasePathInvalidFound",
@@ -48,7 +50,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
@@ -60,9 +62,8 @@ module Alephant
       end
 
       def model_id_for(location)
-        location.split('/').last.sub(/\.rb/, '')
+        location.split("/").last.sub(/\.rb/, "")
       end
-
     end
   end
 end

data/lib/alephant/renderer/views.rb

@@ -4,7 +4,7 @@ module Alephant
       @@views = {}
 
       def self.register(klass)
-        @@views[underscorify(klass.name.split('::').last)] = klass
+        @@views[underscorify(klass.name.split("::").last)] = klass
       end
 
       def self.get_registered_class(id)
@@ -12,9 +12,9 @@ module Alephant
       end
 
       def self.underscorify(str)
-        str.gsub(/::/, '/').
-          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        str.gsub(/::/, "/").
+          gsub(/([A-Z]+)([A-Z][a-z])/,"\1_\2").
+          gsub(/([a-z\d])([A-Z])/,"\1_\2").
           tr("-", "_").
           downcase
       end

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

@@ -1,6 +1,6 @@
-require 'alephant/renderer/views/base'
-require 'mustache'
-require 'i18n'
+require "alephant/renderer/views/base"
+require "mustache"
+require "i18n"
 
 module Alephant
   module Renderer
@@ -31,8 +31,8 @@ module Alephant
           Dir[
             File.join(
               Pathname.new(base_path).parent,
-              'locale',
-              '*.yml')
+              "locale",
+              "*.yml")
           ]
           .flatten
           .uniq
@@ -50,13 +50,16 @@ module Alephant
         end
 
         def template_name
-          Mustache.underscore(self.class.to_s).split('/').last
+          Mustache.underscore(self.class.to_s).split("/").last
         end
 
         def template_file
-          File.join(base_path,'templates',"#{template_name}.#{template_extension}")
+          File.join(
+            base_path,
+            "templates",
+            "#{template_name}.#{template_extension}"
+          )
         end
-
       end
     end
   end

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

@@ -1,8 +1,7 @@
 module MyApp
   class Json < Alephant::Renderer::Views::Json
-
     def whitelist
-      ['item1', 'item2']
+      ["item1", "item2"]
     end
 
     def item1
@@ -16,6 +15,5 @@ module MyApp
     def baz
       @data[:baz]
     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,57 +1,57 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Alephant::Renderer do
-  let(:config) { 
+  let(:config) {
     {
-      renderer_id: 'foo',
-      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'} } 
+  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 { 
+      specify do
         expect(subject.create(config, data)).to be_instance_of expected
-      } 
+      end
     end
   end
 
   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
+      context "using three Models" do
+        it "returns three Views in Hash" do
           expect(subject.views.length).to eql 3
         end
       end
 
-      context 'using `bar`, `foo`, `json` models' do
-        it 'contains a View for `bar` model' do
-          expect(subject.views.key? 'bar').to be
+      context "using `bar`, `foo`, `json` models" do
+        it "contains a View for `bar` model" do
+          expect(subject.views.key? "bar").to be
         end
 
-        it 'contains a View for `foo` model' do
-          expect(subject.views.key? 'foo').to be 
+        it "contains a View for `foo` model" do
+          expect(subject.views.key? "foo").to be
         end
 
-        it 'contains a View for `json` model' do
-          expect(subject.views.key? 'json').to be
+        it "contains a View for `json` model" do
+          expect(subject.views.key? "json").to be
         end
       end
     end

data/spec/spec_helper.rb

@@ -1,12 +1,12 @@
 $: << File.join(File.dirname(__FILE__),"..", "lib")
 
-require 'pry'
+require "pry"
 require "json"
 
-require 'alephant/renderer'
-require 'alephant/renderer/views'
-require 'alephant/renderer/views/json'
-require 'alephant/renderer/views/html'
-require 'alephant/renderer/view_mapper'
+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"
-

data/spec/view_mapper_spec.rb

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

data/spec/views_json_spec.rb

@@ -1,33 +1,32 @@
-require 'spec_helper'
-require 'fixtures/components/foo/models/json'
+require "spec_helper"
+require "fixtures/components/foo-renderer/models/json"
 
 describe Alephant::Renderer::Views::Json do
-  let(:data) { {'foo' => 'test', 'bar' => 'white', 'baz' => 'list'} }
+  let(:data) {
+    {
+      "foo" => "a",
+      "bar" => "b",
+      "baz" => "c"
+    }
+  }
 
   describe "#content_type" do
-
     it "sets the correct content type" do
-      expect(MyApp::Json.new(data).content_type).to eq('application/json')
+      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' => 'test', 'item2' => 'white'}
+      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\":\"test\",\"item2\":\"white\"}"
+      expected_result = "{\"item1\":\"a\",\"item2\":\"b\"}"
       expect(MyApp::Json.new(data).render).to eq(expected_result)
     end
-
   end
-
 end

metadata

@@ -1,221 +1,221 @@
 --- !ruby/object:Gem::Specification
 name: alephant-renderer
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - BBC News
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-nc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rspec-nc
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: guard
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: guard-rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: pry
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-remote
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: pry-remote
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: pry-nav
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
-  type: :development
+  name: bundler
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rake
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  name: rake-rspec
   prerelease: false
+  type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  name: i18n
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mustache
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.99.5
-  type: :runtime
+  name: mustache
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.99.5
 - !ruby/object:Gem::Dependency
-  name: alephant-logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  name: alephant-logger
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  name: hashie
   prerelease: false
+  type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - FutureMediaNewsRubyGems@bbc.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".ruby-version"
-- ".travis.yml"
+- .gitignore
+- .ruby-version
+- .travis.yml
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -223,6 +223,7 @@ files:
 - Rakefile
 - alephant-renderer.gemspec
 - lib/alephant/renderer.rb
+- lib/alephant/renderer/error/invalid_path.rb
 - lib/alephant/renderer/response.rb
 - lib/alephant/renderer/version.rb
 - lib/alephant/renderer/view_mapper.rb
@@ -230,9 +231,9 @@ files:
 - lib/alephant/renderer/views/base.rb
 - lib/alephant/renderer/views/html.rb
 - lib/alephant/renderer/views/json.rb
-- spec/fixtures/components/foo/models/bar.rb
-- spec/fixtures/components/foo/models/foo.rb
-- spec/fixtures/components/foo/models/json.rb
+- spec/fixtures/components/foo-renderer/models/bar.rb
+- spec/fixtures/components/foo-renderer/models/foo.rb
+- spec/fixtures/components/foo-renderer/models/json.rb
 - spec/integration/spec_helper.rb
 - spec/renderer_spec.rb
 - spec/response_spec.rb
@@ -244,30 +245,30 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+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: 
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
 specification_version: 4
 summary: Render HTML snippets
 test_files:
-- spec/fixtures/components/foo/models/bar.rb
-- spec/fixtures/components/foo/models/foo.rb
-- spec/fixtures/components/foo/models/json.rb
+- spec/fixtures/components/foo-renderer/models/bar.rb
+- spec/fixtures/components/foo-renderer/models/foo.rb
+- spec/fixtures/components/foo-renderer/models/json.rb
 - spec/integration/spec_helper.rb
 - spec/renderer_spec.rb
 - spec/response_spec.rb