bibtex-ruby 2.0.8 → 2.0.9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bibtex-ruby (2.0.8)
+    bibtex-ruby (2.0.9)
       latex-decode (>= 0.0.6)
       multi_json (~> 1.3)
 

data/History.txt

@@ -1,3 +1,9 @@
+2.0.9 / 2012-05-15
+==================
+
+* Added extend_initials! method to extend all names in the bibliography
+* Added unify method as a shorthand to unify fields across the bibliography
+
 2.0.8 / 2012-05-11
 ==================
 

data/README.md

@@ -54,6 +54,25 @@ Extend first name initials throughout your bibliography:
     b[:pickaxe].author.to_s
     #=> "Thomas, Dave and Fowler, Chad and Hunt, Andy"
 
+You can also extend all names in the bibliography to their prototypical
+(i.e., the longest available) form:
+
+    b.extend_initials! #=> extends all names in the bibliography
+
+Use with caution as this method will treat two names as identical if they
+look the same in their `#sort_order(:initials => true)` form.
+
+Unify certain fields across the bibliography:
+
+    b.unify :publisher, /o'?reilly/i, "O'Reilly"
+    
+    b.unify :publisher, /^penguin/i do |entry|
+      entry.publisher = 'Penguin Books'
+      entry.address = 'London'
+    end
+
+This will unify various spellings of entries published by O'Reilly and Penguin.
+
 Render your bibliography in one of
 [many different citation styles](https://github.com/citation-style-language/styles)
 (requires the **citeproc-ruby** gem):
@@ -161,17 +180,17 @@ BibTeX-Ruby will return any fields inherited from the parent entry:
 
     > b = BibTeX.parse <<-END
     @inbook{fraassen_1989b,
-    	Crossref = {fraassen_1989},
-    	Pages = {40-64},
-    	Title = {Ideal Science: David Lewis's Account of Laws},
+      Crossref = {fraassen_1989},
+      Pages = {40-64},
+      Title = {Ideal Science: David Lewis's Account of Laws},
     }
 
     @book{fraassen_1989,
-    	Address = {Oxford},
-    	Author = {Bas C. van Fraassen},
-    	Publisher = {Oxford University Press},
-    	Title = {Laws and Symmetry},
-    	Year = 1989
+      Address = {Oxford},
+      Author = {Bas C. van Fraassen},
+      Publisher = {Oxford University Press},
+      Title = {Laws and Symmetry},
+      Year = 1989
     }
     END
     > b['fraassen_1989b'].booktitle
@@ -313,6 +332,20 @@ use the following snippet:
       end
     end
 
+There is also a short-hand for this use case:
+
+    b.extend_initials ['Edgar Allen', 'Poe']
+
+Alternatively, if your bibliography contains the same names in various
+forms (e.g., 'Poe, Edgar A.', 'Poe, E.A.', 'Poe, E. Allen') you can also
+set all names to their longest available form:
+
+    b.extend_initials!
+
+Use with caution, though, as this method will treat names as identical
+as long as their initials are the same. That is to say, 'Poe, Eric A.' would
+be extend to 'Poe, Edgar Allen'.
+
 
 ### Filters
 
@@ -351,7 +384,7 @@ apply the filter upon opening or parsing the Bibliography. You can do this,
 by passing the `:filter` option:
 
    BibTeX.open 'references.bib', :filter => :latex
-   
+
 
 ### Exports
 

data/lib/bibtex/bibliography.rb

@@ -290,12 +290,74 @@ module BibTeX
     #   b.extend_initials(['Edgar Allen', 'Poe'], ['Nathaniel', 'Hawthorne'])
     #   #=> Extends the initials in names like 'E.A. Poe' or 'Hawethorne, N.'
     #       in the bibliography.
+    #
+    # Extends the initials for the given names. Returns the Bibliography.
     def extend_initials(*arguments)
       arguments.each do |with_first, for_last|
         names.each do |name|
           name.extend_initials(with_first, for_last)
         end
       end
+      
+      self
+    end
+    
+    # This method combines all names in the bibliography that look identical
+    # when using initials as first names and then tries to extend the first
+    # names for all names in each group to the longest available form.
+    # Returns the bibliography.
+    #
+    # If your bibliography contains the names 'Poe, Edgar A.', 'Poe, E.A.',
+    # and 'Poe, E. A.' calling this method would convert all three names to
+    # 'Poe, Edgar A.'.
+    def extend_initials!
+      groups = Hash.new do |h,k|
+        h[k] = { :prototype => nil, :names => [] }
+      end
+      
+      # group names together
+      names.each do |name|
+        group = groups[name.sort_order(:initials => true).gsub(/\s+/, '')]
+        group[:names] << name
+        
+        if group[:prototype].nil? || group[:prototype].first.length < name.first.length
+          group[:prototype] = name
+        end
+      end
+      
+      # extend all names in group to prototype
+      groups.each_value do |group|
+        group[:names].each do |name|
+          name.set(group[:prototype])
+        end
+      end
+      
+      self
+    end
+
+    # call-seq:
+    #   b.unify :publisher, /o'?reilly/i, "O'Reilly"
+    #   #=> Unifies the publisher name "O'Reilly" in the bibliography
+    #
+    # Sets all fields matching the passed-in pattern to the supplied value.
+    # If a block is given, each matching entry will be passed to the block
+    # instead. Returns the bibliography.
+    def unify(field, pattern, value = nil)
+      pattern = Regexp.new(pattern) unless pattern.is_a?(Regexp)
+
+      block = if block_given?
+        Proc.new
+      else
+        Proc.new { |e| e[field] = value }
+      end
+      
+      each_entry do |entry|
+        if entry.field?(field) && entry[field].to_s =~ pattern
+          block.call(entry)
+        end
+      end
+            
+      self
     end
     
     def sort(*arguments, &block)
@@ -416,7 +478,15 @@ module BibTeX
     end
     
     alias q query
-        
+    
+    def each_entry
+      if block_given?
+        q('@entry').each(&Proc.new)
+      else
+        q('@entry').to_enum
+      end
+    end
+    
     def find_by_type(*types, &block)
       q(types.flatten.compact.map { |t| "@#{t}" }.join(', '), &block)
     end

data/lib/bibtex/names.rb

@@ -151,7 +151,7 @@ module BibTeX
     
     # Set the name tokens to the values defined in the passed-in hash.
     def set(attributes = {})
-      attributes.each do |key, value|
+      attributes.each_pair do |key, value|
         send("#{key}=", value) if respond_to?(key)
       end
       

data/lib/bibtex/version.rb

@@ -18,6 +18,6 @@
 
 module BibTeX
   module Version
-    STRING = '2.0.8'.freeze
+    STRING = '2.0.9'.freeze
   end
 end

data/test/bibtex/test_bibliography.rb

@@ -68,6 +68,14 @@ module BibTeX
           publisher={O'Reilly}
         }
         @string{ foo = "foobar" }
+        @misc{flanagan-1,
+          title={{Foo Bar}},
+          author={Flanagan, Dav}
+        }
+        @misc{flanagan-2,
+          title={{Foo Bar}},
+          author={Flanagan, David}
+        }
         END
       end
       
@@ -85,6 +93,36 @@ module BibTeX
         end
       end
       
+      describe '#extend_initials!' do
+        it 'extends the initials of all names to the longest prototype' do
+          assert_equal "Ruby, Sam Thomas, Dave Hansson Heinemeier, David Flanagan, David Matsumoto, Y. Segaran, T.",
+            @bib.extend_initials!.names.map(&:sort_order).uniq.join(' ')
+        end
+      end
+      
+      describe '#unify' do
+        it 'sets all fields matching the given pattern to the passed-in value' do
+          @bib.unify :publisher, /reilly/i, 'OReilly'
+          assert_equal 'OReilly', @bib['segaran2007'].publisher
+          assert_equal 'OReilly', @bib['flanagan2008'].publisher
+        end
+        
+        it 'does not change the value of fields that do not match' do
+          @bib.unify :publisher, /reilly/i, 'OReilly'
+          assert_equal 'The Pragmatic Bookshelf', @bib['rails'].publisher
+        end
+        
+        it 'passes each entry with matching fields to the block if given' do
+          years = []
+          @bib.unify(:publisher, /reilly/i) { |e| years << e.year.to_s }
+          assert_equal ['2007','2008'], years.sort
+        end
+        
+        it 'returns the bibliography' do
+          assert_equal @bib, @bib.unify(:publisher, /reilly/i, 'OReilly')
+        end
+      end
+      
       it 'supports access by index' do
         assert_equal 'ruby', @bib[1].keywords 
       end
@@ -139,7 +177,7 @@ module BibTeX
       end
 
       it 'supports queries with negative conditions' do
-        assert_equal 2, @bib['@*[keywords!=ruby]'].length
+        assert_equal 4, @bib['@*[keywords!=ruby]'].length
       end
 
       it 'supports queries with pattern conditions' do
@@ -186,15 +224,15 @@ module BibTeX
       describe '#query' do
         
         it 'returns all elements when passed no arguments' do
-          @bib.query.length.must_be :==, 4
+          @bib.query.length.must_be :==, 6
         end
 
         it 'returns all elements when passed :all and an empty condition' do
-          @bib.query(:all, '').length.must_be :==, 4
+          @bib.query(:all, '').length.must_be :==, 6
         end
         
         it 'returns all entries when passed a * wildcard' do
-          @bib.query('@*').length.must_be :==, 3
+          @bib.query('@*').length.must_be :==, 5
         end
         
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bibtex-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.8
+  version: 2.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-11 00:00:00.000000000 Z
+date: 2012-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: latex-decode
-  requirement: &70229986220740 !ruby/object:Gem::Requirement
+  requirement: &70317354105840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.0.6
   type: :runtime
   prerelease: false
-  version_requirements: *70229986220740
+  version_requirements: *70317354105840
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70229986220220 !ruby/object:Gem::Requirement
+  requirement: &70317354105180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70229986220220
+  version_requirements: *70317354105180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70229986219680 !ruby/object:Gem::Requirement
+  requirement: &70317354104100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70229986219680
+  version_requirements: *70317354104100
 - !ruby/object:Gem::Dependency
   name: racc
-  requirement: &70229986219200 !ruby/object:Gem::Requirement
+  requirement: &70317354103320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.4'
   type: :development
   prerelease: false
-  version_requirements: *70229986219200
+  version_requirements: *70317354103320
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70229986218720 !ruby/object:Gem::Requirement
+  requirement: &70317354102160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: '3.9'
   type: :development
   prerelease: false
-  version_requirements: *70229986218720
+  version_requirements: *70317354102160
 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
@@ -182,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4363834808819370688
+      hash: -50105295349997103
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4363834808819370688
+      hash: -50105295349997103
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10