cup 0.0.1 → 0.0.3

data/.gitignore

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

data/.pryrc

@@ -0,0 +1,9 @@
+$:.push File.expand_path('../lib', __FILE__)
+$:.push File.expand_path('../spec', __FILE__)
+
+require 'ruby-debug'
+require 'cup'
+
+def reload!
+  load 'cup.rb'
+end

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile.lock

@@ -0,0 +1,115 @@
+PATH
+  remote: .
+  specs:
+    cup (0.0.2)
+      activemodel
+      coffee-script
+      rake
+      sass
+      sinatra
+      slim
+      therubyracer
+      thor
+      uglifier
+      yard
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    archive-tar-minitar (0.5.2)
+    backports (2.3.0)
+    builder (3.0.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.1.2)
+    columnize (0.3.4)
+    daemons (1.1.4)
+    diff-lcs (1.1.3)
+    eventmachine (0.12.10)
+    execjs (1.2.9)
+      multi_json (~> 1.0)
+    i18n (0.6.0)
+    libv8 (3.3.10.2)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    monkey-lib (0.5.4)
+      backports
+    multi_json (1.0.3)
+    rack (1.3.3)
+    rack-protection (1.1.4)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    sass (3.1.10)
+    shoulda (2.11.3)
+    sinatra (1.3.0)
+      rack (~> 1.3)
+      rack-protection (~> 1.1)
+      tilt (~> 1.3)
+    sinatra-advanced-routes (0.5.1)
+      monkey-lib (~> 0.5.0)
+      sinatra (~> 1.0)
+      sinatra-sugar (~> 0.5.0)
+    sinatra-reloader (0.5.0)
+      sinatra (~> 1.0)
+      sinatra-advanced-routes (~> 0.5.0)
+    sinatra-sugar (0.5.1)
+      monkey-lib (~> 0.5.0)
+      sinatra (~> 1.0)
+    slim (1.0.3)
+      temple (~> 0.3.4)
+      tilt (~> 1.3.2)
+    statemachine (1.2.0)
+    temple (0.3.4)
+    therubyracer (0.9.8)
+      libv8 (~> 3.3.10)
+    thin (1.2.11)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.14.6)
+    tilt (1.3.3)
+    uglifier (1.0.3)
+      execjs (>= 0.3.0)
+      multi_json (>= 1.0.2)
+    yard (0.7.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cup!
+  rack (= 1.3.3)
+  rack-test
+  rspec
+  ruby-debug19
+  shoulda
+  sinatra-reloader
+  statemachine
+  thin

data/README.md

@@ -1,6 +1,86 @@
 Cup
 ===
 
-## Creating a new javascript library
+## From ruby:
+
+Cup.build
+Cup.cup_name
+Cup.minified
+Cup.concatenated
+Cup.version
+
+
+## CLI helper output
+
+* INSERT HERE
+
+
+## Features
+
+
+* Automatically includes javascripts, easy DSL for customizing their order
+ >>>> but NOT from inside spec/visuals1
+
+* can uglify your project `cup build`
+** concatenates lib**/*.js and src/**/*.js  into unminified and minified outputs in ./build
+
+* `cup serve`
+** landing page for all serve capabilities
+** serve specs in concatenated and debug modes
+** serve visual spec index and serve spec/visual/**/*.spec.erb
+** includes all css files in every request
+** sinatra server extendable by add `server do <sinatra endpoints> end` to the Cupfile
+
+   @pages ||= {
+      :root => Page.new.tap do |page|
+        page.path = '/'
+        page.name = 'root'
+        page.template = :root
+        page.description = 'List of available pages'
+      end,
+      :debug => Page.new.tap do |page|
+        page.path = '/debug'
+        page.name = 'debug'
+        page.template = :debug
+        page.description = 'Headed page with lib and src javascript included'
+      end,
+      :empty => Page.new.tap do |page|
+        page.path = '/empty'
+        page.name = 'empty'
+        page.template = :debug
+        page.options[:layout] = false
+        page.description = 'Totally blank page with lib and src javascript included'
+      end,
+      :spec => Page.new.tap do |page|
+        page.path = '/spec'
+        page.name = 'specs'
+        page.template = :spec
+        page.options[:javascripts_scheme] = :spec
+        page.description = 'Run Jasmine specs on lib and src'
+      end,
+      :spec_concatenated => Page.new.tap do |page|
+        page.path = '/spec/concatenated'
+        page.name = 'specs on build output'
+        page.template = :spec
+        page.options[:javascripts_scheme] = :spec_concatenated
+        page.description = 'Run Jasmine specs on the build output'
+      end,
+      :spec_minified => Page.new.tap do |page|
+        page.path = '/spec/minified'
+        page.name = 'specs on minified build output'
+        page.template = :spec
+        page.options[:javascripts_scheme] = :spec_minified
+        page.description = 'Run Jasmine specs on minified build output'
+      end,
+      :spec_visual => Page.new.tap do |page|
+        page.path = '/spec/visual'
+        page.name = 'visual specs'
+        page.template = :spec
+        page.description = 'View available visual specs'
+      end
+    }
+
+* uglified options overridable in Cupfile
+before_build and after_build hooks are available too
+* requires git
 
-`cup <name>`

data/Rakefile

@@ -1,3 +1 @@
-require 'bundler/gem_tasks'
-require 'versionify'
-Versionify.install_rake_tasks
+require 'bundler/gem_tasks'

data/TODO

@@ -0,0 +1,13 @@
+> RUN every command line task
+> VISIT every server page
+
+>> rebuild superview, js-core-ext (rename to js-core-ext)
+
+> INSPECT concatenated and minified output
+
+> README
+---- Later ----
+
+Rails app integration
+  * integrate with the jasmine-rails gem to run specs on the command line
+  * integrate with the asset pipeline

data/bin/cup

@@ -1,19 +1,4 @@
 #!/usr/bin/env ruby
-require 'thor'
-require 'cup'
 
-class CupCli < Thor
-  
-  desc "create NAME", "Creates a new project structure with the specified name. Can also be called like: cup <name> [options]"
-  method_option 'no-jquery'
-  def create(name)
-    puts "create: #{name}"
-  end
-  
-  def method_missing (*params)
-    params.length == 1 ? create(*params) : super
-  end
-
-end
-
-CupCli.start
+require 'cup/command_line'
+Cup::CommandLine.start

data/cup.gemspec

@@ -1,26 +1,42 @@
 # -*- encoding: utf-8 -*-
-#$:.push File.expand_path('../lib', __FILE__)
+$:.push File.expand_path('../lib', __FILE__)
+require 'cup/version'
 
 Gem::Specification.new do |s|
   s.name        = 'cup'
-  s.version     = '0.0.1' #Versionify.version
+  s.version     = Cup::VERSION
   s.authors     = ['Sam Taylor']
   s.email       = ['sjltaylor@gmail.com']
   s.homepage    = ''
   s.summary     = 'ruby based tools for developing javascript libraries'
   # s.description = %q{TODO: Write a gem description}
-  
-  s.add_dependency 'rake'
-  s.add_dependency 'sinatra'
-  s.add_dependency 'versionify'
-  s.add_dependency 'uglifier'
-  s.add_dependency 'therubyracer'
-  s.add_dependency 'thor'
-  
+
+
   s.rubyforge_project = 'cup'
-  
+
   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.add_runtime_dependency 'thor'
+  s.add_runtime_dependency 'activemodel'
+  s.add_runtime_dependency 'rake'
+  s.add_runtime_dependency 'therubyracer'
+  s.add_runtime_dependency 'uglifier'
+  s.add_runtime_dependency 'sinatra'
+  s.add_runtime_dependency 'slim'
+  s.add_runtime_dependency 'sass'
+  s.add_runtime_dependency 'coffee-script'
+  s.add_runtime_dependency 'yard'
+
+  s.add_development_dependency 'ruby-debug19'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'shoulda'
+  s.add_development_dependency 'statemachine'
+  s.add_development_dependency 'rack', '=1.3.3'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'thin'
+  s.add_development_dependency 'sinatra-reloader'
+
 end

data/js/extra_matchers.js

@@ -0,0 +1,29 @@
+/*
+
+These jasmine matchers are included by default when a project is created with cup.
+
+*/
+beforeEach(function() {
+  this.addMatchers({
+    toBeAFunction: function() {
+      return typeof this.actual === 'function';
+    },
+    toBeInstanceOf: function (ctor) {
+      return this.actual instanceof ctor;
+    },
+    toContain: function (a) {
+      return this.actual.contains(a);
+    },
+    toBeEmpty: function () {
+      return this.actual.isEmpty();
+    },
+    toThrowAnError: function () {
+      try {
+        this.actual()
+      } catch (e) {
+        return e instanceof Error;
+      }
+      return false;
+    }
+  });
+});

data/lib/cup/builder.rb

@@ -0,0 +1,127 @@
+require 'uglifier'
+require 'cup/noop_shell'
+
+module Cup
+  class Builder
+    extend FileUtils
+
+    attr_reader :directory
+
+    def initialize directory
+      @directory = directory
+      @before_build_enabled = true
+      @after_build_enabled = true
+    end
+
+    def build *params
+      cupfile.before_build.call
+      concatenated = concatenate *params
+      minified = minify *params
+      cupfile.after_build.call
+      {
+        :concatenated => concatenated,
+        :minified => minified
+      }
+    end
+
+    def build! *params
+      cupfile.before_build.call
+      concatenated = concatenate! *params
+      minified = minify! *params
+      cupfile.after_build.call
+      {
+        :concatenated => concatenated,
+        :minified => minified
+      }
+    end
+
+    def concatenate *params
+      {:status => :ok, :output => (concatenate! *params)}
+    rescue Exception => e
+      {:status => :failed, :exception => e}
+    end
+
+    def minify *params
+      {:status => :ok, :output => (minify! *params)}
+    rescue Exception => e
+      {:status => :failed, :exception => e}
+    end
+
+    def concatenate!(options = {})
+      process(options, :concatenated) do |input_file_content|
+        input_file_content
+      end
+    end
+
+    def minify!(options = {})
+      uglifier_options = uglifier_defaults.merge directory.cupfile.uglifier_options
+
+      process(options, :minified) do |input_file_content|
+        Uglifier.compile input_file_content, uglifier_options
+      end
+    end
+
+  private
+
+    def process(options, output_file)
+
+      relative_output_file = directory.send output_file, :relative => true
+      output_file = directory.send output_file
+
+      options = default_options.merge options
+      cli = options[:cli]
+
+      build_directory = "#{directory.path.to_s}/build"
+      mkdir build_directory unless Dir.exists?(build_directory)
+      file = File.open(output_file, 'w')
+
+      file.write(license_header)
+
+      input_files.each do |input_file|
+        file.write(';')
+        file.write(yield File.read(input_file))
+        file.write(';')
+      end
+
+      cli.say("#{relative_output_file}: #{file.pos} bytes written.", :green)
+
+      file.close
+
+      File.read(output_file)
+    end
+    def cupfile
+      directory.cupfile
+    end
+    def default_options
+      { :cli => NoopShell }
+    end
+    def license_header
+      license = File.read(directory.cupfile.license) rescue nil
+      license.nil? ? '' : "/*\n#{license}\n*/"
+    end
+    def input_files
+      directory.javascripts :build_input
+    end
+    def uglifier_defaults
+      {
+        :mangle => true, # Mangle variables names
+        :toplevel => false, # Mangle top-level variable names
+        :except => [], # Variable names to be excluded from mangling
+        :max_line_length => 32 * 1024, # Maximum line length
+        :squeeze => true, # Squeeze code resulting in smaller, but less-readable code
+        :seqs => true, # Reduce consecutive statements in blocks into single statement
+        :dead_code => true, # Remove dead code (e.g. after return)
+        :unsafe => false, # Optimizations known to be unsafe in some situations
+        :copyright => true, # Show copyright message
+        :beautify => false, # Output indented code
+        :beautify_options => {
+          :indent_level => 2,
+          :indent_start => 0,
+          :quote_keys => false,
+          :space_colon => 0,
+          :ascii_only => false
+        }
+      }
+    end
+  end
+end

data/lib/cup/command_line.rb

@@ -0,0 +1,225 @@
+require 'thor'
+require 'pathname'
+require 'cup'
+require 'cup/builder'
+require 'cup/directory'
+require 'cup/server/app'
+
+module Cup
+  class CommandLine < Thor
+
+    include Thor::Actions
+
+    class Helper
+
+      JasmineStandaloneDistributionURL = 'http://pivotal.github.com/jasmine/downloads/jasmine-standalone-1.1.0.zip'
+      JQueryURL = 'http://code.jquery.com/jquery.min.js'
+
+      attr_reader :root
+
+      def initialize (path)
+        @root = Pathname.new(path).expand_path
+      end
+
+      def cupfile
+        root + 'Cupfile'
+      end
+
+      def cupfile_default_content(name)
+        <<-CUPFILE
+# This file describes the javascript project
+# see: https://github.com/sjltaylor/cup
+Cup.define do |cup|
+
+  name '#{name}'
+  version '0.0.1'
+  license 'license.txt'
+
+  javascripts do
+    vendor 'jasmine.js', :*
+  end
+
+end
+CUPFILE
+      end
+
+      def standard_directories
+        %w|src lib vendor spec spec/visual|.map {|dir| root + dir}
+      end
+
+      def jquery_file
+        root + 'vendor' + 'jquery.min.js'
+      end
+
+      def extra_matchers_file
+        root + 'vendor' + 'extra_matchers.js'
+      end
+
+      def rackup_file
+        root + 'config.ru'
+      end
+
+      def cupfile?
+        File.exists?(root + 'Cupfile')
+      end
+
+      def license_file
+        root + 'license.txt'
+      end
+
+      def get_jquery
+        jquery = `curl --silent #{JQueryURL}`
+        return jquery if $?.exitstatus == 0
+      end
+
+      def get_license
+        <<-LICENSE
+  Copyright (C) #{Time.now.year} by #{ENV['USER'] || 'THE_MAN'}
+
+  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.
+LICENSE
+      end
+
+      def get_extra_matchers
+        File.read(File.expand_path('../../../js/extra_matchers.js', __FILE__))
+      end
+
+      def download_jasmine
+
+        %x{
+          set -o errexit # exit if it hits the fan
+          set -o nounset # using unset variables is an error
+
+          cd #{root + 'vendor'}
+
+          curl --silent #{JasmineStandaloneDistributionURL} > jasmine.zip
+          unzip jasmine.zip -d jasmine
+
+          cd jasmine
+
+          cp `find . | grep -E '.*\.(css|js)'` ..
+
+          cd ..
+
+          rm -rf jasmine
+          rm jasmine.zip
+        }
+
+        $?.exitstatus == 0
+      end
+    end
+
+    desc "create NAME", "Creates a new directory structure with the specified name. Can also be called like: cup <name> [options]"
+    def create(name)
+
+      unless /^[\w-]+$/ =~ name
+        raise "#{name} is not a valid filename (letters, numbers, underscore and dashes only)"
+      end
+
+      helper = Helper.new(name)
+
+      if Dir.exists? helper.root
+        say_status :halted, "Cannot cup '#{name}'. A directory of that name already exists", :red
+        return
+      end
+
+      empty_directory helper.root
+      helper.standard_directories.each {|dir| empty_directory dir}
+
+      create_file helper.cupfile, helper.cupfile_default_content(name)
+
+      create_file helper.license_file, helper.get_license
+
+      jquery = helper.get_jquery
+
+      if jquery
+        say_status(:downloaded, "#{Helper::JasmineStandaloneDistributionURL}", :green)
+        create_file helper.jquery_file, jquery
+      else
+        say_status(:failed, "download #{Helper::JQueryURL}", :red)
+      end
+
+      if helper.download_jasmine
+        say_status(:downloaded, "#{Helper::JasmineStandaloneDistributionURL} and unpacked into vendor", :green)
+      else
+        say_status(:failed, "download/unpack #{Helper::JasmineStandaloneDistributionURL}", :red)
+      end
+
+      create_file helper.extra_matchers_file, helper.get_extra_matchers
+    end
+
+    desc "build", 'builds and minifies into ./build/'
+    def build
+      Cup.build! :cli => self
+    end
+
+    desc "concatenate", 'builds to STDOUT'
+    def concatenate
+      $stdout.write Cup.concatenate!
+    end
+
+    desc "minify", 'builds to STDOUT'
+    def minify
+      $stdout.write Cup.minify!
+    end
+
+    desc "server [PORT]", 'Starts a sinatra app which serves spec runners etc.'
+    def server(port=5555)
+
+      helper = pwd_helper
+
+      return no_cupfile unless helper.cupfile?
+
+      say(shell.set_color "cup server for '#{Cup.cup_name}' starting on port #{port}", :cyan, true)
+      Cup::Server::App.set :port => port
+      Cup::Server::App.run!
+    end
+
+    desc "version", 'The version of cup and the version of the Cup project in this directory if a Cupfile exists'
+    def version
+      say("#{Cup.cup_name} v#{Cup.version}", :cyan) if File.exist?('Cupfile')
+      say("cup v#{Cup::VERSION}")
+    end
+
+    desc 'rackup', 'Create a config.ru. Do this if you want to use powder'
+    def rackup
+
+      helper = pwd_helper
+
+      return no_cupfile unless helper.cupfile?
+
+      create_file helper.rackup_file, <<-CONFIG_RU
+require 'rubygems' # for ruby 1.8.x
+require 'rack'
+require 'cup/server/app'
+
+run Cup::Server::App
+CONFIG_RU
+    end
+
+  private
+
+    def pwd_helper
+      Helper.new(Cup::Directory.current.path.to_s)
+    end
+    def no_cupfile
+      say("Cupfile not present, bailing...", :red)
+    end
+  end
+end