RubyGems - naether - Versions diffs - 0.8.6 → 0.9.0 - Mend

naether 0.8.6 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

data/README.md +106 -0
data/Rakefile +14 -0
data/VERSION +1 -1
data/doc/Naether.html +3136 -0
data/doc/Naether/Bootstrap.html +796 -0
data/doc/Naether/Configurator.html +490 -0
data/doc/Naether/Java.html +795 -0
data/doc/Naether/Java/JRuby.html +926 -0
data/doc/Naether/Java/Ruby.html +931 -0
data/doc/Naether/Maven.html +1143 -0
data/doc/_index.html +192 -0
data/doc/class_list.html +53 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +57 -0
data/doc/css/style.css +328 -0
data/doc/file.README.html +195 -0
data/doc/file_list.html +55 -0
data/doc/frames.html +28 -0
data/doc/index.html +195 -0
data/doc/js/app.js +214 -0
data/doc/js/full_list.js +173 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +708 -0
data/doc/top-level-namespace.html +112 -0
data/jar_dependencies.yml +19 -25
data/lib/naether.rb +147 -142
data/lib/naether/bootstrap.rb +41 -43
data/lib/naether/configuration.rb +61 -0
data/lib/naether/java.rb +22 -198
data/lib/naether/java/jruby.rb +129 -0
data/lib/naether/java/ruby.rb +153 -0
data/lib/naether/maven.rb +142 -0
data/naether-0.9.0.jar +0 -0
data/naether.gemspec +95 -0
data/pom.xml +153 -132
metadata +86 -10
data/README.rdoc +0 -47
data/naether-0.8.6.jar +0 -0

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,112 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.8.2.1
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!" + escape(window.location.href);
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Naether.html" title="Naether (class)">Naether</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Wed Sep 12 14:18:12 2012 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.2.1 (ruby-1.9.3).
+</div>
+  </body>
+</html>

data/jar_dependencies.yml CHANGED Viewed

@@ -1,39 +1,33 @@
 ---
 :dependencies:
+  - ch.qos.logback:logback-classic:jar:1.0.6
+  - ch.qos.logback:logback-core:jar:1.0.6
   - com.jcraft:jsch:jar:0.1.44-1
   - com.ning:async-http-client:jar:1.6.5
-  - org.apache.xbean:xbean-reflect:jar:3.4
-  - com.google.collections:google-collections:jar:1.0
-  - ch.qos.logback:logback-classic:jar:0.9.29
-  - ch.qos.logback:logback-core:jar:0.9.29
-  - org.slf4j:slf4j-api:jar:1.6.2
-  - org.slf4j:jcl-over-slf4j:jar:1.6.2
-  - org.slf4j:log4j-over-slf4j:jar:1.6.2
-  - org.sonatype.aether:aether-api:jar:1.13
-  - org.sonatype.aether:aether-util:jar:1.13
-  - org.sonatype.aether:aether-impl:jar:1.13
-  - org.sonatype.aether:aether-spi:jar:1.13
-  - org.sonatype.aether:aether-connector-file:jar:1.13
-  - org.sonatype.aether:aether-connector-asynchttpclient:jar:1.13
-  - org.sonatype.aether:aether-connector-wagon:jar:1.13
-  - org.sonatype.sisu:sisu-inject-bean:jar:2.2.3
-  - org.sonatype.sisu:sisu-inject-plexus:jar:2.2.3
-  - org.apache.maven:maven-model-v3:jar:2.0
+  - commons-io:commons-io:jar:2.0.1
   - org.apache.maven:maven-aether-provider:jar:3.0.3
   - org.apache.maven:maven-model:jar:3.0.3
   - org.apache.maven:maven-model-builder:jar:3.0.3
   - org.apache.maven:maven-repository-metadata:jar:3.0.3
-  - org.apache.maven.wagon:wagon-provider-api:jar:1.0-beta-6
-  - org.apache.maven.wagon:wagon-ssh-common:jar:1.0
+  - org.apache.maven.wagon:wagon-file:jar:1.0
   - org.apache.maven.wagon:wagon-http-lightweight:jar:1.0
   - org.apache.maven.wagon:wagon-http-shared:jar:1.0
+  - org.apache.maven.wagon:wagon-provider-api:jar:1.0-beta-6
   - org.apache.maven.wagon:wagon-ssh:jar:1.0
-  - org.apache.maven.wagon:wagon-file:jar:1.0
-  - org.codehaus.plexus:plexus-utils:jar:3.0
-  - org.codehaus.plexus:plexus-container-default:jar:1.5.5
-  - org.codehaus.plexus:plexus-classworlds:jar:2.2.2
+  - org.apache.maven.wagon:wagon-ssh-common:jar:1.0
+  - org.codehaus.plexus:plexus-classworlds:jar:2.4
   - org.codehaus.plexus:plexus-component-annotations:jar:1.5.5
-  - org.codehaus.plexus:plexus-interpolation:jar:1.14
   - org.codehaus.plexus:plexus-interactivity-api:jar:1.0-alpha-6
-  - commons-io:commons-io:jar:2.0.1
+  - org.codehaus.plexus:plexus-interpolation:jar:1.14
+  - org.codehaus.plexus:plexus-utils:jar:2.0.7
   - org.jsoup:jsoup:jar:1.6.1
+  - org.slf4j:slf4j-api:jar:1.6.6
+  - org.slf4j:jcl-over-slf4j:jar:1.6.6
+  - org.slf4j:log4j-over-slf4j:jar:1.6.6
+  - org.sonatype.aether:aether-api:jar:1.13.1
+  - org.sonatype.aether:aether-util:jar:1.13.1
+  - org.sonatype.aether:aether-impl:jar:1.13.1
+  - org.sonatype.aether:aether-spi:jar:1.13.1
+  - org.sonatype.aether:aether-connector-file:jar:1.13.1
+  - org.sonatype.aether:aether-connector-asynchttpclient:jar:1.13.1
+  - org.sonatype.aether:aether-connector-wagon:jar:1.13.1

data/lib/naether.rb CHANGED Viewed

@@ -1,63 +1,63 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership. The ASF
+# licenses this file to you 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.
+require "#{File.dirname(__FILE__)}/naether/configuration"
 require "#{File.dirname(__FILE__)}/naether/bootstrap"
 require "#{File.dirname(__FILE__)}/naether/java"
-# :title:Naether
-#
-# Java dependency resolver using Maven's Aether.
+# Java dependency resolver.
 #
-# = Authors
-# Michael Guymon
+# @author Michael Guymon
 #
 class Naether
-  # Naether jar path will default to packaged in the gem
-  JAR_LIB = "#{File.dirname(__FILE__)}/.."
-  # Load VERSION file to VERSION var
-  if File.exists?( File.join( JAR_LIB, "VERSION" ) )
-    VERSION = File.open( File.join( JAR_LIB, "VERSION" ) ) {|f| f.readline }.strip
-  # VERSION file not found in gem dir, assume running from checkout
-  else
-    VERSION = File.open( "VERSION" ) {|f| f.readline }.strip
-  end
-  # Use the VERSION to create jar file name
-  JAR_PATH = "#{JAR_LIB}/naether-#{VERSION}.jar"
+  attr_reader :resolver
   class << self
-    # Helper to determine the platform
-    def platform
-      $platform || RUBY_PLATFORM[/java/] || 'ruby'
-    end
-    # Java dependencies needed to bootstrap Naether
+    # Helper for Java dependencies needed to bootstrap Naether
+    #
+    # @param [String] dep_file path
+    # @see {Naether::Bootstrap#dependencies}
     def bootstrap_dependencies( dep_file=nil )
       Naether::Bootstrap.dependencies( dep_file )
     end
-    # Loads all jars from paths and creates a new instance of Naether
-    def create_from_paths( deps_jar_dir, naether_jar_dir = nil )
-      naether_jar_dir = naether_jar_dir || JAR_LIB
-      Naether::Java.load_jars_dir( [deps_jar_dir, naether_jar_dir] )
-      Naether.new
+    #
+    # Helper for platform detection
+    #
+    def platform
+      Naether::Configuration.platform
     end
+    #
     # Loads all jars creates a new instance of Naether
+    #
+    # @param [Array<String>] jars of paths
+    # @return [Naether]
     def create_from_jars( jars )
-      Naether::Java.load_jars( jars )
+      Naether::Java.internal_load_paths( jars )
       Naether.new
     end
   end
-  # Create new instance. Naether.create_from_paths and Naether.create_from_jars should be
-  # used instead of Naether.new to ensure the dependencies for Naether are set into the classpath
+  # Create new instance.
   def initialize
-    @resolver = Naether::Java.create('com.slackworks.naether.Naether')
+    @resolver = Naether::Java.create('com.tobedevoured.naether.Naether')
   end
   # Clear all remote repositories
@@ -66,6 +66,10 @@ class Naether
   end
   # Add remote repository
+  #
+  # @param [String] url of remote repo
+  # @param [String] username optional
+  # @param [String] password optioanl
   def add_remote_repository( url, username = nil, password = nil )
     if username
       @resolver.addRemoteRepositoryByUrl( url, username, password )
@@ -74,29 +78,50 @@ class Naether
     end
   end
-  # Array of remote repositories
+  # Get remote repositories
+  #
+  # @return [Array] of remote repos
   def remote_repositories
     Naether::Java.convert_to_ruby_array(@resolver.getRemoteRepositories())
   end
+  # Get remote repositories as urls
+  #
+  # @return [Array<String>] of String urls
   def remote_repository_urls
     Naether::Java.convert_to_ruby_array(@resolver.getRemoteRepositoryUrls(), true)
   end
   # Path to local maven repo
+  #
+  # @return [String] path to local repo
   def local_repo_path
     @resolver.getLocalRepoPath()
   end
   # Set path to local maven repo
+  #
+  # @param [String] path local repo
   def local_repo_path=( path )
     @resolver.setLocalRepoPath( path )
   end
+  #
+  # Add a local Build Artifact, that will be used in the Dependency Resolution
+  #
+  # @param [String] notation
+  # @param [String] path to artifact
+  # @param [String] pom optional path to pom.xml
+  #
   def add_build_artifact( notation, path, pom = nil )
     @resolver.addBuildArtifact(notation, path, pom )
   end
+  #
+  # Set local Build Artifacts, that will be used in the Dependency Resolution
+  #
+  # @param [Array<Hash>] artifacts of Hashs with { notation => path } or { notation => { :path => path, :pom => pom_path }
+  #
   def build_artifacts=( artifacts )
     @resolver.clearBuildArtifacts()
@@ -122,29 +147,40 @@ class Naether
     end
   end
+  #
+  # Get Build Artifacts
+  #
+  # @return [Array] of build artifacts
+  #
   def build_artifacts
     Naether::Java.convert_to_ruby_array( @resolver.getBuildArtifacts() )
   end
-  # Add a dependency in the notation: groupId:artifactId:type:version
+  # Add a dependency
+  #
+  # @param [String] notation in the format of groupId:artifactId:version
+  # @param [String] scope valid options are compile,test,runtime
+  # @see https://github.com/mguymon/naether/wiki/Notations
   def add_notation_dependency( notation, scope='compile' )
     @resolver.addDependency( notation, scope )
   end
   # Add dependencies from a Maven POM
+  #
+  # @param [String] pom_path
+  # @param [Array<String>] scopes valid options are compile,test,runtime
   def add_pom_dependencies( pom_path, scopes=['compile'] )
     if Naether.platform == 'java'
       @resolver.addDependencies( pom_path, scopes )
     else
-      list = Rjb::import("java.util.ArrayList").new
-      scopes.each do |scope|
-        list.add( scope )
-      end
+      list = Naether::Java.convert_to_java_list( scopes )
       @resolver._invoke( 'addDependencies', 'Ljava.lang.String;Ljava.util.List;', pom_path, list )
     end
   end
-  # Add a dependency of org.sonatype.aether.graph.Dependency Java object
+  # Add a dependency of org.sonatype.aether.graph.Dependency
+  #
+  # @param [org.sonatype.aether.graph.Dependency] dependency
   def add_dependency( dependency )
     #@resolver.addDependency( dependency )
     if Naether.platform == 'java'
@@ -154,11 +190,16 @@ class Naether
     end
   end
-  # Array of mixed dependencies.
-  #  * Artifact notation in the format of groupId:artifactId:version or groupId:artifactId:type:version - 'junit:junit:4.7'
-  #  * Hash of a single artifaction notation => scope - { 'junit:junit:4.7' => 'test' }
-  #  * Path to a local pom - 'lib/pom.xml'
-  #  * Hash of a single path to a local pom => scope - { 'lib/pom.xml' => ['compile','test'] }
+  # Set the dependencies
+  #
+  # The dependencies param takes an [Array] of mixed dependencies:
+  #  * [String] Artifact notation, such as groupId:artifactId:version, e.g. 'junit:junit:4.7'
+  #  * [Hash] of a single artifaction notation => scope - { 'junit:junit:4.7' => 'test' }
+  #  * [String] path to a local pom - 'lib/pom.xml'
+  #  * [Hash] of a single path to a local pom => scope - { 'lib/pom.xml' => ['compile','test'] }
+  #
+  # @param [Array] dependencies
+  # @see https://github.com/mguymon/naether/wiki/Notations
   def dependencies=(dependencies)
     @resolver.clearDependencies()
@@ -206,22 +247,30 @@ class Naether
   end
   # Get array of dependencies
+  #
+  # @return [Array]
   def dependencies
     Naether::Java.convert_to_ruby_array( @resolver.getDependencies() )
   end
   # Get array of dependencies as notation
+  #
+  # @return [Array<String>] of notations
+  # @see https://github.com/mguymon/naether/wiki/Notations
   def dependencies_notation
     Naether::Java.convert_to_ruby_array(@resolver.getDependenciesNotation(), true)
   end
-  alias_method :dependenciesNotation, :dependencies_notation # some javaism snuck in
   # Hash of dependency paths
+  #
+  # @return [Array<Hash>] of { notation => path }
   def dependencies_path
     Naether::Java.convert_to_ruby_hash( @resolver.getDependenciesPath(), true )
   end
   # Convert dependencies to Classpath friendly string
+  #
+  # @return [String]
   def dependencies_classpath()
     @resolver.getResolvedClassPath()
   end
@@ -234,7 +283,10 @@ class Naether
     jars
   end
-  # Resolve dependencies, finding related additional dependencies
+  # Resolve dependencies
+  #
+  # @return [Array<String>] of notations
+  # @see https://github.com/mguymon/naether/wiki/Notations
   def resolve_dependencies( download_artifacts = true, properties = nil )
     if properties
@@ -246,24 +298,37 @@ class Naether
     end
     @resolver.resolveDependencies( download_artifacts, map );
-    dependenciesNotation
+    dependencies_notation
   end
+  # Convert notations to local paths of artifacts
+  #
+  # @param [Array<String>] notations
+  # @return [Array<String>] of paths to artifacts
+  # @see https://github.com/mguymon/naether/wiki/Notations
   def to_local_paths( notations )
     if Naether.platform == 'java'
-      Naether::Java.convert_to_ruby_array( @resolver.getLocalPaths( notations ) )
+      Naether::Java.convert_to_ruby_array(
+        Naether::Java.exec_static_method(
+          'com.tobedevoured.naether.util.Notation',
+          'getLocalPaths',
+          [local_repo_path, notations ],
+          ['java.lang.String', 'java.util.List'] ) )
     else
-      list = Rjb::import("java.util.ArrayList").new
-      notations.each do |notation|
-        list.add( notation )
-      end
-      paths = @resolver._invoke('getLocalPaths', 'Ljava.util.List;', list)
+      paths =  Naether::Java.exec_static_method(
+        'com.tobedevoured.naether.util.Notation',
+        'getLocalPaths',
+        [local_repo_path, Naether::Java.convert_to_java_list(notations) ],
+        ['java.lang.String', 'java.util.List'] )
       Naether::Java.convert_to_ruby_array( paths, true )
     end
   end
+  # Download artifacts
+  #
+  # @param [Array<String>] notations
+  # @return [Array<String>] of paths of downloaded artifacts
   def download_artifacts( notations )
     if( notations.is_a? String )
       notations = [notations]
@@ -273,11 +338,7 @@ class Naether
     if Naether.platform == 'java'
       files = @resolver.downloadArtifacts( notations )
     else
-      list = Rjb::import("java.util.ArrayList").new
-      notations.each do |notation|
-        list.add( notation )
-      end
+      list = Naether::Java.convert_to_java_list( notations )
       files = @resolver._invoke('downloadArtifacts', 'Ljava.util.List;', list)
     end
@@ -291,8 +352,18 @@ class Naether
   # Deploy artifact to remote repo url
+  #
+  # @param [String] notation
+  # @param [String] file_path to artifact to deploy
+  # @param [String] url to deploy to
+  # @param [Hash] opts
+  # @option opts [String] :pom_path path to pom.xml
+  # @option opts [String] :username for optional auth
+  # @option opts [String] :password for optional auth
+  # @option opts [String] :pub_key for optional auth
+  # @option opts [String] :pub_key_passphrase for optional auth
   def deploy_artifact( notation, file_path, url, opts = {} )
-    artifact = Naether::Java.create( "com.slackworks.naether.deploy.DeployArtifact" )
+    artifact = Naether::Java.create( "com.tobedevoured.naether.deploy.DeployArtifact" )
     artifact.setRemoteRepo( url )
     artifact.setNotation( notation )
@@ -304,92 +375,26 @@ class Naether
     if opts[:username] || opts[:pub_key]
       artifact.setAuth(opts[:username], opts[:password], opts[:pub_key], opts[:pub_key_passphrase] )
     end
-    @resolver.deployArtifact(artifact)
-  end
-  # Install artifact or pom to local repo, must specify pom_path and/or jar_path
-  def install( notation, pom_path =nil, jar_path = nil )
-    @resolver.install(notation, pom_path, jar_path)
-  end
-  def load_pom( file_path )
-    @project_instance = Naether::Java.create("com.slackworks.naether.maven.Project", file_path )
-  end
-  def pom_dependencies( file_path=nil, scopes = nil)
-    if file_path
-      load_pom( file_path )
-    end
     if Naether.platform == 'java'
-      if scopes.nil?
-        deps = @project_instance.getDependenciesNotation()
-      else
-        deps = @project_instance.getDependenciesNotation( scopes )
-      end
+      @resolver.deployArtifact(artifact)
     else
-      list = nil
-      if scopes
-        list = Rjb::import("java.util.ArrayList").new
-        scopes.each do |scope|
-          list.add( scope )
-        end
-        deps = @project_instance._invoke('getDependenciesNotation', 'Ljava.util.List;', list)
-      else
-        deps = @project_instance.getDependenciesNotation()
-      end
-    end
-    Naether::Java.convert_to_ruby_array(@project_instance.getRepositoryUrls()).each do |url|
-      add_remote_repository( url )
+      @resolver._invoke( 'deployArtifact', 'Lcom.tobedevoured.naether.deploy.DeployArtifact;', artifact )
     end
-    Naether::Java.convert_to_ruby_array( deps, true )
   end
-  # Get the POM version
-  def pom_version( file_path=nil )
-    if file_path
-      load_pom( file_path )
-    end
-    return @project_instance.getVersion()
-  end
-  # Create the XML for a Maven Pom for the notation, groupId:artifactId:type:version
+  # Install artifact or pom to local repo, must specify pom_path and/or jar_path
   #
-  # loads all resolved dependencies into pom
-  def build_pom( notation )
-    @project_instance = Naether::Java.create("com.slackworks.naether.maven.Project")
-    @project_instance.setProjectNotation( notation )
-    @project_instance.setRepositories( @resolver.getRemoteRepositoryUrls() )
-    @project_instance.setDependencies( @resolver.getDependencies() )
-    @project_instance.toXml()
+  # @param [String] notation
+  # @param [String] pom_path
+  # @param [String] jar_path
+  def install( notation, pom_path =nil, jar_path = nil )
+    @resolver.install(notation, pom_path, jar_path)
   end
-  # notation of the pom, groupId:artifactId:type:version
-  # filePath to write the pom
+  # Set Log level for Naether Java logging
   #
-  # loads all resolved dependencies into pom
-  def write_pom( notation, file_path )
-    @project_instance = Naether::Java.create("com.slackworks.naether.maven.Project")
-    @project_instance.setProjectNotation( notation )
-    @project_instance.setDependencies( @resolver.getDependencies() )
-    @project_instance.writePom( file_path )
-  end
+  # @param [String] level to debug, info, warn, or error
   def set_log_level( level )
-    Naether::Java.java_class('com.slackworks.naether.util.LogUtil').changeLevel( 'com.slackworks', level )
+    Naether::Java.exec_static_method('com.tobedevoured.naether.util.LogUtil', 'changeLevel', ['com.tobedevoured', level] )
   end
 end