atto 0.9.0 → 0.9.1

data/README

@@ -1,15 +1,14 @@
 INTRODUCTION
 
 Atto is an ultra-tiny self-contained testing framework inspired by 
-and partially based on nanotest. It is self-contained in that it needs no 
-external libraries. Every file in this project is,and will remain under 100 
-lines long, comments included.
-
+and partially based on nanotest by mynyml. It is self-contained in that it 
+needs no external libraries. Every ruby file in this project is, and will remain
+under 100 lines long, comments included.
 
 USAGE
 
 To use it in your tests, for every ruby file lib/foo/bar.rb in your project,
-make a test file lib/foo/test_bar.rb and start it with: 
+make a test file lib/foo/test_bar.rb and start it with:
 
 require 'atto'
 include Atto::Test
@@ -20,8 +19,37 @@ assert "A test that will always suceed" do true end
 assert { Foo::Bar }
 
 Then run the command atto from your project directory and it will run the tests
-automatically, every time you change either the lib file or the test file. It 
-will also detect new files being added.
+in the test directory automatically, and then, every time you change either a 
+lib file or a test file, it will run the relevant test again. It will also 
+detect new files being added. 
+
+Since version 0.9.1, atto has a tiny command line and environment options
+module, and the atto command understands the following command line options:
+  --help        -h      Display a help message. 
+  --project=dir -pdir   Sets project directory.
+  --lib=sub     -lsub   Sets project library subdirectory.
+  --test=sub    -tsub   Sets project test subdirectory.
+  --skip        -s      Skips tests on startup.
+  
+Unknown options will be completely ignored. You may also set the corresponding 
+environment variables ATTO_HELP, ATTO_PROJECT, ATTO_LIB, ATTO_TEST, ATTO_SKIP
+for the same effect as the command line options.
+
+Most useful here is the --skip option which allows you to skip running all tests 
+on startup. This is invaluable for projects that have many slow-running tests.
+The help message made run.rb reach the 99 lines limit, so it looks like no new 
+features will be implemented in the atto command. :)
+
+To clear out any possible misunderstandings, --project is used to set the 
+project directory, --test and --lib are used to specify *sub*directory names.
+It is currently required that the test dir and the lib dir are subdirectories 
+of the project directory.
+
+For example:
+
+atto --project=~/src/foo --lib=libs --test=tests 
+
+Will run the tests in ~/src/foo/tests for the library files in ~/src/foo/libs.
 
 LICENSE
 

data/Rakefile

@@ -1,11 +1,10 @@
-# Rakefile added by John Mair (banisterfiend)
-
-require 'rake/gempackagetask'
+require 'rubygems'
+require 'rubygems/package_task'
 require 'rake/clean'
 CLEAN.include("pkg/*.gem")
 
 
-ATTO_VERSION = "0.9.0"
+ATTO_VERSION = "0.9.1"
 
 def apply_spec_defaults(s)
 end
@@ -28,7 +27,7 @@ spec = Gem::Specification.new do |s|
     s.executables   = "atto"
 end
 
-Rake::GemPackageTask.new(spec) do |pkg|
+Gem::PackageTask.new(spec) do |pkg|
         pkg.need_zip = false
         pkg.need_tar = false
 end

data/lib/atto.rb

@@ -2,8 +2,10 @@
 module Atto
   # Ansi colors for red/green display after testing.
   autoload :Ansi, 'atto/ansi'
+  # Commandline and environment options
+  autoload :Cop , 'atto/cop'
   # Testing
   autoload :Test, 'atto/test'
   # Autorunning tests
   autoload :Run, 'atto/run'
-end 
+end

data/lib/atto/cop.rb

@@ -0,0 +1,88 @@
+module Atto  
+  # Cop is a module for commandline (and environment) options
+  module Cop
+
+    # Gets an option from the environment. The key will be uppercased, prepended 
+    # by the uppercase basename of $0 without extension and _, and any spaces, 
+    # dashes will be replaced by underscores. Returns the value found, or 
+    # default if not found, and a boolean that indicates if the key was found 
+    # or not found.
+    def get_environment(key, default= nil)
+      base   = File.basename($0).gsub(/\..*\Z/,'').upcase + "_"
+      envkey = base + key.to_s.upcase.gsub('[ \.\-]', '_')
+      res    = ENV[envkey]
+      if res
+        return res, true
+      end
+      return default, false
+    end
+    
+    # Gets a command line argument from ARGV, on condition that it is not
+    # a --command, or preceded by a -c style option. It recognizes -- also.
+    def get_numarg(num, default=nil)
+      numkey = num.to_i
+      skip , aid, index = true, [], 0
+      while index < ARGV.size
+        arg    = ARGV[index]
+        if arg == '--'
+          skip = false
+        elsif (arg[0..1] == '--') && skip
+        elsif arg[0] == '-' && skip
+        else 
+          aid << arg
+        end
+        index += 1
+      end
+      return aid[num], true if aid[num] 
+      return default, false 
+    end
+    
+    # Gets a long --foo=bar style commandline argument from ARGV. The key will
+    # be lowercased, prepended with -- and any spaces, periods or underscores 
+    # will be replaced by dashes. Returns the value found, or default if not 
+    # found, and a boolean that indicates if the key was found or not found.
+    def get_argument(key, default=nil)
+      argkey = "--" + key.to_s.downcase.gsub('[ \.\_]', '-')
+      res    = ARGV.reverse.find{ |arg| arg =~ /\A#{argkey}(\Z|=)/ } 
+      return default, false unless res
+      index  = res.index('=')
+      return true, true unless index
+      return res[index + 1, res.size] , true
+    end
+    
+    # Gets a long -cbar style commandline argument from ARGV. The first 
+    # character of key will be taken, lowercased, and prepended with -
+    # Returns the value found, or default if not found, and 
+    # a boolean that indicates if the key was found or not found.
+    def get_arg(key, default=nil)
+      argkey = "-" + key.to_s[0].downcase
+      res    = ARGV.reverse.find{ |arg| arg =~ /\A#{argkey}/ }
+      return default, false unless res
+      if res.size == 2
+        return true, true
+      end         
+      return res[2, res.size] , true
+    end
+      
+    def get(key, default=nil)
+      if key.respond_to?(:to_int)
+        res, found = get_numarg(key, default)
+        return res if found
+      end   
+      res, found = get_argument(key, default)
+      return res if found  
+      res, found = get_arg(key, default)
+      return res if found 
+      res, found = get_environment(key, default)
+      return res if found
+      return default  
+    end
+    
+    def [](key)
+      return get(key, nil)
+    end
+    
+    extend self
+  end
+end  
+  

data/lib/atto/opt.rb

@@ -0,0 +1,64 @@
+module Atto
+  # A module for handling command line options
+  module Opt
+
+    # Gets an argument in the long form
+    def self.getargument(key, default=nil)
+      keyarg = key.to_s.downcase.gsub(/[_ ]/, '-')
+      arg    = ARGS.select{ |f| f =~ /\A--#{keyarg}(\Z|\=)/  }.last
+      return default, false unless arg
+      ind = arg.index('=')
+      if ind
+        res = arg[ind + 1, arg.size]
+        return res, true unless res.empty?
+        return default, true
+      end
+      return true, true
+    end
+
+    # Gets an argument in the short form
+    def self.getarg(key, default = nil)
+      shortarg = key.to_s[0]
+      arg      = ARGS.index{ |f| f =~ /\A-#{shortarg}\Z)/  }.last
+      return default, false unless arg
+      return ARGS[arg+1] || default, true
+    end
+
+    # Gets an environment variable
+    def self.getenv
+      envarg = key.to_s.upcase.gsub(/[ \-]/, '_')
+      env    = ENV[envarg]
+      return default, false unless env
+      return env || default, true
+    end
+
+    # Gets an option from arguments or from the environment (in that order)
+    def self.get(key, default = nil)
+      keyarg = key.to_s.downcase.gsub(/[_ ]/, '-')
+      arg    = ARGS.select{ |f| f =~ /\A--#{keyarg}(\Z|\=)/  }.last
+      if arg
+        ind = arg.index('=')
+        if ind
+          res = arg[ind + 1, arg.size]
+          return res unless res.empty?
+          return default
+        else
+          return default || true
+        end
+      end
+      # Short arguments
+      shortarg = key.to_s[0]
+      arg      = ARGS.index{ |f| f =~ /\A-#{shortarg}\Z)/  }.last
+
+
+      envarg = key.to_s.upcase.gsub(/[ \-]/, '_')
+      env    = ENV[envarg]
+      return env || default
+    end
+
+    def [](key)
+      return self.get(key)
+    end
+
+  end
+end

data/lib/atto/run.rb

@@ -7,16 +7,8 @@ module Atto
     end
     
     # Find all Ruby all files under the named dir
-    def all_files(name)
-      return Dir.new(name).inject([]) do |res, e| 
-        full   = File.join(name, e)
-        if Dir.exist?(full) &&  e !='.' && e != '..'
-          res += all_files(full)
-        else
-          res << full if full =~ /\.rb\Z/
-        end
-        res
-      end
+    def all_ruby_files(name)
+      Dir["#{name}/**/*.rb"]
     end
     
     # updates the timestamp info for files
@@ -28,7 +20,7 @@ module Atto
       end
     end
     
-    # matches libfiles wih testfiles
+    # matches libfiles with testfiles
     def match_files(libfiles, testfiles)
       return libfiles.inject({}) do |res, libname| 
         testname = libname.dup
@@ -41,11 +33,13 @@ module Atto
     end
     
     # Runs a list of tests
-    def run_tests(list)
+    def run_tests(list, skip = false)
       return list.inject({}) do |results, file|
-        puts("Running tests for #{file}:")
-        res = system("ruby -I #@libdir -I #@testdir #{file}")
-        puts res ? "OK!" : "Failed!"
+        puts(skip ? "Skipping #{file}..." : "Running tests for #{file}:") 
+        unless skip
+          res = system("ruby -I #@libdir -I #@testdir #{file}")
+          puts res ? "OK!" : "Failed!"
+        end 
         results[file] = Time.now
         results
       end
@@ -56,22 +50,34 @@ module Atto
       ran_tests[k] ? ran_tests[k] <= v.mtime : true
     end
     
-    # updates all state info
+    # Updates all state info
     def update_all
-      @libfiles  = all_files(@libdir)
-      @testfiles = all_files(@testdir)
+      @libfiles  = all_ruby_files(@libdir)
+      @testfiles = all_ruby_files(@testdir)
       @matchfiles= match_files(@libfiles, @testfiles)
       @libinfo   = update_info(@libfiles)
       @testinfo  = update_info(@testfiles)
     end
     
+    # Shows help message
+    def help
+      warn "Usage: #{$0} OPTIONS.\nRuns unit tests in the current directory.\n"
+      warn "    --help        -h      Display this help message."
+      warn "    --project=dir -pdir   Sets project directory."
+      warn "    --lib=sub     -lsub   Sets project library subdirectory."
+      warn "    --test=sub    -tsub   Sets project test subdirectory."
+      warn "    --skip        -s      Skips tests on startup.\n"
+      return 0
+    end
+    
     # Main, runs the tests when needed
     def main
-      @projdir  = ARGV[0] || Dir.pwd
-      @libdir   = File.join(@projdir, ARGV[1] || 'lib')
-      @testdir  = File.join(@projdir, ARGV[2] || 'test')
+      return help if Atto::Cop.get(:help)
+      @projdir  = Atto::Cop.get(:project, Dir.pwd)
+      @libdir   = File.join(@projdir, Atto::Cop.get(:lib, 'lib'))
+      @testdir  = File.join(@projdir, Atto::Cop.get(:test, 'test'))
       update_all
-      @ran_tests = run_tests(@testfiles)
+      @ran_tests = run_tests(@testfiles, Atto::Cop.get(:skip, false))
       loop do
         update_all
         torun     = @testinfo.select do |k,v| 

data/lib/atto/test.rb

@@ -43,7 +43,7 @@ module Atto
       begin
         Timeout.timeout(delay) do res = block.call ; end
       rescue 
-        raised = $!
+        raised = $!.dup
       end
       return res, raised 
    end  

data/test/atto/test_cop.rb

@@ -0,0 +1,99 @@
+require 'atto/test'
+include Atto::Test
+require 'atto'
+
+assert "Cop is defined" do
+   Atto::Cop
+end
+
+# Set up some fake environent and argument options
+p $0
+ENV['TEST_COP_FOO'] = 'bar'
+ENV['TEST_COP_BAZ'] = ""
+ARGV << '--foo=quux'
+ARGV << 'file1'
+ARGV << '--foo=bar'
+ARGV << '-fquux'
+ARGV << '-fbaz'
+ARGV << '--bar'
+ARGV << '-b'
+ARGV << 'file2'
+ARGV << '--'
+ARGV << '--file3'
+
+
+assert "Cop is defined" do
+   Atto::Cop
+end
+
+assert "Getting options from environment works" do
+   res, found = Atto::Cop.get_environment(:baz)
+   found
+end
+
+assert "Getting options from environment works" do
+   res, found = Atto::Cop.get_environment(:foo)
+   found && res == 'bar'
+end
+
+assert "Getting long command line arguments works" do
+   res, found = Atto::Cop.get_argument(:foo)
+   found && res == 'bar'
+end
+
+assert "Getting short command line arguments works" do
+   res, found = Atto::Cop.get_arg(:foo)
+   found && res == 'baz'
+end
+
+assert "Indexed command line file arguments works" do
+   res, found = Atto::Cop.get_numarg(0)
+   found && res == 'file1'
+end
+
+assert "Indexed command line file arguments works" do
+   res, found = Atto::Cop.get_numarg(1)
+   found && res == 'file2'
+end
+
+assert "Indexed command line file arguments works" do
+   res, found = Atto::Cop.get_numarg(2)
+   found && res == '--file3'
+end
+
+assert "Indexed command line file arguments works" do
+   res, found = Atto::Cop.get_numarg(3)
+   (!found) && res.nil?
+end
+
+
+assert "Getting generic command line arguments works" do 
+   res = Atto::Cop.get(2)
+   res == '--file3'
+end
+
+assert "Getting generic command line arguments works" do 
+   res = Atto::Cop.get(1)   
+   res == 'file2'
+end
+
+assert "Getting generic command line arguments works" do 
+   res = Atto::Cop.get(0)   
+   res == 'file1'
+end
+
+assert "Getting generic command line arguments works" do 
+   res = Atto::Cop.get(:foo)
+   res == 'bar'
+end
+
+assert "Getting generic command line arguments works" do 
+   res = Atto::Cop.get(:bar)
+   res == true
+end
+
+assert "Defaults work" do
+   Atto::Cop.get(:kazz, 'default') == 'default' 
+end
+
+# We end here before the 100 line limit! :)

data/test/atto/test_test.rb

@@ -1,10 +1,10 @@
 require 'atto'
 include Atto::Test
 
-assert "Atto is defined"                        do Atto                      end 
+assert "Atto is defined"                        do Atto                      end
 assert "Atto::Test is defined"                  do Atto::Test                end
 assert "Success can be detected"                do true                      end
-assert "Works with nexted asserts" do
+assert "Works with nested asserts" do
   assert "This is a nested assert"  do true end
 end
 
@@ -20,3 +20,5 @@ assert "Atto::Test#describe_tests is defined"   do Atto::Test.describe_tests end
 
 
 
+
+

metadata

@@ -1,73 +1,58 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: atto
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 9
-  - 0
-  version: 0.9.0
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Beoran
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-07 00:00:00 +02:00
-default_executable: 
+date: 2011-06-16 00:00:00.000000000Z
 dependencies: []
-
-description: "An ultra-tiny self-contained testing framework. "
+description: ! 'An ultra-tiny self-contained testing framework. '
 email: beoran@rubyforge.org
-executables: 
+executables:
 - atto
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - Rakefile
 - README
 - lib/atto.rb
 - lib/atto/ansi.rb
 - lib/atto/run.rb
+- lib/atto/cop.rb
 - lib/atto/test.rb
+- lib/atto/opt.rb
 - test/test_atto.rb
+- test/atto/test_cop.rb
 - test/atto/test_ansi.rb
 - test/atto/test_test.rb
 - bin/atto
-has_rdoc: true
 homepage: https://github.com/beoran/atto
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: An ultra-tiny self-contained testing framework.
 test_files: []
-