bibtex-ruby 2.3.0 → 2.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Mzc1YjdjZmZiYzYyY2UxODIwZWI4YmI2NDAyYmViNWQ1ZTMwNjQyZg==
+    OGNlNGUzYjY1OWM2NDAxNDFkMTk0ZjkxMzY0NzQ4ZTRlNWM1YzZmMA==
   data.tar.gz: !binary |-
-    NGEwOTAzMzNjMDk2YTkwYTc0ODJiYWQzOTYyYzBiYjNjZjU0NjFkMg==
+    YmI4MjQxZWUwYmYzZDZjZDk0YTIxNzg1YjA5NTU2M2RmM2YzMTIzOA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZmUwOTM3YjhkY2Q1OWFmMGJkMDg1NDc3MjI4NTY0MTYzMzg5MmFhZWZlYmM4
-    MmFhZmQ5N2ViYWUyNmU2ZTI2NDgyNjFjNGViNTczOWU2ZDE1MzE0OGZkZTI0
-    OWIxOGZkNDEyODk3YzA3MTNhNzM0ZDIwOTVlNzcyNTAzZTZiZGQ=
+    NTc3NGEwZDM0Y2YzYjMwMjM5NDFkMjBkMzdjNzZiN2Y4ZTA5YWUyM2Q0M2Ex
+    NGRiYjY2YzViZjAwZjg1YWUwYmNlYWY1OTY4ZWNjNWUwNGFhY2ZlOWY3MmFh
+    ZjJjZjczMDBiNWEzYjYxOTA3ZGVjYTUyNjE3MjBmYTdkYWM5MGE=
   data.tar.gz: !binary |-
-    MTU2Y2VmZmVkOTZiMzA1NmE2N2M5YzgyOTRlYzY1OGI0MjQ2YWZmM2ZlZDI3
-    MDFmMTlkY2UzM2EyYWFmN2Q5NjQ1YWFhMmViMjNlMmJlOTlmNzY3ZWVhNDkx
-    ZWQ5YWRkZjcyZTEzMTQzODkyNTk2ZjdhNmJmZjY5ODY1MGI4ZGY=
+    YjVhNjc3YWRjNzgxNWZiNzg4YjdhMTZjY2UxNzZiZjQ0YTJiOTEyMjZkMjk5
+    MTY4NjA1NGJiNzA4NDM4ZWQzZDhjMGYyMjRmOWYzNTU2YTI5ZTgwZTk1ODMy
+    MzQ0M2JiNjVlOTY5NmNkY2Y2MmI5MTdlMWU5ZGMyNjk4M2EyNDg=

data/Gemfile.lock

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

data/History.txt

@@ -1,3 +1,8 @@
+2.3.1 / 2013-07-04
+==================
+
+* Support multiple filters in #convert methods
+
 2.3.0 / 2013-06-04
 ==================
 
@@ -7,12 +12,12 @@
 2.2.2 / 2013-15-01
 ==================
 
-* Improves Citeproc export #61 #62 (@plessl)
+* Improves CiteProc export #61 #62 (@plessl)
 
 2.2.1 / 2013-13-01
 ==================
 
-* Fixes BibTeX/Citeproc type issue (thanks to @plessl)
+* Fixes BibTeX/CiteProc type issue (thanks to @plessl)
 
 2.2.0 / 2012-12-02
 ==================

data/lib/bibtex/bibliography.rb

@@ -161,12 +161,14 @@ module BibTeX
     end
 
 
-    # Converts all enties using the given filter. If an optional block is given
+    # Converts all enties using the given filter(s). If an optional block is given
     # the block is used as a condition (the block will be called with each
     # entry). @see Entry#convert!
-    def convert (filter)
+    def convert(*filters)
+      filters = filters.flatten.map { |f| Filters.resolve!(f) }
+
       entries.each_value do |entry|
-        entry.convert!(filter) if !block_given? || yield(entry)
+        entry.convert!(*filters) if !block_given? || yield(entry)
       end
 
       self

data/lib/bibtex/entry.rb

@@ -647,18 +647,23 @@ module BibTeX
       end
     end
 
-    # Returns a duplicate entry with all values converted using the filter.
+    # Returns a duplicate entry with all values converted using the filter(s).
     # If an optional block is given, only those values will be converted where
     # the block returns true (the block will be called with each key-value pair).
     #
     # @see #convert!
-    def convert(filter)
-      block_given? ? dup.convert!(filter, &Proc.new) : dup.convert!(filter)
+    def convert(*filters)
+      block_given? ? dup.convert!(*filters, &Proc.new) : dup.convert!(*filters)
     end
 
     # In-place variant of @see #convert
-    def convert!(filter)
-      fields.each_pair { |k,v| !block_given? || yield(k,v) ? v.convert!(filter) : v }
+    def convert!(*filters)
+      filters = filters.flatten.map { |f| Filters.resolve!(f) }
+
+      fields.each_pair do |k, v|
+        (!block_given? || yield(k, v)) ? v.convert!(*filters) : v
+      end
+
       self
     end
 

data/lib/bibtex/filters.rb

@@ -3,29 +3,29 @@ require 'singleton'
 module BibTeX
   class Filter
     include Singleton
-    
+
     class << self
       # Hook called by Ruby if Filter is subclassed
       def inherited(base)
         base.class_eval { include Singleton }
         subclasses << base
       end
-    
+
       # Returns a list of all current Filters
       def subclasses
         @subclasses ||= []
       end
     end
-    
+
     def apply(value)
       value
     end
-    
+
     alias convert apply
     alias << apply
-    
+
   end
-  
+
   module Filters
     LOAD_PATH = [File.expand_path('..', __FILE__), 'filters'].join('/').freeze
 
@@ -33,6 +33,10 @@ module BibTeX
       require filter
     end
 
+    def self.resolve!(filter)
+      resolve(filter) || raise(ArgumentError, "Failed to load filter #{filter.inspect}")
+    end
+
     def self.resolve(filter)
       case
       when filter.respond_to?(:apply)
@@ -44,7 +48,7 @@ module BibTeX
         klass && klass.instance
       else
         nil
-      end      
+      end
     end
   end
 end

data/lib/bibtex/names.rb

@@ -260,17 +260,21 @@ module BibTeX
       end
     end
     
-    def convert(filter)
-      dup.convert!(filter)
+    def convert(*filters)
+      dup.convert!(*filters)
     end
     
-    def convert!(filter)
-      if f = Filters.resolve(filter)
-        each_pair { |k,v| self[k] = f.apply(v) unless v.nil? }
-      else
-        raise ArgumentError, "Failed to load filter #{filter.inspect}"
-      end
+    def convert!(*filters)
+      filters.flatten.each do |filter|
+
+        f = Filters.resolve(filter) ||
+          raise(ArgumentError, "Failed to load filter #{filter.inspect}")
 
+        each_pair do |k, v|
+          self[k] = f.apply(v) unless v.nil?
+        end
+      end
+      
       self
     end
     

data/lib/bibtex/value.rb

@@ -3,17 +3,17 @@
 #--
 # BibTeX-Ruby
 # 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/>.
 #++
@@ -48,10 +48,10 @@ module BibTeX
   class Value
     extend Forwardable
     include Comparable
-    
+
     attr_reader :tokens
     alias to_a tokens
-    
+
     def_delegators :to_s, :=~, :===, *String.instance_methods(false).reject { |m| m =~ /^\W|^length$|^dup$|!$/ }
     def_delegators :@tokens, :[], :length
     def_delegator :@tokens, :each, :each_token
@@ -65,27 +65,27 @@ module BibTeX
     def self.create(*args)
       args[0].class < Value && args.size == 1 ? args[0].dup : Value.new(args)
     end
-    
+
     def initialize(*arguments)
       @tokens = []
       arguments.flatten.compact.each do |argument|
         add(argument)
       end
     end
-    
+
     def initialize_copy(other)
       @tokens = other.tokens.dup
     end
-    
+
     def merge(other)
       dup.merge!(other)
     end
-    
+
     def merge!(other)
       other.tokens.each do |token|
         add token unless include_token?(token)
       end
-      
+
       self
     end
 
@@ -110,10 +110,10 @@ module BibTeX
       end
       self
     end
-    
+
     alias << add
     alias push add
-    
+
     [:strip!, :upcase!, :downcase!, :sub!, :gsub!, :chop!, :chomp!, :rstrip!].each do |method_id|
       define_method(method_id) do |*arguments, &block|
         tokens.each do |part|
@@ -122,7 +122,7 @@ module BibTeX
         self
       end
     end
-    
+
     def replace(*arguments)
       return self unless has_symbol?
       arguments.flatten.each do |argument|
@@ -157,7 +157,7 @@ module BibTeX
       end
       self
     end
-    
+
     # call-seq:
     #   Value.new('foo').to_s                       #=> "foo"
     #   Value.new(:foo).to_s                        #=> "foo"
@@ -189,34 +189,34 @@ module BibTeX
     def value
       atomic? ? @tokens[0] : @tokens.map { |v|  v.is_a?(::String) ? v.inspect : v }.join(' # ')
     end
-    
+
     alias :v :value
 
     def inspect
       "#<#{self.class} #{tokens.map(&:inspect).join(', ')}>"
     end
-    
+
     # Returns true if the Value is empty or consists of a single token.
     def atomic?
       @tokens.length < 2
     end
-    
-    # Returns true if the value is a BibTeX name value. 
+
+    # Returns true if the value is a BibTeX name value.
     def name?; false; end
-    
+
     alias :names? :name?
-    
+
     def to_name
       Names.parse(to_s)
     end
-    
+
     alias to_names to_name
 
-    # Returns true if the Value's content is a date.    
+    # Returns true if the Value's content is a date.
     def date?
       !to_date.nil?
     end
-    
+
     # Returns the string as a date.
     def to_date
       require 'date'
@@ -224,44 +224,43 @@ module BibTeX
     rescue
       nil
     end
-        
+
     # Returns true if the Value's content is numeric.
     def numeric?
       to_s =~ /^\s*[+-]?\d+[\/\.]?\d*\s*$/
     end
-        
+
     def to_citeproc (options = {})
       to_s(options)
     end
-    
+
     # Returns true if the Value contains at least one symbol.
     def symbol?
       tokens.detect { |v| v.is_a?(Symbol) }
     end
-    
+
     alias has_symbol? symbol?
-    
+
     # Returns all symbols contained in the Value.
     def symbols
       tokens.select { |v| v.is_a?(Symbol) }
     end
-    
-    # Returns a new Value with all string values converted according to the given filter.
-    def convert (filter)
-      dup.convert!(filter)
+
+    # Returns a new Value with all string values converted according to the given filter(s).
+    def convert (*filters)
+      dup.convert!(*filters)
     end
-    
-    # Converts all string values according to the given filter.
-    def convert! (filter)
-      if f = Filters.resolve(filter)
+
+    # Converts all string values according to the given filter(s).
+    def convert! (*filters)
+      filters.flatten.each do |filter|
+        f = Filters.resolve!(filter)
         tokens.map! { |t| f.apply(t) }
-      else
-        raise ArgumentError, "Failed to load filter #{filter.inspect}"
       end
-      
+
       self
     end
-    
+
     def method_missing (name, *args)
       case
       when name.to_s =~ /^(?:convert|from)_([a-z]+)(!)?$/
@@ -270,15 +269,15 @@ module BibTeX
         super
       end
     end
-    
+
     def respond_to? (method)
       method =~ /^(?:convert|from)_([a-z]+)(!)?$/ || super
     end
-        
+
     def <=> (other)
       to_s <=> other.to_s
     end
-    
+
   end
 
 end

data/lib/bibtex/version.rb

@@ -20,7 +20,7 @@ module BibTeX
   module Version    
     MAJOR = 2
     MINOR = 3
-    PATCH = 0
+    PATCH = 1
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.').freeze

data/test/bibtex/test_entry.rb

@@ -269,21 +269,30 @@ module BibTeX
         assert_equal 'Melville', e['author'][0]['family']
       end
 
-      describe 'given a filter' do
+      describe 'given a filter object or a filter name' do
         before do
           @filter = Object.new
           def @filter.apply (value); value.is_a?(::String) ? value.upcase : value; end
+          
+          class SuffixB < BibTeX::Filter
+            def apply(value)
+              value.is_a?(::String) ? "#{value}b" : value
+            end
+          end
         end
 
         it 'supports arbitrary conversion' do
-          e = @entry.convert(@filter)
-          assert_equal 'MOBY DICK', e.title
-          assert_equal 'Moby Dick', @entry.title
+          @entry.convert(@filter).title.must_equal 'MOBY DICK'
+          @entry.convert(:suffixb).title.must_equal 'Moby Dickb'
+        end
+
+        it 'supports multiple filters' do
+          @entry.convert(@filter, :suffixb).title.must_equal 'MOBY DICKb'
+          @entry.convert(:suffixb, @filter).title.must_equal 'MOBY DICKB'
         end
 
         it 'supports arbitrary in-place conversion' do
-          @entry.convert!(@filter)
-          assert_equal 'MOBY DICK', @entry.title
+          @entry.convert!(@filter).title.must_equal 'MOBY DICK'
         end
 
         it 'supports conditional arbitrary in-place conversion' do

data/test/bibtex/test_value.rb

@@ -98,6 +98,13 @@ module BibTeX
             value.is_a?(::String) ? value.upcase : value
           end
         end
+        
+        class SuffixA < BibTeX::Filter
+          def apply(value)
+            value.is_a?(::String) ? "#{value}a" : value
+          end
+        end
+        
         @values = [Value.new('foo'), Value.new('foo', :bar)]
       end
 
@@ -113,6 +120,12 @@ module BibTeX
         it "converts the value when given the name of a filter" do
           assert_equal ['FOO', '"FOO" # bar'], @values.map { |v| v.convert(:upcase).to_s }
           assert_equal ['FOO', '"FOO" # bar'], @values.map { |v| v.convert('upcase').to_s }
+          assert_equal ['fooa', '"fooa" # bar'], @values.map { |v| v.convert('suffixa').to_s }
+        end
+
+        it "applies multiple filters in the order passed" do
+          @values.map { |v| v.convert(:upcase, :suffixa).to_s }.must_equal ['FOOa', '"FOOa" # bar']
+          @values.map { |v| v.convert(:suffixa, :upcase).to_s }.must_equal ['FOOA', '"FOOA" # bar']
         end
 
         it "converts the value when using a ghost method" do
@@ -128,6 +141,16 @@ module BibTeX
           @values.each { |v| v.convert_upcase }
           assert_equal ['foo', '"foo" # bar'], @values.map(&:to_s)
         end
+        
+        it "raises argument error when a filter cannot be resolved" do
+          assert_raises ArgumentError do
+            @values[0].convert(:foo)
+          end
+
+          assert_raises ArgumentError do
+            @values[0].convert(:upcase, :foo)
+          end
+        end
       end
 
       describe "#convert!" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bibtex-ruby
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-06 00:00:00.000000000 Z
+date: 2013-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: latex-decode