front_end_tasks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 834da5210e7838434da6cc1676045148c99d0b73
+  data.tar.gz: b570713b3aa5a9ae092d9c0f571070b3eeb0dac4
+SHA512:
+  metadata.gz: a46f36a77e4a7bc549420e0a932c45c4c4cc50d8146cf5a3895bb6cc189c1ac108861e0160b81720b817c6f7fd5891c74c02a390c715c1ca97a0d383b84ea09d
+  data.tar.gz: 3158193588e3bcbf14116078cfc2cf5f7d8e1e91c4e6891abf295161584b710d7f2c540675ef10ac4c9baa427972ad2c47f8f3f6e52f71da4e904bd454906297

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+build/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Mike Enriquez (http://enriquez.me)
+
+MIT License
+
+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

@@ -0,0 +1,187 @@
+# Front End Tasks
+
+Command line tool for client side web application development. Great for develoeprs who prefer to write plain html, css, and javascript that works without any special pre-processing. This tool helps optimize, lint, and test that code.
+
+# Installation
+
+```bash
+$ gem install front_end_tasks
+```
+
+The `fe` command will be available after installing Front End Tasks.
+
+# Usage
+
+Front End Tasks can be used from the command line or scripted with Ruby.
+
+## build
+
+Compiles the given html file by combining and minifying javascript and stylesheet tags according to speical html comments (see HTML Comments section).
+
+```bash
+$ fe build path/to/public_dir path/to/public_dir/index.html
+```
+
+```ruby
+FrontEndTasks.build('path/to/public_dir', './build', 'path/to/public_dir/index.html')
+```
+
+## server
+
+Run a development server on localhost.
+
+```bash
+$ fe server --public_dir app/
+```
+
+```ruby
+FrontEndTasks.server(:public_dir => './app')
+```
+
+## lint
+
+Run the given files through JSLint.
+
+```bash
+$ fe lint app/js/file_to_lint.js app/js/another_file.js
+```
+
+```ruby
+FrontEndTasks.lint('./app/js/file_to_lint.js', './app/js/another_file.js')
+```
+
+## spec
+
+Run Jasmine specs
+
+```bash
+$ fe spec --source_files app/js/post.js --spec_files spec/PostSpec.js
+```
+
+```ruby
+FrontEndTasks.spec({
+  :source_files => ['app/js/post.js'],
+  :spec_files   => ['spec/PostSpec.js']
+})
+```
+
+## list_scripts
+
+List the javascript files that are included in the html (script tags) or js (importScripts) file
+
+```bash
+$ fe list_scripts ./app/index.html
+```
+
+```ruby
+FrontEndTasks.list_scripts('./app/index.html')
+```
+
+# HTML Comments
+
+## build:script
+
+Combine and minify scripts. Takes an argument that specifies the resulting file. See the following example
+
+```html
+<!-- build:script js/scripts.min.js -->
+<script src="/js/app.js"></script>
+<script src="/js/home.js"></script>
+<!-- /build -->
+```
+
+The above combine and minify app.js and home.js together into scripts.min.js
+
+```html
+<script src="/js/scripts.min.js"></script>
+```
+
+Note: Only script tags that reference local urls are allowed between build:script and /build html comments.
+
+## build:style
+
+Similar to build:script, but for stylesheets
+
+```html
+<!-- build:style css/styles.min.css -->
+<link href="vendor/bootstrap-3.1.1-dist/css/bootstrap.css" rel="stylesheet">
+<link href="css/app.css" rel="stylesheet">
+<!-- /build -->
+```
+
+The above becomes
+
+```html
+<link href="css/styles.min.css" rel="stylesheet">
+```
+
+Note: Only link tags that reference local urls are allowed between build:style and /build html comments.
+
+# External References
+
+The build command will find any references to other files in the project and include them in the resulting build.
+
+## Stylesheets
+
+CSS Files may reference fonts, images, etc... by using `url(...)`.
+
+The contents inside `url()` are flattened to the file's basename. For example:
+
+```css
+@font-face {
+  src: url('../fonts/glyphicons-halflings-regular.eot');
+}
+```
+
+Turns into
+
+```css
+@font-face {
+  src: url('glyphicons-halflings-regular.eot');
+}
+```
+
+The above font file will be moved into the same directory as the combined stylesheet (remember that file paths from stylesheets are relative to the location of the calling stylesheet).
+
+Note: Since all the files references from stylesheets are placed in the same directory, the filenames must be unique.
+
+## Javascripts
+
+Javascript files may have references to worker scripts. For example:
+
+```js
+var worker = new Worker('/js/workers/worker.js')
+```
+
+The worker script references are kept the same. The worker script is copied to the build with the same directory structure. Worker scripts are then processed by replacing `importScripts` calls.
+
+```js
+importScripts('/js/workers/worker_helper.js')
+```
+
+The above is replaced with the contents of the given file, then the whole worker script is minified.
+
+# MIT License
+
+Copyright (c) 2014 Mike Enriquez (http://enriquez.me)
+
+MIT License
+
+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 @@
+require "bundler/gem_tasks"

data/bin/fe

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'front_end_tasks/cli'
+
+FrontEndTasks::CLI.start

data/front_end_tasks.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'front_end_tasks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "front_end_tasks"
+  spec.version       = FrontEndTasks::VERSION
+  spec.authors       = ["Mike Enriquez"]
+  spec.email         = ["mike@enriquez.me"]
+  spec.description   = %q{Command line tool for client side web application development}
+  spec.summary       = %q{Front End Tasks comes with everything you need to minify javascript, minify css, run tests, run lint, and run a development server.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "thor", "~> 0.19.1"
+  spec.add_dependency "nokogiri", "~> 1.6.1"
+  spec.add_dependency "uglifier", "~> 2.5.0"
+  spec.add_dependency "yui-compressor", "~> 0.12.0"
+  spec.add_dependency "webrick", "~> 1.3.1"
+  spec.add_dependency "jshintrb", "~> 0.2.4"
+  spec.add_dependency "jasmine", "~> 2.0.0"
+end

data/lib/front_end_tasks.rb

@@ -0,0 +1,42 @@
+require "front_end_tasks/version"
+
+require 'front_end_tasks/optimizer'
+require 'front_end_tasks/server'
+require 'front_end_tasks/lint'
+require 'front_end_tasks/spec'
+require 'front_end_tasks/documents'
+
+module FrontEndTasks
+
+  def self.build(public_dir, build_dir, *files)
+    optimizer = Optimizer.new(public_dir, files)
+    optimizer.build_to(build_dir)
+  end
+
+  def self.server(options)
+    Server.start(options)
+  end
+
+  def self.lint(*files)
+    Lint.report(files)
+  end
+
+  def self.spec(options)
+    Spec.run(options)
+  end
+
+  def self.list_scripts(file, public_root = nil)
+    content = File.read(File.expand_path(file))
+    extension = File.extname(file).downcase
+    doc = nil
+
+    if extension == '.html'
+      doc = Documents::HtmlDocument.new(nil, content)
+    elsif extension == '.js'
+      doc = Documents::JsDocument.new(nil, content)
+    end
+
+    doc.included_scripts(public_root)
+  end
+
+end

data/lib/front_end_tasks/cli.rb

@@ -0,0 +1,45 @@
+require 'thor'
+require 'front_end_tasks'
+
+module FrontEndTasks
+
+  class CLI < Thor
+
+    desc "build", "Builds the given files according to special build comments"
+    method_option :result, :default => File.expand_path('./build')
+    def build(public_dir, *files)
+      FrontEndTasks.build(public_dir, options[:result], *files)
+    end
+
+    desc "server", "Run a static site directory on localhost"
+    method_option :public_dir, :default => File.expand_path('./build')
+    method_option :port, :default => 8000
+    def server
+      FrontEndTasks.server(options)
+    end
+
+    desc "lint", "Run JSLint"
+    def lint(*files)
+      FrontEndTasks.lint(*files)
+    end
+
+    desc "spec", "Run Jasmine specs"
+    method_option :source_files, :type => :array
+    method_option :worker_file
+    method_option :public_root
+    method_option :helper_files, :type => :array, :default => []
+    method_option :spec_files, :type => :array
+    method_option :port, :default => 8001
+    def spec
+      FrontEndTasks.spec(options)
+    end
+
+    desc "list_scripts", "List dependent javascript files"
+    method_option :public_root
+    def list_scripts(file)
+      puts FrontEndTasks.list_scripts(file, options[:public_root])
+    end
+
+  end
+
+end

data/lib/front_end_tasks/documents.rb

@@ -0,0 +1,8 @@
+require 'front_end_tasks/documents/base_document'
+require 'front_end_tasks/documents/asset_document'
+require 'front_end_tasks/documents/css_document'
+require 'front_end_tasks/documents/js_document'
+require 'front_end_tasks/documents/html_document'
+
+module FrontEndTasks::Documents
+end

data/lib/front_end_tasks/documents/asset_document.rb

@@ -0,0 +1,15 @@
+require 'front_end_tasks/documents/base_document'
+
+module FrontEndTasks
+  module Documents
+    class AssetDocument < BaseDocument
+
+      def compile
+        {
+          @compiled_path => @content
+        }
+      end
+
+    end
+  end
+end

data/lib/front_end_tasks/documents/base_document.rb

@@ -0,0 +1,18 @@
+module FrontEndTasks
+  module Documents
+    class BaseDocument
+
+      attr_accessor :compiled_path
+
+      def initialize(public_root, content)
+        @public_root = public_root
+        @content     = content
+      end
+
+      def compile
+        raise NotImplementedError.new('Must override "compile" in subclass')
+      end
+
+    end
+  end
+end

data/lib/front_end_tasks/documents/css_document.rb

@@ -0,0 +1,41 @@
+require 'yui/compressor'
+require 'front_end_tasks/documents/base_document'
+require 'front_end_tasks/documents/asset_document'
+
+module FrontEndTasks
+  module Documents
+    class CssDocument < BaseDocument
+
+      def compile
+        compressor = YUI::CssCompressor.new
+        compiled_content = compressor.compress(@content)
+
+        { @compiled_path => compiled_content }
+      end
+
+      def self.find_and_update_url_references(css_root, new_root, content)
+        assets = []
+        updated_content = content
+
+        url_references = content.scan(/url\(\s?['"](.*?)['"]\s?\)/)
+        url_references.each do |url_reference|
+          url = url_reference[0].strip
+          filename = File.basename(url).split("?")[0].split("#")[0]
+          local_file_path = File.join(css_root, File.dirname(url), filename)
+          new_path = File.join(new_root, filename)
+
+          # flatten url to down to just basename (including ? and # junk)
+          updated_content.sub!(url, File.basename(url))
+
+          # get asset contents
+          asset = AssetDocument.new(css_root, File.read(local_file_path))
+          asset.compiled_path = new_path
+          assets << asset
+        end
+
+        [updated_content, assets]
+      end
+
+    end
+  end
+end