utilikilt 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+vendor/bundle/
+pkg/

data/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,25 @@
+# Get Going!
+install the dependencies you need with:
+```
+bundle install --path vendor/bundle --binstubs
+```
+
+Install pow, your friendly static server)
+```
+curl get.pow.cx | sh
+```
+
+Use powder to ask pow to serve up the files in the *public* subdirectory:
+```
+bin/powder link
+```
+
+Fire up **Guard** which will magically generate HTML and CSS whenever you change your HAML and SASS:
+```
+bin/guard
+```
+
+Open up your content in a web browser:
+```
+bin/powder open
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/uk

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'utilikilt'
+require 'utilikilt/cli'
+
+Utilikilt::CLI.start

data/ext/check_for_node/extconf.rb

@@ -0,0 +1,56 @@
+# tricks rubygems into believeing that the extension compiled and worked out.
+# This function lifted straight out of the zerg_support gem https://rubygems.org/gems/zerg_support
+def emulate_extension_install
+  extension_name = "utilikilt"
+  File.open('Makefile', 'w') { |f| f.write "all:\n\ninstall:\n\n" }
+  File.open('make', 'w') do |f|
+    f.write '#!/bin/sh'
+    f.chmod f.stat.mode | 0111
+  end
+  File.open(extension_name + '.so', 'w') {}
+  File.open(extension_name + '.dll', 'w') {}
+  File.open('nmake.bat', 'w') { |f| }
+end
+
+
+def executable?( exe )
+  system "command -v #{exe} >/dev/null 2>&1"
+end
+
+def check_prereqs_and_advise
+  return nil if executable? 'node'
+
+  generic_advice = "\nUtilikilt uses node.js to serve up your files, but you don't appear to have it installed.\n"
+  if executable? 'brew'
+    return [generic_advice,"However it does look like you have homebrew available.","To install node simply run `brew install node`, then try to install the utilikilt gem again."].join("\n")
+  elsif `uname` =~ /Darwin/
+    return [generic_advice,%Q{The easiest way to install node is using a package manager called homebrew. You can get started with homebrew by visting http://bit.ly/getbrew, or just run the following from the command line:},%Q{/usr/bin/ruby -e "$(curl -fsSL https://raw.github.com/gist/323731)"},"",%Q{Once homebrew is installed you can install node.js with a simple `brew install node` from the command line. After that, try installing the utilikilt gem again.}].join("\n")
+  else
+    return [generic_advice,"Please install node.js and then try to install the utilikilt gem again."].join("\n")
+  end
+end
+
+
+def install_node_package
+  puts 'installing utilikilt npm package...'
+  system *%w{npm install utilikilt}, {:chdir => "../../"}
+  puts '...utilikilt npm package installed'
+end
+
+# This is a big ol' hack to run a pre-install script for this gem, by pretending to compile a native extension. See http://blog.costan.us/2008/11/post-install-post-update-scripts-for.html for details.
+
+emulate_extension_install()
+
+prereq_errors = check_prereqs_and_advise()
+if prereq_errors
+  puts "\n\n\n"
+  puts "*"*80
+  puts prereq_errors
+  puts "*"*80
+  puts "\n\n\n"
+  exit 1
+end
+
+install_node_package()
+
+

data/lib/utilikilt.rb

@@ -0,0 +1,6 @@
+require "utilikilt/version"
+
+module Utilikilt
+  DEFAULT_INPUT_DIR_NAME = 'source'
+  DEFAULT_OUTPUT_DIR_NAME = 'public'
+end

data/lib/utilikilt/cli.rb

@@ -0,0 +1,86 @@
+require 'thor'
+require 'utilikilt/scanner'
+require 'utilikilt/watcher'
+require 'utilikilt/node_proxy'
+require 'utilikilt/workspace'
+
+module Utilikilt
+  class CLI < Thor
+
+    desc "watch", "watch for changes to source files and automatically create corresponding public files"
+    method_option :input_dir, :aliases => '-i', :type => 'string'
+    method_option :output_dir, :aliases => '-o', :type => 'string'
+    def watch( project_dir = nil )
+      opts = normalize_options(project_dir,options)
+      start_watcher(opts)
+    end
+
+    desc "build", "rebuild all input files"
+    method_option :input_dir, :aliases => '-i', :type => 'string'
+    method_option :output_dir, :aliases => '-o', :type => 'string'
+    def build( project_dir = nil )
+      opts = normalize_options(project_dir,options)
+      run_one_off_scan( opts ) 
+    end
+
+    desc "serve", "Start a little web server host whatever is in your public directory, with live refresh"
+    def serve( project_dir = nil )
+      opts = normalize_options(project_dir,options)
+      start_serve( opts )
+    end
+
+    desc "up", "live-compile the contents of source, and serve it up to your browser with live-refresh"
+    method_option :input_dir, :aliases => '-i', :type => 'string'
+    method_option :output_dir, :aliases => '-o', :type => 'string'
+    def up( project_dir=nil )
+      watch_thread = Thread.new{ watch(project_dir) }
+      serve_thread = Thread.new{ serve(project_dir) }
+
+      serve_thread.join # joining on serve rather than watch is arbitrary
+    end
+
+    desc "workspace", "create a new workspace directory"
+    def workspace( workspace_name )
+      workspace = Workspace.new( Dir.getwd, workspace_name )
+      problems = workspace.create_or_report_problems
+      if problems
+        puts 
+        puts problems
+        exit 1
+      end
+    end
+    private 
+
+    def run_one_off_scan(options)
+      scanner = Scanner.new( options )
+      scanner.scan
+    end
+
+    def start_watcher(options)
+      scanner = Scanner.new( options )
+      scanner.scan # do an initial build
+      Watcher.watch options['input_dir'] do
+        scanner.scan
+      end
+    end
+
+    def start_serve(options)
+      server = Utilikilt::NodeProxy.new( options['output_dir'] )
+      server.launch_server
+    end
+
+
+    def normalize_options( project_dir, opts )
+      normalized = {}
+      %w{input_dir output_dir}.each do |k|
+        normalized[k] = File.expand_path( opts[k] ) if opts.has_key?(k)
+      end
+      normalized['project_dir'] = File.expand_path( project_dir || Dir.getwd )
+
+      normalized['input_dir'] ||= File.join( normalized['project_dir'], Utilikilt::DEFAULT_INPUT_DIR_NAME )
+      normalized['output_dir'] ||= File.join( normalized['project_dir'], Utilikilt::DEFAULT_OUTPUT_DIR_NAME )
+
+      normalized
+    end
+  end
+end

data/lib/utilikilt/loggable.rb

@@ -0,0 +1,8 @@
+module Utilikilt
+module Loggable
+  def debug
+    puts yield if $DEBUG
+  end
+end
+end
+

data/lib/utilikilt/node_proxy.rb

@@ -0,0 +1,13 @@
+module Utilikilt
+  class NodeProxy
+    NODE_DIR = File.join( File.dirname(__FILE__), '..','..', 'node_modules', 'utilikilt' )
+
+    def initialize( serve_dir )
+      @serve_dir = File.expand_path(serve_dir)
+    end
+
+    def launch_server
+      system 'node_modules/.bin/coffee', 'lib/uk.coffee', @serve_dir, {:chdir => NODE_DIR}
+    end
+  end
+end

data/lib/utilikilt/scanner.rb

@@ -0,0 +1,76 @@
+require 'pathname'
+require 'fileutils'
+
+require 'utilikilt/loggable'
+
+module Utilikilt
+class Scanner
+  include Loggable
+
+  def initialize( opts )
+    @input_base = Pathname.new( opts['input_dir'] ).expand_path
+    @output_base = Pathname.new( opts['output_dir'] ).expand_path
+    @files_processed = 0
+  end
+  
+  INPUT_TO_OUTPUT_EXT_MAP = {
+    'md' => 'html',
+    'markdown' => 'html',
+    'haml' => 'html',
+    'sass' => 'css',
+    'scss' => 'css',
+    'coffee' => 'js'
+  }
+
+  TILT_OPTIONS = {:cache => false}
+
+  def scan
+    @files_processed = 0
+    input_file_glob = '*.{'+INPUT_TO_OUTPUT_EXT_MAP.keys.join(',')+'}'
+    Pathname.glob(File.join( @input_base, "**", input_file_glob )).each do |input|
+      debug{"checking #{input}"} 
+      output = output_for_input(input)
+      unless FileUtils.uptodate?( output, [input] ) 
+        filter( input, output )
+      end
+    end
+
+    log_files_processed
+  end
+
+  private
+
+  def log_files_processed
+    puts "#{@files_processed} files processed"
+  end
+
+  def filter input, output
+    require 'tilt'
+
+    output.dirname.mkpath
+
+    print "#{input} => #{output} ... "
+      template = Tilt.new( input.to_s, 1, TILT_OPTIONS )
+
+      output.dirname.mkpath
+      output.open('w') do |out_file|
+        out_file.write( template.render )
+      end
+    puts " done"
+
+    @files_processed += 1
+  end
+
+  def output_for_input input
+    relative = input.relative_path_from @input_base
+    
+    # this is a bit fiddly because Pathname defines exts as including the leading dot while our map does not include it
+    output_ext = '.'+INPUT_TO_OUTPUT_EXT_MAP[input.extname[1..-1]]
+
+    raise ArgumentError, "unrecognized input file extension for #{input}" if output_ext.nil?
+
+    @output_base.join( relative.sub_ext(output_ext) )
+  end
+
+end
+end

data/lib/utilikilt/version.rb

@@ -0,0 +1,3 @@
+module Utilikilt
+  VERSION = "0.1.0"
+end

data/lib/utilikilt/watcher.rb

@@ -0,0 +1,20 @@
+require 'rb-fsevent'
+
+module Utilikilt
+class Watcher
+  def self.watch( dir_to_watch, &handler )
+    Watcher.new( dir_to_watch, handler ).start_watching
+  end
+
+  def initialize( dir_to_watch, on_change_handler )
+    @fsevent = FSEvent.new
+    @fsevent.watch dir_to_watch do |directories|
+      on_change_handler.call( directories )
+    end
+  end
+  
+  def start_watching
+    @fsevent.run
+  end
+end
+end

data/lib/utilikilt/workspace.rb

@@ -0,0 +1,38 @@
+require 'pathname'
+
+module Utilikilt
+class Workspace
+  def initialize base_dir, workspace_name
+    @workspace_name = workspace_name
+    @workspace_dir = Pathname.new(base_dir).join(@workspace_name).expand_path
+  end
+
+  def create_or_report_problems
+    if @workspace_dir.directory?
+      "There is already a directory called #{@workspace_name}. I don't want to mess with it. Please give me a new workspace name or delete that directory."
+    elsif @workspace_dir.exist?
+      "There is already a file called #{@workspace_name}, and I can't create a directory with the same name. Please give me a new workspace name or delete that file."
+    else
+      @workspace_dir.mkdir
+      @workspace_dir.join(Utilikilt::DEFAULT_INPUT_DIR_NAME).mkdir
+      @workspace_dir.join(Utilikilt::DEFAULT_OUTPUT_DIR_NAME).mkdir
+      @workspace_dir.join(Utilikilt::DEFAULT_INPUT_DIR_NAME, 'index.haml').open('w') do |f|
+        f.write CANNED_INDEX_HAML
+      end
+      nil
+    end
+  end
+
+
+  CANNED_INDEX_HAML = <<EOS
+!!! 5
+%html
+  %head
+    %title
+      Hello, world
+  %body
+    %p
+      Welcome to your new workspace. Edit #{Utilikilt::DEFAULT_INPUT_DIR_NAME}/index.haml to get started.
+EOS
+end
+end

data/utilikilt.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "utilikilt/version"
+
+Gem::Specification.new do |s|
+  s.name        = "utilikilt"
+  s.version     = Utilikilt::VERSION
+  s.authors     = ["Pete Hodgson"]
+  s.email       = ["github@thepete.net"]
+  s.homepage    = "http://github.com/moredip/utilikilt"
+  s.summary     = %q{Seriously simple prototyping}
+  s.description = %q{Prototype your UI development using tools like HAML and SASS with your changes showing up in the browser every time you save.}
+
+  s.rubyforge_project = "utilikilt"
+
+  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.extensions << 'ext/check_for_node/extconf.rb'
+
+  s.add_runtime_dependency "thor"
+  s.add_runtime_dependency "rb-fsevent"
+  s.add_runtime_dependency "haml"
+  s.add_runtime_dependency "sass"
+  s.add_runtime_dependency "redcarpet"
+  s.add_runtime_dependency "tilt"
+  s.add_runtime_dependency "powder"
+  s.add_runtime_dependency "showoff-io"
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/utilikilt/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/utilikilt/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in utilikilt.gemspec
+gemspec

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: utilikilt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Pete Hodgson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70285499891220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70285499891220
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70285499890800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70285499890800
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &70285499890380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70285499890380
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: &70285499889780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70285499889780
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &70285499889160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70285499889160
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: &70285499888560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70285499888560
+- !ruby/object:Gem::Dependency
+  name: powder
+  requirement: &70285499887880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70285499887880
+- !ruby/object:Gem::Dependency
+  name: showoff-io
+  requirement: &70285499887200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70285499887200
+description: Prototype your UI development using tools like HAML and SASS with your
+  changes showing up in the browser every time you save.
+email:
+- github@thepete.net
+executables:
+- uk
+extensions:
+- ext/check_for_node/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/uk
+- ext/check_for_node/extconf.rb
+- lib/utilikilt.rb
+- lib/utilikilt/cli.rb
+- lib/utilikilt/loggable.rb
+- lib/utilikilt/node_proxy.rb
+- lib/utilikilt/scanner.rb
+- lib/utilikilt/version.rb
+- lib/utilikilt/watcher.rb
+- lib/utilikilt/workspace.rb
+- utilikilt.gemspec
+- utilikilt/.gitignore
+- utilikilt/Gemfile
+homepage: http://github.com/moredip/utilikilt
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: utilikilt
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Seriously simple prototyping
+test_files: []