alephant-preview 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6145f10012de3dabfe234787f636e5a8b011ad5e
-  data.tar.gz: ecdf7211609f469e812feb7cc856b0228a8af42c
+  metadata.gz: 6ca692cb8be7c816e8dfe71d2bc2ce9adfb73352
+  data.tar.gz: 05aeb2aacfc0e0ac62924dd27e44d3496866a8ed
 SHA512:
-  metadata.gz: 9ebf87172b14488e9fe2081077234dc78d72d11c4170ad48a174ae220ee8af3f8a4d1dd40737d75c0af0a37b2d2f79f937d5d01d79c7e87d9b61d87db00a6f6b
-  data.tar.gz: 54719f3ceb52daa9db26cbfd9ea4358ad89434bb7a13a0f26923449db3692ede5435e56a41cd3b150e2bb7bdb036ac43bc201a5d638b1f8a6a4aa944f14b5029
+  metadata.gz: 16b8979f67cea3ddb445fdccfd4875528bcd01e0c8cadc8a20acb32210074a2dc62bafff338b46fecd65572341fd5e4c0bc7165979d509fa4076bd4fdc6dc0c8
+  data.tar.gz: 892dc0f2591fc2c16dbfe3278bb200e23b8a713aa81f6c3a9439fe144c29a58b947e67a667f9c4b34ee18e9a6779a0047f2f461eaa20dedb88aaa411b56d02b5

data/README.md

@@ -1,6 +1,6 @@
 # Alephant::Preview
 
-TODO: Write a gem description
+Provides an in-page preview of components during development
 
 ## Installation
 
@@ -18,7 +18,61 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Provide a view in a folder:
+
+```
+└── components
+    └── group_name
+        ├── models
+        │   └── foo.rb
+        ├── fixtures
+        │   └── foo.json
+        └── templates
+            └── foo.mustache
+```
+
+`alephant-preview`
+
+The included preview server allows you to see the html generated by your
+templates, both standalone and in the context of a page.
+
+###Standalone
+
+`/component/:id/?:fixture?`
+
+###Full page preview
+
+`/preview/:group_name/:id/:region/?:fixture?`
+
+`group_name` is the sub_folder that contains your templates
+
+`id` is the component/folder name
+
+`template` is the mustache template file name
+
+`location_in_page` should be something like (for example) `page_head` (specified
+within a `preview.mustache` file that the consuming application needs to
+create).
+
+- `http://localhost:4567/preview/group_name/id/template/location_in_page`
+
+
+####Updating preview
+
+`alephant-preview update`
+
+When viewing the component in the context of a page, you'll need to retrieve a
+mustache template to provide the page context.
+
+When performing an update a regex is applied to replace the static hostnames in
+the retrieved html.
+
+**Environment Variables**
+
+```sh
+STATIC_HOST_REGEX="static.(sandbox.dev|int|test|stage|live).yourapp(i)?.com\/"
+PREVIEW_TEMPLATE_URL="http://yourapp.com/template"
+```
 
 ## Contributing
 

data/alephant-preview.gemspec

@@ -33,5 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rake'
   spec.add_runtime_dependency 'mustache', '>= 0.99.5'
 
-  spec.add_runtime_dependency 'alephant'
+  spec.add_runtime_dependency 'alephant-renderer'
 end

data/lib/alephant/preview/server.rb

@@ -1,4 +1,6 @@
-require 'alephant/models/render_mapper'
+require 'alephant/renderer'
+require 'alephant/views'
+
 require 'alephant/models/parser'
 
 require 'alephant/preview/template/base'
@@ -11,6 +13,7 @@ require 'uri'
 module Alephant
   module Preview
     class Server < Sinatra::Base
+      DEFAULT_LOCATION = 'components'
 
       get '/preview/:id/:template/:region/?:fixture?' do
         render_preview
@@ -28,10 +31,23 @@ module Alephant
       end
 
       def render_component
-        ::Alephant::RenderMapper.new(id, base_path).create_renderer(template_file, fixture_data).render
+        ::Alephant::Renderer.create(template, base_path, model).render
       end
 
       private
+      def model
+        require model_location
+        ::Alephant::Views.get_registered_class(id).new(fixture_data)
+      end
+
+      def base_path
+        File.join(Dir.pwd, DEFAULT_LOCATION, id)
+      end
+
+      def model_location
+        File.join(base_path, 'models', "#{template}.rb")
+      end
+
       def template
         params['template']
       end
@@ -60,10 +76,6 @@ module Alephant
         @parser ||= Parser.new
       end
 
-      def base_path
-        "#{Dir.pwd}/components"
-      end
-
       def fixture_location
         "#{base_path}/#{id}/fixtures/#{fixture}.json"
       end

data/lib/alephant/preview/version.rb

@@ -1,5 +1,5 @@
 module Alephant
   module Preview
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alephant-preview
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Robert Kenny
@@ -207,7 +207,7 @@ dependencies:
   prerelease: false
   type: :runtime
 - !ruby/object:Gem::Dependency
-  name: alephant
+  name: alephant-renderer
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='