skyrocket 0.0.1

data/README.md

@@ -0,0 +1,4 @@
+skyrocket
+======
+
+Yet another opinionated static content/ web asset generation gem

data/bin/skyrocket

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'skyrocket/cmd'
+Skyrocket::Cmd.new(ARGV).run

data/lib/skyrocket/asset.rb

@@ -0,0 +1,34 @@
+require 'fileutils'
+
+module Skyrocket
+  class Asset
+    attr_reader :filename, :dir, :output_dir, :processor
+
+    def initialize(dir, filename, output_dir, processor)
+      @dir = dir
+      @filename = filename
+      @output_dir = output_dir
+      @processor = processor
+    end
+
+    def name
+      @processor.post_process_name(@filename)
+    end
+
+    def output_path
+      @output_dir + "/" + @processor.post_process_name(@filename)
+    end
+
+    def content
+      return @content if @content
+      @content = raw 
+      @content = @processor.process(@content) if @processor
+      return @content
+    end
+
+    def raw
+      File.read(File.join(@dir, @filename))
+    end
+  end
+end
+

data/lib/skyrocket/asset_factory.rb

@@ -0,0 +1,54 @@
+module Skyrocket
+  class AssetFactory
+    attr_reader :asset_dirs, :lib_dirs, :output_dir
+    def initialize(asset_dirs, lib_dirs = [], output_dir)
+      @asset_dirs = asset_dirs
+      @lib_dirs = lib_dirs
+      @output_dir = output_dir
+      @pf = ProcessorFactory.new
+    end
+
+    def build_asset(filepath)
+      dir, file = parts(filepath)
+      Asset.new(dir, file, @output_dir, @pf.processor(file))
+    end
+
+    def from_name(name)
+      found = dir_search(name, @asset_dirs + @lib_dirs)
+      if found.length > 0
+        found.each do |file|
+          if @pf.post_process_name(file) =~ /#{name}$/
+            dir, file = parts(file)
+            return Asset.new(dir, file, @output_dir, @pf.processor(file))
+          end
+        end
+      end
+      
+      raise AssetNotFoundError
+    end
+
+  private
+    def parts(filepath)
+      dir = file_dir(filepath, @asset_dirs + @lib_dirs)
+      file = filepath.gsub("#{dir}/", '')
+      [dir, file]
+    end
+
+    def file_dir(filepath, dirs)
+      dirs.each do |dir|
+        if(filepath.start_with?(dir))
+          return dir
+        end
+      end
+      raise PathNotInAssetsError.new
+    end
+
+    def dir_search(part, dirs)
+      found = Array.new 
+      dirs.each do |dir|
+        found += Dir[dir + "/" + part + ".*"]
+      end
+      found
+    end
+  end
+end

data/lib/skyrocket/asset_loader.rb

@@ -0,0 +1,40 @@
+require 'shellwords'
+
+# components of this file were borrowed from ruby sprokets, https://github.com/sstephenson/sprockets
+module Skyrocket
+  class AssetLoader
+    HEADER_PATTERN = /
+      \A (
+        (?m:\s*) (
+          (\/\* (?m:.*?) \*\/) |
+          (\#\#\# (?m:.*?) \#\#\#) |
+          (\/\/ .* \n?)+ |
+          (\# .* \n?)+
+        )
+      )+
+    /x
+
+    DIRECTIVE_PATTERN = /
+      ^ [\W]* = \s* (\w+.*?) (\*\/)? $
+    /x
+
+    attr_reader :headers, :body
+
+    def initialize(filepath)
+      raw = File.read(filepath)
+      @headers = raw[HEADER_PATTERN, 0].lines || [""]
+      @body   = $' || data
+      # Ensure body ends in a new line
+      @body  += "\n" if @body != "" && @body !~ /\n\Z/m
+    end
+
+    def requires
+      @requires ||= @headers.each.map do |line|
+        if directive = line[DIRECTIVE_PATTERN, 1]
+          name, arg = Shellwords.shellwords(directive)
+          arg if name == 'require'
+        end
+      end.compact
+    end
+  end
+end

data/lib/skyrocket/asset_locator.rb

@@ -0,0 +1,26 @@
+require 'skyrocket/dir_ext'
+
+module Skyrocket
+  class AssetLocator
+    def initialize(asset_factory)
+      @af = asset_factory
+    end
+
+    def all_assets
+      dirs = @af.asset_dirs + @af.lib_dirs
+      paths = Array.new
+      dirs.each do |dir|
+        paths += Dir.glob_files(dir + "/**/*")
+      end
+      paths.map{ |p| @af.build_asset(p) }
+    end
+
+    def missing_asset_paths
+      out_cont = Dir.glob_files(@af.output_dir + "/**/*")
+      assets = all_assets
+      a_m = all_assets.inject(Hash.new) { |h, a| h[a.output_path] = a; h }
+      out_cont.select { |file| !a_m.keys.include?(file) }
+    end
+  end
+end
+

data/lib/skyrocket/asset_manager.rb

@@ -0,0 +1,59 @@
+require 'pathname'
+
+module Skyrocket
+  class AssetManager
+    attr_reader :asset_dirs, :lib_dirs, :output_dir, :base_url, :style
+
+    def initialize(options)
+      @asset_dirs = options[:asset_dirs].map{ |ad| Pathname.new(ad).realpath.to_s }
+      @lib_dirs = options[:lib_dirs].map{ |ld| Pathname.new(ld).realpath.to_s }
+      @output_dir = Pathname.new(options[:output_dir]).realpath.to_s
+      @base_url = options[:base_url]
+      @style = options[:style]
+      @af = AssetFactory.new(@asset_dirs, @lib_dirs, @output_dir)
+      @aw = AssetWriter.new
+      @al = AssetLocator.new(@af)
+      Processor.asset_factory = @af
+      Processor.base_url = @base_url
+    end
+
+    def compile(&block)
+      update_public(&block)
+    end
+
+    def watch(&block)
+      gem 'listen', '>=0.4.2'
+      require 'listen'
+
+      update_public(&block)
+
+      Listen.to(*(@asset_dirs + @lib_dirs)) do |modified, added, removed|
+        (modified + added).each { |am| process_change(@af.build_asset(am), &block) }
+        removed.each do |del|
+          as = @af.build_asset(del)
+          process_deleted(as.output_path, &block)
+        end
+      end
+    end
+
+  private
+    def update_public(&block)
+      @al.missing_asset_paths.each { |p| process_deleted(p, &block) }
+      @al.all_assets.each { |a| process_change(a, &block) }
+    end
+
+    def process_change(asset)
+      case @aw.write(asset)
+      when :created
+        yield(:created, asset.name) if block_given?
+      when :modified
+        yield(:modified, asset.name) if block_given?
+      end
+    end
+
+    def process_deleted(path)
+      @aw.delete(path)
+      yield(:deleted, path.gsub(@output_dir + '/', '')) if block_given?
+    end
+  end
+end

data/lib/skyrocket/asset_writer.rb

@@ -0,0 +1,37 @@
+require 'fileutils'
+require 'skyrocket/file_ext'
+
+module Skyrocket
+  class AssetWriter
+    def write(asset)
+      if(File.exist?(asset.output_path))
+        existing = File.read(asset.output_path)
+        if existing != asset.content
+          File.write_file(asset.output_path, asset.content)
+          :modified
+        else
+          :no_change
+        end
+      else
+        dirname = File.dirname(asset.output_path)
+        FileUtils.mkdir_p(dirname) 
+        File.write_file(asset.output_path, asset.content)
+        :created
+      end
+    end
+
+    def delete(output_path)
+      File.delete(output_path)
+      dir_parts = output_path.split(File::SEPARATOR)[0..-2]
+      dir_parts.length.times do |index|
+        neg_index = -1 - index
+        path = dir_parts[0..neg_index].join(File::SEPARATOR)
+        if Dir.entries(path).empty?
+          Dir.rmdir(path)
+        else
+          break
+        end
+      end
+    end
+  end
+end

data/lib/skyrocket/cmd.rb

@@ -0,0 +1,87 @@
+require 'optparse'
+require 'fileutils'
+require 'skyrocket'
+
+module Skyrocket
+  # CMD execution controller
+  class Cmd
+    COMMANDS = %w(compile init watch)
+
+    def initialize(argv)
+      @options = {
+        :asset_dirs => Array.new,
+        :lib_dirs => Array.new,
+        :output_dir => './public',
+        :base_url => '/',
+        :style => :raw
+      }
+
+      parser.parse!(argv)
+      @command = argv.shift
+      @arguments = argv
+
+      @options[:asset_dirs] << './assets/public' unless @options[:asset_dirs].length > 0
+      @options[:lib_dirs]   << './assets/lib'    unless @options[:lib_dirs].length > 0
+    end
+
+    def parser
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = "Usage: skyrocket [options] #{COMMANDS.join('|')}"
+
+        opts.separator ""
+        opts.separator "Options:"
+        opts.on("-s", "--style MODE", "Compilation style ('concat' for concat only, 'minify' for concat and minification, default 'raw' for neither)") do |style|
+          @options[:style] = style.to_sym
+        end
+        opts.on("-b", "--base URL", "Base url for assets location/ link generation") { |base| @options[:base_url] = base }
+        opts.on("-a", "--asset DIR", "Assets directory. Use more than once for multiple assets directories") { |asset| @options[:asset_dirs] << asset }
+        opts.on("-l", "--asset-lib DIR", "Asset lib directory. Use more than once for multiple lib directories") { |lib| @options[:lib_dirs] << lib }
+        opts.on("-o", "--output DIR", "Output directory for compiled assets.") { |output| @options[:output_dir] = output}
+
+        opts.on_tail("-h", "-?", "--help", "Show this message") { puts opts; exit }
+        opts.on_tail("-v", "--version", "Show version") { puts Skyrocket::VERSION; exit }
+      end
+    end
+
+    def format_results(action, asset_name)
+      case action
+      when :deleted
+        puts "     \e[31;40m** Deleted  **\e[0m #{asset_name}"
+      when :created
+        puts "     \e[32;40m** Created  **\e[0m #{asset_name}"
+      when :modified
+        puts "     \e[33;40m** Modified **\e[0m #{asset_name}"
+      end
+    end
+
+    def run
+      if COMMANDS.include?(@command)
+        am = AssetManager.new(@options)
+        case @command
+        when "compile"
+          am.compile(&method(:format_results))
+        when "init"
+          @options[:asset_dirs].each{ |dir| FileUtils.mkdir_p(dir) }
+          @options[:lib_dirs].each{ |dir| FileUtils.mkdir_p(dir) }
+          FileUtils.mkdir_p(@options[:output_dir])
+        when "watch"
+          trap("SIGINT") do
+            puts "Ending watch..."
+            exit!
+          end
+          begin
+            am.watch(&method(:format_results))
+          rescue Gem::LoadError => e
+            puts "'watch' command requires the gem '#{e.name}' of version '#{e.requirement}'' be installed."
+          end
+        end
+      elsif @command.nil?
+        puts "Command required"
+        puts @parser
+        exit 1
+      else
+        abort "Unknown command: #{@command}. Valid commands include: #{COMMANDS.join(', ')}"
+      end
+    end
+  end
+end

data/lib/skyrocket/coffeescript_processor.rb

@@ -0,0 +1,13 @@
+require 'coffee-script'
+
+module Skyrocket
+  class CoffeescriptProcessor
+    include Processor
+
+    def extension; '.coffee'; end
+
+    def process(contents)
+      CoffeeScript.compile(contents)
+    end
+  end
+end

data/lib/skyrocket/dir_ext.rb

@@ -0,0 +1,13 @@
+class Dir
+  def self.glob_files(pattern, flags = nil)
+    if block_given?
+      Dir.glob(pattern, flags || 0) do |filename|
+        if File.file?(filename)
+          yield(filename)
+        end
+      end
+    else
+      Dir.glob(pattern, flags || 0).select { |f| File.file?(f) }
+    end
+  end
+end

data/lib/skyrocket/empty_processor.rb

@@ -0,0 +1,9 @@
+module Skyrocket
+  class EmptyProcessor
+    include Processor
+
+    def extension; ''; end
+    def process(contents); contents; end;
+
+  end
+end

data/lib/skyrocket/erb_processor.rb

@@ -0,0 +1,100 @@
+require 'erb'
+
+module Skyrocket
+  class ErbProcessor
+    include Processor
+
+    def extension; '.erb'; end
+
+    def process(contents)
+      template = ERB.new(contents, nil, '-', '@out')
+      results = template.result(get_binding { |name=nil| '' })
+      if(@layout)
+        outer_contents = asset_factory.from_name(@layout).raw
+        outer_template = ERB.new(outer_contents, nil, '-', '@out')
+        results = outer_template.result(get_binding do |name=nil|
+          if name == nil
+            results
+          else
+            @content_for[name.to_sym]
+          end
+        end)
+      end
+      results
+    end
+
+    def get_binding
+      binding
+    end
+
+    def layout(name)
+      @layout = name
+      nil
+    end
+
+    def stylesheet_link_tag(path)
+      "<link rel=\"stylesheet\" href=\"#{resolve(path)}\">"
+    end
+
+    def javascript_include_tag(path)
+      "<script src=\"#{resolve(path)}\"></script>"
+    end
+
+    def link_to(content, path, options)
+      opt_s = to_opt_s(options)
+      "<a href=\"#{resolve(path)}\"#{opt_s}>#{content}</a>"
+    end
+
+    def image_tag(path, options)
+      opt_s = to_opt_s(options)
+      "<img src=\"#{resolve(path)}\"#{opt_s} />"
+    end
+
+    def href(path)
+      resolve(path)
+    end
+
+    def content_for(key)
+      # swap current ERB output buffer with a 'fake' buffer
+      # otherwise calling yield will write contents of block
+      # to ERB results output
+      old = @out
+      @out = ''
+      results = yield.chomp
+      @out = old
+      @content_for ||= Hash.new
+      @content_for[key.to_sym] = results
+      nil
+    end
+
+    def render(asset_name)
+      contents = asset_factory.from_name(asset_name).raw
+      old = @out # save current ERB buffer
+      @out = ''
+      template = ERB.new(contents, nil, '-', '@out')
+      results = template.result(get_binding do |name=nil|
+        if name == nil
+          results
+        else
+          @content_for[name.to_sym]
+        end
+      end)
+      @out = old
+      results
+    end
+
+  private
+    def resolve(path)
+      if(path.start_with?("/") || path =~ /^\w+:\/\//)
+        path
+      else
+        base_url == '/' ? "#{base_url}#{path}" : "#{base_url}/#{path}"
+      end
+    end
+
+    def to_opt_s(options)
+      opt_s = options.keys.map{ |k| "#{k}=\"#{options[k]}\"" }.join(' ')
+      opt_s = " " + opt_s unless opt_s == ''
+    end
+  end
+end

data/lib/skyrocket/errors.rb

@@ -0,0 +1,5 @@
+module Skyrocket
+  class AssetNotFoundError < Exception; end;
+  class PathNotInAssetsError < Exception; end;
+  class NoValidProcessorError < Exception; end;
+end

data/lib/skyrocket/file_ext.rb

@@ -0,0 +1,5 @@
+class File
+  def self.write_file(file, string)
+    File.open(file, 'w') { |f| f.write(string) }
+  end
+end

data/lib/skyrocket/less_processor.rb

@@ -0,0 +1,19 @@
+require 'less'
+
+module Skyrocket
+  class LessProcessor
+    include Processor
+
+    def extension; '.less'; end
+
+    def process(contents)
+      tree = parser.parse(contents)
+      tree.to_css
+    end
+
+  private
+    def parser
+      @@parser ||= Less::Parser.new(:paths => asset_factory.asset_dirs + asset_factory.lib_dirs)
+    end
+  end
+end

data/lib/skyrocket/processor.rb

@@ -0,0 +1,36 @@
+module Skyrocket
+  module Processor
+    def extension
+      raise NotImplimentedError.new("must impliment #{caller[0][/`.*'/][1..-2]} for #{self.class.name}")
+    end
+
+    def process(contents)
+      raise NotImplimentedError.new("must impliment #{caller[0][/`.*'/][1..-2]} for #{self.class.name}")
+    end
+
+    def process?(file)
+      ext = File.extname(file)
+      (ext =~ /#{extension}$/) != nil 
+    end
+
+    def post_process_name(file)
+      file.chomp(extension)
+    end
+
+    def self.asset_factory=(asset_factory)
+      @@af = asset_factory
+    end
+
+    def asset_factory
+      @@af
+    end
+
+    def self.base_url=(base_url)
+      @@bu = base_url
+    end
+
+    def base_url
+      @@bu
+    end
+  end
+end

data/lib/skyrocket/processor_factory.rb

@@ -0,0 +1,28 @@
+module Skyrocket
+  class ProcessorFactory
+   
+    PROCESSORS = [ CoffeescriptProcessor, ErbProcessor, LessProcessor, EmptyProcessor ]
+
+    def process?(filename)
+      PROCESSORS.each do |processor|
+        return true if processor.new.process?(filename)
+      end
+      return false
+    end
+
+    def post_process_name(filename)
+      if process?(filename)
+        processor(filename).post_process_name(filename)
+      else
+        filename
+      end
+    end
+
+    def processor(filename)
+      PROCESSORS.each do |processor|
+        return processor.new if processor.new.process?(filename)
+      end
+      raise NoValidProcessorError
+    end
+  end
+end

data/lib/skyrocket/version.rb

@@ -0,0 +1,3 @@
+module Skyrocket
+  VERSION = "0.0.1"
+end

data/lib/skyrocket.rb

@@ -0,0 +1,19 @@
+require 'skyrocket/version'
+
+module Skyrocket
+  autoload :Asset,                 "skyrocket/asset"
+  autoload :AssetLocator,          "skyrocket/asset_locator"
+  autoload :AssetFactory,          "skyrocket/asset_factory"
+  autoload :AssetManager,          "skyrocket/asset_manager"
+  autoload :AssetWriter,           "skyrocket/asset_writer"
+  autoload :CoffeescriptProcessor, "skyrocket/coffeescript_processor"
+  autoload :EmptyProcessor,        "skyrocket/empty_processor"
+  autoload :ErbProcessor,          "skyrocket/erb_processor"
+  autoload :LessProcessor,         "skyrocket/less_processor"
+  autoload :Processor,             "skyrocket/processor"
+  autoload :ProcessorFactory,      "skyrocket/processor_factory"
+
+  autoload :AssetNotFoundError,    "skyrocket/errors"
+  autoload :NoValidProcessorError, "skyrocket/errors"
+  autoload :PathNotInAssetsError,  "skyrocket/errors"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: skyrocket
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Wasser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: therubyracer
+  requirement: &70197185909260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70197185909260
+- !ruby/object:Gem::Dependency
+  name: less
+  requirement: &70197185908840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70197185908840
+- !ruby/object:Gem::Dependency
+  name: coffee-script
+  requirement: &70197185908420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70197185908420
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70197185908000 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70197185908000
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70197185907500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70197185907500
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70197185907080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70197185907080
+description: An alternative and opinionated static content/ asset management tool
+  that will concatenate/ render javascript, coffeescript, css, less, erb and html
+email:
+- michael@raveld.com
+executables:
+- skyrocket
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- lib/skyrocket/asset.rb
+- lib/skyrocket/asset_factory.rb
+- lib/skyrocket/asset_loader.rb
+- lib/skyrocket/asset_locator.rb
+- lib/skyrocket/asset_manager.rb
+- lib/skyrocket/asset_writer.rb
+- lib/skyrocket/cmd.rb
+- lib/skyrocket/coffeescript_processor.rb
+- lib/skyrocket/dir_ext.rb
+- lib/skyrocket/empty_processor.rb
+- lib/skyrocket/erb_processor.rb
+- lib/skyrocket/errors.rb
+- lib/skyrocket/file_ext.rb
+- lib/skyrocket/less_processor.rb
+- lib/skyrocket/processor.rb
+- lib/skyrocket/processor_factory.rb
+- lib/skyrocket/version.rb
+- lib/skyrocket.rb
+- bin/skyrocket
+homepage: http://www.raveld.com/
+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: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Yet another opinionated static content/ web asset generation system
+test_files: []