html_mockup 0.8.4 → 0.9.0

data/.gitignore

@@ -1,2 +1,2 @@
-doc/*
-pkg/*
+pkg/*
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - rbx-2
+  - jruby
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+    - rvm: jruby
+  fast_finish: true

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## Version 0.9.0
+* More documentation!
+* More tests! (and CI!)
+* Thor and Tilt updates
+* Add possibility to load external generators from gems (with the `HtmlMockup::Generators::Base.register` method)
+* Partials now automatically prefer templates of the same extension as the parent
+* ERB Templates now support `content_for(:name) do ... end` blocks which can be yielded by `:name` in the layout
+* Multiple load paths for partials are now supported
+* Minor changes and fixes
+* First preparations for version 1.0.0. which will be called **Roger**
+
 ## Version 0.8.4
 * Fix requirejs processor to clean up the correct paths
 * Allow typing of Y to rsync instead of full "yes"

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec :name => "html_mockup"
+
+gem "rake"

data/README.md

@@ -0,0 +1,95 @@
+# HtmlMockup
+
+[![Gem Version](https://badge.fury.io/rb/html_mockup.png)](http://badge.fury.io/rb/html_mockup)
+[![Build Status](https://travis-ci.org/DigitPaint/html_mockup.png?branch=master)](https://travis-ci.org/DigitPaint/html_mockup)
+
+## What is it?
+
+HtmlMockup is your friendly front-end development toolbox! It helps you with these 4 things:
+
+1. **Generate** : Set up your projects
+1. **Serve** : Development server
+1. **Test** : Test/lint your stuff
+1. **Release** : Release your code
+
+## Get started
+
+We assume you have a working Ruby 1.9.x or higher running.
+
+1. Install HtmlMockup
+
+    ```shell
+    gem install html_mockup
+    ```
+
+1. Create a new project
+
+    ```shell
+    mockup generate new PROJECT_DIR
+    ```
+
+    Replace `PROJECT_DIR` with your project name
+
+1. Start the development server
+
+    ```shell
+    mockup serve
+    ```
+
+    Open your webbrowser and go to `http://localhost:9000/`
+
+1. Release your project
+
+    ```shell
+    mockup release
+    ```
+
+## Where to go from here?
+
+Read more documentation:
+
+* [**Templating** Learn the power of HtmlMockup built in templating](doc/templating.md)
+* [**CLI** Learn about the different `mockup` commands](doc/cli.md)
+* [**Mockupfile** Learn how to configure and extend your Project](doc/mockupfile.md)
+
+## Why?
+
+When we started with HtmlMockup there was no Grunt/Gulp/whatever and with us being a Ruby shop we wrote HtmlMockup. Since its beginning it has evolved into quite a powerful tool. 
+
+Why would HtmlMockup be better than any other?
+It's not it just does some things differently.
+
+* Ruby
+* Code over configuration
+* Based on little modules, simple to extend
+* Streams & files
+* 4 easy commands separate concerns
+
+## Contributors
+
+[View contributors](https://github.com/digitpaint/html_mockup/graphs/contributors)
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2014 Digitpaint
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,4 +1,9 @@
-task :test do
-  ruby "test/unit/release/processors/require_js_test.rb"
-  ruby "test/unit/release/cleaner_test.rb"
-end
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/unit/**/*_test.rb']
+  t.verbose = true
+end

data/bin/mockup

@@ -2,4 +2,4 @@
 
 require File.dirname(__FILE__) + "/../lib/html_mockup/cli"
 
-HtmlMockup::Cli.start
+HtmlMockup::Cli::Base.start

data/doc/cli.md

@@ -0,0 +1,46 @@
+# Command Line Interface
+
+The easiest way to get help is through the commandline by running 
+
+```shell
+mockup help
+```
+
+or to get help on a specific subcommand
+
+```shell
+mockup help [subcommand]
+```
+
+## Generate
+
+```shell
+mockup generate [generator] [options]
+```
+
+## Serve
+
+```shell
+mockup serve [options]
+```
+
+Starts a webserver (port 9000 by default)
+
+
+## Release
+
+```shell
+mockup release [options]
+```
+
+Releases the project
+
+## Global options
+
+All commands accept these options.
+
+```
+Options:
+  -v, [--verbose]  # Set's verbose output
+  -h, [--help]  # Help
+```

data/doc/mockupfile.md

@@ -0,0 +1,3 @@
+# Mockupfile
+
+The mockupfile is where all the project configuration for releasing, serving etc. happens.

data/doc/templating.md

@@ -0,0 +1,88 @@
+# Templating
+
+## Directories
+
+Before we get started, it's good to know that there are a couple of "special" folders within any HtmlMockup project. Don't worry, you can configure these; they're not hard-coded. The folders are:
+
+* **project-path** this is the main directory containing the Mockupfile and all other directories.
+* **html-path** this is the directory where all your HTML/CSS/Javascript will go (in subdirectories of course).
+* **partials-path** this is the directory where all partials reside.
+* **layouts-path** this is the directory where the layouts hang out.
+
+The default project tree looks like this:
+
+```
+project-path
+  |
+  |- html (html-path)
+  |
+  |- partials (partials-path)
+  |
+  \- layouts (layouts-path)
+```
+
+Only the html-path has to exist. The others are not required.
+
+## HTML
+
+The html-path is actually the root for all you front-end code. This is what will be served as the document-root with `mockup serve` and will be the base for a release when using `mockup release`.
+
+In the html-path you can put static files (images, documents, etc.) but also templates. Anything that the [Tilt Engine](https://github.com/rtomayko/tilt) can handle is ok. The only thing Mockup adds is handling for front-matter, layouts and partials. 
+
+## Front-matter
+
+Every template can optionally start with a bit of front-matter. Front-matter is defined as follows:
+
+```yaml
+---
+key: value
+---
+```
+
+Front-matter is parsed as YAML and can contain data to be used in the template, layout or partial. You can access
+these values in the templates (layouts and partials included) by using `document.KEY`.
+
+## Layouts
+
+Layouts are basically "wrap" templates. The layout will wrap around the rendered template. In the template front-matter you define what layout it should use by setting the `layout` key.
+
+### An example
+
+
+#### html/template.html.erb
+```erb
+---
+layout: default
+---
+Template
+```
+
+#### layouts/default.html.erb
+```erb
+Layout (before)
+<% yield %>
+Layout (after)
+```
+
+#### Results
+This would result in:
+
+```
+Layout (before)
+Template
+Layout (after)
+```
+
+## Partials
+
+Partials are little pieces of template that can be easily reused. You can access the partials throught the `partial("partialpath")` method. You can optionall pass variables to the partial by passing a ruby hash of options as a second parameter. This works like this:
+
+```ruby
+partial("path/to/partial/relative/to/partials-path", {:key => "value"})
+```
+
+In the partial these can be accessed as local variables. So for instance in you `test.html.erb` partial that would look like this:
+
+```erb
+<%= key %>
+```

data/html_mockup.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "html_mockup"
-  s.version = "0.8.4"
+  s.version = "0.9.0"
   
   s.authors = ["Flurin Egger", "Edwin van der Graaf", "Joran Kapteijns"]
   s.email = ["info@digitpaint.nl", "flurin@digitpaint.nl"]  
@@ -18,8 +18,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]  
   
   s.extra_rdoc_files = [
-    "README.rdoc"
-  ]  
+    "README.md"
+  ] + `git ls-files -- {doc}/*`.split("\n")
   
   s.rdoc_options = ["--charset=UTF-8"]
 
@@ -27,7 +27,11 @@ Gem::Specification.new do |s|
 
   s.add_dependency("thor", ["~> 0.16.0"])
   s.add_dependency("rack", [">= 1.0.0"])
-  s.add_dependency("tilt", ["~> 1.4.0"])
+  s.add_dependency("tilt", ["~> 2.0.1"])
+  s.add_dependency("mime-types", ["~> 2.2"])
   s.add_dependency("sass", [">= 0"])
+  s.add_dependency("yui-compressor", [">= 0"])
   s.add_dependency("hpricot", [">= 0.6.4"])
+
+  s.add_development_dependency("test-unit", "~> 2.5.5")
 end

data/lib/html_mockup/cli.rb

@@ -1,4 +1,11 @@
 require 'rubygems'
+
+# Require bundler gems if available
+if Object.const_defined?(:Bundler)
+  Bundler.require(:default)
+end
+
+
 require 'thor'
 require 'thor/group'
 
@@ -8,50 +15,55 @@ include FileUtils
 
 require File.dirname(__FILE__) + "/template"
 require File.dirname(__FILE__) + "/project"
-require File.dirname(__FILE__) + "/generators"
 require File.dirname(__FILE__) + "/w3c_validator"
 
+
 module HtmlMockup
-  class Cli < Thor
-    
-    class_option :verbose,
-      :desc =>  "Set's verbose output",
-      :aliases => ["-v"],
-      :default => false,
-      :type => :boolean
-    
-    desc "serve [directory]","Serve directory as HTML, defaults to current directory"
-    method_options :port => :string, # Defaults to 9000
-                   :html_path => :string, # The document root, defaults to "[directory]/html"
-                   :partial_path => :string, # Defaults to [directory]/partials
-                   :handler => :string, # The handler to use (defaults to mongrel)
-                   :validate => :boolean # Run validation?
-    def serve(path=".")
-      
-      server_options = {} 
-      options.each{|k,v| server_options[k.to_sym] = v }
-      server_options[:server] = {}
-      [:port, :handler, :validate].each do |k|
-        server_options[:server][k] = server_options.delete(k) if server_options.has_key?(k)
-      end
-      
-      # Load the project, it should take care of all the paths
-      @project = initialize_project(path, server_options)
-      
-      server = @project.server
-      server.set_options(server_options[:server])
-      
-      puts "Running HtmlMockup with #{server.handler.inspect} on port #{server.port}"
-      puts banner(@project) 
-      
-      server.run!
+  module Cli; end
+end
+
+require File.dirname(__FILE__) + "/cli/command"
+require File.dirname(__FILE__) + "/cli/serve"
+require File.dirname(__FILE__) + "/cli/release"
+require File.dirname(__FILE__) + "/cli/generate"
+
+require File.dirname(__FILE__) + "/generators"
+
+
+module HtmlMockup
+  class Cli::Base < Thor
+
+    def initialize(*args)
+      super
+      self.class.project = initialize_project
     end
-    
-    desc "release [directory]", "Create a release for the project"
-    def release(path=".")
-      project = initialize_project(path, options)
-      project.release.run!
+
+    class << self
+      attr_accessor :project
     end
+
+    class_option :path, 
+      :desc => "Project root path",
+      :type => :string, 
+      :required => false, 
+      :default => "."
+
+    class_option :html_path,
+      :desc => 'The document root, defaults to "[directory]/html"',
+      :type => :string
+
+
+    class_option :partial_path,
+      :desc => 'Defaults to [directory]/partials',
+      :type => :string
+    
+    register Cli::Generate, "generate", "generate [COMMAND]", "Run a generator"
+
+    register Cli::Serve, "serve", "serve #{Cli::Serve.arguments.map{ |arg| arg.banner }.join(" ")}", Cli::Serve.desc
+    self.tasks["serve"].options = Cli::Serve.class_options
+
+    register Cli::Release, "release", "release #{Cli::Release.arguments.map{ |arg| arg.banner }.join(" ")}", Cli::Release.desc
+    self.tasks["release"].options = Cli::Release.class_options
     
     desc "validate [directory/file]", "Validates the file or all HTML in directory"
     method_options :show_valid => :boolean, # Also print a line for each valid file
@@ -83,40 +95,19 @@ module HtmlMockup
       end      
     end
     
-    register HtmlMockup::Generators::New, "new", "new [directory]", ""
-    # Hack to register our options/description
-    tasks["new"].options = HtmlMockup::Generators::New.class_options
-    tasks["new"].description = HtmlMockup::Generators::New.desc
-    
-    desc "extract [source_path] [target_path]", "Extract a fully relative html mockup into target_path. It will expand all absolute href's, src's and action's into relative links if they are absolute"
-    method_options :partial_path => :string, # Defaults to [directory]/partials
-                   :filter => :string # What files should be converted defaults to **/*.html
-    def extract(source_path=".", target_path="../out")
-      project = initialize_project(source_path)
-      extractor = HtmlMockup::Extractor.new(project, target_path)
-      puts "Extracting mockup"
-      puts banner(project)
-      extractor.run!
-    end
-    
     protected
-    
-    def banner(project)
-      puts "  Html: \"#{project.html_path}\""
-      puts "  Partials: \"#{project.partial_path}\""
-    end
-    
+
     # TODO: handle options
-    def initialize_project(path, options={})
-      
-      if((Pathname.new(path) + "../partials").exist?)
+    def initialize_project
+      if((Pathname.new(options[:path]) + "../partials").exist?)
         puts "[ERROR]: Don't use the \"html\" path, use the project base path instead"
         exit(1)
       end
       
-      Project.new(path, {:shell => self.shell}.update(options))
+      Project.new(options[:path], {:shell => self.shell}.update(options))
     end
 
+    
     def w3cvalidate(file)
       validator = W3CValidator.new(File.read(file))
       validator.validate!  
@@ -128,4 +119,5 @@ module HtmlMockup
     end
  
   end
+
 end