library 0.1.0

data/lib/ubylibs.rb

@@ -0,0 +1,8 @@
+require 'library'
+require 'library/kernel'
+
+# Note the plural!!!
+list = ENV['RUBYLIBS'].to_s.split(/[:;]/)
+
+Library.prime(*list, :expound=>true)
+

data/qed/01_loading.rdoc

@@ -0,0 +1,14 @@
+= Load and Require
+
+The #library method can be used to constrain a library to a particular
+version.
+
+  library('tryme', '1.1')
+
+If we try to constrain a library to an incompatible version a VersionConflit
+will be raised.
+
+  expect Library::VersionConflict do
+    library('tryme', '1.0')
+  end
+

data/qed/02_library.rdoc

@@ -0,0 +1,55 @@
+= Library Instances
+
+The Library class can be initialized given the location of the project.
+
+  tryme10 = Library.new(fixtures + '/tryme/1.0')
+  tryme11 = Library.new(fixtures + '/tryme/1.1')
+
+With a library instance in hand we can query it for information about itself.
+
+  tryme10.name.assert == "tryme"
+  tryme11.name.assert == "tryme"
+
+  tryme10.version.to_s.assert == "1.0"
+  tryme11.version.to_s.assert == "1.1"
+
+Secondary information, taken from a project's  .ruby file, can be queried via
+the #metadata method.
+
+  tryme10.metadata['resources']['home'].assert == "http://tryme.foo"
+  tryme11.metadata['resources']['home'].assert == "http://tryme.foo"
+
+Of course, the most important function of a library is to load and require
+a script. With an Library instance in hand this can be achieved directly.
+
+  tryme10.load('tryme.rb')
+  $tryme_message.assert == "Try Me v1.0"
+
+But if we try to load from another version, we will get a VersionConflict
+error.
+
+  expect Library::VersionConflict do
+    tryme11.load('tryme.rb')
+  end
+
+However, we can bypass this constraint (if we know what you are doing!) with
+the :force option.
+
+  tryme11.load('tryme.rb', :force=>true)
+  $tryme_message.assert == "Try Me v1.1"
+
+Notice that when requiring files directly via a Library instance, if a file
+is required from two different versions of a library, a VersionConflict
+error will be rasied.
+
+  expect Library::VersionConflict do
+    tryme11.require('tryme')
+  end
+
+But there is no error if we use the active version.
+
+  tryme10.require('tryme')
+
+TODO: In the future, I think we will put in a version check, and a :force
+option to override.
+

data/qed/03_ledger.rdoc

@@ -0,0 +1,30 @@
+= The Ledger
+
+At the heart of Library lies a Ledger object. It is essentially a Hash of
+library names indexing Library objects stored in the global $LEDGER variable.
+
+  $LEDGER.keys.sort.assert == ['foo', 'ruby', 'tryme']
+
+The Library class redirects a number of calls to the $LEDGER, so we
+could invoke the same methods on it instead.
+
+  Library.names.assert == $LEDGER.keys
+
+Which we choose to use is really a matter of taste. The Roll::Library
+methods were designed for readability, whereas $LEDGER is used internally.
+For the rest of this demo we will use $LEDGER since this demonstration
+is specifically about it.
+
+The values of $LEDGER will always be either a Library object or an
+array of Library objects, of the same name but differnt versions.
+
+When a particular library is activated for the first time the corresponding
+array value will be replaced by the library.
+
+  $LEDGER['tryme'].assert.is_a?(Array)
+
+  library('tryme')
+
+  $LEDGER['tryme'].assert.is_a?(Library)
+
+

data/qed/04_version.rdoc

@@ -0,0 +1,101 @@
+= Version Class
+
+Librarys has a versioj class which it uses to compare
+versions via vairous constraints.
+
+Load the library.
+
+  require 'library/version'
+
+First, a version object will return the string representation
+via #to_s.
+
+  v = Library::Version.new('1.2.3')
+  '1.2.3'.assert == v.to_s
+
+It will also do this for #to_str.
+
+  v = Library::Version.new('1.2.3')
+  '1.2.3'.assert == v.to_str
+
+The actual segments of a version are stored in an array.
+We can access those via #[].
+
+  v = Library::Version.new('1.2.3')
+  1.assert == v[0]
+  2.assert == v[1]
+  3.assert == v[2]
+
+In addition certain segmetns have special names.
+The first is accessible via #major.
+
+  v = Library::Version.new('1.2.3')
+  v.major.assert == 1
+
+The second is accessible via #minor.
+
+  v = Library::Version.new('1.2.3')
+  v.minor.assert == 2
+
+The third is accessible via #patch.
+
+  v = Library::Version.new('1.2.3')
+  v.patch.assert == 3
+
+And lastly anything beyond the patch number is accessible
+via #build.
+
+  v = Library::Version.new('1.2.3.pre.1')
+  v.build.assert == 'pre.1'
+
+Two version can be compared with the #<=> method, which
+importantly also makes lists of versions sortable.
+
+  v1 = Library::Version.new('1.2.3')
+  v2 = Library::Version.new('1.2.4')
+  (v2 <=> v1).assert == 1
+
+While #=~ provides *pessimistic* constraint comparison.
+
+  v1 = Library::Version.new('1.2.4')
+  v2 = Library::Version.new('1.2')
+  assert(v1 =~ v2)
+
+The Version class also provides some useful singleton methods
+such as #parse_constraint. This method deciphers a comparision string.
+
+  a = Library::Version.parse_constraint("~> 1.0.0")
+  e = ["=~", Library::Version['1.0.0']]
+  a.assert == e
+
+Equality can be written with `==` or `=`.
+
+  a = Library::Version.parse_constraint("= 0.9.0")
+  e = ["==", Library::Version['0.9.0']]
+  a.assert == e
+
+Without an operator equality is implied.
+
+  a = Library::Version.parse_constraint("1.1")
+  e = [ "==", Library::Version['1.1'] ]
+  a.assert == e
+
+This is usefuly for parsing requirement configurations. Using it, the Version
+class can build contraint comparison procedures.
+
+  compare = Library::Version.constraint_lambda("=1.0")
+  compare.call('1.0').assert == true
+  compare.call('0.9').assert == false
+
+Greater than
+
+  compare = Library::Version.constraint_lambda(">1.0")
+  compare.call('1.1').assert == true
+  compare.call('0.9').assert == false
+
+Less than
+
+  compare = Library::Version.constraint_lambda("<1.0")
+  compare.call('1.1').assert == false
+  compare.call('0.9').assert == true
+

data/qed/applique/check.rb

@@ -0,0 +1,11 @@
+if ENV['RUBYOPT'].index('-rubylibs') || ENV['RUBYOPT'].index('-roll')
+  abort "Remove -rubylibs or -roll from RUBYOPT before running these tests." 
+end
+
+# Make sure we use local version of files.
+#$:.unshift('lib')
+
+def fixtures
+  @_fixtures ||= File.dirname(__FILE__) + '/../fixtures'
+end
+

data/qed/applique/project.rb

@@ -0,0 +1,34 @@
+require 'library'
+require 'library/kernel'
+
+require 'pathname'
+
+project_directory = Pathname.new('projects')
+
+When 'Given a project directory "(((\S+)))"' do |name|
+  @project_directory = project_directory + name
+  libdir = @project_directory + 'lib'
+  FileUtils.mkdir_p(libdir) unless libdir.exist?
+end
+
+When 'With a file "(((\S+)))" containing' do |name, text|
+  file = @project_directory + name
+  FileUtils.mkdir_p(file.parent) unless file.parent.exist?
+  File.open(file.to_s, 'w'){ |f| f << text }
+end
+
+Before :demo do
+  prime_ledger
+  #p $LEDGER
+end
+
+# Support method to setup fresh Ledger.
+def prime_ledger
+  projects = File.dirname(__FILE__) + '/../fixtures/*'
+
+  # reset ledger (shouldn't this happen in Library.prime call?)
+  $LEDGER = ::Library::Ledger.new
+
+  ::Library.prime(*projects, :expound=>true)
+end
+

data/qed/fixtures/foo/.ruby

@@ -0,0 +1,5 @@
+---
+name: foo
+version: 0.8.2
+date: 2011-12-12
+title: Foo

data/qed/fixtures/foo/lib/foo.rb

@@ -0,0 +1 @@
+$foo_message = "Foo 0.8.2"

data/qed/fixtures/tryme/1.0/.ruby

@@ -0,0 +1,6 @@
+---
+name: tryme
+version: 1.0
+title: TryMe
+resources:
+  home: "http://tryme.foo"

data/qed/fixtures/tryme/1.0/lib/tryme.rb

@@ -0,0 +1 @@
+$tryme_message = "Try Me v1.0"

data/qed/fixtures/tryme/1.1/.ruby

@@ -0,0 +1,7 @@
+---
+name: tryme
+version: 1.1
+title: TryMe
+resources:
+  home: "http://tryme.foo"
+

data/qed/fixtures/tryme/1.1/lib/tryme.rb

@@ -0,0 +1 @@
+$tryme_message = "Try Me v1.1"

data/qed/helpers/new_project.rdoc

@@ -0,0 +1,29 @@
+= Additional Project
+
+== Neo 0.0.1
+
+Given a project directory "neo/0.0.1".
+
+With a file "VERSION" containing...
+
+  name: neo
+  vers: 0.0.1
+
+With a file "PROFILE" containing...
+
+  title   : Neo
+  author  : Thomas Sawyer
+  homepage: http://neo.foo
+
+With a file "lib/neo.rb" containing...
+
+  $neo_message = "Neo v0.0.1"
+
+With a file ".ruby/name" containing...
+
+  neo
+
+With a file ".ruby/version" containing...
+
+  0.0.1
+

data/qed/helpers/projects.rdoc

@@ -0,0 +1,56 @@
+= Basic Set of Projects
+
+== TryMe 1.0
+
+Given a project directory "tryme/1.0".
+
+With a file "VERSION" containing...
+
+  name: tryme
+  vers: 1.0
+
+With a file "PROFILE" containing...
+
+  title   : TryMe
+  author  : Thomas Sawyer
+  homepage: http://tryme.foo
+
+With a file "lib/tryme.rb" containing...
+
+  $tryme_message = "Try Me v1.0"
+
+With a file ".ruby/name" containing...
+
+  tryme
+
+With a file ".ruby/version" containing...
+
+  1.0
+
+== TryMe 1.1
+
+Given a project directory "tryme/1.1".
+
+With a file "VERSION" containing...
+
+  name: tryme
+  vers: 1.1
+
+With a file "PROFILE" containing...
+
+  title   : TryMe
+  author  : Thomas Sawyer
+  homepage: http://tryme.foo
+
+With a file "lib/tryme.rb" containing...
+
+  $tryme_message = "Try Me v1.1"
+
+With a file ".ruby/name" containing...
+
+  tryme
+
+With a file ".ruby/version" containing...
+
+  1.1
+

data/test/case_ledger.rb

@@ -0,0 +1,23 @@
+covers 'library/ledger'
+
+testcase Library::Ledger do
+
+  method :add do
+    test do
+      ledger = Library::Ledger.new
+      ledger.add(File.dirname(__FILE__) + '/fixture')
+      ledger.assert.size == 1
+    end
+  end
+
+  method :[] do
+    test do
+      ledger = Library::Ledger.new
+      ledger.add(File.dirname(__FILE__) + '/fixture')
+
+      ledger[:foo].assert.is_a? Array
+      ledger['foo'].assert.is_a? Array
+    end
+  end
+
+end

data/test/case_library.rb

@@ -0,0 +1,13 @@
+covers 'library'
+
+testcase Library do
+
+  class_method :new do
+
+    test do
+      Library.new(File.dirname(__FILE__) + '/fixture')
+    end
+
+  end
+
+end

data/test/case_version.rb

@@ -0,0 +1,89 @@
+covers 'library/version'
+
+testcase Library::Version do
+
+  concern "Ensure functionality of Roll's Version class."
+
+  method :to_s do
+    test do
+      v = Library::Version.new('1.2.3')
+      v.to_s.assert == '1.2.3'
+    end
+  end
+
+  method :to_str do
+    test do
+      v = Library::Version.new('1.2.3')
+      v.to_str.assert == '1.2.3'
+    end
+  end
+
+  method :inspect do
+    test do
+      v = Library::Version.new('1.2.3')
+      v.inspect.assert == '1.2.3'
+    end
+  end
+
+  method :[] do
+    test do
+      v = Library::Version.new('1.2.3')
+      v[0].assert == 1
+      v[1].assert == 2
+      v[2].assert == 3
+    end
+  end
+
+  method :<=> do
+    test do
+      v1 = Library::Version.new('1.2.3')
+      v2 = Library::Version.new('1.2.4')
+      (v2 <=> v1).assert == 1
+    end
+  end
+
+  # TODO
+  #   def =~( other )
+  #     #other = other.to_t
+  #     upver = other.dup
+  #     upver[0] += 1
+  #     @self >= other and @self < upver
+  #   end
+
+  method :=~ do
+    test "pessimistic constraint" do
+      v1 = Library::Version.new('1.2.4')
+      v2 = Library::Version.new('1.2')
+      assert(v1 =~ v2)
+    end
+  end
+
+  method :major do
+    test do
+      v = Library::Version.new('1.2.3')
+      v.major.assert == 1
+    end
+  end
+
+  method :minor do
+    test do
+      v = Library::Version.new('1.2.3')
+      v.minor.assert == 2
+    end
+  end
+
+  method :patch do
+    test do
+      v = Library::Version.new('1.2.3')
+      v.patch.assert == 3
+    end
+  end
+
+  class_method :parse_constraint do
+    test do
+      constraint = Library::Version.parse_constraint("~> 1.0.0")
+      constraint.assert == ["=~", Library::Version['1.0.0']]
+    end
+  end
+
+end