fifty 0.0.3 → 0.0.5

data/README.md

@@ -1,4 +1,4 @@
-## Fifty
+![Logo](https://raw.github.com/louismullie/fifty/master/logo.png)
 
 Have you ever written the same template or helper twice? Do you have trouble sleeping at night because of code duplication? Then Fifty may right for you. It allows you to save keystrokes by leveraging:
 
@@ -183,4 +183,4 @@ js_data :client_data, $data.to_json
 hbs_helper :add, %t{
   function (a, b) { return a + b; }
 }
-```
+```

data/lib/fifty/helpers/locales.rb

@@ -0,0 +1,36 @@
+module Fifty::Helpers::Locales
+
+  require 'i18n'
+  require 'yaml'
+
+  Fifty.class_eval do
+    class << self
+      attr_accessor :locales
+    end
+    self.locales = ['./config/locales/*.yml']
+  end
+
+  def self.compile
+    locales = Fifty.locales.map { |p| Dir[p] }.flatten
+    hash = {}
+    locales.each do |file|
+      name = File.basename(file, '.yml')
+      yaml = YAML.load(File.read(file))
+      hash.merge!(yaml)
+    end
+
+    Fifty.helper :t, "function(path) {
+      var current = locales[locale];
+      var elements = path.split('.');
+      while (elements.length > 0 ) {
+        current = current[elements.shift()];
+      }
+      return current;
+    }"
+
+    Fifty.shared :locale, "'#{I18n.locale.to_s}'"
+    Fifty.shared :locales, hash.to_json
+
+  end
+
+end

data/lib/fifty/helpers.rb

@@ -1,99 +1,8 @@
 module Fifty::Helpers
-  
-  module Locales
-    
-    require 'i18n'
-    require 'yaml'
-    require 'json'
-    
-    Fifty.helper :t, "function(path) {
-      var current = locales[locale];
-      var elements = path.split('.');
-      while (elements.length > 0 ) {
-        current = current[elements.shift()];
-      }
-      return current;
-    }"
-    
-    Fifty.class_eval do
-      class << self
-        attr_accessor :locales
-      end
-      self.locales = ['./config/locales/*.yml']
-    end
-    
-    def self.compile
-      locales = Fifty.locales.map { |p| Dir[p] }.flatten
-      hash = {}
-      locales.each do |file|
-        name = File.basename(file, '.yml')
-        yaml = YAML.load(File.read(file))
-        hash.merge!(yaml)
-      end
-      Fifty.shared :locale, "'#{I18n.locale.to_s}'"
-      Fifty.shared :locales, hash.to_json
-    end
-    
-  end
-  
-  module Render
-    
-    Fifty.shared :Fifty, "{
-    
-      render: function(template, data) {
-        var hbs  = $('#_' + template).html();
-        var tmpl = Handlebars.compile(hbs);
-        return tmpl(data);
-      },
-      
-      getAndRender: function(name, params) {
-        $.getJSON('/' + name + '.json',
-          function (data) {
-            Fifty.render(name, data);
-        }, $.param(params));
-      },
-      
-      postAndRender: function(name, params) {
-        $.post('/' + name + '.json', $.param(params),
-          function (data) {
-            Fifty.render(name, data);
-        });
-      },
-      
-      replace: function(id, name, data) {
-        $(id).html(Fifty.render(name, data));
-      },
-      
-      getAndReplace: function(id, name, params) {
-       $(id).html(Fifty.getAndRender(name, params)); 
-      },
-      
-      postAndReplace: function(id, name, params) {
-        $(id).html(Fifty.postAndRender(name, params));
-      },
-      
-      append: function(id, name, data) {
-        $(id).append(Fifty.render(name, data));
-      },
-      
-      getAndAppend: function(id, name, params) {
-       $(id).append(Fifty.getAndRender(name, params)); 
-      },
-      
-      postAndAppend: function(id, name, params) {
-        $(id).append(Fifty.postAndRender(name, params));
-      },
-      
-      postAndRemove: function(id, name, params) {
-        $.post('/' + name + '.json', $.param(param),
-          function () {
-            $(id).remove();
-        });
-      }
-
-    }"
-    
-  end
 
-
-end
+  path = File.expand_path(__FILE__)
+  base = File.dirname(path)
+  dir = File.join(base, 'helpers', '*')
+  Dir[dir].each { |file| require file }
+  
+end

data/lib/fifty.rb

@@ -1,207 +1,274 @@
 module Fifty
 
+  # Require dependencies.
   require 'handlebars'
   require 'haml'
+  require 'json'
 
-  VERSION = '0.0.3'
+  # Version of the gem.
+  VERSION = '0.0.5'
+
+  # Class-level variables.
 
   class << self
+    # Glob-style paths to templates.
     attr_accessor :views
+    # Hash of compiled helpers.
+    attr_accessor :helpers
+    # Hash of compiled shared data.
+    attr_accessor :shareds
+    # Hash of compiled partials
+    attr_accessor :partials
+    # Boolean - have we compiled?
     attr_accessor :compiled
+    # Context of the calling script.
     attr_accessor :context
+    # Logger for debug info.
+    attr_accessor :logger
+    # Handlebars runtime.
+    attr_accessor :hbs
   end
 
+  # Default values for class variables.
   self.views = ['./views/**/*.haml']
-  self.compiled = false
 
-  @@handlebars = Handlebars::Context.new
+  self.helpers = {}
+  self.shareds = {}
+  self.partials = {}
 
-  @@handlebars.partial_missing do |a|
-    Fifty.hbs2html(Fifty.render_haml(a, context), @@current)
-  end
+  self.compiled = false
+  self.logger = $stdout
 
-  @@helpers, @@shared, @@partials = {}, {}, {}
-  @@view_paths = []
+  # Initialize the Handlebars runtime.
+  self.hbs = Handlebars::Context.new
 
-  def self.helper(name, fn)
-    code = self.register_helper(name, fn)
-    @@helpers[name] = code
-    self.eval_js(code)
+  # Handle missing Handlebars partials.
+  # We don't register partials server-side.
+  self.hbs.partial_missing do |name|
+    hbs = Fifty.render_haml(name)
+    Fifty.hbs2html(hbs, @@current)
   end
 
-  def self.shared(name, code)
-    code = "var #{name} = #{code};\n"
-    @@shared[name] = code
-    self.eval_js(code)
+  # Register a Handlebars helper with
+  # a name and a Javascript function.
+  def self.helper(name, helper)
+    code = helper_registerer(name, helper)
+    helpers[name] = eval_js(code)
   end
 
-  def self.compile
-    self.compile_statics
-    self.compile_inlines
-    self.compiled = true
+  # Make a piece of Ruby data available
+  # to the client as a JSON object.
+  def self.shared(name, data)
+    code = "var #{name} = #{data};\n"
+    shareds[name] = eval_js(code)
   end
 
-  def self.compile_statics
-    views = self.views.map { |p| Dir[p] }.flatten
-    context = binding.of_caller(3)
-    views.each do |file|
-
-      puts "Trying to register #{file}"
-      next if file.index('layout')
-      path = File.dirname(file)
-
-      name = '_' + file.gsub('./', '')
-      .gsub('.haml', '')
-      .split('/')[1..-1].join('-')
-
-      unless @@view_paths.include?(path)
-        puts path.inspect
-        @@view_paths << path
-      end
-      template = File.read(file)
-
-      partial = Haml::Engine.
-      new(template).render(context, layout: false)
-      partial = self.escape_hbs(partial)
-      @@partials[name] = partial
-      puts "Registered #{name}"
-
+  # Output the helpers, the partials,
+  # and the data inside script tags.
+  def self.headers
+    scripts = ['helpers', 'partials', 'shareds']
+    headers = ''
+    scripts.each do |type|
+      headers += header(type)
     end
+    headers
   end
-
-  def self.compile_inlines
-    inlines = Sinatra::Application.templates
-    inlines.each do |name, info|
-      next if name == :layout
-      partial = Haml::Engine.
-      new(info[0].strip).render(context)
-      partial = self.escape_hbs(partial)
-      @@partials[name] = partial
+  
+  # Generate a header of a given type.
+  def self.header(type)
+    code, list = '', self.send(type)
+    list.each do |name, code|
+      code += code + "\n"
     end
+    script_tag(type, code)
   end
-
-  def self.register_helper(name, fn)
-    "Handlebars.registerHelper('#{name}', #{fn});"
+  
+  # Main API for rendering templates with Fifty.
+  def fifty(view, data, globals = {})
+    Fifty.compile unless Fifty.compiled
+    Fifty.hbs2html(Fifty.haml2hbs(view, globals), data)
   end
 
-  def self.eval_js(code)
-    @@handlebars.instance_eval do
-      @js.runtime.eval(code)
-    end
-  end
+  # Alias for Fifty.
+  alias :fy :fifty
 
-  def self.escape_hbs(partial)
-    2.times do
-      partial.gsub!("{{", "{%{")
-      partial.gsub!("}}", "}%}")
-    end
-    partial
+  # Compile static and inline HAML
+  # templates to HTML/HBS templates.
+  def self.compile
+    compile_template_files
+    compile_inline_templates
+    self.compiled = true
   end
 
-  def self.included(base)
-    base.class_eval {
-    Fifty::Helpers::Locales.compile  }
+  # Return a list of the template files,
+  # as defined in the list of view paths,
+  # excluding the templates containing
+  # the word "layout" (which are assumed
+  # to be static and part of the page
+  # that is always rendered server-side).
+  def self.get_template_files
+    views.map { |p| Dir[p] }.flatten
+    .select { |x| x.index('layout').nil? }
   end
 
-  def fifty(view, data, globals = {})
-    Fifty.compile unless Fifty.compiled
-    Fifty.hbs2html(Fifty.haml2hbs(view, globals), data)
+  # Iterate over all template files
+  # and compile each one to HBS.
+  def self.compile_template_files
+    get_template_files.each do |file|
+      compile_template_file(file)
+    end
   end
 
-  alias :fu :fifty
-  
-  def self.core_js
-    
-    core_js = ''
-    @@helpers.each do |name, code|
-      core_js += code + "\n"
-    end
-    script_tag('helpers', core_js)
-    
+  # Compile a single HAML template
+  # file to HTML with HBS.
+  def self.compile_template_file(file)
+    contents = File.read(file)
+    partial = render_raw_haml(contents)
+    name = path_to_name(file)
+    template = escape_hbs(partial)
+    reg = partial_registerer(name, template)
+    partials[name] = reg
+  rescue
+    debug "Couldn't compile #{file}"
+    raise
+  else
+    debug "Compiled #{file}"
   end
 
-  def self.partials_js
-    partials_js = ''
-    @@partials.each do |name, code|
-      partials_js += register_partial(name, code) + "\n"
-    end
-    script_tag('partials', partials_js)
+  # Get the inline templates defined
+  # in Sinatra::Application, excluding
+  # templates containing the word "layout".
+  def self.get_inline_templates
+    Sinatra::Application.templates
+    .map { |p| Dir[p] }.flatten
+    .reject { |x| x.to_s.index('layout') }
   end
 
-  def self.shared_js
-    
-    shared_js = "\n"
-    @@shared.each do |name, code|
-      shared_js += code + "\n"
+  # Iterate over inline templates and compile them.
+  def self.compile_inline_templates
+    get_inline_templates.each do |name, info|
+      compile_inline_template(name, info)
     end
-    script_tag('shared', shared_js)
-    
   end
 
-  def self.helpers
-    [core_js, partials_js, shared_js].join
+  # Compile a single inline template into HTML/HBS.
+  def self.compile_inline_template(name, info)
+    partial = render_raw_haml(info[0].strip)
+    partials[name] = escape_hbs(partial)
+  rescue
+    debug "Couldn't compile inline #{name}"
+    raise
+  else
+    debug "Compiled inline #{name}"
   end
 
-  require_relative 'fifty/helpers'
-
-  private
-
+  # Render a HAML template into HTML/HBS.
   def self.haml2hbs(name, options = {})
-    puts "Rendering #{name} from HAML to HBS"
-    result = render_haml(name, context, layout: false)
+    result = render_haml(name, layout: false)
     while data = result.match(/{{> ([^}]*)}}/)
-      partial = render_haml($1, context, layout: false)
+      partial = render_haml($1, layout: false)
       result = result.gsub(data[0], partial)
     end
     render_layout(context, result, options)
+  rescue
+    debug "Couldn't render template #{name}"
+    raise
   end
 
+  # If the :layout option is set to true,
+  # render the supplied template inside the layout.
   def self.render_layout(context, insert, options)
-    !options[:layout] ? insert :
-    render_haml(:layout, context) { insert }
+    return insert unless options[:layout]
+    layout = if options[:layout].is_a?(Symbol)
+      options[:layout]
+    else
+      options[:layout] ? true : false
+    end
+    render_haml(layout, options) { insert }
   end
 
+  # Find a template and get its contents.
   def self.get_template(name)
     inlines = Sinatra::Application.templates
-    if path = find_haml_template(name)
+    if path = find_template_file(name)
       File.read(path)
     elsif partial = inlines[name.intern]
       partial.first
     else
-      raise "No template for #{name}."
+      raise "Couldn't find template for #{name}."
     end
   end
 
-  def self.find_haml_template(name)
-    file = './views/' + name.to_s.gsub('-', '/') + '.haml'
+  # Find a template file given it's name.
+  def self.find_template_file(name)
+    name = name.to_s.gsub('-', '/')
+    file = File.join('views', name) + '.haml'
     return file if File.readable?(file)
   end
 
-  def self.render_haml(name, context = nil, options = {}, &block)
-    puts "Rendering HAML template #{name}"
-    Haml::Engine.new(get_template(name),
-    options).render(context, &block)
+  # Get the contents of a HAML template by name and
+  # render the template to HTML with nested HBS.
+  def self.render_haml(name, options = {}, &block)
+    args = [get_template(name), options]
+    Haml::Engine.new(*args).render(context, &block)
+  rescue
+    debug "Couldn't render template #{name}"
+    raise
   end
 
+  # Render actual HAML content.
+  def self.render_raw_haml(haml)
+    args = [ context, layout: false ]
+    Haml::Engine.new(haml).render(*args)
+  end
+
+  # Convert a file path to a template name.
+  def self.path_to_name(path)
+    trimmed = path.gsub('./', '').gsub('.haml', '')
+    '_' + trimmed.split('/')[1..-1].join('-')
+  end
+
+  # Render HBS to HTML.
   def self.hbs2html(html, data)
-    @@current = data
-    puts "-> with partials #{data}"
-    unescape_hbs(@@handlebars.compile(html).call(data))
+    unescape_hbs(hbs.compile(html).call(@@current = data))
   end
 
-  def self.unescape_hbs(html)
-    html.gsub("{%{", "{{").gsub("}%}", "}}")
+  # Output a debug text to the logger.
+  def self.debug(text)
+    logger.puts "[Fifty]: #{text}"
+  end
+
+  # * Javascript-generating methods * #
+
+  # Evaluate Javascript code within
+  # the context of the JS runtime
+  # and return the code as plaintext.
+  def self.eval_js(code)
+    hbs.instance_eval do
+      @js.runtime.eval(code)
+    end
+    code
   end
 
+  # Generates a Javascript script tag with inline code.
   def self.script_tag(id, code, type = 'text/javascript')
     "\n<script id='#{id}' type='#{type}'>#{code}</script>\n"
   end
 
-  def self.register_partial(name, code)
+  # Generates JS code to register a Handlebars helper.
+  def self.helper_registerer(name, fn)
+    "Handlebars.registerHelper('#{name}', #{fn});"
+  end
+
+  # Generates JS code to register a Handlebars partial.
+  def self.partial_registerer(name, code)
     "Handlebars.registerPartial('#{name[1..-1]}', " +
     "'#{escape_javascript(code)}');"
   end
 
+  # * Helpers for escaping JS/HBS * #
+
+  # Helper map for JS escaping.
   JS_ESCAPE_MAP = {
     '\\'    => '\\\\',
     '</'    => '<\/',
@@ -212,9 +279,37 @@ module Fifty
     "'"     => "\\'"
   }
 
+  # Escape text for inclusion into a quoted JS string.
   def self.escape_javascript(javascript)
     regexp = /(\\|<\/|\r\n|\342\200\250|[\n\r"'])/u
     javascript.gsub(regexp) {|match| JS_ESCAPE_MAP[match] }
   end
 
+  # Escape double and triple-mustaches.
+  def self.escape_hbs(partial)
+    2.times do
+      partial.gsub!("{{", "{%{")
+      partial.gsub!("}}", "}%}")
+    end
+    partial
+  end
+
+  # Unescape double and triple-mustaches.
+  def self.unescape_hbs(html)
+    html.gsub("{%{", "{{").gsub("}%}", "}}")
+  end
+
+  # * Helper-related methods * #
+
+  # When Fifty is included into an application,
+  # compile each of the helpers.
+  def self.included(base)
+    helpers =  Fifty::Helpers.constants
+    .map { |c| Fifty::Helpers.const_get(c) }
+    helpers.each { |h| h.compile }
+  end
+
+  # Require all helpers into Fifty.
+  require_relative 'fifty/helpers'
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fifty
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-18 00:00:00.000000000 Z
+date: 2013-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -83,6 +83,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/fifty/helpers/locales.rb
 - lib/fifty/helpers.rb
 - lib/fifty.rb
 homepage: https://github.com/louismullie/fifty