curtain 0.2.0 → 0.3.0

data/lib/curtain/form_builder.rb

@@ -0,0 +1,218 @@
+module Curtain
+  class FormBuilder
+    include HTMLHelpers
+
+    attr_accessor :object
+
+    def initialize(object=nil)
+      self.object = object
+    end
+
+    def form_object(object)
+      prev_object = self.object
+      self.object = object
+      yield
+      self.object = prev_object
+      object
+    end
+
+    def label(content=nil, attrs={}, &body)
+      if content.is_a?(Symbol)
+        attrs = { for: content }.merge(attrs)
+        content = content.to_s.titleize
+      end
+      content_tag(:label, content, attrs, &body)
+    end
+
+    NO_VALUE_INPUT_TYPES = %w[checkbox file password radio]
+
+    def input(name=nil, attrs={})
+      if name.is_a?(Hash)
+        name = nil
+        attrs = name
+      end
+
+      if name
+        new_attrs = { name: name }
+
+        if object && !NO_VALUE_INPUT_TYPES.include?(attrs[:type])
+          new_attrs[:value] = object.try(name)
+        end
+
+        unless attrs.has_key?(:id) && !attrs[:id]
+          attrs = attrs.merge(id: name)
+        end
+
+        attrs = new_attrs.merge(attrs)
+      end
+
+      void_tag(:input, attrs)
+    end
+
+    # @!method color(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="color"
+    # @!method date(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="date"
+    # @!method datetime(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="datetime"
+    # @!method datetime_local(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="datetime_local"
+    # @!method email(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="email"
+    # @!method file(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="file"
+    # @!method hidden(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="hidden"
+    # @!method image(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="image"
+    # @!method month(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="month"
+    # @!method number(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="number"
+    # @!method password(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="password"
+    # @!method range(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="range"
+    # @!method search(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="search"
+    # @!method tel(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="tel"
+    # @!method text(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="text"
+    # @!method time(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="time"
+    # @!method url(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="url"
+    # @!method week(name, attrs={})
+    #   @param name [String] The value for the name attribute
+    #   @param attrs [Hash] The attributes for the tag
+    #   @return [String] HTML input tag with type="week"P
+    INPUT_TAG_NAMES = [
+      :checkbox,
+      :color,
+      :date,
+      :datetime,
+      :datetime_local,
+      :email,
+      :file,
+      :hidden,
+      :image,
+      :month,
+      :number,
+      :password,
+      :radio,
+      :range ,
+      :search,
+      :tel,
+      :text,
+      :time ,
+      :url,
+      :week
+    ].each do |tag|
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
+        def #{tag}(name, attrs={})
+          input(name, { type: '#{tag.to_s.gsub('_','-')}' }.merge(attrs))
+        end
+      METHOD
+    end
+
+    #@param name [String] The value for the name attribute
+    #@param attrs [Hash] The attributes for the tag
+    #@return [String] HTML input tag with type="checkbox"
+    def checkbox(name, attrs={})
+      input(:checkbox, { type: 'checkbox', value: 'true', checked: !!object.try(name) }.merge(attrs))
+    end
+
+    #@param name [String] The value for the name attribute
+    #@param attrs [Hash] The attributes for the tag
+    #@return [String] HTML input tag with type="radio"
+    def radio(name, attrs={})
+      input(:radio, { type: 'radio', checked: (attrs.has_key?(:value) && attrs[:value].to_s == object.try(name).to_s) }.merge(attrs))
+    end
+
+    def select(name, attrs={}, &body)
+      attrs = attrs.dup
+      if name.is_a?(Hash)
+        name = nil
+        attrs = name
+      end
+
+      selected = attrs[:selected]
+      if name
+        new_attrs = { name: name }
+
+        selected ||= object.try(name) if object
+
+        unless attrs.has_key?(:id) && !attrs[:id]
+          attrs = attrs.merge(id: name)
+        end
+
+        attrs = new_attrs.merge(attrs)
+      end
+
+      if options = attrs.delete(:options)
+        content = "\n".html_safe
+        options.each do |o|
+          if o.is_a?(Array)
+            text = o.first
+            value = o.last
+          else
+            text = o
+            value = o
+          end
+          content << option(text, value: value, selected: (!selected.nil? && value.to_s == selected.to_s))
+          content << "\n"
+        end
+      end
+
+      content_tag(:select, content, attrs, &body)
+    end
+
+    def textarea(name, attrs={}, &body)
+      content_tag(:textarea, object.try(name), attrs, &body)
+    end
+
+    def button(content=nil, attrs={}, &body)
+      content_tag(:button, content, attrs, &body)
+    end
+
+    def submit(content=nil, attrs={}, &body)
+      button(content, { type: 'submit' }.merge(attrs), &body)
+    end
+
+  end
+end

data/lib/curtain/form_helpers.rb

@@ -0,0 +1,23 @@
+module Curtain
+  module FormHelpers
+
+    def self.included(cls)
+      cls.class_eval do
+        attr_accessor :current_form
+
+        delegate :button, :checkbox, :color, :date, :datetime, :email, :file, :hidden, :image, :input, :label, :month, :number, :password, :radio, :range, :reset, :search, :select, :submit, :tel, :text, :textarea, :time, :url, :week, :to => :current_form
+      end
+    end
+
+    def form(attrs={}, &body)
+      # Have a property for a default form builder
+      # Accept builder and object attrs
+      # Allow for custom builder classes
+      attrs = attrs.dup
+      self.current_form = FormBuilder.new(attrs.delete(:for))
+      content = content_tag(:form, attrs, &body)
+      self.current_form = nil
+      content
+    end
+  end
+end

data/lib/curtain/html_helpers.rb

@@ -0,0 +1,180 @@
+module Curtain
+  module HTMLHelpers
+    def capture
+      original_buffer = @output_buffer
+      @output_buffer = Curtain::OutputBuffer.new
+      yield
+    ensure
+      @output_buffer = original_buffer
+    end
+
+    # Generates a tag that has no content.
+    #
+    # @example Tag with no attributes
+    #   view.void_tag(:br) # => "<br>"
+    #
+    # @example Tag with attributes
+    #   view.void_tag(:img, src: "/logo.png") # => '<img src="/logo.png">'
+    #
+    # @param name [Symbol, String] The name of the tag
+    # @param attrs [Hash] The attributes of the tag
+    #
+    # @return [String] The HTML tag
+    #
+    def void_tag(name, attrs={})
+      tag_opening(name, attrs) << ">".html_safe
+    end
+
+    # Generates a with opening and closing tags and potentially content.
+    #
+    # @example Tag with no attributes, no content
+    #   content_tag(:p) # => "<p></p>"
+    #
+    # @example Tag with content
+    #   content_tag(:p, "Hello") # => "<p>Hello</p>"
+    #
+    # @example Tag with block content
+    #   content_tag(:p) { "Hello" } # => "<p>Hello</p>"
+    #
+    # @example Tag with content and attributes
+    #   content_tag(:a, "Log In", href: "/log_in") # => "<a href="/log_in">Log In</a>"
+    #
+    # @example Tag with content block and attributes
+    #   content_tag(:a, href: "/log_in") { "Log In" } # => "<a href="/log_in">Log In</a>"
+    #
+    # @param name [Symbol, String] The name of the tag
+    # @param attrs [Hash] The attributes of the tag
+    #
+    # @return [String] The HTML tag
+    #
+    def content_tag(name, content=nil, attrs={}, &body)
+      if content.is_a?(Hash)
+        attrs = content
+        content = nil
+      end
+
+      if block_given?
+        content = capture(&body)
+      end
+
+      tag = tag_opening(name, attrs)
+      tag << ">".html_safe
+      tag << content
+      tag << "</#{name}>".html_safe
+    end
+
+    # Tags
+
+    # @!method br(attrs={})
+    #   @param attrs [Hash] The attributes
+    #   @return [String] HTML br tag
+    # @!method hr(attrs={})
+    # @!method img(attrs={})
+    VOID_TAGS = [
+      :br,
+      :hr,
+      :img
+    ].each do |tag|
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
+        def #{tag}(attrs={})
+          void_tag(#{tag.inspect}, attrs)
+        end
+      METHOD
+    end
+
+    # @!method a(content=nil, attrs={}, &body)
+    #   @return [String] HTML a tag
+    # @!method b(content=nil, attrs={}, &body)
+    #   @return [String] HTML b tag
+    # @!method dd(content=nil, attrs={}, &body)
+    #   @return [String] HTML dd tag
+    # @!method div(content=nil, attrs={}, &body)
+    #   @return [String] HTML div tag
+    # @!method dl(content=nil, attrs={}, &body)
+    #   @return [String] HTML dl tag
+    # @!method dt(content=nil, attrs={}, &body)
+    #   @return [String] HTML dt tag
+    # @!method h1(content=nil, attrs={}, &body)
+    #   @return [String] HTML h1 tag
+    # @!method h2(content=nil, attrs={}, &body)
+    #   @return [String] HTML h2 tag
+    # @!method h3(content=nil, attrs={}, &body)
+    #   @return [String] HTML h3 tag
+    # @!method h4(content=nil, attrs={}, &body)
+    #   @return [String] HTML h4 tag
+    # @!method h5(content=nil, attrs={}, &body)
+    #   @return [String] HTML h5 tag
+    # @!method h6(content=nil, attrs={}, &body)
+    #   @return [String] HTML h6 tag
+    # @!method i(content=nil, attrs={}, &body)
+    #   @return [String] HTML i tag
+    # @!method p(content=nil, attrs={}, &body)
+    #   @return [String] HTML p tag
+    # @!method table(content=nil, attrs={}, &body)
+    #   @return [String] HTML table tag
+    # @!method tbody(content=nil, attrs={}, &body)
+    #   @return [String] HTML tbody tag
+    # @!method td(content=nil, attrs={}, &body)
+    #   @return [String] HTML td tag
+    # @!method tfoot(content=nil, attrs={}, &body)
+    #   @return [String] HTML tfoot tag
+    # @!method th(content=nil, attrs={}, &body)
+    #   @return [String] HTML th tag
+    # @!method thead(content=nil, attrs={}, &body)
+    #   @return [String] HTML thead tag
+    # @!method tr(content=nil, attrs={}, &body)
+    #   @return [String] HTML tr tag#
+    CONTENT_TAGS = [
+      :a,
+      :b,
+      :dd,
+      :div,
+      :dl,
+      :dt,
+      :h1,
+      :h2,
+      :h3,
+      :h4,
+      :h5,
+      :h6,
+      :i,
+      :li,
+      :option,
+      :p,
+      :section,
+      :table,
+      :tbody,
+      :td,
+      :tfoot,
+      :th,
+      :thead,
+      :tr,
+      :ul
+    ].each do |tag|
+      class_eval <<-METHOD, __FILE__, __LINE__ + 1
+        def #{tag}(content=nil, attrs={}, &body)
+          content_tag(#{tag.inspect}, content, attrs, &body)
+        end
+      METHOD
+    end
+
+    private
+    def tag_opening(name, attrs={})
+      tag = "<#{name}".html_safe
+
+      if attrs
+        attrs.each do |name, value|
+          if value == true
+            tag << %{ #{name}}.html_safe
+          elsif value != false
+            tag << %{ #{name}="}.html_safe
+            tag << value
+            tag << '"'.html_safe
+          end
+        end
+      end
+
+      tag
+    end
+  end
+end

data/lib/curtain/output_buffer.rb

@@ -0,0 +1,10 @@
+module Curtain
+  class OutputBuffer < ActiveSupport::SafeBuffer
+    def <<(value)
+      super(value.to_s)
+    end
+    alias :append= :<<
+    alias :safe_append= :<<
+    alias :safe_contact :<<
+  end
+end

data/lib/curtain/rendering.rb

@@ -1,26 +1,8 @@
 require 'tilt'
+require 'temple'
 
 module Curtain
 
-  class MustacheRenderer < ::Mustache
-    def initialize(view, template_file)
-      @view = view
-      @template_file = template_file
-    end
-
-    def respond_to?(method_name)
-      super || @view.respond_to?(method_name)
-    end
-
-    def method_missing(name, *args, &block)
-      if @view.respond_to?(name)
-        @view.send(name, *args, &block)
-      else
-        super
-      end
-    end
-  end
-
   module Rendering
     # Renders the template
     #
@@ -28,7 +10,7 @@ module Curtain
     #   view.render
     #
     # @example Render the foo template
-    #   view.render "foo.erb"
+    #   view.render "foo.slim"
     #
     # @example You can use symbols and omit the extension
     #   view.render :foo
@@ -58,16 +40,13 @@ module Curtain
       template_file = self.class.find_template(name)
       ext = template_file.split('.').last
 
-      # Apparently Tilt doesn't support mustache?
-      # TODO: There has to be an implementation out there,
-      # if not, write one
-      if ext == 'mustache'
-        mustache = MustacheRenderer.new(self, template_file)
-        mustache.render
-      else
-        template = Tilt.new(template_file)
-        template.render(self, variables.merge(locals))
-      end
+      orig_buffer = @output_buffer
+      @output_buffer = Curtain::OutputBuffer.new
+      template = Tilt.new(template_file, :buffer => '@output_buffer', :use_html_safe => true, :disable_capture => true, :generator => Temple::Generators::RailsOutputBuffer )
+      template.render(self, variables.merge(locals))
+      @output_buffer
+    ensure
+      @output_buffer = orig_buffer
     end
   end
 end

data/lib/curtain/templating.rb

@@ -45,9 +45,13 @@ module Curtain
         raise TemplateNotFound.new("Could not find a template matching '#{name}' in #{Array(template_directories).map{|d| File.expand_path(d) }}")
       end
 
+      def template_name
+        name.underscore.sub(/_view$/,'')
+      end
+
       def template(*args)
         if args.empty?
-          @template ||= name.underscore.sub(/_view$/,'')
+          @template ||= template_name
         else
           @template = args.first
         end

data/lib/curtain/version.rb

@@ -1,3 +1,3 @@
 module Curtain
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/curtain.rb

@@ -1,8 +1,13 @@
 require 'active_support/core_ext'
+require 'curtain/version'
 require 'curtain/templating'
 require 'curtain/rendering'
 require 'curtain/variable_support'
-require 'curtain/version'
+require 'curtain/output_buffer'
+require 'curtain/html_helpers'
+require 'curtain/form_helpers'
+require 'curtain/form_builder'
+require 'curtain/caching'
 
 module Curtain
 
@@ -11,6 +16,9 @@ module Curtain
       include Curtain::Templating
       include Curtain::Rendering
       include Curtain::VariableSupport
+      include Curtain::HTMLHelpers
+      include Curtain::FormHelpers
+      include Curtain::Caching
     end
   end
 
@@ -18,10 +26,19 @@ module Curtain
     include Curtain
 
     def initialize(attrs={})
+      @output_buffer = Curtain::OutputBuffer.new
       attrs.each do |k,v|
         send("#{k}=", v)
       end
     end
+
+    def self.render(*args)
+      new.render(*args)
+    end
+  end
+
+  def self.render(*args)
+    View.render(*args)
   end
 
 end

data/test/basic_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+
+class BasicTest < Curtain::TestCase
+
+  # Using the top-level to test default template name behavior
+  class ::TestView < Curtain::View
+    attr_accessor :name
+
+    def shout(s)
+      s.upcase
+    end
+  end
+
+  class SubdirView < Curtain::View
+    template :index
+  end
+
+  def use(lang)
+    TestView.template_directories = File.join(File.dirname(__FILE__), "examples", "basic", lang)
+
+    SubdirView.template_directories = [
+      File.join(File.dirname(__FILE__), "examples", "basic", lang, "subdir"),
+      File.join(File.dirname(__FILE__), "examples", "basic", lang)
+    ]
+  end
+
+  %w[erb slim].each do |lang|
+    test "render default with #{lang}" do
+      use lang
+      view = TestView.new
+      assert_equal "<h1>TEST</h1>", strip_lines(view.render)
+    end
+
+    test "render default with locals with #{lang}" do
+      use lang
+      view = TestView.new
+      assert_equal "<h1>TEST</h1><p>Hello, World!</p>", strip_lines(view.render(:msg => "Hello, World!"))
+    end
+
+    test "render template with #{lang}" do
+      use lang
+      view = TestView.new
+      assert_equal "<h1>default</h1>", strip_lines(view.render(:index))
+    end
+
+    test "render template with locals with #{lang}" do
+      use lang
+      view = TestView.new
+      assert_equal "<h1>Hello, World!</h1>", strip_lines(view.render(:index, :msg => "Hello, World!"))
+    end
+
+    test "variables and render within template with #{lang}" do
+      use lang
+      view = TestView.new
+      view[:msg] = "Hello, World!"
+      assert_equal "<html><body><h1>Hello, World!</h1></body></html>", strip_lines(view.render("layout", :main => "body"))
+    end
+
+    test "render multiple template directories with #{lang}" do
+      use lang
+      view = SubdirView.new
+      assert_equal "<h1>Subdir</h1>", strip_lines(view.render)
+    end
+  end
+
+end

data/test/cache_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class CacheTest < Curtain::TestCase
+  class ::CacheView < Curtain::View
+  end
+
+  def use(lang)
+    CacheView.template_directories File.join(File.dirname(__FILE__), "examples", "cache", lang)
+  end
+
+  %w[erb slim].each do |lang|
+    test "cache with #{lang}" do
+      use lang
+      assert_equal %{<h1>Test</h1>}, strip_lines(CacheView.render)
+    end
+  end
+end

data/test/examples/basic/erb/index.erb

@@ -0,0 +1 @@
+<h1><%= defined?(msg) ? msg : 'default' %></h1>

data/test/examples/basic/erb/layout.erb

@@ -0,0 +1,3 @@
+<html>
+  <body><%= render main %></body>
+</html>

data/test/examples/basic/slim/body.slim

@@ -0,0 +1,5 @@
+h1= msg
+- if defined? main
+  | This won't be reached,
+    because the local doesn't carry through to subsequent render calls,
+    but the variables, like methods on the view, do.

data/test/examples/basic/slim/index.slim

@@ -0,0 +1 @@
+h1= defined?(msg) ? msg : 'default'

data/test/examples/basic/slim/layout.slim

@@ -0,0 +1,2 @@
+html
+  body= render main

data/test/examples/basic/slim/subdir/index.slim

@@ -0,0 +1 @@
+h1 Subdir

data/test/examples/basic/slim/test.slim

@@ -0,0 +1,3 @@
+h1= shout "test"
+- if defined? msg
+  p= msg

data/test/examples/cache/erb/cache.erb

@@ -0,0 +1,3 @@
+<%= cache "test" do %>
+  <h1>Test</h1>
+<% end %>

data/test/examples/cache/slim/cache.slim

@@ -0,0 +1,2 @@
+= cache "test" do
+  h1 Test