iba 0.0.1

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/LICENSE

@@ -0,0 +1,16 @@
+Copyright (c) 2010--2011 Matijs van Zuijlen
+
+Iba is free software; you can redistribute it and/or modify it under the
+terms of the GNU Lesser General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.
+
+This library is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
+more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this library. If not, see <http://www.gnu.org/licenses/>.
+
+

data/README.rdoc

@@ -0,0 +1,59 @@
+= Iba
+
+by Matijs van Zuijlen
+
+== Description
+
+Introspective Block Assertions
+
+== Features/Problems
+
+* Write assertions as a (one-expression) block
+* Assertion message deconstructs the block's expression.
+* Not done yet.
+
+== Synopsis
+
+  # In your test helper:
+  require 'iba'
+  class Test::Unit::TestCase
+    include Iba::BlockAssertion
+  end
+
+  # In your test:
+  foo = 24
+  assert { foo == 23 } # => "(foo == 23) is false
+                       #     foo is 24."
+
+== Details
+
+Iba provides an assert method that takes a block. If the block returns
+false, it will try to construct an insightful error message based on the
+contents of the block.
+
+Iba's functionality is inspired by Wrong[1], but doesn't use an external
+Ruby parser. This means it will work in contexts where Wrong does not
+(generated code, on the command line). It also means there are more limits
+to the contents of the block.
+
+Current limits:
+
+* Only single-expression blocks are supported.
+* The expression must start with a method-like identifier (like 'foo', but
+  not 'Foo' or '23'). In practice, this produces quite natural results.
+
+Iba's implementation is inspired by Arlo[2], a generic combinator library
+for Python.
+
+== Install
+
+  gem install iba
+
+== Links
+
+[1] https://github.com/sconover/wrong
+[2] http://withoutane.com/rants/2008/12/arlo-generic-combinators-for-python
+
+== Licence
+
+See the LICENSE file.

data/Rakefile

@@ -0,0 +1,3 @@
+load 'tasks/setup.rb'
+
+task :default => 'test:run'

data/lib/iba.rb

@@ -0,0 +1,182 @@
+module Iba
+
+class Combinator
+  def initialize &blk
+    @block = blk
+  end
+
+  def call
+    @block.call
+  end
+
+  def to_s
+    expression._to_s
+  end
+
+  def expression
+    @expression ||= EmptyExpression.new._parse(&@block)
+  end
+
+  def analyse
+    if expression._to_s == ""
+      "empty block"
+    else
+      str = "#{self.to_s} is #{self.call.inspect}"
+      if expression.class == MethodCallExpression and expression._method == :==
+	b = @block.binding
+	lft = expression._reciever
+	rgt = expression._args.first
+	exprs = [lft, rgt].map {|e| display_subexpression e}.compact
+	str << "\n"
+	str << exprs.join(", ")
+      end
+      str
+    end
+  end
+
+  private
+
+  def display_subexpression expr
+    if expr.class == LiteralExpression
+      nil
+    else
+      str = expr._to_s
+      "#{str} is #{eval str, @block.binding}"
+    end
+  end
+
+end
+
+class EmptyExpression
+  def method_missing method, *args
+    return MethodCallExpression.new self, method, args
+  end
+
+  def _parse &blk
+    b = blk.binding
+
+    vars = eval "local_variables", b
+    vars.each do |v|
+      next if v =~ /^_/
+      eval "_#{v} = #{v}", b
+      eval "#{v} = Iba::MethodCallExpression.new(Iba::EmptyExpression.new, :#{v}, [])", b
+    end
+
+    result = self.instance_eval(&blk)
+    unless result.class == MethodCallExpression
+      result = LiteralExpression.new(result)
+    end
+
+    vars.each do |v|
+      next if v =~ /^_/
+      eval "#{v} = _#{v}", b
+    end
+
+    result
+  end
+
+  def _to_s
+    ""
+  end
+end
+
+class LiteralExpression
+  def initialize val
+    @value = val
+  end
+
+  def _to_s
+    @value.to_s
+  end
+end
+
+class MethodCallExpression
+  OPERATORS = [:+]
+  def initialize reciever, methodname, args
+    @reciever = reciever
+    @method = methodname
+    @args = args.map {|a| _wrap(a)}
+  end
+
+  def _method
+    @method
+  end
+
+  def _reciever
+    @reciever
+  end
+
+  def _args
+    @args
+  end
+
+  def _to_s
+    rcv = @reciever._to_s
+    args = @args.map {|a| a.respond_to?(:_to_s) ? a._to_s : a.to_s }
+
+    if @method == :[]
+      "#{rcv}[#{args[0]}]"
+    elsif method_is_operator?
+      case @args.length
+      when 0
+	"#{@method.to_s.sub(/@$/, '')}#{rcv}"
+      when 1
+	"(#{rcv} #{@method} #{args.first})"
+      else
+	raise NotImplementedError
+      end
+    else
+      str = rcv == "" ? "" : "#{rcv}."
+      str << @method.to_s
+      unless @args.empty?
+	str << "(#{args.join(', ')})"
+      end
+      str
+    end
+  end
+
+  def method_missing method, *args
+    super if method.to_s =~ /^_/
+    return MethodCallExpression.new self, method, args
+  end
+
+  def method_is_operator?
+    @method.to_s !~ /^[a-z]/
+  end
+
+  def to_s
+    method_missing :to_s
+  end
+
+  def == other
+    method_missing :==, other
+  end
+
+  private
+
+  def _wrap arg
+    if arg.class == MethodCallExpression
+      arg
+    else
+      LiteralExpression.new arg
+    end
+  end
+end
+
+module BlockAssertion
+  def assert *args
+    if block_given?
+      if yield
+	assert_block("true") { true }
+      else
+        msg = args.empty? ? "" : args.first
+	ana = Combinator.new(&Proc.new).analyse
+	assert_block(build_message(msg, "#{ana}.")) { false }
+      end
+    else
+      super
+    end
+  end
+end
+
+end

data/tasks/notes.rake

@@ -0,0 +1,122 @@
+# The following code is based on Bones 2.5.1
+#
+
+module Bones
+
+# A helper class used to find and display any annotations in a collection of
+# project files.
+#
+class AnnotationExtractor
+
+  class Annotation < Struct.new(:line, :tag, :text)
+    # Returns a string representation of the annotation. If the
+    # <tt>:tag</tt> parameter is given as +true+, then the annotation tag
+    # will be included in the string.
+    #
+    def to_s( opts = {} )
+      s = "[%3d] " % line
+      s << "[#{tag}] " if opts[:tag]
+      s << text
+    end
+  end
+
+  # Enumerate all the annoations for the given _project_ and _tag_. This
+  # will search for all athe annotations and display them on standard
+  # output.
+  #
+  def self.enumerate tag, id = nil, opts = {}
+    extractor = new(tag, id)
+    extractor.display(extractor.find, opts)
+  end
+
+  attr_reader :tag, :id
+
+  # Creates a new annotation extractor configured to use the _project_ open
+  # strcut and to search for the given _tag_ (which can be more than one tag
+  # via a regular expression 'or' operation -- i.e. THIS|THAT|OTHER)
+  #
+  def initialize tag, id
+    @tag = tag
+    @id = @id_rgxp = nil
+
+    unless id.nil? or id.empty?
+      @id = id
+      @id_rgxp = Regexp.new(Regexp.escape(id), Regexp::IGNORECASE)
+    end
+  end
+
+  # Iterate over all the files in the project and extract annotations from
+  # the those files. Returns the results as a hash for display.
+  #
+  def find
+    results = {}
+    rgxp = %r/(#{tag}):?\s*(.*?)(?:\s*(?:-?%>|\*+\/))?$/o
+
+    files = Dir.glob("lib/**/*.rb")
+    files += Dir.glob("test/**/*.rb")
+    files += Dir.glob("bin/*")
+    files.each do |fn|
+      results.update(extract_annotations_from(fn, rgxp))
+    end
+
+    results
+  end
+
+  # Extract any annotations from the given _file_ using the regular
+  # expression _pattern_ provided.
+  #
+  def extract_annotations_from( file, pattern )
+    lineno = 0
+    result = File.readlines(file).inject([]) do |list, line|
+      lineno += 1
+      next list unless m = pattern.match(line)
+      next list << Annotation.new(lineno, m[1], m[2]) unless id
+
+      text = m[2]
+      if text =~ @id_rgxp
+        list << Annotation.new(lineno, m[1], text)
+      end
+      list
+    end
+    result.empty? ? {} : { file => result }
+  end
+
+  # Print the results of the annotation extraction to the screen. If the
+  # <tt>:tags</tt> option is set to +true+, then the annotation tag will be
+  # displayed.
+  #
+  def display( results, opts = {} )
+    results.keys.sort.each do |file|
+      puts "#{file}:"
+      results[file].each do |note|
+        puts "  * #{note.to_s(opts)}"
+      end
+      puts
+    end
+  end
+
+end  # class AnnotationExtractor
+end  # module Bones
+
+note_tags = ["TODO", "FIXME", "OPTIMIZE"]
+
+desc "Enumerate all annotations"
+task :notes do |t|
+  id = if t.application.top_level_tasks.length > 1
+    t.application.top_level_tasks.slice!(1..-1).join(' ')
+  end
+  Bones::AnnotationExtractor.enumerate(
+      note_tags.join('|'), id, :tag => true)
+end
+
+namespace :notes do
+  note_tags.each do |tag|
+    desc "Enumerate all #{tag} annotations"
+    task tag.downcase.to_sym do |t|
+      id = if t.application.top_level_tasks.length > 1
+        t.application.top_level_tasks.slice!(1..-1).join(' ')
+      end
+      Bones::AnnotationExtractor.enumerate(tag, id)
+    end
+  end
+end