bibtex-ruby 1.3.7 → 1.3.8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bibtex-ruby (1.3.7)
+    bibtex-ruby (1.3.8)
 
 GEM
   remote: http://rubygems.org/

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.3.8 / 2011-07-05
+
+* Added a converter-plugin framework
+
 === 1.3.7 / 2011-06-30
 
 * Added option to toggle dropping/non-dropping behaviour of 'von' parts

data/Manifest

@@ -39,6 +39,9 @@ lib/bibtex/elements.rb
 lib/bibtex/entry.rb
 lib/bibtex/error.rb
 lib/bibtex/extensions.rb
+lib/bibtex/filters
+lib/bibtex/filters/latex.rb
+lib/bibtex/filters.rb
 lib/bibtex/lexer.rb
 lib/bibtex/name_parser.output
 lib/bibtex/name_parser.rb
@@ -57,6 +60,7 @@ test/bibtex
 test/bibtex/test_bibliography.rb
 test/bibtex/test_elements.rb
 test/bibtex/test_entry.rb
+test/bibtex/test_filters.rb
 test/bibtex/test_lexer.rb
 test/bibtex/test_name_parser.rb
 test/bibtex/test_names.rb

data/lib/bibtex.rb

@@ -54,6 +54,7 @@ end
 
 require 'bibtex/extensions'
 require 'bibtex/value'
+require 'bibtex/filters'
 require 'bibtex/name_parser'
 require 'bibtex/names'
 require 'bibtex/replaceable'

data/lib/bibtex/bibliography.rb

@@ -47,10 +47,11 @@ module BibTeX
       #
       # -:parse_names: set to false to disable automatic name parsing
       # -:parse_months: set to false to disable automatic month conversion
+      # -:filter: convert all entries using the sepcified filter (not set by default)
       #
       def open(path, options = {})
         b = parse(Kernel.open(path).read, options)
-        return b unless !b.nil? and block_given?
+        return b unless block_given?
 
         begin
           yield b
@@ -61,7 +62,7 @@ module BibTeX
 
       # Parses the given string and returns a corresponding Bibliography instance.
       def parse(bibtex, options = {})
-        Parser.new(options).parse(bibtex)
+        Parser.new(options).parse(bibtex) || Bibliography.new(options)
       end
       
       #
@@ -119,15 +120,22 @@ module BibTeX
     end
     
     def parse_names
-      @entries.values.each { |e| e.parse_names }
+      @entries.each_value { |e| e.parse_names }
       self
     end
     
     def parse_months
-      @entries.values.each { |e| e.parse_month }
+      @entries.each_value { |e| e.parse_month }
       self
     end
     
+    # Converts all enties using the given filter. 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)
+      @entries.each_value { |e| e.convert!(filter) if !block_given? || yield(e) }
+    end
+    		
     #
     # Deletes an object, or a list of objects from the bibliography.
     # If a list of objects is to be deleted, you can either supply the list

data/lib/bibtex/entry.rb

@@ -117,6 +117,15 @@ module BibTeX
 			yield self if block_given?
 		end
 
+    def initialize_copy (other)
+      @fields = {}
+      
+      self.type = other.type
+      self.key = other.key
+      
+      add(other.fields)
+    end
+    
 		# Sets the key of the entry
 		def key=(key)
 			raise(ArgumentError, "keys must be convertible to Symbol; was: #{type.class.name}.") unless type.respond_to?(:to_sym)
@@ -133,8 +142,8 @@ module BibTeX
 		  @key ||= default_key
 		end
 
-		alias :id :key		
-		alias :id= :key=
+		alias id key		
+		alias id= key=
 		
 		# Sets the type of the entry.
 		def type=(type)
@@ -150,14 +159,15 @@ module BibTeX
       @fields.has_key?(field)
     end
     
-		def method_missing(name, *args)
+		def method_missing(name, *args, &block)
 		  return self[name] if @fields.has_key?(name)
 		  return self.send(:add, name.to_s.chop.to_sym, args[0]) if name.to_s.match(/=$/)		  
+      return $2 ? convert!($1, &block) : convert($1, &block) if name =~ /^(?:convert|from)_([a-z]+)(!)?$/
 		  super
 		end
 		
 		def respond_to?(method)
-		  @fields.has_key?(method.to_sym) || method.to_s.match(/=$/) || super
+		  @fields.has_key?(method.to_sym) || method.to_s.match(/=$/) || method =~ /^(?:convert|from)_([a-z]+)(!)?$/ || super
 		end
 		
 		# Returns a copy of the Entry with all the field names renamed.
@@ -207,7 +217,7 @@ module BibTeX
 			self
 		end
 		
-		alias :<< :add
+		alias << add
 
 		# Removes the field with a given name from the entry.
 		# Returns the value of the deleted field; nil if the field was not set.
@@ -229,6 +239,7 @@ module BibTeX
 			bibliography.entries[key] = self
 			parse_names if bibliography.options[:parse_names]
 			parse_months if bibliography.options[:parse_months]
+			convert(bibliography.options[:filter]) if bibliography.options[:filter]
 			self
 		end
 				
@@ -259,7 +270,7 @@ module BibTeX
       self
     end
     
-    alias :parse_months :parse_month
+    alias parse_months parse_month
     
     # Parses all name values of the entry. Tries to replace and join the
     # value prior to parsing.
@@ -309,7 +320,7 @@ module BibTeX
 		  { 'date-parts' => [[@fields[:year],m].compact.map(&:to_i)] }
 		end
 		
-		alias :citeproc_date :issued
+		alias citeproc_date issued
 		
 		def to_xml(options = {})
 		  require 'rexml/document'
@@ -324,6 +335,22 @@ module BibTeX
       xml
 		end
 		
+		# Returns a duplicate entry with all values converted using the filter.
+		# 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)
+		end
+		
+		# In-place variant of @see convert
+		def convert! (filter)
+		  @fields.each_pair { |k,v| !block_given? || yield(k,v) ? v.convert!(filter) : v }
+		  self
+		end
+		
 		def <=>(other)
 		  type != other.type ? type <=> other.type : key != other.key ? key <=> other.key : to_s <=> other.to_s
 		end

data/lib/bibtex/filters.rb

@@ -0,0 +1,49 @@
+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
+
+    Dir.glob("#{LOAD_PATH}/*.rb").each do |filter|
+      require filter
+    end
+
+    def self.resolve (filter)
+      case
+      when filter.respond_to?(:apply)
+        filter
+      when filter.respond_to?(:to_s)
+        klass = Filter.subclasses.detect do |c|
+          c.name == filter.to_s || c.name.split(/::/)[-1] =~ /^#{filter}$/i
+        end
+        klass && klass.instance
+      else
+        nil
+      end      
+    end
+  end
+end
+

data/lib/bibtex/filters/latex.rb

@@ -0,0 +1,13 @@
+# require 'latex/decode'
+#  
+# module BibTeX
+#   module Filters
+#     
+#     class LaTeX < Filter
+#       def apply (value)
+#         LaTeX.decode(value)
+#       end
+#     end
+#     
+#   end
+# end

data/lib/bibtex/value.rb

@@ -1,3 +1,5 @@
+# -*- coding: utf-8 -*-
+
 #--
 # BibTeX-Ruby
 # Copyright (C) 2010-2011  Sylvester Keil <sylvester.keil.or.at>
@@ -48,7 +50,7 @@ module BibTeX
     include Comparable
     
     attr_reader :tokens
-    alias :to_a :tokens
+    alias to_a tokens
     
     def_delegators :to_s, :empty?, :=~, :match, :intern, :to_sym, :to_i, :to_f, :end_with?, :start_with?, :include?, :upcase, :downcase, :reverse, :chop, :chomp, :rstrip, :gsub, :sub, :size, :strip, :succ, :to_c, :to_r, :to_str, :split, :each_byte, :each_char, :each_line
     def_delegators :@tokens, :[], :length
@@ -82,8 +84,8 @@ module BibTeX
       self
     end
     
-    alias :<< :add
-    alias :push :add
+    alias << add
+    alias push add
     
     [:strip!, :upcase!, :downcase!, :sub!, :gsub!, :chop!, :chomp!, :rstrip!].each do |method_id|
       define_method(method_id) do |*arguments, &block|
@@ -128,6 +130,9 @@ module BibTeX
     # If the Value is atomic and the option :quotes is given, the string
     # will be quoted using the quote symbols specified.
     #
+    # If the option :filter is given, the Value will be converted using
+    # the filter(s) specified.
+    #
     # call-seq:
     # Value.new('foo').to_s                       #=> "foo"
     # Value.new(:foo).to_s                        #=> "foo"
@@ -136,8 +141,10 @@ module BibTeX
     # Value.new('foo').to_s(:quotes => ['{','}']) #=> "{foo}"
     # Value.new(:foo, 'bar').to_s                 #=> "foo # \"bar\""
     # Value.new('foo', 'bar').to_s                #=> "\"foo\" # \"bar\""
+    # Value.new('\"u').to_s(:filter => :latex)    #=> "ü"
     #
     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?
       *q = options[:quotes]
       [q[0], value, q[-1]].compact.join
@@ -172,13 +179,13 @@ module BibTeX
       Names.parse(to_s)
     end
     
-    alias :to_names :to_name
+    alias to_names to_name
 
     # Returns true if the Value's content looks like a date.    
     def date?
     end
 
-    alias :is_date? :date?
+    alias is_date? date?
     
     # Returns the string as a citeproc date. TODO use edtf format instead.
     def to_date
@@ -190,9 +197,9 @@ module BibTeX
       to_s =~ /^\s*[+-]?\d+[\/\.]?\d*\s*$/
     end
     
-    alias :is_numeric? :numeric?
+    alias is_numeric? numeric?
     
-    def to_citeproc(options = {})
+    def to_citeproc (options = {})
       to_s(options)
     end
     
@@ -201,14 +208,45 @@ module BibTeX
       @tokens.detect { |v| v.is_a?(Symbol) }
     end
     
-    alias :has_symbol? :symbol?
+    alias has_symbol? symbol?
     
     # Returns all symbols contained in the Value.
     def symbols
       @tokens.select { |v| v.is_a?(Symbol) }
     end
     
-    def <=>(other)
+    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)
+    end
+    
+    # Converts all string values according to the given filter.
+    def convert! (filter)
+      f = Filters.resolve(filter)
+
+      unless f
+        message = "Failed to load filter #{f.inspect}"
+        Log.error message
+        raise ArgumentError.new(message)
+      end
+      
+      @tokens.map! { |t| f.apply(t) }
+      self
+    end
+    
+    def method_missing (name, *args)
+      return $2 ? convert!($1) : convert($1) if name =~ /^(?:convert|from)_([a-z]+)(!)?$/
+		  super
+		end
+		
+		def respond_to? (method)
+		  method =~ /^(?:convert|from)_([a-z]+)(!)?$/ || super
+		end
+		
+    
+    def <=> (other)
       to_s <=> other.to_s
     end
     

data/lib/bibtex/version.rb

@@ -18,6 +18,6 @@
 
 module BibTeX
   module Version
-    STRING = '1.3.7'.freeze
+    STRING = '1.3.8'.freeze
   end
 end

data/test/bibtex/test_bibliography.rb

@@ -135,6 +135,25 @@ module BibTeX
         assert_equal @bib, BibTeX.open(tmp.path)
       end
       
+      context 'given a filter' do
+        setup do
+          @filter = Object
+          def @filter.apply (value); value.is_a?(::String) ? value.upcase : value; end
+        end
+          
+        should 'support arbitrary conversions' do
+          @bib.convert(@filter)
+          assert_equal 'RUBY, RAILS', @bib[:rails].keywords
+        end
+        
+        should 'support conditional arbitrary conversions' do
+          @bib.convert(@filter) { |e| e.key != :rails }
+          assert_equal 'ruby, rails', @bib[:rails].keywords
+          assert_equal 'RUBY', @bib[:flanagan2008].keywords
+        end
+        
+      end
+      
     end
     
     

data/test/bibtex/test_entry.rb

@@ -40,7 +40,6 @@ module BibTeX
       end
       
     end
-    
 
     context 'given an entry' do
       setup do
@@ -57,11 +56,25 @@ module BibTeX
         end
       end
       
-      should 'support renaming of field attributes' do
-        @entry.rename(:title => :foo)
+      should 'support renaming! of field attributes' do
+        @entry.rename!(:title => :foo)
         refute @entry.has_field?(:title)
         assert_equal 'Moby Dick', @entry[:foo]
       end
+
+      should 'support renaming of field attributes' do
+        e = @entry.rename(:title => :foo)
+
+        assert @entry.has_field?(:title)
+        refute @entry.has_field?(:foo)
+
+        assert e.has_field?(:foo)
+        refute e.has_field?(:title)
+        
+        assert_equal 'Moby Dick', @entry[:title]
+        assert_equal 'Moby Dick', e[:foo]
+      end
+
       
       should 'support citeproc export' do
         e = @entry.to_citeproc
@@ -72,6 +85,39 @@ module BibTeX
         assert_equal 'Herman', e['author'][0]['given']
         assert_equal 'Melville', e['author'][0]['family']
       end
+      
+      context 'given a filter' do
+        setup do
+          @filter = Object.new
+          def @filter.apply (value); value.is_a?(::String) ? value.upcase : value; end
+        end
+        
+        should 'support arbitrary conversion' do
+          e = @entry.convert(@filter)
+          assert_equal 'MOBY DICK', e.title
+          assert_equal 'Moby Dick', @entry.title
+        end
+
+        should 'support arbitrary in-place conversion' do
+          @entry.convert!(@filter)
+          assert_equal 'MOBY DICK', @entry.title
+        end
+
+        should 'support conditional arbitrary in-place conversion' do
+          @entry.convert!(@filter) { |k,v| k.to_s =~ /publisher/i  }
+          assert_equal 'Moby Dick', @entry.title
+          assert_equal 'PENGUIN', @entry.publisher
+        end
+
+        should 'support conditional arbitrary conversion' do
+          e = @entry.convert(@filter) { |k,v| k.to_s =~ /publisher/i  }
+          assert_equal 'Moby Dick', e.title
+          assert_equal 'PENGUIN', e.publisher
+          assert_equal 'Penguin', @entry.publisher
+        end
+        
+      end
+      
     end
 
     context 'citeproc export' do

data/test/bibtex/test_filters.rb

@@ -0,0 +1,37 @@
+require 'helper.rb'
+
+module BibTeX
+  class FiltersTest < MiniTest::Spec
+    
+    should "Filters should be singleton classes" do
+      assert_equal false, Filter.respond_to?(:new)
+      assert_equal Filter.instance.object_id, Filter.instance.object_id
+    end
+    
+    context 'Filters.resolve' do
+      should "return the filter if a filter is given" do
+        assert_equal Filter.instance.object_id, Filters.resolve(Filter.instance).object_id
+      end
+
+      should "return the parameter if it quacks like a filter" do
+        f = Object.new
+        def f.apply; nil; end
+        assert_equal f.object_id, Filters.resolve(f).object_id
+      end
+
+      should "return the filter if there is a filter by that name" do
+        class FooBar < Filter; end
+        assert_equal FooBar.instance.object_id, Filters.resolve(:foobar).object_id
+        assert_equal FooBar.instance.object_id, Filters.resolve('foobar').object_id
+        Filter.subclasses.delete(FooBar)
+      end
+      
+      should "return nil if there is no filter by that name" do
+        assert_equal nil, Filters.resolve(:foobar)
+        assert_equal nil, Filters.resolve('foobar')
+        assert_equal nil, Filters.resolve(nil)
+      end
+    end
+    
+  end
+end

data/test/bibtex/test_value.rb

@@ -66,5 +66,70 @@ module BibTeX
         assert_equal '"foo" # bar', Value.new('foo', :bar).to_s
       end
     end
+    
+    context "conversions" do
+      setup do
+        class Upcase < BibTeX::Filter
+          def apply (value)
+            value.is_a?(::String) ? value.upcase : value
+          end
+        end
+        @values = [Value.new('foo'), Value.new('foo', :bar)]
+      end
+      
+      context "#convert" do
+        should "convert the value when given a filter instance" do
+          assert_equal ['FOO', '"FOO" # bar'], @values.map { |v| v.convert(Upcase.instance).to_s }
+        end
+
+        should "convert the value when given a filter class" do
+          assert_equal ['FOO', '"FOO" # bar'], @values.map { |v| v.convert(Upcase).to_s }
+        end
+
+        should "convert 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 }
+        end
+
+        should "convert the value when using a ghost method" do
+          assert_equal ['FOO', '"FOO" # bar'], @values.map { |v| v.convert_upcase.to_s }
+        end
+        
+        should "not alter the value when using a filter name" do
+          @values.each { |v| v.convert(:upcase) }
+          assert_equal ['foo', '"foo" # bar'], @values.map(&:to_s)
+        end
+
+        should "not alter the value when using a ghost method" do
+          @values.each { |v| v.convert_upcase }
+          assert_equal ['foo', '"foo" # bar'], @values.map(&:to_s)
+        end
+      end
+      
+      context "#convert!" do
+        should "convert the value when given the name of a filter" do
+          assert_equal ['FOO', '"FOO" # bar'], @values.map { |v| v.convert!(:upcase).to_s }
+        end
+        
+        should "alter the value when given the name of a filter" do
+          @values.each { |v| v.convert!(:upcase) }
+          assert_equal ['FOO', '"FOO" # bar'], @values.map(&:to_s)
+        end
+
+        should "alter the value when using a ghost method" do
+          @values.each { |v| v.convert_upcase! }
+          assert_equal ['FOO', '"FOO" # bar'], @values.map(&:to_s)
+        end
+        
+      end
+      
+      context "#to_s" do
+        should 'accept a :filter option and convert the values accordingly without changing the value' do
+          assert_equal '"FOO" # bar', @values[1].to_s(:filter => :upcase)
+          assert_equal '"foo" # bar', @values[1].to_s
+        end
+      end
+    end
+    
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: bibtex-ruby
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.3.7
+  version: 1.3.8
 platform: ruby
 authors: 
 - Sylvester Keil
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-30 00:00:00 +02:00
+date: 2011-07-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -165,6 +165,8 @@ files:
 - lib/bibtex/entry.rb
 - lib/bibtex/error.rb
 - lib/bibtex/extensions.rb
+- lib/bibtex/filters/latex.rb
+- lib/bibtex/filters.rb
 - lib/bibtex/lexer.rb
 - lib/bibtex/name_parser.output
 - lib/bibtex/name_parser.rb
@@ -181,6 +183,7 @@ files:
 - test/bibtex/test_bibliography.rb
 - test/bibtex/test_elements.rb
 - test/bibtex/test_entry.rb
+- test/bibtex/test_filters.rb
 - test/bibtex/test_lexer.rb
 - test/bibtex/test_name_parser.rb
 - test/bibtex/test_names.rb
@@ -224,7 +227,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3039077610417701704
+      hash: -4114590851027997026
       segments: 
       - 0
       version: "0"
@@ -245,6 +248,7 @@ test_files:
 - test/bibtex/test_bibliography.rb
 - test/bibtex/test_elements.rb
 - test/bibtex/test_entry.rb
+- test/bibtex/test_filters.rb
 - test/bibtex/test_lexer.rb
 - test/bibtex/test_name_parser.rb
 - test/bibtex/test_names.rb