html_mockup 0.6.3 → 0.6.4

data/.gitignore

@@ -0,0 +1,2 @@
+doc/*
+pkg/*

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+## 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/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/Rakefile

@@ -0,0 +1,4 @@
+task :test do
+  ruby "test/unit/release/processors/require_js_test.rb"
+  ruby "test/unit/release/cleaner_test.rb"
+end

data/html_mockup.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "html_mockup"
+  s.version = "0.6.4"
+  
+  s.authors = ["Flurin Egger", "Edwin van der Graaf"]
+  s.email = ["info@digitpaint.nl", "flurin@digitpaint.nl"]  
+  s.homepage = "http://github.com/digitpaint/html_mockup"
+  s.summary = "HTML Mockup 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.rdoc"
+  ]  
+  
+  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", [">= 0"])
+end

data/lib/html_mockup/release/finalizers/dir.rb

@@ -1,10 +1,11 @@
 require 'fileutils'
 
-# Finalizes the release into a directory in target_path
-# 
-# The directory name will have the format PREFIX-VERSION
-#
 module HtmlMockup::Release::Finalizers
+  
+  # Finalizes the release into a directory in target_path
+  # 
+  # The directory name will have the format PREFIX-VERSION
+  #  
   class Dir < Base    
     # @option options :prefix Prefix to put before the version (default = "html")
     def call(release, options = {})

data/lib/html_mockup/release/finalizers/rsync.rb

@@ -0,0 +1,70 @@
+require 'shellwords'
+
+module HtmlMockup::Release::Finalizers
+  
+  # Finalizes the release by uploading your mockup with rsync to a remote server
+  # 
+  # @see RsyncFinalizer#initialize for options
+  #
+  class Rsync < Base
+  
+    # @param Hash options The options
+    #
+    # @option options String :rsync The Rsync command to run (default is "rsync")
+    # @option options String :remote_path The remote path to upload to
+    # @option options String :host The remote host to upload to
+    # @option options String :username The remote username to upload to
+    def initialize(options = {})
+      @options = {
+        :rsync => "rsync",
+        :remote_path => "",
+        :host => "",
+        :username  => ""
+      }.update(options)
+    end
+  
+    def call(release, options = {})
+      options = @options.dup.update(options)
+    
+      # Validate options
+      validate_options!(release, options)
+    
+      begin
+        `#{@options[:rsync]} --version`
+      rescue Errno::ENOENT
+        raise RuntimeError, "Could not find rsync in #{@options[:rsync].inspect}"
+      end    
+    
+
+      local_path = release.build_path.to_s
+      remote_path = options[:remote_path]
+    
+      local_path += "/" unless local_path =~ /\/\Z/
+      remote_path += "/" unless remote_path =~ /\/\Z/    
+
+      release.log(self, "Starting upload of #{(release.build_path + "*")} to #{options[:host]}")
+    
+      command = "#{options[:rsync]} -az #{Shellwords.escape(local_path)} #{Shellwords.escape(options[:username])}@#{Shellwords.escape(options[:host])}:#{Shellwords.escape(remote_path)}"
+    
+      # Run r.js optimizer
+      output = `#{command}`
+        
+      # Check if r.js succeeded
+      unless $?.success?
+        raise RuntimeError, "Rsync failed.\noutput:\n #{output}"
+      end
+        
+    end
+  
+    protected
+  
+    def validate_options!(release, options)
+      must_have_keys = [:remote_path, :host, :username]
+      if (options.keys & must_have_keys).size != must_have_keys.size
+        release.log(self, "You must specify these options: #{(must_have_keys - options.keys).inspect}")
+        raise "Missing keys: #{(must_have_keys - options.keys).inspect}"
+      end
+    end
+  
+  end
+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/generator-subcommand.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+
+# This testfile is just a small testcase on how
+# to do something with nested generators. It's
+# just some basics and needs to be explored further.
+
+# What we need for/from a generator:
+# - It needs to be registered in our Generators::Generate class
+# - It needs to be automatically loaded from:
+#    - The mockup: <root>/generators/<name>/<name>_generator.rb
+#    - The gem
+#    - Other gems which have been manually required (?)
+# - It needs to have access to the current Mockup::Project instance
+# - It needs to have the following file structure:
+#    - <name>
+#      - <name>_generator.rb
+#      - ...support files...
+
+require 'rubygems'
+require 'thor'
+require 'thor/group'
+
+
+module Generators
+  class Generate < Thor
+  end
+
+  class GeneratorBase < Thor::Group
+    def self.inherited(sub)
+      name = sub.to_s.sub(/Generator$/, "").sub(/^Generators::/,"").downcase
+      Generate.register sub, name, name, "Run #{name}"
+    end
+  end
+
+  class ThingGenerator < GeneratorBase
+    def done
+      puts "Yep, done the thing"
+    end
+  end
+
+  class BlingGenerator < GeneratorBase
+    def done
+      puts "Here is some bling!"
+    end
+  end
+end
+
+module CLI
+  class Base < Thor  
+    register Generators::Generate, "generate", "generate [COMMAND]", "Run a generator"
+  end
+end
+
+CLI::Base.start

data/test/unit/release/cleaner_test.rb

@@ -0,0 +1,42 @@
+require "./lib/html_mockup/release.rb"
+require "./lib/html_mockup/release/cleaner.rb"
+require "test/unit"
+
+class CleanerTest < Test::Unit::TestCase
+
+  def test_only_clean_inside_build_path_relative
+    path = "processors"
+    cleaner = HtmlMockup::Release::Cleaner.new(path)
+    inside_build_path = cleaner.send :is_inside_build_path, File.dirname(__FILE__), path
+
+    assert(inside_build_path, "Only delete content inside build_path")
+  end  
+
+  def test_only_clean_inside_build_path_absolute
+    path = Pathname.new(File.dirname(__FILE__) + "/processors").realpath.to_s
+    cleaner = HtmlMockup::Release::Cleaner.new(path)
+    inside_build_path = cleaner.send :is_inside_build_path, File.dirname(__FILE__), path
+
+    assert(inside_build_path, "Only delete content inside build_path")
+  end  
+
+  
+  def test_dont_clean_outside_build_path
+    path = "../../../lib"
+    cleaner = HtmlMockup::Release::Cleaner.new(path)
+
+    assert_raise RuntimeError do
+      inside_build_path = cleaner.send :is_inside_build_path, File.dirname(__FILE__), path
+    end
+
+  end
+  
+  def test_dont_fail_on_nonexistent_files
+    path = "bla"
+    cleaner = HtmlMockup::Release::Cleaner.new(path)
+
+    assert !cleaner.send(:is_inside_build_path, File.dirname(__FILE__), path), "Failed on nonexistent directories/files"
+
+  end  
+
+end

data/test/unit/release/processors/require_js_test.rb

@@ -0,0 +1,62 @@
+require "./lib/html_mockup/release.rb" 
+require "./lib/html_mockup/release/processors/requirejs"
+require "test/unit"
+
+class RequireJsTest < Test::Unit::TestCase
+
+  def test_require_js_default_fallback
+    # When the user points the requirejs processer to a wrong file
+    # it should throw an RunTimeError
+    options = {:rjs => "s.js"}
+    requirejs_processor = HtmlMockup::Release::Processors::Requirejs.new(options)
+    rjs = options[:rjs]
+
+    rjs_command = ''
+
+    assert_raise RuntimeError do
+      # The file does is there - it's this one, so it should raise
+      rjs_command = requirejs_processor.rjs_check
+    end
+
+    # No command string is returned
+    assert_equal rjs_command, ""
+    
+  end
+  
+  def test_require_js_bin
+    # When no default require.js path is given we expect it to be r.js availble in $PATH
+    requirejs_processor = HtmlMockup::Release::Processors::Requirejs.new
+    rjs = "r.js" # Default r.js by npm
+
+    begin
+      `#{rjs} -v`
+    rescue Errno::ENOENT
+      assert_raise RuntimeError do
+        requirejs_processor.rjs_check
+      end
+    else
+      assert_equal requirejs_processor.rjs_check, rjs
+    end
+    
+  end
+  
+  def test_require_js_lib
+    # Just point options[:rjs] to a file to look if its there,
+    # the user is expected to point to a correct r.js file if he
+    # doesn't want to use the r.js shipped with npm
+    options = {:rjs => __FILE__}
+    requirejs_processor = HtmlMockup::Release::Processors::Requirejs.new(options)
+    rjs = options[:rjs]
+
+    rjs_command = ''
+
+    assert_nothing_raised RuntimeError do
+      # The file  is there - it's this one in fact, so it shouldn't raise
+      rjs_command = requirejs_processor.rjs_check
+    end
+
+    assert_equal rjs_command, "node #{rjs}"
+    
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: html_mockup
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-23 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70100536874920 !ruby/object:Gem::Requirement
+  requirement: &70163962703500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 0.16.0
   type: :runtime
   prerelease: false
-  version_requirements: *70100536874920
+  version_requirements: *70163962703500
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70100536873660 !ruby/object:Gem::Requirement
+  requirement: &70163962703020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70100536873660
+  version_requirements: *70163962703020
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70100536872460 !ruby/object:Gem::Requirement
+  requirement: &70163962702540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,15 +44,22 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70100536872460
+  version_requirements: *70163962702540
 description: 
-email: flurin@digitpaint.nl
+email:
+- info@digitpaint.nl
+- flurin@digitpaint.nl
 executables:
 - mockup
 extensions: []
 extra_rdoc_files:
 - README.rdoc
 files:
+- .gitignore
+- CHANGELOG.md
+- MIT_LICENSE
+- README.rdoc
+- Rakefile
 - bin/mockup
 - examples/default_template/.gitignore
 - examples/default_template/CHANGELOG
@@ -60,6 +67,7 @@ files:
 - examples/default_template/Mockupfile
 - examples/default_template/html/.empty_directory
 - examples/default_template/partials/.empty_directory
+- html_mockup.gemspec
 - lib/html_mockup/cli.rb
 - lib/html_mockup/extractor.rb
 - lib/html_mockup/generators.rb
@@ -73,6 +81,7 @@ 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/rsync.rb
 - lib/html_mockup/release/finalizers/zip.rb
 - lib/html_mockup/release/injector.rb
 - lib/html_mockup/release/processors.rb
@@ -84,7 +93,10 @@ files:
 - lib/html_mockup/server.rb
 - lib/html_mockup/template.rb
 - lib/html_mockup/w3c_validator.rb
-- README.rdoc
+- test/Mockupfile-syntax.rb
+- test/generator-subcommand.rb
+- test/unit/release/cleaner_test.rb
+- test/unit/release/processors/require_js_test.rb
 homepage: http://github.com/digitpaint/html_mockup
 licenses:
 - MIT
@@ -111,4 +123,8 @@ rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: HTML Mockup is a set of tools to create self-containing HTML mockups.
-test_files: []
+test_files:
+- test/Mockupfile-syntax.rb
+- test/generator-subcommand.rb
+- test/unit/release/cleaner_test.rb
+- test/unit/release/processors/require_js_test.rb