glia 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f3643b91dabc177197be3c240ff6de7c21522c0
-  data.tar.gz: 3f493ca6458e66cf8f39735f7f2e81b8f960a0e6
+  metadata.gz: 9a50686cc03676e699d74a01655c296020b723bb
+  data.tar.gz: 4ba937471d4071c387dec39827bb2f5ed0b480e4
 SHA512:
-  metadata.gz: ddfebae6ff8ffdb40e9cdfd0cb877714e4dfa68b62668f80b36bc7cf0c9997a7c216e0359dbec91eb98a7098d5239b12538ee7ebcc8afbab4a3c7d1db06b6011
-  data.tar.gz: 45006a08c0f57dfeec98722b6b81ce960057a032516952bb0037d8befcc55098c24d1305f2727d1948a032fe9f39b1d8613afdacc62676ebd2fb41c5aae31a75
+  metadata.gz: bcdd053ca3266f8747da57001154d65c31201bffb43c988d1b63db6277e3dcaf5f5c60732953de6648eb998f9a88e888827903db0a4d20df71249a7f8e1902a8
+  data.tar.gz: 8e15f7300f86449b0853e6deff45a87d0ef0998a456399c78fe1b9904c9ef3374da2301808482086878cb409e8c44a150aa54e5bae7b5d40863c1f70b2f6b937

data/README.md

@@ -41,9 +41,14 @@ Layout files are written with a DSL that is designed to help describe the layout
 ```ruby
 # layout/frontend/default.rb
 Glia.area(:frontend) do 
+  view_namespace Fixtures::View
   handle :default do
     cell name: :root, class: :'core/html', template_name: 'root', missing_accessor: 'ignore_me' do
       cell name: :header, class: :template, template_name: 'header'
+      cell name: :sidebar, class: :list do
+        # ...
+      end
+      cell name: :footer, class: :template, template_name: 'footer'
     end
   end
   handle :cake_view do
@@ -67,6 +72,15 @@ Glia.area(:frontend) do
 end
 ```
 
+![Cake View](readme/layout_cake.png?raw=true)
+
+![Pav View](readme/layout_pav.png?raw=true)
+
+#### View Namespace (Optional)
+
+Pass a class/module. Any cell created within this area definition using a string or symbol for `class` 
+will use this namespace when getting the actual class. 
+
 #### Handle
 
 Handles are key tool for customising your layout per page. 
@@ -172,14 +186,6 @@ end
 
 The handles will be generated in the controller based on the request/loaded objects/controller. Examples to come.
 
-#### Configure the layout 
-
-If you wish to use class codes in place of classes, Tell it what namespace to use when finding classes for a class code. 
-
-```ruby
-Glia::Layout.view_namespace = Fixtures::View
-```
-
 #### Create a layout
 
 Pick an 'area' to render, e.g. `:frontend` or `:admin`, and pass this into the layout method along with the handles.
@@ -224,6 +230,50 @@ Try one or more of these options:
   pass data to, and the cells can read data from. 
 * If more flexibility is required, the controller can pull a specific cell from the layout, and call a method on it. 
 
+### Customise the ViewFactory
+
+Example for Customised Lotus Views
+
+```ruby
+module Frontend
+  class Application < Lotus::Application
+
+    def renderer
+      @custom_renderer ||= Client::RenderingPolicy.new(configuration)
+    end
+
+    configure do
+      # ...
+    end
+
+  end
+end
+```
+
+```ruby
+require 'glia'
+class Client::RenderingPolicy < Lotus::RenderingPolicy
+
+  class ViewFactory < Glia::ViewFactory
+    def instantiate(klass, definition, *args)
+      #@todo: Allow blocks/cells to subscribe to registry values.
+      locals = args[0].nil? ? definition : definition.merge(args[0])
+      klass.new({format: :html}.merge(locals))
+    end
+  end
+
+  def _render_action(action, response)
+    if successful?(response)
+      RequestStore.store[:action_exposures] = action.exposures
+      layout = Glia.layout(:frontend, action.handles)
+      layout.view_factory = ViewFactory.new
+      layout.cell(:root, action.exposures).render
+    end
+  end
+
+end
+```
+
 ## Notes
 * When the DSL is parsed, the result is a simple hash of values that describes the layout. 
 

data/lib/glia/cell.rb

@@ -1,15 +1,22 @@
 module Glia
   module Cell
+    attr_accessor :child_definitions, :layout
+
     # To be overloaded, but here to prevent errors if we don't define initialize
     def initialize(config)
     end
 
     def children
       @children ||= {}
+      child_definitions.keys.each{|p| @children[p] ||= cell(p)} unless child_definitions.nil?
+      @children
     end
 
-    def cell(code)
-      @children[code]
+    def cell(code, *args)
+      @children ||= {}
+      name = child_definitions[code]
+      raise Errors::MissingCellError, "No child cell in position #{code}" if name.nil?
+      @children[code] ||= layout.cell(name, *args)
     end
   end
 end

data/lib/glia/errors.rb

@@ -2,5 +2,9 @@ module Glia
   module Errors
     class SyntaxError < StandardError
     end
+    class MissingCellError < StandardError
+    end
+    class InvalidCellError < StandardError
+    end
   end
 end

data/lib/glia/layout.rb

@@ -1,6 +1,7 @@
 module Glia
 
   class Layout
+    attr_writer :view_factory
     attr_reader :handles, :data, :update, :cells
     singleton_class.class_eval do
       attr_accessor :layout_dir, :view_namespace
@@ -13,20 +14,26 @@ module Glia
       @data = @update.merge(@handles)
     end
 
-    def cell(name)
+    def cell(name, *args)
       if @cells[name].nil?
         definition = @data[name]
+        raise Errors::MissingCellError, "Cell #{name} is missing from layout" if definition.nil?
         code = definition.delete(:class)
         actions = definition.delete(:actions)
         children = definition.delete(:children)
-        @cells[name] = view_factory.build(code, definition, actions)
-        children.each{|p, n| @cells[name].children[p] = cell(n)} unless children.nil?
+        namespace = definition.delete(:view_namespace) || Object
+        @cells[name] = view_factory.build(code, namespace, definition, actions, *args)
+        unless @cells[name].respond_to?(:child_definitions=)
+          raise Errors::InvalidCellError, @cells[name].class.name+' is not a valid cell. Include Glia::Cell.'
+        end
+        @cells[name].child_definitions = children
+        @cells[name].layout = self
       end
       @cells[name]
     end
 
     def view_factory
-      @view_factory ||= ViewFactory.new(self.class.view_namespace)
+      @view_factory ||= ViewFactory.new
     end
 
   end

data/lib/glia/update_builder.rb

@@ -6,6 +6,11 @@ module Glia
       @data = {}
     end
 
+    def view_namespace(namespace)
+      @view_namespace = namespace
+      self
+    end
+
     def handle(key, &blk)
       begin
         @current_scope = @data[key] ||= {}
@@ -15,10 +20,14 @@ module Glia
         @current_scope = nil
         @current_cell = nil
       end
+      self
     end
 
     def cell(definition, &blk)
       raise Glia::Errors::SyntaxError, 'cell must have a class' if definition[:class].nil?
+      # Store the namespace here, for use when building layout.
+      # We delay resolving the class, in case a block is not used, or is defined later.
+      definition[:view_namespace] = @view_namespace unless @view_namespace.nil?
       _cell(definition, &blk)
     end
 

data/lib/glia/version.rb

@@ -1,3 +1,3 @@
 module Glia
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/glia/view_factory.rb

@@ -1,26 +1,32 @@
 module Glia
   class ViewFactory
-    def initialize(namespace)
-      @namespace = namespace  || Object
+
+    def build(code, view_namespace = Object, definition = {}, actions = [], *args)
+      object = instantiate(find_class(code, view_namespace), definition, *args)
+      apply_actions(object, actions)
+      object
+    end
+
+    def instantiate(klass, definition, *args)
+      klass.new(*(args|[definition]))
     end
 
-    def build(code, definition = {}, actions = [])
-      object = find_class(code).new(definition)
+    def apply_actions(object, actions)
       actions.each do |action|
         object.send(action[:name], *action[:args])
       end unless actions.nil?
-      object
     end
 
-    def find_class(code)
+    def find_class(code, view_namespace = Object)
       if code.is_a? Symbol
         parts = code.to_s.split('/').map{ |str| str.split('_').map {|w| w.capitalize}.join }
-        parts.inject(@namespace){|namespace, part| namespace.const_get(part)}
+        parts.inject(view_namespace){|namespace, part| namespace.const_get(part)}
       elsif code.is_a? String
-        @namespace.const_get(code)
+        view_namespace.const_get(code)
       else
         code
       end
     end
+
   end
 end

data/test/fixtures/layout/default.rb

@@ -1,4 +1,5 @@
 Glia.area(:frontend) do
+  view_namespace Fixtures::View
 
   handle :default do
     cell name: :root, class: :'core/html', template_name: 'root', missing_accessor: 'ignore_me' do

data/test/unit/layout_test.rb

@@ -2,7 +2,6 @@ require 'test_helper'
 class Glia::Layout::Test < UnitTest
   describe Glia::Layout do
 
-    Glia::Layout.view_namespace = Fixtures::View
     let(:layout){ Glia.layout(:frontend, [:default, :cake_view, :pavlova_view]) }
 
     def test_update

data/test/unit/view_factory_test.rb

@@ -1,16 +1,17 @@
 require 'test_helper'
 class Glia::ViewFactory::Test < UnitTest
   describe Glia::ViewFactory do
-    let(:factory) { Glia::ViewFactory.new(Fixtures::View) }
+    let(:factory) { Glia::ViewFactory.new }
 
     def test_find_class
-      assert_equal Fixtures::View::Template, factory.find_class(:template)
-      assert_equal Fixtures::View::Core::Html, factory.find_class(:'core/html')
+      assert_equal Fixtures::View::Template, factory.find_class(:template, Fixtures::View)
+      assert_equal Fixtures::View::Core::Html, factory.find_class(:'core/html', Fixtures::View)
     end
 
     def test_build
       cell = factory.build(
           :template,
+          Fixtures::View,
           {template_name: 'my_template'},
           [{name: :add_ingredient, args: ['Eggs', '6 Large']}]
       )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glia
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dane Lowe
@@ -74,6 +74,8 @@ files:
 - lib/glia/update_registry.rb
 - lib/glia/version.rb
 - lib/glia/view_factory.rb
+- readme/layout_cake.png
+- readme/layout_pav.png
 - test/fixtures/layout.rb
 - test/fixtures/layout/default.rb
 - test/fixtures/view.rb