jsc 0.1.3 → 0.2.0

data/History.txt

@@ -1,3 +1,9 @@
+== 0.2.0 / 2009-12-14
+
+added -a, -v, -c options
+now compile file by default (-f option removed)
+If no output_info options are passed to bin first check for errors and, if not any, return compiled code
+
 == 0.1.3 / 2009-12-14
 
 BUG fix: now show every error in a file, not just the first

data/README.rdoc

@@ -1,5 +1,5 @@
 jsc, JavaScript Compiler
-    by sub
+    by Davide Saurino
     http://github.com/sub/jsc
 
 == DESCRIPTION:
@@ -27,27 +27,29 @@ Check {Google API Reference}[http://code.google.com/intl/it-IT/closure/compiler/
 
 == SYNOPSIS:
 
-Compile a file:
+Get compiled code, if no errors are found:
 
-  ruby bin/jsc -f js/compiled_code.js
+  ruby bin/jsc js/compiled_code.js
 
 Compile a file, check for errors:
 
-  ruby bin/jsc -f js/errors.js -e
+  ruby bin/jsc js/errors.js -e
 
 Compile a file, check for warnings:
 
-  ruby bin/jsc -f js/warnings.js -w
+  ruby bin/jsc js/warnings.js -w
 
 Compile a file and get compression stats:
 
-  ruby bin/jsc -f js/compiled_code.js -s
+  ruby bin/jsc js/compiled_code.js -s
 
 Compile a piece of code, check for errors:
 
-  ruby bin/jsc -e "function("
+  ruby bin/jsc -e -c "function("
 
-<b>NOTE</b>: the library is a single file, so you can include it and just call one of the JSCompiler.compile* functions everywhere in your code.
+Compile a file and get compiled code if no errors or warnings are found:
+
+  ruby bin/jsc js/compiled_code.js -a
 
 == EMACS SNIPPETS
 
@@ -71,8 +73,16 @@ jsc requires the {bones}[http://gemcutter.org/gems/bones] gem.
 
 If you have gemcutter in your gem sources, run:
 
-  gem install jsc
+  [sudo] gem install jsc
 
 == LICENSE:
 
-GNU General Public License (GPLv3)
+(The MIT License)
+
+Copyright © 2009 Davide Saurino
+
+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

@@ -31,7 +31,8 @@ Bones {
   authors  'sub'
   email  'fitzkarraldo@gmail.com'
   url  'http://github.com/sub/jsc'
-  version  '0.1.3'
+  version  JSCompiler::VERSION
   summary 'Simple Ruby API to Google Closure Compiler Web service'
+  readme_file 'README.rdoc'
 }
 

data/bin/jsc

@@ -15,10 +15,10 @@ Look at http://gemcutter.org/gems/jsc for more info.
 
 == Usage
 
-jsc [options] ... CODE
+jsc [options] ... ARG
 
---file x, -f x:
-   compile file x
+--code x, -c x:
+   compile code x
 
 --errors, -e:
    check for errors
@@ -29,38 +29,55 @@ jsc [options] ... CODE
 --stats, -s:
    get statistics for compiled code
 
+--all, -a:
+   execute every check for this code
+
 --level value, -l value:
    compile with level value
    If this option is not supplied, SIMPLE_OPTIMIZATIONS will be used
    (look at Google API for accepted values).
 
+--version, -v:
+   show version
+
 --help, -h:
    this help
 
-CODE: The code that will be compiled.
- 
+ARG: A path to a javascript file or the code that will be compiled.
+
+If one of the following options is not specified
+
+-e, -w, -s, -a
+
+the code will be first compiled for errors and only if no errors are found 
+it will return the compiled code 
 EOU
 
 opts = GetoptLong.new(
                       [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
-                      [ '--file', '-f', GetoptLong::OPTIONAL_ARGUMENT ],
+                      [ '--version', '-v', GetoptLong::NO_ARGUMENT ],
+                      [ '--code', '-c', GetoptLong::OPTIONAL_ARGUMENT ],
                       [ '--errors', '-e', GetoptLong::NO_ARGUMENT ],
                       [ '--warns', '-w', GetoptLong::NO_ARGUMENT ],
                       [ '--stats', '-s', GetoptLong::NO_ARGUMENT ],
+                      [ '--all', '-a', GetoptLong::NO_ARGUMENT ],
                       [ '--level','-l',  GetoptLong::REQUIRED_ARGUMENT ]
                       )
 
-file = false
-output_info, level, file_path = String.new
+file = true
+output_info, level, code = ""
 
 opts.each do |opt, arg|
   case opt
   when '--help'
     puts USAGE_PREAMBLE
     exit 0
-  when '--file'
-    file = true
-    file_path = arg
+  when '--version'
+    puts JSCompiler::VERSION
+    exit 0
+  when '--code'
+    file = false
+    code = arg
   when '--level'
     if arg == ''
       level = "SIMPLE_OPTIMIZATIONS"
@@ -73,14 +90,28 @@ opts.each do |opt, arg|
     output_info = "warnings"
   when '--stats'
     output_info = "statistics"
+  when '--all'
+    output_info = "all"
   end
 end
 
 # -f option or CODE arg requested
-unless ARGV.length > 0 or file
-   puts "Missing any argument (try --help)"
-   exit 0
+unless ARGV.length > 0 or code
+  puts "Missing any argument (try --help)"
+  exit 0
 end
 
-arg = file_path.blank? ? ARGV.shift : file_path
-puts JSCompiler.compile(arg, file, output_info, level)
+arg = code.blank? ? ARGV.shift : code
+
+if output_info.eql?("all")
+  puts JSCompiler.full_compile(arg, file, level)
+elsif output_info.blank?
+  errors_output = JSCompiler.compile(arg, file, "errors", level)
+  unless errors_output.eql?("No errors")
+    puts errors_output
+  else
+    puts JSCompiler.compile(arg, file, "", level)
+  end
+else
+  puts JSCompiler.compile(arg, file, output_info, level)
+end

data/lib/jsc.rb

@@ -1,7 +1,7 @@
 module JSCompiler
 
   # :stopdoc:
-#  VERSION = '1.0.0'
+   VERSION = '0.2.0'
 #  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
 #  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   # :startdoc:

data/lib/jsc/closure_compiler.rb

@@ -57,26 +57,35 @@ module JSCompiler
       @level = level.blank? ? DEFAULT_LEVEL : level
       value = true
 
-      if is_file
-        js_code, value = read_file(arg)
-      else
-        js_code = arg
-      end
-      # js_code = is_file ? read_file(arg) : arg
-
-      unless value
-        return "Error reading file #{arg}"
-      end
-
       begin
+        if is_file
+          js_code = read_file(arg)
+        else
+          js_code = arg
+        end
         resp, data = post_to_cc(create_json_request(js_code))
-      rescue
-        return "Error calling the service...try again later"
+      rescue StandardError => e
+        return e
       end
 
       parse_json_output(data)
     end
 
+    # Compiles a file or a piece of code and returns parsed output
+    # if no errors or warnings are found
+    #
+    # Accepted parameters:
+    # * <b>arg</b>: the code or the file path to compile
+    # * <b>file</b>: 0 => arg is code
+    #                1 => arg is a file path
+    # * <b>level</b>: compilation_level parameter
+    def full_compile(arg, file, level)
+      ['errors', 'warnings','compiled_code'].each do |x|
+        str = JSCompiler.compile(arg, file, x, level)
+        return str unless str.eql?("No " + x)
+      end
+    end
+    
     # Calls compile method for every file in <em>dir</em> directory
     #
     # Accepted parameters:
@@ -84,7 +93,7 @@ module JSCompiler
     # * <b>op</b>: output_info parameter
     # * <b>level</b>: compilation_level parameter
     def compile_dir(dir, op, level)
-      out = String.new
+      out = ""
       Dir.entries(dir).each do |file|
         if File.extname(file) == ".js"
           out << "Statistics for file #{file}...\n"
@@ -99,7 +108,7 @@ module JSCompiler
     # Accepted parameters:
     # * <b>response</b>: the server response
     def parse_json_output(response)
-      out = String.new
+      out = ""
       parsed_response = JSON.parse(response, :max_nesting => false)
 
       if parsed_response.has_key?("serverErrors") 
@@ -118,9 +127,14 @@ module JSCompiler
         begin
           result = parsed_response[@op]
           unless result.nil?
+            num = result.size
+            out << "You've got #{result.size} #{@op}\n"
+            i = 0
             result.each do |message|
-              out << "#{message['type']}: " + message[@op.singularize] + " at line #{message['lineno']} character #{message['charno']}\n"
-              out << message['line'] + "\n" unless message['line'].nil?
+              i += 1
+              out << "\n#{@op.singularize.capitalize} n.#{i}\n"
+              out << "\t#{message['type']}: " + message[@op.singularize] + " at line #{message['lineno']} character #{message['charno']}\n"
+              out << "\t" + message['line'] + "\n" unless message['line'].nil?
             end
             return out
           else
@@ -139,10 +153,9 @@ module JSCompiler
     def read_file(file_name)
       begin
         content = File.open(file_name).read
-        return content, true
+        return content
       rescue
-        out = "ERROR reading #{file_name} file"
-        return out, false
+        raise
       end
     end
 

data/plugins/jsc.el

@@ -7,7 +7,7 @@
  (let ((tmp-buffer (get-buffer-create "**fitz-cc**"))
        (region-str (buffer-substring (region-beginning) (region-end)))
        (cc-output (shell-command-to-string
-                       (concat "jsc -e \""
+                       (concat "jsc -e -c \""
                                (buffer-substring (region-beginning) (region-end)) "\""))))
    (set-buffer tmp-buffer)
    (goto-char (point-max))
@@ -29,7 +29,7 @@
  (let ((tmp-buffer (get-buffer-create "**fitz-cc**"))
        (region-str (buffer-substring (region-beginning) (region-end)))
        (cc-output (shell-command-to-string
-                       (concat "jsc -w \""
+                       (concat "jsc -w -c \""
                                (buffer-substring (region-beginning) (region-end)) "\""))))
    (set-buffer tmp-buffer)
    (goto-char (point-max))

data/spec/jsc_spec.rb

@@ -96,18 +96,17 @@ describe JSCompiler do
       end
       
       it 'should return the result string' do
-        @resp.should match(/at line/)
+        @resp.should match(/Error n./)
       end
     end
 
     describe 'compile code and find warnings' do
       before do
         @resp = JSCompiler.compile(WARNING_CODE, false, "warnings", "SIMPLE_OPTIMIZATIONS")
-      puts @resp
       end
       
       it 'should return the result string' do
-        @resp.should match(/at line/)
+        @resp.should match(/Warning n./)
       end  
     end
 
@@ -121,7 +120,40 @@ describe JSCompiler do
       end
     end
   end
-  
+
+  describe 'FULL code compile' do
+    describe 'without errors or warnings' do
+      before do
+        @resp = JSCompiler.full_compile(COMPILE_CODE, false, "SIMPLE_OPTIMIZATIONS")
+      end
+ 
+      it 'should receive the compiled code' do
+        @resp.should_not be_nil
+      end
+    end
+    
+    describe 'and get errors' do
+      before do
+        @resp = JSCompiler.full_compile(ERROR_CODE, false, "SIMPLE_OPTIMIZATIONS")
+      end
+      
+      it 'should return the result string' do
+        @resp.should match(/Error n./)
+      end
+    end
+
+    describe 'and get warnings' do
+      before do
+        @resp = JSCompiler.full_compile(WARNING_CODE, false, "SIMPLE_OPTIMIZATIONS")
+      end
+      
+      it 'should return the result string' do
+        @resp.should match(/Warning n./)
+      end  
+    end
+
+  end
+
   describe 'read .js file' do
     before do
       #test file
@@ -130,26 +162,25 @@ describe JSCompiler do
     end
 
     it 'should return the code without errors' do
-      result, value = JSCompiler.read_file(@file_name)
-      value.should be_true
-    end
-
-    it 'should return error if file not found' do
-      result, value = JSCompiler.read_file(@file_not_found)
-      result.should match(/ERROR reading /)
+      lambda { JSCompiler.read_file(@file_name) }.should_not raise_error
     end
-  end
-
-  describe 'compile a whole directory' do
 
-    it 'should get statistics for every file' do
-      js_dir = "js"
-      result = JSCompiler.compile_dir(js_dir, "statistics", String.new)
-      # suppose I have 3 files in the dir
-      3.times do 
-        result.should =~ /Original Size:/
-      end
+    it 'should raise exception if file not found' do
+      lambda { JSCompiler.read_file(@file_not_found) }.should raise_error
     end
   end
+  
+  # TODO
+  # describe 'compile a whole directory' do
+
+  #   it 'should get statistics for every file' do
+  #     js_dir = "js"
+  #     result = JSCompiler.compile_dir(js_dir, "statistics", "")
+  #     # suppose I have 3 files in the dir
+  #     3.times do 
+  #       result.should =~ /Original Size:/
+  #     end
+  #   end
+  # end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jsc
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors: 
 - sub
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-14 00:00:00 +01:00
+date: 2009-12-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,30 +25,26 @@ dependencies:
 description: Simple Ruby API to Google Closure Compiler Web service.
 email: fitzkarraldo@gmail.com
 executables: 
-- "#jsc#"
 - jsc
 extensions: []
 
 extra_rdoc_files: 
 - History.txt
 - README.rdoc
-- bin/#jsc#
 - bin/jsc
 files: 
 - .gitignore
 - History.txt
 - README.rdoc
 - Rakefile
-- bin/#jsc#
 - bin/jsc
 - js/compiled_code.js
 - js/errors.js
-- js/temp.js
 - js/warnings.js
 - lib/jsc.rb
-- lib/jsc/clo2.rb
 - lib/jsc/closure_compiler.rb
 - plugins/jsc.el
+- spec/#wip_spec.rb#
 - spec/jsc_spec.rb
 - spec/spec_helper.rb
 - spec/wip_spec.rb

data/js/temp.js

@@ -1 +0,0 @@
-function hello(a){return; alert(\"Hello, \"+a)}hello(\"New user\")

data/lib/jsc/clo2.rb

@@ -1,169 +0,0 @@
-require 'rubygems'  # include RubyGems
-gem 'activesupport' # load ActiveSupport
-require 'activesupport' # include ActiveSupport
-require 'active_support/core_ext/integer/inflections'
-
-require 'json'
-require 'net/http'
-
-module JSCompiler
-
-# CONFIGURE this with the relative path to your javascript
-# folder (typically public/javascripts in a RAILS APP)
-# NO MORE NEEDED
-#JAVASCRIPTS_DIR = "js/"
-
-# Link to Google Closure Compiler service
-GOOGLE_SERVICE_ADDRESS = "http://closure-compiler.appspot.com/compile"
-# Default output_info parameter
-DEFAULT_SERVICE = "compiled_code"
-# Default compilation_level parameter
-DEFAULT_LEVEL = "SIMPLE_OPTIMIZATIONS"
-
-  class << self
-
-    # Creates the <em>JSON</em> hash for the request and returns the hash to send along with the request
-    #
-    # Accepted parameters:
-    # * <b>code</b>: json_code parameter
-    # * <b>level</b>: compilation_level parameter
-    def create_json_request(code)
-      parameters = {
-    	"code" => code,
-	"level" => @level,
-	"format"   => "json",
-	"info"  => @op
-      }
-    end
-
-    # Sends the JSON request <em>data</em> hash to Google service and returns its response
-    #
-    def post_to_cc(data)
-      post_args = { 
-        'js_code' => data["code"],
-        'compilation_level' => data["level"],
-        'output_format' => data["format"],
-        'output_info' => data["info"]
-      }
-      # send the request
-      resp, data = Net::HTTP.post_form(URI.parse(GOOGLE_SERVICE_ADDRESS), post_args)
-    end
-
-    # Reads the <em>file_name</em> file and calls compile method on it
-    #
-    # Accepted parameters:
-    # * <b>file_name</b>: absolute path to file
-    # * <b>op</b>: output_info parameter
-    # * <b>level</b>: compilation_level parameter
-    def compile_file(file_name, op, level)
-      #    javascript_code = read_file(JAVASCRIPTS_DIR + file_name)
-      #    resp, data = post_to_cc(create_json_request(javascript_code, op, level))
-      #    parse_json_output(data, op)
-     
-      javascript_code = read_file(file_name)
-      compile(javascript_code, op, level)
-    end
-
-    # Compiles <em>javascript_code</em> code and returns parsed output
-    #
-    # Accepted parameters:
-    # * <b>req</b>: the code to compile
-    # * <b>op</b>: output_info parameter
-    # * <b>level</b>: compilation_level parameter
-    def compile(req, is_file, op, level)
-      @op = op.blank? ? DEFAULT_SERVICE : op
-      @level = level.blank? ? DEFAULT_LEVEL : level
-
-      js_code = is_file ? read_file(qualcosa) : qualcosa
-      resp, data = post_to_cc(create_json_request(js_code))
-      parse_json_output(data)
-    end
-
-    # Calls compile method for every file in <em>dir</em> directory
-    #
-    # Accepted parameters:
-    # * <b>dir</b>: the directory
-    # * <b>op</b>: output_info parameter
-    # * <b>level</b>: compilation_level parameter
-    def compile_dir(dir, op, level)
-      out = String.new
-      Dir.entries(dir).each do |file|
-        if File.extname(file) == ".js"
-          out << "Statistics for file #{file}...\n"
-          out << compile_file(file, op, level) + "\n***************\n"
-        end
-      end
-      return out
-    end
-
-    # Parses and returns JSON server <em>response</em>
-    #
-    # Accepted parameters:
-    # * <b>response</b>: the server response
-    def parse_json_output(response)
-      out = String.new
-      parsed_response = JSON.parse(response, :max_nesting => false)
-      #p response
-
-      if parsed_response.has_key?("serverErrors") 
-        result = parsed_response['serverErrors']
-        return "Server Error: #{result[0]['error']} - Error Code: #{result[0]['code']}"
-      end
-
-      case @op
-      when "compiled_code"
-        out = parsed_response['compiledCode']
-      when "statistics"
-        result = parsed_response['statistics']
-        out = create_statistics_output(result)
-      else "errors"
-        #case for errors or warnings
-        begin
-          result = parsed_response[@op]
-          unless result.nil?
-            result.each do |message|
-              out = "#{message['type']}: " + message[@op.singularize] + " at line #{message['lineno']} character #{message['charno']}\n"
-              out << message['line'] unless message['line'].nil?
-              return out
-            end
-          else
-            return "No #{@op}"
-          end
-        rescue
-          out = "Error parsing JSON output...Check your output"
-        end
-      end
-    end
-
-    # Reads file and returns its content
-    #
-    # Accepted parameters:
-    # * <b>file_name</b>: the absolute path to the file
-    def read_file(file_name)
-      begin
-        #      content = File.open(JAVASCRIPTS_DIR + file_name).read
-        content = File.open(file_name).read
-        return content, true
-      rescue
-        out = "ERROR reading #{file_name} file"
-        return out, false
-      end
-    end
-
-    # Parses and returns the <em>result</em> JSON server response
-    #
-    # Accepted parameters:
-    # * <b>result</b>: the already parsed JSON server response
-    def create_statistics_output(result)
-      size_improvement = result['originalSize'] - result['compressedSize']
-      size_gzip_improvement = result['originalGzipSize'] - result['compressedGzipSize']
-      rate_improvement = (size_improvement * 100)/result['originalSize']
-      rate_gzip_improvement = (size_gzip_improvement * 100)/result['originalGzipSize']
-      out = "Original Size: #{result['originalSize']} bytes (#{result['originalGzipSize']} bytes gzipped) \n"
-      out << "Compiled Size: #{result['compressedSize']} bytes (#{result['compressedGzipSize']} bytes gzipped) \n"
-      out << "\t Saved #{rate_improvement}% off the original size (#{rate_gzip_improvement}% off the gzipped size)"
-    end
-
-  end
-
-end