faml 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5be22673d059f3065d3e748acab1499879a0808
-  data.tar.gz: 493d64d87e95ee62a3f2567a60233de635a7ab69
+  metadata.gz: e56f6b1d1e1616fb0c3fad21f37e222335c035a5
+  data.tar.gz: 75024b5bd093c4fcc27505e42d9fd17e3ff4cca5
 SHA512:
-  metadata.gz: ed6b5e9ef55122c50b410dc412f403f781a80ba99193f415a3eb8a6a188598e6861a8afb71362733acb71039856c4fc3d5fb7e9710e337f5cde92882eba5ca3f
-  data.tar.gz: bca6c7834c44dab97238d108da0ee99db1f9152c15e6609e5e506ac2af6039b208c8aee57aab5bff4479ed27d5469810fb85ea83fd0f99a9164705ee9dde1c4d
+  metadata.gz: c5c2e4fd53a113be080c4a36e93dfc9c9472fd2bd2d2beecb5f60b7c0a8e47534380a9c3116239dcf2206710951d247b4a673f30441abd7eb07cc6d0b977f6a4
+  data.tar.gz: 3bb17b5f494fed5b47bbbe7507156b90cf7cc8f2378e52398527e97228e854249b50d4c976335055e8fad919ee90ad490e22004e52b30c867404900ea552bc3b

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.2.6 (2015-03-31)
+- Fix dependency on temple
+- Improve backtrace when syntax error is raised
+    - https://github.com/eagletmt/faml/issues/13
+
 ## 0.2.5 (2015-03-30)
 - Fix parser when parsing attributes in `{'foo': 'bar'}` form
     - The syntax was introduced in Ruby 2.2.

data/Rakefile

@@ -11,7 +11,7 @@ require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 namespace :benchmark do
-  task :rendering => ['benchmark:rendering:haml', 'benchmark:rendering:attributes']
+  task :rendering => ['benchmark:rendering:haml', 'benchmark:rendering:attributes', 'benchmark:rendering:slim']
   namespace :rendering do
     desc "Run benchmark with Haml's standard template"
     task :haml do
@@ -22,7 +22,12 @@ namespace :benchmark do
 
     desc "Run benchmark for attribute builder"
     task :attributes do
-      sh 'ruby', 'benchmark/rendering.rb', File.join('benchmark/attribute_builder.haml')
+      sh 'ruby', 'benchmark/rendering.rb', 'benchmark/attribute_builder.haml', 'benchmark/attribute_builder.slim'
+    end
+
+    desc "Run slim's benchmark"
+    task :slim do
+      sh 'ruby', 'benchmark/slim.rb'
     end
   end
 end

data/benchmark/attribute_builder.slim

@@ -0,0 +1,5 @@
+- h = { 'user' => { id: 1234, name: 'eagletmt' }, book_id: 5432 }
+- c = %w[content active]
+
+span.book data=h class=c
+  |Book

data/benchmark/context.rb

@@ -0,0 +1,11 @@
+class Context
+  def header
+    'Colors'
+  end
+
+  def item
+    [ { name: 'red',   current: true,  url: '#red'   },
+      { name: 'green', current: false, url: '#green' },
+      { name: 'blue',  current: false, url: '#blue'  } ]
+  end
+end

data/benchmark/rendering.rb

@@ -2,34 +2,38 @@
 require 'benchmark/ips'
 require 'haml'
 require 'faml'
+require 'slim'
 require 'escape_utils/html/haml'
 
-template = ARGV[0]
-unless template
-  $stderr.puts "Usage: #{$0} template.haml"
+unless ARGV[0]
+  $stderr.puts "Usage: #{$0} template.haml [template.slim]"
   exit 1
 end
 
+haml_code = File.read(ARGV[0])
+slim_code = ARGV[1] ? File.read(ARGV[1]) : nil
+
 Benchmark.ips do |x|
   obj = Object.new
 
-  Haml::Engine.new(File.read(template), ugly: true, escape_html: true).def_method(obj, :haml)
-  code_array = Faml::Engine.new.call(File.read(template))
-  obj.instance_eval("def faml_array; #{code_array}; end")
-  code_string = Faml::Engine.new(generator: Temple::Generators::RailsOutputBuffer).call(File.read(template))
-  obj.instance_eval("def faml_string; #{code_string}; end")
-
-  x.report('Haml') do
-    obj.haml
+  Haml::Engine.new(haml_code, ugly: true, escape_html: true).def_method(obj, :haml)
+  obj.instance_eval %{
+    def faml_array; #{Faml::Engine.new.call(haml_code)}; end
+    def faml_string; #{Faml::Engine.new(generator: Temple::Generators::RailsOutputBuffer).call(haml_code)}; end
+  }
+  if slim_code
+    obj.instance_eval %{
+      def slim_array; #{Slim::Engine.new.call(slim_code)}; end
+      def slim_string; #{Slim::Engine.new(generator: Temple::Generators::RailsOutputBuffer).call(slim_code)}; end
+    }
   end
 
-  x.report('Faml (Array)') do
-    obj.faml_array
+  x.report('Haml') { obj.haml }
+  x.report('Faml (Array)') { obj.faml_array }
+  x.report('Faml (String)') { obj.faml_string }
+  if slim_code
+    x.report('Slim (Array)') { obj.slim_array }
+    x.report('Slim (String)') { obj.slim_string }
   end
-
-  x.report('Faml (String)') do
-    obj.faml_string
-  end
-
   x.compare!
 end

data/benchmark/slim.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+require 'benchmark/ips'
+require 'haml'
+require 'faml'
+require 'slim'
+require 'escape_utils/html/haml'
+
+require_relative 'context'
+
+haml_code = File.read(File.join(__dir__, 'view.haml'))
+slim_code = File.read(File.join(__dir__, 'view.slim'))
+
+context = Context.new
+Haml::Engine.new(haml_code, ugly: true, escape_html: true).def_method(context, :haml)
+context.instance_eval %{
+  def faml; #{Faml::Engine.new(generator: Temple::Generators::RailsOutputBuffer).call(haml_code)}; end
+  def slim; #{Slim::Engine.new(generator: Temple::Generators::RailsOutputBuffer).call(slim_code)}; end
+}
+
+Benchmark.ips do |x|
+  x.report('Haml') { context.haml }
+  x.report('Faml') { context.faml }
+  x.report('Slim') { context.slim }
+  x.compare!
+end

data/benchmark/view.haml

@@ -0,0 +1,18 @@
+!!! html
+
+%html
+  %head
+    %title Simple Benchmark
+  %body
+    %h1= header
+    - unless item.empty?
+      %ul
+        - for i in item
+          - if i[:current]
+            %li
+              %strong= i[:name]
+          - else
+            %li
+              %a{:href => i[:url]}= i[:name]
+    - else
+      %p The list is empty.

data/benchmark/view.slim

@@ -0,0 +1,17 @@
+doctype html
+html
+  head
+    title Simple Benchmark
+  body
+    h1 = header
+    - unless item.empty?
+      ul
+        - for i in item
+          - if i[:current]
+            li
+              strong = i[:name]
+          - else
+            li
+              a href=i[:url] = i[:name]
+    - else
+      p The list is empty.

data/faml.gemspec

@@ -21,18 +21,19 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "escape_utils"
   spec.add_dependency "parser"
-  spec.add_dependency "temple"
+  spec.add_dependency "temple", ">= 0.7.0"
   spec.add_dependency "tilt"
   spec.add_development_dependency "appraisal"
   spec.add_development_dependency "benchmark-ips"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "coffee-script"
   spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "haml"
+  spec.add_development_dependency "haml"  # for benchmark
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rake-compiler"
   spec.add_development_dependency "redcarpet"
   spec.add_development_dependency "rspec", ">= 3"
   spec.add_development_dependency "sass"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "slim"  # for benchmark
 end

data/lib/faml/engine.rb

@@ -8,6 +8,7 @@ module Faml
   class Engine < Temple::Engine
     define_options(
       generator: Temple::Generators::ArrayBuffer,
+      filename: nil,
     )
 
     DEFAULT_OPTIONS = {

data/lib/faml/error.rb

@@ -0,0 +1,9 @@
+module Faml
+  class Error < StandardError
+    attr_reader :lineno
+    def initialize(message, lineno)
+      super(message)
+      @lineno = lineno
+    end
+  end
+end

data/lib/faml/indent_tracker.rb

@@ -1,12 +1,8 @@
+require 'faml/error'
+
 module Faml
   class IndentTracker
-    class IndentMismatch < StandardError
-      attr_reader :lineno
-
-      def initialize(message, lineno)
-        super("#{message} at line #{lineno}")
-        @lineno = lineno
-      end
+    class IndentMismatch < Error
     end
 
     def initialize(on_enter: nil, on_leave: nil)

data/lib/faml/parser.rb

@@ -1,5 +1,6 @@
 require 'faml/ast'
 require 'faml/element_parser'
+require 'faml/error'
 require 'faml/filter_parser'
 require 'faml/indent_tracker'
 require 'faml/line_parser'
@@ -11,6 +12,7 @@ require 'faml/syntax_error'
 module Faml
   class Parser
     def initialize(options = {})
+      @filename = options[:filename]
     end
 
     def call(template_str)
@@ -39,6 +41,11 @@ module Faml
       end
       @indent_tracker.finish
       @ast
+    rescue Error => e
+      if @filename && e.lineno
+        e.backtrace.unshift "#{@filename}:#{e.lineno}"
+      end
+      raise e
     end
 
     private

data/lib/faml/rails_handler.rb

@@ -4,6 +4,7 @@ module Faml
       Engine.new(
         use_html_safe: true,
         generator: Temple::Generators::RailsOutputBuffer,
+        filename: template.identifier,
       ).call(template.source)
     end
   end

data/lib/faml/syntax_error.rb

@@ -1,10 +1,6 @@
-module Faml
-  class SyntaxError < StandardError
-    attr_reader :lineno
+require 'faml/error'
 
-    def initialize(message, lineno)
-      super("#{message} at line #{lineno}")
-      @lineno = lineno
-    end
+module Faml
+  class SyntaxError < Error
   end
 end

data/lib/faml/tilt.rb

@@ -4,7 +4,7 @@ require 'faml/engine'
 module Faml
   class Tilt < Tilt::Template
     def prepare
-      @code = Engine.new(options).call(data)
+      @code = Engine.new(options.merge(filename: File.expand_path(file))).call(data)
     end
 
     def precompiled_template(locals = {})

data/lib/faml/version.rb

@@ -1,3 +1,3 @@
 module Faml
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/spec/rails/app/views/books/indent_error.html.haml

@@ -0,0 +1,3 @@
+%div
+    %span indent
+  %span mismatch

data/spec/rails/app/views/books/syntax_error.html.haml

@@ -0,0 +1,2 @@
+%div
+  %span{ syntax error

data/spec/rails/config/routes.rb

@@ -5,5 +5,7 @@ Rails.application.routes.draw do
     get :with_capture
     get :escaped
     get :preserve
+    get :syntax_error
+    get :indent_error
   end
 end

data/spec/rails/spec/requests/faml_spec.rb

@@ -52,4 +52,22 @@ RSpec.describe 'Faml with Rails', type: :request do
       expect(response.body).to include('<b>preserve&#x000A;me</b>')
     end
   end
+
+  describe 'compile time errors' do
+    describe Faml::SyntaxError do
+      it 'has proper backtrace' do
+        expect { get '/books/syntax_error' }.to raise_error { |e|
+          expect(e.backtrace[0]).to end_with('app/views/books/syntax_error.html.haml:2')
+        }
+      end
+    end
+
+    describe Faml::IndentTracker::IndentMismatch do
+      it 'has proper backtrace' do
+        expect { get '/books/indent_error' }.to raise_error { |e|
+          expect(e.backtrace[0]).to end_with('app/views/books/indent_error.html.haml:3')
+        }
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faml
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Kohei Suzuki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2015-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: escape_utils
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -234,6 +234,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Faster implementation of Haml template language.
 email:
 - eagletmt@gmail.com
@@ -254,7 +268,12 @@ files:
 - README.md
 - Rakefile
 - benchmark/attribute_builder.haml
+- benchmark/attribute_builder.slim
+- benchmark/context.rb
 - benchmark/rendering.rb
+- benchmark/slim.rb
+- benchmark/view.haml
+- benchmark/view.slim
 - bin/faml
 - ext/attribute_builder/attribute_builder.c
 - ext/attribute_builder/extconf.rb
@@ -270,6 +289,7 @@ files:
 - lib/faml/compiler.rb
 - lib/faml/element_parser.rb
 - lib/faml/engine.rb
+- lib/faml/error.rb
 - lib/faml/filter_compilers.rb
 - lib/faml/filter_compilers/base.rb
 - lib/faml/filter_compilers/cdata.rb
@@ -317,7 +337,9 @@ files:
 - spec/rails/app/models/concerns/.keep
 - spec/rails/app/views/books/escaped.html.haml
 - spec/rails/app/views/books/hello.html.haml
+- spec/rails/app/views/books/indent_error.html.haml
 - spec/rails/app/views/books/preserve.html.haml
+- spec/rails/app/views/books/syntax_error.html.haml
 - spec/rails/app/views/books/with_capture.html.haml
 - spec/rails/app/views/books/with_variables.html.haml
 - spec/rails/app/views/layouts/application.html.haml
@@ -406,7 +428,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Faster implementation of Haml template language.
@@ -426,7 +448,9 @@ test_files:
 - spec/rails/app/models/concerns/.keep
 - spec/rails/app/views/books/escaped.html.haml
 - spec/rails/app/views/books/hello.html.haml
+- spec/rails/app/views/books/indent_error.html.haml
 - spec/rails/app/views/books/preserve.html.haml
+- spec/rails/app/views/books/syntax_error.html.haml
 - spec/rails/app/views/books/with_capture.html.haml
 - spec/rails/app/views/books/with_variables.html.haml
 - spec/rails/app/views/layouts/application.html.haml