netlinx-compile 1.0.0

data/lib/netlinx/compiler_result.rb

@@ -0,0 +1,72 @@
+module NetLinx
+  # Contains info pertaining to a job run through the compiler.
+  class CompilerResult
+    # The raw stream of text returned by the compiler.
+    attr_reader :stream
+    # Number of compiler errors.
+    attr_reader :errors
+    # Number of compiler warnings.
+    attr_reader :warnings
+    
+    # Implement the Compilable interface.
+    
+    # See Compilable interface.
+    attr_reader :compiler_target_files
+    # See Compilable interface.
+    attr_reader :compiler_include_paths
+    # See Compilable interface.
+    attr_reader :compiler_module_paths
+    # See Compilable interface.
+    attr_reader :compiler_library_paths
+    
+    # Args:
+    #  stream -- The raw stream of text returned by the compiler.
+    #  compiler_target_files  -- See Compilable interface.
+    #  compiler_include_paths -- See Compilable interface.
+    #  compiler_module_paths  -- See Compilable interface.
+    #  compiler_library_paths -- See Compilable interface.
+    def initialize(**kvargs)
+      @stream   = kvargs.fetch :stream,   ''
+      
+      @compiler_target_files  = kvargs.fetch :compiler_target_files,  []
+      @compiler_include_paths = kvargs.fetch :compiler_include_paths, []
+      @compiler_module_paths  = kvargs.fetch :compiler_module_paths,  []
+      @compiler_library_paths = kvargs.fetch :compiler_library_paths, []      
+      
+      # Capture error and warning counts.
+      @errors = nil
+      @warnings = nil
+      
+      @stream.scan /(\d+) error\(s\), (\d+) warning\(s\)/ do |e, w|
+        @errors   = e.to_i if e
+        @warnings = w.to_i if w
+      end
+    end
+    
+    # Alias of #stream.
+    def to_s
+      @stream
+    end
+    
+    # Returns the absolute path of the source code file that was compiled.
+    def target_file
+      @compiler_target_files.first
+    end
+    
+    # Compile was successful?
+    def success?
+      @errors == 0 && @warnings == 0
+    end
+    
+    # An enumerable list of warnings.
+    def warning_items
+      @stream.scan(/(^WARNING: .*$)/).map {|i| i.first}
+    end
+    
+    # An enumerable list of errors.
+    def error_items
+      @stream.scan(/(^ERROR: .*$)/).map {|i| i.first}
+    end
+    
+  end
+end

data/lib/netlinx/source_file.rb

@@ -0,0 +1,78 @@
+module NetLinx
+  class SourceFile
+    
+    # Parameters:
+    #   file: Name or path of the file to compile.
+    #   compiler_include_paths: Array of additional paths for the compiler to find include files.
+    #   compiler_module_paths: Array of additional paths for the compiler to find module files.
+    #     NOTE: SourceFile already searches the body of the source file to automatically determine
+    #           include and module paths.
+    def initialize(**kvargs)
+      @compiler_target_files  = [ (kvargs.fetch :file, nil) ]
+      @compiler_include_paths = kvargs.fetch :compiler_include_paths, []
+      @compiler_module_paths  = kvargs.fetch :compiler_module_paths,  []
+      
+      return unless @compiler_target_files.first
+      
+      source_code = File.open(@compiler_target_files.first).read
+      
+      # Scan file for additional include paths.
+      includes = source_code.scan(/(?i)^\s*(?:\#include)\s+'([\w\-]+)'/)
+      
+      includes.each do |inc|
+        inc = inc.first
+        
+        path = Dir["./**/#{inc}.*"].first
+        next unless path
+        
+        path = File.expand_path path
+        @compiler_include_paths << File.dirname(path)
+      end
+      
+      @compiler_include_paths.uniq!
+      
+      # Scan file for additional module paths.
+      modules = source_code.scan(/(?i)^\s*(?:define_module)\s+'([\w\-]+)'/)
+      
+      modules.each do |mod|
+        mod = mod.first
+        
+        path = Dir["./**/#{mod}.*"].first
+        next unless path
+        
+        path = File.expand_path path
+        @compiler_module_paths << File.dirname(path)
+      end
+      
+      @compiler_module_paths.uniq!
+    end
+    
+    # See Test::NetLinx::Compilable interface.
+    def compiler_target_files
+      @compiler_target_files
+    end
+    
+    # See Test::NetLinx::Compilable interface.
+    def compiler_include_paths
+      @compiler_include_paths
+    end
+    
+    # See Test::NetLinx::Compilable interface.
+    def compiler_module_paths
+      @compiler_module_paths
+    end
+    
+    # See Test::NetLinx::Compilable interface.
+    def compiler_library_paths
+      []
+    end
+    
+    # Execute the compiler on itself.
+    def compile
+      require 'netlinx/compiler'
+      compiler = NetLinx::Compiler.new
+      result = compiler.compile self
+    end
+    
+  end
+end

data/lib/test/netlinx/compilable.rb

@@ -0,0 +1,48 @@
+module Test
+  module NetLinx
+    # Interface tests for an object that can be compiled with NetLinx::Compiler.
+    module Compilable
+      
+      # :nodoc:
+      def test_responds_to_compiler_target_files
+        assert_respond_to @object, :compiler_target_files
+      end
+      
+      # :nodoc:
+      def test_responds_to_compiler_include_paths
+        assert_respond_to @object, :compiler_include_paths
+      end
+      
+      # :nodoc:
+      def test_responds_to_compiler_library_paths
+        assert_respond_to @object, :compiler_library_paths
+      end
+      
+      # :nodoc:
+      def test_responds_to_compiler_module_paths
+        assert_respond_to @object, :compiler_module_paths
+      end
+      
+      # :nodoc:
+      def test_compiler_target_files_is_an_array
+        assert @object.compiler_target_files.is_a? Array
+      end
+      
+      # :nodoc:
+      def test_compiler_include_paths_is_an_array
+        assert @object.compiler_include_paths.is_a? Array
+      end
+      
+      # :nodoc:  
+      def test_compiler_library_paths_is_an_array
+        assert @object.compiler_library_paths.is_a? Array
+      end
+      
+      # :nodoc:
+      def test_compiler_module_paths_is_an_array
+        assert @object.compiler_module_paths.is_a? Array
+      end
+      
+    end
+  end
+end

data/lib/test/netlinx/compile/discoverable.rb

@@ -0,0 +1,14 @@
+module Test
+  module NetLinx
+    module Compile
+      # Interface tests for an object that registers an EventHandler
+      # under NetLinx::Compile::Extension.
+      module Discoverable
+        # :nodoc:
+        def test_responds_to_get_handler
+          assert_respond_to @object, :get_handler
+        end
+      end
+    end
+  end
+end

data/lib/test/netlinx/compile/invokable.rb

@@ -0,0 +1,15 @@
+module Test
+  module NetLinx
+    module Compile
+      # Interface tests for an object that provides a means to
+      # invoke the compiler on a Compilable file extension.
+      # See ExtensionDiscovery.
+      module Invokable
+        # :nodoc:
+        def test_responds_to_compile
+          assert_respond_to @object, :compile
+        end
+      end
+    end
+  end
+end

data/license.txt

@@ -0,0 +1,13 @@
+Copyright 2013 Alex McLain
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: netlinx-compile
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex McLain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This library provides an executable, netlinx-compile, that wraps the
+  nlrc.exe NetLinx compiler provided by AMX. It is designed for easier command line
+  access, as well as for integration with third-party tools with source code build
+  support, like text editors and IDE's. Also provided in this library is a Ruby API
+  for invoking the NetLinx compiler.
+email: alex@alexmclain.com
+executables:
+- netlinx-compile
+extensions: []
+extra_rdoc_files: []
+files:
+- license.txt
+- README.txt
+- bin/netlinx-compile
+- lib/netlinx/compile/extension/axs.rb
+- lib/netlinx/compile/extension_discovery.rb
+- lib/netlinx/compile/extension_handler.rb
+- lib/netlinx/compile/script.rb
+- lib/netlinx/compiler.rb
+- lib/netlinx/compiler_result.rb
+- lib/netlinx/source_file.rb
+- lib/netlinx-compile.rb
+- lib/test/netlinx/compilable.rb
+- lib/test/netlinx/compile/discoverable.rb
+- lib/test/netlinx/compile/invokable.rb
+- doc/created.rid
+- doc/images/add.png
+- doc/images/arrow_up.png
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/delete.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_blue.png
+- doc/images/tag_green.png
+- doc/images/transparent.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/jquery.js
+- doc/js/navigation.js
+- doc/js/search.js
+- doc/js/searcher.js
+- doc/js/search_index.js
+- doc/NetLinx/Compile/Extension/AXS.html
+- doc/NetLinx/Compile/Extension.html
+- doc/NetLinx/Compile/ExtensionDiscovery.html
+- doc/NetLinx/Compile/ExtensionHandler.html
+- doc/NetLinx/Compile/Script.html
+- doc/NetLinx/Compile.html
+- doc/NetLinx/Compiler.html
+- doc/NetLinx/CompilerResult.html
+- doc/NetLinx/NoCompilerError.html
+- doc/NetLinx/SourceFile.html
+- doc/NetLinx.html
+- doc/rdoc.css
+- doc/table_of_contents.html
+- doc/Test/NetLinx/Compilable.html
+- doc/Test/NetLinx/Compile/Discoverable.html
+- doc/Test/NetLinx/Compile/Invokable.html
+- doc/Test/NetLinx/Compile.html
+- doc/Test/NetLinx.html
+- doc/Test.html
+homepage: https://sourceforge.net/projects/netlinx-compile/
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A wrapper utility for the AMX NetLinx compiler.
+test_files: []