RubyGems - jbundle - Versions diffs - 0.0.10 → 0.0.11 - Mend

jbundle 0.0.10 → 0.0.11

Files changed (12) hide show

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jbundle (0.0.10)
+    jbundle (0.0.11)
       closure-compiler
       rack
       thor

data/README.md CHANGED Viewed

@@ -1,5 +1,15 @@
 ## JBundle
+Ruby utility to help in developing JavaScript libraries. Lets you declare JavaScript libraries composed of multiple files. Easily bundle and minify your JavaScript bundles when you're done. Includes a Rack server for easy testing.
+## Installation
+JBundle is a Ruby gem.
+    gem install jbundle
+## Usage
 Define a set of javascript files to bundle and minify
     JBundle.config do
@@ -170,7 +180,32 @@ Learn more about the JBundle command-line with
     jbundle help # all commands
     jbundle help server # server command options
+## Generator
+The command line has a quick generator that creates stub files for your library code, an example file and tests using Qunit.
+    jsbundle init my_library.js
+    create  JFile
+          create  src
+          create  src/license.txt
+          create  src/my_library.js
+          create  test
+          create  test/index.html
+          create  test/tests.js
+          create  test/qunit.js
+          create  test/qunit.css
+          create  dist
+    Done. Try it!
+        jbundle s
+        open test/index.html
+At the moment only Qunit is supported in the generator but others (like Jasmine) would be easy to add.
+If you don't need the test stubs run the command with --no-tests
 ## TODO
 - DRY up stuff, better error handling for missing config

data/lib/jbundle/command_line.rb CHANGED Viewed

@@ -2,6 +2,9 @@ require 'thor'
 module JBundle
   class CommandLine < Thor
+    include Thor::Actions
     default_task :bundle
     map "s" => :server
@@ -46,6 +49,40 @@ module JBundle
     def version
       puts JBundle::VERSION
     end
+    def self.source_root
+      ::File.dirname(__FILE__)
+    end
+    AFTER_INIT_MESSAGE = %(
+Done. Try it!
+    jbundle s
+    open test/index.html
+Then package your work
+    jsbundle
+    )
+    desc 'init', 'Create example JFile and test stubs'
+    method_option :tests, :default => 'qunit', :aliases => '-t'
+    def init(name)
+      @name = name
+      template('templates/jfile.tt', "JFile")
+      empty_directory 'src'
+      template('templates/license.tt', "src/license.txt")
+      template('templates/lib.tt', "src/#{name}")
+      if options[:tests] == 'qunit'
+        empty_directory 'test'
+        template('templates/index.tt', "test/index.html")
+        template('templates/tests.tt', "test/tests.js")
+        copy_file 'templates/qunit.tt', 'test/qunit.js'
+        copy_file 'templates/qunit_css.tt', 'test/qunit.css'
+      end
+      empty_directory 'dist'
+      say AFTER_INIT_MESSAGE, :yellow
+    end
   end
 end

data/lib/jbundle/templates/index.tt ADDED Viewed

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<head>
+	<meta charset="UTF-8" />
+	<title>QUnit Test Suite</title>
+	<link rel="stylesheet" href="qunit.css" type="text/css" media="screen">
+	<script type="text/javascript" src="http://localhost:5555/<%= @name %>"></script>
+	<script type="text/javascript" src="qunit.js"></script>
+	<script type="text/javascript" src="tests.js"></script>
+</head>
+<body>
+	<h1 id="qunit-header">QUnit Test Suite</h1>
+	<h2 id="qunit-banner"></h2>
+	<div id="qunit-testrunner-toolbar"></div>
+	<h2 id="qunit-userAgent"></h2>
+	<ol id="qunit-tests"></ol>
+	<div id="qunit-fixture">test markup</div>
+</body>
+</html>

data/lib/jbundle/templates/jfile.tt ADDED Viewed

@@ -0,0 +1,30 @@
+# The JFile defines your JavaScript library and it's dependencies.
+# Read more on https://github.com/ismasan/jbundle/blob/master/README.md
+#
+# Version.
+# jbundle command will put source and minified versions in
+# - dist/0.0.1/
+# - dist/0.0/
+#
+version '0.0.1'
+# put your development files here
+#
+src_dir './src'
+# Define one or more JavaScript bundles
+#
+bundle '<%= @name %>' do
+  license 'license.txt'
+  file '<%= @name %>'
+end
+# Optional post-bundling filter, for example for string substitution
+#
+filter do |src, config|
+  src.gsub /<VERSION>/, config.version.to_s
+end
+# your packaged, versioned releases go here
+#
+target_dir 'dist'

data/lib/jbundle/templates/lib.tt ADDED Viewed

@@ -0,0 +1,14 @@
+var <%= @name.sub('.js', '').capitalize %> = (function () {
+  function klass (name) {
+    this.name = name;
+  }
+  klass.prototype = {
+    title: function () {
+      return 'Mr. ' + this.name;
+    }
+  }
+  return klass;
+})();

data/lib/jbundle/templates/license.tt ADDED Viewed

@@ -0,0 +1,25 @@
+/*  <%= @name %>, version <VERSION>
+Copyright (c) <%= Time.now.year %> [your name here]
+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.
+------------------------------------------------------------------*/