jsshuffle 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,58 @@
-jsshuffle
-=========
+jsshuffle ![Gem Version](https://badge.fury.io/rb/jsshuffle.svg)
+================================================================
 
 A library to just-in-time randomly obfuscate JS. 
+
+
+Installation
+------------
+
+    $ gem install jsshuffle
+
+and 
+
+    require 'jsshuffle'
+
+should be enough to get you up and running.
+
+For rails, just add _jsshuffle_ to your Gemfile:
+
+    gem 'jsshuffle', group: :production
+
+
+Usage
+-----
+
+_jsshuffle_ can be used standalone and as a Ruby library.
+
+The standalone executable takes a filename as a parameter or reads the input from `STDIN` and outputs on `STDOUT`:
+
+    $ jsshuffle <<EOF
+    > var test = 13;
+    > test = (test + 13) * 7;
+    > alert( test );
+    > EOF
+    var dqkwxnvj = 13;
+    dqkwxnvj = (dqkwxnvj + 13) * 7;
+    alert(dqkwxnvj);
+
+To use _jsshuffle_ in your own Ruby project, instantiate `JsShuffle::Shuffler`:
+
+    require 'jsshuffle'
+
+    shuffler = JsShuffle::Shuffler.new use: :variable_renaming
+
+    puts shuffler.shuffle js: %Q(
+        var variable = "variable";
+        function newFunc( parameter ) {
+            return parameter + " is a cool parameter.";
+        }
+
+        console.log( newFunc( variable ) );
+    )
+
+Extending JsShuffle
+-------------------
+
+You can sublcass `JsShuffle::Methods::Method` and pass the new class as a `use:` argument to `Shuffler#new` or alternatively pass a Block or Proc.  
+For more information view the RDoc.

data/Rakefile

@@ -1,2 +1,7 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
+desc "Run Tests"
+Rake::TestTask.new do |t|
+    t.libs << 'test'
+end

data/jsshuffle.gemspec

@@ -17,8 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "bundler", "~> 1.6"
+  spec.add_dependency "rake", "~> 10.0"
+  spec.add_dependency "rkelly-remix", "~> 0.0.6"
 
-  spec.add_runtime_dependency "rkelly-remix", "~> 0.0.6"
+  spec.add_development_dependency "execjs", "~> 2.2.1"
 end

data/lib/jsshuffle/methods.rb

@@ -9,3 +9,4 @@ end
 
 require 'jsshuffle/methods/method.rb'
 require 'jsshuffle/methods/variable_renaming.rb'
+require 'jsshuffle/methods/parameter_renaming.rb'

data/lib/jsshuffle/methods/method.rb

@@ -47,9 +47,9 @@ module JsShuffle::Methods
         
         # Make sure +#respond_to?+ works like expected, even though this class provides the hooks
         def self.inherited( subclass )
-            undef_method :preprocess
-            undef_method :process
-            undef_method :postprocess
+            undef_method :preprocess    rescue ""
+            undef_method :process       rescue "" 
+            undef_method :postprocess   rescue ""
             super
         end
     end

data/lib/jsshuffle/methods/parameter_renaming.rb

@@ -0,0 +1,17 @@
+module JsShuffle::Methods
+    # Replaces local variable names with a randomly generated new one
+    #
+    # pass +:parameter_renaming+ in the +:use+ array of a {Parser}[rdoc-ref:JsShuffle::Parser] to use this +Method+.
+    class ParameterRenaming < Method
+        JsShuffle::Methods.methods[:parameter_renaming] = self
+
+        def process( ast, shuffler )
+            functionNodes = ast.select { |node| node.is_a? RKelly::Nodes::FunctionDeclNode }
+            functionNodes.each do |node|
+                renamed_parameters = {}
+                node.arguments.each { |arg| renamed_parameters[arg.value] = (arg.value = shuffler.random_new_name) }
+                node.function_body.value.each { |child| child.value = renamed_parameters[child.value] if child.is_a? RKelly::Nodes::ResolveNode and renamed_parameters.has_key? child.value }
+            end
+        end
+    end
+end

data/lib/jsshuffle/methods/variable_renaming.rb

@@ -6,7 +6,7 @@ module JsShuffle::Methods
         JsShuffle::Methods.methods[:variable_renaming] = self
 
         def process( ast, shuffler )
-            sourceNodes = ast.select do |node| node.is_a? RKelly::Nodes::SourceElementsNode end
+            sourceNodes = ast.select { |node| node.is_a? RKelly::Nodes::SourceElementsNode }
             sourceNodes.each do |node|
                 renamed_variables = {} 
                 node.value.each do |child|
@@ -15,9 +15,7 @@ module JsShuffle::Methods
                     elsif child.is_a? RKelly::Nodes::ResolveNode
                         child.value = renamed_variables[child.value] if renamed_variables.has_key? child.value
                     else
-                        child.each do |n|
-                            n.value = renamed_variables[n.value] if n.is_a? RKelly::Nodes::ResolveNode and renamed_variables.has_key? n.value
-                        end
+                        child.each { |n| n.value = renamed_variables[n.value] if n.is_a? RKelly::Nodes::ResolveNode and renamed_variables.has_key? n.value }
                     end
                 end
             end

data/lib/jsshuffle/shuffler.rb

@@ -9,7 +9,7 @@ module JsShuffle
         #   A +Symbol+, +Proc+ or a +Class+ inheriting from {JsShuffle::Methods::Method}[rdoc-ref:JsShuffle::Methods::Method] or an +Array+ mixing any of these types.
         #   Symbols are matched to JsShuffle's native {Methods}[rdoc-ref:JsShuffle::Methods] and should be lowercased and underscored (like the filenames of the corresponding +Method+)
         #   Procs are called three times and receive the +pass+ (one of +:preprocess+, +:process+ or +postprocess+), the AST and the {Shuffler}[rdoc-ref:JsShuffle::Shuffler] instance. In the last pass the js string is passed instead of the AST and the Proc is expected to return the modified string
-        def initialize( hash={ use: :variable_renaming } )
+        def initialize( hash={ use: [:variable_renaming, :parameter_renaming] } )
             @methods = hash[:use]
             @methods = [ @methods ] if @methods.is_a? Symbol
 
@@ -22,9 +22,7 @@ module JsShuffle
             end
 
             @defaults = {}
-            @methods.each do |m|
-                @defaults.merge! m.default_config if m.is_a? JsShuffle::Methods::Method
-            end
+            @methods.each { |m| @defaults.merge! m.default_config if m.is_a? JsShuffle::Methods::Method }
         end
 
         # Shuffle a javascript program string and return the result
@@ -57,7 +55,7 @@ module JsShuffle
             @new_names = []
             ast = hash[:ast] || @parser.parse( hash[:js] )
 
-            @methods.each do |m| m.configure options if m.is_a? JsShuffle::Methods::Method end
+            @methods.each { |m| m.configure options if m.is_a? JsShuffle::Methods::Method }
 
             [:preprocess, :process].each do |pass|
                 @methods.each do |m|
@@ -79,7 +77,7 @@ module JsShuffle
             return @parser.parse( js ) if hash[:ast]
             js
         end
-        
+
         # Generates a random new symbol name
         def random_new_name
             begin

data/lib/jsshuffle/version.rb

@@ -1,3 +1,3 @@
 module Jsshuffle
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/test_parameter_renaming.rb

@@ -0,0 +1,45 @@
+require 'test/unit'
+require 'jsshuffle'
+require 'execjs'
+
+class ParameterRenamingTest < Test::Unit::TestCase
+    def test_can_include
+        assert_nothing_raised do
+            @shuffler = JsShuffle::Shuffler.new use: :parameter_renaming
+        end
+    end
+
+    def test_name_changes
+        assert_nothing_raised { @shuffler = JsShuffle::Shuffler.new use: :parameter_renaming }
+        original = %Q(
+            function double(parameter) {
+                return parameter*2;
+            }
+        )
+        assert_not_equal original,
+            @shuffler.shuffle( js: original )
+    end
+
+    def test_code_works
+        assert_nothing_raised { @shuffler = JsShuffle::Shuffler.new use: :parameter_renaming }
+        shuffled = @shuffler.shuffle js: %Q(
+            function double(parameter) {
+                return parameter*2;
+            }
+            return double(333);
+        )
+        assert_equal 666,
+            ExecJS.exec( shuffled )
+    end
+
+    def test_references_updated
+        assert_nothing_raised { @shuffler = JsShuffle::Shuffler.new use: :parameter_renaming }
+        assert_no_match /parameter/,
+            @shuffler.shuffle( js: %Q(
+                function double(parameter) {
+                    return parameter*2;
+                }
+                return double(333);
+            ))
+    end
+end

data/test/test_shuffler.rb

@@ -0,0 +1,38 @@
+require 'test/unit'
+require 'jsshuffle'
+require 'execjs'
+
+class ShufflerTest < Test::Unit::TestCase
+    def test_instantiate
+        assert_nothing_raised do
+            @shuffler = JsShuffle::Shuffler.new
+        end
+    end
+
+    def test_default_does_something
+        assert_nothing_raised { @shuffler = JsShuffle::Shuffler.new }
+        original = "var beers_i_had = 5; return beers_i_had;"
+        shuffled = @shuffler.shuffle js: original
+
+        assert_not_equal original, shuffled
+
+        assert_equal 5,
+            ExecJS.exec( shuffled )
+    end
+
+    def test_code_works
+        assert_nothing_raised { @shuffler = JsShuffle::Shuffler.new }
+        shuffled = @shuffler.shuffle js: %Q(
+            var twelve = 12;
+            twelve = twelve + 2;
+            function subtract_three( number ) {
+                var local = number - 3;
+                return local;
+            }
+            return subtract_three( twelve ) + "-ish";
+        )
+
+        assert_equal "11-ish",
+            ExecJS.exec( shuffled )
+    end
+end

data/test/test_variable_renaming.rb

@@ -0,0 +1,34 @@
+require 'test/unit'
+require 'jsshuffle'
+require 'execjs'
+
+class VariableRenamingTest < Test::Unit::TestCase
+    def setup
+        @shuffler = JsShuffle::Shuffler.new use: :variable_renaming
+    end
+
+    def test_name_changes
+        original = "var beers_i_had = 5;"
+        assert_not_equal original,
+            @shuffler.shuffle( js: original )
+    end
+
+    def test_references_updated
+        assert_no_match /is_working/,
+            @shuffler.shuffle( js: %Q(
+                var is_working = true;
+                return is_working;
+            ))
+    end
+
+    def test_code_works
+        shuffled = @shuffler.shuffle js: %Q(
+            var twelve = 12;
+            twelve = twelve + 2;
+            return twelve;
+        )
+
+        assert_equal 14,
+            ExecJS.exec( shuffled )
+    end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsshuffle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-23 00:00:00.000000000 Z
+date: 2014-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -19,7 +19,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -35,7 +35,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -59,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.6
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.1
 description: 
 email:
 - s0lll0s@blinkenshell.org
@@ -77,10 +93,14 @@ files:
 - lib/jsshuffle.rb
 - lib/jsshuffle/methods.rb
 - lib/jsshuffle/methods/method.rb
+- lib/jsshuffle/methods/parameter_renaming.rb
 - lib/jsshuffle/methods/variable_renaming.rb
 - lib/jsshuffle/railtie.rb
 - lib/jsshuffle/shuffler.rb
 - lib/jsshuffle/version.rb
+- test/test_parameter_renaming.rb
+- test/test_shuffler.rb
+- test/test_variable_renaming.rb
 homepage: ''
 licenses:
 - MIT
@@ -106,4 +126,7 @@ rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A library to just-in-time randomly obfuscate JS
-test_files: []
+test_files:
+- test/test_parameter_renaming.rb
+- test/test_shuffler.rb
+- test/test_variable_renaming.rb