flatrack 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18f2a64112e63e97157245c00c1ea592bf0afbdb
-  data.tar.gz: eca104199ffa912f5b4dbc87f8423027c0512a8b
+  metadata.gz: 8edfe0f35ac6cc52afc3bedd60f818c74e7e1d52
+  data.tar.gz: 5b338685735c1feb6dece6a301b20d50d19cf5ce
 SHA512:
-  metadata.gz: c0d551d21329e7c2a1848e02c538a606dc558d32a0fcafbe40282c00a5ff26bab931cd44ba922220b07a8f634df322a0d21b951936e41d1ec24300616426f6e8
-  data.tar.gz: ead79f7435dd9b79962112da8d38866d13505163ea109b3bd37d012d3b80b9705ecc8e2c544aaa75481f8a9201e023f1dc0d7a6119e7b5eaa6e7db5aa1af788c
+  metadata.gz: 09b78371dbfe2ec291364dfa6ba660b53dc3ab2f5d0e80e4afeacfeaaee91b8e71a2cf0f4ab030b813df6dec4ddf4b74c4c4c2d4a3355c3854a2830ff87a1af6
+  data.tar.gz: 94b13b995d764115712e86573a76a5f7859d83ff5a290e9ac31ec9acc2d532b147dc96e9e135f08ef37b66b28d167c67feafae2ae5dca8cd56d39c7b94f96603

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-# Flatrack 1.1.1 (March 05, 2014)
+# Flatrack 1.1.1 (March 06, 2014)
 
 *   Fix gem build errors, and update dependencies.
 
@@ -14,4 +14,4 @@
 
 *   Initial Release
 
-    *Jason Waldrip*
+    *Jason Waldrip*

data/README.md

@@ -1,10 +1,10 @@
-![Flatrack](https://raw.github.com/jwaldrip/flatrack/master/logo.png)
+![Flatrack](https://raw.github.com/jwaldrip/flatrack/master/lib/flatrack/cli/templates/logo.png)
 --
 
 [![Version](http://allthebadges.io/jwaldrip/flatrack/badge_fury.png)](http://allthebadges.io/jwaldrip/flatrack/badge_fury)
 [![Dependencies](http://allthebadges.io/jwaldrip/flatrack/gemnasium.png)](http://allthebadges.io/jwaldrip/flatrack/gemnasium)
 [![Build Status](http://allthebadges.io/jwaldrip/flatrack/travis.png)](http://allthebadges.io/jwaldrip/flatrack/travis)
-[![Coverage](http://allthebadges.io/jwaldrip/flatrack/coveralls.png?1)](http://allthebadges.io/jwaldrip/flatrack/coveralls)
+[![Coverage Status](https://coveralls.io/repos/jwaldrip/flatrack/badge.png?branch=master)](https://coveralls.io/r/jwaldrip/flatrack?branch=master)
 [![Code Climate](http://allthebadges.io/jwaldrip/flatrack/code_climate.png)](http://allthebadges.io/jwaldrip/flatrack/code_climate)
 
 ## About
@@ -51,6 +51,18 @@ Anything in `/pages` maps to a URL at `/`, root of a directory will always map t
 
 `GET /foo.html` would map to `/pages/foo.html.erb`, the erb (or any other format) is optional if you wish to render your pages dynamically.
 
+## Templating Support
+
+### Built in
+
+* HTML
+* ERB
+* Ruby Evaluated Output
+
+### Extensions
+
+* [Haml](https://github.com/jwaldrip/haml-flatrack)
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/flat-rack/fork )

data/flatrack.gemspec

@@ -30,6 +30,8 @@ based routing.
 
   # Dependencies
   spec.add_runtime_dependency 'rack', '~> 1.4'
+  spec.add_runtime_dependency 'erubis', '~> 2.7'
+  spec.add_runtime_dependency 'tilt', '~> 1.1'
   spec.add_runtime_dependency 'activesupport', ['> 3.2', '< 4.2']
   spec.add_runtime_dependency 'sass', '~> 3.2'
   spec.add_runtime_dependency 'sprockets-sass', '~> 1.0'
@@ -46,4 +48,6 @@ based routing.
   spec.add_development_dependency 'pry', '~> 0.9'
   spec.add_development_dependency 'coveralls', '~> 0.7'
   spec.add_development_dependency 'simplecov', '~> 0.8'
+  spec.add_development_dependency 'rubocop', '~> 0.18'
+  spec.add_development_dependency 'inch', '~> 0.3'
 end

data/lib/flatrack/cli.rb

@@ -6,7 +6,8 @@ class Flatrack
     include FileUtils
     include Thor::Actions
 
-    source_root File.join Flatrack.gem_root, '..', 'templates'
+    SRC_ROOT = File.join Flatrack.gem_root, 'flatrack/cli/templates'
+    source_root SRC_ROOT
 
     method_option :verbose, type: :boolean, default: true, aliases: :v
     method_option :bundle, type: :boolean, default: true, aliases: :b
@@ -34,6 +35,10 @@ class Flatrack
       'javascript.js.coffee' => 'assets/javascripts/main.js.coffee'
     }
 
+    BIN_COPY_FILES = {
+      'logo.png' => 'assets/images/logo.png'
+    }
+
     def new(path)
       mkdir_p path
       full_path             = File.expand_path path
@@ -79,6 +84,10 @@ class Flatrack
       FILES.each do |temp, dest|
         template temp, dest, verbose: options[:verbose]
       end
+      BIN_COPY_FILES.each do |src, dest|
+        src = File.join SRC_ROOT, src
+        copy_file src, dest, verbose: options[:verbose]
+      end
     end
   end
 end

data/lib/flatrack/request.rb

@@ -23,7 +23,7 @@ class Flatrack
 
     def response
       Response.new(self).render
-    rescue RendererNotFound
+    rescue TemplateNotFound
       respond_with_error(500)
     rescue FileNotFound
       respond_with_error(404)
@@ -34,7 +34,7 @@ class Flatrack
     def respond_with_error(code)
       Response.new(self).render(file: "#{code}.html", status: code)
     rescue FileNotFound
-      file = File.join Flatrack.gem_root, '../templates', "#{code}.html"
+      file = File.join Flatrack.gem_root, '../error_pages', "#{code}.html"
       Response.new(self).render(file: file, status: code)
     end
   end

data/lib/flatrack/response.rb

@@ -1,7 +1,5 @@
 class Flatrack
   class Response
-    autoload :ViewContext, 'flatrack/response/view_context'
-
     DEFAULT_FILE  = 'index'
     CONTENT_TYPES = {
       html: 'text/html',
@@ -23,10 +21,10 @@ class Flatrack
     end
 
     def render(file: file_for(request.path), status: 200, layout: :layout)
-      page_content = proc { renderer_for_page(file).render(view_context) }
+      page_content = proc { renderer_for_page(file).render(view) }
       set_content_type
       body << begin
-        renderer_for_layout(layout).render(view_context, &page_content)
+        renderer_for_layout(layout).render(view, &page_content)
       rescue Flatrack::FileNotFound
         page_content.call
       end
@@ -48,15 +46,15 @@ class Flatrack
     end
 
     def renderer_for_page(file)
-      Renderer.find :page, file
+      Template.find :page, file
     end
 
     def renderer_for_layout(file)
-      Renderer.find :layout, File.join("#{file}.#{request.format}")
+      Template.find :layout, File.join("#{file}.#{request.format}")
     end
 
-    def view_context
-      @view_context ||= ViewContext.new(self)
+    def view
+      @view ||= View.new(self)
     end
   end
 end

data/lib/flatrack/site.rb

@@ -2,7 +2,6 @@ require 'rack/server'
 
 class Flatrack
   module Site
-
     def self.call(env)
       builder.call(env)
     end
@@ -28,6 +27,5 @@ class Flatrack
         '/'       => site
       }
     end
-
   end
 end

data/lib/flatrack/template/erubis/handler.rb

@@ -0,0 +1,76 @@
+require 'erubis'
+
+class Flatrack
+  module Template
+    class Erubis < Tilt::ErubisTemplate
+      class Handler < ::Erubis::Eruby
+        def add_preamble(src)
+          @newline_pending = 0
+        end
+
+        def add_text(src, text)
+          return if text.empty?
+          if text == "\n"
+            @newline_pending += 1
+          else
+            src << "@output_buffer.safe_append='"
+            src << "\n" * @newline_pending if @newline_pending > 0
+            src << escape_text(text)
+            src << "'.freeze;"
+            @newline_pending = 0
+          end
+        end
+
+        # Erubis toggles <%= and <%== behavior when escaping is enabled.
+        # We override to always treat <%== as escaped.
+        def add_expr(src, code, indicator)
+          case indicator
+          when '=='
+            add_expr_escaped(src, code)
+          else
+            super
+          end
+        end
+
+        BLOCK_EXPR = /\s+(do|\{)(\s*\|[^|]*\|)?\s*\Z/
+
+        def add_expr_literal(src, code)
+          flush_newline_if_pending(src)
+          if code =~ BLOCK_EXPR
+            src << '@output_buffer.append= ' << code
+          else
+            src << '@output_buffer.append=(' << code << ');'
+          end
+        end
+
+        def add_expr_escaped(src, code)
+          flush_newline_if_pending(src)
+          if code =~ BLOCK_EXPR
+            src << '@output_buffer.safe_append= ' << code
+          else
+            src << '@output_buffer.safe_append=(' << code << ');'
+          end
+        end
+
+        def add_stmt(src, code)
+          flush_newline_if_pending(src)
+          super
+        end
+
+        def add_postamble(src)
+          flush_newline_if_pending(src)
+          src << 'output_buffer = @output_buffer.to_s'
+        end
+
+        def flush_newline_if_pending(src)
+          if @newline_pending > 0
+            src << begin
+              "@output_buffer.safe_append='#{"\n" * @newline_pending}'.freeze;"
+            end
+            @newline_pending = 0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flatrack/template/erubis.rb

@@ -0,0 +1,20 @@
+class Flatrack
+  module Template
+    class Erubis < Tilt::ErubisTemplate
+      extend ActiveSupport::Autoload
+      autoload :Handler
+
+      def self.engine_initialized?
+        defined? Handler
+      end
+
+      def prepare
+        @outvar = :output_buffer
+        @options.merge!(trim: true)
+        @engine = Handler.new(data, options)
+      end
+    end
+  end
+end
+
+Tilt.prefer Flatrack::Template::Erubis, 'erb'

data/lib/flatrack/template/html.rb

@@ -0,0 +1,11 @@
+class Flatrack
+  module Template
+    class Html < Tilt::PlainTemplate
+      def evaluate(scope, locals, &block)
+        super.html_safe
+      end
+    end
+  end
+end
+
+Tilt.prefer Flatrack::Template::Html, 'html'

data/lib/flatrack/template/rb.rb

@@ -0,0 +1,13 @@
+require 'erubis'
+
+class Flatrack
+  module Template
+    class Rb < Tilt::ErubisTemplate
+      def data
+        "<%= #{super} %>"
+      end
+    end
+  end
+end
+
+Tilt.prefer Flatrack::Template::Rb, 'rb'

data/lib/flatrack/template.rb

@@ -0,0 +1,35 @@
+require 'tilt'
+require 'flatrack/template/erubis'
+require 'flatrack/template/rb'
+require 'flatrack/template/html'
+
+class Flatrack
+  module Template
+    def find(type, file)
+      template = find_by_type type, file
+      fail FileNotFound, "could not find #{file}" unless template
+      Tilt.new template, options
+    rescue RuntimeError
+      raise(TemplateNotFound, "could not find a renderer for #{file}")
+    end
+
+    private
+
+    def options
+      local_options = {}
+      super.merge local_options
+    rescue NoMethodError
+      local_options
+    end
+
+    def find_by_type(type, file)
+      if File.exist?(file)
+        file
+      else
+        Dir[File.join type.to_s.pluralize, "#{file}*"].first
+      end
+    end
+
+    module_function :find, :find_by_type, :options
+  end
+end

data/lib/flatrack/version.rb

@@ -1,3 +1,3 @@
 class Flatrack
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/flatrack/view/capture_helper.rb

@@ -0,0 +1,30 @@
+class Flatrack
+  class View
+    module CaptureHelper
+      include ERB::Util
+
+      private
+
+      def capture(*args)
+        value  = nil
+        buffer = with_output_buffer { value = yield(*args) }
+        string = buffer.presence || value
+        html_escape string if string.is_a?(String)
+      end
+
+      # Use an alternate output buffer for the duration of the block.
+      # Defaults to a new empty string.
+      def with_output_buffer(buf = nil) #:nodoc:
+        unless buf
+          buf = OutputBuffer.new
+          buf.force_encoding(output_buffer.encoding) if output_buffer
+        end
+        self.output_buffer, old_buffer = buf, output_buffer
+        yield
+        output_buffer
+      ensure
+        self.output_buffer = old_buffer
+      end
+    end
+  end
+end

data/lib/flatrack/view/link_helper.rb

@@ -0,0 +1,28 @@
+class Flatrack
+  class View
+    module LinkHelper
+      include TagHelper
+
+      def link_to(name = nil, options = nil, html_options = nil, &block)
+        if block_given?
+          href, options, block = name, options, block
+        elsif options.is_a?(Hash) || options.blank?
+          name, href, options, block = name, name, options, block
+        else
+          name, href, options, block = name, options, html_options, block
+        end
+
+        block ||= proc { name }
+
+        html_tag :a, link_to_options(href, options || {}), &block
+      end
+
+      private
+
+      def link_to_options(link, opts = {})
+        link << '?' + opts.delete(:params).to_param if opts[:params].present?
+        { href: link }.merge(opts)
+      end
+    end
+  end
+end

data/lib/flatrack/view/output_buffer.rb

@@ -0,0 +1,24 @@
+class Flatrack
+  class View
+    class OutputBuffer < ActiveSupport::SafeBuffer #:nodoc:
+      def initialize(*)
+        super
+        encode!
+      end
+
+      def <<(value)
+        return self if value.nil?
+        super(value.to_s)
+      end
+
+      alias_method :append=, :<<
+
+      def safe_concat(value)
+        return self if value.nil?
+        super(value.to_s)
+      end
+
+      alias_method :safe_append=, :safe_concat
+    end
+  end
+end

data/lib/flatrack/view/render_helper.rb

@@ -0,0 +1,9 @@
+class Flatrack
+  class View
+    module RenderHelper
+      def render(file)
+        Template.find(:partial, file.to_s).render(self)
+      end
+    end
+  end
+end

data/lib/flatrack/view/request_helper.rb

@@ -0,0 +1,13 @@
+class Flatrack
+  class View
+    module RequestHelper
+      def params
+        @response.request.params
+      end
+
+      def path
+        @response.request.path
+      end
+    end
+  end
+end

data/lib/flatrack/view/tag_helper.rb

@@ -0,0 +1,102 @@
+class Flatrack
+  class View
+    module TagHelper
+      include CaptureHelper
+      include ERB::Util
+
+      PRE_CONTENT_STRINGS = {
+        textarea: "\n"
+      }
+
+      BOOLEAN_ATTRIBUTES = %w(disabled readonly multiple checked autobuffer
+                              autoplay controls loop selected hidden scoped
+                              async defer reversed ismap seamless muted
+                              required autofocus novalidate formnovalidate open
+                              pubdate itemscope allowfullscreen default inert
+                              sortable truespeed typemustmatch).to_set
+
+      def html_tag(name, content_or_options_with_block = nil, options = nil,
+        escape = true, &block)
+        if block_given?
+          if content_or_options_with_block.is_a?(Hash)
+            options = content_or_options_with_block
+          end
+          html_tag_string(name, capture(&block), options, escape)
+        else
+          html_tag_string(name, content_or_options_with_block, options, escape)
+        end
+      end
+
+      def image_tag(uri, options = {})
+        uri = asset_path(uri) unless uri =~ %r{^(http)?(s)?:?\/\/}
+        options.merge! src: uri
+        html_tag(:img, nil, options)
+      end
+
+      def javascript_tag(uri)
+        uri = asset_path(uri) + '.js' if uri.is_a? Symbol
+        html_tag(:script, '', src: uri, type: 'application/javascript')
+      end
+
+      def stylesheet_tag(uri)
+        uri = asset_path(uri) + '.css' if uri.is_a? Symbol
+        html_tag(:link, nil, rel: 'stylesheet', type: 'text/css', href: uri)
+      end
+
+      private
+
+      def html_tag_string(name, content, options, escape = true)
+        tag_options = tag_options(options, escape) if options
+        content     = h(content) if escape && !content.nil?
+        '<'.tap do |tag|
+          tag << name.to_s
+          tag << tag_options.to_s
+          content_with_ending = content.nil? ? '/>' : ">#{content}</#{name}>"
+          tag << content_with_ending
+        end.html_safe
+      end
+
+      def tag_options(options = {}, escape = true)
+        attrs = build_tag_options(options, escape)
+        " #{attrs * ' '}" unless attrs.blank?
+      end
+
+      def build_tag_options(options = {}, escape = true)
+        (options || {}).reduce([]) do |attrs, (key, value)|
+          if key.to_s == 'data' && value.is_a?(Hash)
+            attrs += data_tag_options(value, escape)
+          elsif BOOLEAN_ATTRIBUTES.include?(key.to_s)
+            attrs << boolean_tag_option(key, value)
+          elsif !value.nil?
+            attrs << tag_option(key, value, escape)
+          end
+          attrs
+        end.compact.sort
+      end
+
+      def data_tag_options(hash, escape = true)
+        hash.each_pair.map do |k, v|
+          data_tag_option(k, v, escape)
+        end
+      end
+
+      def data_tag_option(key, value, escape)
+        key   = "data-#{key.to_s.dasherize}"
+        value = value.to_json unless value.is_a?(String) ||
+          value.is_a?(Symbol) ||
+          value.is_a?(BigDecimal)
+        tag_option(key, value, escape)
+      end
+
+      def boolean_tag_option(key, bool)
+        %(#{key}="#{key}") if bool
+      end
+
+      def tag_option(key, value, escape)
+        value = value.join(' ') if value.is_a?(Array)
+        value = h(value) if escape
+        %(#{key}="#{value}")
+      end
+    end
+  end
+end

data/lib/flatrack/view.rb

@@ -0,0 +1,30 @@
+class Flatrack
+  class View
+    extend ActiveSupport::Autoload
+
+    autoload :TagHelper
+    autoload :LinkHelper
+    autoload :RequestHelper
+    autoload :CaptureHelper
+    autoload :RenderHelper
+    autoload :OutputBuffer
+
+    include AssetExtensions
+    include TagHelper
+    include LinkHelper
+    include RequestHelper
+    include CaptureHelper
+    include RenderHelper
+    include ERB::Util
+
+    attr_accessor :output_buffer
+
+    def initialize(response)
+      @response = response
+      @output_buffer = OutputBuffer.new
+      super(response)
+    rescue ArgumentError
+      super()
+    end
+  end
+end

data/lib/flatrack.rb

@@ -9,14 +9,15 @@ require 'rack'
 class Flatrack
   extend ActiveSupport::Autoload
 
-  autoload :Renderer
+  autoload :View
+  autoload :Template
   autoload :Request
   autoload :Response
   autoload :Site
   autoload :AssetExtensions
   autoload :CLI
 
-  RendererNotFound = Class.new StandardError
+  TemplateNotFound = Class.new StandardError
   FileNotFound     = Class.new StandardError
 
   FORMATS = {}
@@ -32,7 +33,6 @@ class Flatrack
   end
 
   class << self
-
     def delegate_instance
       @delegate_instance ||= new
     end
@@ -46,7 +46,6 @@ class Flatrack
     def method_missing(m, *args, &block)
       delegate_instance.public_method(m).call(*args, &block)
     end
-
   end
 
   def config(&block)
@@ -81,9 +80,4 @@ class Flatrack
 
   # Fix Locales issue
   I18n.enforce_available_locales = false
-
-  # Load all renderers
-  Dir.glob(File.join gem_root, '../renderers/**/*.rb').each do |f|
-    require f
-  end
 end