bibtex-ruby 4.4.7 → 5.0.0

data/lib/bibtex/replaceable.rb

@@ -1,6 +1,6 @@
 #--
 # BibTeX-Ruby
-# Copyright (C) 2010	Sylvester Keil <sylvester.keil.or.at>
+# Copyright (C) 2010  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
@@ -9,15 +9,14 @@
 #
 # 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
+# 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/>.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #++
 
 module BibTeX
-
   #
   # The Replaceable module provides methods that expose a Value attribute
   # and the ability to join or replace the contained BibTeX symbols.
@@ -27,26 +26,25 @@ module BibTeX
 
     attr_reader :value
 
-		def value=(value)
-		  @value = Value.new(value)
-		end
+    def value=(value)
+      @value = Value.new(value)
+    end
 
-		def replace(*arguments)
-			@value.replace(*arguments)
-			self
-		end
+    def replace(*arguments)
+      @value.replace(*arguments)
+      self
+    end
 
     def join
       @value.join
       self
     end
 
-		def <<(value)
-			@value << value
-			self
-		end
-
-    alias :v :value
+    def <<(value)
+      @value << value
+      self
+    end
 
+    alias v value
   end
 end

data/lib/bibtex/utilities.rb

@@ -17,9 +17,7 @@
 #++
 
 module BibTeX
-
   class << self
-
     # Opens a BibTeX file or URI and returns a corresponding +Bibliography+
     # object or, if a block is given, yields the Bibliography to the block,
     # ensuring that the file is saved.
@@ -30,10 +28,9 @@ module BibTeX
     # Parses the given string and returns a corresponding +Bibliography+ object.
     # Delegates to BibTeX.open if the string is a filename or URI.
     def parse(string, options = {}, &block)
-      case
-      when string.length < 260 && File.exist?(string)
+      if string.length < 260 && File.exist?(string)
         Bibliography.open(string, options, &block)
-      when string =~ /\A[a-z]+:\/\//i
+      elsif string =~ %r{\A[a-z]+://}i
         Bibliography.open(string, options)
       else
         Bibliography.parse(string, options)
@@ -50,10 +47,8 @@ module BibTeX
       Names.parse(string)
     end
 
-    alias :name :names
-    alias :parse_name :names
-    alias :parse_names :names
-
+    alias name names
+    alias parse_name names
+    alias parse_names names
   end
-
 end

data/lib/bibtex/value.rb

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 #--
 # BibTeX-Ruby
 # Copyright (C) 2010-2015  Sylvester Keil <sylvester.keil.or.at>
@@ -21,8 +19,6 @@
 require 'forwardable'
 
 module BibTeX
-
-
   # A BibTeX Value is something very much like a string. In BibTeX files it
   # can appear on the right hand side of @string or @entry field assignments
   # or as @preamble contents. In the example below [VALUE] indicates possible
@@ -53,9 +49,9 @@ module BibTeX
     alias to_a tokens
 
     def_delegators :to_s, :=~, :===,
-      *String.instance_methods(false).reject { |m|
-        m =~ /^\W|^(length|dup|replace|to_s|inspect)$|!$/
-      }
+                   *String.instance_methods(false).reject do |m|
+                     m =~ /^\W|^(length|dup|replace|to_s|inspect)$|!$/
+                   end
 
     def_delegators :@tokens, :[], :length
     def_delegator :@tokens, :each, :each_token
@@ -79,9 +75,8 @@ module BibTeX
 
     def initialize_copy(other)
       @tokens = other.tokens.map do |token|
-        case
-        when token.nil? then nil
-        when token.is_a?(Symbol) then token
+        if token.nil? then nil
+        elsif token.is_a?(Symbol) then token
         else token.dup
         end
       end
@@ -115,7 +110,7 @@ module BibTeX
         if argument.respond_to?(:to_s)
           @tokens << argument.to_s
         else
-          raise(ArgumentError, "Failed to create Value from argument #{ argument.inspect }; expected String, Symbol or Value instance.")
+          raise(ArgumentError, "Failed to create Value from argument #{argument.inspect}; expected String, Symbol or Value instance.")
         end
       end
       self
@@ -124,10 +119,10 @@ module BibTeX
     alias << add
     alias push add
 
-    [:strip!, :upcase!, :downcase!, :sub!, :gsub!, :chop!, :chomp!, :rstrip!].each do |method_id|
+    %i[strip! upcase! downcase! sub! gsub! chop! chomp! rstrip!].each do |method_id|
       define_method(method_id) do |*arguments, &block|
         @tokens.each do |part|
-          part.send(method_id, *arguments, &block) unless part.nil?
+          part&.send(method_id, *arguments, &block)
         end
         self
       end
@@ -135,6 +130,7 @@ module BibTeX
 
     def replace(*arguments)
       return self unless has_symbol?
+
       arguments.flatten.each do |argument|
         case argument
         when ::String # simulates Ruby's String#replace
@@ -148,7 +144,6 @@ module BibTeX
       self
     end
 
-
     # call-seq:
     #   Value.new('foo', 'bar').join #=> <'foobar'>
     #   Value.new(:foo, 'bar').join  #=> <:foo, 'bar'>
@@ -157,13 +152,12 @@ module BibTeX
     #
     # @return {Value} the instance with all consecutive String tokens joined
     def join(separator = '')
-      @tokens = @tokens.inject([]) do |a,b|
+      @tokens = @tokens.each_with_object([]) do |b, a|
         if a[-1].is_a?(::String) && b.is_a?(::String)
           a[-1] = [a[-1], b].join(separator)
         else
           a << b
         end
-        a
       end
       self
     end
@@ -186,8 +180,9 @@ module BibTeX
     # If the option :filter is given, the Value will be converted using
     # the filter(s) specified.
     def to_s(options = {})
-      return convert(options.delete(:filter)).to_s(options) if options.has_key?(:filter)
-      return value.to_s unless options.has_key?(:quotes) && atomic? && !symbol?
+      return convert(options.delete(:filter)).to_s(options) if options.key?(:filter)
+      return value.to_s unless options.key?(:quotes) && atomic? && !symbol?
+
       q = Array(options[:quotes])
       [q[0], value, q[-1]].compact.join
     end
@@ -200,11 +195,11 @@ module BibTeX
       if atomic?
         @tokens[0]
       else
-        @tokens.map { |v|  v.is_a?(::String) ? v.inspect : v }.join(' # ')
+        @tokens.map { |v| v.is_a?(::String) ? v.inspect : v }.join(' # ')
       end
     end
 
-    alias :v :value
+    alias v value
 
     def inspect
       "#<#{self.class} #{@tokens.map(&:inspect).join(', ')}>"
@@ -216,9 +211,11 @@ module BibTeX
     end
 
     # Returns true if the value is a BibTeX name value.
-    def name?; false; end
+    def name?
+      false
+    end
 
-    alias :names? :name?
+    alias names? name?
 
     def to_name
       Names.parse(to_s)
@@ -235,7 +232,7 @@ module BibTeX
     def to_date
       require 'date'
       Date.parse(to_s)
-    rescue
+    rescue StandardError
       nil
     end
 
@@ -248,7 +245,7 @@ module BibTeX
       @tokens[0].to_i
     end
 
-    def to_citeproc (options = {})
+    def to_citeproc(options = {})
       to_s(options)
     end
 
@@ -265,12 +262,12 @@ module BibTeX
     end
 
     # Returns a new Value with all string values converted according to the given filter(s).
-    def convert (*filters)
+    def convert(*filters)
       dup.convert!(*filters)
     end
 
     # Converts all string values according to the given filter(s).
-    def convert! (*filters)
+    def convert!(*filters)
       filters.flatten.each do |filter|
         f = Filters.resolve!(filter)
         @tokens.map! { |t| f.apply(t) }
@@ -279,27 +276,24 @@ module BibTeX
       self
     end
 
-    def method_missing (name, *args)
-      case
-      when name.to_s =~ /^(?:convert|from)_([a-z]+)(!)?$/
-        $2 ? convert!($1) : convert($1)
+    def method_missing(name, *args)
+      if name.to_s =~ /^(?:convert|from)_([a-z]+)(!)?$/
+        Regexp.last_match(2) ? convert!(Regexp.last_match(1)) : convert(Regexp.last_match(1))
       else
         super
       end
     end
 
-    def respond_to? (method, include_all=false)
+    def respond_to?(method, include_all = false)
       method =~ /^(?:convert|from)_([a-z]+)(!)?$/ || super
     end
 
-    def <=> (other)
+    def <=>(other)
       if numeric? && other.respond_to?(:numeric?) && other.numeric?
         to_i <=> other.to_i
       else
         to_s <=> other.to_s
       end
     end
-
   end
-
 end

data/lib/bibtex/version.rb

@@ -1,6 +1,6 @@
 #--
 # BibTeX-Ruby
-# Copyright (C) 2010-2015	Sylvester Keil <sylvester.keil.or.at>
+# Copyright (C) 2010-2015  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
@@ -9,18 +9,18 @@
 #
 # 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
+# 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/>.
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #++
 
 module BibTeX
   module Version
-    MAJOR = 4
-    MINOR = 4
-    PATCH = 7
+    MAJOR = 5
+    MINOR = 0
+    PATCH = 0
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.').freeze

data/test/benchmark.rb

@@ -7,21 +7,22 @@ require 'bibtex'
 
 # data = File.open(BibTeX::Test.fixtures(:benchmark)).read
 
-input = <<-END
-@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}
-}
+input = <<~END
+  @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}
+  }
 END
 
-n, k = 31, 10
+n = 31
+k = 10
 lexer = BibTeX::Lexer.new
 # parser = BibTeX::Parser.new
 
@@ -31,26 +32,23 @@ g = []
 # Ruby 1.9.3
 format = Benchmark.const_defined?(:FMTSTR) ? Benchmark::FMTSTR : Benchmark::FORMAT
 
-Benchmark.benchmark((" "*15) + CAPTION, 7, format, '%14s:' % 'sum(f)', '%14s:' % 'sum(g)') do |b|
-
-  1.step(n,k) do |i|
-
-    f << b.report('%14s:' % "f(#{i})") do
+Benchmark.benchmark((' ' * 15) + CAPTION, 7, format, format('%14s:', 'sum(f)'), format('%14s:', 'sum(g)')) do |b|
+  1.step(n, k) do |i|
+    f << b.report(format('%14s:', "f(#{i})")) do
       i.times do
         lexer.data = input
         lexer.analyse
-				# BibTeX::Parser.new.parse(input)
+        # BibTeX::Parser.new.parse(input)
       end
     end
 
     data = input * i
 
-    g << b.report('%14s:' % "g(#{i})") do
+    g << b.report(format('%14s:', "g(#{i})")) do
       lexer.data = data
       lexer.analyse
-			# BibTeX::Parser.new.parse(data)
+      # BibTeX::Parser.new.parse(data)
     end
-
   end
 
   [f.inject(:+), g.inject(:+)]

data/test/bibtex/entry/test_rdf_converter.rb

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 require 'helper.rb'
 
 module BibTeX
@@ -37,7 +35,7 @@ module BibTeX
     end
 
     describe '#bdsk_url' do
-      let(:entry) { Entry.new(:'bdsk-url-1' => 'http://www.example.com') }
+      let(:entry) { Entry.new('bdsk-url-1': 'http://www.example.com') }
 
       it 'should run successfully' do
         subject.bdsk_url
@@ -73,7 +71,7 @@ module BibTeX
     end
 
     describe '#date_added' do
-      let(:entry) { Entry.new(:'date-added' => '2014-01-20') }
+      let(:entry) { Entry.new('date-added': '2014-01-20') }
 
       it 'should run successfully' do
         subject.date_added
@@ -81,7 +79,7 @@ module BibTeX
     end
 
     describe '#date_modified' do
-      let(:entry) { Entry.new(:'date-modified' => '2014-01-20') }
+      let(:entry) { Entry.new('date-modified': '2014-01-20') }
 
       it 'should run successfully' do
         subject.date_modified

data/test/bibtex/test_bibliography.rb

@@ -1,11 +1,7 @@
-# -*- encoding: utf-8 -*-
-
 require 'helper'
 
 module BibTeX
-
   class BibliographyTest < Minitest::Spec
-
     describe 'when newly created' do
       it 'should not be nil' do
         assert Bibliography.new
@@ -27,16 +23,15 @@ module BibTeX
 
         assert_equal b.length - 1, BibTeX.open(tmp.path).length
       end
-
     end
 
     describe '.parse' do
       it 'accepts filters' do
-        Bibliography.parse("@misc{k, title = {\\''u}}", :filter => 'latex')[0].title.must_be :==, 'ü'
+        Bibliography.parse("@misc{k, title = {\\''u}}", filter: 'latex')[0].title.must_be :==, 'ü'
       end
 
       it 'accepts filters in an array' do
-        Bibliography.parse("@misc{k, title = {\\''u}}", :filter => ['latex'])[0].title.must_be :==, 'ü'
+        Bibliography.parse("@misc{k, title = {\\''u}}", filter: ['latex'])[0].title.must_be :==, 'ü'
       end
     end
 
@@ -89,15 +84,15 @@ module BibTeX
       describe '#extend_initials' do
         it 'extends the initials in matching names' do
           @bib.names.map(&:to_s).wont_include 'Flanagan, Dave'
-          @bib.extend_initials(['Dave', 'Flanagan'])
+          @bib.extend_initials(%w[Dave Flanagan])
           @bib.names.map(&:to_s).must_include 'Flanagan, Dave'
         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, Yukihiro Segaran, Thomas",
-            @bib.extend_initials!.names.map(&:sort_order).uniq.join(' ')
+          assert_equal 'Ruby, Sam Thomas, Dave Hansson Heinemeier, David Flanagan, David Matsumoto, Yukihiro Segaran, Thomas',
+                       @bib.extend_initials!.names.map(&:sort_order).uniq.join(' ')
         end
       end
 
@@ -116,7 +111,7 @@ module BibTeX
         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
+          assert_equal %w[2007 2008], years.sort
         end
 
         it 'returns the bibliography' do
@@ -144,11 +139,11 @@ module BibTeX
       end
 
       it 'supports access by range' do
-        assert_equal %w{2008 2007}, @bib[1..2].map(&:year)
+        assert_equal %w[2008 2007], @bib[1..2].map(&:year)
       end
 
       it 'supports access by index and offset' do
-        assert_equal %w{2008 2007}, @bib[1,2].map(&:year)
+        assert_equal %w[2008 2007], @bib[1, 2].map(&:year)
       end
 
       it 'supports queries by symbol key' do
@@ -192,7 +187,6 @@ module BibTeX
         assert_nil @bib.q(:first, '@collection')
       end
 
-
       it 'supports queries by pattern' do
         assert_equal 0, @bib[/reilly/].length
         assert_equal 2, @bib[/reilly/i].length
@@ -230,7 +224,6 @@ module BibTeX
         assert_equal 0, @bib['@*[year>=2010]'].length
       end
 
-
       it 'supports queries by bibtex element' do
         entry = Entry.parse(<<-END).first
         @article{segaran2007,
@@ -258,7 +251,6 @@ module BibTeX
       end
 
       describe '#query' do
-
         it 'returns all elements when passed no arguments' do
           @bib.query.length.must_be :==, 6
         end
@@ -270,11 +262,9 @@ module BibTeX
         it 'returns all entries when passed a * wildcard' do
           @bib.query('@*').length.must_be :==, 5
         end
-
       end
 
       describe 'duplicates' do
-
         it 'understands select_duplicates_by' do
           assert_equal 1, @bib.select_duplicates_by.length
         end
@@ -282,7 +272,6 @@ module BibTeX
         it 'understands duplicates?' do
           assert @bib.duplicates?
         end
-
       end
 
       describe '#uniq!' do
@@ -320,7 +309,7 @@ module BibTeX
 
         describe 'with block' do
           it 'removes duplicate entries and returns the bibliography' do
-            assert @a.length > @a.uniq!(:author){|d,e| d+'|'+e.pages_from}.length
+            assert @a.length > @a.uniq!(:author) { |d, e| d + '|' + e.pages_from }.length
           end
         end
       end
@@ -328,7 +317,9 @@ module BibTeX
       describe 'given a filter' do
         before do
           @filter = Object.new
-          def @filter.apply (value); value.is_a?(::String) ? value.upcase : value; end
+          def @filter.apply(value)
+            value.is_a?(::String) ? value.upcase : value
+          end
         end
 
         it 'supports arbitrary conversions' do
@@ -341,11 +332,9 @@ module BibTeX
           assert_equal 'ruby, rails', @bib[:rails].keywords
           assert_equal 'RUBY', @bib[:flanagan2008].keywords
         end
-
       end
 
       describe 'sorting' do
-
         before do
           @small_bib = BibTeX.parse <<-END
         @book{flanagan2008,
@@ -372,29 +361,29 @@ module BibTeX
           year={2007},
           publisher={O'Reilly}
         }
-        END
-      end
+          END
+        end
 
         it 'can be sorted destructively' do
           @small_bib.sort!
-          @small_bib.map(&:key).must_equal [ 'segaran2007', 'flanagan2008', 'rails']
+          @small_bib.map(&:key).must_equal %w[segaran2007 flanagan2008 rails]
         end
 
         it 'can be sorted by field destructively' do
           @small_bib.sort_by! { |e| -e[:year].to_i }
-          @small_bib.map(&:key).must_equal [  'rails', 'flanagan2008', 'segaran2007' ]
+          @small_bib.map(&:key).must_equal %w[rails flanagan2008 segaran2007]
         end
 
         it 'can be sorted non-destructively' do
           sorted_entries = @small_bib.sort
-          sorted_entries.map(&:key).must_equal [ 'segaran2007', 'flanagan2008', 'rails']
-          @small_bib.map(&:key).must_equal [  'flanagan2008', 'rails', 'segaran2007']
+          sorted_entries.map(&:key).must_equal %w[segaran2007 flanagan2008 rails]
+          @small_bib.map(&:key).must_equal %w[flanagan2008 rails segaran2007]
         end
 
         it 'can be sorted by field non-destructively' do
           sorted_entries = @small_bib.sort_by { |e| -e[:year].to_i }
-          sorted_entries.map(&:key).must_equal [  'rails', 'flanagan2008', 'segaran2007' ]
-          @small_bib.map(&:key).must_equal [  'flanagan2008', 'rails', 'segaran2007']
+          sorted_entries.map(&:key).must_equal %w[rails flanagan2008 segaran2007]
+          @small_bib.map(&:key).must_equal %w[flanagan2008 rails segaran2007]
         end
       end
 
@@ -406,7 +395,6 @@ module BibTeX
         it 'converts LaTeX umlauts' do
           @bib.convert(:latex)['rails'].keywords.must_be :==, 'rüby'
         end
-
       end
 
       describe 'BibTeXML export' do
@@ -422,13 +410,12 @@ module BibTeX
         end
 
         it 'supports exporting to extended BibTeXML' do
-          @bib.to_xml(:extended => true).write(@bibtexml, 2)
+          @bib.to_xml(extended: true).write(@bibtexml, 2)
           @bibtexml.rewind
           xml = REXML::Document.new(@bibtexml)
           xml.root.namespace.must_be :==, 'http://bibtexml.sf.net/'
           xml.root.get_elements('//bibtex:person').wont_be_empty
         end
-
       end
     end
 
@@ -439,7 +426,7 @@ module BibTeX
 
       it 'should respect options provided to initializer' do
         assert_equal(@bib.add('@article{, title = test}'), @bib)
-        assert(! @bib.entries.keys.any?(&:empty?))
+        assert(@bib.entries.keys.none?(&:empty?))
       end
     end
   end