nibjs 1.0.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 1.0.0 / 2011-02-22
+
+* Enhancements
+
+  * Birthday!

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec :name => "nibjs"

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    nibjs (1.0.0)
+      bundler (~> 1.0)
+      quickl (~> 0.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bluecloth (2.0.10)
+    diff-lcs (1.1.2)
+    quickl (0.2.0)
+    rack (1.2.1)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    sinatra (1.1.2)
+      rack (~> 1.1)
+      tilt (~> 1.2)
+    tilt (1.2.2)
+    wlang (0.10.1)
+    yard (0.6.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bluecloth (~> 2.0.9)
+  bundler (~> 1.0)
+  nibjs!
+  quickl (~> 0.2.0)
+  rake (~> 0.8.7)
+  rcov (~> 0.9)
+  rspec (~> 2.4.0)
+  sinatra (> 0)
+  wlang (~> 0.10.1)
+  yard (~> 0.6.4)

data/LICENCE.js

@@ -0,0 +1,7 @@
+/**
+ * nib.js - [Java/Coffee]script application packager from node.js conventions
+ * 
+ * Copyright 2011, Bernard Lambeau
+ * Released under the MIT License
+ * http://github.com/blambeau/nib.js
+ */

data/LICENCE.md

@@ -0,0 +1,22 @@
+# The MIT Licence
+
+    Copyright (c) 2011 - Bernard Lambeau
+
+    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/Manifest.txt

@@ -0,0 +1,16 @@
+bin/**/*
+CHANGELOG.md
+dist
+Gemfile
+Gemfile.lock
+lib/**/*
+LICENCE.js
+LICENCE.md
+Manifest.txt
+nibjs.gemspec
+nibjs.noespec
+Rakefile
+README.md
+src/**/*
+tasks/**/*
+test/**/*

data/README.md

@@ -0,0 +1,64 @@
+# NibJS
+
+nib.js - Package and embed node.js or coffeescript libraries in the browser
+
+nib.js is a NibJS javascript library allowing to maintain javascript/coffeescript projects 
+ala 'node.js' (modules, exports, require) while also targetting a web browser as execution 
+platform. It contains a simple packager command (nibjs) that will convert your sources to a 
+single and minified .js file to be embedded in the browser. Node.js's exports and require 
+are correctly bounded.
+
+## Getting started
+
+    gem install nibjs
+    nibjs --help 
+
+## How to use it
+
+Let assume that your project has the structure below. 
+
+    mylib/
+      dist/
+      src/
+        foo.[js,coffee]          # exports.Foo = ...
+        bar.[js,coffee]          # require('./foo')
+        index.[js,coffee]        # exports.X = ...
+      spec/
+        foo_spec.[js,coffee]
+        bar_spec.[js,coffee]
+      package.json
+
+### EXAMPLE 1 (embedded javascript):
+
+  In a shell:
+
+    # if the sources are .js
+    nibjs --libname=mylib --output=mylib.js src
+
+    # if the sources are .coffee
+    nibjs --coffee --libname=mylib --output=mylib.js src
+
+  In the browser:
+
+    <script src="js/nibjs.js" type="text/javascript">
+    <script src="js/mylib.js" type="text/javascript">
+    <script>
+      var mylib = NibJS.require('mylib')
+    </script>
+
+### EXAMPLE 2 (embedded coffeescript):
+
+  In a shell:
+
+    nibjs --coffee --no-coffee-compile --libname=mylib --output=mylib.coffee src
+
+  In the browser:
+
+    <script src="js/coffee-script.js" type="text/javascript">
+    <script src="js/nibjs.js" type="text/javascript">
+    <script src="js/mylib.coffee" type="text/coffeescript">
+    <script>
+      /* But be warned of coffeescript's issue 1054
+         https://github.com/jashkenas/coffee-script/issues/#issue/1054 */
+      var mylib = NibJS.require('mylib')
+    </script>

data/Rakefile

@@ -0,0 +1,53 @@
+begin
+  gem "bundler", "~> 1.0"
+  require "bundler/setup"
+rescue LoadError => ex
+  puts ex.message
+  abort "Bundler failed to load, (did you run 'gem install bundler' ?)"
+end
+
+# Runs a command, returns result on STDOUT. If the exit status was no 0,
+# a RuntimeError is raised. 
+def shell_safe_exec(cmd)
+  puts cmd
+  unless system(cmd)
+    raise RuntimeError, "Error while executing #{cmd}" 
+  end
+  $?
+end
+
+def _(path)
+  File.join(File.dirname(__FILE__), path)
+end
+
+def dist(target)
+  shell_safe_exec("cat src/nibjs.coffee | coffee --bare --compile --stdio > #{target}")
+  code = ""
+  code += File.read("LICENCE.js")
+  code += "(function(exports){\n"
+  code += File.read(target).gsub(/^/m, "  ")
+  code += "}).call(this, this)"
+  File.open(target, "w"){|io| io << code}
+end
+
+def nibjs(*args)
+  nibjs = _('bin/nibjs')
+  shell_safe_exec "#{nibjs} #{args.flatten.join(' ')}"
+end
+  
+# Dynamically load the gem spec
+$gemspec_file = File.expand_path('../nibjs.gemspec', __FILE__)
+$gemspec      = Kernel.eval(File.read($gemspec_file))
+
+# We run tests by default
+task :default => :test
+
+#
+# Install all tasks found in tasks folder
+#
+# See .rake files there for complete documentation.
+#
+Dir["tasks/*.rake"].each do |taskfile|
+  instance_eval File.read(taskfile), taskfile
+end
+

data/bin/nibjs

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby -rrubygems
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "nibjs"
+NibJS::Main.run(ARGV)

data/lib/nibjs/loader.rb

@@ -0,0 +1,2 @@
+require "bundler"
+require "quickl"

data/lib/nibjs/main.rb

@@ -0,0 +1,288 @@
+require 'nibjs'
+module NibJS
+  #
+  # nibjs - Package and embed node.js/coffeescript application in your browser
+  #
+  # SYNOPSIS
+  #   #{program_name} [--help] [--version] [FOLDER]
+  #
+  # OPTIONS
+  # #{summarized_options}
+  #
+  # DESCRIPTION
+  #   This command packages a complete javascript/coffeescript as a single .js file 
+  #   to be embedded in the browser. Basically, it defines Node.js's exports and 
+  #   require to work nicely. For this, we expect a project structure that respect
+  #   Node.js's package conventions (exports, require, index): 
+  #
+  #     mylib/
+  #       dist/
+  #       src/
+  #         foo.[js,coffee]            # exports.Foo = ...
+  #         bar.[js,coffee]            # require('./foo')
+  #         index.[js,coffee]          # exports.X = ...
+  #       spec/
+  #         foo_spec.[js,coffee]
+  #         bar_spec.[js,coffee]
+  #
+  # EXAMPLE 1 (embedded javascript):
+  #
+  #   In a shell:
+  #
+  #       # if the sources are .js
+  #       nibjs --libname=mylib --output=mylib.js src
+  #
+  #       # if the sources are .coffee
+  #       nibjs --coffee --libname=mylib --output=mylib.js src
+  #
+  #   In the browser:
+  #
+  #     <script src="js/coffee-script.js" type="text/javascript">
+  #     <script src="js/nibjs.js" type="text/javascript">
+  #     <script src="js/mylib.js" type="text/javascript">
+  #     <script>
+  #       var mylib = NibJS.require('mylib')
+  #     </script>
+  #
+  # EXAMPLE 2 (embedded coffeescript):
+  #
+  #   In a shell:
+  #
+  #     nibjs --coffee --no-coffee-compile --libname=mylib --output=mylib.coffee src
+  #
+  #   In the browser:
+  #
+  #     <script src="js/nibjs.js"     type="text/javascript">
+  #     <script src="js/mylib.coffee" type="text/coffeescript">
+  #     <script>
+  #       /* But be warned of coffeescript's issue 1054
+  #          https://github.com/jashkenas/coffee-script/issues/#issue/1054 */
+  #       var mylib = NibJS.require('mylib')
+  #     </script>
+  #
+  class Main < Quickl::Command(__FILE__, __LINE__)
+    
+    # Name of the library which is packaged
+    attr_accessor :libname
+    
+    # Look for .coffee files
+    attr_accessor :coffee
+    
+    # Compile .coffee files
+    attr_accessor :coffee_compile
+    
+    # Join the sources instead of treating them separately
+    attr_accessor :join
+    
+    # Invoke ugligyjs on result
+    attr_accessor :uglify
+    
+    # Add 'libname = NibJS.require(libname)' at end of script
+    attr_accessor :autorequire
+    
+    # Path to a licencing file to add as header
+    attr_accessor :header
+    
+    # IO or filename where to output result
+    attr_accessor :output
+    
+    def initialize
+      @output = STDOUT
+    end
+    
+    # Install options
+    options do |opt|
+      @libname = nil
+      opt.on("--libname=X", "Specify the main library name") do |value|
+        @libname = value
+      end
+      @autorequire = false
+      opt.on('-a','--autorequire', "Add 'libname = NibJS.require(libname)' at end of script") do
+        @autorequire = true
+      end
+      @coffee = false
+      opt.on("-c", "--coffee", "Look for .coffee instead of .js files (requires coffee)") do
+        @coffee = true
+      end
+      @coffee_compile = true
+      opt.on("--[no-]coffee-compile", "Compile .coffee sources to javascript (requires coffee)") do |value|
+        @coffee_compile = value
+      end
+      @join = false
+      opt.on('-j', '--join', "Join the sources instead of treating them separately") do |value|
+        @join = true
+      end
+      @uglify = false
+      opt.on('-u', '--[no-]uglify', "Invoke ugligyjs on result (requires uglifyjs)") do |value| 
+        @uglify = value
+      end
+      opt.separator('')
+      @header = nil
+      opt.on("--header=FILE", "Add a (licencing) header from a file") do |value|
+        @header = value
+      end
+      #@output = STDOUT
+      opt.on("-o", "--output=FILE", "Output in a specific file") do |value|
+        @output = value
+      end
+      opt.on_tail("--help", "Show help") do
+        raise Quickl::Help
+      end
+      opt.on_tail("--version", "Show version") do
+        raise Quickl::Exit, "#{program_name} #{NibJS::VERSION} (c) 2011, Bernard Lambeau"
+      end      
+    end
+    
+    ### In coffee
+      
+    def with_coffee_registration(file)
+      code = ""
+      code += "nibjs.register '#{file}', (exports, require)->\n"
+      code += yield.strip.gsub(/^/m, '  ') + "\n"
+      code += "\n"
+    end
+
+    def with_coffee_define(package)
+      code = ""
+      code += "NibJS.define '#{package}', (nibjs)->\n"
+      code += yield.strip.gsub(/^/m, '  ') + "\n"
+      code += "\n"
+      code += "  nibjs.require './index'\n"
+    end
+    
+    ### In javascript
+    
+    def with_js_registration(file)
+      code = ""
+      code += "nibjs.register('#{file}', function(exports, require) {\n"
+      code += yield.strip.gsub(/^/m, '  ') + "\n"
+      code += "});\n"
+    end
+
+    def with_js_define(package)
+      code = ""
+      code += "NibJS.define('#{package}', function(nibjs) {\n"
+      code += yield.strip.gsub(/^/m, '  ') + "\n"
+      code += "  return nibjs.require('./index');\n"
+      code += "});\n"
+    end
+    
+    ###
+    
+    # Runs a command, returns result on STDOUT. If the exit status was no 0,
+    # a RuntimeError is raised. 
+    def safe_run(cmd)
+      res = `#{cmd}`
+      unless $?.exitstatus == 0
+        raise RuntimeError, "Error while executing #{cmd}" 
+      end
+      res
+    end
+    
+    def with_temp_file(content)
+      require "tempfile"
+      file = Tempfile.new('nibjs')
+      file << content
+      file.close
+      res = yield(file)
+      file.unlink
+      res
+    end
+    
+    ###
+    
+    def file2require(root_folder, file)
+      root_folder, file = File.expand_path(root_folder), File.expand_path(file)
+      stripped = file[(1+root_folder.size)..-1]
+      stripped =~ /(.*)\.(js|coffee)$/
+      "./#{$1}"
+    end
+    
+    ###
+    
+    def collect_on_files(folder)
+      files = if coffee
+        Dir["#{folder}/**/*.coffee"]
+      else
+        Dir["#{folder}/**/*.js"]
+      end
+      if join
+        files.sort!
+        content = files.collect{|f| File.read(f)}.join("\n")
+        [ with_temp_file(content){|f| yield(f.path, './index')} ]
+      else
+        files.collect{|f| yield(f, file2require(folder, f))}
+      end
+    end
+
+    def compile_coffee_source(code)
+      with_temp_file(code){|f|
+        safe_run("cat #{f.path} | coffee --compile --stdio --bare")
+      }
+    end
+
+    def compile(folder)
+      folder = File.expand_path(folder)
+      self.libname ||= File.basename(folder)
+      if self.libname =~ /(.*)\.\w/
+        self.libname = $1
+      end
+      
+      code = if coffee
+        code = with_coffee_define(libname){
+          collect_on_files(folder){|filepath, reqname|
+            with_coffee_registration(reqname){ File.read(filepath) }
+          }.join
+        }
+        if coffee_compile
+          compile_coffee_source(code) 
+        else
+          code
+        end
+      else
+        with_js_define(libname){
+          collect_on_files(folder){|filepath, reqname|
+            with_js_registration(reqname){ File.read(filepath) }
+          }.join
+        }
+      end
+
+      # Add the autorequire line if requested
+      if autorequire 
+        if (!coffee || coffee_compile)
+          code += "var #{libname} = NibJS.require('#{libname}');\n"
+        else
+          code += "#{libname} = NibJS.require '#{libname}'\n"
+        end
+      end
+      
+      if header
+        code = File.read(header) + "\n" + code
+      end
+      
+      # Uglify result now
+      if uglify
+        code = with_temp_file(code){|f| safe_run("uglifyjs #{f.path}") } 
+      end
+      
+      code
+    end
+    
+    def with_output
+      if String === output 
+        File.open(output, 'w'){|io| yield(io) }
+      else
+        yield(output)
+      end
+    end
+
+    def execute(args)
+      if args.size == 1
+        with_output{|io| io << compile(args[0]) }
+      else
+        raise Quickl::Help
+      end
+    end
+
+  end # class Main
+end # module NibJS

data/lib/nibjs/version.rb

@@ -0,0 +1,14 @@
+module NibJS
+  module Version
+  
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+  
+    def self.to_s
+      [ MAJOR, MINOR, TINY ].join('.')
+    end
+  
+  end 
+  VERSION = Version.to_s
+end

data/lib/nibjs.rb

@@ -0,0 +1,9 @@
+#
+# nib.js - Package and embed node.js or coffeescript libraries in the browser
+#
+module NibJS
+  
+end # module NibJS
+require "nibjs/version"
+require "nibjs/loader"
+require "nibjs/main"