rail 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37044477e117facbe9e5e675ee19e1b8088d5aa6
-  data.tar.gz: 0588d8fd31eab039d6fc11344a4779a6b068f848
+  metadata.gz: 43471296d43318f06e1781bfea739eb39bf8da7f
+  data.tar.gz: be098116b23160188c2696295bc7758d8876f1d7
 SHA512:
-  metadata.gz: 2a4eda036b542c53e9fdb22a25c13d476beb4cb6fdb370404ac3e5796abf9f90bd418fb32a4d3162d31edc27f335be4ab97dc948327d3679cfcdc96042d7422d
-  data.tar.gz: dde7176c4d1b6c5bae9b79cc3e39dec81188dbdd0ffe49bc0973f312720282357e0318b762c7893ef45b8920ba951fbfc31606487d5da8dd83ff8bcbc4b4ed68
+  metadata.gz: 4f0f8b61cfef6396c5a1cc20cf14b04413eff13161ea2bc347b7131cc2ad036432ce5dab6162e93e48cf87b9721af39b7ecee7147810c00b4b2eacdc97bb84c7
+  data.tar.gz: 8143e93f3ec6e07273f04d0ac0854977a67a72373f70bdaa4c2659895b6a3cee2bb933b18079dda6c242855a30e570b11ad6b508df896bafcfe82be61883c323

data/.gitignore

@@ -1,5 +1,6 @@
 *.swp
-Gemfile.lock
-pkg
+.sass-cache
 .yardoc
+Gemfile.lock
 doc
+pkg

data/CHANGELOG.md

@@ -1,14 +1,19 @@
+## Rail (develop)
+
+* Dropped the dependency on Sprockets.
+* Implemented the rendering of templates inside layouts.
+
 ## Rail 0.0.5 (June 29, 2014)
 
-* Enforced usage of the pipeline when precompiling assets.
+* Enforced the usage of the pipeline when precompiling assets.
 
 ## Rail 0.0.4 (June 26, 2014)
 
-* Proper format of README making YARD happy.
+* Changed the format of README to make YARD happy.
 
 ## Rail 0.0.3 (June 24, 2014)
 
-* Proper response headers when pipelining assets.
+* Set proper response headers when pipelining assets.
 
 ## Rail 0.0.2 (June 21, 2014)
 

data/README.md

@@ -1,14 +1,12 @@
 # Rail [![Gem Version](https://badge.fury.io/rb/rail.svg)](http://badge.fury.io/rb/rail) [![Dependency Status](https://gemnasium.com/IvanUkhov/rail.svg)](https://gemnasium.com/IvanUkhov/rail) [![Build Status](https://travis-ci.org/IvanUkhov/rail.svg?branch=master)](https://travis-ci.org/IvanUkhov/rail)
 
 A light framework for front-end development inspired by
-[Rails](http://rubyonrails.org/). It is solely based on
-[Sprockets](https://github.com/sstephenson/sprockets) and includes the
-following components out of the box:
+[Rails](http://rubyonrails.org/). The sole purpose of Rail is to compile
+assets, and it includes the following components:
 
 * [CoffeeScript](http://coffeescript.org/) for JavaScript,
-* [Haml](http://haml.info/) for HTML,
-* [Sass](http://sass-lang.com/) for CSS, and
-* [Uglifier](https://github.com/lautis/uglifier) for compression.
+* [Haml](http://haml.info/) for HTML, and
+* [Sass](http://sass-lang.com/) for CSS.
 
 ## Installation
 
@@ -17,7 +15,7 @@ First of all, include the gem in your `Gemfile`. Here is an example:
 ```ruby
 source 'https://rubygems.org'
 
-gem 'rail', '~> 0.0.5'
+gem 'rail', '~> 0.0.6'
 
 # The rest is optional
 gem 'redcarpet', '~> 3.1.2' # your favorit complement to Haml
@@ -75,8 +73,13 @@ Organize your code according to the following convention:
 * `app/helpers` for helper modules, and
 * `public` for other static content.
 
-In addition, `app/views/layouts/application.html.haml` will be used for
-rendering the root of your application (both `/` and `/index.html`).
+The templates in `app/views/layouts` have a special purpose. First,
+`application.html.haml` is used for rendering the root of your application
+(both `/` and `/index.html`). Second, any template in `layouts` is used as
+a layout for the templates in the subfolder of `views` that has the same name
+as the layout. For example, `articles/what-is-the-meaning-of-life.html.haml`
+will be rendered in the context of `layouts/articles.html.haml` provided
+that the latter has a placeholder for the former via the `yield` keyword.
 
 ### Configuration
 
@@ -124,7 +127,7 @@ delete the precompiled files when you change your code in `app`.
 ### Examples
 
 Additional usage examples can be found
-[here](https://github.com/IvanUkhov/type-works),
+[here](https://github.com/IvanUkhov/opentype-works),
 [here](https://github.com/IvanUkhov/photography), and
 [here](https://github.com/IvanUkhov/liu-profile).
 

data/lib/rail/context.rb

@@ -0,0 +1,12 @@
+module Rail
+  class Context
+    def initialize(options = {})
+      (options[:mixins] || []).each { |mixin| extend(mixin) }
+      singleton_class.class_eval do
+        (options[:locals] || {}).each do |name, value|
+          define_method(name) { value }
+        end
+      end
+    end
+  end
+end

data/lib/rail/pipeline.rb

@@ -9,58 +9,45 @@ module Rail
     end
 
     def process(request)
-      Thread.current[:request] = request
+      context = Context.new(locals: { request: request }, mixins: helpers)
 
-      path = request.path
+      asset = rewrite(request.path)
+      klass = Processor.find(asset) or raise NotFoundError
+      asset = klass.extensify(asset)
+      filename = find(asset) or raise NotFoundError
 
-      case path
-      when '', 'index.html'
-        path = 'layouts/application'
-      end
+      processor = klass.new(self)
+      body = processor.compile(filename, context: context)
 
-      path = "#{ path }.html" if File.extname(path).empty?
+      headers = { 'Content-Type' => klass.mime_type }
 
-      sprockets.call('PATH_INFO' => path)
+      [ 200, headers, Array(body) ]
+    rescue NotFoundError
+      [ 404, {}, [] ]
     end
 
-    private
-
-    def sprockets
-      @sprockets ||= build_sprockets
-    end
-
-    def build_sprockets
-      environment = Sprockets::Environment.new
-
-      paths.each do |directory|
-        environment.append_path(directory)
+    def find(asset)
+      paths.each do |path|
+        filename = File.join(path, asset)
+        return filename if File.exist?(filename)
       end
+      nil
+    end
 
-      if compress?
-        environment.js_compressor = :uglify
-        environment.css_compressor = :scss
-      end
-
-      # TODO: Find a per-instance way to configure HAML.
-      Haml::Options.defaults[:ugly] = compress?
-
-      helpers.each do |helper|
-        environment.context_class.class_eval do
-          include helper
-        end
-      end
+    private
 
-      environment.context_class.class_eval do
-        define_method(:request) do
-          Thread.current[:request]
-        end
+    def rewrite(path)
+      if [ '', 'index.html' ].include?(path)
+        'layouts/application.html'
+      elsif File.extname(path).empty?
+        "#{ path }.html"
+      else
+        path
       end
-
-      environment
     end
 
     def paths
-      (application_paths + gems.map { |name| gem_paths(name) }).flatten
+      @paths ||= (application_paths + gems.map { |gem| gem_paths(gem) }).flatten
     end
 
     def application_paths

data/lib/rail/processor/base.rb

@@ -0,0 +1,22 @@
+module Rail
+  module Processor
+    class Base
+      extend Forwardable
+
+      def self.capable?(extension)
+        Array(output_extension).include?(extension)
+      end
+
+      def self.extensify(filename)
+        "#{ filename }.#{ input_extension }"
+      end
+
+      attr_reader :pipeline
+      def_delegator :pipeline, :compress?
+
+      def initialize(pipeline)
+        @pipeline = pipeline
+      end
+    end
+  end
+end

data/lib/rail/processor/coffee_script.rb

@@ -0,0 +1,68 @@
+module Rail
+  module Processor
+    class CoffeeScript < Base
+      def self.input_extension
+        'coffee'
+      end
+
+      def self.output_extension
+        'js'
+      end
+
+      def self.mime_type
+        'application/javascript'
+      end
+
+      def compile(filename, options = {})
+        code = process(filename, options)
+        code = Uglifier.new.compile(code) if compress?
+        code
+      end
+
+      private
+
+      def process(filename, options = {})
+        output = []
+
+        code = File.read(filename)
+
+        extract_requirements(code).each do |name|
+          requirement_filename = find_requirement(name, filename)
+          raise NotFoundError unless requirement_filename
+          output << compile(requirement_filename, options)
+        end
+
+        output << ::CoffeeScript.compile(code, options)
+
+        output.join
+      end
+
+      def find_requirement(name, referrer)
+        assets = [ name, "#{ name }.coffee", "#{ name }.js.coffee" ]
+
+        if name =~ /^\.\// # relative?
+          path = File.dirname(referrer)
+          assets.each do |asset|
+            filename = File.join(path, asset)
+            return filename if File.exist?(filename)
+          end
+        else
+          assets.each do |asset|
+            filename = pipeline.find(asset)
+            return filename if filename
+          end
+        end
+
+        nil
+      end
+
+      def extract_requirements(code)
+        match = /\A(?:\s*(?:\#.*\n?)+)+/.match(code) or return []
+        match[0].split(/\n/).map(&:strip).reject(&:empty?).map do |line|
+          match = /^\s*\#\s*=\s*require\s+(.*)$/.match(line)
+          match ? match[1].strip.gsub(/(^['"])|(['"]$)/, '') : nil
+        end.compact
+      end
+    end
+  end
+end

data/lib/rail/processor/haml.rb

@@ -0,0 +1,50 @@
+module Rail
+  module Processor
+    class Haml < Base
+      def self.input_extension
+        'haml'
+      end
+
+      def self.output_extension
+        'html'
+      end
+
+      def self.mime_type
+        'text/html'
+      end
+
+      def compile(filename, options = {}, &block)
+        options = {
+          filename: filename,
+          line: 1,
+          ugly: compress?
+        }.merge(options)
+
+        engine = ::Haml::Engine.new(File.read(filename), options)
+
+        layout_filename = find_layout(filename)
+
+        if layout_filename
+          compile(layout_filename, options) do
+            engine.render(options[:context], {}, &block)
+          end
+        else
+          engine.render(options[:context], {}, &block)
+        end
+      end
+
+      private
+
+      def find_layout(filename)
+        asset = "layouts/#{ filename.split('/')[-2] }"
+
+        [ "#{ asset }.haml", "#{ asset }.html.haml" ].each do |asset|
+          filename = pipeline.find(asset)
+          return filename if filename
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/rail/processor/sass.rb

@@ -0,0 +1,29 @@
+module Rail
+  module Processor
+    class Sass < Base
+      def self.input_extension
+        'scss'
+      end
+
+      def self.output_extension
+        'css'
+      end
+
+      def self.mime_type
+        'text/css'
+      end
+
+      def compile(filename, options = {})
+        options = {
+          filename: filename,
+          line: 1,
+          syntax: :scss,
+          style: compress? ? :compressed : :nested
+        }.merge(options)
+
+        engine = ::Sass::Engine.new(File.read(filename), options)
+        engine.render
+      end
+    end
+  end
+end

data/lib/rail/processor.rb

@@ -0,0 +1,20 @@
+require_relative 'processor/base'
+require_relative 'processor/coffee_script'
+require_relative 'processor/haml'
+require_relative 'processor/sass'
+
+module Rail
+  module Processor
+    def self.processors
+      @processors ||= Processor.constants.map do |name|
+        object = Processor.const_get(name)
+        object.is_a?(Class) && object < Base ? object : nil
+      end.compact
+    end
+
+    def self.find(filename)
+      extension = File.extname(filename).slice(1..-1)
+      processors.find { |processor| processor.capable?(extension) }
+    end
+  end
+end

data/lib/rail/version.rb

@@ -1,3 +1,3 @@
 module Rail
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/rail.rb

@@ -2,21 +2,26 @@ require 'ostruct'
 require 'forwardable'
 
 require 'rack'
+
+require 'coffee-script'
 require 'haml'
+require 'sass'
+
 require 'uglifier'
-require 'sprockets'
 
 require_relative 'rail/application'
 require_relative 'rail/browser'
+require_relative 'rail/context'
 require_relative 'rail/pipeline'
+require_relative 'rail/processor'
 require_relative 'rail/request'
 require_relative 'rail/server'
 require_relative 'rail/support'
 require_relative 'rail/version'
 
-Sprockets.register_engine('.haml', Tilt::HamlTemplate)
-
 module Rail
+  NotFoundError = Class.new(StandardError)
+
   def self.env
     @env ||= build_env
   end

data/rail.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'rake'
 
-  spec.add_dependency 'sprockets', '~> 2.12'
+  spec.add_dependency 'rack', '~> 1.5'
 
   spec.add_dependency 'coffee-script', '~> 2.2'
   spec.add_dependency 'haml', '~> 4.0'

data/spec/coffee_spec.rb

@@ -10,6 +10,17 @@ describe Rail::Application do
     end
     body = controller.process('/application.js')
     assert_equal body.strip, <<-BODY.strip
+(function() {
+  window.Parser = (function() {
+    function Parser(format) {
+      this.format = format;
+    }
+
+    return Parser;
+
+  })();
+
+}).call(this);
 (function() {
   window.Font = (function() {
     function Font(name) {
@@ -36,7 +47,7 @@ describe Rail::Application do
     end
     body = controller.process('/application.js')
     assert_equal body.strip, <<-BODY.strip
-(function(){window.Font=function(){function n(n){this.name=n}return n}()}).call(this),function(){var n;n=new Font(\"Benton Modern Display\")}.call(this);
+(function(){window.Parser=function(){function n(n){this.format=n}return n}()}).call(this),function(){window.Font=function(){function n(n){this.name=n}return n}()}.call(this),function(){var n;n=new Font(\"Benton Modern Display\")}.call(this);
     BODY
   end
 end

data/spec/haml_spec.rb

@@ -36,6 +36,24 @@ describe Rail::Application do
 <body>
 <h1>Hello</h1>
 </body>
+</html>
+    BODY
+  end
+
+  it 'handles layouts' do
+    controller = Controller.new do
+      config.compress = false
+    end
+    body = controller.process('/articles/about')
+    assert_equal body.strip, <<-BODY.strip
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Hello</title>
+  </head>
+  <body>
+    <h1>About</h1>
+  </body>
 </html>
     BODY
   end

data/spec/project/app/assets/javascripts/font.coffee

@@ -1,2 +1,4 @@
+#= require "./parser.js"
+
 class window.Font
   constructor: (@name) ->

data/spec/project/app/assets/javascripts/parser.js.coffee

@@ -0,0 +1,2 @@
+class window.Parser
+  constructor: (@format) ->

data/spec/project/app/helpers/application_helper.rb

@@ -0,0 +1,5 @@
+module ApplicationHelper
+  def title
+    'Hello'
+  end
+end

data/spec/project/app/views/articles/about.html.haml

@@ -0,0 +1 @@
+%h1 About

data/spec/project/app/views/layouts/application.html.haml

@@ -1,6 +1,6 @@
 !!! 5
 %html
   %head
-    %title Hello
+    %title= title
   %body
-    %h1 Hello
+    %h1= request.host || title

data/spec/project/app/views/layouts/articles.html.haml

@@ -0,0 +1,6 @@
+!!! 5
+%html
+  %head
+    %title= title
+  %body
+    = yield

data/spec/project/controller.rb

@@ -8,6 +8,6 @@ class Controller
 
   def process(path)
     _, _, body = @application.call('PATH_INFO' => path)
-    body.to_s
+    body.join.to_s
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rail
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ivan Ukhov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-29 00:00:00.000000000 Z
+date: 2014-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sprockets
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: coffee-script
   requirement: !ruby/object:Gem::Requirement
@@ -127,7 +127,13 @@ files:
 - lib/rail.rb
 - lib/rail/application.rb
 - lib/rail/browser.rb
+- lib/rail/context.rb
 - lib/rail/pipeline.rb
+- lib/rail/processor.rb
+- lib/rail/processor/base.rb
+- lib/rail/processor/coffee_script.rb
+- lib/rail/processor/haml.rb
+- lib/rail/processor/sass.rb
 - lib/rail/request.rb
 - lib/rail/server.rb
 - lib/rail/support.rb
@@ -139,9 +145,13 @@ files:
 - spec/haml_spec.rb
 - spec/project/app/assets/javascripts/application.js.coffee
 - spec/project/app/assets/javascripts/font.coffee
+- spec/project/app/assets/javascripts/parser.js.coffee
 - spec/project/app/assets/stylesheets/_reset.scss
 - spec/project/app/assets/stylesheets/application.css.scss
+- spec/project/app/helpers/application_helper.rb
+- spec/project/app/views/articles/about.html.haml
 - spec/project/app/views/layouts/application.html.haml
+- spec/project/app/views/layouts/articles.html.haml
 - spec/project/config/application.rb
 - spec/project/controller.rb
 - spec/sass_spec.rb
@@ -174,9 +184,13 @@ test_files:
 - spec/haml_spec.rb
 - spec/project/app/assets/javascripts/application.js.coffee
 - spec/project/app/assets/javascripts/font.coffee
+- spec/project/app/assets/javascripts/parser.js.coffee
 - spec/project/app/assets/stylesheets/_reset.scss
 - spec/project/app/assets/stylesheets/application.css.scss
+- spec/project/app/helpers/application_helper.rb
+- spec/project/app/views/articles/about.html.haml
 - spec/project/app/views/layouts/application.html.haml
+- spec/project/app/views/layouts/articles.html.haml
 - spec/project/config/application.rb
 - spec/project/controller.rb
 - spec/sass_spec.rb