alephant-preview 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26a32900c55bb2643938552eb8b87471842d679c
-  data.tar.gz: a89909666fce0c35da89d52b500684b771a47dd1
+  metadata.gz: 78b56936f9da81875bcd551feba3fda79ef53d5a
+  data.tar.gz: e9064caba88ad1249cc16e69ddb417ba9f4af350
 SHA512:
-  metadata.gz: 8a516b733aaa96b428a04cd7f1f13a1b9ce9234c998f339bdf7d81648a533b76858094a94e757fafc5136262aa67fe584de3847f00acadbb9c7b739a8a83a3f6
-  data.tar.gz: f7a133fe951e7e4235d279f8d30aae7515929017b7148830b4fda591e641d68ca5336ff5180fa0acca78a1fab8cbf21db0d795851d2398deec5d158eef8b2156
+  metadata.gz: 328ed2f347aaae17fc0d39dd934ed6350a63e71cc4b7ec722c3b85d7c74c638fe21dc86d6c042b345a43378bbc50b0f04742b057ec705ff1a3ac1574846ac0eb
+  data.tar.gz: e731769a904afa44950d36ce29792b10a77a6b27c38761fa437b59b0d4e9075b57c4505446f56d88a4e9c90a91faec46d1b4fbb82ef17e053a067925151d2474

data/.ruby-version

@@ -1 +1 @@
-jruby-1.7.9
+jruby-1.7

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
 notifications:
   email:
     recipients:
-      - kenoir@gmail.com
+      - stevenmajack@gmail.com
+      - mark.mxdc@gmail.com
     on_failure: change
     on_success: never

data/Guardfile

@@ -1,6 +1,10 @@
-guard 'rspec' do
+guard 'rake', :task => 'spec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/.+\.rb$})
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('spec/spec_helper.rb')                        { "spec" }
+  watch('spec/spec_helper.rb')
+  watch('spec/fixtures/.+$')
+end
+
+guard 'rake', :task => 'integration' do
+  watch(%r{^spec/integration/.+_spec\.rb$})
 end

data/README.md

@@ -35,6 +35,23 @@ Provide a view in a folder:
             └── foo.mustache
 ```
 
+### Data mappers
+
+If you application uses data mappers and they make more than one call, use the following folder structure to provide a fixture for each call:
+
+```
+└── components
+    └── group_name
+        ├── models
+        │   └── foo.rb
+        ├── fixtures
+        │   └── foo_1.json
+        │   └── foo_2.json
+        │   └── foo_3.json
+        └── templates
+            └── foo.mustache
+```
+
 `alephant-preview`
 
 The included preview server allows you to see the html generated by your

data/Rakefile

@@ -1,9 +1,7 @@
 $:.unshift File.join(File.dirname(__FILE__), 'lib')
 
 require 'rspec/core/rake_task'
+require 'rake/rspec'
 require 'bundler/gem_tasks'
-require 'alephant/preview'
 
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+task :default => :all

data/alephant-preview.gemspec

@@ -21,10 +21,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec-nc"
   spec.add_development_dependency "rack-test"
   spec.add_development_dependency "guard"
-  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-rake"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake-rspec"
 
   spec.add_runtime_dependency 'sinatra'
   spec.add_runtime_dependency 'sinatra-reloader'
@@ -34,4 +35,6 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'alephant-support'
   spec.add_runtime_dependency 'alephant-renderer'
+  spec.add_runtime_dependency 'alephant-publisher-request'
+
 end

data/lib/alephant/preview/fixture_loader.rb

@@ -0,0 +1,28 @@
+module Alephant
+  module Preview
+    class FixtureLoader
+      attr_reader :base_path, :current_fixture, :fixtures
+
+      def initialize(base_path)
+        @base_path = base_path
+        @fixtures  = Dir.glob("#{base_path}/fixtures/*")
+      end
+
+      def get(uri)
+        OpenStruct.new(
+          :status => 200,
+          :body   => fixture
+        )
+      end
+
+      protected
+
+      def fixture
+        path = fixtures.shift
+        raise "There isn't a fixture matching the request call, please add one" if path.nil?
+        File.open(path).read
+      end
+
+    end
+  end
+end

data/lib/alephant/preview/server.rb

@@ -1,9 +1,12 @@
 require 'alephant/renderer/views/html'
 require 'alephant/renderer/views/json'
 require 'alephant/renderer/view_mapper'
+require 'alephant/publisher/request/data_mapper_factory'
+require 'alephant/publisher/request/data_mapper'
+require 'alephant/publisher/request/error'
 
 require 'alephant/support/parser'
-
+require 'alephant/preview/fixture_loader'
 require 'alephant/preview/template/base'
 
 require 'sinatra/base'
@@ -19,6 +22,7 @@ module Alephant
 
       register Sinatra::Reloader
       also_reload 'components/*/models/*.rb'
+      also_reload 'components/*/mapper.rb'
 
       BASE_LOCATION = "#{(ENV['BASE_LOCATION'] || Dir.pwd)}/components"
 
@@ -89,9 +93,23 @@ module Alephant
       end
 
       def fixture_data
-        msg = Struct.new(:body)
-          .new(raw_fixture_data)
-        parser.parse msg
+        if File.exists? "#{base_path}/mapper.rb"
+          loader              = Alephant::Preview::FixtureLoader.new(base_path)
+          data_mapper_factory = Alephant::Publisher::Request::DataMapperFactory.new(loader, BASE_LOCATION)
+          begin
+            mapper              = data_mapper_factory.create(id, {})
+            mapper.data
+          rescue Alephant::Publisher::Request::InvalidApiResponse
+            raise "The JSON passed to the data mapper isn't valid"
+          rescue StandardError => e
+            puts e.backtrace
+            raise "There was an issue with the data mapper class: #{e.message}"
+          end
+        else
+          msg = Struct.new(:body)
+            .new(raw_fixture_data)
+          parser.parse msg
+        end
       end
 
       def raw_fixture_data

data/lib/alephant/preview/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Preview
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/spec/fixture_loader_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Alephant::Preview::FixtureLoader do
+  let (:fixtures_base) { File.join(File.dirname(__FILE__), 'fixtures') }
+  let (:base_path) { File.join(fixtures_base, 'components', 'bar') }
+  subject { described_class.new(base_path) }
+
+  describe ".new" do
+
+    context 'using valid parameters' do
+      let (:expected) { described_class }
+
+      specify { expect(subject).to be_a expected }
+    end
+  end
+
+  describe "#get" do
+    let (:uri) { '/test/uri' }
+
+    context 'with a single fixture' do
+      let (:fixture_data) { File.open(File.join(fixtures_base, 'components', 'bar', 'fixtures', 'bar.json')).read }
+      specify { expect(subject.get(uri).body).to eq fixture_data}
+    end
+
+    context 'with multiple fixtures' do
+      let (:base_path) { File.join(fixtures_base, 'components', 'baz') }
+      let (:fixture_data) do
+        fixtures = Dir.glob(File.join(fixtures_base, 'components', 'baz', 'fixtures', '*'))
+        fixtures.map { |fixture| File.open(fixture).read }
+      end
+
+      context 'using a valid amount of fixtures' do
+
+        it "should return each fixture on subsequent calls" do
+          (0..2).each do |index|
+            expect(subject.get(uri).body).to eq fixture_data[index]
+          end
+        end
+      end
+
+      context 'using incorrect amount of fixtures' do
+        it "should raise an exception" do
+          (0..2).each { |index| subject.get(uri).body }
+          expect{ subject.get(uri).body }.to raise_error
+        end
+      end
+    end
+  end
+end

data/spec/fixtures/components/bar/fixtures/bar.json

@@ -0,0 +1 @@
+{ "a" : "data mapped content" }

data/spec/fixtures/components/bar/mapper.rb

@@ -0,0 +1,7 @@
+class BarMapper < Alephant::Publisher::Request::DataMapper
+  def data
+    {
+      :bar => 'data mapped content'
+    }
+  end
+end

data/spec/fixtures/components/bar/models/bar.rb

@@ -0,0 +1,9 @@
+require 'alephant/renderer/views/html'
+
+module MyApp
+  class Bar < ::Alephant::Renderer::Views::Html
+    def content
+      data.bar
+    end
+  end
+end

data/spec/fixtures/components/bar/templates/bar.mustache

@@ -0,0 +1 @@
+{{content}}

data/spec/fixtures/components/baz/fixtures/baz_1.json

@@ -0,0 +1 @@
+{ "a" : "multiple endpoint" }

data/spec/fixtures/components/baz/fixtures/baz_2.json

@@ -0,0 +1 @@
+{ "b" : "data mapped" }

data/spec/fixtures/components/baz/fixtures/baz_3.json

@@ -0,0 +1 @@
+{ "c" : "content" }

data/spec/fixtures/components/baz/mapper.rb

@@ -0,0 +1,7 @@
+class BazMapper < Alephant::Publisher::Request::DataMapper
+  def data
+    (1..3).reduce({}) do |accum, index|
+      accum.merge(get("/test/call"))
+    end
+  end
+end

data/spec/fixtures/components/baz/models/baz.rb

@@ -0,0 +1,9 @@
+require 'alephant/renderer/views/html'
+
+module MyApp
+  class Baz < ::Alephant::Renderer::Views::Html
+    def content
+      "#{data.a} #{data.b} #{data.c}"
+    end
+  end
+end

data/spec/fixtures/components/baz/templates/baz.mustache

@@ -0,0 +1 @@
+{{content}}

data/spec/integration/preview_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe Alephant::Preview::Server do
+  include Rack::Test::Methods
+  let (:app) { subject }
+
+  describe 'preview endpoint (GET /preview/{id}/{template}/{region}/{fixture})' do
+
+    describe 'content' do
+
+      context 'with valid data' do
+        before(:each) do
+          get "/preview/#{id}/#{template}/#{region}/#{fixture}"
+        end
+        let (:id) { 'foo' }
+        let (:template) { id }
+        let (:fixture) { id }
+        let (:region) { 'page_region' }
+
+        specify { expect(last_response.body).to eq("topcontent\nbottom\n") }
+      end
+    end
+  end
+
+  describe 'component endpoint (GET /component/{id}/{template}/{fixture})' do
+
+    describe 'content' do
+      before(:each) do
+        get "/component/#{id}/#{template}/#{fixture}"
+      end
+      let (:response) { last_response.body.chomp }
+
+      context 'without a data mapper' do
+        let (:id) { 'foo' }
+        let (:template) { id }
+        let (:fixture) { id }
+
+        specify { expect(response).to eq("content") }
+      end
+
+      context 'with a data mapper' do
+
+        context 'using a single fixture' do
+          let (:id) { 'bar' }
+          let (:template) { id }
+          let (:fixture) { id }
+
+          specify { expect(response).to eq("data mapped content") }
+        end
+
+        context 'using multiple fixtures' do
+          let (:id) { 'baz' }
+          let (:template) { id }
+          let (:fixture) { id }
+
+          specify { expect(response).to eq("multiple endpoint data mapped content") }
+        end
+      end
+    end
+  end
+
+  describe "status endpoint (GET /status)" do
+    before(:each) do
+      get "/status"
+    end
+
+    context "status code" do
+      specify { expect(last_response.status).to eq 200 }
+    end
+  end
+end

metadata

@@ -1,226 +1,254 @@
 --- !ruby/object:Gem::Specification
 name: alephant-preview
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Robert Kenny
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-10-13 00:00:00.000000000 Z
+date: 2014-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
   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
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rack-test
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: guard
   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
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: guard-rake
   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
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: pry
   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
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: bundler
   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: '0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake-rspec
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: sinatra
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sinatra-reloader
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: sinatra-reloader
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: faraday
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: trollop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: trollop
   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
+        version: '0'
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: mustache
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.99.5
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.99.5
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
   name: alephant-support
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-renderer
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: alephant-renderer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
   prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: alephant-publisher-request
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+description:
 email:
 - kenoir@gmail.com
 executables:
@@ -239,6 +267,7 @@ files:
 - alephant-preview.gemspec
 - bin/alephant-preview
 - lib/alephant/preview.rb
+- lib/alephant/preview/fixture_loader.rb
 - lib/alephant/preview/server.rb
 - lib/alephant/preview/tasks.rb
 - lib/alephant/preview/tasks/preview.rake
@@ -246,18 +275,29 @@ files:
 - lib/alephant/preview/template/base.rb
 - lib/alephant/preview/template/updater.rb
 - lib/alephant/preview/version.rb
+- spec/fixture_loader_spec.rb
+- spec/fixtures/components/bar/fixtures/bar.json
+- spec/fixtures/components/bar/mapper.rb
+- spec/fixtures/components/bar/models/bar.rb
+- spec/fixtures/components/bar/templates/bar.mustache
+- spec/fixtures/components/baz/fixtures/baz_1.json
+- spec/fixtures/components/baz/fixtures/baz_2.json
+- spec/fixtures/components/baz/fixtures/baz_3.json
+- spec/fixtures/components/baz/mapper.rb
+- spec/fixtures/components/baz/models/baz.rb
+- spec/fixtures/components/baz/templates/baz.mustache
 - spec/fixtures/components/foo/fixtures/foo.json
 - spec/fixtures/components/foo/models/foo.rb
 - spec/fixtures/components/foo/templates/.DS_Store
 - spec/fixtures/components/foo/templates/foo.mustache
 - spec/fixtures/lib/templates/preview.mustache
-- spec/preview_spec.rb
+- spec/integration/preview_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -272,16 +312,27 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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: Preview component templates
 test_files:
+- spec/fixture_loader_spec.rb
+- spec/fixtures/components/bar/fixtures/bar.json
+- spec/fixtures/components/bar/mapper.rb
+- spec/fixtures/components/bar/models/bar.rb
+- spec/fixtures/components/bar/templates/bar.mustache
+- spec/fixtures/components/baz/fixtures/baz_1.json
+- spec/fixtures/components/baz/fixtures/baz_2.json
+- spec/fixtures/components/baz/fixtures/baz_3.json
+- spec/fixtures/components/baz/mapper.rb
+- spec/fixtures/components/baz/models/baz.rb
+- spec/fixtures/components/baz/templates/baz.mustache
 - spec/fixtures/components/foo/fixtures/foo.json
 - spec/fixtures/components/foo/models/foo.rb
 - spec/fixtures/components/foo/templates/.DS_Store
 - spec/fixtures/components/foo/templates/foo.mustache
 - spec/fixtures/lib/templates/preview.mustache
-- spec/preview_spec.rb
+- spec/integration/preview_spec.rb
 - spec/spec_helper.rb

data/spec/preview_spec.rb

@@ -1,40 +0,0 @@
-require 'spec_helper'
-
-describe Alephant::Preview::Server do
-  include Rack::Test::Methods
-
-  def app
-    Alephant::Preview::Server
-  end
-
-  describe '/preview/:id/:template/:region/?:fixture?' do
-    context 'valid component' do
-      it "should return the rendered component inside the page region specified" do
-        get '/preview/foo/foo/page_region/foo'
-
-        expect(last_response).to be_ok
-        expect(last_response.body).to eq("topcontent\nbottom\n")
-      end
-    end
-  end
-
-  describe '/component/:id/:template/?:fixture?' do
-    context 'valid component' do
-      it "should return the rendered component" do
-        get '/component/foo/foo/foo'
-
-        expect(last_response).to be_ok
-        expect(last_response.body).to eq("content\n")
-      end
-    end
-  end
-
-  describe '/status' do
-    it "responds with ok" do
-      get '/status'
-
-      expect(last_response).to be_ok
-      expect(last_response.body).to eq('ok')
-    end
-  end
-end