jsinstrument 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mushan Yang
+
+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,20 @@
+# JSInstrument
+
+Instrument JavaScript source code to monitor code coverage in pure Ruby
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jsinstrument'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsinstrument
+
+## Usage
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/jsinstrument.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsinstrument/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsinstrument"
+  spec.version       = JSInstrument::VERSION
+  spec.authors       = ["Mushan Yang"]
+  spec.email         = ["mushan.yang@hulu.com"]
+  spec.description   = %q{Instrument JavaScript source code to monitor code coverage in pure Ruby}
+  spec.summary       = %q{Instrument JavaScript source code to monitor code coverage in pure Ruby}
+  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_dependency "rkelly", "~>1.0.7"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/jsinstrument.rb

@@ -0,0 +1,2 @@
+require "jsinstrument/version"
+require "jsinstrument/instrumenter"

data/lib/jsinstrument/inserting.js

@@ -0,0 +1,135 @@
+/* automatically generated by JSInstrument */
+/*
+ * create __coverage__ object as a global variable
+ */
+!function(root){
+  if (root && (typeof root.%{js_object_name} === 'undefined')) {
+    root.%{js_object_name} = {
+      /**
+       * Coverage data
+       */
+      _data: {},
+      /**
+       * A thread is uploading data
+       */
+      _uploading: false,
+      /**
+       * mark code line
+       */
+      mark: function(file, lines) {
+        if(!this._data[file]) this._data[file] = [];
+        for (var i in lines) {
+          if(!this._data[file][lines[i]]) {
+            this._data[file][lines[i]] = 0;
+          }
+        }
+      },
+      /**
+       * Hit a line
+       */
+      hit: function(file, line) {
+        if(!this._data[file]) this._data[file] = [];
+
+        if(!this._data[file][line]) this._data[file][line] = 1;
+        else this._data[file][line] = this._data[file][line] + 1;
+      },
+      /**
+       * Push data to server
+       */
+      upload: function(force, mark) {
+        /**
+         * Avoid dup upload
+         */
+        if(!force && this._uploading) return;
+
+        this._uploading = true;
+
+        try {
+          $.post('%{upload_url}', this._serialize(this._data, mark)).success(function() {
+            for (var file in _$jscoverage._data) {
+              var length = _$jscoverage._data[file].length;
+              for (var line = 0; line < length; line++) {
+                var value = _$jscoverage._data[file][line];
+                if (value === undefined || value === null) continue;
+                _$jscoverage._data[file][line] = 0;
+              }
+            }
+          }).complete(function() {
+             _$jscoverage._uploading = false; 
+          });
+        } catch (e) {
+          this._uploading = false;
+        }
+      }
+      /**
+       * serialize data for data uploading
+       */
+      _serialize: function(data, mark) {
+        var json = [];
+
+        for (var file in data) {
+          var coverage = data[file];
+
+          var array = [];
+          var length = coverage.length;
+          for (var line = 0; line < length; line++) {
+            var value = coverage[line];
+            if (value === undefined || value === null) {
+              value = '';
+            }
+            array.push(value);
+          }
+
+          json.push(this._quote(file) + ':[' + array.join(',') + ']');
+        }
+
+        var result = '{' + json.join(',') + '}';
+
+        var r = {
+          project: '%{project_name}',
+          commit: '%{commit_hash}',
+          batch: '%{batch_text}',
+          mark: mark,
+          data: result
+        }
+
+        var data_compress_method = %{data_compress_method};
+
+        if (data_compress_method) {
+          var result_deflated = data_compress_method(result);
+          var result_encoded = btoa(result_deflated);
+          r.data_compressed = true;
+          r.data = result_encoded;
+        }
+
+        return r;
+      },
+      _quote: function(s) {
+        return '"' + s.replace(/[\u0000-\u001f"\\\u007f-\uffff]/g, function (c) {
+          switch (c) {
+            case '\b': return '\\b';
+            case '\f': return '\\f';
+            case '\n': return '\\n';
+            case '\r': return '\\r';
+            case '\t': return '\\t';
+            case '"': return '\\"';
+            case '\\': return '\\\\';
+            default: return '\\u' + this._pad(c.charCodeAt(0).toString(16));
+          }
+        }) + '"';
+      },
+      _pad: function(s) {
+        return '0000'.substr(s.length) + s;
+      },
+    };
+
+    // $(document).ready(function() {
+    //   $(window).unload(function (e) {
+    //     _$jscoverage.upload(true);
+    //   });
+    // });
+  }
+
+  root.%{js_object_name}.mark('%{src_filename}', %{instrumented_lines});
+}(this);
+

data/lib/jsinstrument/instrumenter.rb

@@ -0,0 +1,133 @@
+require 'set'
+require 'rkelly'
+require 'rkelly/node'
+require 'rkelly/parent_builder'
+include RKelly::Nodes
+
+module JSInstrument
+  class Instrumenter
+
+    attr_accessor :js_object_name, :upload_url, :project_name, :commit_hash, :batch_text, :data_compress_method
+
+    def js_object_name
+      @js_object_name || '__coverage__'
+    end
+
+    def instrument src, filename
+      raise 'Filename not set' unless filename
+      ast = RKelly::Parser.new.parse src
+      raise 'Parse source failed.' unless ast
+      ast, instrumented_lines = instrument_ast ast
+      instrumented_src = ast.to_ecma
+
+      inserting = File.open(File.dirname(__FILE__) + '/inserting.js').read
+
+      bindings = {
+        js_object_name: self.js_object_name,
+        upload_url: self.upload_url,
+        src_filename: self.filename,
+        project_name: self.project_name,
+        commit_hash: self.commit_hash,
+        batch_text: self.batch_text,
+        data_compress_method: self.data_compress_method,
+        instrumented_lines: instrumented_lines
+      }
+
+      (inserting % bindings) + instrumented_src
+    end
+
+    private
+    def instrument_ast ast
+      # build parent attr for all nodes in ast
+      #
+      ast = RKelly::Visitors::ParentBuilder.new.build ast
+      instrumented_lines = Set.new
+      ast.each do |node|
+        parent = node.parent
+        line = node.line
+        # instrument only if we can get the line no. and we haven't instrumented it
+        #
+        if line and not instrumented_lines.member? line
+          if ExpressionStatementNode === node or EmptyStatementNode === node or
+            DoWhileNode === node or WhileNode === node or ForNode === node or
+            ForInNode === node or ContinueNode === node or VarDeclNode === node or
+            SwitchNode === node or BreakNode === node or ThrowNode === node or
+            ReturnNode === node or IfNode === node or VarStatementNode === node
+
+            if DoWhileNode === parent
+              if parent.left.eql? node
+                instrumented_lines.add line
+                parent.left = get_inserted_block node
+              end
+            elsif IfNode === parent or WhileNode === parent or
+              ForNode === parent or ForInNode === parent or WithNode === parent
+              if parent.value.eql? node
+                instrumented_lines.add line
+                parent.value = get_inserted_block node
+              elsif parent.else.eql? node
+                instrumented_lines.add line
+                parent.else = get_inserted_block node
+              end
+            elsif CaseBlockNode === parent or LabelNode === parent
+              # do nothing here
+            elsif SourceElementsNode === parent
+              if insert_func_before node
+                instrumented_lines.add line
+              end
+            end
+          elsif WithNode === node or TryNode === node
+            if SourceElementsNode === parent
+              if insert_func_before node
+                instrumented_lines.add line
+              end
+            end
+          elsif FunctionDeclNode === node or FunctionExprNode === node
+            if insert_func_before node
+              instrumented_lines.add line
+            end
+          end
+        end
+      end
+      [ast, instrumented_lines.sort]
+    end
+
+    def get_insert_func_call line
+      ExpressionStatementNode.new(
+        FunctionCallNode.new(
+          ResolveNode.new("#{self.js_object_name}.hit"),
+          ArgumentsNode.new([
+            StringNode.new("\"#{self.src_filename}\""),
+            NumberNode.new(line)
+          ])
+        )
+      )
+    end
+
+    def get_inserted_block node
+      BlockNode.new(
+        SourceElementsNode.new([
+          get_insert_func_call(node.line),
+          node
+        ])
+      )
+    end
+
+    def insert_func_before node
+      # get the original node line
+      #
+      line = node.line
+      # backtrack until we can insert the func
+      #
+      while not SourceElementsNode === node.parent and node.parent != nil
+        node = node.parent
+      end
+      if node.parent == nil
+        false
+      else
+        index = node.parent.value.index{|x| x.eql? node}
+        node.parent.value.insert index, get_insert_func_call(line)
+        true
+      end
+    end
+  end
+end

data/lib/jsinstrument/version.rb

@@ -0,0 +1,3 @@
+module JSInstrument
+  VERSION = "0.0.1"
+end

data/lib/rkelly/node.rb

@@ -0,0 +1,14 @@
+module RKelly
+  module Nodes
+    class Node
+      # add an accessor to receord the parent of a node
+      #
+      attr_accessor :parent
+    end
+    class IfNode
+      # make the else part of IfNode writable
+      #
+      attr_accessor :else
+    end
+  end
+end

data/lib/rkelly/parent_builder.rb

@@ -0,0 +1,120 @@
+module RKelly
+  module Visitors
+    class ParentBuilder < Visitor
+
+      def build node
+        link_parents node, nil
+        node
+      end
+
+      ## define methods for traverse different kinds of nodes
+      ## consts are from RKelly::Visitors::Visitor
+
+      TERMINAL_NODES.each do |type|
+        define_method(:"visit_#{type}Node") { |o| o.value }
+      end
+
+      BINARY_NODES.each do |type|
+        define_method(:"visit_#{type}Node") do |o|
+          [o.left && link_parents(o.left, o), o.value && link_parents(o.value, o)]
+        end
+      end
+
+      ARRAY_VALUE_NODES.each do |type|
+        define_method(:"visit_#{type}Node") do |o|
+          o.value && o.value.map { |v| v ? link_parents(v, o) : nil }
+        end
+      end
+
+      NAME_VALUE_NODES.each do |type|
+        define_method(:"visit_#{type}Node") do |o|
+          [o.name.to_s.to_sym, o.value ? link_parents(o.value, o) : nil]
+        end
+      end
+
+      SINGLE_VALUE_NODES.each do |type|
+        define_method(:"visit_#{type}Node") do |o|
+          link_parents(o.value, o) if o.value
+        end
+      end
+
+      PREFIX_POSTFIX_NODES.each do |type|
+        define_method(:"visit_#{type}Node") do |o|
+          link_parents(o.operand, o)
+        end
+
+      end
+
+      CONDITIONAL_NODES.each do |type|
+        define_method(:"visit_#{type}Node") do |o|
+          [ link_parents(o.conditions, o),
+            link_parents(o.value, o),
+            o.else ? link_parents(o.else, o) : nil
+          ]
+        end
+      end
+      FUNC_CALL_NODES.each do |type|
+        define_method(:"visit_#{type}Node") do |o|
+          [link_parents(o.value, o), link_parents(o.arguments, o)]
+        end
+      end
+      FUNC_DECL_NODES.each do |type|
+        define_method(:"visit_#{type}Node") do |o|
+          [
+            o.value ? o.value : nil,
+            o.arguments.map { |x| link_parents(x, o) },
+            link_parents(o.function_body, o)
+          ]
+        end
+      end
+
+      def visit_ForNode(o)
+        [
+          o.init ? link_parents(o.init, o) : nil,
+          o.test ? link_parents(o.test, o) : nil,
+          o.counter ? link_parents(o.counter, o) : nil,
+          link_parents(o.value, o)
+        ]
+      end
+
+      def visit_ForInNode(o)
+        [
+          link_parents(o.left, o),
+          link_parents(o.right, o),
+          link_parents(o.value, o)
+        ]
+      end
+
+      def visit_TryNode(o)
+        [
+          link_parents(o.value, o),
+          o.catch_var ? o.catch_var : nil,
+          o.catch_block ? link_parents(o.catch_block, o) : nil,
+          o.finally_block ? link_parents(o.finally_block, o) : nil
+        ]
+      end
+
+      def visit_BracketAccessorNode(o)
+        [
+          link_parents(o.value, o),
+          link_parents(o.accessor, o)
+        ]
+      end
+
+      def visit_DotAccessorNode(o)
+        link_parents(o.value, o)
+      end
+
+      private
+      def link_parents node, parent
+        node.parent = parent
+
+        # call the visit method to traverse potential subnodes depends on the node class
+        # error if the node is not in the predefined list
+        #
+        raise "No visit method for '#{node.class}'" unless self.respond_to?("visit_#{node.class.name.split(/::/)[-1]}")
+        self.send(:"visit_#{node.class.name.split(/::/)[-1]}", node)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: jsinstrument
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mushan Yang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rkelly
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Instrument JavaScript source code to monitor code coverage in pure Ruby
+email:
+- mushan.yang@hulu.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jsinstrument.gemspec
+- lib/jsinstrument.rb
+- lib/jsinstrument/inserting.js
+- lib/jsinstrument/instrumenter.rb
+- lib/jsinstrument/version.rb
+- lib/rkelly/node.rb
+- lib/rkelly/parent_builder.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Instrument JavaScript source code to monitor code coverage in pure Ruby
+test_files: []