glia 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7c365840fb404b696b34559a20de1fb19e0ade6
-  data.tar.gz: a8538ba3f88281dd85ccf16e7ea7264b1abd50ae
+  metadata.gz: c60022b523fa35b5f6fa9264a831fc701f264e85
+  data.tar.gz: 1e11377556148f16bbf2e250cf63e20bff7eb1a1
 SHA512:
-  metadata.gz: ef536f5b333cd5a3db8098ffa736d993a8a3e824dc14202c9f87f93167ca284e9d6e839c81fb64fd5c8e72cf0a11896b936ccef47f57d71fe39daed52b0ff3b0
-  data.tar.gz: 96f03d9af2a0ee4f97f7e6f9cc998fb36806a4ce785348eaa8fc5ef55c30e30e9b4cbe3acb35cdcbfd37a1a7ad6f582b67971c5d4998585fc0286bbb4872b08d
+  metadata.gz: 80d45c1149ce6a7af36b8312e54fa20a26cd392b68e397ac99788a1700ad703edaeaaf7e2badd2332405bc9098be9cc06587fb3b231b821d8fb6a6da4b570068
+  data.tar.gz: aa4ec7caebe66f54dad33ed98827a6cc6c80e88d0e943a15639439f4d512cf5e6d16e0b94c8c91583ac3ed5d098db078543d83a5c7a0bd30b130578e35308db0

data/README.md

@@ -280,6 +280,40 @@ class Client::RenderingPolicy < Lotus::RenderingPolicy
 end
 ```
 
+## Theme Inheritance
+In addition to areas, Glia provides a means to override the layouts with different 'themes'. 
+
+For example. If your project serves multiple sites that each need a different header, you can achieve this with themes. 
+
+```ruby
+Glia::UpdateRegistry.area(:frontend, :default) do
+  handle :default do
+    cell name: :root, class: :html, template_name: 'root' do
+      cell name: :header, class: :template, template_name: 'header'
+      cell name: :footer, class: :template, template_name: 'footer'
+    end
+  end
+end
+
+Glia::UpdateRegistry.area(:frontend, :au) do
+  handle :default do
+    cell name: :root, class: :html, template_name: 'root' do
+      cell name: :header, class: :template, template_name: 'header_au'
+      remove name: :footer
+    end
+  end
+end
+```
+
+When you get the layout, just specify which themes you want to merge. 
+
+```ruby
+layout = Glia.layout(:frontend, [:default, :product_view], theme_inheritance: [:default, :au])
+```  
+
+There is no limit to the number of themes you can use in the inheritance chain. 
+It begins with the first theme, and applies updates from each successive theme.
+
 ## Notes
 * When the DSL is parsed, the result is a simple hash of values that describes the layout. 
 

data/lib/glia.rb

@@ -8,8 +8,8 @@ require "glia/view_factory"
 
 module Glia
   # Your code goes here...
-  def self.area(code, &blk)
-    UpdateRegistry.area(code, &blk)
+  def self.area(code, theme = :default, &blk)
+    UpdateRegistry.area(code, theme, &blk)
   end
 
   def self.layout(area, handles, options = {})

data/lib/glia/cell.rb

@@ -26,5 +26,9 @@ module Glia
     def blocks
       @blocks ||= []
     end
+
+    def themes
+      layout.themes
+    end
   end
 end

data/lib/glia/layout.rb

@@ -2,14 +2,16 @@ module Glia
 
   class Layout
     attr_writer :view_factory
-    attr_reader :handles, :data, :update, :cells
+    attr_reader :handles, :data, :update, :cells, :themes
+
     singleton_class.class_eval do
       attr_accessor :layout_dir, :view_namespace
     end
 
     def initialize(area, handles, options = {})
       @area = area
-      @update = UpdateRegistry.area(area)
+      @themes = options[:theme_inheritance] || [:default]
+      @update = UpdateRegistry.merge_themes(area, )
       @cells = {}
       @handles = handles
       @data = @update.merge(@handles)

data/lib/glia/update_builder.rb

@@ -2,8 +2,8 @@ module Glia
 
   class UpdateBuilder
 
-    def initialize
-      @data = {}
+    def initialize(data = nil)
+      @data = data||{}
     end
 
     def view_namespace(namespace)
@@ -59,20 +59,28 @@ module Glia
       merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
       handles.each{|h| _data = _data.merge(@data[h].clone, &merger) unless @data[h].nil?}
 
+      #returned cleaned merged data
+      _clean_handle(_data)
+    end
+
+    private
+
+    def _clean_handle(data)
+      _data = data.nil? ? {} : data.clone
       # Remove orphan references, or deleted cells
       _data = _data.delete_if{|k, v|  v.nil? || v[:class].nil? || v[:_removed]}
 
       # Tidy up child references for deleted children, empty child lists
       _data.each_with_object({}) do |(name, definition), hash|
         d = definition.clone
-        d[:children].delete_if{|position, n| _data[n].nil?}
-        d.delete(:children) if d[:children].empty?
+        unless d[:children].nil?
+          d[:children].delete_if{|position, n| _data[n].nil?}
+          d.delete(:children) if d[:children].empty?
+        end
         hash[name] = d
       end
     end
 
-    private
-
     def _cell(definition, &blk)
       raise Glia::Errors::SyntaxError, 'cell cannot be used outside of handle' if @current_scope.nil?
       begin

data/lib/glia/update_registry.rb

@@ -1,17 +1,35 @@
 module Glia
   class UpdateRegistry
     class << self
-      def area(code, &blk)
+      def area(area_code, theme = :default, &blk)
         #@todo UpdateRegistry can load update_data from cache and instantiate new UpdateBuilder directly with cached data.
         @updates ||= {}
-        update = @updates[code] ||= UpdateBuilder.new
-
+        @updates[area_code] ||= {}
+        update = @updates[area_code][theme] ||= UpdateBuilder.new
         if block_given?
           update.instance_eval(&blk)
         end
 
         update
       end
+
+      def merge_themes(area_code, theme_inheritance = nil)
+        theme_inheritance ||= [:default]
+        merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+        data = theme_inheritance.each_with_object({}) do |theme, data|
+          data.merge!(area(area_code, theme).to_h, &merger)
+        end
+        UpdateBuilder.new(data)
+      end
+
+      def clear(area_code = nil)
+        if area_code.nil?
+          @updates = {}
+        else
+          @updates.delete(area_code)
+        end
+        self
+      end
     end
   end
 end

data/lib/glia/version.rb

@@ -1,3 +1,3 @@
 module Glia
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/test/fixtures/layout/default.rb

@@ -31,3 +31,9 @@ Glia.area(:frontend) do
   end
 
 end
+
+Glia.area(:test_area) do
+  handle :test do
+    cell name: :test, class: :template, comment: 'This area should be cleared between each test, so not in tests'
+  end
+end

data/test/fixtures/layout/default_au.rb

@@ -0,0 +1,7 @@
+Glia.area(:frontend, :au) do
+
+  handle :default do
+    reference name: :header, template: 'header_au'
+  end
+
+end

data/test/test_helper.rb

@@ -7,5 +7,9 @@ require 'fixtures/layout'
 
 class UnitTest < Minitest::Test
 
+  def setup
+    Glia::UpdateRegistry.clear(:test_area)
+  end
+
 end
 

data/test/unit/layout_test.rb

@@ -1,31 +1,37 @@
 require 'test_helper'
 class Glia::Layout::Test < UnitTest
-  describe Glia::Layout do
 
-    let(:layout){ Glia.layout(:frontend, [:default, :cake_view, :pavlova_view]) }
+  def setup
+    super
+    @layout = Glia.layout(:frontend, [:default, :cake_view, :pavlova_view], theme_inheritance: [:default, :au])
+  end
 
-    def test_update
-      assert_equal :'core/html', layout.update.to_h[:default][:root][:class]
-    end
 
-    def test_data
-      assert_equal :'core/html', layout.data[:root][:class]
-      assert_nil layout.data[:non_existent]
-    end
+  def test_update
+    assert_equal :'core/html', @layout.update.to_h[:default][:root][:class]
+  end
 
-    def test_cell
-      root = layout.cell(:root)
-      assert_instance_of Fixtures::View::Core::Html, root
-      assert_equal 'root', root.template_name
-      assert_operator root.children.count, :>=, 1
-      child = root.cell(:content)
-      assert_equal layout.cell(:details), child
-      assert_instance_of Fixtures::View::Template, child
-      assert_equal 'cake_details', child.template_name
-      ingredients = layout.cell(:cake_ingredients)
-      assert_instance_of Fixtures::View::Template, ingredients
-      assert_equal 'cake/pavlova_ingredients', ingredients.template_name
-    end
+  def test_data
+    assert_equal :'core/html', @layout.data[:root][:class]
+    assert_nil @layout.data[:non_existent]
+    assert_equal [:default, :au], @layout.themes
+  end
 
+  def test_cell
+    root = @layout.cell(:root)
+    assert_instance_of Fixtures::View::Core::Html, root
+    assert_equal 'root', root.template_name
+    assert_operator root.children.count, :>=, 1
+    assert_equal [:default, :au], root.themes
+    child = root.cell(:content)
+    assert_equal @layout.cell(:details), child
+    assert_instance_of Fixtures::View::Template, child
+    assert_equal 'cake_details', child.template_name
+    assert_equal [:default, :au], child.themes
+    ingredients = @layout.cell(:cake_ingredients)
+    assert_instance_of Fixtures::View::Template, ingredients
+    assert_equal 'cake/pavlova_ingredients', ingredients.template_name
+    assert_equal [:default, :au], ingredients.themes
   end
+
 end

data/test/unit/update_builder_test.rb

@@ -1,66 +1,69 @@
 require 'test_helper'
 class Glia::UpdateBuilder::Test < UnitTest
-  describe Glia::UpdateBuilder do
-    let(:builder) { Glia::UpdateBuilder.new }
 
-    def test_cell
-      builder.handle :test do
-        reference name: :defined_later do
-          cell name: :defined_later_sub_cell, class: :template, position: :here
-        end
-        cell name: :root, class: :html, template_name: 'root' do
-          action name: :compile, args: ['javascript', 'css']
-          cell name: :header, class: :template, template_name: 'header'
-        end
-      end
-      builder.handle :test, :other_handle do
-        cell name: :defined_later, class: :list
+  def setup
+    super
+    @builder = Glia::UpdateBuilder.new
+  end
+
+  def test_cell
+    @builder.handle :test do
+      reference name: :defined_later do
+        cell name: :defined_later_sub_cell, class: :template, position: :here
       end
-      expected_output = {
-          test: {
-              root: {class: :html, template_name: 'root',
-                     children: {header: :header}, actions: [{name: :compile, args: ['javascript', 'css']}]},
-              header: {class: :template, template_name: 'header', children: {}},
-              defined_later: {children: {here: :defined_later_sub_cell}, class: :list},
-              defined_later_sub_cell: {children: {}, class: :template}
-          },
-          other_handle: {
-              defined_later: {children: {}, class: :list},
-          }
-      }
-      assert_equal expected_output, builder.to_h
-      assert_raises Glia::Errors::SyntaxError do
-        builder.cell name: :header, class: :template, template_name: 'header'
+      cell name: :root, class: :html, template_name: 'root' do
+        action name: :compile, args: ['javascript', 'css']
+        cell name: :header, class: :template, template_name: 'header'
       end
     end
+    @builder.handle :test, :other_handle do
+      cell name: :defined_later, class: :list
+    end
+    expected_output = {
+        test: {
+            root: {class: :html, template_name: 'root',
+                   children: {header: :header}, actions: [{name: :compile, args: ['javascript', 'css']}]},
+            header: {class: :template, template_name: 'header', children: {}},
+            defined_later: {children: {here: :defined_later_sub_cell}, class: :list},
+            defined_later_sub_cell: {children: {}, class: :template}
+        },
+        other_handle: {
+            defined_later: {children: {}, class: :list},
+        }
+    }
+    assert_equal expected_output, @builder.to_h
+    assert_raises Glia::Errors::SyntaxError do
+      @builder.cell name: :header, class: :template, template_name: 'header'
+    end
+  end
 
-    def test_merge
-      builder.handle :default do
-        remove name: :defined_later
-        cell name: :root, class: :html, template_name: 'root' do
-          action name: :compile, args: ['javascript', 'css']
-          cell name: :header, class: :template, template_name: 'header'
-          cell name: :footer, class: :template, template_name: 'footer'
-        end
+  def test_merge
+    @builder.handle :default do
+      remove name: :defined_later
+      cell name: :root, class: :html, template_name: 'root' do
+        action name: :compile, args: ['javascript', 'css']
+        cell name: :header, class: :template, template_name: 'header'
+        cell name: :footer, class: :template, template_name: 'footer'
       end
-      builder.handle :test do
-        remove name: :header
-        reference name: :footer, template_name: 'new_footer' do
-          cell name: :copyright, class: :template, template_name: 'copyright', position: :footer_bottom
-        end
-        cell name: :defined_later, class: :list
+    end
+    @builder.handle :test do
+      remove name: :header
+      reference name: :footer, template_name: 'new_footer' do
+        cell name: :copyright, class: :template, template_name: 'copyright', position: :footer_bottom
       end
-      expected_output = {
-          root: {
-              class: :html,
-              template_name: 'root',
-              children: {footer: :footer},
-              actions: [{name: :compile, args: ['javascript', 'css']}]
-          },
-          footer: {class: :template, template_name: 'new_footer', children: {footer_bottom: :copyright}},
-          copyright: {class: :template, template_name: 'copyright'}
-      }
-      assert_equal expected_output, builder.merge([:default, :test])
+      cell name: :defined_later, class: :list
     end
+    expected_output = {
+        root: {
+            class: :html,
+            template_name: 'root',
+            children: {footer: :footer},
+            actions: [{name: :compile, args: ['javascript', 'css']}]
+        },
+        footer: {class: :template, template_name: 'new_footer', children: {footer_bottom: :copyright}},
+        copyright: {class: :template, template_name: 'copyright'}
+    }
+    assert_equal expected_output, @builder.merge([:default, :test])
   end
+
 end

data/test/unit/update_registry_test.rb

@@ -0,0 +1,75 @@
+require 'test_helper'
+class Glia::UpdateRegistry::Test < UnitTest
+
+  def test_theme
+    assert_equal({}, Glia::UpdateRegistry.area(:test_area).to_h) #describe messes with inheritance
+
+    Glia::UpdateRegistry.area(:test_area, :nz) do
+      handle :test do
+        cell name: :root, class: :html, template_name: 'root' do
+          cell name: :header, class: :template, template_name: 'header_nz'
+        end
+      end
+    end
+
+    Glia::UpdateRegistry.area(:test_area, :au) do
+      handle :test do
+        cell name: :root, class: :html, template_name: 'root' do
+          cell name: :header, class: :template, template_name: 'header_au'
+        end
+      end
+    end
+
+    assert_equal 'header_nz', Glia::UpdateRegistry.area(:test_area, :nz).to_h[:test][:header][:template_name]
+    assert_equal 'header_au', Glia::UpdateRegistry.area(:test_area, :au).to_h[:test][:header][:template_name]
+
+  end
+
+  def test_merge_themes
+    assert_equal({}, Glia::UpdateRegistry.area(:test_area).to_h)
+
+    Glia::UpdateRegistry.area(:test_area, :default) do
+      handle :test do
+        cell name: :root, class: :html, template_name: 'root' do
+          cell name: :header, class: :template, template_name: 'header'
+          cell name: :footer, class: :template, template_name: 'footer'
+        end
+      end
+    end
+
+    Glia::UpdateRegistry.area(:test_area, :au) do
+      handle :test do
+        cell name: :root, class: :html, template_name: 'root' do
+          cell name: :header, class: :template, template_name: 'header_au'
+          remove name: :footer
+        end
+      end
+    end
+
+    # We can't clean up the deleted/orphaned children until the handles are merged
+    expected_output = {
+      test: {
+          root: {
+              children: {header: :header, footer: :footer},
+              class: :html,
+              template_name: 'root'
+          },
+          header: {
+              children: {},
+              class: :template,
+              template_name: 'header_au'
+          },
+          footer: {
+              children: {},
+              class: :template,
+              template_name: 'footer',
+              _removed: true
+          }
+      }
+    }
+
+    assert_equal expected_output, Glia::UpdateRegistry.merge_themes(:test_area, [:default, :au]).to_h
+
+  end
+
+end

data/test/unit/view_factory_test.rb

@@ -1,24 +1,26 @@
 require 'test_helper'
 class Glia::ViewFactory::Test < UnitTest
-  describe Glia::ViewFactory do
-    let(:factory) { Glia::ViewFactory.new }
 
-    def test_find_class
-      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 setup
+    super
+    @factory = Glia::ViewFactory.new
+  end
 
-    def test_build
-      cell = factory.build(
-          :template,
-          Fixtures::View,
-          {template_name: 'my_template'},
-          [{name: :add_ingredient, args: ['Eggs', '6 Large']}]
-      )
-      assert_instance_of Fixtures::View::Template, cell
-      assert_equal 'my_template', cell.template_name
-      assert_equal 'Eggs : 6 Large', cell.ingredients.first
-    end
+  def test_find_class
+    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']}]
+    )
+    assert_instance_of Fixtures::View::Template, cell
+    assert_equal 'my_template', cell.template_name
+    assert_equal 'Eggs : 6 Large', cell.ingredients.first
   end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glia
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Dane Lowe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-09 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,6 +78,7 @@ files:
 - readme/layout_pav.png
 - test/fixtures/layout.rb
 - test/fixtures/layout/default.rb
+- test/fixtures/layout/default_au.rb
 - test/fixtures/view.rb
 - test/fixtures/view/core/html.rb
 - test/fixtures/view/list.rb
@@ -85,6 +86,7 @@ files:
 - test/test_helper.rb
 - test/unit/layout_test.rb
 - test/unit/update_builder_test.rb
+- test/unit/update_registry_test.rb
 - test/unit/view_factory_test.rb
 homepage: https://github.com/danelowe/glia
 licenses:
@@ -113,6 +115,7 @@ summary: Manage App Layouts.
 test_files:
 - test/fixtures/layout.rb
 - test/fixtures/layout/default.rb
+- test/fixtures/layout/default_au.rb
 - test/fixtures/view.rb
 - test/fixtures/view/core/html.rb
 - test/fixtures/view/list.rb
@@ -120,5 +123,6 @@ test_files:
 - test/test_helper.rb
 - test/unit/layout_test.rb
 - test/unit/update_builder_test.rb
+- test/unit/update_registry_test.rb
 - test/unit/view_factory_test.rb
 has_rdoc: