html_mockup 0.6.5 → 0.7.0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## Version 0.7.0
+* Replace --quiet with -s in as it's no longer supported in newer GIT versions
+* Add support for ENV passing to the partials
+* Add support for single file processing and env passing in the extractor (release)
+* Refactor path and url resolving
+* Allow `.html` files to be processed by ERB (both in release and serve)
+* Pass "MOCKUP_PROJECT" variable to env (both in release and serve)
+
 ## Version 0.6.5
 * Allow disabling of URL relativizing in the extractor with `release.extract :url_relativize => false`
 * Add missing Hpricot dependency to gem

data/html_mockup.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "html_mockup"
-  s.version = "0.6.5"
+  s.version = "0.7.0"
   
   s.authors = ["Flurin Egger", "Edwin van der Graaf"]
   s.email = ["info@digitpaint.nl", "flurin@digitpaint.nl"]  

data/lib/html_mockup/extractor.rb

@@ -1,4 +1,5 @@
 require 'hpricot'
+require File.dirname(__FILE__) + '/resolver'
 
 module HtmlMockup
   class Extractor
@@ -12,21 +13,27 @@ module HtmlMockup
     
     # @option options [Array] :url_attributes The element attributes to parse and relativize
     # @option options [Array] :url_relativize Wether or not we should relativize
+    # @option options [Array] :env ENV variable to pass to template renderer.
     def initialize(project, target_path, options={})
       @project = project
       @target_path = Pathname.new(target_path)
+      @resolver = Resolver.new(self.target_path)
+      
       
       @options = {
         :url_attributes => %w{src href action},
-        :url_relativize => true
+        :url_relativize => true,
+        :env => {}
       }
       
       @options.update(options) if options
+      
+      env.update("MOCKUP_PROJECT" => project)
     end
     
     def run!
       target_path = self.target_path
-      source_path, partial_path = self.project.html_path, self.project.partial_path
+      source_path = self.project.html_path
       
       
       filter = "**/*.html"
@@ -39,86 +46,48 @@ module HtmlMockup
       cp_r(source_path.children, target_path)
       
       Dir.chdir(source_path) do
-        Dir.glob(filter).each do |file_name|
-          source = HtmlMockup::Template.open(file_name, :partial_path => partial_path).render
-          
-          if @options[:url_relativize]
-            source = relativize_urls(source, file_name)
-          end
-
-          File.open(target_path + file_name,"w"){|f| f.write(source) }
+        Dir.glob(filter).each do |file_path|
+          self.run_on_file!(file_path, @options[:env])
         end
       end           
     end
+    
+    def run_on_file!(file_path, env = {})
+      source = self.extract_source_from_file(file_path, env)
+      File.open(target_path + file_path,"w"){|f| f.write(source) }
+    end
+    
+    # Runs the extractor on a single file and return processed source.
+    def extract_source_from_file(file_path, env = {})
+      source = HtmlMockup::Template.open(file_path, :partial_path => self.project.partial_path).render(env)
+          
+      if @options[:url_relativize]
+        source = relativize_urls(source, file_path)
+      end
 
+      source
+    end
+    
     
     protected
     
-    def relativize_urls(source, file_name)
-      cur_dir = Pathname.new(file_name).dirname
-      up_to_root = File.join([".."] * (file_name.split("/").size - 1))
-          
+    def relativize_urls(source, file_path)
       doc = Hpricot(source)
       @options[:url_attributes].each do |attribute|
         (doc/"*[@#{attribute}]").each do |tag|
-          converted_url = convert_relative_url_to_absolute_url(tag[attribute], cur_dir,  up_to_root)
+          converted_url = @resolver.url_to_relative_url(tag[attribute], file_path)
               
           case converted_url
           when String
             tag[attribute] = converted_url
           when nil
-            puts "Could not resolve link #{tag[attribute]} in #{file_name}"
+            puts "Could not resolve link #{tag[attribute]} in #{file_path}"
           end
         end
       end
       
       doc.to_original_html      
     end
-    
-    # @return [false, nil, String] False if it can't be converted, nil if it can't be resolved and the converted string if it can be resolved.
-    def convert_relative_url_to_absolute_url(url, cur_dir, up_to_root)
-      # Skip if the url doesn't start with a / (but not with //)
-      return false unless url =~ /\A\/[^\/]/
-              
-      # Strip off anchors
-      anchor = nil
-      url.gsub!(/(#.+)\Z/) do |r|
-        anchor = r
-        ""
-      end
-              
-      # Strip off query strings
-      query = nil
-      url.gsub!(/(\?.+)\Z/) do |r|
-        query = r
-        ""
-      end
-              
-      if true_file = resolve_path(cur_dir + up_to_root + url.sub(/\A\//,""))
-        url = true_file.relative_path_from(cur_dir).to_s
-        url += query if query
-        url += anchor if anchor
-        url
-      else
-        nil
-      end
-      
-    end
-    
-    def resolve_path(path)
-      path = Pathname.new(path) unless path.kind_of?(Pathname)
-      # Append index.html/index.htm/index.rhtml if it's a diretory
-      if path.directory?
-        search_files = %w{.html .htm}.map!{|p| path + "index#{p}" }
-      # If it ends with a slash or does not contain a . and it's not a directory
-      # try to add .html/.htm to see if that exists.
-      elsif (path.to_s =~ /\/$/) || (path.to_s =~ /^[^.]+$/)
-        search_files = [path.to_s + ".html", path.to_s + ".htm"].map!{|p| Pathname.new(p) }
-      else
-        search_files = [path]
-      end
-      search_files.find{|p| p.exist? }  
-    end   
-        
+            
   end
 end

data/lib/html_mockup/rack/html_mockup.rb

@@ -2,42 +2,37 @@ require 'rack/request'
 require 'rack/response'
 require 'rack/file'
 
+require File.dirname(__FILE__) + '/../resolver'
+
 module HtmlMockup
   module Rack
+    
     class HtmlMockup
-      def initialize(root,partial_path)
+      
+      attr_reader :project
+      
+      def initialize(project)
+        @project = project
+        root,partial_path = project.html_path, project.partial_path
+        
         @docroot = root
         @partial_path = partial_path
         @file_server = ::Rack::File.new(@docroot)
       end
 
       def call(env)
-        path = env["PATH_INFO"]
-        
-        # TODO: Combine with Extractor#resolve_path
+        url = env["PATH_INFO"]
+        env["MOCKUP_PROJECT"] = project
         
-        # Append index.html/index.htm if it's a diretory
-        if File.directory?(File.join(@docroot,path))
-          search_files = %w{.html .htm}.map!{|p| File.join(@docroot,path,"index#{p}")}
-        # If it's already a .html/.htm file, render that file
-        elsif (path =~ /\.html?$/)
-          search_files = [File.join(@docroot,path)]
-        # If it ends with a slash or does not contain a . and it's not a directory
-        # try to add .html/.htm to see if that exists.
-        elsif (path =~ /\/$/) || (path =~ /^[^.]+$/)
-          search_files = [path + ".html", path + ".htm"].map!{|p| File.join(@docroot,p) }
-        # Otherwise don't render anything at all.
-        else
-          search_files = []
-        end
+        resolver = Resolver.new(@docroot)
 
-        if template_path = search_files.find{|p| File.exist?(p)}
-          env["rack.errors"].puts "Rendering template #{template_path.inspect} (#{path.inspect})"
+        if template_path = resolver.url_to_path(url)
+          env["rack.errors"].puts "Rendering template #{template_path.inspect} (#{url.inspect})"
           begin
             templ = ::HtmlMockup::Template.open(template_path, :partial_path => @partial_path)
             resp = ::Rack::Response.new do |res|
               res.status = 200
-              res.write templ.render
+              res.write templ.render(env)
             end
             resp.finish
           rescue StandardError => e
@@ -49,7 +44,7 @@ module HtmlMockup
             resp.finish
           end
         else
-          env["rack.errors"].puts "Invoking file handler for #{path.inspect}"
+          env["rack.errors"].puts "Invoking file handler for #{url.inspect}"
           @file_server.call(env)
         end
       end    

data/lib/html_mockup/release/scm/git.rb

@@ -61,7 +61,7 @@ module HtmlMockup::Release::Scm
           
           if $?.to_i > 0
             # HEAD is not a tagged verison, get the short SHA1 instead            
-            @_version = `git --git-dir=#{git_dir} show #{ref} --format=format:"%h" --quiet 2>&1` 
+            @_version = `git --git-dir=#{git_dir} show #{ref} --format=format:"%h" -s 2>&1` 
           else
             # HEAD is a tagged version, if version is prefixed with "v" it will be stripped off
             @_version.gsub!(/^v/,"")
@@ -69,7 +69,7 @@ module HtmlMockup::Release::Scm
           @_version.strip!
     
           # Get the date in epoch time
-          date = `git --git-dir=#{git_dir} show #{ref} --format=format:"%ct" --quiet 2>&1`
+          date = `git --git-dir=#{git_dir} show #{ref} --format=format:"%ct" -s 2>&1`
           if date =~ /\d+/
             @_date = Time.at(date.to_i)
           else

data/lib/html_mockup/resolver.rb

@@ -0,0 +1,95 @@
+module HtmlMockup
+  class Resolver
+    
+    def initialize(path)
+      @base = Pathname.new(path)
+    end
+    
+    def url_to_path(url, exact_match = false)
+      path, qs, anch = strip_query_string_and_anchor(url.to_s)
+      
+      extensions = %w{html htm}
+        
+      # Append index.extension if it's a diretory
+      if File.directory?(File.join(@base,path))
+        search_files = extensions.map{|p| File.join(@base,path,"index.#{p}")}
+      # If it's already a .extension file, return that file
+      elsif extensions.detect{|e| path =~ /\.#{e}\Z/ }
+        search_files = [File.join(@base,path)]
+      # If it ends with a slash or does not contain a . and it's not a directory
+      # try to add extenstions to see if that exists.
+      elsif (path =~ /\/$/) || (path =~ /^[^.]+$/)
+        search_files = extensions.map{|e| File.join(@base,"#{path}.#{e}") }
+      # Otherwise don't return anything at all.
+      else
+        if exact_match
+          search_files = [File.join(@base,path)]
+        else
+          search_files = []
+        end
+      end
+      
+      if file = search_files.find{|p| File.exist?(p) }
+        Pathname.new(file)
+      end
+    end
+    
+    
+    # Convert a disk path on file to an url
+    def path_to_url(path, relative_to = nil)
+
+      path = Pathname.new(path).relative_path_from(@base).cleanpath
+      
+      if relative_to
+        if relative_to.to_s =~ /\A\//
+          relative_to = Pathname.new(File.dirname(relative_to.to_s)).relative_path_from(@base).cleanpath
+        else
+          relative_to = Pathname.new(File.dirname(relative_to.to_s))
+        end
+        path = Pathname.new("/" + path.to_s).relative_path_from(Pathname.new("/" + relative_to.to_s))
+        path.to_s
+      else
+        "/" + path.to_s
+      end
+      
+    end
+    
+    def url_to_relative_url(url, relative_to_path)
+      # Skip if the url doesn't start with a / (but not with //)
+      return false unless url =~ /\A\/[^\/]/
+      
+      path, qs, anch = strip_query_string_and_anchor(url)
+
+      # Get disk path
+      if true_path =  self.url_to_path(path, true)
+        path = self.path_to_url(true_path, relative_to_path)
+        path += qs if qs
+        path += anch if anch
+        path
+      else
+        false
+      end
+    end
+    
+    def strip_query_string_and_anchor(url)
+      url = url.dup
+      
+      # Strip off anchors
+      anchor = nil
+      url.gsub!(/(#.+)\Z/) do |r|
+        anchor = r
+        ""
+      end
+              
+      # Strip off query strings
+      query = nil
+      url.gsub!(/(\?.+)\Z/) do |r|
+        query = r
+        ""
+      end
+      
+      [url, query, anchor]
+    end  
+    
+  end
+end

data/lib/html_mockup/server.rb

@@ -65,7 +65,7 @@ module HtmlMockup
       return @app if @app
       
       @stack.use Rack::HtmlValidator if self.options[:validate]
-      @stack.run Rack::HtmlMockup.new(self.project.html_path, self.project.partial_path)
+      @stack.run Rack::HtmlMockup.new(self.project)
       
       @app = @stack
     end    

data/lib/html_mockup/template.rb

@@ -2,6 +2,7 @@ require 'pathname'
 require 'strscan'
 require 'erb'
 require 'cgi'
+require 'tilt'
 
 module HtmlMockup
   
@@ -10,7 +11,7 @@ module HtmlMockup
   class Template
   
     class << self
-      def open(filename,options={})
+      def open(filename, options={})
         raise "Unknown file #{filename}" unless File.exist?(filename)
         self.new(File.read(filename),options.update(:target_file => filename))
       end
@@ -39,18 +40,17 @@ module HtmlMockup
   
     # Create a new HtmlMockupTemplate
     #
-    # ==== Parameters
-    # template<String>:: The template to parse
-    # options<Hash>:: See options
+    # @param [String] source The template to parse
+    # @param [Hash] options See options
     #
-    # ==== Options (optional)
-    # partial_path<String>:: Path where the partials reside (default: $0/../../partials)
-    #--
-    def initialize(template, options={})
-      defaults = {:partial_path => File.dirname(__FILE__) + "/../../partials/"}
-      @template = template
+    # @option options [String] partial_path Path where the partials reside (default: $0/../../partials)
+    def initialize(source, options={})
+      defaults = {
+        :partial_path => File.dirname(__FILE__) + "/../../partials/"
+      }
+      @source = source
+      @template = Tilt::ERBTemplate.new{ @source }      
       @options = defaults.update(options)
-      @scanner = StringScanner.new(@template)
       raise "Partial path '#{self.options[:partial_path]}' not found" unless File.exist?(self.options[:partial_path])
     end
   
@@ -65,6 +65,7 @@ module HtmlMockup
     # 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
@@ -73,7 +74,7 @@ module HtmlMockup
 
     		# scan until end of tag
     		current_content = self.scanner.scan_until(/<!-- \[STOP:#{tag}\] -->/)
-    		out << (render_partial(tag, params) || current_content)
+    		out << (render_partial(tag, params, env) || current_content)
     	end
     	out << scanner.rest    
     end
@@ -115,24 +116,18 @@ module HtmlMockup
       unless self.available_partials[tag]
         raise MissingPartial.new("Could not find partial '#{tag}' in partial path '#{@options[:partial_path]}'")
       end
-      template = ERB.new(self.available_partials[tag])
-      context = TemplateContext.new(params, env)
-      "\n" + template.result(context.get_binding).rstrip + "\n<!-- [STOP:#{tag}] -->"
+      template = Tilt::ERBTemplate.new{ self.available_partials[tag] }
+      context = TemplateContext.new(params)
+      "\n" + template.render(context, :env => env).rstrip + "\n<!-- [STOP:#{tag}] -->"
     end
   
     class TemplateContext
       # Params will be set as instance variables
-      def initialize(params, env = {})
+      def initialize(params)
         params.each do |k,v|
           self.instance_variable_set("@#{k}",v)
         end
-        
-        @_env = env;
-      end
-      
-      def env; @_env; end
-      
-      def get_binding; binding(); end
+      end      
     end
   
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html_mockup
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-10 00:00:00.000000000 Z
+date: 2013-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70323203509020 !ruby/object:Gem::Requirement
+  requirement: &70345877984660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 0.16.0
   type: :runtime
   prerelease: false
-  version_requirements: *70323203509020
+  version_requirements: *70345877984660
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70323203508540 !ruby/object:Gem::Requirement
+  requirement: &70345877984180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70323203508540
+  version_requirements: *70345877984180
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70323202817780 !ruby/object:Gem::Requirement
+  requirement: &70345877983700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70323202817780
+  version_requirements: *70345877983700
 - !ruby/object:Gem::Dependency
   name: hpricot
-  requirement: &70323202816620 !ruby/object:Gem::Requirement
+  requirement: &70345877983200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: 0.6.4
   type: :runtime
   prerelease: false
-  version_requirements: *70323202816620
+  version_requirements: *70345877983200
 description: 
 email:
 - info@digitpaint.nl
@@ -101,6 +101,7 @@ files:
 - lib/html_mockup/release/processors/yuicompressor.rb
 - lib/html_mockup/release/scm.rb
 - lib/html_mockup/release/scm/git.rb
+- lib/html_mockup/resolver.rb
 - lib/html_mockup/server.rb
 - lib/html_mockup/template.rb
 - lib/html_mockup/w3c_validator.rb