subload 1.0.3 → 1.1.0

data/CHANGELOG.rdoc

@@ -0,0 +1,7 @@
+=== 1.1.0 / 2010-03-17
+
+* 1 major enhancement
+
+  * Moved to Hoe
+  * Modification from coderrr to support C2C2Api -> c2c2_api
+

data/Manifest.txt

@@ -0,0 +1,19 @@
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+examples/a.rb
+examples/a/foo.rb
+examples/a/foo/bar.rb
+examples/a/foo/baz.rb
+examples/rails/loader.rb
+lib/subload.rb
+subload.gemspec
+test/test_subload.rb
+test/test_subload/a.rb
+test/test_subload/b.rb
+test/test_subload/c.rb
+test/test_subload/d.rb
+test/test_subload/e.rb
+test/test_subload/f.rb
+test/test_subload/f/a.rb

data/README.rdoc

@@ -0,0 +1,117 @@
+= subload
+
+* http://rubygems.org/gems/subload
+* docs: http://libraggi.rubyforge.org/subload/
+* source: http://github.com/raggi/subload/
+* issues: http://github.com/raggi/subload/issues
+* rubyforge: http://rubyforge.org/projects/libraggi
+
+== DESCRIPTION:
+
+A handy dandy autoload / require / load helper for your rubies. Similar to
+using[1], but with a few differences of opinion, and a bit shorter.
+
+Basically, expand path is fine, up until a point. Sometimes there's no point
+(i.e. when the load path already contains most of the path you're trying to
+open). When you're writing libs that users might require sub parts with
+'libname/sub_part', then expand_path combined with say, rubygems, can lead to
+double requires. Lets not do that. :-)
+
+[1] http://github.com/smtlaissezfaire/using/
+
+== FEATURES/PROBLEMS:
+
+* File.expand_path: Expand path is good if you're traversing up directories.
+  It is bad if you're loading something within a library that is on the load
+  path. If the library is on the load path, and you require files with an
+  expanded path, there is the likelihood of a double require when other code
+  contains a require that is expectant of the load path modification.
+
+* Frameworks: Sometimes require explicit load order control. In these cases,
+  overriding the loader and either tracking, or performing stateful operations
+  works well.
+
+* Abusive use of override_mode: Override mode is potentially dangerous. As per
+  the other documentation, override mode should be reserved for use in
+  application code only. Libraries setting override mode could cause
+  additional failure cases for foreign libraries, although gratuitous addition
+  of loading mechanisms is not recommended.
+
+* Generated code loading: When you're doing code generation, sometimes it is
+  desirable to have tow locations from which to load a class. One will contain
+  custom class defintions, and the other will contain generated definitions.
+  Using a custom loader, one can then utilise a single subload statement to
+  correctly load both files.
+
+* TODO Chaotic Overloading
+
+* Consider vertical vs. horizontal delegation rules and use cases for new
+  loaders in non-framework libraries that perform custom loads such that it is
+  easy to say "invoke the current load mode with the following options".
+
+== SYNOPSIS:
+
+  module A
+    
+    # The nominal use case, A.autoload :B, 'a/b'
+    # You rarely need much else!
+    subload :B
+    
+    # A custom path, A.autoload :C, 'a/c'
+    subload :C, :path => 'a/c'
+    # For example when 'a/c' defines several constants:
+    subload :Ca, :path => 'a/c'
+    subload :Cb, :path => 'a/c'
+    
+    # An expanded path, A.autoload :D, File.join(Dir.pwd, 'a/d')
+    subload :D, :expand_path => true
+    # This has interesting uses in combination, although not generally 
+    # recommended:
+    subload :E, :path => '../../path/e', :expand_path => true
+    
+    # Explicitly override the mode, for this call only, A.require 'a/f'
+    subload :F, :mode => :require
+    
+    # Set the mode for all subsiquent calls to subload in this class/module
+    subload_with :require
+    subload :G # => require 'a/g'
+    subload :H # => require 'a/h'
+    
+    # Other features intended for library and framework developers are described
+    # in the class documentation.
+    
+  end
+
+
+== REQUIREMENTS:
+
+* ruby
+
+== INSTALL:
+
+* gem install subload
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 James Tucker <raggi@rubyforge.org>
+
+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 NON-INFRINGEMENT.
+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.

data/Rakefile

@@ -1,109 +1,27 @@
 #!/usr/bin/env rake
-require 'rake/clean'
 
-task :default => :spec
+require 'hoe'
+Hoe.plugin :doofus, :git, :gemcutter
 
-def spec(file = Dir['*.gemspec'].first)
-  @spec ||=
-  begin
-    require 'rubygems/specification'
-    Thread.abort_on_exception = true
-    data = File.read(file)
-    spec = nil
-    Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
-    spec.instance_variable_set(:@filename, file)
-    def spec.filename; @filename; end
-    spec
-  end
+hoe = Hoe.spec 'subload' do
+  developer "James Tucker", "raggi@rubyforge.org"
+  extra_dev_deps << %w(hoe-doofus >=1.0.0)
+  extra_dev_deps << %w(hoe-git >=1.3.0)
+  extra_dev_deps << %w(hoe-gemcutter >=1.0.0)
+  self.extra_rdoc_files = FileList["**/*.rdoc"]
+  self.history_file     = "CHANGELOG.rdoc"
+  self.readme_file      = "README.rdoc"
+  self.rubyforge_name   = 'libraggi'
 end
 
-def manifest; @manifest ||= `git ls-files`.split("\n").reject{|s|s=~/\.gemspec$|\.gitignore$/}; end
+# TODO  make a plugin to deal with this
+gem_spec_file = hoe.spec.name + '.gemspec'
+version_file = %Q{lib/#{hoe.spec.name}.rb}
 
-@gem_package_task_type = begin
-  require 'rubygems/package_task'
-  Gem::PackageTask
-rescue LoadError
-  require 'rake/gempackagetask'
-  Rake::GemPackageTask
+desc "Generate #{gem_spec_file}"
+file gem_spec_file => hoe.spec.files - [gem_spec_file] do
+  open(gem_spec_file, 'w') { |f| f.write hoe.spec.to_ruby }
 end
-def gem_task; @gem_task ||= @gem_package_task_type.new(spec); end
-gem_task.define
-Rake::Task[:clobber].enhance [:clobber_package]
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |t|
-  t.test_files = spec.test_files
-  t.ruby_opts = ['-rubygems'] if defined? Gem
-  t.warning = true
-end unless spec.test_files.empty?
-
-rdoc_task_type = begin
-  require 'rdoc/task'
-  RDoc::Task
-rescue LoadError
-  require 'rake/rdoctask'
-  Rake::RDocTask
-end
-df = begin; require 'rdoc/generator/darkfish'; true; rescue LoadError; end
-rdtask = rdoc_task_type.new do |rd|
-  rd.title = spec.name
-  rd.main = spec.extra_rdoc_files.first
-  lib_rexp = spec.require_paths.map { |p| Regexp.escape p }.join('|')
-  rd.rdoc_files.include(*manifest.grep(/^(?:#{lib_rexp})/))
-  rd.rdoc_files.include(*spec.extra_rdoc_files)
-  rd.template = 'darkfish' if df
-end
-
-Rake::Task[:clobber].enhance [:clobber_rdoc]
-
-require 'yaml'
-require 'rake/contrib/sshpublisher'
-desc "Publish rdoc to rubyforge"
-task :publish => rdtask.name do
-  rf_cfg = File.expand_path '~/.rubyforge/user-config.yml'
-  host = "#{YAML.load_file(rf_cfg)['username']}@rubyforge.org"
-  remote_dir = "/var/www/gforge-projects/#{spec.rubyforge_project}/#{spec.name}/"
-  Rake::SshDirPublisher.new(host, remote_dir, rdtask.rdoc_dir).upload
-end
-
-desc 'Generate and open documentation'
-task :docs => :rdoc do
-  path = rdtask.send :rdoc_target
-  case RUBY_PLATFORM
-  when /darwin/       ; sh "open #{path}"
-  when /mswin|mingw/  ; sh "start #{path}"
-  else 
-    sh "firefox #{path}"
-  end
-end
-
-desc "Regenerate gemspec"
-task :gemspec => spec.filename
-
-task spec.filename do
-  spec.files = manifest
-  spec.test_files = FileList['{test,spec}/**/{test,spec}_*.rb']
-  open(spec.filename, 'w') { |w| w.write spec.to_ruby }
-end
-
-desc "Bump version from #{spec.version} to #{spec.version.to_s.succ}"
-task :bump do
-  spec.version = spec.version.to_s.succ
-end
-
-desc "Tag version #{spec.version}"
-task :tag do
-  tagged = Dir.new('.git/refs/tags').entries.include? spec.version.to_s
-  if tagged
-    warn "Tag #{spec.version} already exists"
-  else
-    # TODO release message in tag message
-    sh "git tag #{spec.version}"
-  end
-end
-
-desc "Release #{gem_task.gem_file} to rubyforge and gemcutter"
-task :release => [:tag, :gem, :publish] do |t|
-  sh "rubyforge add_release #{spec.rubyforge_project} #{spec.name} #{spec.version} #{gem_task.package_dir}/#{gem_task.gem_file}"
-  sh "gem push #{gem_task.package_dir}/#{gem_task.gem_file}"
-end
+task :package => gem_spec_file
+task :check_manifest => gem_spec_file

data/lib/subload.rb

@@ -1,5 +1,7 @@
 # TODO convert to yardoc
 module Subload
+  VERSION = '1.1.0'
+
   # To add modes to subload, simply add them to this hash. Please use the
   # a namespace convention, starting with +:projectname_operationdescription+.
   MODES = {
@@ -62,7 +64,7 @@ module Subload
     subload_with(mode)[self, symbol, path, options]
   end
 
-  LONG_UPPER_CONSTS = [/([A-Z]+)([A-Z][a-z]+)/, '\1_\2']
+  LONG_UPPER_CONSTS = [/([A-Z\d]+)([A-Z][a-z]+)/, '\1_\2']
   TAIL_UPPER_CONSTS = [/([a-z])([A-Z])/, '\1_\2']
   DOUBLE_UNDERSCORE = '__'
   DOUBLE_COLON = '::'
@@ -98,4 +100,4 @@ class Module
   else
     alias __name__ name
   end
-end
+end

data/subload.gemspec

@@ -0,0 +1,52 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{subload}
+  s.version = "1.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Tucker"]
+  s.date = %q{2010-03-17}
+  s.description = %q{A handy dandy autoload / require / load helper for your rubies. Similar to
+using[1], but with a few differences of opinion, and a bit shorter.
+
+Basically, expand path is fine, up until a point. Sometimes there's no point
+(i.e. when the load path already contains most of the path you're trying to
+open). When you're writing libs that users might require sub parts with
+'libname/sub_part', then expand_path combined with say, rubygems, can lead to
+double requires. Lets not do that. :-)
+
+[1] http://github.com/smtlaissezfaire/using/}
+  s.email = ["raggi@rubyforge.org"]
+  s.extra_rdoc_files = ["Manifest.txt", "CHANGELOG.rdoc", "README.rdoc"]
+  s.files = ["CHANGELOG.rdoc", "Manifest.txt", "README.rdoc", "Rakefile", "examples/a.rb", "examples/a/foo.rb", "examples/a/foo/bar.rb", "examples/a/foo/baz.rb", "examples/rails/loader.rb", "lib/subload.rb", "subload.gemspec", "test/test_subload.rb", "test/test_subload/a.rb", "test/test_subload/b.rb", "test/test_subload/c.rb", "test/test_subload/d.rb", "test/test_subload/e.rb", "test/test_subload/f.rb", "test/test_subload/f/a.rb"]
+  s.homepage = %q{http://rubygems.org/gems/subload}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{libraggi}
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A handy dandy autoload / require / load helper for your rubies}
+  s.test_files = ["test/test_subload.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<hoe-doofus>, [">= 1.0.0"])
+      s.add_development_dependency(%q<hoe-git>, [">= 1.3.0"])
+      s.add_development_dependency(%q<hoe-gemcutter>, [">= 1.0.0"])
+      s.add_development_dependency(%q<hoe>, [">= 2.3.3"])
+    else
+      s.add_dependency(%q<hoe-doofus>, [">= 1.0.0"])
+      s.add_dependency(%q<hoe-git>, [">= 1.3.0"])
+      s.add_dependency(%q<hoe-gemcutter>, [">= 1.0.0"])
+      s.add_dependency(%q<hoe>, [">= 2.3.3"])
+    end
+  else
+    s.add_dependency(%q<hoe-doofus>, [">= 1.0.0"])
+    s.add_dependency(%q<hoe-git>, [">= 1.3.0"])
+    s.add_dependency(%q<hoe-gemcutter>, [">= 1.0.0"])
+    s.add_dependency(%q<hoe>, [">= 2.3.3"])
+  end
+end

data/test/test_subload.rb

@@ -1,6 +1,4 @@
 require "test/unit"
-
-$:.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
 require "subload"
 
 class TestSubload < Test::Unit::TestCase
@@ -68,4 +66,10 @@ class TestSubload < Test::Unit::TestCase
     assert_equal("Module", Module.__name__)
   end
 
-end
+  def test_to_path
+    assert_equal 'c2c2_api', Subload.to_path('C2C2Api')
+    assert_equal '123_api', Subload.to_path('123Api')
+    assert_equal 'http_error', Subload.to_path('HTTPError')
+    assert_equal 'no_method_error', Subload.to_path('NoMethodError')
+  end
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: subload
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - James Tucker
@@ -9,39 +14,90 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-10 00:00:00 +01:00
+date: 2010-03-17 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rdoc
+  name: hoe-doofus
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe-git
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.4.3
-    version: 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: hoe-gemcutter
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.8.7
-    version: 
-description: An autoload/require/custom loader wrapper
-email: raggi@rubyforge.org
+        segments: 
+        - 2
+        - 3
+        - 3
+        version: 2.3.3
+  type: :development
+  version_requirements: *id004
+description: |-
+  A handy dandy autoload / require / load helper for your rubies. Similar to
+  using[1], but with a few differences of opinion, and a bit shorter.
+  
+  Basically, expand path is fine, up until a point. Sometimes there's no point
+  (i.e. when the load path already contains most of the path you're trying to
+  open). When you're writing libs that users might require sub parts with
+  'libname/sub_part', then expand_path combined with say, rubygems, can lead to
+  double requires. Lets not do that. :-)
+  
+  [1] http://github.com/smtlaissezfaire/using/
+email: 
+- raggi@rubyforge.org
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
+- Manifest.txt
+- CHANGELOG.rdoc
+- README.rdoc
 files: 
-- README
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
 - Rakefile
 - examples/a.rb
 - examples/a/foo.rb
@@ -49,6 +105,7 @@ files:
 - examples/a/foo/baz.rb
 - examples/rails/loader.rb
 - lib/subload.rb
+- subload.gemspec
 - test/test_subload.rb
 - test/test_subload/a.rb
 - test/test_subload/b.rb
@@ -58,37 +115,35 @@ files:
 - test/test_subload/f.rb
 - test/test_subload/f/a.rb
 has_rdoc: true
-homepage: http://libraggi.rubyforge.org/subload
+homepage: http://rubygems.org/gems/subload
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --line-numbers
-- --inline-source
-- --title
-- Subload
 - --main
-- README
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: libraggi
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
-specification_version: 2
-summary: An autoload/require/custom loader wrapper
+specification_version: 3
+summary: A handy dandy autoload / require / load helper for your rubies
 test_files: 
 - test/test_subload.rb

data/README

@@ -1,77 +0,0 @@
-subload
-
-A handy dandy autoload / require / load helper for your rubies. Similar to
-using[1], but with a few differences of opinion, and a bit shorter.
-
-Basically, expand path is fine, up until a point. Sometimes there's no point
-(i.e. when the load path already contains most of the path you're trying to
-open). When you're writing libs that users might require sub parts with
-'libname/sub_part', then expand_path combined with say, rubygems, can lead to
-double requires. Lets not do that. :-)
-
-[1] http://github.com/smtlaissezfaire/using/
-
-TODO - replace me... more...
-
-Examples:
-
-module A
-
-  # The nominal use case, A.autoload :B, 'a/b'
-  # You rarely need much else!
-  subload :B
-
-  # A custom path, A.autoload :C, 'a/c'
-  subload :C, :path => 'a/c'
-  # For example when 'a/c' defines several constants:
-  subload :Ca, :path => 'a/c'
-  subload :Cb, :path => 'a/c'
-
-  # An expanded path, A.autoload :D, File.join(Dir.pwd, 'a/d')
-  subload :D, :expand_path => true
-  # This has interesting uses in combination, although not generally 
-  # recommended:
-  subload :E, :path => '../../path/e', :expand_path => true
-
-  # Explicitly override the mode, for this call only, A.require 'a/f'
-  subload :F, :mode => :require
-
-  # Set the mode for all subsiquent calls to subload in this class/module
-  subload_with :require
-  subload :G # => require 'a/g'
-  subload :H # => require 'a/h'
-
-  # Other features intended for library and framework developers are described
-  # in the class documentation.
-
-end
-
-Some Notes:
-
-* File.expand_path: Expand path is good if you're traversing up directories.
-  It is bad if you're loading something within a library that is on the load
-  path. If the library is on the load path, and you require files with an
-  expanded path, there is the likelihood of a double require when other code
-  contains a require that is expectant of the load path modification.
-
-* Frameworks: Sometimes require explicit load order control. In these cases,
-  overriding the loader and either tracking, or performing stateful operations
-  works well.
-
-* Abusive use of override_mode: Override mode is potentially dangerous. As per
-  the other documentation, override mode should be reserved for use in
-  application code only. Libraries setting override mode could cause
-  additional failure cases for foreign libraries, although gratuitous addition
-  of loading mechanisms is not recommended.
-
-* Generated code loading: When you're doing code generation, sometimes it is
-  desirable to have tow locations from which to load a class. One will contain
-  custom class defintions, and the other will contain generated definitions.
-  Using a custom loader, one can then utilise a single subload statement to
-  correctly load both files.
-
-TODO Chaotic Overloading
-
-Consider vertical vs. horizontal delegation rules and use cases for new
-loaders in non-framework libraries that perform custom loads such that it is
-easy to say "invoke the current load mode with the following options".