yargi 0.1.2 → 0.2.0

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'yargi'

data/spec/test_decorate.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+module Yargi
+  describe Decorate do
+
+    let(:graph) do
+      graph = Digraph.new{|d|
+        v0, v1, v2, v3 = d.add_n_vertices(4)
+        d.connect(v0, v1)
+        d.connect(v1, v2)
+        d.connect(v2, v3)
+        d.connect(v0, v3)
+      }
+    end
+
+    specify "DEPTH" do
+      Decorate::DEPTH.execute(graph)
+      graph.vertices.collect{|v| v[:depth]}.should == [0, 1, 2, 1]
+    end
+
+    specify "SHORTEST_PATH" do
+      Decorate::SHORTEST_PATH.execute(graph)
+      graph.vertices.collect{|v| v[:shortest_path].join(',')}.should == [
+        "", "e0:V0->V1", "e0:V0->V1,e1:V1->V2", "e3:V0->V3"
+      ]
+    end
+
+  end
+end

data/spec/test_digraph.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+module Yargi
+  describe Digraph do
+
+    let(:graph) do
+      Digraph.new{|g|
+        v0, v1 = g.add_n_vertices(2)
+        g.connect(v0,v1)
+      }
+    end
+
+    it "should support creating a graph smootlhy" do
+      graph.should be_a(Digraph)
+    end
+
+    it "should have vertex_count and edge_count methods" do
+      graph.vertex_count.should eq(2)
+      graph.edge_count.should eq(1)
+    end
+
+    it "should allow connecting trough indexes" do
+      v0, v1, edge = nil, nil, nil
+      d = Digraph.new{|d|
+        v0, v1 = d.add_n_vertices(2)
+        edge = d.connect(0,1).first
+      }
+      edge.source.should eq(v0)
+      edge.target.should eq(v1)
+    end
+
+    it "should have a ith_vertex and ith_edge methods" do
+      graph.ith_vertex(0).index.should eq(0)
+      graph.ith_vertex(1).index.should eq(1)
+      graph.ith_edge(0).index.should eq(0)
+    end
+
+    it "should accept integers as vertices selectors" do
+      graph.vertices(1).collect{|v| v.index}.should eq([1])
+    end
+
+  end
+end

data/spec/test_random.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+module Yargi
+  describe Random do
+
+    it "should be installed as a graph class method" do
+      Digraph.random.should be_a(Digraph)
+    end
+
+    it "should serve the requested number of vertices unless strip" do
+      graph = Digraph.random do |r|
+         r.vertex_count = 10
+         r.edge_count = 20
+         r.strip = false
+      end
+      graph.vertex_count.should == 10
+      graph.edge_count.should == 20
+    end
+
+    it "should allow specifying sizes inline" do
+      graph = Digraph.random(10, 20) do |r|
+         r.strip = false
+      end
+      graph.vertex_count.should == 10
+      graph.edge_count.should == 20
+    end
+
+    it "should strip the graph if requested" do
+      graph = Digraph.random(50, 20)
+      graph.vertex_count.should_not eq(50)
+      Decorate::DEPTH.execute(graph)
+      graph.vertices{|v| v[:depth] > 20}.should be_empty
+    end
+
+    it "should allow specifying vertex and edge builders" do
+      graph = Digraph.random(10, 20) do |r|
+        r.vertex_builder = lambda{|v,i| v[:i] = i}
+        r.edge_builder   = lambda{|e,i| e[:i] = i}
+        r.strip = false
+      end
+      graph.vertices.collect{|v| v[:i]}.should == (0...10).to_a
+      graph.edges.collect{|e| e[:i]}.should == (0...20).to_a
+    end
+
+  end
+end

data/spec/test_yargi.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+describe Yargi do
+
+  it "should have a version number" do
+    Yargi.const_defined?(:VERSION).should be_true
+  end
+
+end

data/tasks/debug_mail.rake

@@ -0,0 +1,75 @@
+# Installs a rake task for debuging the announcement mail.
+#
+# This file installs the 'rake debug_mail' that flushes an announcement mail
+# for your library on the standard output. It is automatically generated
+# by Noe from your .noespec file, and should therefore be configured there,
+# under the variables/rake_tasks/debug_mail entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     debug_mail:
+#       rx_changelog_sections: /^#/
+#       nb_changelog_sections: 1
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file,
+# don't forget to set safe-override to false in your noe specification:
+#
+# template-info:
+#   manifest:
+#     tasks/debug_mail.rake:
+#       safe-override: false
+#
+# The mail template used can be found in debug_mail.txt. That file may be
+# changed to tune the mail you want to send. If you do so, don't forget to
+# add a manifest entry in your .noespec file to avoid overriding you
+# changes. The mail template uses wlang, with parentheses for block
+# delimiters.
+#
+# template-info:
+#   manifest:
+#     tasks/debug_mail.txt:
+#       safe-override: false
+#
+desc "Debug the release announcement mail"
+task :debug_mail do
+  begin
+    require 'wlang'
+  rescue LoadError
+    abort "wlang is not available. Try 'gem install wlang'"
+  end
+  require 'yaml'
+
+  # Check that a .noespec file exists
+  noespec_file = File.expand_path('../../yargi.noespec', __FILE__)
+  unless File.exists?(noespec_file)
+    raise "Unable to find .noespec project file, sorry."
+  end
+
+  # Load it as well as variables and options
+  noespec = YAML::load(File.read(noespec_file))
+  vars = noespec['variables'] || {}
+
+  # Changes are taken from CHANGELOG
+  logs = Dir[File.expand_path("../../CHANGELOG.*", __FILE__)]
+  unless logs.size == 1
+    abort "Unable to find a changelog file"
+  end
+
+  # Load interesting changesets
+  changes, end_found = [], 0
+  File.readlines(logs.first).select{|line|
+    if line =~ /^# /
+      break if end_found >= 1
+      end_found += 1
+    end
+    changes << line
+  }
+  vars['changes'] = changes.join
+
+  # WLang template
+  template = File.expand_path('../debug_mail.txt', __FILE__)
+
+  # Let's go!
+  $stdout << WLang::file_instantiate(template, vars, "wlang/active-text")
+end

data/tasks/debug_mail.txt

@@ -0,0 +1,13 @@
+Subject: [ANN] !{lower} !{version} Released
+
+!{lower} version !{version} has been released!
+
+!{summary}
+
+*{links as l}{* <!{l}>}{!{"\n"}}
+
+!{description}
+
+Changes:
+
+!{changes}

data/tasks/gem.rake

@@ -0,0 +1,68 @@
+# Installs rake tasks for gemming and packaging
+#
+# This file installs the 'rake package', 'rake gem' tasks and associates
+# (clobber_package, repackage, ...). It is automatically generated by Noe
+# from your .noespec file, and should therefore be configured there, under
+# the variables/rake_tasks/gem entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     gem:
+#       package_dir: pkg
+#       need_tar: false
+#       need_tar_gz: false
+#       need_tar_bz2: false
+#       need_zip: false
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file,
+# don't forget to set safe-override to false in your noe specification:
+#
+# template-info:
+#   manifest:
+#     tasks/gem.rake:
+#       safe-override: false
+#
+begin
+  require 'rubygems/package_task'
+  Gem::PackageTask.new($gemspec) do |t|
+
+    # Name of the package
+    t.name = $gemspec.name
+
+    # Version of the package
+    t.version = $gemspec.version
+
+    # Directory used to store the package files
+    t.package_dir = "pkg"
+
+    # True if a gzipped tar file (tgz) should be produced
+    t.need_tar = false
+
+    # True if a gzipped tar file (tar.gz) should be produced
+    t.need_tar_gz = false
+
+    # True if a bzip2'd tar file (tar.bz2) should be produced
+    t.need_tar_bz2 = false
+
+    # True if a zip file should be produced (default is false)
+    t.need_zip = false
+
+    # List of files to be included in the package.
+    t.package_files = $gemspec.files
+
+    # Tar command for gzipped or bzip2ed archives.
+    t.tar_command = "tar"
+
+    # Zip command for zipped archives.
+    t.zip_command = "zip"
+
+  end
+rescue LoadError
+  task :gem do
+    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
+  end
+  task :package do
+    abort 'rubygems/package_task is not available. You should verify your rubygems installation'
+  end
+end

data/tasks/spec_test.rake

@@ -0,0 +1,71 @@
+# Installs a rake task for for running examples written using rspec.
+#
+# This file installs the 'rake spec_test' (aliased as 'rake spec') as well as
+# extends 'rake test' to run spec tests, if any. It is automatically generated
+# by Noe from your .noespec file, and should therefore be configured there,
+# under the variables/rake_tasks/spec_test entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     spec_test:
+#       pattern: spec/**/*_spec.rb
+#       verbose: true
+#       rspec_opts: [--color, --backtrace]
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file,
+# don't forget to set safe-override to false in your noe specification:
+#
+# template-info:
+#   manifest:
+#     tasks/spec_test.rake:
+#       safe-override: false
+#
+# This file has been written to conform to RSpec v2.4.0. More information about
+# rspec and options of the rake task defined below can be found on
+# http://relishapp.com/rspec
+#
+begin
+  require "rspec/core/rake_task"
+  desc "Run RSpec code examples"
+  RSpec::Core::RakeTask.new(:spec_test) do |t|
+    # Glob pattern to match files.
+    t.pattern = "spec/**/test_*.rb"
+
+    # Whether or not to fail Rake when an error occurs (typically when
+    # examples fail).
+    t.fail_on_error = true
+
+    # A message to print to stderr when there are failures.
+    t.failure_message = nil
+
+    # Use verbose output. If this is set to true, the task will print the
+    # executed spec command to stdout.
+    t.verbose = true
+
+    # Use rcov for code coverage?
+    t.rcov = false
+
+    # Path to rcov.
+    t.rcov_path = "rcov"
+
+    # Command line options to pass to rcov. See 'rcov --help' about this
+    t.rcov_opts = []
+
+    # Command line options to pass to ruby. See 'ruby --help' about this
+    t.ruby_opts = []
+
+    # Path to rspec
+    t.rspec_path = "rspec"
+
+    # Command line options to pass to rspec. See 'rspec --help' about this
+    t.rspec_opts = ["--color", "--backtrace"]
+  end
+rescue LoadError => ex
+  task :spec_test do
+    abort 'rspec is not available. In order to run spec, you must: gem install rspec'
+  end
+ensure
+  task :spec => [:spec_test]
+  task :test => [:spec_test]
+end

data/tasks/unit_test.rake

@@ -0,0 +1,76 @@
+# Installs a rake task for for running unit tests.
+#
+# This file installs the 'rake unit_test' and extends 'rake test' to run unit
+# tests, if any. It is automatically generated by Noe from your .noespec file,
+# and should therefore be configured there, under the variables/rake_tasks/unit_test
+# entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     unit_test:
+#       pattern: test/test*.rb
+#       verbose: false
+#       warning: false
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file,
+# don't forget to set safe-override to false in your noe specification:
+#
+# template-info:
+#   manifest:
+#     tasks/unit_test.rake:
+#       safe-override: false
+#
+# More info about the TestTask and its options can be found on
+# http://rake.rubyforge.org/classes/Rake/TestTask.html
+#
+begin
+  require 'rake/testtask'
+  desc "Run unit tests"
+  Rake::TestTask.new(:unit_test) do |t|
+
+    # List of directories to added to $LOAD_PATH before running the
+    # tests. (default is 'lib')
+    t.libs = ["lib"]
+
+    # True if verbose test output desired. (default is false)
+    t.verbose = false
+
+    # Test options passed to the test suite.  An explicit TESTOPTS=opts
+    # on the command line will override this. (default is NONE)
+    t.options = nil
+
+    # Request that the tests be run with the warning flag set.
+    # E.g. warning=true implies "ruby -w" used to run the tests.
+    t.warning = false
+
+    # Glob pattern to match test files. (default is 'test/test*.rb')
+    t.pattern = "test/test_*.rb"
+
+    # Style of test loader to use.  Options are:
+    #
+    # * :rake -- Rake provided test loading script (default).
+    # * :testrb -- Ruby provided test loading script.
+    # * :direct -- Load tests using command line loader.
+    #
+    t.loader = :rake
+
+    # Array of commandline options to pass to ruby when running test
+    # loader.
+    t.ruby_opts = []
+
+    # Explicitly define the list of test files to be included in a
+    # test.  +list+ is expected to be an array of file names (a
+    # FileList is acceptable).  If both +pattern+ and +test_files+ are
+    # used, then the list of test files is the union of the two.
+    t.test_files = nil
+
+  end
+rescue LoadError => ex
+  task :unit_test do
+    abort "rake/testtask does not seem available...\n  #{ex.message}"
+  end
+ensure
+  desc "Run all tests"
+  task :test => [:unit_test]
+end

data/tasks/yard.rake

@@ -0,0 +1,51 @@
+# Installs a rake task to generate API documentation using yard.
+#
+# This file installs the 'rake yard' task. It is automatically generated by Noe from
+# your .noespec file, and should therefore be configured there, under the
+# variables/rake_tasks/yard entry, as illustrated below:
+#
+# variables:
+#   rake_tasks:
+#     yard:
+#       files: lib/**/*.rb
+#       options: []
+#       ...
+#
+# If you have specific needs requiring manual intervention on this file,
+# don't forget to set safe-override to false in your noe specification:
+#
+# template-info:
+#   manifest:
+#     tasks/yard.rake:
+#       safe-override: false
+#
+# This file has been written to conform to yard v0.6.4. More information about
+# yard and the rake task installed below can be found on http://yardoc.org/
+#
+begin
+  require "yard"
+  desc "Generate yard documentation"
+  YARD::Rake::YardocTask.new(:yard) do |t|
+    # Array of options passed to yardoc commandline. See 'yardoc --help' about this
+    t.options = ["--output-dir", "doc/api", "-", "README.md", "CHANGELOG.md", "LICENCE.md"]
+
+    # Array of ruby source files (and any extra documentation files
+    # separated by '-')
+    t.files = ["lib/**/*.rb"]
+
+    # A proc to call before running the task
+    # t.before = proc{ }
+
+    # A proc to call after running the task
+    # r.after = proc{ }
+
+    # An optional lambda to run against all objects being generated.
+    # Any object that the lambda returns false for will be excluded
+    # from documentation.
+    # t.verifier = lambda{|obj| true}
+  end
+rescue LoadError
+  task :yard do
+    abort 'yard is not available. In order to run yard, you must: gem install yard'
+  end
+end