cuba-haml 1.0

data/README.md

@@ -0,0 +1,74 @@
+cuba-haml
+=========
+
+A Cuba plugin to use Haml
+
+Configure
+---------
+
+__Cuba::Haml__ plugin introduces some __keys__ into _Cuba.settings_ to make easy the way to reander layouts
+
+``` ruby
+  # Default layouts directory
+  app.settings[:haml][:layout_path] ||= app.settings[:haml][:views]
+  
+  # Default layout file
+  app.settings[:haml][:layout] ||= "layout"
+```
+
+Feel free to overwrite this variables after install the plugin. Following this example
+``` ruby
+require "cuba/haml"
+
+Cuba.plugin Cuba::Haml
+Cuba.settings[:haml][:layout_path] = "some/other/path"
+Cuba.settings[:haml][:layout] = "not_default_layout"
+```
+
+
+Rendering
+---------
+
+Cuba ships with a plugin that provides helpers for rendering templates.
+But if only want to use haml, you can specify this plugin.
+
+``` ruby
+require "cuba/haml"
+
+Cuba.plugin Cuba::Haml
+
+Cuba.define do
+  on default do
+
+    # Within the partial, you will have access to the local variable `content`,
+    # that will hold the value "hello, world".
+    res.write render("home.haml", content: "hello, world")
+  end
+end
+```
+
+Using the method __render__, you need to provide _full path template_ so there are two methods to do it easy
+`template_path(template_name)` and `layout_path(layout).`
+
+
+But you can use the __haml__ helper to get a cleaner code
+``` ruby
+...
+  on default do
+    haml("home", content: "hello, world")
+  end
+...
+```
+
+Also if you want to override the _default layout_ you can use the __view__ helper
+``` ruby
+...
+  on default do
+    view("home", 'other-layout', content: "hello, world")
+  end
+...
+```
+
+Don't be afraid and read the tests, there are really simple I promisse!
+
+> Note that in order to use this plugin you need to have [Haml](https://github.com/haml/haml) installed.

data/Rakefile

@@ -0,0 +1,7 @@
+task :test do
+  require "cutest"
+
+  Cutest.run(Dir["test/*.rb"])
+end
+
+task :default => :test

data/cuba-haml.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |s|
+  s.name              = "cuba-haml"
+  s.version           = "1.0"
+  s.summary           = "A Cuba plugin to use Haml."
+  s.description       = "Cuba is a microframework for web applications."
+  s.authors           = ["Emiliano Mancuso"]
+  s.email             = ["emiliano.mancuso@gmail.com"]
+  s.homepage          = "http://github.com/eMancu/cuba-haml"
+  s.license           = "UNLICENSE"
+
+  s.files = Dir[
+    "README.md",
+    "Rakefile",
+    "lib/**/*.rb",
+    "*.gemspec",
+    "test/*.*"
+  ]
+
+  s.add_dependency "cuba"
+  s.add_dependency "haml"
+  s.add_development_dependency "cutest"
+  s.add_development_dependency "rack-test"
+end

data/lib/cuba/haml.rb

@@ -0,0 +1,69 @@
+require 'haml'
+
+class Cuba
+  module Haml
+    def self.setup(app)
+      app.settings[:haml] ||= {}
+      app.settings[:haml][:views] ||= File.expand_path("views", Dir.pwd)
+      app.settings[:haml][:layout_path] ||= app.settings[:haml][:views]
+      app.settings[:haml][:layout] ||= "layout"
+      app.settings[:haml][:options] ||= {
+        default_encoding: Encoding.default_external
+      }
+    end
+
+    # Use default layout
+    def haml(template, locals = {})
+      res.write render(layout_path,
+                { content: partial(template, locals) }.merge(locals),
+                settings[:haml][:options])
+    end
+
+    # Use specific layout file nested into :layout_path
+    def view(template, layout_file, locals = {})
+      res.write render(layout_path(layout_file),
+                        { content: partial(template, locals) }.merge(locals))
+    end
+
+    # Skip layout, only renders the template
+    def partial(template, locals = {})
+      render(template_path(template), locals, settings[:haml][:options])
+    end
+
+    def template_path(template)
+      "%s/%s.haml" % [
+        settings[:haml][:views],
+        template
+      ]
+    end
+
+    def layout_path(layout = settings[:haml][:layout])
+      "%s/%s.haml" % [
+        settings[:haml][:layout_path],
+        layout
+      ]
+    end
+
+    # Render any type of template file supported by Tilt.
+    #
+    # @example
+    #
+    #   # Renders home, and is assumed to be HAML.
+    #   render("home")
+    #
+    #   # Renders with some local variables
+    #   render("home", site_name: "My Site")
+    #
+    #   # Renders with HAML options
+    #   render("home", {}, ugly: true, format: :html5)
+    #
+    #   # Renders in layout
+    #   render("layout.haml") { render("home.haml") }
+    #
+    def render(template, locals = {}, options = {}, &block)
+      template = File.read(template)
+      ::Haml::Engine.new(template, options.merge(outvar: '@_output'))
+                    .render(self, locals, &block)
+    end
+  end
+end

data/test/haml.rb

@@ -0,0 +1,94 @@
+require_relative "helper"
+
+require "cuba/haml"
+
+test "doesn't override the settings if they already exist" do
+  Cuba.settings[:haml] = {
+    :views => "./test/views",
+    :layout => "guest"
+  }
+
+  Cuba.plugin Cuba::Haml
+
+  assert_equal "./test/views", Cuba.settings[:haml][:views]
+  assert_equal "guest", Cuba.settings[:haml][:layout]
+end
+
+scope do
+  setup do
+    Cuba.plugin Cuba::Haml
+    Cuba.settings[:haml][:views] = "./test/views"
+    Cuba.settings[:haml][:template_engine] = "haml"
+
+    Cuba.define do
+      on "home" do
+        haml("home", name: "Agent Smith", title: "Home")
+      end
+
+      on "home2" do
+        view("home", 'layout2', name: "Agent Smith", title: "Home")
+      end
+
+      on "home3" do
+        res.write render(layout_path('layout-yield')) {
+          render(template_path("home"), name: "Agent Smith", title: "Home")
+        }
+      end
+
+      on "about" do
+        res.write partial("about", title: "About Cuba")
+      end
+    end
+  end
+
+  test "partial" do
+    _, _, body = Cuba.call({ "PATH_INFO" => "/about", "SCRIPT_NAME" => "/" })
+
+    assert_response body, ["<h1>About Cuba</h1>\n"]
+  end
+
+  test "haml" do
+    _, _, body = Cuba.call({ "PATH_INFO" => "/home", "SCRIPT_NAME" => "/" })
+
+    assert_response body, ["<title>Cuba: Home</title>\n<h1>Home</h1>\n<p>Hello Agent Smith</p>\n"]
+  end
+
+  test "view" do
+    _, _, body = Cuba.call({ "PATH_INFO" => "/home2", "SCRIPT_NAME" => "/" })
+
+    assert_response body, ["Header\n<h1>Home</h1>\n<p>Hello Agent Smith</p>\nFooter\n"]
+  end
+
+  test "render with blocks" do
+    _, _, body = Cuba.call({ "PATH_INFO" => "/home3", "SCRIPT_NAME" => "/" })
+
+    assert_response body, ["Header\n<h1>Home</h1>\n<p>Hello Agent Smith</p>\nFooter\n"]
+  end
+end
+
+scope do
+  setup do
+    Cuba.plugin Cuba::Haml
+    Cuba.settings[:haml][:views] = "./test/views"
+
+    Cuba.define do
+      on 'default_layout' do
+        haml('content-yield', title: "Default layout")
+      end
+
+      on 'custom_layout' do
+        view("layout-yield.haml", "content-yield")
+      end
+    end
+
+    test "simple layout support" do
+      _, _, resp = Cuba.call({ "PATH_INFO" => "/default_layout", "SCRIPT_NAME" => "" })
+      assert_response resp, ["Cuba: Default layout\n"]
+    end
+
+    test "custom layout support" do
+      _, _, resp = Cuba.call({ "PATH_INFO" => "/custom_layout", "SCRIPT_NAME" => "" })
+      assert_response resp, ["Header\nThis is the actual content.\nFooter\n"]
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,13 @@
+$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+require "cuba"
+
+prepare { Cuba.reset! }
+
+def assert_response(body, expected)
+  arr = []
+  body.each { |line| arr << line }
+
+  flunk "#{arr.inspect} != #{expected.inspect}" unless arr == expected
+  print "."
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: cuba-haml
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Emiliano Mancuso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cuba
+  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: cutest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cuba is a microframework for web applications.
+email:
+- emiliano.mancuso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/cuba/haml.rb
+- cuba-haml.gemspec
+- test/haml.rb
+- test/helper.rb
+homepage: http://github.com/eMancu/cuba-haml
+licenses:
+- UNLICENSE
+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.24
+signing_key: 
+specification_version: 3
+summary: A Cuba plugin to use Haml.
+test_files: []