html_mockup 0.7.4 → 0.8.0

data/lib/html_mockup/template.rb

@@ -1,135 +1,124 @@
-require 'pathname'
-require 'strscan'
-require 'erb'
-require 'cgi'
 require 'tilt'
+require 'yaml'
+require 'ostruct'
+
+require File.dirname(__FILE__) + "/mockup_template"
 
 module HtmlMockup
   
-  class MissingPartial < StandardError; end
-  
   class Template
-  
+    
+    # The source
+    attr_accessor :source
+    
+    # Store the frontmatter
+    attr_accessor :data
+    
+    # The actual Tilt template
+    attr_accessor :template
+    
+    # The path to the source file for this template
+    attr_accessor :source_path
+    
     class << self
-      def open(filename, options={})
-        raise "Unknown file #{filename}" unless File.exist?(filename)
-        self.new(File.read(filename),options.update(:target_file => filename))
-      end
+      def open(path, options = {})
+        raise "Unknown file #{path}" unless File.exist?(path)
+        self.new(File.read(path), options.update(:source_path => path))
+      end      
+    end
+    
+    
+    # @option options [String,Pathname] :source_path The path to the source of the template being processed
+    # @option options [String,Pathname] :layouts_path The path to where all layouts reside
+    # @option options [String,Pathname] :partials_path The path to where all partials reside    
+    def initialize(source, options = {})
+      @options = options
+      self.source_path = options[:source_path]
+      self.data, self.source = extract_front_matter(source)
+      self.template = Tilt.new(self.source_path.to_s){ self.source }
       
-      # Returns all available partials in path
-      def partials(path)
-        available_partials = {}
-        path = Pathname.new(path)
-        self.partial_files(path).inject({}) do |mem,f|
-          name = f.to_s.split(".",2)[0]
-          mem[name] = (path + f).read
-          mem
-        end
+      if self.data[:layout] && layout_template_path = self.find_template(self.data[:layout], :layouts_path)
+        @layout_template = Tilt.new(layout_template_path.to_s)
       end
+    end
+    
+    def render(env = {})
+      context = TemplateContext.new(self, env)
+      locals = {:document => OpenStruct.new(self.data)}
       
-      def partial_files(path)
-        filter = "**/*.part.{?h,h}tml"
-        files = []
-        Dir.chdir(Pathname.new(path)) do 
-          files = Dir.glob(filter)        
+      if @layout_template
+        @layout_template.render(context, locals) do
+          self.template.render(context, locals)
         end
-        files
+      else
+        self.template.render(context, locals)
       end
-      
-    end
-  
-    # Create a new HtmlMockupTemplate
-    #
-    # @param [String] source The template to parse
-    # @param [Hash] options See options
-    #
-    # @option options [String] partial_path Path where the partials reside (default: $0/../../partials)
-    # @option options [String] target_file Path of the processed file
-    def initialize(source, options={})
-      defaults = {
-        :partial_path => File.dirname(__FILE__) + "/../../partials/"
-      }
-      @source = source
-      @template = Tilt::ERBTemplate.new(options[:target_file].to_s){ @source }      
-      @options = defaults.update(options)
-      raise "Partial path '#{self.options[:partial_path]}' not found" unless File.exist?(self.options[:partial_path])
     end
-  
-    attr_reader :template, :options, :scanner
-  
-    # Renders the template and returns it as a string
-    #
-    # ==== Parameters
-    # env<Hash>:: An environment hash (mostly used in combination with Rack)
-    #
-    # ==== Returns
-    # String:: The rendered template
-    #--
-    def render(env={})
-      @scanner = StringScanner.new(@template.render(Object.new, :env => env))      
-      out = ""
-    	while (partial = self.parse_partial_tag!) do
-    	  tag,params,scanned = partial
-    		# add new skipped content to output file
-    		out << scanned
+    
+    def find_template(name, path_type)
+      raise(ArgumentError, "path_type must be one of :partials_path or :layouts_path") unless [:partials_path, :layouts_path].include?(path_type)
 
-    		# scan until end of tag
-    		current_content = self.scanner.scan_until(/<!-- \[STOP:#{tag}\] -->/)
-    		out << (render_partial(tag, params, env) || current_content)
-    	end
-    	out << scanner.rest    
-    end
-  
-    def save(filename=self.options[:target_file])
-      File.open(filename,"w"){|f| f.write render}
-    end
-  
+      @resolvers ||= {}        
+      @resolvers[path_type] ||= Resolver.new(@options[path_type])
+      
+      @resolvers[path_type].url_to_path(name)
+    end      
+    
     protected
-  
-    def available_partials(force=false)
-      return @_available_partials if @_available_partials && !force
-      @_available_partials = self.class.partials(self.options[:partial_path])
-    end
-  
-    def parse_partial_tag!
-      params = {}
-      scanned = ""
-      begin_of_tag = self.scanner.scan_until(/<!-- \[START:/)
-      return nil unless begin_of_tag
-      scanned << begin_of_tag
-      scanned << tag = self.scanner.scan(/[a-z0-9_\/\-]+/)
-      if scanned_questionmark = self.scanner.scan(/\?/)
-        scanned << scanned_questionmark
-        scanned << raw_params = self.scanner.scan_until(/\] -->/)
-        raw_params.gsub!(/\] -->$/,"")
+    
+    # Get the front matter portion of the file and extract it.
+    def extract_front_matter(source)
+      fm_regex = /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
       
-        params = CGI.parse(raw_params)
-        params.keys.each{|k| params[k] = params[k].first }
+      if match = source.match(fm_regex)
+        source = source.sub(fm_regex, "")
+
+        begin
+          data = (YAML.load(match[1]) || {}).inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+        rescue *YAML_ERRORS => e
+          puts "YAML Exception: #{e.message}"
+          return false
+        end
       else
-        scanned << self.scanner.scan_until(/\] -->/)
+        return [{}, source]
       end
 
-      [tag,params,scanned]
+      [data, source]
+    rescue
+      [{}, source]
     end
+    
+  end
   
-    # Actually renders the tag as ERB
-    def render_partial(tag, params, env = {})
-      unless self.available_partials[tag]
-        raise MissingPartial.new("Could not find partial '#{tag}' in partial path '#{@options[:partial_path]}'")
-      end
-      template = Tilt::ERBTemplate.new{ self.available_partials[tag] }
-      context = TemplateContext.new(params)
-      "\n" + template.render(context, :env => env).rstrip + "\n<!-- [STOP:#{tag}] -->"
+  class TemplateContext
+    
+    def initialize(template, env={})
+      @_template, @_env = template, env
     end
-  
-    class TemplateContext
-      # Params will be set as instance variables
-      def initialize(params)
-        params.each do |k,v|
-          self.instance_variable_set("@#{k}",v)
-        end
-      end      
+    
+    def template
+      @_template
     end
-  
+    
+    def env
+      @_env
+    end
+        
+    def partial(name, options = {})
+      if template_path = self.template.find_template(name, :partials_path)
+        # puts "Rendering partial #{name}, with template #{template_path}"
+        partial_template = Tilt.new(template_path.to_s)
+        partial_template.render(self, options[:locals] || {})
+      elsif template_path = self.template.find_template(name + ".part", :partials_path)
+        # puts "Rendering old-style partial #{name}, with template #{template_path}"
+        template = Tilt::ERBTemplate.new(template_path.to_s)
+        context = MockupTemplate::TemplateContext.new(options[:locals] || {})
+        template.render(context, :env => self.env)        
+      else
+        raise ArgumentError, "No such partial #{name}, referenced from #{self.template.source_path}"
+      end
+    end
+    
   end
+  
 end

data/test/project/.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p194@mockup-test-project

data/test/project/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "html_mockup", :path => File.dirname(__FILE__) + "/../../"
+gem "sass"
+gem "yui-compressor"
+gem "redcarpet"

data/test/project/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: /Users/flurin/Projects.local/libraries/html_mockup
+  specs:
+    html_mockup (0.7.4)
+      hpricot (>= 0.6.4)
+      rack (>= 1.0.0)
+      sass
+      thor (~> 0.16.0)
+      tilt
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    POpen4 (0.1.4)
+      Platform (>= 0.4.0)
+      open4
+    Platform (0.4.0)
+    hpricot (0.8.6)
+    open4 (1.3.0)
+    rack (1.5.2)
+    redcarpet (2.2.2)
+    sass (3.2.9)
+    thor (0.16.0)
+    tilt (1.4.1)
+    yui-compressor (0.9.6)
+      POpen4 (>= 0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  html_mockup!
+  redcarpet
+  sass
+  yui-compressor

data/test/project/Mockupfile

@@ -0,0 +1,7 @@
+
+mockup.serve do |s|
+end
+
+mockup.release do |r|
+  
+end

data/test/project/html/formats/erb.html.erb

@@ -0,0 +1,5 @@
+<h1>ERB format</h1>
+
+<p>
+  <%= "yay" %> from ERB!
+</p>

data/test/project/html/formats/markdown.md

@@ -0,0 +1,3 @@
+# Markdown format
+
+"yay" from markdown

data/test/project/html/formats/mockup.html

@@ -0,0 +1,5 @@
+<h1>Mockup format</h1>
+
+<p>
+  Yay from mockup
+</p>

data/test/project/html/front_matter/erb.html.erb

@@ -0,0 +1,16 @@
+---
+title : "ERB frontmattter"
+---
+
+<h1>Document H1</h1>
+
+<p>
+  The title of this document is <%= document.title %>
+</p>
+
+<p>
+  Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim
+  ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in
+  reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
+  culpa qui officia deserunt mollit anim id est laborum.
+</p>

data/test/project/html/front_matter/markdown.md

@@ -0,0 +1,7 @@
+---
+title : "Markdown frontmattter"
+---
+
+# Document H1
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

data/test/project/html/layouts/erb.html.erb

@@ -0,0 +1,19 @@
+---
+layout : "test"
+title : "ERB frontmattter"
+---
+
+<h1>Document H1</h1>
+
+<strong>Var from layout before:</strong>
+<%= @var_from_layout_before %>
+<br>
+<strong>Var from layout after:</strong>
+<%= @var_from_layout_after %>
+
+<p>
+  Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim
+  ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in
+  reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
+  culpa qui officia deserunt mollit anim id est laborum.
+</p>

data/test/project/html/partials/erb.html.erb

@@ -0,0 +1,10 @@
+<h1>Partials in document</h1>
+
+<h2>ERB</h2>
+<%= partial "test/erb", :locals => {:value => "value"} %>
+
+<h2>MD</h2>
+<%= partial "test/markdown" %>
+
+<h2>Mockup</h2>
+<%= partial "test/mockup", :locals => {:value => "value"} %>

data/test/project/html/partials/mockup.html

@@ -0,0 +1,13 @@
+<h1>Partials in document</h1>
+
+<h2>ERB</h2>
+<!-- [START:test/erb?value=value] -->
+<!-- [STOP:test/erb] -->
+
+<h2>MD</h2>
+<!-- [START:test/markdown] -->
+<!-- [STOP:test/markdown] -->
+
+<h2>Mockup</h2>
+<!-- [START:test/mockup?value=value] -->
+<!-- [STOP:test/mockup] -->

data/test/project/layouts/test.html.erb

@@ -0,0 +1,27 @@
+<!doctype html>
+<html>
+  <head>
+    <title><%= document.title %></title>
+  </head>
+  <body>
+    <h1>H1 from layout</h1>
+    
+    <% @var_from_layout_before = "VAR from layout before yield is OK!" %>
+    
+    <!-- Template content -->
+    <%= yield %>
+    <!-- /Template content -->
+
+    <% @var_from_layout_after = "VAR from layout after yield is OK!" %>
+
+
+    <h2>Partials in layout</h2>
+    
+    <h3>ERB</h3>
+    <%= partial "test/erb", :locals => {:value => "value"} %>
+    
+    <h3>MD</h3>
+    <%= partial "test/markdown" %>
+    
+  </body>
+</html>

data/test/project/partials/test/erb.html.erb

@@ -0,0 +1 @@
+Let's render some ERB! (Value is <%= value %>)

data/test/project/partials/test/markdown.md

@@ -0,0 +1 @@
+Let's render some **markdown**

data/test/project/partials/test/mockup.part.html

@@ -0,0 +1 @@
+Let's render some old style ERB! (Value is <%= @value %>)

metadata

@@ -1,61 +1,87 @@
 --- !ruby/object:Gem::Specification
 name: html_mockup
 version: !ruby/object:Gem::Version
-  version: 0.7.4
-  prerelease: 
+  version: 0.8.0
 platform: ruby
 authors:
 - Flurin Egger
 - Edwin van der Graaf
+- Joran Kapteijns
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2014-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70157042134200 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.16.0
   type: :runtime
   prerelease: false
-  version_requirements: *70157042134200
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70157042133720 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70157042133720
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70157042133240 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70157042133240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: hpricot
-  requirement: &70157042132760 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.6.4
   type: :runtime
   prerelease: false
-  version_requirements: *70157042132760
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.4
 description: 
 email:
 - info@digitpaint.nl
@@ -83,6 +109,7 @@ files:
 - lib/html_mockup/extractor.rb
 - lib/html_mockup/generators.rb
 - lib/html_mockup/generators/new.rb
+- lib/html_mockup/mockup_template.rb
 - lib/html_mockup/mockupfile.rb
 - lib/html_mockup/project.rb
 - lib/html_mockup/rack/html_mockup.rb
@@ -92,12 +119,15 @@ files:
 - lib/html_mockup/release/cleaner.rb
 - lib/html_mockup/release/finalizers.rb
 - lib/html_mockup/release/finalizers/dir.rb
+- lib/html_mockup/release/finalizers/git_branch.rb
 - lib/html_mockup/release/finalizers/rsync.rb
 - lib/html_mockup/release/finalizers/zip.rb
 - lib/html_mockup/release/injector.rb
 - lib/html_mockup/release/processors.rb
+- lib/html_mockup/release/processors/mockup.rb
 - lib/html_mockup/release/processors/requirejs.rb
 - lib/html_mockup/release/processors/sass.rb
+- lib/html_mockup/release/processors/url_relativizer.rb
 - lib/html_mockup/release/processors/yuicompressor.rb
 - lib/html_mockup/release/scm.rb
 - lib/html_mockup/release/scm/git.rb
@@ -107,36 +137,67 @@ files:
 - lib/html_mockup/w3c_validator.rb
 - test/Mockupfile-syntax.rb
 - test/generator-subcommand.rb
+- test/project/.rvmrc
+- test/project/Gemfile
+- test/project/Gemfile.lock
+- test/project/Mockupfile
+- test/project/html/formats/erb.html.erb
+- test/project/html/formats/markdown.md
+- test/project/html/formats/mockup.html
+- test/project/html/front_matter/erb.html.erb
+- test/project/html/front_matter/markdown.md
+- test/project/html/layouts/erb.html.erb
+- test/project/html/partials/erb.html.erb
+- test/project/html/partials/mockup.html
+- test/project/layouts/test.html.erb
+- test/project/partials/test/erb.html.erb
+- test/project/partials/test/markdown.md
+- test/project/partials/test/mockup.part.html
 - test/unit/release/cleaner_test.rb
 - test/unit/release/processors/require_js_test.rb
 homepage: http://github.com/digitpaint/html_mockup
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.1.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: HTML Mockup is a set of tools to create self-containing HTML mockups.
 test_files:
 - test/Mockupfile-syntax.rb
 - test/generator-subcommand.rb
+- test/project/.rvmrc
+- test/project/Gemfile
+- test/project/Gemfile.lock
+- test/project/Mockupfile
+- test/project/html/formats/erb.html.erb
+- test/project/html/formats/markdown.md
+- test/project/html/formats/mockup.html
+- test/project/html/front_matter/erb.html.erb
+- test/project/html/front_matter/markdown.md
+- test/project/html/layouts/erb.html.erb
+- test/project/html/partials/erb.html.erb
+- test/project/html/partials/mockup.html
+- test/project/layouts/test.html.erb
+- test/project/partials/test/erb.html.erb
+- test/project/partials/test/markdown.md
+- test/project/partials/test/mockup.part.html
 - test/unit/release/cleaner_test.rb
 - test/unit/release/processors/require_js_test.rb