noumenon 0.1.1 → 0.1.2

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# 0.1.2
+
+## New Features
+
+* Started keeping a changelog.
+* Added the `assign_to` and `item_at_path` filters for use in templates.
+
+## Bug Fixes
+
+* Attempting to use a theme which is not loaded will no longer result in an infinite loop.

data/README.md

@@ -69,6 +69,9 @@ If not specified the type defaults to "string", the label to a capitalised versi
 
 Any fields provided to a template which aren't specified will still be available in the Liquid template part.
 
+Templates are written using Liquid, and so all the [standard tags and filters](https://github.com/tobi/liquid/wiki/Liquid-for-Designers)
+are available, as well as the ones documented at [Noumenon::Template::CoreTags](http://rubydoc.info/gems/noumenon/Noumenon/Template/CoreTags).
+
 #### Layouts
 
 Layouts are used to wrap a piece of content with the overall look and feel of your website, and are provided with a single field

data/features/including_content_from_a_template.feature

@@ -0,0 +1,17 @@
+Feature: Including content in a template
+  As a designer
+  I want to include a piece of content within a page
+  So that it can be changed by the end user
+
+  Scenario: The content item exists
+    Given this template exists at "inclusion.nou.html"
+      """
+      {{ "/includes/header" | item_at_path | assign_to: "header" }}
+      <h1>{{ header.title }}</h1>
+      """
+    And this content item exists at "/inclusion"
+      | template | inclusion |
+    And this content item exists at "/includes/header"
+      | title | The site title |
+    When I view "/inclusion"
+    Then the headline should be "The site title"

data/features/step_definitions/liquid_steps.rb

@@ -0,0 +1,3 @@
+When /^I have loaded the example tags$/ do
+  require 'noumenon/spec/example_tags'
+end

data/features/template_extensions.feature

@@ -0,0 +1,32 @@
+Feature: Registering template extensions
+  As a developer
+  I want to register Liquid extensions
+  So that my designers can use the application I'm writing
+  
+  Scenario: Registering a tag
+    Given this template exists at "tag.nou.html"
+      """
+      {% hello_world %}
+      """
+    And this content item exists at "/tag"
+      | template | tag |
+    And I have loaded the example tags
+    When I view "/tag"
+    Then the page content should be:
+      """
+      Hello, world!
+      """
+
+  Scenario: Registering a filter
+    Given this template exists at "filter.nou.html"
+      """
+      {{ "hello" | opposite_day }}
+      """
+    And this content item exists at "/filter"
+      | template | filter |
+    And I have loaded the example tags
+    When I view "/filter"
+    Then the page content should be:
+      """
+      goodbye
+      """

data/lib/noumenon/spec/example_tags.rb

@@ -0,0 +1,18 @@
+require 'noumenon/template'
+
+module Noumenon::Spec::ExampleTags
+  class HelloWorldTag < Liquid::Tag
+    def render(context)
+      "Hello, world!"
+    end
+  end
+  Liquid::Template.register_tag 'hello_world', HelloWorldTag
+  
+  module OppositeDayFilter
+    def opposite_day(input)
+      return "goodbye" if input == "hello"
+      input 
+    end
+  end
+  Liquid::Template.register_filter(OppositeDayFilter)
+end

data/lib/noumenon/template/core_tags.rb

@@ -0,0 +1,42 @@
+require 'noumenon/template'
+
+# Liquid extensions provided by Noumenon.
+#
+# @see [ Noumenon::Template::CoreTags::Filters ]
+module Noumenon::Template::CoreTags
+  # The core set of filters provided by Noumenon for use in templates.
+  #
+  # @api public
+  module Filters
+    # Assigns the data piped in to the named variable.
+    #
+    # @example
+    #   {{ "Jon" | assign_to: "name" }}
+    #   {{ name }}
+    #
+    # @api public
+    def assign_to(input, variable)
+      @context.scopes.last[variable] = input
+      ''
+    end
+    
+    # Loads the content item at the path provided and passes it on.
+    # 
+    # If nothing was found then nothing will be returned, allowing the presence
+    # of some content to be checked before trying to use it.
+    # 
+    # @example
+    #   {{ "/includes/site_details" | item_at_path | assign_to: "site" }}
+    #   {% if site %}
+    #     <h1>{{ site.title }}</h1>
+    #     <p>Written by {{ site.author }}</p>
+    #   {% end %}
+    #
+    # @api public
+    def item_at_path(input)
+      item = Noumenon.content_repository.get(input)
+      item ? item.stringify_keys : nil
+    end
+  end
+  Liquid::Template.register_filter(Filters)
+end

data/lib/noumenon/template.rb

@@ -1,5 +1,5 @@
-require 'noumenon'
 require 'liquid'
+require 'noumenon'
 
 # Templates specify the structure and presentation of a particular piece of content in
 # a Noumenon site, and are usually provided by a theme.
@@ -86,6 +86,14 @@ class Noumenon::Template
     self.new(path, content, fields)
   end
   
+  def self.drops
+    @drops ||= {}
+  end
+  
+  def self.register_drop(name, klass)
+    drops[name] = klass
+  end
+
   # Creates a new Template instance.
   #
   # @api public
@@ -123,7 +131,9 @@ class Noumenon::Template
     end
 
     raise MissingContentError.new("The following fields were missing from your content: #{missing_fields.sort.join(", ")}") unless missing_fields.empty?
-
-    Liquid::Template.parse(content).render(fields_from_page)
+    
+    Liquid::Template.parse(content).render(fields_from_page.merge(self.class.drops))
   end
 end
+
+require 'noumenon/template/core_tags'

data/lib/noumenon/version.rb

@@ -1,5 +1,5 @@
 module Noumenon
   # The current version of Noumenon.
   # @api public
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/noumenon.rb

@@ -69,6 +69,7 @@ module Noumenon
     if theme.is_a? Noumenon::Theme
       @theme = theme
     else
+      raise ArgumentError.new("The theme '#{theme}' has not been loaded.") unless Noumenon::Theme.themes.key?(theme)
       self.theme = Noumenon::Theme.themes[theme]
     end
     

data/spec/noumenon_spec.rb

@@ -24,7 +24,7 @@ describe Noumenon do
 
     context "when assigning a theme name" do
       around do |example|
-        with_temporary_theme do
+        with_temporary_theme(name: "Example Theme") do
           example.run
         end
       end
@@ -37,7 +37,16 @@ describe Noumenon do
       end
 
       it "raises an ArgumentError if it has not been registered" do
+        error_raised = false
 
+        begin
+          Noumenon.theme = "Unloaded Theme"
+        rescue ArgumentError => e
+          error_raised = true
+          e.to_s.should == "The theme 'Unloaded Theme' has not been loaded."
+        end
+
+        error_raised.should be_true
       end
     end
   end

metadata

@@ -2,7 +2,7 @@
 name: noumenon
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Jon Wood
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-25 00:00:00 +01:00
+date: 2011-05-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -159,6 +159,7 @@ files:
 - .gitignore
 - .travis.yml
 - .yardopts
+- CHANGELOG.md
 - Gemfile
 - MIT-LICENSE
 - README.md
@@ -166,15 +167,18 @@ files:
 - bin/noumenon
 - features/dynamic_template_rendering.feature
 - features/generator/site_generator.feature
+- features/including_content_from_a_template.feature
 - features/mounted_applications.feature
 - features/static_template_rendering.feature
 - features/step_definitions/asset_steps.rb
 - features/step_definitions/content_steps.rb
 - features/step_definitions/generator_steps.rb
+- features/step_definitions/liquid_steps.rb
 - features/step_definitions/request_steps.rb
 - features/step_definitions/theme_steps.rb
 - features/support/env.rb
 - features/support/theme/theme.yml
+- features/template_extensions.feature
 - features/theme_assets.feature
 - generators/repository/index.yml
 - generators/site/Gemfile
@@ -190,9 +194,11 @@ files:
 - lib/noumenon/repository/file_system.rb
 - lib/noumenon/spec.rb
 - lib/noumenon/spec/example_app.rb
+- lib/noumenon/spec/example_tags.rb
 - lib/noumenon/spec/theme_helpers.rb
 - lib/noumenon/string_extensions.rb
 - lib/noumenon/template.rb
+- lib/noumenon/template/core_tags.rb
 - lib/noumenon/theme.rb
 - lib/noumenon/theme/assets_middleware.rb
 - lib/noumenon/version.rb
@@ -237,15 +243,18 @@ summary: A flexible content management system.
 test_files: 
 - features/dynamic_template_rendering.feature
 - features/generator/site_generator.feature
+- features/including_content_from_a_template.feature
 - features/mounted_applications.feature
 - features/static_template_rendering.feature
 - features/step_definitions/asset_steps.rb
 - features/step_definitions/content_steps.rb
 - features/step_definitions/generator_steps.rb
+- features/step_definitions/liquid_steps.rb
 - features/step_definitions/request_steps.rb
 - features/step_definitions/theme_steps.rb
 - features/support/env.rb
 - features/support/theme/theme.yml
+- features/template_extensions.feature
 - features/theme_assets.feature
 - spec/noumenon/repository/file_system_spec.rb
 - spec/noumenon/repository_spec.rb