mullet 0.0.2 → 0.0.3

data/lib/mullet.rb

@@ -1,8 +1,9 @@
-require 'mullet/default_model'
-require 'mullet/default_nested_model'
-require 'mullet/model'
+require 'mullet/default_scope'
+require 'mullet/default_nested_scope'
+require 'mullet/scope'
 require 'mullet/template_error'
 require 'mullet/version'
+require 'mullet/view'
 
 require 'mullet/html/layout'
 require 'mullet/html/template'

data/lib/mullet/{default_nested_model.rb → default_nested_scope.rb}

@@ -1,19 +1,19 @@
-require 'mullet/default_model'
+require 'mullet/default_scope'
 
 module Mullet
 
-  # Composite model that combines models in nested scopes. Tries each model in
+  # Composite scope that combines scopes in nested scopes. Tries each scope in
   # sequence until a value is successfully resolved.
-  class DefaultNestedModel
-    include Model
+  class DefaultNestedScope
+    include Scope
 
     # Constructor
     # 
-    # @param dataObjects
+    # @param data_objects
     #           scopes in outer to inner order
-    def initialize(*dataObjects)
+    def initialize(*data_objects)
       @scopes = []
-      dataObjects.each {|data| push_scope(data) }
+      push_scope(*data_objects)
     end
 
     # Resolves variable name to value.
@@ -32,13 +32,15 @@ module Mullet
       return NOT_FOUND
     end
 
-    # Adds a nested scope to search in subsequent lookups.
+    # Adds new innermost nested scopes.
     #
-    # @param data
-    #           data object
-    def push_scope(data)
-      @scopes.push(
-          data.respond_to?(:get_variable_value) ? data : DefaultModel.new(data))
+    # @param data_objects
+    #           scopes in outer to inner order
+    def push_scope(*data_objects)
+      data_objects.each do |data|
+        @scopes.push(
+            data.respond_to?(:get_variable_value) ? data : DefaultScope.new(data))
+      end
     end
 
     # Removes innermost nested scope.

data/lib/mullet/{default_model.rb → default_scope.rb}

@@ -1,38 +1,32 @@
-require 'mullet/model'
+require 'mullet/scope'
 
 module Mullet
 
-  # Default model implementation which resolves variable names to values by
+  # Default scope implementation which resolves variable names to values by
   # reading from a data object. Given a variable name _key_, the following
   # mechanisms are tried in this order:
   #
-  #   * If the variable name is `this`, then return the object.
-  #   * If the object is a `Hash`, then use _key_ as the key to retrieve the
-  #     value from the hash.
+  #   * If the variable name is `.`, then return the object.
   #   * If the object has a method named _key_ taking no parameters, then use
   #     the value returned from calling the method.
   #   * If the object has an instance variable named @_key_, then use the
   #     variable value.
+  #   * If the object is a `Hash`, then use _key_ as the key to retrieve the
+  #     value from the hash.
   #
   # If the value is a Proc, then use the value returned from calling it.
-  class DefaultModel
-    include Model
+  class DefaultScope
+    include Scope
 
     def initialize(data)
       @data = data
     end
 
     def fetch_impl(name)
-      if name == :this
+      if name == :'.'
         return @data
       end
 
-      # Is the variable name a key in a Hash?
-      if @data.respond_to?(:fetch)
-        # Call the block if the key is not found.
-        return @data.fetch(name) {|k| @data.fetch(k.to_s(), NOT_FOUND) }
-      end
-
       # Does the variable name match a method name in the object?
       if @data.respond_to?(name)
         method = @data.method(name)
@@ -47,6 +41,12 @@ module Mullet
         return @data.instance_variable_get(variable)
       end
 
+      # Is the variable name a key in a Hash?
+      if @data.respond_to?(:fetch)
+        # If the key was not found, then try to find it as a String.
+        return @data.fetch(name) {|k| @data.fetch(k.to_s(), NOT_FOUND) }
+      end
+
       return NOT_FOUND
     end
 

data/lib/mullet/html/attribute_command.rb

@@ -1,4 +1,4 @@
-require 'mullet/model'
+require 'mullet/scope'
 
 module Mullet; module HTML
 
@@ -23,7 +23,7 @@ module Mullet; module HTML
     #           attributes to update
     def execute(render_context, attributes)
       value = get_value(render_context)
-      if value == Model::NOT_FOUND || value == nil
+      if value == Scope::NOT_FOUND || value == nil
         # Value not found.  Do not render the attribute.
         attributes.delete(@attribute_name)
       else

data/lib/mullet/html/element_renderer.rb

@@ -3,7 +3,7 @@ require 'mullet/template_error'
 require 'mullet/html/command'
 require 'mullet/html/message'
 require 'mullet/html/message_attribute_command'
-require 'mullet/html/model_attribute_command'
+require 'mullet/html/scope_attribute_command'
 
 module Mullet; module HTML
 
@@ -43,7 +43,7 @@ module Mullet; module HTML
 
     def add_attribute_command(attribute_name, variable_name)
       @attribute_commands <<
-          ModelAttributeCommand.new(attribute_name, variable_name)
+          ScopeAttributeCommand.new(attribute_name, variable_name)
     end
 
     def add_attribute_commands(attribute_variable_pairs)

data/lib/mullet/html/for_element_renderer.rb

@@ -1,5 +1,5 @@
 require 'mullet/html/command_element_renderer'
-require 'mullet/model'
+require 'mullet/scope'
 
 module Mullet; module HTML
 
@@ -19,7 +19,7 @@ module Mullet; module HTML
 
     alias :super_render :render
 
-    def render_nested_model(data, render_context)
+    def render_nested_scope(data, render_context)
       render_context.push_scope(data)
       super_render(render_context)
       render_context.pop_scope()
@@ -27,7 +27,7 @@ module Mullet; module HTML
 
     def render(render_context)
       value = render_context.get_variable_value(@variable_name)
-      if value == Model::NOT_FOUND || value == nil || value == false
+      if value == Scope::NOT_FOUND || value == nil || value == false
         return
       end
 
@@ -36,11 +36,11 @@ module Mullet; module HTML
       end
 
       if value.respond_to?(:each)
-        value.each {|item| render_nested_model(item, render_context) }
+        value.each {|item| render_nested_scope(item, render_context) }
         return
       end
 
-      render_nested_model(value, render_context)
+      render_nested_scope(value, render_context)
     end
   end
 

data/lib/mullet/html/if_element_renderer.rb

@@ -1,5 +1,5 @@
 require 'mullet/html/command_element_renderer'
-require 'mullet/model'
+require 'mullet/scope'
 
 module Mullet; module HTML
 
@@ -19,7 +19,7 @@ module Mullet; module HTML
 
     def should_render_element(render_context)
       value = render_context.get_variable_value(@variable_name)
-      if value == Model::NOT_FOUND || value == nil
+      if value == Scope::NOT_FOUND || value == nil
         return false
       end
 

data/lib/mullet/html/{model_attribute_command.rb → scope_attribute_command.rb}

@@ -2,8 +2,8 @@ require 'mullet/html/attribute_command'
 
 module Mullet; module HTML
 
-  # Operation to set attribute value from model.
-  class ModelAttributeCommand
+  # Operation to set attribute to value resolved from a scope.
+  class ScopeAttributeCommand
     include AttributeCommand
 
     # Constructor

data/lib/mullet/html/template_loader.rb

@@ -7,7 +7,7 @@ module Mullet; module HTML
   # loaded templates.
   #
   # By default, templates render an empty string when a variable is not found
-  # or its value is null. Call the `on_missing` and `on_nil` methods to
+  # or its value is nil. Call the `on_missing` and `on_nil` methods to
   # configure how templates loaded by this loader should handle missing and nil
   # values respectively.
   class TemplateLoader

data/lib/mullet/render_context.rb

@@ -1,5 +1,5 @@
 require 'cgi'
-require 'mullet/default_nested_model'
+require 'mullet/default_nested_scope'
 
 module Mullet
 
@@ -20,8 +20,8 @@ module Mullet
     # @param [#<<] output
     #           where to write rendered output
     def initialize(data, missing_value_strategy, nil_value_strategy, output)
-      @model = data.is_a?(DefaultNestedModel) ?
-          data : DefaultNestedModel.new(data)
+      @scope = data.is_a?(DefaultNestedScope) ?
+          data : DefaultNestedScope.new(data)
       @on_missing = missing_value_strategy
       @on_nil = nil_value_strategy
       @output = output
@@ -43,7 +43,7 @@ module Mullet
     #           variable name
     # @return value
     def get_variable_value(name)
-      return @model.get_variable_value(name)
+      return @scope.get_variable_value(name)
     end
 
     # Adds a nested scope to search in subsequent lookups.
@@ -51,23 +51,23 @@ module Mullet
     # @param data
     #           data object
     def push_scope(data)
-      @model.push_scope(data)
+      @scope.push_scope(data)
     end
 
     # Removes innermost nested scope.
     def pop_scope()
-      @model.pop_scope()
+      @scope.pop_scope()
     end
 
-    # Gets model value that is intended for display in the rendered output.
+    # Gets scope value that is intended for display in the rendered output.
     # Applies configured strategies for handling missing and nil values.
     #
     # @param [Symbol] key
     #           variable name
     # @return value
     def get_display_value(key)
-      value = @model.get_variable_value(key)
-      if value == Model::NOT_FOUND
+      value = @scope.get_variable_value(key)
+      if value == Scope::NOT_FOUND
         value = @on_missing.call(key)
       end
       if value == nil

data/lib/mullet/{model.rb → scope.rb}

@@ -1,8 +1,8 @@
 module Mullet
 
-  # A model responds to the method `get_variable_value` taking a variable name
+  # A scope responds to the method `get_variable_value` taking a variable name
   # argument and returning the variable value.  
-  module Model
+  module Scope
 
     # special value indicating variable name was not found
     NOT_FOUND = Object.new()

data/lib/mullet/sinatra.rb

@@ -0,0 +1,100 @@
+require 'mullet/sinatra/engine'
+require 'sinatra/base'
+
+module Mullet
+ 
+  # Sinatra extension for rendering views with Mullet.
+  #
+  # Example:
+  #
+  #   require 'mullet/sinatra'
+  #
+  #   class App < Sinatra::Base
+  #     register Mullet::Sinatra
+  #
+  #     set :mullet, {
+  #       # path to folder containing template .html files.  If not set, then
+  #       # default is `settings.views`
+  #       template_path: "views"
+  #     }
+  #
+  #     get '/' do
+  #       mullet :index
+  #     end
+  #   end
+  #
+  # When `mullet :index` is called, the engine will attempt to load a Ruby view
+  # class named `Views::Index` from the `views/index.rb` file.  If the view
+  # class is not found, then the engine will render the template file
+  # `view/index.html` directly.
+  #
+  # By default, the rendered page will passed to a layout view named `:layout`.
+  # The rendered page content is passed to the layout template in the variable
+  # `content`.
+  module Sinatra
+    module Helpers
+      @@engine = Mullet::Sinatra::Engine.new()
+
+      def mullet(view_name, options={}, locals={})
+        # The options hash may contain a key :locals with the value being a 
+        # hash mapping variable names to values.
+        locals.merge!(options.delete(:locals) || {})
+
+        # Get application settings.
+        view_options = { root: settings.root, views: settings.views }
+
+        if settings.respond_to?(:mullet)
+          view_options = settings.mullet.merge(view_options)
+        end
+
+        view_options.merge!(options)
+
+        # Copy instance variables set by Sinatra application.
+        application_data = Object.new()
+        instance_variables.each do |name|
+          application_data.instance_variable_set(
+              name, instance_variable_get(name))
+        end
+
+        # Render view.
+        template = @@engine.get_template(view_name, view_options)
+        view_class = @@engine.get_view_class(view_name, view_options)
+        view = view_class.new()
+        view.set_model(application_data, locals)
+        output = ''
+        template.execute(view, output)
+
+        # Render layout.
+        layout_name = :layout
+        if options[:layout]
+          layout_name = options[:layout]
+        end
+
+        if layout_name != false
+          # If configured layout is true or nil, then use :layout.
+          if layout_name == true || !layout_name
+            layout_name = :layout
+          end
+
+          layout = @@engine.get_template(layout_name, view_options)
+          view_class = @@engine.get_view_class(layout_name, view_options)
+          view = view_class.new()
+          view.set_model(application_data, locals, { content: output })
+          layout_output = ''
+          layout.execute(view, layout_output)
+          output = layout_output
+        end
+        
+        return output
+      end
+    end
+
+    # Called when this extension is registered.
+    def self.registered(app)
+      app.helpers Mullet::Sinatra::Helpers
+    end
+
+  end
+end
+
+Sinatra.register Mullet::Sinatra

data/lib/mullet/sinatra/engine.rb

@@ -0,0 +1,102 @@
+require 'mullet'
+
+module Mullet; module Sinatra
+
+  # Loads view classes and template files.
+  class Engine
+
+    def initialize()
+      @class_cache = Hash.new()
+      @loader = Mullet::HTML::TemplateLoader.new(nil)
+    end
+
+    # Gets template.
+    #
+    # @param [Symbol] view_name
+    #           view name
+    # @param [Hash] options
+    #           options
+    # @return template
+    def get_template(view_name, options)
+      template_path = options[:template_path] || options[:views]
+      @loader.template_path = template_path
+      return @loader.load("#{view_name.to_s()}.html")
+    end
+
+    # Gets view class.
+    #
+    # @param [Symbol] view_name
+    #           view name
+    # @param [Hash] options
+    #           options
+    # @return view class
+    def get_view_class(view_name, options)
+      view_class = @class_cache.fetch(view_name, nil)
+      if view_class == nil
+        view_class = find_class(view_name.to_s(), options)
+        @class_cache.store(view_name, view_class)
+      end
+      return view_class
+    end
+
+    private
+
+    # Gets the named view class.
+    #
+    # @param [String] view_name
+    #           view name
+    # @param [Hash] options
+    #           options
+    # @return view class, or `View` if not found
+    def find_class(view_name, options)
+      relative_view_path = options[:views]
+      if relative_view_path.start_with?(options[:root])
+        relative_view_path = relative_view_path[options[:root].size()..-1]
+      end
+      relative_view_path.sub!(/^\//, '')
+
+      # Construct string in form sub_folder/user_list
+      relative_view_name = File.join(relative_view_path, view_name)
+
+      # Convert view name from the format sub_folder/user_list to the format
+      # SubFolder::UserList
+      class_name = relative_view_name.split('/').map do |namespace|
+        namespace.split(/[-_]/).map do |part|
+          part[0] = part[0].chr.upcase
+          part
+        end.join
+      end.join('::')
+
+      # Is the class already defined?
+      if const = const_get!(class_name)
+        return const
+      end
+
+      full_view_name = File.join(options[:views], view_name)
+      if File.exists?("#{full_view_name}.rb")
+        require full_view_name
+      else
+        return View
+      end
+      
+      if const = const_get!(class_name)
+        return const
+      end
+      return View
+    end
+
+    # Finds constant by fully qualified name.
+    #
+    # @param [String] name
+    #           fully qualified name to find
+    # @return constant, or `nil` if not found
+    def const_get!(name)
+      name.split('::').inject(Object) do |cur_class, part|
+        cur_class.const_get(part)
+      end
+    rescue NameError
+      nil
+    end
+  end
+
+end; end

data/lib/mullet/version.rb

@@ -1,3 +1,3 @@
 module Mullet
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/lib/mullet/view.rb

@@ -0,0 +1,29 @@
+require 'mullet/default_nested_scope'
+
+module Mullet
+
+  # Adapts model data for rendering in a template.  Applications will typically
+  # define subclasses with attributes that will be referenced by name from the
+  # templates.
+  class View
+
+    # Sets model to adapt.  Applications do not have to call this method
+    # directly.  The template engine will call this method implicitly.
+    #
+    # @param data_objects
+    #           scopes in outer to inner order
+    def set_model(*data_objects)
+      @model = DefaultNestedScope.new(*data_objects)
+    end
+
+    # Resolves variable name to value from the model.
+    # 
+    # @param [Symbol] name
+    #           variable name
+    # @return variable value
+    def fetch(name)
+      return @model.get_variable_value(name)
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mullet
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-30 00:00:00.000000000 Z
+date: 2012-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2152850480 !ruby/object:Gem::Requirement
+  requirement: &2152575380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.6.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152850480
+  version_requirements: *2152575380
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &2152848500 !ruby/object:Gem::Requirement
+  requirement: &2152574680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152848500
+  version_requirements: *2152574680
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &2152844660 !ruby/object:Gem::Requirement
+  requirement: &2152574020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.17.2
   type: :development
   prerelease: false
-  version_requirements: *2152844660
+  version_requirements: *2152574020
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2152842280 !ruby/object:Gem::Requirement
+  requirement: &2152573060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,19 +54,20 @@ dependencies:
         version: 0.7.3
   type: :development
   prerelease: false
-  version_requirements: *2152842280
+  version_requirements: *2152573060
 description: ! "It's like Mustache but the variables are in HTML attributes.\n\n  *
   Extremely simple variable syntax is incapable of expressing logic in the\n    templates.\n
-  \ * Templates are clean HTML.  Your HTML authoring tool and browser will\n    correctly
-  display the templates while you prototype your user interface.\n"
+  \ * Templates are clean HTML which your HTML authoring tool and browser can\n    display
+  correctly.  You can use the templates as a static HTML prototype\n    for your user
+  interface.\n"
 email: pukkaone@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/mullet/container.rb
-- lib/mullet/default_model.rb
-- lib/mullet/default_nested_model.rb
+- lib/mullet/default_nested_scope.rb
+- lib/mullet/default_scope.rb
 - lib/mullet/html/attribute_command.rb
 - lib/mullet/html/attributes.rb
 - lib/mullet/html/command.rb
@@ -79,7 +80,6 @@ files:
 - lib/mullet/html/layout.rb
 - lib/mullet/html/message.rb
 - lib/mullet/html/message_attribute_command.rb
-- lib/mullet/html/model_attribute_command.rb
 - lib/mullet/html/page_builder.rb
 - lib/mullet/html/parser/attribute.rb
 - lib/mullet/html/parser/constants.rb
@@ -89,17 +89,20 @@ files:
 - lib/mullet/html/parser/simple_parser.rb
 - lib/mullet/html/parser/tokenizer.rb
 - lib/mullet/html/remove_mode.rb
+- lib/mullet/html/scope_attribute_command.rb
 - lib/mullet/html/static_text_renderer.rb
 - lib/mullet/html/template.rb
 - lib/mullet/html/template_builder.rb
 - lib/mullet/html/template_loader.rb
 - lib/mullet/html/template_parser.rb
 - lib/mullet/html/unless_element_renderer.rb
-- lib/mullet/model.rb
 - lib/mullet/render_context.rb
+- lib/mullet/scope.rb
+- lib/mullet/sinatra/engine.rb
+- lib/mullet/sinatra.rb
 - lib/mullet/template_error.rb
-- lib/mullet/tilt.rb
 - lib/mullet/version.rb
+- lib/mullet/view.rb
 - lib/mullet.rb
 homepage: http://pukkaone.github.com/mullet/
 licenses: []

data/lib/mullet/tilt.rb

@@ -1,37 +0,0 @@
-require 'mullet'
-require 'tilt'
-
-# Registers the Mullet template engine in Tilt to handle file names with the
-# `html` extension.
-module Mullet; module Tilt
-
-  class MulletTemplate < ::Tilt::Template
-
-    def initialize_engine
-      @@loader = Mullet::HTML::TemplateLoader.new(nil)
-      @@parser = Mullet::HTML::TemplateParser.new(@@loader)
-    end
-
-    def prepare
-      if file
-        @@loader.template_path = File.dirname(file)
-      end
-
-      @template = @@parser.parse(data)
-    end
-
-    def evaluate(scope, locals, &block)
-      if block
-        content = block.call()
-        locals = locals.merge(content: content)
-      end
-
-      output = ''
-      @template.execute(DefaultNestedModel.new(scope, locals), output)
-      return output
-    end
-
-    ::Tilt.register self, :html
-  end
-
-end; end