rub_a_scripts 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZjRkODY1Y2NmYmNhZWI4NDFkYmE4NGU3M2U1ODQxM2YzYjE5ZGNiZQ==
+  data.tar.gz: !binary |-
+    MWY4ODk2NzFlZjU4NWU2MDcxNTYwZTQ0YmM1ZDJmY2QyYTVjOTY5Nw==
+SHA512:
+  metadata.gz: !binary |-
+    MmY3ODhjOTRkY2FlYzg2MTE0ODk3OWRhMTA5ZGY4MjM1NzRmMmFhMTEzYmQz
+    NmY5MjA3OTkwMGZkNmI1YTYyY2E5MjJiOTM5MGU0ZTdmNmMwNWNmMzA1OGU3
+    MDljYWNhMjZjYTMxZGQzNGNlYTE4MTdjNjg4YmY0ZjY0MmNlZDk=
+  data.tar.gz: !binary |-
+    MjM5ZmNiZGFiOWRjZTc2ZjJhMzhkYjVlOWNjMDJlZTY2ZjgzY2Q0OWVlM2I5
+    N2U4OTg2Zjg3ZWYxZWJiZWE2ODk0ZmZjMTY0NjU2MTE3OTg5NGUzNTRhMmYw
+    YWNjOTRjMjI2ZTJkYWJlZDY1MjdmNjhkY2QyYTQxYjAxYzkzNGI=

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rake'
+
+task :build_gem do
+  File.open("#{Dir.pwd}/batch_jobs/build_doc.bat", 'w') {|file|
+    file.write("cd #{Dir.pwd}\n")
+    file.write("rdoc --op #{Dir.pwd}/doc\n")
+  }
+  system("#{Dir.pwd}/batch_jobs/build_doc.bat")
+  FileUtils.rm_rf(Dir.glob("batch_jobs/build_doc.bat"))
+  system("#{Dir.pwd}/batch_jobs/build_gem.bat")
+  system("#{Dir.pwd}/batch_jobs/install_gem.bat")
+
+  #gem_files = Dir.glob("rub_a_scripts*.gem")
+  #FileUtils.rm_rf(gem_files)
+end

data/bin/rub_a_scripts

@@ -0,0 +1 @@
+require 'rub_a_scripts'

data/lib/rub_a_scripts.rb

@@ -0,0 +1,238 @@
+require "inline"
+require 'Date'
+module Inline
+
+  ##
+  # VBScript Inline - allow simple inline of VBScript within Ruby.
+  #
+  class VBScript
+
+    ##
+    # extra_args: Allow the user to specify any other arguments they want to add. By default //Nologo is added.
+    #
+    attr_accessor :extra_args
+
+    def initialize(mod)
+      @context = mod
+      @src = ""
+      @imports = []
+      @sigs = []
+      @file_name = ''
+      @extra_args = '//Nologo'
+    end
+
+    ##
+    # Use by RubyInline to designate new file or to reuse cache. For VBScript
+    #   we simply create a new file every times so this will always be set to false.
+    #   Also crapped in here a method to clear out the inline folder if files are
+    #   more than 3 days old.
+    #
+    def load_cache
+      clear_inline_folder
+      false
+    end
+
+    ##
+    # This method will clear out the inline directory if any files is more than 3 days old.
+    #
+    def clear_inline_folder
+      files = Dir.glob("#{Inline.directory}/VBScript*")
+      files.each do |file|
+        file_time = File.ctime(file)
+        today_date = Date.today
+        if ((file_time.day - today_date.day) >= 2) and (file_time.month >= today_date.month) and (file_time.year >= today_date.year)
+          FileUtils.rm_rf(file)
+        end
+      end
+    end
+
+    ##
+    # Parse your VBScript to find a function name. Store them sor Ruby
+    #    can create a Ruby method with the exact name and parameters list.
+    #
+    def vbscript(src)
+      @src << src << "\n"
+      signature = src.match(/Function\W+([a-zA-Z0-9_]+)\((.*)\)/)
+      @sigs << [signature[1], signature[2], signature[3]] unless !signature
+      if !signature
+        signature = src.match(/Sub\W+([a-zA-Z0-9_]+)\((.*)\)/)
+        @sigs << [signature[1], signature[2], signature[3]] unless !signature
+      end
+    end
+
+    ##
+    # @build. Build source VBScript file to be later used for execution.
+    #   - grabbing all your vbscript source code
+    #   - creating a vbscript file and then inputing in the code
+    #   - it will also add an extra vbscript function that will
+    #   later be called to pass in parameters and output result to
+    #   a file so Ruby can pick up.
+    #
+    def build
+      @load_name = @name = "VBScript#{@src.hash.abs}"
+      @file_name = "#{Inline.directory}/#{@name}.vbs"
+      @src << extra_input_fx << "\n"
+      File.open(@file_name, 'w') {|file| file.write(@src)}
+    end
+
+    ##
+    # This method is used to dynamically create all the Ruby methods
+    #   that is associate with their VBScript methods. No doubt the
+    #   most important method of this module as it's reponsible for
+    #   creating handling interactions between Ruby and VBScript.
+    #
+    def load
+      @context.module_eval "const_set :#{@name}, Inline::VBScript;"
+
+      @context.module_eval "
+      def clean_cache
+        files = Dir.glob(\"\#{Inline.directory}/VBScript*\")
+        files.each {|file| FileUtils.rm_rf(file)}
+      end
+      def delete_file
+        File.delete('#{@file_name}') if File.exist?('#{@file_name}');
+      end
+      "
+
+      @context.module_eval "
+      def construct_arguments(*args)
+        @argument_to_send = ''
+        if args.class == Array
+          args.each_with_index do |top_level_item, args_index|
+            @argument_to_send += \",\" if args_index > 0
+            if top_level_item.class == Array
+              @argument_to_send += \"Array(\"
+              top_level_item.each_with_index do |inner_item, top_level_index|
+                @argument_to_send += \",\" if top_level_item.count != top_level_index and top_level_index > 0
+                @argument_to_send += construct_arguments(inner_item)
+              end
+              @argument_to_send += \")\"
+            else
+              case
+                when top_level_item.class == String
+                  @argument_to_send += %q[\"] + %Q[\#{top_level_item.to_s}] + %q[\"]
+                when top_level_item.class == Fixnum
+                  @argument_to_send += top_level_item.to_s
+                when top_level_item.class == TrueClass
+                  @argument_to_send += \"True\"
+                when top_level_item.class == FalseClass
+                  @argument_to_send += \"False\"
+                else
+                  @argument_to_send += top_level_item.to_s
+              end
+            end
+          end
+        end
+        return @argument_to_send
+      end
+      "
+
+      @sigs.each do |sig|
+        @context.module_eval "
+        def #{sig[0]}(*args);
+          @arguments_to_send = construct_arguments(args)
+          @arguments_to_send.sub!(\"Array(\",\"\").chomp!(\")\")
+          @arguments_to_send.gsub!(/\"/, \'\\'\')
+          @arguments_to_send.chomp!
+          execution_str = 'cscript #{@file_name} \"#{sig[0]}' + '(' + @arguments_to_send + ')\" #{@extra_args}';
+
+          IO.popen(execution_str).each do |line|
+            case
+              when (line.strip == \"nothing\" or line.strip == \"null\" or line.strip == \"Empty\")
+                @result = nil
+              when line.strip == \"False\"
+                @result = false
+              when line.strip == \"True\"
+                @result = true
+              when line.strip[/^[-+]?[0-9]+$/]
+                @result = line.strip.to_i
+              when line.strip[/^[-+]?[\\d]+(\\.[\\d]+){0,1}$/]
+                @result = line.strip.to_f
+              when line.strip[/Array\\[.*\\]/]
+                begin
+                  @result = eval(line.strip.gsub(\"Array\",\"\").gsub(\"True\",\"true\").gsub(\"False\",\"false\"))
+                rescue => e
+                  @result = line.strip;
+                  warn(e)
+                end
+              else
+                @result = line.strip;
+            end
+          end.close
+          return @result
+        end"
+      end
+    end
+
+    ##
+    # The inside man. This source code and methods is added and inject into the VBScript.
+    #   It's responsible for picking up arguments and executing the VBScript function
+    #   being called. Will also write result to stdout so that Ruby can pick up.
+    #   A few basic mapping and error handling is also being done here vs the load method on the Ruby side.
+    #
+    def extra_input_fx()
+      my_str1 = '
+      Function fxWriteOutput
+		    InputArgs = WScript.Arguments.Item(0)
+        InputArgs = Replace(InputArgs, "\'", chr(34))
+	      if WScript.Arguments.Count() > 0 Then
+          On Error Resume Next
+            fx_value = Eval(InputArgs)
+            If Err.Number <> 0 Then
+              If Err.Description = "Object doesn\'t support this property or method" Then
+                fx_value = "Error: " & Err.Description & ". Sorry!!! Object are not mapped."
+              End If
+              Err.Clear
+            End If
+          On Error Goto 0
+          ' + "\n"
+      my_str_3 = '
+            if IsArray(fx_value) = False Then
+              if fx_value = True Then
+                WScript.Echo "True"
+              elseif IsEmpty(fx_value) Then
+                WScript.Echo "Empty"
+              elseif fx_value = False Then
+                WScript.Echo "False"
+              else
+                WScript.Echo fx_value
+              End If
+            else
+              my_array_list = "Array" & abcExpandArray(fx_value)
+              WScript.Echo my_array_list
+            End if
+        End if
+      End Function
+      fxWriteOutput()
+
+      Function abcExpandArray(fx_value)
+	      If IsArray(fx_value) Then
+          For i = (lbound(fx_value)) to ubound(fx_value)
+            if i > 0 Then
+              finalStr = finalStr & "," & abcExpandArray(fx_value(i))
+            Else
+              finalStr = finalStr & abcExpandArray(fx_value(i))
+            End If
+          Next
+          abcExpandArray = "[" & finalStr  & "]"
+        Else
+          If IsNumeric(fx_value) Then
+            abcExpandArray = fx_value
+          ElseIf fx_value = True Then
+            abcExpandArray =  "True"
+          ElseIf IsEmpty(fx_value) Then
+            abcExpandArray =  "Empty"
+          ElseIf fx_value = False Then
+            abcExpandArray =  "False"
+          Else
+            abcExpandArray = """" & fx_value & """"
+          End If
+	      End If
+      End Function
+      '
+      return (my_str1 + my_str_3)
+    end
+
+  end
+
+end

data/test/test_rub_a_scripts.rb

@@ -0,0 +1,194 @@
+require 'rub_a_scripts'
+require 'minitest'
+require 'minitest/autorun'
+
+class MyVBScriptClass
+
+  inline :VBScript do |builder|
+    builder.vbscript '
+    Function fnSum(var1,var2)
+      vrSum = var1 + var2
+      fnSum = vrSum
+    End Function
+    '
+
+    builder.vbscript '
+    Function fnSubtract(var1,var2)
+      vrSubtract = var1 - var2
+      fnSubtract = vrSubtract
+    End Function
+    '
+
+    builder.vbscript '
+    Function fnString(input)
+      fnString = input & " World!!!"
+    End Function
+    '
+
+    builder.vbscript '
+    Function fnBoolean(input)
+      if input = True then
+        fnBoolean = False
+      else
+        fnBoolean = True
+      End If
+    End Function
+    '
+
+    builder.vbscript'
+     \'WScript.Echo "Hello Cruel Cruel World!!!"
+    '
+
+    builder.vbscript '
+    Function fnArray(input)
+      fnArray = input(2)
+    End Function
+    '
+
+    builder.vbscript '
+    Function fn2Array(input, input2)
+      fn2Array = input2(5)
+    End Function
+    '
+
+    builder.vbscript '
+    Function fnNull()
+      fnNull = "nothing"
+    End Function
+    '
+
+    builder.vbscript '
+    Function fnDecimal()
+      fnDecimal = 123.13
+    End Function
+    '
+
+    builder.vbscript '
+    Function fnDecimalNegative()
+      fnDecimalNegative = -1234567.13
+    End Function
+    '
+
+    builder.vbscript '
+    Function fnReturnArray()
+     fnReturnArray = Array(3,9,4,0,8,2)
+    End Function
+    '
+
+    builder.vbscript '
+    Function fnReturn2DArray()
+      array1 = Array(1,3)
+      array2 = Array("Hello", "World")
+      fnReturn2DArray = Array(array1,array2,True)
+    End Function
+    '
+
+    builder.vbscript '
+    Function fnProcessMultiDimArray(input)
+      fnProcessMultiDimArray = input
+    End Function
+    '
+
+    builder.vbscript '
+    Function fnObject()
+      set fso = CreateObject("Scripting.FileSystemObject")
+      Set fnObject = fso
+    End Function
+    '
+
+    builder.vbscript '
+    Sub subString()
+      WScript.Echo "I am inside a Procedures!!!"
+      response.write("I was written by a sub procedure")
+    End Sub
+    '
+
+  end
+
+end
+
+class TestRubAScript < Minitest::Test
+  def setup
+    @vb_script_obj = MyVBScriptClass.new()
+    @my_str = "Hello"
+    @my_array = ['a', 'b', 'c', 'd', 'e', 'f']
+    @my_array2 = ["1", "2", "3", "4", "5", "6"]
+    @my_array3 = [9,[0],[[1],[[2],[3]],[4]],"Hello World"]
+    @error_str = "Error: Object doesn't support this property or method. Sorry!!! Object are not mapped."
+  end
+
+  def test_fnSum
+    assert_equal 8, @vb_script_obj.fnSum(3,5)
+  end
+
+  def test_fnSubtract
+    assert_equal 5, @vb_script_obj.fnSubtract(8,3)
+  end
+
+  def test_fnSubtractNegative
+    assert_equal -5, @vb_script_obj.fnSubtract(3,8)
+  end
+
+  def test_fnString
+    assert_equal "Hello World!!!", @vb_script_obj.fnString('Hello')
+  end
+
+  def test_fnString_with_var
+    assert_equal "Hello World!!!", @vb_script_obj.fnString(@my_str)
+  end
+
+  def test_fnBoolean_true
+    assert_equal false, @vb_script_obj.fnBoolean(true)
+  end
+
+  def test_fnBoolean_false
+    assert_equal true, @vb_script_obj.fnBoolean(false)
+  end
+
+  def test_fnArray
+    assert_equal "c", @vb_script_obj.fnArray(@my_array)
+  end
+
+  def test_2fnArray
+    assert_equal 6, @vb_script_obj.fn2Array(@my_array, @my_array2)
+  end
+
+  def test_fnNull
+    assert_equal nil, @vb_script_obj.fnNull
+  end
+
+  def test_fnDecimal
+    assert_equal 123.13, @vb_script_obj.fnDecimal
+  end
+
+  def test_fnDecimal
+    assert_equal -1234567.13, @vb_script_obj.fnDecimalNegative
+  end
+
+  def test_fnReturnArray
+    assert_equal [3,9,4,0,8,2], @vb_script_obj.fnReturnArray()
+  end
+
+  def test_fnReturn2DArray
+    assert_equal [[1,3],['Hello', 'World'], true], @vb_script_obj.fnReturn2DArray()
+  end
+
+  def test_fnProcessMultiDimArray
+    assert_equal @my_array3, @vb_script_obj.fnProcessMultiDimArray(@my_array3)
+  end
+
+  def test_fnObject
+    assert_equal @error_str, @vb_script_obj.fnObject
+  end
+
+  def test_subString()
+    assert_equal nil, @vb_script_obj.subString()
+  end
+
+end
+
+Minitest.after_run {
+  @test = MyVBScriptClass.new()
+  @test.delete_file
+  @test.clean_cache
+}

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: rub_a_scripts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kent T. Le
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-25 00:00:00.000000000 Z
+dependencies: []
+description: An extension of RubyInline. Allow for the use of VBScript in Ruby.
+email: Le.78@osu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- bin/rub_a_scripts
+- lib/rub_a_scripts.rb
+- test/test_rub_a_scripts.rb
+homepage: https://github.com/KentViet/rub_a_scripts
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- test
+- bin
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An extension of RubyInline gem. rub_a_scripts allows you to write VBScript
+  within Ruby code. The extensions are then automatically loaded into the class/module
+  that defines it. Allowing ruby to call on VBScript function and procedure. Basic
+  data types are mapped as such facilitate the exchange of data between the two languages.
+test_files:
+- test/test_rub_a_scripts.rb