fifty 0.0.1

data/README.md

@@ -0,0 +1,186 @@
+## Fifty
+
+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:
+
+  - HAML as a markup language for the static part of your templates.
+  - Handlebars to render dynamic fields on the server or in the browser.
+  - Javascript to write helpers that run both client- and server-side.
+
+## Is it ready?
+
+No. The proof of concept is there for you to see, but I need to work on this some more before I release it as a gem.
+
+## What does it do?
+
+Hopefully this is self-explanatory:
+
+### 1. Start with some model data
+
+```ruby
+$data = {
+  posts: [
+    { title: 'Hello, world!',
+      text: 'This is fu-man-chu!',
+      likes: 2,
+      comments: [
+        { user: 'Louis',
+          text: 'Cool!' },
+        { user: 'Justin',
+          text: 'What do you think?'  }
+    ] },
+    { title: 'This is a post!',
+      text: 'With lots of love.',
+      likes: 1,
+      comments: [
+        { user: 'Chris',
+          text: 'Nice!' }
+    ] }
+  ]
+}
+```
+
+### 2. Include Fifty in our app.
+
+```ruby
+require 'sinatra'
+require 'fifty'
+
+class MyApp < Sinatra::Base
+
+  helpers Fifty
+  
+  # Share a copy of the data to the client.
+  # Made available as `window.client`
+  shared_data :client_data, $data.to_json
+  
+  get '/posts?.format?' do |format|
+    if format == 'json'
+      $data.to_json
+    elsif format == 'html'
+      fifty :posts, $data
+    end
+  end
+
+end
+
+MyApp.run!
+
+```
+
+### 3. Define your views
+
+
+```haml
+@@ layout
+
+%html
+  %head
+    %script{src: fifty_cdn(:handlebars)}
+    %script{src: fifty_cdn(:jquery)}
+
+    = fifty_partials
+    = fifty_scripts
+
+  %body
+    #posts
+      = yield
+
+  :javascript
+
+    // Reload from route /posts.json
+    $('#reload').click(function () {
+      $('#posts').getAndReplace('posts');
+    });
+    
+    // Submit form and add post to feed.
+    $('#form').submit(function (event) {
+      event.preventDefault();
+      var data = $(this).serialize;
+      $('#posts').postAndAppend('post', data);
+    });
+    
+    // Delete post and remove from feed.
+    $('.delete').click(function (e) {
+      $(this).postAndRemove('post/delete', {
+        id: $(this).closest('.post')
+      });
+    });
+
+@@ posts
+
+.container
+  .row
+    {{#each posts}}
+    {{> post}}
+    {{/each}}
+  
+  %button#reload Reload
+
+@@ post
+
+.post{id: "{{id}}"}
+  %h3 {{title}}
+  %p {{text}}
+  %p
+    {{likes}}
+    {{t "like"}}
+  %hr
+  %p
+    {{#each comments}}
+    {{> comment}}
+    {{/each}}
+
+  %a.delete{href: '#'} Delete
+  
+@@ comment
+
+.comment{id: "{{id}}"}
+  %b {{user}}:
+  %span {{text}}
+  
+@@ form
+
+%form{method: 'post'}
+  Name:
+  %input#name{type: 'text'}
+  Message:
+  %textarea#message
+
+```
+
+## Configuration Options
+
+You can put these anywhere before you run your routes. For a Sinatra app, the canonical path is `config/fifty.rb`.
+
+**Paths to Views and Locales**
+
+Set the path(s) to your views (shown is the default):
+
+```ruby
+Fifty.views = ['./views/**/*.haml']
+```
+
+If using locales with `I18n`, set the path to your files:
+
+```ruby
+Fifty.locales = ['./config/locales/*.yml']
+```
+
+**Shared Helpers and JSON data**
+
+```ruby
+# Share a copy of the data to the client.
+#
+# Made available as `window.client`
+
+js_data :client_data, $data.to_json
+
+# Define a shared helper function.
+#
+# Can be invoked within a HBS
+# template in Ruby or Javascript.
+
+hbs_helper :add, %t{
+  function (a, b) { return a + b; }
+}
+```

data/lib/fifty/helpers.rb

@@ -0,0 +1,92 @@
+module Fifty::Helpers
+  
+  module Locales
+    
+    require 'i18n'
+    require 'yaml'
+    require 'json'
+    
+    Fifty.helper :t, "function(element) { return locales[locale][element]; }"
+    
+    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

data/lib/fifty.rb

@@ -0,0 +1,198 @@
+module Fifty
+
+  require 'handlebars'
+  require 'haml'
+  require 'binding_of_caller'
+  
+  VERSION = '0.0.1'
+  
+  class << self
+    attr_accessor :views
+    attr_accessor :compiled
+  end
+  
+  self.views = ['./views/**/*.haml']
+  self.compiled = false
+  
+  def self.cdn(name)
+   if name == :handlebars
+     'https://cdnjs.cloudflare.com/ajax/libs/'  +
+     'handlebars.js/1.0.0-rc.3/handlebars.min.js'
+    elsif name == :jquery
+      'https://cdnjs.cloudflare.com/' +
+      'ajax/libs/jquery/1.9.1/jquery.min.js'
+    end
+  end
+
+  @@handlebars = Handlebars::Context.new
+  @@helpers, @@shared, @@partials = {}, {}, {}
+  @@view_paths = []
+  
+  def self.helper(name, fn)
+    code = self.register_helper(name, fn)
+    @@helpers[name] = code
+    self.eval_js(code)
+  end
+
+  def self.shared(name, code)
+    code = "var #{name} = #{code};\n"
+    @@shared[name] = code
+    self.eval_js(code)
+  end
+  
+  def self.compile
+    self.compile_statics
+    self.compile_inlines
+    self.compiled = true
+  end
+
+  def self.compile_statics
+    views = self.views.map { |p| Dir[p] }.flatten
+    context = binding.of_caller(3)
+    views.each do |file|
+      path = File.dirname(file)
+      unless @@view_paths.include?(path)
+        @@view_paths << path
+      end
+      template = File.read(file)
+      name = '_' + File.basename(file, '.haml')
+      next if name == '_layout'
+      partial = Haml::Engine.
+        new(template).render(
+        context, layout: false)
+      partial = self.escape_hbs(partial)
+      @@partials[name] = partial
+    end
+  end
+
+  def self.compile_inlines
+    inlines = Sinatra::Application.templates
+    context = binding.of_caller(3)
+    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
+    end
+  end
+  
+  def self.register_helper(name, fn)
+    "Handlebars.registerHelper('#{name}', #{fn});"
+  end
+
+  def self.eval_js(code)
+    @@handlebars.instance_eval do
+      @js.runtime.eval(code)
+    end
+  end
+  
+  def self.escape_hbs(partial)
+    2.times do
+      partial.gsub!("{{", "{%{")
+      partial.gsub!("}}", "}%}")
+    end
+    partial
+  end
+  
+  def self.included(base)
+    base.class_eval {
+    Fifty::Helpers::Locales.compile  }
+  end
+
+  def fifty(view, data)
+    Fifty.compile unless Fifty.compiled
+    hbs2html(haml2hbs(view), data)
+  end
+
+  alias :fu :fifty
+
+  def self.partials
+    partials_hbs = ''
+    @@partials.each do |name, code|
+      partials_hbs += script_tag(name,
+        code, 'x-text-handlebars')
+    end
+    partials_js = ''
+    @@partials.each do |name, code|
+      partials_js += register_partial(name) + "\n"
+    end
+    partials_js = script_tag('partials', partials_js)
+    [partials_hbs, partials_js].join
+  end
+
+  def self.scripts
+    scripts_js = ''
+    @@helpers.each do |name, code|
+      scripts_js += code + "\n"
+    end
+    scripts_js = script_tag('helpers', scripts_js)
+    shared_js = "\n"
+    @@shared.each do |name, code|
+      shared_js += code + "\n"
+    end
+    shared_js = script_tag('shared', shared_js)
+    [scripts_js, shared_js].join
+  end
+
+  require_relative 'fifty/helpers'
+
+  private
+
+  def haml2hbs(name)
+    context = binding.of_caller(4)
+    result = render_haml(name, context, layout: false)
+    while data = result.match(/{{> ([^}]*)}}/)  
+      partial = render_haml($1, context, layout: false)
+      result = result.gsub(data[0], partial)
+    end
+    render_layout(context, result)
+  end
+  
+  def render_layout(context, insert)
+    render_haml(:layout, context) do
+      insert
+    end
+  end
+
+  def get_template(name)
+    inlines = Sinatra::Application.templates
+    if path = find_haml_template(name)
+      File.read(path)
+    elsif partial = inlines[name.intern]
+      partial.first
+    else
+      raise "No template for #{name}."
+    end
+  end
+  
+  def find_haml_template(name)
+    @@view_paths.each do |path|
+      file = File.join(path, name.to_s + '.haml')
+      return file if File.readable?(file)
+    end
+    nil
+  end
+
+  def render_haml(name, context = nil, options = {}, &block)
+    Haml::Engine.new(get_template(name), options).render(context, &block)
+  end
+  
+  def hbs2html(html, data)
+    unescape_hbs(@@handlebars.compile(html).call(data))
+  end
+
+  def unescape_hbs(html)
+    html.gsub("{%{", "{{").gsub("}%}", "}}")
+  end
+
+  def self.script_tag(id, code, type = 'text/javascript')
+    "\n<script id='#{id}' type='#{type}'>#{code}</script>\n"
+  end
+
+  def self.register_partial(name)
+    "Handlebars.registerPartial('#{name[1..-1]}'," +
+    " document.getElementById('#{name}').innerText);"
+  end
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: fifty
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Louis Mullie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: handlebars
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: binding_of_caller
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- louis.mullie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/fifty/helpers.rb
+- lib/fifty.rb
+homepage: https://github.com/louismullie/fifty
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []