flatrack 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0aec0d226a3b1fbf6614fdd772325b2d393a58a
-  data.tar.gz: c066f48a3047e11b32a7df82e5ad544bf8d7390f
+  metadata.gz: aeb92ed8375597715f099798076360100171fd3d
+  data.tar.gz: e4eb7e564ee857784c67e0952001821cc3abaadb
 SHA512:
-  metadata.gz: 57a09c2d7aae4bfab7c95450a5a5a41b4ed1f34abf5a345d90a8f444d4e301b0e7fdb81c2de6c9e9cc3d26a9fa7b86f772cbefde2eb500755a3b277f0f21e603
-  data.tar.gz: 61804f644c5f4c5bfece7bf8974ebbdca4707a06c8196ae32b214cc18d758b0c5ea5dbdadd66b5b4fca6806a687665fceaf215f1ae257d884b551dcc2b0009bb
+  metadata.gz: 350ed50f84bcc2d115b9223e2ce5bff5a41d36d679ff7002b358fc0dd8e59178bac1e180cc713ee04dcd450c2066e7fa54f755d57bfcaeea4369cd08b19196ef
+  data.tar.gz: d5c093b73c97259debe0941bb544948dcae572d62148598f7fdc620462a6d045b3f82c5f02bd9b522f3bfe7ddf83a75dc60d5b6a440cf6dc5120386b525caf27

data/.rubocop.yml

@@ -1,3 +1,4 @@
 AllCops:
   Excludes:
     - vendor/bundle/**
+    - spec/**

data/.travis.yml

@@ -2,4 +2,7 @@ language: ruby
 rvm:
   - 2.0.0
   - 2.1.1
-cache: bundler
+cache: bundler
+after_success:
+  - bundle exec inch
+  - bundle exec rubocop

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# Flatrack 1.2.1 (March 25, 2014)
+
+*   Fully Documented Flatrack.
+
+    *Jason Waldrip*
+    
+*   Added --version to CLI.
+
+    *Jason Waldrip*
+
+# Flatrack 1.2.0 (March 24, 2014)
+
+*   Moved away from custom templating engine in favor or tilt.
+
+    *Jason Waldrip*
+
 # Flatrack 1.1.1 (March 06, 2014)
 
 *   Fix gem build errors, and update dependencies.

data/README.md

@@ -2,10 +2,10 @@
 --
 
 [![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 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)
+[![Inline docs](http://inch-pages.github.io/github/jwaldrip/flatrack.png)](http://inch-pages.github.io/github/jwaldrip/flatrack)
 
 ## About
 A simple rack web layer for delivering rendered static files.
@@ -20,17 +20,18 @@ A simple rack web layer for delivering rendered static files.
     
 ### Structure
 
-You should have 3 directories:
+You should have 4 directories:
 
     - assets
     - layouts
     - pages
+    - partials
     
 #### Assets
 Location of sprockets assets, flatrack comes with Sass and Coffeescript out of the box.
 
     - images
-    - javascripte
+    - javascripts
     - stylesheets
     
 #### Pages
@@ -61,11 +62,20 @@ Anything in `/pages` maps to a URL at `/`, root of a directory will always map t
 
 ### Extensions
 
-* [Haml](https://github.com/jwaldrip/haml-flatrack)
+* HAML ([haml-flatrack](https://github.com/jwaldrip/haml-flatrack))
+* Markdown ([redcarpet](https://github.com/vmg/redcarpet), [bluecloth](https://github.com/mislav/bluecloth/))
+* Textile (Redcloth)
+* _and more!_ (see [Tilt](https://github.com/rtomayko/tilt) for more details.)
+
+### Sites using flatrack
+___Pull Request to add yours!___
+
+* [jasonwaldrip.com](http://jasonwaldrip.com)
+* [carlypaige.com](http://carlypaige.com)
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/flat-rack/fork )
+1. Fork it ( http://github.com/jwaldrip/flat-rack/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/flatrack/cli.rb

@@ -75,7 +75,10 @@ class Flatrack
     desc '--version', 'flatrack version'
     # Info about flatrack
     def __default__
-      puts 'Flatrack ' + Flatrack::VERSION and return if options[:version]
+      if options[:version]
+        puts 'Flatrack ' + Flatrack::VERSION
+        return
+      end
     end
 
     default_task :__default__

data/lib/flatrack/request.rb

@@ -2,9 +2,6 @@ class Flatrack
   # parses an incoming flatrack request and provides a method to render a
   # response
   class Request
-    # @private
-    DEFAULT_FORMAT = 'html'
-
     attr_reader :env, :rack_request
 
     # Initializes a response
@@ -26,7 +23,11 @@ class Flatrack
 
     # the format on the incoming request
     def format
-      (ext = File.extname path).empty? ? DEFAULT_FORMAT : ext.sub(/\./, '')
+      ext = File.extname path
+      unless ext.empty?
+        path.sub!(/#{ext}/, '')
+        ext.split('.').last
+      end
     end
 
     # the processed response for an inbound request

data/lib/flatrack/response.rb

@@ -4,7 +4,9 @@ class Flatrack
     # @private
     DEFAULT_FILE = 'index'
 
+    attr_accessor :layout
     attr_reader :request
+    delegate :format, to: :request
 
     # Initializes a response
     # @param request [Flatrack::Request]
@@ -19,18 +21,33 @@ class Flatrack
     # @option opts [Symbol] :layout
     # @return [Array] the rack response
     def render(file: file_for(request.path), status: 200, layout: :layout)
-      page_content = proc { renderer_for_page(file).render(view) }
-      set_content_type
+      @file, @status, @layout = file, status, layout
+      page_content            = pre_render_page
       body << begin
-        renderer_for_layout(layout).render(view, &page_content)
+        renderer_for_layout(@layout).render view, &proc { page_content }
       rescue Flatrack::FileNotFound
-        page_content.call
+        page_content
       end
       [status, headers, body]
     end
 
+    # Set the layout
+    # @param layout [String]
+    # @return [String]
+    def use_layout(layout)
+      @layout = layout.to_s
+    end
+
     private
 
+    def pre_render_page
+      renderer                = renderer_for_page(@file)
+      content                 = renderer.render(view)
+      @view                   = nil
+      headers['Content-Type'] = FORMATS[renderer.format.to_sym]
+      content
+    end
+
     def body
       @body ||= []
     end
@@ -39,10 +56,6 @@ class Flatrack
       @headers ||= {}
     end
 
-    def set_content_type
-      headers['Content-Type'] = FORMATS[request.format.to_sym]
-    end
-
     def file_for(path)
       if File.directory?(File.join 'pages', path)
         File.join(path, DEFAULT_FILE)
@@ -52,11 +65,11 @@ class Flatrack
     end
 
     def renderer_for_page(file)
-      Template.find :page, file
+      Template.find :page, format, file
     end
 
     def renderer_for_layout(file)
-      Template.find :layout, File.join("#{file}.#{request.format}")
+      Template.find :layout, format, file
     end
 
     def view

data/lib/flatrack/template.rb

@@ -6,34 +6,40 @@ require 'flatrack/template/html'
 class Flatrack
   # The default template parser/finder
   class Template
-    attr_reader :type, :file
+    # @private
+    DEFAULT_FORMAT = 'html'
+
+    attr_reader :type, :file, :format
+    delegate :render, to: :@renderer
 
     # Creates a new template instance and invokes find
     # @param type [Symbol] the type of template
+    # @param format [String] the format e.g. html
     # @param file [String] the location of the file
-    def self.find(type, file)
-      new(type, file).find
+    def self.find(type, format, file)
+      new(type, format, file)
     end
 
     # Creates a new template instance
     # @param type [Symbol] the type of template
+    # @param format [String] the format e.g. html
     # @param file [String] the location of the file
-    def initialize(type, file)
-      @type, @file = type, file
+    def initialize(type, format, file)
+      @format      = format || DEFAULT_FORMAT
+      @type, @file = type, file.to_s
+      @renderer = find
     end
 
-    # Finds a given template
-    # @return [Tilt::Template]
+    private
+
     def find
       template = find_by_type
       fail FileNotFound, "could not find #{file}" unless template
       Tilt.new template, options
     rescue RuntimeError
-      raise(TemplateNotFound, "could not find a renderer for #{file}")
+      raise TemplateNotFound, "could not find a renderer for #{file}"
     end
 
-    private
-
     def options
       local_options = {}
       super.merge local_options
@@ -45,7 +51,8 @@ class Flatrack
       if File.exist?(file)
         file
       else
-        Dir[File.join type.to_s.pluralize, "#{file}*"].first
+        file_with_format = [file, format].compact.join('.')
+        Dir[File.join type.to_s.pluralize, "#{file_with_format}*"].first
       end
     end
   end

data/lib/flatrack/version.rb

@@ -1,5 +1,5 @@
 # Version
 class Flatrack
   # @private
-  VERSION = '1.2.1'
+  VERSION = '1.3.0'
 end

data/lib/flatrack/view/render_helper.rb

@@ -6,7 +6,7 @@ class Flatrack
       # @param file [Symbol, String]
       # @return [String]
       def render(file)
-        Template.find(:partial, file.to_s).render(self)
+        Template.find(:partial, nil, file.to_s).render(self)
       end
     end
   end

data/lib/flatrack/view.rb

@@ -19,6 +19,7 @@ class Flatrack
     include ERB::Util
 
     attr_accessor :output_buffer
+    delegate :use_layout, to: :@response
 
     # initializes a flatrack view
     # @param response [Flatrack::Response]

data/lib/rake/asset_tasks/asset.rb

@@ -1,36 +1,38 @@
 # Rake Extensions
 module Rake
-  # Asset class for sprockets pre-compilation
-  class AssetTasks::Asset
-    # Returns a sprockets asset
-    # @param env [Sprockets::Environment]
-    # @param file [String]
-    def initialize(env, file)
-      @env  = env
-      @file = file
-    end
+  class AssetTasks
+    # Asset class for sprockets pre-compilation
+    class Asset
+      # Returns a sprockets asset
+      # @param env [Sprockets::Environment]
+      # @param file [String]
+      def initialize(env, file)
+        @env  = env
+        @file = file
+      end
 
-    # Returns the path of an asset
-    # @return [String]
-    def path
-      File.expand_path(file).sub(/(#{@env.paths.join('|')})\//, '')
-    end
+      # Returns the path of an asset
+      # @return [String]
+      def path
+        File.expand_path(file).sub(/(#{@env.paths.join('|')})\//, '')
+      end
 
-    private
+      private
 
-    def basename
-      File.basename @file
-    end
+      def basename
+        File.basename @file
+      end
 
-    def parts
-      basename.split('.').size
-    end
+      def parts
+        basename.split('.').size
+      end
 
-    def file
-      if parts > 2
-        @file.split('.').tap(&:pop).join('.')
-      else
-        @file
+      def file
+        if parts > 2
+          @file.split('.').tap(&:pop).join('.')
+        else
+          @file
+        end
       end
     end
   end

data/spec/fixtures/templates/alt_layout.html.erb

@@ -0,0 +1,3 @@
+<div class="layout-content">
+  <%= yield %>
+</div>

data/spec/fixtures/templates/set_layout.html

@@ -0,0 +1,3 @@
+<div class="layout-content">
+    hello world
+</div>

data/spec/fixtures/templates/set_layout.html.erb

@@ -0,0 +1,5 @@
+<%
+   path = File.expand_path File.join File.dirname(__FILE__), 'alt_layout.html.erb'
+   use_layout path
+%>
+hello world

data/spec/fixtures/templates/set_layout.html.rb

@@ -0,0 +1,3 @@
+path = File.expand_path File.join File.dirname(__FILE__), 'alt_layout.html.erb'
+use_layout path
+'hello world'

data/spec/lib/flatrack/cli_spec.rb

@@ -57,4 +57,11 @@ describe Flatrack::CLI do
     end
   end
 
+  describe '--version' do
+    it 'should display the flatrack version' do
+      expect(STDOUT).to receive(:puts).with 'Flatrack ' + Flatrack::VERSION
+      Flatrack::CLI.start(%w(--version))
+    end
+  end
+
 end

data/spec/lib/flatrack/view/set_layout_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Flatrack::View do
+  def render_template(fixture)
+    path = File.join Flatrack.gem_root, '../spec/fixtures/templates', fixture
+    env = Rack::MockRequest.env_for 'http://example.com'
+    req = Flatrack::Request.new env
+    _, _, body = Flatrack::Response.new(req).render(file: path)
+    body.first.lines.map(&:strip).join
+  end
+
+  describe '#link_to' do
+
+    context 'using erb' do
+      it 'should properly render' do
+        template_content = render_template 'set_layout.html.erb'
+        expected_content = render_template 'set_layout.html'
+        expect(template_content).to eq expected_content
+      end
+    end
+
+    context 'using rb' do
+      it 'should properly render' do
+        template_content = render_template 'set_layout.html.rb'
+        expected_content = render_template 'set_layout.html'
+        expect(template_content).to eq expected_content
+      end
+    end
+
+  end
+end

data/spec/lib/flatrack/view_spec.rb

@@ -42,7 +42,7 @@ describe Flatrack::View do
 
     it 'should properly render a partial' do
       site do
-        write(:partial, 'sample.erb', template)
+        write(:partial, 'sample.html.erb', template)
         result = view.render(:sample)
         expect(result).to include 'Hello World'.reverse
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flatrack
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Jason Waldrip
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-26 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -364,6 +364,7 @@ files:
 - public/assets/manifest-6d7e78baa6d2c0670a82be957315fcbc.json
 - spec/fixtures/assets/sample.css.scss
 - spec/fixtures/assets/sample.js.coffee
+- spec/fixtures/templates/alt_layout.html.erb
 - spec/fixtures/templates/html_tag.html
 - spec/fixtures/templates/html_tag.html.erb
 - spec/fixtures/templates/html_tag.html.rb
@@ -376,6 +377,9 @@ files:
 - spec/fixtures/templates/link_to.html
 - spec/fixtures/templates/link_to.html.erb
 - spec/fixtures/templates/link_to.html.rb
+- spec/fixtures/templates/set_layout.html
+- spec/fixtures/templates/set_layout.html.erb
+- spec/fixtures/templates/set_layout.html.rb
 - spec/fixtures/templates/stylesheet_tag.html
 - spec/fixtures/templates/stylesheet_tag.html.erb
 - spec/fixtures/templates/stylesheet_tag.html.rb
@@ -385,6 +389,7 @@ files:
 - spec/lib/flatrack/response_spec.rb
 - spec/lib/flatrack/site_spec.rb
 - spec/lib/flatrack/view/link_helper_spec.rb
+- spec/lib/flatrack/view/set_layout_spec.rb
 - spec/lib/flatrack/view/tag_helper_spec.rb
 - spec/lib/flatrack/view_spec.rb
 - spec/lib/flatrack_spec.rb
@@ -419,6 +424,7 @@ summary: Deliver static files with style.
 test_files:
 - spec/fixtures/assets/sample.css.scss
 - spec/fixtures/assets/sample.js.coffee
+- spec/fixtures/templates/alt_layout.html.erb
 - spec/fixtures/templates/html_tag.html
 - spec/fixtures/templates/html_tag.html.erb
 - spec/fixtures/templates/html_tag.html.rb
@@ -431,6 +437,9 @@ test_files:
 - spec/fixtures/templates/link_to.html
 - spec/fixtures/templates/link_to.html.erb
 - spec/fixtures/templates/link_to.html.rb
+- spec/fixtures/templates/set_layout.html
+- spec/fixtures/templates/set_layout.html.erb
+- spec/fixtures/templates/set_layout.html.rb
 - spec/fixtures/templates/stylesheet_tag.html
 - spec/fixtures/templates/stylesheet_tag.html.erb
 - spec/fixtures/templates/stylesheet_tag.html.rb
@@ -440,6 +449,7 @@ test_files:
 - spec/lib/flatrack/response_spec.rb
 - spec/lib/flatrack/site_spec.rb
 - spec/lib/flatrack/view/link_helper_spec.rb
+- spec/lib/flatrack/view/set_layout_spec.rb
 - spec/lib/flatrack/view/tag_helper_spec.rb
 - spec/lib/flatrack/view_spec.rb
 - spec/lib/flatrack_spec.rb