rcommons 0.8.0

data/COPYING

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/Changes.rdoc

@@ -0,0 +1,4 @@
+= rCommons Changelog
+
+== Version 0.8.0
+* initial revision.

data/README.rdoc

@@ -0,0 +1,21 @@
+= rCommons
+
+== Installation
+
+== License
+Apache License 2.0
+
+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.
+
+== Version
+SVN: $Id: README.rdoc 70 2008-10-08 14:21:16Z whitestar $

data/Rakefile

@@ -0,0 +1,277 @@
+# Rakefile
+#
+# $Id: Rakefile 77 2008-10-12 12:07:49Z whitestar $
+
+require 'rake/testtask'
+require 'rake/clean'
+require 'rake/rdoctask'
+#require 'hanna/rdoctask'
+require 'rake/gempackagetask'
+
+PROJECT = 'rCommons'
+MY_NAME = 'Yomei Komiya'
+MY_EMAIL = ''
+PROJECT_SUMMARY = 'Common libraries for Ruby similar to Apache Commons.'
+
+# The project's package name (as opposed to its display name). Used for
+# RubyForge connectivity and packaging.
+UNIX_NAME = 'rcommons'
+RUBYFORGE_USER = ENV['RUBYFORGE_USER'] || 'whitestar'
+
+# Variable settings for extension support.
+EXT_DIR = 'ext'
+HAVE_EXT = File.directory?(EXT_DIR)
+EXTCONF_FILES = FileList["#{EXT_DIR}/**/extconf.rb"]
+EXT_SOURCES = FileList["#{EXT_DIR}/**/*.{c,h}"]
+# Eventually add other files from EXT_DIR, like "MANIFEST"
+EXT_DIST_FILES = EXT_SOURCES + EXTCONF_FILES
+
+REQUIRE_PATHS = ['lib', 'test']
+#REQUIRE_PATHS = ['lib']
+REQUIRE_PATHS << EXT_DIR if HAVE_EXT
+$LOAD_PATH.concat(REQUIRE_PATHS)
+# This library file defines the MyProject::VERSION constant.
+require 'commons'
+PROJECT_VERSION = eval('Commons::VERSION')
+#require "#{UNIX_NAME}"
+#PROJECT_VERSION = eval("#{PROJECT}::VERSION") # e.g. '1.0.2'
+
+WEBSITE_DIR = 'website'
+
+# Output directory for the rdoc html files.
+# If you don't have a custom homepage, and want to use the RDoc
+# index.html as homepage, just set it to WEBSITE_DIR.
+RDOC_HTML_DIR = "#{WEBSITE_DIR}/rdoc/#{PROJECT_VERSION}"
+RDOC_ALL_HTML_DIR = "#{WEBSITE_DIR}/rdoc-all/#{PROJECT_VERSION}"
+
+# Clobber object files and Makefiles generated by extconf.rb.
+CLOBBER.include("#{EXT_DIR}/**/*.{so,dll,o}", "#{EXT_DIR}/**/Makefile")
+# Clobber .config generated by setup.rb.
+CLOBBER.include('.config')
+CLOBBER.include('coverage')
+
+# Options common to RDocTask AND Gem::Specification.
+#   The --main argument specifies which file appears on the index.html page
+GENERAL_RDOC_OPTS = {
+  '--title' => "#{PROJECT} #{PROJECT_VERSION} API documentation",
+  '--main' => 'README.rdoc'
+}
+
+# Additional RDoc formatted files, besides the Ruby source files.
+RDOC_FILES = FileList['README.rdoc', 'Changes.rdoc']
+# Remove the following line if you don't want to extract RDoc from
+# the extension C sources.
+RDOC_FILES.include(EXT_SOURCES)
+
+# Ruby library code.
+LIB_FILES = FileList['lib/**/*.rb']
+
+# Filelist with Test::Unit test cases.
+TEST_FILES = FileList['test/**/*_test.rb']
+#TEST_FILES = FileList['test/**/tc_*.rb']
+
+# Executable scripts, all non-garbage files under bin/.
+BIN_FILES = FileList['bin/*']
+
+# This filelist is used to create source packages.
+# Include all Ruby and RDoc files.
+DIST_FILES = FileList['**/*.rb', '**/*.rdoc']
+DIST_FILES.include('Rakefile', 'COPYING')
+DIST_FILES.include(BIN_FILES)
+DIST_FILES.include('data/**/*', 'test/data/**/*')
+DIST_FILES.include("#{WEBSITE_DIR}/**/*.{html,css}", 'man/*.[0-9]')
+# Don't package files which are autogenerated by RDocTask
+DIST_FILES.exclude(/^(\.\/)?#{RDOC_HTML_DIR}(\/|$)/)
+# Include extension source files.
+DIST_FILES.include(EXT_DIST_FILES)
+# Don't package temporary files, perhaps created by tests.
+DIST_FILES.exclude('**/temp_*', '**/*.tmp')
+# Don't get into recursion...
+DIST_FILES.exclude(/^(\.\/)?pkg(\/|$)/)
+
+# Run the tests if rake is invoked without arguments.
+task 'default' => ['test']
+
+test_task_name = HAVE_EXT ? 'run-tests' : 'test'
+Rake::TestTask.new(test_task_name) do |t|
+  t.test_files = TEST_FILES
+  t.libs = REQUIRE_PATHS
+  t.ruby_opts = ['-rubygems']
+end
+
+begin
+  require 'rcov/rcovtask'
+ 
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.rcov_opts = [
+      '-xRakefile',
+      '-x/var/lib/gems', '-x/Library',
+      '--text-report',
+      '--sort coverage'
+    ]
+    t.test_files = FileList[
+      'test/**/*_test.rb'
+    ]
+    t.output_dir = "#{WEBSITE_DIR}/coverage/#{PROJECT_VERSION}"
+    t.ruby_opts = ['-rubygems']
+    t.verbose = true
+  end
+rescue LoadError
+  puts 'RCov is not available'
+end
+
+# Set an environment variable with any configuration options you want to
+# be passed through to 'setup.rb config'.
+CONFIG_OPTS = ENV['CONFIG']
+if HAVE_EXT
+  file_create '.config' do
+    ruby "setup.rb config #{CONFIG_OPTS}"
+  end
+  
+  desc 'Configure and make extension. ' +
+    "The CONFIG variable is passed to `setup.rb config'"
+  task 'make-ext' => '.config' do
+    # The -q option suppresses messages from setup.rb.
+    ruby 'setup.rb -q setup'
+  end
+  
+  desc 'Run tests after making the extension.'
+  task 'test' do
+    Rake::Task['make-ext'].invoke
+    Rake::Task['run-tests'].invoke
+  end
+end
+
+# The 'rdoc' task generates API documentation.
+Rake::RDocTask.new('rdoc') do |t|
+  t.rdoc_files = RDOC_FILES + LIB_FILES
+  t.title = GENERAL_RDOC_OPTS['--title']
+  t.main = GENERAL_RDOC_OPTS['--main']
+  t.rdoc_dir = RDOC_HTML_DIR
+  t.template = 'doc/jamis.rb'
+  #t.template = 'hanna'
+  #t.template = 'kilmer'
+  t.options = ['--inline-source', '--line-numbers']
+end
+
+Rake::RDocTask.new('rdoc_all') do |t|
+  t.rdoc_files = RDOC_FILES + LIB_FILES + TEST_FILES
+  t.title = GENERAL_RDOC_OPTS['--title'] + ' with TestCases'
+  t.main = GENERAL_RDOC_OPTS['--main']
+  t.rdoc_dir = RDOC_ALL_HTML_DIR
+  t.template = 'doc/jamis.rb'
+  #t.template = 'hanna'
+  #t.template = 'kilmer'
+  t.options = ['--inline-source', '--line-numbers']
+end
+
+GEM_SPEC = Gem::Specification.new do |s|
+  s.name = UNIX_NAME
+  s.version = PROJECT_VERSION
+  s.summary = PROJECT_SUMMARY
+  s.rubyforge_project = UNIX_NAME
+  s.homepage = "http://#{UNIX_NAME}.sourceforge.jp/wikiu/"
+  #s.homepage = "http://#{UNIX_NAME}.rubyforge.org/"
+  s.author = MY_NAME
+  s.email = MY_EMAIL
+  s.files = DIST_FILES
+  s.test_files = TEST_FILES
+  s.executables = BIN_FILES.map { |fn| File.basename(fn) }
+  s.add_dependency('facets', '>= 2.4.4')
+  s.add_dependency('log4r', '>= 1.0.5')
+  s.has_rdoc = true
+  s.extra_rdoc_files = RDOC_FILES
+  s.rdoc_options = GENERAL_RDOC_OPTS.to_a.flatten
+  if HAVE_EXT
+    s.extensions = EXTCONF_FILES
+    s.require_paths << EXT_DIR
+  end
+end
+
+# Now we can generate the package-related tasks.
+Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+desc 'Upload website to RubyForge. ' +
+  'scp will prompt for your RubyForge password.'
+task 'publish-website' => ['rdoc'] do
+  rubyforge_path = "/var/www/gforge-projects/#{UNIX_NAME}/"
+  sh "scp -r #{WEBSITE_DIR}/* " +
+    "#{RUBYFORGE_USER}@rubyforge.org:#{rubyforge_path}",
+    :verbose => true
+end
+
+task 'rubyforge-setup' do
+  unless File.exist?(File.join(ENV['HOME'], '.rubyforge'))
+    puts 'rubyforge will ask you to edit its config.yml now.'
+    puts "Please set the `username' and `password' entries"
+    puts 'to your RubyForge username and RubyForge password!'
+    puts 'Press ENTER to continue.'
+    $stdin.gets
+    sh 'rubyforge setup', :verbose => true
+  end
+end
+
+task 'rubyforge-login' => ['rubyforge-setup'] do
+  # Note: We assume that username and password were set in
+  # rubyforge's config.yml.
+  sh 'rubyforge login', :verbose => true
+end
+
+task 'publish-packages' => ['package', 'rubyforge-login'] do
+  # Upload packages under pkg/ to RubyForge
+  # This task makes some assumptions:
+  # * You have already created a package on the "Files" tab on the
+  #   RubyForge project page. See pkg_name variable below.
+  # * You made entries under package_ids and group_ids for this
+  #   project in rubyforge's config.yml.  If not, eventually read
+  #   "rubyforge --help" and then run "rubyforge setup".
+  pkg_name = ENV['PKG_NAME'] || UNIX_NAME
+  cmd = "rubyforge add_release #{UNIX_NAME} #{pkg_name} " +
+        "#{PROJECT_VERSION} #{UNIX_NAME}-#{PROJECT_VERSION}"
+  cd 'pkg' do
+    sh(cmd + '.gem', :verbose => true)
+    sh(cmd + '.tgz', :verbose => true)
+    sh(cmd + '.zip', :verbose => true)
+  end
+end
+
+desc 'Generate project\'s all documentations.'
+task 'alldocs' => ['clobber'] do
+  puts "Generating all documents of #{PROJECT} version #{PROJECT_VERSION} ..."
+  Rake::Task['rcov'].invoke
+  Rake::Task['rdoc'].invoke
+  Rake::Task['rdoc_all'].invoke
+end
+
+# The "prepare-release" task makes sure your tests run, and then generates
+# files for a new release.
+desc 'Run tests, generate RDoc and create packages.'
+task 'prepare-release' => ['clobber'] do
+  puts "Preparing release of #{PROJECT} version #{PROJECT_VERSION}"
+  Rake::Task['test'].invoke
+  Rake::Task['alldocs'].invoke
+  Rake::Task['package'].invoke
+end
+
+# The "publish" task is the overarching task for the whole project. It
+# builds a release and then publishes it to RubyForge.
+desc "Publish new release of #{PROJECT}"
+task 'publish' => ['prepare-release'] do
+  puts 'Uploading documentation...'
+  Rake::Task['publish-website'].invoke
+  puts 'Checking for rubyforge command...'
+  `rubyforge --help`
+  if $? == 0
+    puts 'Uploading packages...'
+    Rake::Task['publish-packages'].invoke
+    puts 'Release done!'
+  else
+    puts "Can't invoke rubyforge command."
+    puts "Either install rubyforge with 'gem install rubyforge'"
+    puts 'and retry or upload the package files manually!'
+  end
+end