roger 0.0.1 → 0.10.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    M2FhYzgyZDQ3NDY5NjI2ODgxMDViMThkMDAxMWM3NTM5MjY4YThjMw==
+    MDYwN2JiYWE4N2QzYjdkYzhjNTRiYWQ3NTdkMWU3OGU4NWI0MTIxMg==
   data.tar.gz: !binary |-
-    Y2YxYWE1MTcxN2FjOTI4NDNjZDQzNTljN2IwNzc1M2I3Yzc1NDA3Yg==
+    YzZjMjM2MjcyY2U5ODBhMTk5MDBiNTQ3OGFjODNlNGVmZWM2ZmZlMA==
 SHA512:
   metadata.gz: !binary |-
-    MDQyODc0ZGRmMTQ3OWEyZDNlNDc5NDBlZTVkYTFlYTBmZjZmMzAwZWI3OGE3
-    Y2JlYjU3OWI5ZTFjODg3YTFiMmVmNWJlMWQ4ZjY0ZDEwODM5MWU2Yjg3YzVj
-    NTJiNjA3NGM5MTNmNzc2MjFkZjQ3ODU5N2UzNWIxZWZhYjQ1Yjg=
+    ZTM3NmYzNjkyNTIzZmUzMzI1OGZlOTQ2M2JkZDNkMjg1MWE5ODQ5Mjk4MGI3
+    ZTQ1ZTUyNzY4OGJiNzM5ZTQwNDk4OTAxMDIxNzIxMjJlOGFkN2E4YjMzNGQy
+    YmRhZjUxODk1Mzc3MmM1N2I5ZjJjYjVlNTI5MTIxNzhjYjBkZWY=
   data.tar.gz: !binary |-
-    MDYwMDM3ZTVjMzM2MTE0OWIwMmQ5YjI5MTE1ZDU4YmY2MmQ5ZmMxNDY1NDc1
-    NDg5ZWQ2ZGFkY2U5NTM2MGMyNzljMzBhMmZiMDkxNDVkMTdhMTdlOTcyYmE3
-    ZDE1M2RkMmZhNDM3NDJmNzE1MjhkNDgyY2I5NjA5ZGRmMWNlMGQ=
+    YTA2OGU2NDg0MTFjMWI4ZWU2YzNiZmU2NzE1ZjhlOTk0MTQ5ZTNmMGY3Nzg0
+    MTY2ZGMxMzJmODQ0Y2M2MzhlODQyMGY2YTUxMTQ0NWQ2MjkzMjEwYThlYzRh
+    MzMyMzc1Y2Q4Zjc3OGVhNWU3OTYwODgwODk1NWQxN2UyZmQ5ZGY=

data/.gitignore

@@ -0,0 +1,2 @@
+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

@@ -0,0 +1,102 @@
+# Changelog
+
+## Version 0.10.0
+* Welcome **Roger**
+* Removed requirejs, sass and yuicompressor processors in favour of separate gems
+* Removed legacy templates using `<!-- [START:...] -->` partials (still available in separate gem)
+
+## Version 0.9.0
+* More documentation!
+* More tests! (and CI!)
+* Thor and Tilt updates
+* Add possibility to load external generators from gems (with the `Roger::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"
+
+## Version 0.8.3
+* Make the url relativizer respect :skip parameter
+
+## Version 0.8.2
+* If bundler is installed we're running Bundler.require automatically.
+
+## Version 0.8.1
+* Don't crash on non-existent partials/layouts path
+* Add more logging in verbose mode when extracting mockup
+* Fix the passing of env options to mockup release processor
+
+## Version 0.8.0
+* Set content type header in response when rendering templates
+* Add option to prompt user before performing rsync finalizer (defaults to true)
+* Fix zip finalizer to use options[:zip] in actuall executed command too
+* Logger now outputs color and has support for warning messages
+* Mockup templating is now fully handled with Tilt
+* Mockup extraction and URL relativization etc. for release are now done in their respective processors (will be added automatically if you haven't added them yourself.) This gives a fine-grained control over the point in time when these processors are ran.
+* Add a testproject to the repository
+* Add support for layouts
+* Add a `git_branch` finalizer that allows us to release to a branch on a repository (this makes it easy to release github pages)
+* Allow requirejs processor to work wih single files as well
+* Expose server options to mockup so you can configure a https server if you want
+* Minor fixes
+
+## Version 0.7.4
+* Allow for underscores in .scss files when releasing
+
+## Version 0.7.3
+* Set a sensible `load_path` for sass in release mode (defaults to `build_path + "stylesheets"`)
+* Also automatically require the rsync finalizers
+
+## Version 0.7.2
+* Add zip finalizers
+* Instead of complaining about existing build path, just clean it up
+* Instead of complaining about unexisting target path, just create it
+* Automatically require all built-in procssors
+
+## Version 0.7.1
+* Pass target_file to the ERBTemplate to files with erb errors
+* Fix env["MOCKUP_PROJECT"] setting in extractor
+
+## 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
+
+## Version 0.6.4
+* Add RsyncFinalizer to automatically upload your mockup
+
+## Version 0.6.3
+* Add license to gemspec
+* Fix default_template in gem
+* Add option to allow for resolving urls in custom attributes in the extractor (via `release.extract(options_hash)`)
+* Add more unified interface to finalizers and processors
+* Fix error if node can't be found in Processors::Requirejs
+
+## Version 0.6.2
+* Improved cleaner with more robust tests
+
+## Version 0.6.1
+* Correctly pass file and linenumber to Mockupfile evaluation
+* Add the tilt gem as a requirement (needed for injectors in release)
+* Make the cleaner also remove directories, also make it more safe (it will never delete stuff above the build_path)
+
+## Version 0.6.0
+* Pass command line options to underlying objets
+* Update docs
+* The different Processors, injections and cleanups are run in order as specified. Finalizers will always be run last in their own order.
+* Replace CLI "generate" command with "new" subcommand and add support for remote git skeletons based on Thor templating.
+* Add most simple mockup directory as default_template
+* Requirejs processor updated so it will search for a global r.js command, a local npm r.js command and a vendored r.js command
+* Minor fixes and changes

data/Gemfile

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

data/MIT_LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Flurin Egger, DigitPaint (http://www.digitpaint.nl)
+ 
+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/README.md

@@ -1,11 +1,11 @@
-# HtmlMockup
+# Roger
 
-[![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)
+[![Gem Version](https://badge.fury.io/rb/roger.png)](http://badge.fury.io/rb/roger)
+[![Build Status](https://travis-ci.org/DigitPaint/roger.png?branch=master)](https://travis-ci.org/DigitPaint/roger)
 
 ## What is it?
 
-HtmlMockup is your friendly front-end development toolbox! It helps you with these 4 things:
+Roger is your friendly front-end development toolbox! It helps you with these 4 things:
 
 1. **Generate** : Set up your projects
 1. **Serve** : Development server
@@ -16,10 +16,10 @@ HtmlMockup is your friendly front-end development toolbox! It helps you with the
 
 We assume you have a working Ruby 1.9.x or higher running.
 
-1. Install HtmlMockup
+1. Install Roger
 
     ```shell
-    gem install html_mockup
+    gem install roger
     ```
 
 1. Create a new project
@@ -48,15 +48,15 @@ We assume you have a working Ruby 1.9.x or higher running.
 
 Read more documentation:
 
-* [**Templating** Learn the power of HtmlMockup built in templating](doc/templating.md)
+* [**Templating** Learn the power of Roger 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. 
+When we started with Roger there was no Grunt/Gulp/whatever and with us being a Ruby shop we wrote Roger. Since its beginning it has evolved into quite a powerful tool. 
 
-Why would HtmlMockup be better than any other?
+Why would Roger be better than any other?
 It's not it just does some things differently.
 
 * Ruby
@@ -67,7 +67,7 @@ It's not it just does some things differently.
 
 ## Contributors
 
-[View contributors](https://github.com/digitpaint/html_mockup/graphs/contributors)
+[View contributors](https://github.com/digitpaint/roger/graphs/contributors)
 
 ## License
 

data/Rakefile

@@ -0,0 +1,9 @@
+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/roger

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + "/../lib/roger/cli"
+
+Roger::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 Roger 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/examples/default_template/.gitignore

@@ -0,0 +1,2 @@
+# Ignore apple specific files
+.DS_Store

data/examples/default_template/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gem "roger"

data/examples/default_template/Mockupfile

@@ -0,0 +1 @@
+# Configure your mockup here

data/lib/roger/cli/command.rb

@@ -0,0 +1,23 @@
+module Roger
+
+  class Cli::Command < Thor::Group
+
+    class_option :verbose,
+      :desc =>  "Set's verbose output",
+      :aliases => ["-v"],
+      :default => false,
+      :type => :boolean
+
+    def initialize_project
+      @project = Cli::Base.project
+    end
+
+    protected
+
+    def project_banner(project)
+      puts "  Html: \"#{project.html_path}\""
+      puts "  Partials: \"#{project.partial_path}\""
+    end
+  end
+
+end

data/lib/roger/cli/generate.rb

@@ -0,0 +1,5 @@
+module Roger
+  class Cli::Generate < Thor
+
+  end
+end

data/lib/roger/cli/release.rb

@@ -0,0 +1,10 @@
+module Roger
+  class Cli::Release < Cli::Command
+
+    desc "Release the current project"
+
+    def release
+      @project.release.run!
+    end
+  end
+end

data/lib/roger/cli/serve.rb

@@ -0,0 +1,29 @@
+module Roger
+  class Cli::Serve < Cli::Command
+
+
+    desc "Serve the current project"
+
+    class_options :port => :string, # Defaults to 9000
+                   :handler => :string, # The handler to use (defaults to mongrel)
+                   :validate => :boolean # Run validation?
+
+    def serve
+      
+      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
+      
+      server = @project.server
+      server.set_options(server_options[:server])
+      
+      puts "Running Roger with #{server.handler.inspect} on port #{server.port}"
+      puts project_banner(@project) 
+      
+      server.run!
+    end
+  end
+end

data/lib/roger/cli.rb

@@ -0,0 +1,123 @@
+require 'rubygems'
+
+# Require bundler gems if available
+if Object.const_defined?(:Bundler)
+  Bundler.require(:default)
+end
+
+
+require 'thor'
+require 'thor/group'
+
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+require File.dirname(__FILE__) + "/template"
+require File.dirname(__FILE__) + "/project"
+require File.dirname(__FILE__) + "/w3c_validator"
+
+
+module Roger
+  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 Roger
+  class Cli::Base < Thor
+
+    def initialize(*args)
+      super
+      self.class.project = initialize_project
+    end
+
+    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
+                   :filter => :string # What files should be found, defaults to [^_]*.html
+    def validate(path=".")
+      filter = options["filter"] || "[^_]*.html"
+      
+      puts "Filtering on #{options["filter"]}" if options["filter"]
+      
+      if File.directory?(path)
+        any_invalid = false
+        
+        if (files = Dir.glob("#{path}/**/#{filter}")).any?
+        	files.each do |file|
+        		if !self.w3cvalidate(file)
+        		  any_invalid = true
+        	  end
+        	end
+        	if !any_invalid
+        	  puts "All files were considered valid"
+          end
+        else
+          puts "No files matched \"#{filter}\""
+        end
+      elsif File.readable?(path)
+        self.w3cvalidate(path)
+      else
+        puts "No such file/directory #{path}"
+      end      
+    end
+    
+    protected
+
+    # TODO: handle options
+    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(options[:path], {:shell => self.shell}.update(options))
+    end
+
+    
+    def w3cvalidate(file)
+      validator = W3CValidator.new(File.read(file))
+      validator.validate!  
+      if !options["show_valid"] && !validator.valid || options["show_valid"]
+        print "- #{file} "    
+        print "(errors: #{validator.errors}, warnings: #{validator.warnings})\n"
+      end
+      validator.valid
+    end
+ 
+  end
+
+end