backload 0.2.0

data/.index

@@ -0,0 +1,53 @@
+---
+type: ruby
+revision: 2013
+sources:
+- var
+authors:
+- name: Thomas Sawyer
+  email: transfire@gmail.com
+organizations: []
+requirements:
+- groups:
+  - test
+  development: true
+  name: microtest
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - build
+  development: true
+  name: rake
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/backload
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/backload
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/backload/issues
+  label: Issue Tracker
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/backload.git
+categories: []
+paths:
+  load:
+  - lib
+copyrights:
+- holder: Rubyworks
+  year: '2012'
+  license: BSD-2-Clause
+created: '2012-04-29'
+summary: ! 'Callbacks for #require and #load.'
+title: Backload
+version: 0.2.0
+name: backload
+description: ! 'Backload provides callbacks for Ruby''s #require and #load methods.'
+date: '2012-12-23'

data/HISTORY.md

@@ -0,0 +1,47 @@
+# RELEASE HISTORY
+
+## 0.2.0 / 2012-12-22
+
+Change the name of the project from Loaded to Backload, and
+changed the main callback method from `#loaded` to `#backloaded`.
+Then re-added `#loaded`, `#required` and `#required_relative` as
+straight callbacks for their corresponding present-tense methods.
+This makes the library backward compatible with v0.1.0.
+
+Changes:
+
+* Rename project to "backload".
+* Add basic callbacks for load, require and require_relative.
+* Master callback is renamed to `#backloaded`.
+
+
+## 0.1.1 / 2012-12-19
+
+Just a tweak to require_relative support, so that the `:relative`
+option provides the relative path, not just `true` or `false`.
+
+Changes:
+
+* The :relative option provides the relative path.
+
+
+## 0.1.0 / 2012-12-18
+
+This release uses a single callback method `#loaded` instead
+of the previous two (`#loaded` and `#required`). It also adds
+optional support for `#require_relative`.
+
+Changes:
+
+* Use single callback method.
+* Add support for #require_relative.
+
+
+## 0.0.1 / 2012-04-29
+
+Initial release of Loaded.
+
+Changes:
+
+* Created and implemented.
+

data/LICENSE.txt

@@ -0,0 +1,26 @@
+Required - Shouldn't require have a callback?  
+(http://rubyworks.github.com/required)
+
+Copyright (c) 2012 Rubyworks. All rights reserved
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
+BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+SPDX License: BSD-2-Clause

data/README.md

@@ -0,0 +1,74 @@
+[Homepage](http://rubygems.org/gems/backload) |
+[Report Issue](http://github.com/rubyworks/backload/issues) |
+[Source Code](http://github.com/rubyworks/backload) 
+( [![Build Status](https://secure.travis-ci.org/rubyworks/backload.png)](http://travis-ci.org/rubyworks/backload) )
+
+
+# Backload
+
+Shouldn't loading have a callback?
+
+
+## Installation
+
+Using RubyGems type on a command line:
+
+    $ gem install backload
+
+
+## Instruction
+
+To use Backload simply override the `Kernel.backloaded` method.
+
+```ruby
+  require 'backload'
+  require 'backload/require_relative'
+
+  def Kernel.backloaded(feature, options={})
+    if options[:require]
+      if rel = options[:relative]
+        puts "#{feature} has been required relative to #{rel}!"
+      else
+        puts "#{feature} has been required!"
+      end
+    else
+      if wrap = options[:wrap]
+        puts "#{feature} has been loaded with wrap, it's #{wrap}!"  
+      else
+        puts "#{feature} has been loaded!" 
+      end
+    end
+  end
+```
+
+Becuase of implementation details, `#require_relative` has to be reimplemented completely 
+to make the callback work. To be on the safe side, at least for now, it therefore has to
+be required separately, as the example above demonstrates.
+
+Backload also provides callbacks for each type of loading. Just use the past tense
+of the term for any of `#load`, `#require` and `#require_relative`. For example, to
+see all features as they have been required.
+
+```ruby
+  def Kernel.required(feature)
+    puts "#{feature} required!"
+  end
+```
+
+## Feedback
+
+Please report issues or suggestions to
+[GitHub Issues](http://github.com/rubyworks/backload/issues).
+Or if you wish to discuss in real-time try [IRC #rubyworks](irc://chat.us.freenet.org/rubyworks) on freenode.net.
+
+
+## Copying
+
+Backload is copyrighted open source software.
+
+    Copyright 2012 Rubyworks.
+
+it is modifiable and redistributable in accordance with the
+**BSD-2-Clause** license.
+
+See LICENSE.txt for details.

data/lib/backload.rb

@@ -0,0 +1,29 @@
+require 'backload/load'
+require 'backload/require'
+#require 'backload/require_relative'
+
+module Kernel
+
+  # Common callback for all loading methods: #load, #require
+  # and #require_relative.
+  #
+  # @param [Hash] options
+  #   The load callback options.
+  #
+  # @option options [Boolean] :load
+  #   True if #load was used.
+  #
+  # @option options [Boolean] :require
+  #   True is #require or #require_relative was used.
+  #
+  # @option options [Boolean] :relative
+  #   True is #require_relative was used.
+  #
+  # @option options [Boolean] :wrap
+  #   The wrap argument passed to #load.
+  #
+  def self.backloaded(path, options={})
+  end
+
+end
+

data/lib/backload/autoload.rb

@@ -0,0 +1,12 @@
+# This does not look doable in pure Ruby.
+
+#module Kernel
+#
+#  #
+#  # We create a noop method b/c it simplifes implementation.
+#  # Just override this method to use.
+#  #
+#  def self.autoloaded(path, options={})
+#  end
+#
+#end

data/lib/backload/load.rb

@@ -0,0 +1,52 @@
+module Kernel
+  
+  #
+  # We create a noop method b/c it simplifes implementation.
+  # Just override this method to use.
+  #
+  def self.loaded(path, wrap=nil)
+  end
+
+private
+
+  #
+  # Alias original Kernel#load method.
+  #
+  alias_method :load_without_callback, :load
+
+  #
+  # Redefine Kernel#load with callback.
+  #
+  def load(path, wrap=nil)
+    result = load_without_callback(path, wrap)
+
+    if result
+      Kernel.loaded(path, wrap)
+      Kernel.backloaded(path, :load=>true, :require=>false, :wrap=>wrap)
+    end
+
+    result
+  end
+
+  class << self
+    #
+    # Alias original Kernel.load method.
+    #
+    alias_method :load_without_callback, :load
+
+    #
+    # Redefine Kernel.load with callback.
+    #
+    def load(path, wrap=nil)
+      result = load_without_callback(path, wrap)
+
+      if result
+        Kernel.loaded(path, wrap)
+        Kernel.backloaded(path, :load=>true, :require=>false, :wrap=>wrap)
+      end
+
+      result
+    end
+  end
+
+end

data/lib/backload/require.rb

@@ -0,0 +1,52 @@
+module Kernel
+
+  #
+  # We create a noop method  b/c it simplifes implementation.
+  # Just override this method to use.
+  #
+  def self.required(path)
+  end
+
+private
+
+  #
+  # Alias original Kernel#require method.
+  #
+  alias_method :require_without_callback, :require
+
+  #
+  # Redefine Kernel#require with callback.
+  #
+  def require(feature, options=nil)
+    result = require_without_callback(feature)
+
+    if result
+      Kernel.required(feature)
+      Kernel.backloaded(feature, :require=>true, :load=>false)
+    end
+
+    result
+  end
+
+  class << self
+    #
+    # Alias original Kernel.require method.
+    #
+    alias_method :require_without_callback, :require
+
+    #
+    # Redefine Kernel.require with callback.
+    #
+    def require(feature)
+      result = require_without_callback(feature)
+
+      if result
+        Kernel.required(feature)
+        Kernel.backloaded(feature, :require=>true, :load=>false)
+      end
+
+      result
+    end
+  end
+
+end

data/lib/backload/require_relative.rb

@@ -0,0 +1,89 @@
+module Kernel
+
+  #
+  # We create a noop method b/c it simplifes implementation.
+  # Just override this method to use.
+  #
+  # Presently this is an optional feature and must be required 
+  # separately via `backload/require_relative`.
+  #
+  def self.required_relative(path)
+  end
+
+private
+
+  #
+  # Alias original Kernel#require_relative method.
+  #
+  alias_method :require_relative_without_callback, :require_relative
+
+  #
+  # Redefine Kernel#require_relative with callback.
+  #
+  # @todo It would nice if the `:relative` option were set to the
+  #       realtive path, but that would require `Binding.of_caller`.
+  #
+  def require_relative(feature)
+    #result = require_relative_without_callback(feature)
+
+    ## We have to reimplement #require_relative instead of calling
+    ## the alias to ensure the proper path is used. (*sad*)
+    result = (
+      c = caller.first
+      fail "Can't parse #{c}" unless c.rindex(/:\d+(:in `.*')?$/)
+      file = $` # File.dirname(c)
+      if /\A\((.*)\)/ =~ file # eval, etc.
+        raise LoadError, "require_relative is called in #{$1}"
+      end
+      #options[:relative] = File.dirname(file)
+      absolute = File.expand_path(feature, File.dirname(file))
+      require_without_callback(absolute)
+    )
+
+    if result
+      Kernel.required_relative(feature)
+      Kernel.backloaded(feature, :require=>true, :load=>false, :relative=>File.dirname(file))
+    end
+
+    result
+  end
+
+  class << self
+    #
+    # Alias original Kernel.require_relative method.
+    #
+    alias_method :require_relative_without_callback, :require_relative
+
+    #
+    # Redefine Kernel.require_relative with callback.
+    #
+    # @todo It would nice if the `:relative` option were set to the
+    #       realtive path, but that would require `Binding.of_caller`.
+    #
+    def require_relative(feature)
+      #result = require_relative_without_callback(feature)
+
+      ## We have to reimplement #require_relative instead of calling
+      ## the alias to ensure the proper path is used. (*sad*)
+      result = (
+        c = caller.first
+        fail "Can't parse #{c}" unless c.rindex(/:\d+(:in `.*')?$/)
+        file = $` # File.dirname(c)
+        if /\A\((.*)\)/ =~ file # eval, etc.
+          raise LoadError, "require_relative is called in #{$1}"
+        end
+        #options[:relative] = File.dirname(file)
+        absolute = File.expand_path(feature, File.dirname(file))
+        require_without_callback absolute
+      )
+
+      if result
+        Kernel.required_relative(feature)
+        Kernel.backloaded(feature, :require=>true, :load=>false, :relative=>File.dirname(file))
+      end
+
+      result
+    end
+  end
+
+end

data/test/fixtures/example_load.rb

@@ -0,0 +1,2 @@
+# example ruby file
+1 + 1

data/test/fixtures/example_relative.rb

@@ -0,0 +1,2 @@
+# example ruby file
+1 + 1

data/test/fixtures/example_require.rb

@@ -0,0 +1,2 @@
+# example ruby file
+1 + 1

data/test/helper.rb

@@ -0,0 +1,25 @@
+# Load our test framework.
+require 'microtest'
+require 'microtest/assertions'
+
+# Load the library to be tested.
+require 'backload'
+
+# Put our load fixtures on the load path.
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/fixtures')
+
+# We use this setup to test each possible load configuration.
+def Kernel.backloaded(name, opts)
+  $load_name = name
+  $load_opts = opts
+end
+
+# Old version of Microtest lacks #refute.
+module MicroTest::Assertions
+  unless method_defined?(:refute)
+    def refute(fact, msg=nil)
+      __assert__(!fact, msg)
+    end
+  end
+end
+

data/test/test_load.rb

@@ -0,0 +1,17 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+
+class RequiredTestCase < MicroTest::TestCase
+
+  def test_load
+    load 'example_load.rb'
+
+    assert_equal 'example_load.rb', $load_name
+
+    refute $load_opts[:require]
+    refute $load_opts[:relative]
+    assert $load_opts[:load]
+    refute $load_opts[:wrap]
+  end
+
+end
+

data/test/test_require.rb

@@ -0,0 +1,17 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+
+class RequiredTestCase < MicroTest::TestCase
+
+  def test_require
+    require 'example_require'
+
+    assert_equal 'example_require', $load_name
+
+    assert $load_opts[:require]
+    refute $load_opts[:relative]
+    refute $load_opts[:load]
+    refute $load_opts[:wrap]
+  end
+
+end
+

data/test/test_require_relative.rb

@@ -0,0 +1,21 @@
+require File.expand_path('helper', File.dirname(__FILE__))
+
+require 'backload/require_relative'  # optional feature
+
+class RequiredTestCase < MicroTest::TestCase
+
+  def test_require_relative
+    require_relative 'fixtures/example_relative'
+
+    assert_equal 'fixtures/example_relative', $load_name
+
+    assert $load_opts[:require]
+    assert $load_opts[:relative]
+    refute $load_opts[:load]
+    refute $load_opts[:wrap]
+
+    assert_equal File.dirname(__FILE__), $load_opts[:relative]
+  end
+
+end
+

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: backload
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Sawyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: microtest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: detroit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Backload provides callbacks for Ruby''s #require and #load methods.'
+email:
+- transfire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- HISTORY.md
+- README.md
+files:
+- .index
+- lib/backload/autoload.rb
+- lib/backload/load.rb
+- lib/backload/require.rb
+- lib/backload/require_relative.rb
+- lib/backload.rb
+- test/fixtures/example_load.rb
+- test/fixtures/example_relative.rb
+- test/fixtures/example_require.rb
+- test/helper.rb
+- test/test_load.rb
+- test/test_require.rb
+- test/test_require_relative.rb
+- LICENSE.txt
+- HISTORY.md
+- README.md
+homepage: http://rubyworks.github.com/backload
+licenses:
+- BSD-2-Clause
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ! 'Callbacks for #require and #load.'
+test_files:
+- test/test_require.rb
+- test/helper.rb
+- test/test_require_relative.rb
+- test/test_load.rb
+- test/fixtures/example_require.rb
+- test/fixtures/example_load.rb
+- test/fixtures/example_relative.rb