javaclass 0.4.1 → 0.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d2365f0669ad709753366f66070bd05668c73becda0c878e94d346337d1a3cb
+  data.tar.gz: 3157e8329a20c00a28e14f9c23c7b21e07984aef67ff83cbc8e0b6cff5ea1cae
+SHA512:
+  metadata.gz: f0879048da8004e427b7d8d48125f13a041059e8e3ae537ab4a72b2a48b9ca012880ddfbe427d49d32c9dd5d205448e8f36d461a1194c17c9b3d6dbc4e094201
+  data.tar.gz: 548019c98321c52573b6c239b456c7a9fb048f2a3900ca6d5987a494d5568aeffc22923783b656a821092d05292f5bd7f6ec1b98620ff374b9244c4f1c8a08ed

data/Rakefile

@@ -1,194 +1,188 @@
-require 'net/http'
-require 'rubygems'
-require 'rubygems/gem_runner' # install and uninstall
-require 'rubygems/package_task'
-require 'rake'
-require 'rake/clean' # for clean/clobber
-require 'rake/testtask'
-require 'rake/packagetask'
-require File.dirname(__FILE__) + '/dev/example_task'
-
-# Test, package and publish functions.
-# Author::           Peter Kofler
-# See::              http://rake.rubyforge.org/files/doc/rakefile_rdoc.html
-# Acknowledgement::  Building this Rake file was supported as System One Research Day. Thank you System One for funding Open Source :-)
-
-RDOC_DIR = 'html'
-RDOC_REPO = 'api'
-
-gemspec = eval(IO.readlines('javaclass.gemspec').join)
-full_gem_name = "#{gemspec.name}-#{gemspec.version}"
-
-desc 'Validates the gemspec'
-task :validate_gem do
-  gemspec.validate
-end
-
-desc 'Displays the current version'
-task :version do
-  puts gemspec.version
-end
-
-# :test
-Rake::TestTask.new do |t|
-  t.test_files = gemspec.test_files
-  t.warning = true
-  # t.verbose = false is default
-end
-
-begin
-  require 'rcov/rcovtask'
-
-# :rcov
-Rcov::RcovTask.new do |t|
-  t.test_files = gemspec.test_files
-  t.warning = true
-  t.rcov_opts << "--sort=coverage"
-  t.rcov_opts << "--only-uncovered"
-end
-
-rescue LoadError
-  # skip if not installed
-  warn("rcov not installed. coverage not available. #{$!}")
-end
-
-desc 'Find missing test methods with ZenTest'
-task :zentest do
-  files = gemspec.files.find_all { |f| f =~ /^#{gemspec.require_path}.*\.rb$/ } + gemspec.test_files
-  output = `ruby -I#{gemspec.require_path} -e "require 'rubygems'; load(Gem.bin_path('ZenTest', 'zentest'))" #{files.join(' ')}`
-  puts output.gsub(/^#.*\n/, '') # skip all ZenTest comments
-end
-
-# :gem
-Gem::PackageTask.new(gemspec) do |pkg|
-  pkg.need_zip = true
-end
-
-# :package, :clobber_package, :repackage
-Rake::PackageTask.new(gemspec.name, gemspec.version) do |pkg|
-  #pkg.need_tar = true - no compress in tar on unxutils in Windows
-  #pkg.need_tar_gz = true - no compress in tar on unxutils in Windows
-  pkg.need_zip = true
-  pkg.package_files.include gemspec.files
-end
-
-desc 'Install the gem locally'
-task :install_gem => :package do
-  Gem::GemRunner.new.run ['install', "pkg/#{full_gem_name}"]
-end
-
-desc 'Uninstall the gem'
-task :uninstall_gem do
-  Gem::GemRunner.new.run ['uninstall', gemspec.name]
-end
-
-# Helper method to execute Mercurial with the _params_ array.
-# The +hg+ executable must be in the path.
-def hg(params)
-  puts `hg #{params.join(' ')}`
-end
-
-desc 'Tag current version in Hg'
-task :tag do
-  hg ['tag', '-f', "-m \"Released gem version #{gemspec.version}\"", "#{full_gem_name}"]
-  # hg ['push']
-  puts 'Tag created. Don\'t forget to push'
-  puts 'hg push'
-end
-
-# internal - desc 'Release the gem to Rubygems'
-task :release_rubygems => :package do
-  puts "Releasing #{full_gem_name} to Rubygems"
-  Gem::GemRunner.new.run ['push', "pkg/#{full_gem_name}.gem"]
-end
-
-desc 'Package and upload gem to Rubygems'
-task :publish_gem => [:clobber_package, :example, :package, :release_rubygems]
-
-# :example, :clobber_example, :reexample
-example_task_lib = Rake::ExampleTask.new do |example|
-  example.example_files.include 'examples/**/*.rb'
-end
-task :clobber_rdoc => [:clobber_example]
-task :rdoc => [:example]
-task :package => [:example]
-
-begin
-  require 'rdoc/task'
-  SomeRDocTask = RDoc::Task
-rescue LoadError
-  require 'rake/rdoctask'
-  SomeRDocTask = Rake::RDocTask
-end
-
-# :rdoc, :clobber_rdoc, :rerdoc
-SomeRDocTask.new do |rdoc|
-  rdoc.rdoc_dir = RDOC_DIR # 'html' is default anyway
-  rdoc.title = "#{full_gem_name} Documentation"
-  rdoc.main = 'Readme.txt'
-
-  # examples are generated later and not necessarily available at definition time
-  examples = example_task_lib.conversion_pairs.map { |a| a[1] }
-
-  rdoc.rdoc_files.include(*examples)
-  rdoc.rdoc_files.include('lib/**/*.rb', *gemspec.extra_rdoc_files)
-end
-
-# Helper method to add target="_parent" to all external links in _file_ html.
-def add_href_parent(file)
-  lines = IO.readlines(file).collect do |line|
-    if line =~ /(href=(?:'|")https?:\/\/)/
-      "#{$`}target=\"_parent\" #{$1}#{$'}"
-    else
-      line
-    end
-  end
-  File.open(file, 'w') { |f| f.print lines.join }
-end
-
-desc 'Fix the RDoc hrefs in framesets'
-task :fix_rdoc => [:rdoc] do
-  Dir["#{RDOC_DIR}/**/*.html"].each { |file| add_href_parent(file) }
-end
-
-# Helper method to add the gem version _dir_ into index _file_ to frameset links.
-def add_frameset_version(file, dir)
-  lines = IO.readlines(file).collect do |line|
-    if line =~ /(frame src=")/
-      "#{$`}#{$1}#{dir}/#{$'}"
-    else
-      line
-    end
-  end
-  File.open(file, 'w') { |f| f.print lines.join }
-end
-
-desc 'Publish the RDoc files to repository'
-task :publish_rdoc => [:clobber_rdoc, :fix_rdoc] do
-  puts "Releasing #{full_gem_name} to API"
-  remote_repo = "https://bitbucket.org/pkofler/#{HG_PROJECT}.#{RDOC_REPO}/"
-  remote_dir = "#{gemspec.version}"
-
-  FileUtils.rm_r RDOC_REPO rescue nil
-  hg ['clone', remote_repo, RDOC_REPO]
-
-  FileUtils.rm_r "#{RDOC_REPO}/#{remote_dir}" rescue nil
-  FileUtils.cp_r RDOC_DIR, "#{RDOC_REPO}/#{remote_dir}"
-
-  # modify index, update redirect in frameset
-  file = "#{RDOC_REPO}/index.html"
-  FileUtils.cp "#{RDOC_REPO}/#{remote_dir}/index.html", file
-  add_frameset_version(file, remote_dir)
-
-  hg ['addremove', '-q', "-R #{RDOC_REPO}"]
-  hg ['ci', "-m \"Update Rdoc for version #{gemspec.version}\"", "-R #{RDOC_REPO}"]
-  hg ['tag', '-f', "-m \"Released gem version #{gemspec.version}\"", "-R #{RDOC_REPO}", "#{full_gem_name}"]
-  # hg ['push', "-R #{RDOC_REPO}"]
-  puts 'API site created. Don\'t forget to push'
-  puts "hg push -R #{RDOC_REPO}"
-end
-
-# :clean :clobber
-CLOBBER.include(RDOC_REPO, 'ClassLists', 'fullClassList*.txt')
-
-task :default => :test
+require 'net/http'
+require 'rubygems'
+require 'rubygems/gem_runner' # install and uninstall
+require 'rubygems/package_task'
+require 'rake'
+require 'rake/clean' # for clean/clobber
+require 'rake/testtask'
+require 'rake/packagetask'
+require File.dirname(__FILE__) + '/dev/example_task'
+
+# Test, package and publish functions.
+# Author::           Peter Kofler
+# See::              http://rake.rubyforge.org/files/doc/rakefile_rdoc.html
+# Acknowledgement::  Building this Rake file was supported as System One Research Day. Thank you System One for funding Open Source :-)
+
+RDOC_DIR = 'html'
+RDOC_REPO = 'api'
+
+gemspec = eval(IO.readlines('javaclass.gemspec').join)
+full_gem_name = "#{gemspec.name}-#{gemspec.version}"
+
+desc 'Validates the gemspec'
+task :validate_gem do
+  gemspec.validate
+end
+
+desc 'Displays the current version'
+task :version do
+  puts gemspec.version
+end
+
+# :test
+Rake::TestTask.new do |t|
+  t.test_files = gemspec.test_files
+  t.warning = true
+  # t.verbose = false is default
+end
+
+begin
+  require 'rcov/rcovtask'
+
+# :rcov
+Rcov::RcovTask.new do |t|
+  t.test_files = gemspec.test_files
+  t.warning = true
+  t.rcov_opts << "--sort=coverage"
+  t.rcov_opts << "--only-uncovered"
+end
+
+rescue LoadError
+  # skip if not installed
+  # warn("rcov not installed. coverage not available. #{$!}")
+end
+
+desc 'Find missing test methods with ZenTest'
+task :zentest do
+  files = gemspec.files.find_all { |f| f =~ /^#{gemspec.require_path}.*\.rb$/ } + gemspec.test_files
+  output = `ruby -I#{gemspec.require_path} -e "require 'rubygems'; load(Gem.bin_path('ZenTest', 'zentest'))" #{files.join(' ')}`
+  puts output.gsub(/^#.*\n/, '') # skip all ZenTest comments
+end
+
+# :gem
+Gem::PackageTask.new(gemspec) do |pkg|
+  pkg.need_zip = true
+end
+
+# :package, :clobber_package, :repackage
+Rake::PackageTask.new(gemspec.name, gemspec.version) do |pkg|
+  #pkg.need_tar = true - no compress in tar on unxutils in Windows
+  #pkg.need_tar_gz = true - no compress in tar on unxutils in Windows
+  pkg.need_zip = true
+  pkg.package_files.include gemspec.files
+end
+
+desc 'Install the gem locally'
+task :install_gem => :package do
+  Gem::GemRunner.new.run ['install', "pkg/#{full_gem_name}"]
+end
+
+desc 'Uninstall the gem'
+task :uninstall_gem do
+  Gem::GemRunner.new.run ['uninstall', gemspec.name]
+end
+
+# Helper method to execute Git with the _params_ array.
+# The +git+ executable must be in the path.
+def git(params)
+  puts `git #{params.join(' ')}`
+end
+
+desc 'Tag current version in Git'
+task :tag do
+  git ['tag', "#{full_gem_name}"]
+  # git ['push']
+  puts 'Tag created. Don\'t forget to push'
+end
+
+# internal - desc 'Release the gem to Rubygems'
+task :release_rubygems => :package do
+  puts "Releasing #{full_gem_name} to Rubygems"
+  Gem::GemRunner.new.run ['push', "pkg/#{full_gem_name}.gem"]
+end
+
+desc 'Package and upload gem to Rubygems'
+task :publish_gem => [:clobber_package, :example, :package, :release_rubygems]
+
+# :example, :clobber_example, :reexample
+example_task_lib = Rake::ExampleTask.new do |example|
+  example.example_files.include 'examples/**/*.rb'
+end
+task :clobber_rdoc => [:clobber_example]
+task :rdoc => [:example]
+task :package => [:example]
+
+begin
+  require 'rdoc/task'
+  SomeRDocTask = RDoc::Task
+rescue LoadError
+  require 'rake/rdoctask'
+  SomeRDocTask = Rake::RDocTask
+end
+
+# :rdoc, :clobber_rdoc, :rerdoc
+SomeRDocTask.new do |rdoc|
+  rdoc.rdoc_dir = RDOC_DIR # 'html' is default anyway
+  rdoc.title = "#{full_gem_name} Documentation"
+  rdoc.main = 'Readme.txt'
+
+  # examples are generated later and not necessarily available at definition time
+  examples = example_task_lib.conversion_pairs.map { |a| a[1] }
+
+  rdoc.rdoc_files.include(*examples)
+  rdoc.rdoc_files.include('lib/**/*.rb', *gemspec.extra_rdoc_files)
+end
+
+# Helper method to add target="_parent" to all external links in _file_ html.
+def add_href_parent(file)
+  lines = IO.readlines(file).collect do |line|
+    if line =~ /(href=(?:'|")https?:\/\/)/
+      "#{$`}target=\"_parent\" #{$1}#{$'}"
+    else
+      line
+    end
+  end
+  File.open(file, 'w') { |f| f.print lines.join }
+end
+
+desc 'Fix the RDoc hrefs in framesets'
+task :fix_rdoc => [:rdoc] do
+  Dir["#{RDOC_DIR}/**/*.html"].each { |file| add_href_parent(file) }
+end
+
+# Helper method to add the gem version _dir_ into index _file_ to frameset links.
+def add_frameset_version(file, dir)
+  lines = IO.readlines(file).collect do |line|
+    if line =~ /(frame src=")/
+      "#{$`}#{$1}#{dir}/#{$'}"
+    else
+      line
+    end
+  end
+  File.open(file, 'w') { |f| f.print lines.join }
+end
+
+desc 'Publish the RDoc files to repository'
+task :publish_rdoc => [:clobber_rdoc, :fix_rdoc] do
+  puts "Releasing #{full_gem_name} API"
+  version_dir = "#{gemspec.version}"
+
+  FileUtils.rm_r RDOC_REPO rescue nil
+  FileUtils.mkdir RDOC_REPO
+
+  FileUtils.rm_r "#{RDOC_REPO}/#{version_dir}" rescue nil
+  FileUtils.cp_r RDOC_DIR, "#{RDOC_REPO}/#{version_dir}"
+
+  # modify index, update redirect in frameset
+  file = "#{RDOC_REPO}/index.html"
+  FileUtils.cp "#{RDOC_REPO}/#{version_dir}/index.html", file
+  add_frameset_version(file, version_dir)
+
+  puts 'API created. Copy to hosting\4_bitbucket.org\api'
+  puts 'API created. Don\'t forget to upload'
+end
+
+# :clean :clobber
+CLOBBER.include(RDOC_REPO, 'ClassLists', 'fullClassList*.txt')
+
+task :default => :test

data/Readme.txt

@@ -1,7 +1,7 @@
 javaclass-rb
-by {Peter 'Code Cop' Kofler}[http://www.code-cop.org/]
+by {Peter 'Code Cop' Kofler}[https://www.code-cop.org/]
 
-* {Homepage (Bitbucket)}[https://bitbucket.org/pkofler/javaclass-rb]
+* {Homepage (GitHub)}[https://github.com/codecop/javaclass-rb]
 * email peter dot kofler at code minus cop dot org
 
 == Description
@@ -27,52 +27,56 @@ which might be the base for some serious static code analysis tools. (I
   sudo gem install javaclass
 
 * {Gem Hosting}[http://rubygems.org/gems/javaclass]
-* {Download of tarballs and gems}[https://bitbucket.org/pkofler/javaclass-rb/downloads]
+* {Download of tar balls and gems}[https://www.code-cop.org/download/javaclass-rb/]
 
 == Documentation
 
 Module JavaClass is the entry point for basic functions. All advanced functions are
-available in Object through the JavaClass::Dsl::Mixin. The main class or the parser 
-is JavaClass::ClassFile::JavaClassHeader which provides access to all information 
-of a Java class file. 
+available in Object through the JavaClass::Dsl::Mixin. The main class or the parser
+is JavaClass::ClassFile::JavaClassHeader which provides access to all information
+of a Java class file.
 
-* {API RDoc}[http://www.code-cop.org/api/javaclass-rb/]
+* {API RDoc}[https://www.code-cop.org/api/javaclass-rb/]
 
-I tried hard to rdoc all classes and public methods, so just {read it}[http://www.code-cop.org/api/javaclass-rb/].
+I tried hard to rdoc all classes and public methods, so just {read it}[https://www.code-cop.org/api/javaclass-rb/].
 
 == Usage
 
-See the various examples in the examples folder of the gem. 
+See the various examples in the examples folder of the gem.
 
 * {Basic Usage}[link:/files/lib/generated/examples/simple_usage_txt.html]
-* {Number of classes in modules/JARs}[link:/files/lib/generated/examples/count_classes_in_modules_txt.html]
-* {Check names of all interfaces}[link:/files/lib/generated/examples/check_interface_names_txt.html]
-* {All imported types}[link:/files/lib/generated/examples/find_all_imported_types_txt.html]
-* {Cumulative dependencies of a class}[link:/files/lib/generated/examples/cumulative_dependencies_txt.html]
-* {Find (un)referenced JARs}[link:/files/lib/generated/examples/find_referenced_modules_txt.html] 
-* {Find unused classes}[link:/files/lib/generated/examples/find_unreferenced_classes_txt.html]
-* {Extract and chart dependencies between classes}[link:/files/lib/generated/examples/chart_class_dependencies_txt.html]
-* {Extract and chart dependency info between modules}[link:/files/lib/generated/examples/chart_module_dependencies_txt.html]
-* {Generate lists of JDK classes}[link:/files/lib/generated/examples/generate_class_lists_txt.html]
-* {List content of a (Maven) JAR}[link:/files/lib/generated/examples/show_jar_api_txt.html]
-
-There is some experimental logic to recognize Java class name literals in Ruby 
-which are mapped to JavaClass::JavaQualifiedName. Packages have to be suffixed 
-with ".*" to be recognized. See JavaClass::Dsl::JavaNameFactory for its usage. 
+* Classes in modules/Jars, classpath
+  * {Number of classes in modules/JARs}[link:/files/lib/generated/examples/count_classes_in_modules_txt.html]
+  * {List content of a (Maven) JAR}[link:/files/lib/generated/examples/show_jar_api_txt.html]
+  * {Generate lists of JDK classes}[link:/files/lib/generated/examples/generate_class_lists_txt.html]
+  * {Check names of all interfaces}[link:/files/lib/generated/examples/check_interface_names_txt.html]
+* Dependencies to other classes
+  * {All imported types}[link:/files/lib/generated/examples/find_all_imported_types_txt.html]
+  * {Cumulative dependencies of a class}[link:/files/lib/generated/examples/cumulative_dependencies_txt.html]
+  * {Find (un)referenced JARs}[link:/files/lib/generated/examples/find_referenced_modules_txt.html]
+  * {Find unused classes}[link:/files/lib/generated/examples/find_unreferenced_classes_txt.html]
+  * {Extract and chart dependencies between classes}[link:/files/lib/generated/examples/chart_class_dependencies_txt.html]
+  * {Extract and chart dependency info between modules}[link:/files/lib/generated/examples/chart_module_dependencies_txt.html]
+  * {Find classes that are accessed from outside the module}[link:/files/lib/generated/examples/find_incoming_dependency_graph_txt.html]
+  * {Based on dependencies, sort modules into layers}[link:/files/lib/generated/examples/find_layers_of_modules_txt.html]
+
+There is some experimental logic to recognize Java class name literals in Ruby
+which are mapped to JavaClass::JavaQualifiedName. Packages have to be suffixed
+with ".*" to be recognized. See JavaClass::Dsl::JavaNameFactory for its usage.
 
 == Dependencies
 
-* Ruby 1.8.7 (also tested under 1.9.3, 2.0.0 and 2.1.6)
-* {rubyzip}[https://github.com/rubyzip/rubyzip] 0.9.1 (also tested with 0.9.6.1, 0.9.9, 1.0.0 and 1.1.7)
+* Ruby 1.8.7 (also tested 1.9.3, 2.0, 2.1 to 2.7)
+* {rubyzip}[https://github.com/rubyzip/rubyzip] 0.9.1 (also tested 0.9.6.1, 0.9.9, 1.0.0, 1.1.7, 1.3.0, 2.3.0)
 * Originally Ruby 1.8.6 with rubyzip 0.9.1
 
 == References
 
-* {The Java class file lifestyle}[http://www.javaworld.com/javaworld/jw-07-1996/jw-07-classfile.html], JavaWorld 1996.
-* {The class File Format}[http://java.sun.com/docs/books/jvms/second_edition/html/ClassFile.doc.html], The Java Virtual Machine Specification, Second Edition.
-* {Similar Project by unageanu}[http://github.com/unageanu/javaclass], GitHub 2010. 
+* The Java class file lifestyle, JavaWorld 1996.
+* The class File Format, The Java Virtual Machine Specification, Second Edition.
+* {Similar Project by unageanu}[http://github.com/unageanu/javaclass], GitHub 2010.
 
 == License
 
 Typically the licenses listed for the project are that of the project itself, and not of dependencies.
-* {BSD License}[http://www.opensource.org/licenses/bsd-license.php], it's enclosed in {license.txt}[link:/files/license_txt.html].
+* {The 2-Clause BSD License}[http://www.opensource.org/licenses/bsd-license.php], it's enclosed in {license.txt}[link:/files/license_txt.html].