sherlock 0.1.1 → 0.1.2

data/lib/core_ext.rb

@@ -1,42 +1,42 @@
-
-class ::Object
-  #:call-seq:
-  #   obj.full?
-  #   obj.full? { |f| ... }
-  #
-  # Returns wheter or not the given obj is not blank?.
-  # If a block is given and the obj is full?, the obj is yielded to that block.
-  # 
-  #   salary = nil
-  #   salary.full? # => nil
-  #   salary.full? { |s| "#{s} $" } # => nil
-  #   salary = 100
-  #   salary.full? { |s| "#{s} $" } # => "100 $"
-  # 
-  # With ActiveSupport's implementation of Symbol#to_proc it is possible to write:
-  # 
-  #   current_user.full?(&:name) # => "Dave"
-  def full?
-    f = blank? ? nil : self
-    if block_given? and f
-      yield f
-    else
-      f
-    end
-  end
-end
-
-class ::Symbol
-  # Turns the symbol into a simple proc, which is especially useful for enumerations. Examples:
-  #
-  #   # The same as people.collect { |p| p.name }
-  #   people.collect(&:name)
-  #
-  #   # The same as people.select { |p| p.manager? }.collect { |p| p.salary }
-  #   people.select(&:manager?).collect(&:salary)
-  #
-  # (borrowed from ActiveSupport)
-  def to_proc
-    Proc.new { |*args| args.shift.__send__(self, *args) }
-  end
-end
+
+class ::Object
+  #:call-seq:
+  #   obj.full?
+  #   obj.full? { |f| ... }
+  #
+  # Returns wheter or not the given obj is not blank?.
+  # If a block is given and the obj is full?, the obj is yielded to that block.
+  # 
+  #   salary = nil
+  #   salary.full? # => nil
+  #   salary.full? { |s| "#{s} $" } # => nil
+  #   salary = 100
+  #   salary.full? { |s| "#{s} $" } # => "100 $"
+  # 
+  # With ActiveSupport's implementation of Symbol#to_proc it is possible to write:
+  # 
+  #   current_user.full?(&:name) # => "Dave"
+  def full?
+    f = blank? ? nil : self
+    if block_given? and f
+      yield f
+    else
+      f
+    end
+  end
+end
+
+class ::Symbol
+  # Turns the symbol into a simple proc, which is especially useful for enumerations. Examples:
+  #
+  #   # The same as people.collect { |p| p.name }
+  #   people.collect(&:name)
+  #
+  #   # The same as people.select { |p| p.manager? }.collect { |p| p.salary }
+  #   people.select(&:manager?).collect(&:salary)
+  #
+  # (borrowed from ActiveSupport)
+  def to_proc
+    Proc.new { |*args| args.shift.__send__(self, *args) }
+  end unless method_defined?(:to_proc)
+end

data/lib/latex.rb

@@ -1,45 +1,56 @@
-#!/usr/bin/env ruby -wKU
-
-module Sherlock
-  module LaTex
-    class << self
-      def included(base)
-        base.__send__(:include, InstanceMethods)
-        Sherlock::Collection::Files.__send__(:include, Collection::Files::InstanceMethods)
-      end
-    end
-    
-    module InstanceMethods
-      def tex_files(opts = {})
-        investigate('**/*.tex', opts)
-      end
-    end
-    
-    module Collection
-      module Files
-        module InstanceMethods
-          def collect_macros(pattern)
-            collect(/\\(#{pattern})(\{([^\}]+)\})*/)
-          end
-          alias macros collect_macros
-      
-          def inputs(opts = {})
-            macros(:input).filter(opts)
-          end
-      
-          def tagged(with_tag)
-            tag_prefix = "%%!!"
-            arr = [with_tag].flatten.map { |tag| "#{tag_prefix} #{tag}" }
-            containing(arr)
-          end
-    
-          def not_tagged(with_tag)
-            tag_prefix = "%%!!"
-            arr = [with_tag].flatten.map { |tag| "#{tag_prefix} #{tag}" }
-            not_containing(arr)
-          end
-        end
-      end
-    end
-  end
+#!/usr/bin/env ruby -wKU
+
+# this is still very experimental
+#
+# I want to be able to perform large LaTeX document analysis in an easy readable way
+# e.g. 
+#   Sherlock[:tex].inputs(:except => 'generated') 
+#     # => all lines with input directives, except the ones containing 'generated'
+#   Sherlock[:tex].macros(:emph)
+#     # => all lines containing the \emph{} macro
+#
+#  Maybe even environments could be analysed (e.g. figure and tabular)
+#
+module Sherlock
+  module LaTex #:nodoc:
+    class << self
+      def included(base)
+        base.__send__(:include, InstanceMethods)
+        Sherlock::Collection::Files.__send__(:include, Collection::Files::InstanceMethods)
+      end
+    end
+    
+    module InstanceMethods
+      def tex_files(opts = {})
+        investigate('**/*.tex', opts)
+      end
+    end
+    
+    module Collection
+      module Files
+        module InstanceMethods
+          def collect_macros(pattern)
+            collect(/\\(#{pattern})(\{([^\}]+)\})*/)
+          end
+          alias macros collect_macros
+      
+          def inputs(opts = {})
+            macros(:input).filter(opts)
+          end
+      
+          def tagged(with_tag)
+            tag_prefix = "%%!!"
+            arr = [with_tag].flatten.map { |tag| "#{tag_prefix} #{tag}" }
+            containing(arr)
+          end
+    
+          def not_tagged(with_tag)
+            tag_prefix = "%%!!"
+            arr = [with_tag].flatten.map { |tag| "#{tag_prefix} #{tag}" }
+            not_containing(arr)
+          end
+        end
+      end
+    end
+  end
 end

data/lib/sherlock.rb

@@ -1,33 +1,24 @@
-#!/usr/bin/env ruby -wKU
-
-# TODO: Output-Methoden für File- und Line-Collections, Tabellen, success & failure inkl. optionaler Colorierung.
-# TODO: vielleicht LaTex shortcuts à la tex_files.inputs(:only => 'generated/schema')
-
-%w(collection core_ext latex).each do |_module|
-  require File.join(File.dirname(__FILE__), _module)
-end
-
-module Sherlock
-  module VERSION #:nodoc:
-    MAJOR = 0
-    MINOR = 1
-    BUILD = 1
-
-    STRING = [MAJOR, MINOR, BUILD].join('.').freeze
-  end
-  
-  module InstanceMethods
-    def collect_files_matching(*args)
-      Sherlock::Collection::Files.new(*args)
-    end
-    alias investigate collect_files_matching
-  end
-  
-  class << self
-    def included(base)
-      base.__send__(:include, InstanceMethods)
-    end
-    include InstanceMethods
-    alias [] collect_files_matching
-  end
+#!/usr/bin/env ruby -wKU
+
+# TODO: Output-Methoden für File- und Line-Collections, Tabellen, success & failure inkl. optionaler Colorierung.
+
+%w(collection core_ext latex version).each do |_module|
+  require File.join(File.dirname(__FILE__), _module)
+end
+
+module Sherlock
+  module InstanceMethods
+    def collect_files_matching(*args)
+      Sherlock::Collection::Files.new(*args)
+    end
+    alias investigate collect_files_matching
+  end
+  
+  class << self
+    def included(base)
+      base.__send__(:include, InstanceMethods)
+    end
+    include InstanceMethods
+    alias [] collect_files_matching
+  end
 end

data/lib/version.rb

@@ -0,0 +1,10 @@
+
+module Sherlock
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    BUILD = 2
+
+    STRING = [MAJOR, MINOR, BUILD].join('.').freeze
+  end
+end

data/spec/collection/base_spec.rb

@@ -1,142 +1,140 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-
-describe Sherlock::Collection::Base do
-  def new_collection(arr = nil, opts = {})
-    arr ||= %w(eins zwei drei vier fünf)
-    Sherlock::Collection::Base.new(arr, opts)
-  end
-  
-  def filter_arguments
-    [
-      [['ei']],
-      [[/ei/]],
-      [['sieben', 'sechs', 'fünf', 'vier']],
-      [[/ei/, 'fünf'], {:only => /ei$/, :except => 'zwei'}],
-      [{:only => /ei$/, :except => 'zwei'}],
-    ]
-  end
-  
-  describe "#initialize" do
-    it "creates an empty collection without arguments" do
-      empty_collection = Sherlock::Collection::Base.new
-      empty_collection.should be_empty
-    end
-    it "creates a full collection for a given array" do
-      collection = new_collection([:foo, :bar])
-      collection.should_not be_empty
-    end
-    it "creates a full collection for a given collection" do
-      collection = new_collection(new_collection)
-      collection.should_not be_empty
-    end
-  end
-  
-  describe "#first" do
-    it "should give a collection with the first matching element for a string" do
-      collection = new_collection.first('ei')
-      collection.should == new_collection(%w(eins))
-    end
-    it "should give a collection with the first matching element for a regexp" do
-      collection = new_collection.first(/ei/)
-      collection.should == new_collection(%w(eins))
-    end
-    it "should give a collection with the first matching element for an array of strings" do
-      collection = new_collection.first(%w(sieben sechs fünf))
-      collection.should == new_collection(%w(fünf))
-    end
-    it "should give a collection with the first matching element for an array of regexps" do
-      collection = new_collection.first([/sieben/, /sechs/, /fünf/])
-      collection.should == new_collection(%w(fünf))
-    end
-    it "should give a collection with the first matching element for an array of strings and regexps" do
-      collection = new_collection.first([/sieben/, /sechs/, 'fünf'])
-      collection.should == new_collection(%w(fünf))
-    end
-  end
-  
-  describe "#filter" do
-    # without real arguments
-    it "should give the same collection without arguments" do
-      collection = new_collection.filter
-      collection.should == new_collection
-    end
-    it "should give the same collection with empty arguments" do
-      collection = new_collection.filter([], {})
-      collection.should == new_collection
-    end
-    
-    # without options
-    it "should give a collection with the matching elements for a string" do
-      collection = new_collection.filter('ei')
-      collection.should == new_collection(%w(eins zwei drei))
-    end
-    it "should give a collection with the matching elements for a regexp" do
-      collection = new_collection.filter(/ei/)
-      collection.should == new_collection(%w(eins zwei drei))
-    end
-    it "should give a collection with the matching elements for an array of strings" do
-      collection = new_collection.filter(%w(sieben sechs fünf vier))
-      collection.should == new_collection(%w(vier fünf))
-    end
-    it "should give a collection with the matching elements for an array of regexps" do
-      collection = new_collection.filter([/ei/, /sechs/, /fünf/])
-      collection.should == new_collection(%w(eins zwei drei fünf))
-    end
-    it "should give a collection with the matching elements for an array of strings and regexps" do
-      collection = new_collection.filter([/ei/, 'fünf'])
-      collection.should == new_collection(%w(eins zwei drei fünf))
-    end
-    
-    # with options
-    it "should accept options as only argument" do
-      collection = new_collection.filter(:except => 'zwei')
-      collection.should == new_collection(%w(eins drei vier fünf))
-    end
-    it "should accept options as only argument (chained)" do
-      collection = new_collection.filter([/ei/, 'fünf']).filter(:except => 'zwei')
-      collection.should == new_collection(%w(eins drei fünf))
-    end
-    it "should filter results with :except option" do
-      collection = new_collection.filter([/ei/, 'fünf'], :except => 'zwei')
-      collection.should == new_collection(%w(eins drei fünf))
-    end
-    it "should filter results with :only option" do
-      collection = new_collection.filter([/ei/, 'fünf'], :only => /ei$/)
-      collection.should == new_collection(%w(zwei drei))
-    end
-    it "should filter results with :only option first and :except option afterwards" do
-      collection = new_collection.filter([/ei/, 'fünf'], :only => /ei$/, :except => 'zwei')
-      collection.should == new_collection(%w(drei))
-    end
-  end
-  
-  describe "#[]" do
-    it "should be a shortcut for 'filter'" do
-      filter_arguments.each do |args|
-        new_collection[*args].should == new_collection.filter(*args)
-      end
-    end
-  end
-  
-  describe "#+" do
-    it "should combine two collections" do
-      collection1 = new_collection(nil, :only => 'eins')
-      collection2 = new_collection(nil, :only => 'zwei')
-      result = collection1 + collection2
-      result.should == new_collection(%w(eins zwei))
-    end
-  end
-  
-  describe "#-" do
-    it "should reduce two collections" do
-      collection1 = new_collection(nil, :only => /ei/)
-      collection2 = new_collection(nil, :only => 'zwei')
-      result = collection1 - collection2
-      result.should == new_collection(%w(eins drei))
-    end
-  end
-  
-  # TODO: tests für #& und #| schreiben
-  # TODO: testen, dass filter(), und first() und containing und so alle String, Regexp sowie [String/Regexp] nehmen
-  
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Sherlock::Collection::Base do
+  def new_collection(arr = nil, opts = {})
+    arr ||= %w(eins zwei drei vier fünf)
+    Sherlock::Collection::Base.new(arr, opts)
+  end
+  
+  def filter_arguments
+    [
+      [['ei']],
+      [[/ei/]],
+      [['sieben', 'sechs', 'fünf', 'vier']],
+      [[/ei/, 'fünf'], {:only => /ei$/, :except => 'zwei'}],
+      [{:only => /ei$/, :except => 'zwei'}],
+    ]
+  end
+  
+  describe "#initialize" do
+    it "creates an empty collection without arguments" do
+      empty_collection = Sherlock::Collection::Base.new
+      empty_collection.should be_empty
+    end
+    it "creates a full collection for a given array" do
+      collection = new_collection([:foo, :bar])
+      collection.should_not be_empty
+    end
+    it "creates a full collection for a given collection" do
+      collection = new_collection(new_collection)
+      collection.should_not be_empty
+    end
+  end
+  
+  describe "#first" do
+    it "should give a collection with the first matching element for a string" do
+      collection = new_collection.first('ei')
+      collection.should == new_collection(%w(eins))
+    end
+    it "should give a collection with the first matching element for a regexp" do
+      collection = new_collection.first(/ei/)
+      collection.should == new_collection(%w(eins))
+    end
+    it "should give a collection with the first matching element for an array of strings" do
+      collection = new_collection.first(%w(sieben sechs fünf))
+      collection.should == new_collection(%w(fünf))
+    end
+    it "should give a collection with the first matching element for an array of regexps" do
+      collection = new_collection.first([/sieben/, /sechs/, /fünf/])
+      collection.should == new_collection(%w(fünf))
+    end
+    it "should give a collection with the first matching element for an array of strings and regexps" do
+      collection = new_collection.first([/sieben/, /sechs/, 'fünf'])
+      collection.should == new_collection(%w(fünf))
+    end
+  end
+  
+  describe "#filter" do
+    # without real arguments
+    it "should give the same collection without arguments" do
+      collection = new_collection.filter
+      collection.should == new_collection
+    end
+    it "should give the same collection with empty arguments" do
+      collection = new_collection.filter([], {})
+      collection.should == new_collection
+    end
+    
+    # without options
+    it "should give a collection with the matching elements for a string" do
+      collection = new_collection.filter('ei')
+      collection.should == new_collection(%w(eins zwei drei))
+    end
+    it "should give a collection with the matching elements for a regexp" do
+      collection = new_collection.filter(/ei/)
+      collection.should == new_collection(%w(eins zwei drei))
+    end
+    it "should give a collection with the matching elements for an array of strings" do
+      collection = new_collection.filter(%w(sieben sechs fünf vier))
+      collection.should == new_collection(%w(vier fünf))
+    end
+    it "should give a collection with the matching elements for an array of regexps" do
+      collection = new_collection.filter([/ei/, /sechs/, /fünf/])
+      collection.should == new_collection(%w(eins zwei drei fünf))
+    end
+    it "should give a collection with the matching elements for an array of strings and regexps" do
+      collection = new_collection.filter([/ei/, 'fünf'])
+      collection.should == new_collection(%w(eins zwei drei fünf))
+    end
+    
+    # with options
+    it "should accept options as only argument" do
+      collection = new_collection.filter(:except => 'zwei')
+      collection.should == new_collection(%w(eins drei vier fünf))
+    end
+    it "should accept options as only argument (chained)" do
+      collection = new_collection.filter([/ei/, 'fünf']).filter(:except => 'zwei')
+      collection.should == new_collection(%w(eins drei fünf))
+    end
+    it "should filter results with :except option" do
+      collection = new_collection.filter([/ei/, 'fünf'], :except => 'zwei')
+      collection.should == new_collection(%w(eins drei fünf))
+    end
+    it "should filter results with :only option" do
+      collection = new_collection.filter([/ei/, 'fünf'], :only => /ei$/)
+      collection.should == new_collection(%w(zwei drei))
+    end
+    it "should filter results with :only option first and :except option afterwards" do
+      collection = new_collection.filter([/ei/, 'fünf'], :only => /ei$/, :except => 'zwei')
+      collection.should == new_collection(%w(drei))
+    end
+  end
+  
+  describe "#[]" do
+    it "should be a shortcut for 'filter'" do
+      filter_arguments.each do |args|
+        new_collection[*args].should == new_collection.filter(*args)
+      end
+    end
+  end
+  
+  describe "#+" do
+    it "should combine two collections" do
+      collection1 = new_collection(nil, :only => 'eins')
+      collection2 = new_collection(nil, :only => 'zwei')
+      result = collection1 + collection2
+      result.should == new_collection(%w(eins zwei))
+    end
+  end
+  
+  describe "#-" do
+    it "should reduce two collections" do
+      collection1 = new_collection(nil, :only => /ei/)
+      collection2 = new_collection(nil, :only => 'zwei')
+      result = collection1 - collection2
+      result.should == new_collection(%w(eins drei))
+    end
+  end
+  
+  # TODO: tests for #& und #|
 end