naether 0.9.2-java → 0.10.0-java

data/lib/naether.rb

@@ -17,10 +17,11 @@ require "#{File.dirname(__FILE__)}/naether/configuration"
 require "#{File.dirname(__FILE__)}/naether/bootstrap"
 require "#{File.dirname(__FILE__)}/naether/java"
 
-
-# Java dependency resolver.
+#
+# Java dependency resolver
 #
 # @author Michael Guymon
+# @see https://github.com/mguymon/naether/tree/master/core
 #
 class Naether
   
@@ -28,7 +29,7 @@ class Naether
   
   class << self
     
-    # Helper for Java dependencies needed to bootstrap Naether
+    # List of Java dependencies needed to bootstrap Naether
     # 
     # @param [String] dep_file path
     # @see {Naether::Bootstrap#dependencies}
@@ -57,7 +58,7 @@ class Naether
   
   # Create new instance.
   def initialize
-    @resolver = Naether::Java.create('com.tobedevoured.naether.Naether')
+    @resolver = Naether::Java.create('com.tobedevoured.naether.impl.NaetherImpl')
   end
   
   # Clear all remote repositories
@@ -250,7 +251,7 @@ class Naether
   #
   # @return [Array]
   def dependencies
-    Naether::Java.convert_to_ruby_array( @resolver.getDependencies() )
+    Naether::Java.convert_to_ruby_array( @resolver.currentDependencies() )
   end
   
   # Get array of dependencies as notation
@@ -271,11 +272,37 @@ class Naether
   # Convert dependencies to Classpath friendly string
   #
   # @return [String]
-  def dependencies_classpath()
+  def dependencies_classpath
     @resolver.getResolvedClassPath()
   end
   
+  # Dependencies as a Graph of nested Hashes
+  #
+  # @return [Hash]
+  def dependencies_graph(nodes=nil)
+    nodes = @resolver.getDependenciesGraph() unless nodes
+    
+    graph = {}
+    if Naether.platform == 'java'
+      nodes.each do |k,v|
+        deps = dependencies_graph(v)
+        graph[k] = Naether::Java.convert_to_ruby_hash( deps )
+      end
+    else
+      iterator = nodes.entrySet().iterator();
+      while iterator.hasNext()
+          entry = iterator.next()
+          deps = dependencies_graph(entry.getValue())
+          graph[entry.getKey().toString()] = Naether::Java.convert_to_ruby_hash( deps )
+      end
+    end
+    
+    graph
+  end
+  
   # Load dependencies to Classpath
+  #
+  # @return [Array] of loaded jars
   def load_dependencies_to_classpath
     jars = dependencies_classpath.split(":")
     Naether::Java.load_jars(jars)

data/lib/naether/bootstrap.rb

@@ -5,12 +5,11 @@ require 'open-uri'
 require 'fileutils'
         
 class Naether
-  # :title:Naether::Bootstrap
+  
   #
   # Helper for bootstrapping Naether
   #
-  # = Authors
-  # Michael Guymon
+  # @author Michael Guymon
   #
   class Bootstrap
     
@@ -18,11 +17,14 @@ class Naether
     
     class << self
       
+      # Default local repo of ENV['M2_REPO'] or ~/.m2/repository
+      #
+      # @return [String]
       def default_local_repo
         ENV['M2_REPO'] || File.expand_path('~/.m2/repository')
       end
       
-      # write bootstrap dependencies to yaml file
+      # Write bootstrap dependencies to yaml file
       def write_dependencies( dest = 'jar_dependencies.yml' )
         deps = {};
         if Naether::Configuration.platform == 'java'
@@ -37,7 +39,11 @@ class Naether
         end
       end
       
-      # List of Java dependencies for Naether
+      # List of Java dependencies for Naether from yaml dependency file. Caches
+      # result after first run.
+      # 
+      # @param [String] dep_file path, defaults to Naether::Configuration.dependencies_yml
+      # @return [List]
       def dependencies( dep_file=nil )
         
         if @@dependencies
@@ -53,6 +59,11 @@ class Naether
       end
       
 
+      #
+      # Bootstrap the local repo by downloading Naether's dependencies
+      # @param [String] local_repo defaults to #default_local_repo
+      # @param [hash] opts
+      #
       def bootstrap_local_repo(local_repo = nil, opts = {} )
         local_repo = local_repo || default_local_repo
         
@@ -71,10 +82,16 @@ class Naether
           install_dependencies_to_local_repo( deps[:downloaded], jars, opts )
         end
         
-        #raise Naether::Java.instance.java.class_loader.getLoadedPaths().map { |x| x.toString() }.sort.inspect
+        #raise Naether::Java.internal_loaded_paths.inspect
         
       end
       
+      #
+      # Download Naether dependencies
+      #
+      # @param [String] dest to download dependencies t
+      # @param [Hash] opts
+      # @return [Hash] with status of missing, downloaded, exists dependencies
       def download_dependencies( dest, opts = {} )
          
         if !File.exists? dest
@@ -121,6 +138,12 @@ class Naether
         deps
       end
       
+      #
+      # Check local_repo for Naether dependencies
+      # 
+      # @param [String] local_repo
+      # @param [Hash] opts
+      # @return [Hash] with status of missing, downloaded, exists dependencies
       def check_local_repo_for_deps(local_repo = nil, opts = {} )
         
         local_repo = local_repo || default_local_repo
@@ -151,6 +174,14 @@ class Naether
         deps
       end
       
+      #
+      # Install Naether Dependencies to local_repo
+      # 
+      # @param [Array<String>] install_jars 
+      # @param [Array<String>] naether_jars to bootstrap Naether. These may overlap with install_jars.
+      # @param [Hash] opts
+      # @return [Naether]
+      #
       def install_dependencies_to_local_repo( install_jars, naether_jars, opts = {}  )
           
         require "#{File.dirname(__FILE__)}/../naether"

data/lib/naether/configuration.rb

@@ -1,5 +1,9 @@
 
 class Naether
+  
+  #
+  # Naether runtime configuration
+  #
   class Configurator
     def initialize(data={})
       gem_dir = File.expand_path("#{File.dirname(__FILE__)}/../../")
@@ -19,7 +23,7 @@ class Naether
       
       @data = {
         :gem_dir =>     gem_dir,
-        :naether_jar => File.join( gem_dir, "naether-#{version}.jar"),
+        :naether_jar => File.join( gem_dir, "core-#{version}.jar"),
         :platform =>    ($platform || RUBY_PLATFORM[/java/] || 'ruby'),
         :version =>     version,
         :dependencies_yml => File.expand_path("#{File.dirname( __FILE__ )}/../../jar_dependencies.yml")

data/lib/naether/java.rb

@@ -1,13 +1,11 @@
 require 'singleton'
 require "#{File.dirname(__FILE__)}/configuration"
 
-# :title:Naether::Java
 #
-# Handles loading jars. Determines correct platform to use, Naether::Java::JRuby
+# Handles loading jars using the correct platform, Naether::Java::JRuby
 # or Naether::Java::Ruby
 #
-# = Authors
-# Michael Guymon
+# @author Michael Guymon
 #
 class Naether
   class Java
@@ -15,6 +13,10 @@ class Naether
     
     attr_reader :java
     
+    #
+    # Creates new instance by loading the Naether jar to the parent ClassLoader
+    # and creating the internal Naether ClassLoader
+    #
     def initialize()
       naether_jar = Naether::Configuration.naether_jar
       
@@ -24,44 +26,93 @@ class Naether
       
       if Naether::Configuration.platform == 'java'
         require "#{File.dirname(__FILE__)}/java/jruby"
-        @java = Naether::Java::JRuby.instance
+        @java = Naether::Java::JRuby.new
       else
         require "#{File.dirname(__FILE__)}/java/ruby"
-        @java = Naether::Java::Ruby.instance
+        @java = Naether::Java::Ruby.new
       end
     end
     
+    #
     # Paths loaded
+    #
+    # @return [Array] of String paths
+    #
     def self.loaded_paths
       instance.java.loaded_paths
     end
     
-    # Load paths for the runtime platform
+    #
+    # Load a path onto the parent ClassLoader
+    #
+    # @param [Array] paths as an Array of String paths or a String path
+    #
     def self.load_paths(paths)
       instance.java.load_paths(paths)
     end
     
-    # Load paths for the runtime platform
+    def self.internal_loaded_paths
+      convert_to_ruby_array( instance.java.class_loader.getLoadedPaths, true )
+    end
+    
+    #
+    # Load a path into the internal Naether ClassLoader
+    #
+    # @param [Array] paths as an Array of String paths or a String path
+    #
     def self.internal_load_paths(paths)
       instance.java.internal_load_paths(paths)
     end
-    
+ 
+    #
+    # Create a Java Object from the Naether Class Loader
+    #
+    # @param [String] target_class to create
+    # @param [Array] args Array of constructor arguments   
     def self.create( target_class, *args )
       instance.java.create( target_class, *args )
     end
     
-    def self.exec_static_method( target_class, target_method, *args ) 
-      instance.java.exec_static_method( target_class, target_method, *args )
+    #
+    # Execute a Staic method on a Java class from the Naether Class Loader
+    #
+    # @param [String] target_class
+    # @param [String] target_method
+    # @param [Array] params Array of method parameters
+    # @param [Array] types if defined, a Array of String classes of params type that lines up with params one to one.
+    # @return [Object]
+    def self.exec_static_method( target_class, target_method, params, types = nil ) 
+      instance.java.exec_static_method( target_class, target_method, params, types )
     end
     
+    #
+    # Convert a Ruby Array to a java.util.ArrayList
+    # 
+    # @param [Array] ruby_array to convert to Java.util.ArrayList
+    # @return [java.util.ArrayList]
+    #    
     def self.convert_to_java_list( ruby_array )
       instance.java.convert_to_java_list( ruby_array )
     end
     
+    #
+    # Convert a java,util.List to a Ruby Array
+    #
+    # @param [java.util.ArrayList] java_array
+    # @param [Boolean] to_string platform dependent helper
+    # @return [Array]
+    #
     def self.convert_to_ruby_array( java_array, to_string = false )
       instance.java.convert_to_ruby_array( java_array, to_string )
     end
-    
+
+    #
+    # Convert a java.util.Map to a Ruby Hash
+    #
+    # @param [java.util.Map] java_hash
+    # @param [Boolean] to_string platform dependent helper
+    # @return [Hash]
+    #
     def self.convert_to_ruby_hash( java_hash, to_string = false )
       instance.java.convert_to_ruby_hash( java_hash, to_string )
     end

data/lib/naether/java/jruby.rb

@@ -1,23 +1,20 @@
 require "#{File.dirname(__FILE__)}/../configuration"
 
-# :title:Naether::Java::JRuby
-#
-# Singletn that handles Java interactions for JRuby. Providers helpers for 
+
+# Handles Java interactions for JRuby. Providers helpers for 
 # nomalizing accesss.
 
-# = Authors
-# Michael Guymon
+# @author Michael Guymon
 #
 class Naether
   class Java
 
     class JRuby
-      include Singleton
       
       attr_reader :loaded_paths, :class_loader
       
       #
-      # Creates new instance by loading the Naether jar to the global ClassLoader
+      # Creates new instance by loading the Naether jar to the parent ClassLoader
       # and creating the internal Naether ClassLoader
       #
       def initialize
@@ -33,15 +30,22 @@ class Naether
       end
       
       #
-      # Create a Java Object
+      # Create a Java Object from the Naether Class Loader
       #
+      # @param [String] target_class to create
+      # @param [Array] args Array of constructor arguments
       def create( target_class, *args )
         @class_loader.newInstance(target_class, *args )
       end
       
       #
-      # Execute a Staic method on a Java class
+      # Execute a Staic method on a Java class from the Naether Class Loader
       #
+      # @param [String] target_class
+      # @param [String] target_method
+      # @param [Array] params Array of method parameters
+      # @param [Array] types if defined, a Array of String classes of params type that lines up with params one to one.
+      # @return [Object]
       def exec_static_method( target_class, target_method, params, types = nil ) 
         unless params.is_a? Array
           params = [params]
@@ -59,6 +63,8 @@ class Naether
       #
       # Load a path into the internal Naether ClassLoader
       #
+      # @param [Array] paths as an Array of String paths or a String path
+      #
       def internal_load_paths(paths)
         load_paths = []
         unless paths.is_a? Array
@@ -78,7 +84,9 @@ class Naether
       end
       
       #
-      # Load a path onto the Global ClassLoader
+      # Load a path onto the parent ClassLoader
+      #
+      # @param [Array] paths as an Array of String paths or a String path
       #
       def load_paths(paths)
         load_paths = []
@@ -99,7 +107,10 @@ class Naether
       end
       
       #
-      # Convert a Ruby Array to a Java ArrayList
+      # Convert a Ruby Array to a java.util.ArrayList
+      # 
+      # @param [Array] ruby_array Array to convert to Java.util.ArrayList
+      # @return [java.util.ArrayList]
       #
       def convert_to_java_list( ruby_array ) 
         list = java.util.ArrayList.new
@@ -111,17 +122,31 @@ class Naether
       end
       
       #
-      # Convert a Java List to a Ruby Array
+      # Convert a java,util.List to a Ruby Array
+      #
+      # @param [java.util.ArrayList] java_array
+      # @param [Boolean] to_string has no affect on conversion.
+      # @return [Array]
       #
       def convert_to_ruby_array( java_array, to_string = false )
         java_array.to_a
       end
       
       #
-      # Convert a Java Map to a Ruby Hash
+      # Convert a java.util.Map to a Ruby Hash
+      #
+      # @param [java.util.Map] java_hash
+      # @param [Boolean] to_string has no affect on conversion
+      # @return [Hash]
       #
       def convert_to_ruby_hash( java_hash, to_string = false )
-        java_hash.to_hash
+        hash = java_hash.to_hash
+        
+        hash.each do |k,v|
+          if v.is_a? java.util.Map
+            hash[k] = convert_to_ruby_hash(v, to_string )
+          end
+        end
       end
     
     end    

data/lib/naether/java/ruby.rb

@@ -1,21 +1,21 @@
 require "#{File.dirname(__FILE__)}/../configuration"
 
-# :title:Naether::Java::Ruby
-#
-# Sngleton that handles Java interactions for Ruby using RJB. Providers helpers for
+# Handles Java interactions for Ruby using RJB. Providers helpers for
 # nomalizing accesss.
 #
-# = Authors
-# Michael Guymon
+# @author Michael Guymon
 #
 class Naether
   class Java
 
     class Ruby
-      include Singleton
       
       attr_reader :loaded_paths, :class_loader
       
+      #
+      # Creates new instance by loading the Naether jar to the parent ClassLoader
+      # and creating the internal Naether ClassLoader
+      #
       def initialize
         require 'rjb' 
         
@@ -35,6 +35,11 @@ class Naether
         
       end
       
+      #
+      # Create a Java Object from the Naether Class Loader
+      #
+      # @param [String] target_class to create
+      # @param [Array] args Array of constructor arguments
       def create( target_class, *args )
         #@class_loader.newInstance(target_class, *args )
         if args.size > 0
@@ -44,6 +49,14 @@ class Naether
         end
       end
       
+      #
+      # Execute a Staic method on a Java class from the Naether Class Loader
+      #
+      # @param [String] target_class
+      # @param [String] target_method
+      # @param [Array] params Array of method parameters
+      # @param [Array] types if defined, a Array of String classes of params type that lines up with params one to one.
+      # @return [Object]
       def exec_static_method( target_class, target_method, params, types = nil ) 
         unless params.is_a? Array
           params = [params]
@@ -72,7 +85,12 @@ class Naether
           end
         end
       end
-      
+     
+      #
+      # Load a path into the internal Naether ClassLoader
+      #
+      # @param [Array] paths as an Array of String paths or a String path
+      #
       def internal_load_paths(paths)
         loadable_paths = []
         unless paths.is_a? Array
@@ -90,6 +108,11 @@ class Naether
         loadable_paths
       end
       
+      #
+      # Load a path onto the parent ClassLoader
+      #
+      # @param [Array] paths as an Array of String paths or a String path
+      #
       def load_paths(paths)
         loadable_paths = []
         unless paths.is_a? Array
@@ -108,6 +131,12 @@ class Naether
         loadable_paths
       end
       
+     #
+     # Convert a Ruby Array to a java.util.ArrayList
+     # 
+     # @param [Array] ruby_array Array to convert to Java.util.ArrayList
+     # @return [java.util.ArrayList]
+     #
       def convert_to_java_list( ruby_array ) 
         list = Rjb::import("java.util.ArrayList").new
         ruby_array.each do |item|
@@ -117,6 +146,13 @@ class Naether
         list
       end
       
+      #
+      # Convert a java,util.List to a Ruby Array
+      #
+      # @param [java.util.ArrayList] java_array
+      # @param [Boolean] to_string converts each element using toString
+      # @return [Array]
+      #      
       def convert_to_ruby_array( java_array, to_string = false )
         ruby_array = java_array.toArray()
         
@@ -127,20 +163,37 @@ class Naether
         ruby_array
       end
       
+      #
+      # Convert a java.util.Map to a Ruby Hash
+      #
+      # @param [java.util.Map] java_hash
+      # @param [Boolean] to_string converts each element using toString 
+      # @return [Hash]
+      #
       def convert_to_ruby_hash( java_hash, to_string = false )
         
         hash = {}
-        keys = java_hash.keySet()
-        iterator = keys.iterator()
-        if to_string
-          while iterator.hasNext()
-            key = iterator.next().toString()
-            hash[key] = java_hash.get( key ).toString()
+        unless java_hash.is_a? Hash
+          keys = java_hash.keySet()
+          iterator = keys.iterator()
+          if to_string
+            while iterator.hasNext()
+              key = iterator.next().toString()
+              hash[key] = java_hash.get( key ).toString()
+            end
+          else
+            while iterator.hasNext()
+              key = iterator.next()
+              hash[key] = java_hash.get( key )              
+            end
           end
         else
-          while iterator.hasNext()
-            key = iterator.next()
-            hash[key] = java_hash.get( key )              
+          if to_string
+            java_hash.each do |k,v|
+              hash[k.toString()] = v.toString()
+            end
+          else
+            hash = java_hash
           end
         end