cargo 0.0.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Michel Martens & Damian Janowski
+
+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.

data/README.markdown

@@ -0,0 +1,128 @@
+Cargo
+=====
+
+Require libraries without cluttering your namespace.
+
+Description
+-----------
+
+Consider these two versions of the same library:
+
+    # foo-1.0.0.rb
+    class Foo
+      VERSION = "1.0.0"
+    end
+
+    # foo-2.0.0.rb
+    class Foo
+      VERSION = "2.0.0"
+    end
+
+If you want to use both of them in your application, `require` and
+`load` will be of little help. Consider what happens when you require
+both libraries:
+
+    >> require "foo-1.0.0"
+    => true
+    >> require "foo-2.0.0"
+    => true
+    >> Foo::VERSION
+    => "2.0.0"
+
+As both files are opening the same class, there's no way for you to use
+them independently.
+
+Cargo solves that problem in a very simple way:
+
+    >> Foo1 = import("foo-1.0.0")
+    => #<Module:0x000001009ffa28>::Foo
+    >> Foo2 = import("foo-2.0.0")
+    => #<Module:0x000001009f2828>::Foo
+    >> Foo1::VERSION
+    => "1.0.0"
+    >> Foo2::VERSION
+    => "2.0.0"
+
+How does it work?
+-----------------
+
+The command `Kernel.load` accepts a second parameter, which value is
+`false` by default. When the passed value is `true`, the script is
+executed under an anonymous module, protecting the calling program's
+global namespace. No local variables in the loaded file are propagated
+to the loading environment.
+
+By using a global module as a temporal storage, it is possible to
+transfer a value from the anonymous module to the caller program.
+
+Usage
+-----
+
+After requiring `cargo` in the calling program, two methods will
+be available: `import` and `export`. Both use the global module
+`Cargo` for temporal storage.
+
+This is how you will use it in the calling program:
+
+    $ cat calling_program.rb
+    require "cargo"
+
+    MyFoo = import("foo")
+
+
+And for that to work, the imported library should look like this:
+
+    $ cat foo.rb
+    class Foo
+      VERSION = "1.0.0"
+    end
+
+    export(Foo)
+
+Note that you can only export one value per file. Multiple calls to
+`export` just change the value to be exported. This constraint is in
+place in order to make for a simple and clean implementation.
+
+How to prepare your library for Cargo
+-------------------------------------
+
+In your library entry point, you need to use `export` and provide a value. As
+the `export` method won't be available unless the caller is using
+Cargo, you can make a conditional call:
+
+    export(Foo) if defined?(export)
+
+If your library has just one file, that single line will make your code
+ready to be imported. Otherwise, you will need to require Cargo and
+make sure you don't mix import with require for local files.
+
+Installation
+------------
+
+    $ gem install cargo
+
+License
+-------
+
+Copyright (c) 2010 Michel Martens & Damian Janowski
+
+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.

data/Rakefile

@@ -0,0 +1,5 @@
+task :test do
+  system "cd test && ruby cargo_test.rb"
+end
+
+task :default => :test

data/cargo.gemspec

@@ -0,0 +1,10 @@
+Gem::Specification.new do |s|
+  s.name              = "cargo"
+  s.version           = "0.0.1"
+  s.summary           = "Require libraries without cluttering your namespace."
+  s.description       = "Cargo lets you use different versions of the same library by implementing two simple commands, which let you load programs without messing with your namespace."
+  s.authors           = ["Michel Martens", "Damian Janowski"]
+  s.email             = ["michel@soveran.com", "djanowski@dimaion.com"]
+  s.homepage          = "http://github.com/soveran/cargo"
+  s.files = ["LICENSE", "README.markdown", "Rakefile", "lib/cargo.rb", "cargo.gemspec", "test/cargo_test.rb", "test/foo-1.0.0.rb", "test/foo-2.0.0.rb", "test/helper.rb"]
+end

data/lib/cargo.rb

@@ -0,0 +1,25 @@
+module Cargo
+  VERSION = "0.0.1"
+
+  def self.import(file)
+    unless file.match(/\.rb$/)
+      file = "#{file}.rb"
+    end
+
+    load(file, true)
+
+    @cargo
+  end
+
+  def self.export(cargo)
+    @cargo = cargo
+  end
+end
+
+def import(file)
+  Cargo.import(file)
+end
+
+def export(cargo)
+  Cargo.export(cargo)
+end

data/test/cargo_test.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+
+require File.join(File.dirname(__FILE__), "helper")
+require "ruby-debug"
+
+setup do
+  unless defined?(Foo1)
+    Foo1 = import("foo-1.0.0")
+  end
+
+  unless defined?(Foo2)
+    Foo2 = import("foo-2.0.0")
+  end
+end
+
+test "Foo is not available" do
+  assert nil == defined?(Foo)
+end
+
+test "Foo1 is a class" do
+  assert Class == Foo1.class
+end
+
+test "methods are available" do
+  assert "Hello" == Foo1.new.bar
+end
+
+test "methods on nested classes are available" do
+  assert "Hello" == Foo1::Bar.new.baz
+  assert "Hello" == Foo1::Bar::Baz.new.qux
+end
+
+test "nested classes are not available in the top level" do
+  begin
+    Bar::Baz.new.qux
+  rescue
+    assert NameError == $!.class
+  end
+end
+
+test "Foo2 should be possible" do
+  assert "Hello" == Foo2.new.bar
+end
+
+puts " ✔ All tests passed"

data/test/foo-1.0.0.rb

@@ -0,0 +1,19 @@
+class Foo
+  class Bar
+    class Baz
+      def qux
+        "Hello"
+      end
+    end
+
+    def baz
+      "Hello"
+    end
+  end
+
+  def bar
+    "Hello"
+  end
+end
+
+export(Foo) if defined?(export)

data/test/foo-2.0.0.rb

@@ -0,0 +1,19 @@
+class Foo
+  class Bar
+    class Baz
+      def qux
+        "Hello"
+      end
+    end
+
+    def baz
+      "Hello"
+    end
+  end
+
+  def bar
+    "Hello"
+  end
+end
+
+export(Foo) if defined?(export)

data/test/helper.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+require File.join(File.dirname(__FILE__), "..", "lib", "cargo")
+
+AssertionFailed = Class.new(StandardError)
+
+def assert(value)
+  return if value
+
+  file, line = caller[0].split(":")
+  code = File.readlines(file)[line.to_i - 1]
+
+  puts " ✗ #{code.strip}"
+  puts "   #{file}:#{line}"
+  exit(1)
+end
+
+def setup(&block)
+  @_setup = block
+end
+
+def test(name = nil, &block)
+  @_test = name
+
+  block.call(@_setup.call)
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: cargo
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Michel Martens
+- Damian Janowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-26 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: Cargo lets you use different versions of the same library by implementing two simple commands, which let you load programs without messing with your namespace.
+email: 
+- michel@soveran.com
+- djanowski@dimaion.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/cargo.rb
+- cargo.gemspec
+- test/cargo_test.rb
+- test/foo-1.0.0.rb
+- test/foo-2.0.0.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/soveran/cargo
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Require libraries without cluttering your namespace.
+test_files: []
+