jbundler 0.8.0.pre → 0.8.0

data/lib/jbundler/classpath_file.rb

@@ -0,0 +1,115 @@
+#
+# Copyright (C) 2013 Christian Meier
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module JBundler
+
+  class ClasspathFile
+
+    def initialize(classpathfile = '.jbundler/classpath.rb')
+      @classpathfile = classpathfile
+    end
+    
+    def file
+      @classpathfile
+    end
+
+    def load_classpath
+      load File.expand_path @classpathfile
+    end
+
+    def require_classpath
+      load_classpath
+      JBUNDLER_CLASSPATH.each { |c| require c }
+    end
+
+    def require_test_classpath
+      load_classpath
+      JBUNDLER_TEST_CLASSPATH.each { |c| require c }
+    end
+
+    def mtime
+      File.mtime(@classpathfile)
+    end
+
+    def exists?
+      File.exists?(@classpathfile)
+    end
+
+    def missing?( jarfile )
+      !exists? || !jarfile.exists_lock?
+    end
+
+    def jarfile_newer?( jarfile )
+      jarfile.exists? && (jarfile.mtime > mtime)
+    end
+
+    def jarlock_newer?( jarfile )
+      jarfile.exists_lock? && (jarfile.mtime_lock > mtime)
+    end
+       
+    def needs_update?(jarfile, gemfile_lock)
+      if ( jarfile.exists? || gemfile_lock.exists? || jarfile.exists_lock? )
+        missing?( jarfile ) || jarfile_newer?( jarfile ) || jarlock_newer?( jarfile ) || gemfile_lock.newer?( mtime )
+      else
+        false
+      end
+    end
+
+    def generate( classpath_array, test_array = [], jruby_array = [], local_repo = nil )
+      FileUtils.mkdir_p(File.dirname(@classpathfile))
+      File.open(@classpathfile, 'w') do |f|
+        if local_repo
+          local_repo = File.expand_path( local_repo )
+          f.puts "require 'jar_dependencies'"
+          f.puts "JBUNDLER_LOCAL_REPO = Jars.home"
+        end
+        dump_array( f, jruby_array || [], 'JRUBY_', local_repo )
+        dump_array( f, test_array || [], 'TEST_', local_repo )
+        dump_array( f, classpath_array || [], '', local_repo )
+        f.close
+      end
+    end
+    
+    private
+    def dump_array( file, array, prefix, local_repo )
+      file.puts "JBUNDLER_#{prefix}CLASSPATH = []"
+      array.each do |path|
+        dump_jar( file, path, prefix, local_repo )
+      end
+      file.puts "JBUNDLER_#{prefix}CLASSPATH.freeze"
+    end
+
+    def dump_jar( file, path, prefix, local_repo )
+      return if path =~ /pom$/
+      if local_repo
+        path.sub!( /#{local_repo}/, '' )
+        unless File.exists?( path )
+          file.puts "JBUNDLER_#{prefix}CLASSPATH << (JBUNDLER_LOCAL_REPO + '#{path}')"
+          path = nil
+        end
+      end
+      if path
+        # either we do not have a local_repo or the path is a absolute
+        # path from system artifact
+        file.puts "JBUNDLER_#{prefix}CLASSPATH << '#{path}'"        
+      end
+    end
+  end
+end

data/lib/jbundler/cli.rb

@@ -0,0 +1,146 @@
+#
+# Copyright (C) 2013 Christian Meier
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'bundler/vendored_thor'
+require 'jbundler/config'
+require 'jbundler/tree'
+require 'jbundler/lock_down'
+require 'jbundler/jruby_complete'
+module JBundler
+  # As of v1.9.0, bundler's vendored version of thor is namespaced
+  Thor = Bundler::Thor if Gem.loaded_specs['bundler'].version >= Gem::Version.new('1.9.0')
+
+  class Cli < Thor
+    no_tasks do
+      def config
+        @config ||= JBundler::Config.new
+      end
+
+      def unvendor
+        vendor = JBundler::Vendor.new( config.vendor_dir )
+        vendor.clear
+      end
+
+      def vendor
+        vendor = JBundler::Vendor.new( config.vendor_dir )
+        if vendor.vendored?
+          raise "already vendored. please 'jbundle install --no-deployment before."
+        else
+          vendor.setup( JBundler::ClasspathFile.new( config.classpath_file ) )
+        end
+      end
+
+      def say_bundle_complete
+        puts ''
+        puts 'Your jbundle is complete! Use `jbundle show` to see where the bundled jars are installed.'
+      end
+    end
+
+    desc 'tree', 'display a graphical representation of the dependency tree'
+    #method_option :details, :type => :boolean, :default => false
+    def tree
+      JBundler::Tree.new( config ).show_it
+    end
+
+    desc 'install', "first `bundle install` is called and then the jar dependencies will be installed. for more details see `bundle help install`, jbundler will ignore most options. the install command is also the default when no command is given."
+    method_option :vendor, :type => :boolean, :default => false, :desc => 'vendor jars into vendor directory (jbundler only).'
+    method_option :debug, :type => :boolean, :default => false, :desc => 'enable maven debug output (jbundler only).'
+    method_option :verbose, :type => :boolean, :default => false, :desc => 'enable maven output (jbundler only).'
+    method_option :deployment, :type => :boolean, :default => false, :desc => "copy the jars into the vendor/jars directory (or as configured). these vendored jars have preference before the classpath jars !"
+    method_option :no_deployment, :type => :boolean, :default => false, :desc => 'clears the vendored jars'
+    method_option :path, :type => :string
+    method_option :without, :type => :array
+    method_option :system, :type => :boolean
+    method_option :local, :type => :boolean
+    method_option :binstubs, :type => :string
+    method_option :trust_policy, :type => :string
+    method_option :gemfile, :type => :string
+    method_option :jobs, :type => :string
+    method_option :retry, :type => :string
+    method_option :no_cache, :type => :boolean
+    method_option :quiet, :type => :boolean
+    def install
+      msg = JBundler::LockDown.new( config ).lock_down( options[ :vendor ],
+                                                        options[ :debug ] ,
+                                                        options[ :verbose ] )
+      config.verbose = ! options[ :quiet ]
+      Show.new( config ).show_classpath
+      unless options[ :quiet ]
+        puts 'jbundle complete !'
+        puts
+      end
+      puts msg if msg
+    end
+
+    desc 'console', 'irb session with gems and/or jars and with lazy jar loading.'
+    def console
+      # dummy - never executed !!!
+    end
+    
+    desc 'lock_down', "first `bundle install` is called and then the jar dependencies will be installed. for more details see `bundle help install`, jbundler will ignore all options. the install command is also the default when no command is given. that is kept as fall back in cases where the new install does not work as before."
+    method_option :deployment, :type => :boolean, :default => false, :desc => "copy the jars into the vendor/jars directory (or as configured). these vendored jars have preference before the classpath jars !"
+    method_option :no_deployment, :type => :boolean, :default => false, :desc => 'clears the vendored jars'
+    method_option :path, :type => :string
+    method_option :without, :type => :array
+    method_option :system, :type => :boolean
+    method_option :local, :type => :boolean
+    method_option :binstubs, :type => :string
+    method_option :trust_policy, :type => :string
+    method_option :gemfile, :type => :string
+    method_option :jobs, :type => :string
+    method_option :retry, :type => :string
+    method_option :no_cache, :type => :boolean
+    method_option :quiet, :type => :boolean
+    def lock_down
+      require 'jbundler'
+
+      unvendor if options[ :no_deployment ]
+
+      vendor if options[ :deployment ]
+
+      config.verbose = ! options[ :quiet ]
+
+      Show.new( config ).show_classpath
+
+      say_bundle_complete unless options[ :quiet ]
+    end
+
+    desc 'update', "first `bundle update` is called and if there are no options then the jar dependencies will be updated. for more details see `bundle help update`."
+    method_option :debug, :type => :boolean, :default => false, :desc => 'enable maven debug output (jbundler only).'
+    method_option :verbose, :type => :boolean, :default => false, :desc => 'enable maven output (jbundler only).'
+    def update
+      return unless ARGV.size == 1
+        
+      JBundler::LockDown.new( config ).update( options[ :debug ] ,
+                                               options[ :verbose ] )
+
+      config.verbose = ! options[ :quiet ]
+      Show.new( config ).show_classpath
+      puts ''
+      puts 'Your jbundle is updated! Use `jbundle show` to see where the bundled jars are installed.'
+    end
+
+    desc 'show', "first `bundle show` is called and if there are no options then the jar dependencies will be displayed. for more details see `bundle help show`."
+    def show
+      config.verbose = true
+      Show.new( config ).show_classpath
+    end
+  end
+end

data/lib/jbundler/config.rb

@@ -0,0 +1,191 @@
+#
+# Copyright (C) 2013 Christian Meier
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+require 'yaml'
+require 'jar_dependencies'
+
+module JBundler
+
+  # allow yaml config in $HOME/.jbundlerrc and $PWD/.jbundlerrc
+  class Config
+
+    RC_FILE = '.jbundlerrc'
+
+    attr_accessor :verbose, :local_repository, :jarfile, :gemfile, :skip, :settings, :offline, :work_dir, :vendor_dir, :basedir
+
+    def initialize
+      if ENV.has_key? 'HOME'
+        homefile = File.join(ENV['HOME'], RC_FILE)
+        home_config = YAML.load_file(homefile) if File.exists?(homefile)
+      else
+        home_config = nil
+      end
+      @config = (home_config || {})
+      @basedir = find_basedir( File.expand_path( '.' ) )
+      @basedir ||= File.expand_path( '.' )
+      file = join_basedir( RC_FILE )
+      pwd_config = YAML.load_file(file) if File.exists?(file)
+      @config.merge!(pwd_config || {})
+    end
+    
+    def join_basedir( path )
+      if @basedir
+        File.join( @basedir, path )
+      else
+        path
+      end
+    end
+
+    def find_basedir( dir )
+      f = File.join( dir, RC_FILE )
+      return dir if File.exists?( f )
+      f = File.join( dir, _jarfile )
+      return dir if File.exists?( f )
+      f = File.join( dir, _gemfile )
+      return dir if File.exists?( f )
+      parent = File.dirname( dir )
+      if dir != ENV['HOME'] && dir != parent
+        find_basedir( parent )
+      end
+    end
+
+    def absolute( file )
+      if file.nil? || file == File.expand_path( file )
+        file
+      else
+        File.join( @basedir, file )
+      end
+    end
+
+    def _jbundler_env( key )
+      ENV[ key.upcase.gsub( /[.]/, '_' ) ] ||
+        @config[ key.downcase.sub(/^j?bundle_/, '' ).sub( /[.]/, '_' ) ]
+    end
+    private :_jbundler_env
+
+    if defined? JRUBY_VERSION
+      def jbundler_env( key )
+        java.lang.System.getProperty( key.downcase.gsub( /_/, '.' ) ) ||
+          _jbundler_env( key )
+      end
+    else
+      alias :jbundler_env :_jbundler_env
+    end
+    private :jbundler_env
+
+    def skip
+      skip = jbundler_env('JBUNDLE_SKIP')
+      # defaults to false
+      @skip ||= skip && skip != 'false'
+    end
+
+    def verbose
+      verbose = jbundler_env('JBUNDLE_VERBOSE')
+      # defaults to false
+      @verbose ||= verbose && verbose != 'false'
+    end
+
+    def jarfile
+      @jarfile ||= absolute( _jarfile )
+    end
+
+    def _jarfile
+      jbundler_env('JBUNDLE_JARFILE') || 'Jarfile'
+    end
+    private :_jarfile
+
+    def jarfile_lock
+      "#{jarfile}.lock"
+    end
+
+    def gemfile
+      @gemfile ||= absolute( _gemfile )
+    end
+
+    def _gemfile
+      jbundler_env('BUNDLE_GEMFILE') || 'Gemfile'
+    end
+    private :_gemfile
+
+    def gemfile_lock
+      "#{gemfile}.lock"
+    end
+
+    def classpath_file
+      absolute( jbundler_env('JBUNDLE_CLASSPATH_FILE') ||
+                '.jbundler/classpath.rb' )
+    end
+
+    def local_repository
+      # use maven default local repo as default
+      local_maven_repository = absolute( jbundler_env('JBUNDLE_LOCAL_REPOSITORY') )
+      if local_maven_repository
+        warn "JBUNDLE_LOCAL_REPOSITORY environment or jbundle.local.repository' system property is deprecated use JARS_HOME or jars.home instead"
+        ENV[ Jars::HOME ] ||= local_maven_repository
+      else
+        # first load the right settings
+        self.settings
+        Jars.home
+      end
+    end
+
+    def settings
+      settings = absolute( jbundler_env('JBUNDLE_SETTINGS') )
+      if settings
+        warn "JBUNDLE_SETTINGS environment or jbundle.settings' system property is deprecated use JARS_MAVEN_SETTINGS or jars.maven.settings instead"
+        ENV[ Jars::MAVEN_SETTINGS ] ||= settings
+      end
+      Jars.maven_settings
+    end
+
+    def offline
+      @offline ||= jbundler_env('JBUNDLE_OFFLINE')
+      @offline == 'true' || @offline == true
+    end
+
+    def proxy
+      @proxy ||= jbundler_env('JBUNDLE_PROXY')
+      if @proxy
+        warn 'proxy config is deprecated, use settings.xml instead'
+      end
+      @proxy
+    end
+
+    def mirror
+      @mirror ||= jbundler_env('JBUNDLE_MIRROR')
+      # nice to have no leading slash
+      @mirror = @mirror.sub( /\/$/, '' ) if @mirror
+      if @mirror
+        warn 'mirror config is deprecated, use settings.xml instead'
+      end
+      @mirror
+    end
+
+    def work_dir
+      @work_dir ||= absolute( jbundler_env('JBUNDLE_WORK_DIR') || 'pkg' )
+    end
+
+    def vendor_dir
+      @vendor_dir ||= absolute( jbundler_env('JBUNDLE_VENDOR_DIR') ||
+                                File.join( 'vendor', 'jars' ) )
+    end
+
+  end
+end