roger 0.0.1 → 0.10.0

data/lib/roger/template.rb

@@ -0,0 +1,206 @@
+require 'tilt'
+require 'mime/types'
+require 'yaml'
+require 'ostruct'
+
+# We're enforcing Encoding to UTF-8
+Encoding.default_external = "UTF-8"
+
+module Roger
+  
+  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(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 }
+      
+      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)
+      
+      if @layout_template
+        content_for_layout = self.template.render(context, {}) # yields
+        
+        @layout_template.render(context, {}) do |content_for|
+          if content_for
+            context._content_for_blocks[content_for]
+          else
+            content_for_layout
+          end
+        end
+      else
+        self.template.render(context, {})
+      end
+    end
+    
+    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)
+
+      return nil unless @options[path_type]
+
+      @resolvers ||= {}        
+      @resolvers[path_type] ||= Resolver.new(@options[path_type])
+      
+      @resolvers[path_type].find_template(name, :preferred_extension => self.target_extension)
+    end
+
+    # Try to infer the final extension of the output file.
+    def target_extension
+      return @target_extension if @target_extension
+
+      if type = MIME::Types[self.target_mime_type].first
+        # Dirty little hack to enforce the use of .html instead of .htm
+        if type.sub_type == "html"
+          @target_extension = "html"
+        else
+          @target_extension = type.extensions.first
+        end
+      else
+        @target_extension = File.extname(self.source_path.to_s).sub(/^\./, "")
+      end
+    end
+
+    def source_extension
+      parts = File.basename(File.basename(self.source_path.to_s)).split(".")
+      if parts.size > 2
+        parts[-2..-1].join(".")
+      else
+        File.extname(self.source_path.to_s).sub(/^\./, "")
+      end
+    end
+
+    # Try to figure out the mime type based on the Tilt class and if that doesn't
+    # work we try to infer the type by looking at extensions (needed for .erb)
+    def target_mime_type
+      mime = self.template.class.default_mime_type
+      return mime if mime
+
+      path = File.basename(self.source_path.to_s)
+      mime = MIME::Types.type_for(path).first
+      return mime.to_s if mime
+
+      parts = File.basename(path).split(".")
+      if parts.size > 2
+        mime = MIME::Types.type_for(parts[0..-2].join(".")).first
+        return mime.to_s if mime
+      else
+        nil
+      end
+    end
+    
+    protected
+
+    # 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
+      
+      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
+        return [{}, source]
+      end
+
+      [data, source]
+    rescue
+      [{}, source]
+    end
+    
+  end
+  
+  class TemplateContext
+    attr_accessor :_content_for_blocks
+
+    def initialize(template, env={})
+      @_template, @_env = template, @_content_for_blocks = {}, env
+    end
+    
+    # The current Roger::Template in use
+    def template
+      @_template
+    end
+
+    # Access to the front-matter of the document (if any)
+    def document
+      @_data ||= OpenStruct.new(self.template.data)
+    end
+    
+    # The current environment variables.
+    def env
+      @_env
+    end
+
+    # Capture content in blocks in the template for later use in the layout.
+    # Currently only works in ERB templates. Use like this in the template:
+    #
+    # ```
+    #   <% content_for :name %> bla bla <% end %>
+    # ```
+    #
+    # Place it like this in the layout:
+    #
+    # ```
+    #   <%= yield :name %>
+    # ```
+    def content_for(block_name, &capture)
+      raise ArgumentError, "content_for works only with ERB Templates" if !self.template.template.kind_of?(Tilt::ERBTemplate)
+      eval "@_erbout_tmp = _erbout", capture.binding
+      eval "_erbout = \"\"", capture.binding
+      t = Tilt::ERBTemplate.new(){ "<%= yield %>" }
+      @_content_for_blocks[block_name] = t.render(&capture)
+      return nil
+    ensure
+      eval "_erbout = @_erbout_tmp", capture.binding
+    end
+        
+    def partial(name, options = {})
+      if template_path = self.template.find_template(name, :partials_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)
+        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/lib/roger/w3c_validator.rb

@@ -0,0 +1,129 @@
+require 'cgi'
+require 'net/http'
+require 'uri'
+require 'yaml'
+
+module Roger
+  class W3CValidator
+  
+    ValidationUri = "http://validator.w3.org/check"
+    
+    class RequestError < StandardError; end
+  
+    attr_reader :valid,:response,:errors,:warnings,:status
+  
+    class << self
+      def validation_uri
+        @uri ||= URI.parse(ValidationUri)
+      end
+    end 
+  
+    def initialize(html)
+      @html = html
+    end
+  
+    def validate!
+      @status = @warnings = @errors = @response = @valid = nil
+      options = {"output" => "json"}
+      query,headers = build_post_query(options)
+      response =  self.request(:post,self.class.validation_uri.path,query,headers)
+      @status,@warnings,@errors = response["x-w3c-validator-status"],response["x-w3c-validator-warnings"].to_i,response["x-w3c-validator-errors"].to_i
+    
+      if @status == "Valid" && @warnings == 0 && @errors == 0
+        return @valid = true
+      else
+        begin
+          @response = YAML.load(response.body)
+        rescue 
+        end
+        return (@valid = (@errros == 0))
+      end
+    
+    end
+  
+    protected
+  
+    def build_post_query(options)
+      boundary = "validate-this-content-please"
+      headers = {"Content-type" => "multipart/form-data, boundary=" + boundary + " "}
+    
+      parts = []
+      options.each do |k,v|
+        parts << post_param(k,v)
+      end
+      parts << file_param("uploaded_file","index.html",@html,"text/html")
+    
+      q = parts.map{|p| "--#{boundary}\r\n#{p}"}.join("") + "--#{boundary}--"
+      [q,headers]
+    end
+  
+    def post_param(k,v)
+      "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"\r\n\r\n#{v}\r\n"
+    end
+  
+    def file_param(k,filename,content,mime_type)
+      out = []
+      out << "Content-Disposition: form-data; name=\"#{CGI::escape(k)}\"; filename=\"#{filename}\""
+      out << "Content-Transfer-Encoding: binary"
+      out << "Content-Type: #{mime_type}"
+      out.join("\r\n") + "\r\n\r\n" + content + "\r\n"
+    end
+    
+    # Makes request to remote service.
+    def request(method, path, *arguments)
+      perform_request(method, path, arguments, 3)
+    end
+    
+    def perform_request(method, path, arguments, tries=3)
+      result = nil
+      result = http.send(method, path, *arguments)
+      handle_response(result)
+    rescue RequestError => e
+      if tries > 0
+        perform_request(method, path, arguments, tries-1)
+      else
+        raise
+      end
+    rescue Timeout::Error => e
+      raise       
+    end
+  
+    # Handles response and error codes from remote service.
+    def handle_response(response)
+      case response.code.to_i
+        when 301,302
+          raise "Redirect"
+        when 200...400
+          response
+        when 400
+          raise "Bad Request"
+        when 401
+          raise "Unauthorized Access"
+        when 403
+          raise "Forbidden Access"
+        when 404
+          raise "Rescoure not found"
+        when 405
+          raise "Method not allowed"
+        when 409
+          raise RequestError.new("Rescource conflict")
+        when 422
+          raise RequestError.new("Resource invalid")
+        when 401...500
+          raise "Client error"
+        when 500...600
+          raise RequestError.new("Server error")
+        else
+          raise "Unknown response: #{response.code.to_i}"
+      end
+    end
+        
+    def http
+      site = self.class.validation_uri
+      http = Net::HTTP.new(site.host, site.port)
+  #    http.use_ssl = site.is_a?(URI::HTTPS)
+  #    http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http.use_ssl
+      http
+    end      
+  end
+end

data/roger.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "roger"
+  s.version = "0.10.0"
+  
+  s.authors = ["Flurin Egger", "Edwin van der Graaf", "Joran Kapteijns"]
+  s.email = ["info@digitpaint.nl", "flurin@digitpaint.nl"]  
+  s.homepage = "http://github.com/digitpaint/roger"
+  s.summary = "Roger is a set of tools to create self-containing HTML mockups."
+  s.licenses = ["MIT"]
+
+  s.date = Time.now.strftime("%Y-%m-%d")
+  
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]  
+  
+  s.extra_rdoc_files = [
+    "README.md"
+  ] + `git ls-files -- {doc}/*`.split("\n")
+  
+  s.rdoc_options = ["--charset=UTF-8"]
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.add_dependency("thor", ["~> 0.16.0"])
+  s.add_dependency("rack", [">= 1.0.0"])
+  s.add_dependency("tilt", ["~> 2.0.1"])
+  s.add_dependency("mime-types", ["~> 2.2"])
+  s.add_dependency("hpricot", [">= 0.6.4"])
+
+  s.add_development_dependency("test-unit", "~> 2.5.5")
+end

data/test/Mockupfile-syntax.rb

@@ -0,0 +1,85 @@
+# Example idea for a Mockupfile, a lot of this has to have a sensible default.
+
+Sass::Plugin.options[:style] = :expanded
+Sass::Plugin.options[:template_location] = "./html/stylesheets"
+Sass::Plugin.options[:css_location] = "./html/stylesheets"
+
+# These are defaults, but can be set here
+# mockup.project.html_path = mockup.project.path + "html"
+# mockup.project.partial_path = mockup.project.path + "partials"
+
+mockup.serve(config) do |server|
+  server.use :sass
+end
+
+mockup.release(config) do |release|
+  
+  release.target_path # The target path where releases are put
+  release.build_path # The path where the release gets built
+  release.source_path # The source for this mockup
+  
+  # Extract mockup
+  # Pass custom config to the extractor, this is optional
+  # release.extract :url_attributes =>  %w{src href action data-main}
+  
+  # Get git version
+  release.scm.previous # Get the previous version SCM op (looks for tags)
+  release.scm.version # Get the git version
+  release.scm.date # Get the git date
+    
+  # Create custom banner
+  release.banner do
+    "bla bla bla"
+  end
+  
+  # The default banner looks like this:
+  #
+  # =======================
+  # = Version : v1.0.0    =
+  # = Date : 2012-06-20   =
+  # =======================  
+  
+  # Sassify CSS (this are the defaults too), all options except form :match and :skip are passed to Sass.compile_file
+  # release.use :sass, :match => ["stylesheets/**/*.scss"], :skip => [/_.*\.scss\Z/], :style => :expanded
+  # The previous statement is the same as:
+  release.use :sass
+  
+  # Run requirejs optimizer
+  # release.use :requirejs, {
+  #     :build_files => {"javascripts/site.build.js" => "javascripts"},
+  #     :rjs => release.source_path + "../vendor/requirejs/r.js",
+  #     :node => "node"
+  #   }
+  release.use :requirejs
+    
+  # Minify, will not minify anything above the :delimiter
+  # release.use :yuicompressor, {
+  #   :match => ["**/*.{css,js}"],
+  #   :skip =>  [/javascripts\/vendor\/.*\.js\Z/, /_doc\/.*/],
+  #   :delimiter => Regexp.escape("/* -------------------------------------------------------------------------------- */")
+  # }
+  # The previous statement is the same as:
+  release.use :yuicompressor
+  
+  
+  # Inject VERSION / DATE (i.e. in TOC)
+  r.inject({"[VERSION]" => release.scm.version, "[DATE]" => release.scm.date.strftime("%Y-%m-%d")}, :into => %w{_doc/toc.html})
+  
+  # Inject Banners on everything matching the regexp in all .css files
+  # The banner will be commented as CSS.
+  release.inject({ /\/\*\s*\[BANNER\]\s*\*\// => r.banner(:comment => :css)}, :into => %w{**/*.css})
+  
+  # Inject CHANGELOG
+  release.inject({"[CHANGELOG]" => {:file => "../CHANGELOG", :processor => 'md'}}, :into => %w{_doc/changelog.html})  
+  
+  # Inject NOTES
+  release.inject({"[NOTES]" => {:file => "../NOTES.md", :processor => 'md'}}, :into => %w{_doc/notes.html})    
+  
+  # Cleanup on the build
+  release.cleanup "**/.DS_Store"  
+  
+  # Finalize the release
+  # This is the default finalizer so not required
+  # release.finalize :dir
+    
+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,7 @@
+source "https://rubygems.org"
+
+gem "roger", :path => File.dirname(__FILE__) + "/../../"
+gem "sass"
+gem "yui-compressor"
+gem "redcarpet"
+gem "pry"

data/test/project/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: /Users/flurin/Projects.local/libraries/roger
+  specs:
+    roger (0.10.0)
+      hpricot (>= 0.6.4)
+      mime-types (~> 2.2)
+      rack (>= 1.0.0)
+      thor (~> 0.16.0)
+      tilt (~> 2.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    hpricot (0.8.6)
+    method_source (0.8.2)
+    mime-types (2.2)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    redcarpet (3.1.1)
+    sass (3.3.5)
+    slop (3.5.0)
+    thor (0.16.0)
+    tilt (2.0.1)
+    yui-compressor (0.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  redcarpet
+  roger!
+  sass
+  yui-compressor

data/test/project/Mockupfile

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + "/lib/generators/test"
+
+mockup.project.options[:verbose] = true;
+
+mockup.project.partial_path = [mockup.project.path + "partials", mockup.project.path + "partials2"]
+
+mockup.serve do |s|
+end
+
+mockup.release do |r|
+  r.use :mockup
+  r.use :url_relativizer, :skip => [/non-relative.*/]
+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/index.html

@@ -0,0 +1 @@
+Just an index.html

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/content-for.html.erb

@@ -0,0 +1,17 @@
+---
+layout : "test"
+title : "Content for"
+---
+Normal Yield
+
+<% content_for :one do %>
+  Yield for one <%= "bla" %>
+<% end %>
+
+And more normal stuff
+
+<% content_for :two do %>
+  Yield for two <%= "bla" %>
+<% end %>
+
+And the end of the normal stuff

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/mockup/encoding.html

@@ -0,0 +1,3 @@
+Some special characterrrs
+
+éᙀ

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/load_path.html.erb

@@ -0,0 +1,3 @@
+<%= partial "partials-test" %>
+
+<%= partial "partials2-test" %>

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/html/static/non-relative.html.erb

@@ -0,0 +1,9 @@
+<h1>Links should not be made relative</h1>
+
+<p>
+  <a href="/static/non-relative.html">/test</a>
+  <img src="/static/non-relative.html">
+  <form action="/static/non-relative.html">
+    Form
+  </form>
+</p>

data/test/project/html/static/relative.html.erb

@@ -0,0 +1,9 @@
+<h1>Links should be made relative</h1>
+
+<p>
+  <a href="/static/relative.html">/test</a>
+  <img src="/static/relative.html">
+  <form action="/static/relative.html">
+    Form
+  </form>
+</p>