bibtex-ruby 2.0.12 → 2.1.0

data/Rakefile

@@ -1,21 +1,24 @@
-# -*- ruby -*-
-lib = File.expand_path('../lib/', __FILE__)
-$:.unshift lib unless $:.include?(lib)
+# encoding: utf-8
+
+require 'bundler'
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), './lib'))
+
 
 require 'rake/clean'
 require 'rake/testtask'
 
-require 'rdoc/task'
-
 require 'bibtex/version'
 
-RDoc::Task.new(:rdoc => ['clean','racc']) do |rd|
-  rd.main = 'README.md'
-  rd.title = "BibTeX-Ruby Documentation"
-  rd.rdoc_files.include('README.md',"lib/**/*.rb")
-  rd.rdoc_dir = "doc/html"
-  rd.options << '--webcvs=http://github.com/inukshuk/bibtex-ruby/tree/master/'
-end
+require 'yard'
+YARD::Rake::YardocTask.new
 
 Rake::TestTask.new(:test_task) do |t|
   t.libs << 'lib' << 'test'
@@ -31,12 +34,12 @@ begin
 rescue LoadError
   desc 'Cucumber rake task not available'
   task :features do
-    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+    abort 'Cucumber rake task is not available. Please install cucumber as a gem or plugin'
   end
 end
 
 
-task :default => ['racc']
+task :default => [:test, :features]
 
 desc 'Generates the BibTeX parser'
 task :racc => ['lib/bibtex/parser.rb','lib/bibtex/name_parser.rb']
@@ -54,6 +57,18 @@ file 'lib/bibtex/name_parser.rb' => ['lib/bibtex/names.y'] do
   sh 'bundle exec racc -o lib/bibtex/name_parser.rb lib/bibtex/names.y'
 end
 
+desc 'Run an IRB session with BibTeX-Ruby loaded'
+task :console, [:script] do |t,args|
+  ARGV.clear
+
+  require 'irb'
+  require 'bibtex'
+  
+  IRB.conf[:SCRIPT] = args.script
+  IRB.start
+end
+
+
 desc 'Runs the benchmarks (and plots the results)'
 task :benchmark => ['racc'] do
   require File.expand_path('../test/benchmark.rb', __FILE__)
@@ -69,7 +84,9 @@ end
 desc 'Updates the Manifest file'
 task :manifest => ['clean', 'racc'] do
   m = File.open('Manifest', 'w')
-  m.print FileList['**/*'].reject{ |f| f.end_with?('rbc') }.join("\n")
+  m.print FileList['**/*'].reject{ |f|
+    f.start_with?('coverage') || f.end_with?('rbc')
+  }.join("\n")
   m.close
 end
 
@@ -89,7 +106,4 @@ CLEAN.include('lib/bibtex/parser.rb')
 CLEAN.include('lib/bibtex/parser.output')
 CLEAN.include('lib/bibtex/name_parser.rb')
 CLEAN.include('lib/bibtex/name_parser.output')
-CLEAN.include('doc/html')
 CLEAN.include('*.gem')
-
-# vim: syntax=ruby

data/bibtex-ruby.gemspec

@@ -9,12 +9,12 @@ Gem::Specification.new do |s|
   s.version     = BibTeX::Version::STRING.dup
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Sylvester Keil']
-  s.email       = ['http://sylvester.keil.or.at']
+  s.email       = ['sylvester@keil.or.at']
   s.homepage    = 'http://inukshuk.github.com/bibtex-ruby'
   s.license     = 'GPL-3'
 
   s.summary     = 'A BibTeX parser, converter and API for Ruby.'
-  s.description = <<-END_DESCRIPTION
+  s.description = <<-END_DESCRIPTION.gsub(/^\s+/, '')
 		BibTeX-Ruby is the Rubyist's swiss-army-knife for all things BibTeX. It
     includes a parser for all common BibTeX objects (@string, @preamble,
     @comment and regular entries) and a sophisticated name parser that
@@ -28,18 +28,12 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('latex-decode', ['>=0.0.6'])
   s.add_runtime_dependency('multi_json', ['~>1.3'])
 
-  s.add_development_dependency('rake', ['~>0.9'])
-  s.add_development_dependency('racc', ['~>1.4'])
-  s.add_development_dependency('rdoc', ['~>3.9'])
-
   s.files        = File.open('Manifest').readlines.map(&:chomp)
   s.test_files   = Dir.glob('test/**/test*.rb')
   s.executables  = []
   s.require_path = 'lib'
 
-  s.rdoc_options      = %w{--line-numbers --inline-source --title "BibTeX-Ruby\ Documentation" --main README.md --webcvs=http://github.com/inukshuk/bibtex-ruby/tree/master/}
-  s.extra_rdoc_files  = %w{README.md}
-  
+  s.has_rdoc  = 'yard'
 end
 
 # vim: syntax=ruby

data/features/query.feature

@@ -59,4 +59,42 @@ Feature: Searching in BibTeX bibliographies
 		Then there should be exactly 3 matches
 		When I search for "@*[year=2007]"
 		Then there should be exactly 1 match
-		
+		
+	@query
+	Scenario: Find entries using compound queries
+		Given the bibliography:
+		"""
+		@book{pickaxe,
+			Address = {Raleigh, North Carolina},
+			Author = {Thomas, Dave, and Fowler, Chad, and Hunt, Andy},
+			Date-Added = {2010-08-05 09:54:07 +0200},
+			Date-Modified = {2010-08-05 10:07:01 +0200},
+			Keywords = {ruby},
+			Publisher = {The Pragmatic Bookshelf},
+			Series = {The Facets of Ruby},
+			Title = {Programming Ruby 1.9: The Pragmatic Programmer's Guide},
+			Year = {2009}
+		}
+		@article{a1,
+		  Title = {An Article},
+			Keywords = {@book}
+		}
+		@book{dragon,
+			Address = {Boston},
+			Author = {Aho, Alfred V., and Lam, Monica S., and Ullman, Jeffrey D.},
+			Booktitle = {Compilers: Principles, Techniques, and Tools},
+			Date-Added = {2010-08-05 09:57:15 +0200},
+			Date-Modified = {2010-08-05 10:06:32 +0200},
+			Edition = {second},
+			Keywords = {compiler, lex, yacc},
+			Publisher = {Addison Wesley},
+			Title = {Compilers: Principles, Techniques, and Tools},
+			Year = {2007}
+		}
+		"""
+		When I search for "@*[keywords = @book || edition = second]"
+		Then there should be exactly 2 matches
+		When I search for "@*[keywords = @book && edition = second]"
+		Then there should be exactly 0 matches
+		When I search for "@*[keywords = @book && title ~= Article]"
+		Then there should be exactly 1 match

data/features/support/env.rb

@@ -1,6 +1,18 @@
+begin  
+  if RUBY_VERSION > '1.8'
+    require 'debugger'
+    require 'simplecov'
+  else
+    require 'ruby-debug'
+    Debugger.start
+  end
+rescue LoadError
+  # ignore
+end
+
 require 'bibtex'
 require 'minitest/unit'
 
 World do
   extend MiniTest::Assertions
-end
+end

data/lib/bibtex.rb

@@ -1,6 +1,6 @@
 #--
 # BibTeX-Ruby
-# Copyright (C) 2010-2011	Sylvester Keil <sylvester.keil.or.at>
+# Copyright (C) 2010-2012	Sylvester Keil <sylvester.keil.or.at>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -56,10 +56,13 @@ end
 # Debugger.start
 
 require 'bibtex/extensions'
-require 'bibtex/compatibility'
+
 require 'bibtex/value'
 require 'bibtex/filters'
 require 'bibtex/name_parser'
+
+require 'bibtex/compatibility'
+
 require 'bibtex/names'
 require 'bibtex/replaceable'
 require 'bibtex/elements'

data/lib/bibtex/bibliography.rb

@@ -1,6 +1,6 @@
 #--
 # BibTeX-Ruby
-# Copyright (C) 2010-2011  Sylvester Keil <sylvester.keil.or.at>
+# Copyright (C) 2010-2012  Sylvester Keil <sylvester.keil.or.at>
 # 
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

data/lib/bibtex/compatibility.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 
 unless Symbol.include?(Comparable)
   class Symbol
@@ -7,4 +8,11 @@ unless Symbol.include?(Comparable)
       to_s <=> other.to_s
     end
   end
-end
+end
+
+if RUBY_VERSION < '1.9'
+  $KCODE = 'u'
+  require 'jcode'
+  
+  BibTeX::NameParser.patterns[:upper] = /[[:upper:]ÄÖÜ][^\t\r\n\s\{\}\d\\,]*/o
+end

data/lib/bibtex/elements.rb

@@ -1,17 +1,17 @@
 #--
 # BibTeX-Ruby
-# Copyright (C) 2010-2011 Sylvester Keil <sylvester.keil.or.at>
-# 
+# Copyright (C) 2010-2012 Sylvester Keil <sylvester.keil.or.at>
+#
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
-# 
+#
 # This program 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 General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #++
@@ -23,10 +23,10 @@ module BibTeX
   #
   class Element
     include Comparable
-    
+
     attr_writer :id
     attr_reader :bibliography
-    
+
     # Returns an array of BibTeX elements.
     def self.parse(input, options = {})
       case input
@@ -45,7 +45,7 @@ module BibTeX
         raise ArgumentError, "failed to parse Element from #{input.inspect}"
       end
     end
-    
+
     # Returns a string containing the object's content.
     def content(options = {}); ''; end
 
@@ -54,33 +54,33 @@ module BibTeX
 
     # Invokes BibTeX string joining on this element.
     def join; self; end
-    
+
     # Returns the element's id.
     def id; @id ||= object_id.to_s; end
-    
+
     # Returns the BibTeX type (if applicable) or the normalized class name.
     def type
       self.class.name.split(/::/).last.gsub(/([[:lower:]])([[:upper:]])/) { "#{$1}_#{$2}" }.downcase.intern
     end
-  
+
     # Returns a list of names for that Element. All Elements except Entries return an empty list.
     def names
       []
     end
-    
+
     def has_type?(type)
       self.type == type.intern || defined?(type) == 'constant' && is_a?(type)
     end
-    
-    [:entry, :book, :article, :collection, :string, :preamble, :comment]. each do |type|
+
+    [:entry, :book, :article, :collection, :string, :preamble, :comment].each do |type|
       method_id = "#{type}?"
       define_method(method_id) { has_type?(type) } unless method_defined?(method_id)
     end
-    
+
     # Returns true if the element matches the given query.
     def matches?(query)
       return true if query.nil? || query.respond_to?(:empty?) && query.empty?
-      
+
       case query
       when Symbol
         query.to_s == id.to_s
@@ -88,63 +88,61 @@ module BibTeX
         query == self
       when Regexp
         to_s.match(query)
+      when /^\/(.+)\/$/
+        to_s.match(Regexp.new($1))
       when /@(\*|\w+)(?:\[([^\]]*)\])?/
         query.scan(/@(\*|\w+)(?:\[([^\]]*)\])?/).any? do |type, condition|
-          has_type?(type) && ( condition.nil? || meets?(condition.split(/,\s*/)) )
+          if has_type?(type)
+            if condition.nil? || condition.empty?
+              true
+            else
+              condition.to_s.split(/\s*\|\|\s*/).any? do |conditions|
+                meets_all? conditions.split(/\s*(?:,|&&)\s*/)
+              end
+            end
+          end
         end
-      when /^\/(.+)\/$/
-        to_s.match(Regexp.new($1))
       else
         id.to_s == query
-      end      
+      end
     end
-    
+
     alias === matches?
     alias match? matches?
-    
-    # Returns true if the element meets all of the given conditions.
-    def meets?(*conditions)
-      conditions.flatten.all? do |condition|
-        property, operator, value = condition.split(/\s*([!~\/\^<>]?=)\s*/)
-        
-        if property.nil?
-          true
-        else
-          case operator
-          when '!=', '/='
-            !respond_to?(property) || send(property).to_s != value
-          when '^='
-            respond_to?(property) && send(property).to_s.match("^#{value}")
-          when '~='
-            respond_to?(property) && send(property).to_s.match(value)
-          when '<='
-            respond_to?(property) && send(property).to_i <= value.to_i
-          when '>='
-            respond_to?(property) && send(property).to_i >= value.to_i
-          else
-            respond_to?(property) && send(property).to_s == value
-          end
-        end
+
+    def meets_all?(*conditions)
+      meets? conditions.flatten, :all?
+    end
+    alias meet_all? meets_all?
+
+    def meets_any?(*conditions)
+      meets? conditions.flatten, :any?
+    end
+    alias meet_any? meets_any?
+
+    # Returns true if the element meets all or any of the given conditions.
+    def meets?(conditions, op = :all?)
+      conditions.send(op) do |condition|
+        meets_condition? condition
       end
     end
-    
     alias meet? meets?
-    
+
     alias to_s content
-    
+
     def to_hash(options = {})
       { type => content }
     end
-    
+
     def to_yaml(options = {})
       require 'yaml'
       to_hash.to_yaml
     end
-    
+
     def to_json(options = {})
       MultiJson.dump(to_hash(options))
     end
-    
+
     def to_xml(options = {})
       require 'rexml/document'
       xml = REXML::Element.new(type)
@@ -158,25 +156,52 @@ module BibTeX
       @bibliography = bibliography
       self
     end
-    
+
     # Called when the element was removed from a bibliography.
     def removed_from_bibliography(bibliography)
       @bibliography = nil
       self
     end
-    
+
     def <=>(other)
       return nil unless other.respond_to? :type and other.respond_to? :to_s
       [type, to_s] <=> [other.type, other.to_s]
     end
-    
+
     # Returns the Element as a nicely formatted string.
     def inspect
       "#<#{self.class} #{content.gsub(/\n/, ' ')}>"
     end
+    
+    private
+    
+    def meets_condition?(condition)
+      property, operator, value = condition.split(/\s*([!~\/\^<>]?=)\s*/)
+
+      if property.nil?
+        true
+      else
+        actual = respond_to?(property) ? send(property) : nil
+
+        case operator
+        when '!=', '/='
+          actual.nil? || actual.to_s != value
+        when '^='
+          !actual.nil? && actual.to_s.match("^#{value}")
+        when '~='
+          !actual.nil? && actual.to_s.match(value)
+        when '<='
+          !actual.nil? && actual.to_i <= value.to_i
+        when '>='
+          !actual.nil? && actual.to_i >= value.to_i
+        else
+          !actual.nil? && actual.to_s == value
+        end
+      end
+    end
   end
 
- 
+
   #
   # Represents a @string object.
   #
@@ -187,9 +212,9 @@ module BibTeX
   # @string and @preamble objects, as well as in field values
   # of regular entries.
   #
-  class String < Element    
+  class String < Element
     include Replaceable
-    
+
     attr_reader :key
 
     # Creates a new instance.
@@ -201,7 +226,7 @@ module BibTeX
     # Sets the string's key (i.e., the symbol identifying the constant).
     def key=(key)
       raise(ArgumentError, "keys must be convertible to Symbol; was: #{type.class.name}.") unless type.respond_to?(:to_sym)
-      
+
       unless bibliography.nil?
         bibliography.strings.delete(@key)
         bibliography.strings[key.to_sym] = self
@@ -214,7 +239,7 @@ module BibTeX
     def [](key)
       @key == key ? @value : nil
     end
-    
+
 
     # Called when the element was added to a bibliography.
     def added_to_bibliography(bibliography)
@@ -222,7 +247,7 @@ module BibTeX
       bibliography.strings[@key] = self
       self
     end
-    
+
     # Called when the element was removed from a bibliography.
     def removed_from_bibliography(bibliography)
       super
@@ -239,23 +264,23 @@ module BibTeX
     def to_s(options = {})
       "@string{ #{content} }"
     end
-    
+
     def to_hash(options = {})
       { :string => { @key => @value.to_s(:quotes => '"') } }
     end
-    
+
     def to_xml(options = {})
       require 'rexml/document'
-      
+
       xml = REXML::Element.new(:string)
-      
+
       k, v = REXML::Element.new(:key), REXML::Element.new(:value)
       k.text = key.to_s
       v.text = value.to_s(:quotes => '"')
-    
+
       xml.add_elements(k)
       xml.add_elements(v)
-      
+
       xml
     end
   end
@@ -273,7 +298,7 @@ module BibTeX
     def initialize(value = '')
       @value = Value.new(value)
     end
-    
+
     # Returns a string representation of the @preamble's content.
     def content
       @value.to_s(:quotes => '"')
@@ -288,7 +313,7 @@ module BibTeX
   # Represents a @comment object.
   class Comment < Element
     attr_accessor :content
-    
+
     def initialize(content = '')
       @content = content
     end
@@ -300,7 +325,7 @@ module BibTeX
 
   # Represents text in a `.bib' file, but outside of an
   # actual BibTeX object; typically, such text is treated
-  # as a comment and is ignored by the parser. 
+  # as a comment and is ignored by the parser.
   # BibTeX-Ruby offers this class to allows for
   # post-processing of this type of `meta' content. If you
   # want the parser to include +MetaComment+ objects, you
@@ -308,7 +333,7 @@ module BibTeX
   # option.
   class MetaContent < Element
     attr_accessor :content
-    
+
     def initialize(content = '')
       @content = content
     end