js-preflight 0.0.1

data/bin/preflight

@@ -0,0 +1,158 @@
+#!/usr/bin/ruby
+require 'pathname'
+require 'optparse'
+require 'stringio'
+require 'fileutils'
+require 'lib/js-preflight'
+
+module Js
+  module Preflight
+    module Instructions
+      extend self
+      def executable
+        @executable ||= Pathname.new(__FILE__).basename.to_s
+      end
+
+      def print_usage
+
+        STDERR.puts <<USAGE
+
+#{executable}
+#{"=" * executable.length}
+Provide one or more html files as arguments. #{executable} will
+find files ending in .js in the src property of each script tag,
+and process them in order of appearance.
+
+For help with options and usage: 
+#{executable} --help
+
+USAGE
+      end
+    end
+  end
+end
+
+options = {}
+js_output = StringIO.new
+regexp = Js::Preflight::JsRegexp
+protected_paths = %w{/bin /sbin /usr/bin /usr/sbin /usr/local/bin /usr/local/sbin /var /var/log /var/spool /etc}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: #{Js::Preflight::Instructions.executable} [options] index.html [index2.html, ...]"
+
+  options[:lint] = true
+  opts.on("-l", "--[no-]lint", "Run JSLint on every .js file (default: true)") do |j|
+    options[:lint] = j
+  end
+
+  options[:strict] = true
+  opts.on("-s", "--[no-]strict", "Don't proceed unless JSLint passes (default: true)") do |s|
+    options[:strict] = s
+  end
+
+  options[:pack] = true
+  opts.on("-p", "--[no-]pack", "Pack every .js file, in order of apperance, using JSMin (default: true)") do |p|
+    options[:pack] = p
+  end
+
+  options[:exclude_paths] = []
+  opts.on("--exclude path1,path2,path3", Array, "Exclude .js files if they are in this list of comma-separated paths") do |paths|
+    options[:exclude_paths] = paths
+  end
+
+  options[:quiet] = false
+  opts.on("-q", "--quiet", "Don't report errors (default: false)") do |q|
+    options[:quiet] = q
+  end
+
+  options[:js_file] = false
+  opts.on("-j [FILE]", "--js-file [FILE]", "Output to file <FILE> instead of STDOUT (FILE default: assets.js)") do |f|
+    options[:js_file] = true
+    f = f.nil? ? "assets.js" : f
+    js_output = File.new(f, "w")
+  end
+
+  options[:html_path] = false
+  opts.on("--html-path PATH", "Output the provided HTML file(s), with affected script tags", "   replaced by the packaged version, at <PATH>/[JS_FILE].", "   Protected paths are silently ignored; ask an adult for help.", "   Depends on -j, which provides the basename for JS_FILE") do |path|
+    unless options[:js_file]
+      STDERR.puts "--html-path PATH requires --js-file JS_FILE"
+      exit
+    end
+    unless protected_paths.include?(path)
+      options[:html_path] = path
+    end
+  end
+
+  opts.on("-h", "--help", "Show options and usage") do
+    Js::Preflight::Instructions.print_usage
+    puts opts
+    exit
+  end
+end
+
+optparse.parse!
+
+
+
+if ARGV.length > 0
+
+  ARGV.each do |filename|
+
+    js_files = []
+    path = Pathname.new(filename)
+    file = File.new(path)
+
+    ::Js::Preflight::Scanner.scan(file, options) do |js_file|
+      js_files << js_file
+    end
+
+    relative_js_files = js_files.map{|js_file| File.join(path.dirname, js_file)}
+
+    lint_errors = []
+    if options[:lint]
+      ::Js::Preflight::Lint.build(relative_js_files) do |errors|
+        lint_errors << errors
+      end
+    end
+
+    if lint_errors.any?
+      unless options[:quiet]
+        STDERR.puts("#{path}:")
+        STDERR.puts("=" * path.to_s.length)
+        lint_errors.each {|error| STDERR.puts(error)}
+      end
+
+      next if options[:strict]
+    end
+
+    if options[:pack]
+      ::Js::Preflight::Pack.build(relative_js_files) do |packed_file|
+        js_output << packed_file
+      end
+    end
+
+    if options[:html_path]
+      file.rewind
+      out_filename = Pathname.new(File.join(options[:html_path], path.basename))
+      FileUtils.mkdir_p(out_filename.dirname)
+      File.open(out_filename, "w+") do |outfile|
+        while line = file.gets do
+          outfile << line unless js_files.include?(line[regexp, 1])
+          outfile << %Q{<script src="#{js_output.path}" type="text/javascript" charset="utf-8"></script>} if line[regexp, 1] == js_files.last
+        end
+      end
+    end
+
+  end
+
+  if options[:js_file]
+    js_output.close
+  else
+    js_output.rewind
+    STDOUT.puts js_output.read
+  end
+
+else
+  Js::Preflight::Instructions.print_usage
+  exit
+end

data/js-preflight.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "js-preflight/version"
+
+Gem::Specification.new do |s|
+  s.name        = "js-preflight"
+  s.version     = Js::Preflight::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Scott Burton", "Doug Crockford", "Andy Walker"]
+  s.email       = ["scottburton11@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Easy preflight command-line script for jslint and jsmin}
+  s.description = %q{Easy preflight command-line script for jslint and jsmin. Provides a packed, minified javascript file on STDOUT, or writes .js and provided .html files to a provided directory.}
+
+  s.rubyforge_project = "js-preflight"
+
+  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.bindir  = "bin"
+end

data/lib/js-preflight/lint.rb

@@ -0,0 +1,32 @@
+module Js
+  module Preflight
+    class Lint
+      attr_reader :filename, :executable_path
+      def initialize(filename, options = {})
+        @filename = filename
+        @executable_path = options[:executable_path] || File.join(::Js::Preflight::Basedir, "bin")
+      end
+
+      def errors
+        @errors ||= lint
+      end
+
+      def clean?
+        errors == "jslint: No problems found."
+      end
+
+      def self.build(files)
+        files.each do |file|
+          lint = Lint.new(file)
+          yield lint.errors unless lint.clean?
+        end
+      end
+
+      private
+
+      def lint
+        `js -f #{executable_path}/jslint < #{filename}`
+      end  
+    end
+  end
+end

data/lib/js-preflight/pack.rb

@@ -0,0 +1,27 @@
+module Js
+  module Preflight
+    class Pack
+      attr_reader :filename, :executable_path
+      def initialize(filename, options = {})
+        @filename = filename
+        @executable_path = options[:executable_path] || File.join(::Js::Preflight::Basedir, "bin")
+      end
+
+      def packed
+        @pack ||= pack
+      end
+
+      def self.build(files)
+        files.each do |file|
+          yield Pack.new(file).packed
+        end
+      end
+
+      private
+
+      def pack
+        `#{executable_path}/jsmin < #{filename}`
+      end
+    end
+  end
+end

data/lib/js-preflight/scanner.rb

@@ -0,0 +1,17 @@
+module Js
+  module Preflight
+    class Scanner
+      class << self
+        def scan(file, options = {})
+          exclude_paths = options[:exclude_paths] || []
+          file = File.open(file, "r") unless file.kind_of?(File)
+          while line = file.gets do
+            line.scan(::Js::Preflight::JsRegexp).each do |js_file|
+              yield js_file[0] unless exclude_paths.any? { |p| js_file[0].match(p) }
+            end
+          end
+        end
+      end      
+    end
+  end
+end

data/lib/js-preflight/version.rb

@@ -0,0 +1,5 @@
+module Js
+  module Preflight
+    VERSION = "0.0.1"
+  end
+end

data/lib/js-preflight.rb

@@ -0,0 +1,12 @@
+$:.unshift("./lib")
+require 'js-preflight/lint'
+require 'js-preflight/pack'
+require 'js-preflight/scanner'
+require 'js-preflight/version'
+
+module Js
+  module Preflight
+    JsRegexp = %r|src=\"(.+\.js)\"|
+    Basedir  = File.expand_path(File.join(__FILE__, "..", ".."))
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: js-preflight
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Scott Burton
+- Doug Crockford
+- Andy Walker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Easy preflight command-line script for jslint and jsmin. Provides a packed, minified javascript file on STDOUT, or writes .js and provided .html files to a provided directory.
+email: 
+- scottburton11@gmail.com
+executables: 
+- jslint
+- jsmin
+- preflight
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- bin/jslint
+- bin/jsmin
+- bin/preflight
+- js-preflight.gemspec
+- lib/js-preflight.rb
+- lib/js-preflight/lint.rb
+- lib/js-preflight/pack.rb
+- lib/js-preflight/scanner.rb
+- lib/js-preflight/version.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: js-preflight
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Easy preflight command-line script for jslint and jsmin
+test_files: []
+