bibtex-ruby 2.0.2 → 2.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bibtex-ruby (2.0.1)
+    bibtex-ruby (2.0.2)
       latex-decode (>= 0.0.6)
       multi_json (~> 1.0)
 
@@ -27,7 +27,7 @@ GEM
     gnuplot (2.3.6)
     json (1.5.4)
     json (1.5.4-java)
-    latex-decode (0.0.9)
+    latex-decode (0.0.10)
       unicode (~> 0.4)
     linecache (0.46)
       rbx-require-relative (> 0.0.4)

data/History.txt

@@ -1,3 +1,8 @@
+2.0.3 / 2011-12-13
+==================
+
+* Added new entry wildcard "@*" to queries (kudos to @vanto)
+
 2.0.2 / 2011-11-25
 ==================
 

data/README.md

@@ -58,38 +58,19 @@ one of [many different styles](https://github.com/citation-style-language/styles
       Guide. Raleigh, North Carolina: The Pragmatic Bookshelf, 2009."
 
 
-Installation
-------------
-
-If you just want to use it:
-
-    $ [sudo] gem install bibtex-ruby
-
-If you want to work with the sources:
-
-    $ git clone http://github.com/inukshuk/bibtex-ruby.git
-    $ cd bibtex-ruby
-    $ [sudo] bundle install
-    $ rake racc
-    $ rake rdoc
-    $ rake features
-    $ rake test
-
-For extra credit, fork the
-[project on GitHub](http://github.com/inukshuk/bibtex-ruby.git).
-
 
 Requirements
 ------------
 
-* The parser generator [racc](http://i.loveruby.net/en/projects/racc/) is
-  required to generate the BibTeX parser and the name parser.
-
-The BibTeX-Ruby gem has been tested on Ruby versions 1.8.7 and 1.9.2; it has
+The BibTeX-Ruby gem has been tested on Ruby 1.8 and 1.9; it has
 been confirmed to work with REE, JRuby, and Rubinius;
 however, there have been some [issues](https://github.com/inukshuk/bibtex-ruby/issues)
 with MacRuby implementations.
 
+The parser generator [racc](http://i.loveruby.net/en/projects/racc/) is
+required to generate the BibTeX parser and the name parser; you do not need
+to install it to use the bibtex-ruby gem.
+
 
 
 Usage
@@ -453,18 +434,31 @@ You can check out a copy of the latest code using Git:
 
 If you've found a bug or have a question, please open an issue on the
 [BibTeX-Ruby issue tracker](http://github.com/inukshuk/bibtex-ruby/issues).
-Or, for extra credit, clone the BibTeX-Ruby repository, write a failing
+For extra credit, clone the BibTeX-Ruby repository, write a failing
 example, or cucumber feature, fix the bug and submit a pull request (for
 useful examples, take a look at the cucumber features in the
 [features/issues/](https://github.com/inukshuk/bibtex-ruby/blob/master/features/issues)
 directory).
 
+To run the tests and cucumber examples execute these commands (from within
+the bibtex-ruby directory):
+
+    $ [sudo] gem install bundler
+    $ [sudo] bundle install
+    $ bundle exec cucumber
+    $ bundle exec rake test
+
+To execute the test suite continuously while you're working run:
+
+    $ bundle exec watchr auto.watchr
+
+
 
 Credits
 -------
 
-The BibTeX-Ruby package was written by [Sylvester Keil](http://sylvester.keil.or.at/);
-kudos and thanks to all [contributors](https://github.com/inukshuk/bibtex-ruby/contributors)!
+Copyright 2011 [Sylvester Keil](http://sylvester.keil.or.at/).
 
-BibTeX-Ruby is distributed under the terms and conditions of the GPL. See
+BibTeX-Ruby was written by many awesome [contributors](https://github.com/inukshuk/bibtex-ruby/contributors)
+and is distributed under the terms and conditions of the GNU GPL. See
 LICENSE for details.

data/features/query.feature

@@ -53,4 +53,10 @@ Feature: Searching in BibTeX bibliographies
 		Then there should be exactly 0 matches
 		When I search for "@book, @article"
 		Then there should be exactly 3 matches
+		When I search for "@entry"
+		Then there should be exactly 3 matches
+		When I search for "@*"
+		Then there should be exactly 3 matches
+		When I search for "@*[year=2007]"
+		Then there should be exactly 1 match
 		

data/lib/bibtex/bibliography.rb

@@ -335,33 +335,52 @@ module BibTeX
       root = REXML::Element.new('bibtex:file')
       root.add_namespace('bibtex', 'http://bibtexml.sf.net/')
       
-      each { |e| root.add_element(e.to_xml(options)) }
+      each { |e| root.add_element(e.to_xml(options)) if e.is_a?(Entry) }
 
       xml.add_element(root)
       xml
     end
 
+    # call-seq:
+    #   bib.query()          #=> returns all elements
+    #   bib.query('@book')   #=> returns all books
+    #   bib.query('@entry')  #=> returns all entries (books, articles etc.)
+    #   bib.query('@*')      #=> same as above
+    #   bib.query(:first, '@book, @article')
+    #     #=> returns the first book or article or nil
+    #   bib.query('@book[year=2011], @article)
+    #     #=> returns all books published in 2011 and all articles
+    #   bib.query('@book, @article) { |o| o.year == '2011' }
+    #     #=> returns all books and articles published in 2011
+    #   bib.query('@book[year=2011], @article[year=2011])
+    #     #=> same as above without using a block
+    #
     # Returns objects in the Bibliography which match the given selector and,
     # optionally, the conditions specified in the given block.
     #
-    # call-seq:
-    # bib.query()        #=> returns all objects
-    # bib.query(:all)    #=> returns all objects
-    # bib.query(:first)  #=> returns the first object
-    # bib.query('@book') #=> returns all books
-    # bib.query(:first, '@book, @article')
-    # #=> returns the first book or article
-    # bib.query('@book[year=2011], @article)
-    # #=> returns all books published in 2011 and all articles
-    # bib.query('@book, @article) { |o| o.year == '2011' }
-    # #=> returns all books and articles published in 2011
-    # bib.query('@book[year=2011], @article[year=2011])
-    # #=> same as above without using a block
+    # Queries offer syntactic sugar for common enumerator invocations:
+    #
+    #     >> bib.query(:all, '@book')
+    #     => same as bib.select { |b| b.has_type?(:book) }
+    #     >> bib.query('@book')
+    #     => same as above
+    #     >> bib.query(:first, '@book')
+    #     => same as bib.detect { |b| b.has_type?(:book) }
+    #     >> bib.query(:none, '@book')
+    #     => same as bib.reject { |b| b.has_type?(:book) }
     #
     def query(*arguments, &block)
-      raise ArgumentError, "wrong number of arguments (#{arguments.length} for 0..2)" unless arguments.length.between?(0,2)
-
-      q, selector = arguments.reverse
+      case arguments.length
+      when 0
+        selector, q = :all, nil
+      when 1
+        selector, q = :all, arguments[0]
+      when 2
+        selector, q = arguments
+      else
+        raise ArgumentError, "wrong number of arguments (#{arguments.length} for 0..2)"
+      end
+      
       filter = block ? Proc.new { |e| e.match?(q) && block.call(e) } :
         Proc.new { |e| e.match?(q) }
 

data/lib/bibtex/elements.rb

@@ -79,7 +79,7 @@ module BibTeX
     
     # Returns true if the element matches the given query.
     def matches?(query)
-      return true if !query || query.respond_to?(:empty?) && query.empty?
+      return true if query.nil? || query.respond_to?(:empty?) && query.empty?
       
       case query
       when Symbol
@@ -88,8 +88,8 @@ module BibTeX
         query == self
       when Regexp
         to_s.match(query)
-      when /@(\w+)(?:\[([^\]]*)\])?/
-        query.scan(/@(\w+)(?:\[([^\]]*)\])?/).any? do |type, condition|
+      when /@(\*|\w+)(?:\[([^\]]*)\])?/
+        query.scan(/@(\*|\w+)(?:\[([^\]]*)\])?/).any? do |type, condition|
           has_type?(type) && ( condition.nil? || meets?(condition.split(/,\s*/)) )
         end
       when /^\/(.+)\/$/

data/lib/bibtex/entry.rb

@@ -192,7 +192,7 @@ module BibTeX
     end
     
     def has_type?(type)
-      type.to_s.match(/^entry$/i) || @type == type.to_sym || super
+      type.to_s.match(/^(?:entry|\*)$/i) || @type == type.to_sym || super
     end
     
     alias type? has_type?

data/lib/bibtex/value.rb

@@ -54,6 +54,7 @@ module BibTeX
     
     def_delegators :to_s, :=~, :===, *String.instance_methods(false).reject { |m| m =~ /^\W|^length$|^dup$|!$/ }
     def_delegators :@tokens, :[], :length
+    def_delegator :@tokens, :each, :each_token
     
     def initialize(*arguments)
       @tokens = []
@@ -212,8 +213,6 @@ module BibTeX
       tokens.select { |v| v.is_a?(Symbol) }
     end
     
-    def each_token; tokens.each; end
-    
     # Returns a new Value with all string values converted according to the given filter.
     def convert (filter)
       dup.convert!(filter)

data/lib/bibtex/version.rb

@@ -18,6 +18,6 @@
 
 module BibTeX
   module Version
-    STRING = '2.0.2'.freeze
+    STRING = '2.0.3'.freeze
   end
 end

data/test/bibtex/test_bibliography.rb

@@ -63,6 +63,7 @@ module BibTeX
           year={2007},
           publisher={O'Reilly}
         }
+        @string{ foo = "foobar" }
         END
       end
       
@@ -144,6 +145,22 @@ module BibTeX
         assert_equal @bib.length, BibTeX.open(tmp.path).length
       end
       
+      describe '#query' do
+        
+        it 'returns all elements when passed no arguments' do
+          @bib.query.length.must_be :==, 4
+        end
+
+        it 'returns all elements when passed :all and an empty condition' do
+          @bib.query(:all, '').length.must_be :==, 4
+        end
+        
+        it 'returns all entries when passed a * wildcard' do
+          @bib.query('@*').length.must_be :==, 3
+        end
+        
+      end
+      
       describe 'given a filter' do
         before do
           @filter = Object

data/test/bibtex/test_filters.rb

@@ -28,6 +28,7 @@ module BibTeX
       
       it "should return nil if there is no filter by that name" do
         assert_equal nil, Filters.resolve(:foobar)
+        assert_equal nil, Filters.resolve(:upcase)
         assert_equal nil, Filters.resolve('foobar')
         assert_equal nil, Filters.resolve(nil)
       end

data/test/bibtex/test_names.rb

@@ -23,7 +23,7 @@ module BibTeX
     
 		describe "conversions" do
       before do
-        class Upcase < BibTeX::Filter
+        class UpcaseAll < BibTeX::Filter
           def apply (value)
             value.upcase
           end
@@ -32,7 +32,7 @@ module BibTeX
       
       describe "#convert" do
         it "converts the value when given a filter instance" do
-					Names.parse('Poe and Hawthorne').convert(Upcase.instance).to_s.must_be :==, 'POE and HAWTHORNE'
+					Names.parse('Poe and Hawthorne').convert(UpcaseAll.instance).to_s.must_be :==, 'POE and HAWTHORNE'
         end
 
 				it "converts LaTeX umlauts" do

data/test/bibtex/test_value.rb

@@ -70,7 +70,7 @@ module BibTeX
     describe "conversions" do
       before do
         class Upcase < BibTeX::Filter
-          def apply (value)
+          def apply(value)
             value.is_a?(::String) ? value.upcase : value
           end
         end
@@ -81,7 +81,7 @@ module BibTeX
         it "converts the value when given a filter instance" do
           assert_equal ['FOO', '"FOO" # bar'], @values.map { |v| v.convert(Upcase.instance).to_s }
         end
-
+        
         it "converts the value when given a filter class" do
           assert_equal ['FOO', '"FOO" # bar'], @values.map { |v| v.convert(Upcase).to_s }
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bibtex-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-25 00:00:00.000000000 Z
+date: 2011-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: latex-decode
-  requirement: &70324808993440 !ruby/object:Gem::Requirement
+  requirement: &70212662177440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *70324808993440
+  version_requirements: *70212662177440
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70324808989740 !ruby/object:Gem::Requirement
+  requirement: &70212662176600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70324808989740
+  version_requirements: *70212662176600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70324808988600 !ruby/object:Gem::Requirement
+  requirement: &70212662175900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70324808988600
+  version_requirements: *70212662175900
 - !ruby/object:Gem::Dependency
   name: racc
-  requirement: &70324808987400 !ruby/object:Gem::Requirement
+  requirement: &70212662175140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.4'
   type: :development
   prerelease: false
-  version_requirements: *70324808987400
+  version_requirements: *70212662175140
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70324808984640 !ruby/object:Gem::Requirement
+  requirement: &70212662174580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: '3.9'
   type: :development
   prerelease: false
-  version_requirements: *70324808984640
+  version_requirements: *70212662174580
 description: ! "\t\tBibTeX-Ruby is the Rubyist's swiss-army-knife for all things BibTeX.
   It\n    includes a parser for all common BibTeX objects (@string, @preamble,\n    @comment
   and regular entries) and a sophisticated name parser that\n    tokenizes correctly