bibtex-ruby 1.3.8 → 1.3.9

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    bibtex-ruby (1.3.8)
+    bibtex-ruby (1.3.9)
+      latex-decode (>= 0.0.1)
 
 GEM
   remote: http://rubygems.org/
@@ -10,19 +11,21 @@ GEM
     autowatchr (0.1.5)
       watchr
     builder (3.0.0)
-    columnize (0.3.2)
-    cucumber (0.10.6)
+    columnize (0.3.3)
+    cucumber (1.0.0)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
-      gherkin (~> 2.4.0)
+      gherkin (~> 2.4.1)
       json (>= 1.4.6)
       term-ansicolor (>= 1.0.5)
     diff-lcs (1.1.2)
-    gherkin (2.4.0)
+    gherkin (2.4.1)
       json (>= 1.4.6)
     gnuplot (2.3.6)
-    json (1.5.1)
-    linecache (0.43)
+    json (1.5.3)
+    latex-decode (0.0.1)
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
     linecache19 (0.5.12)
       ruby_core_source (>= 0.1.4)
     mini_shoulda (0.3.0)
@@ -32,7 +35,8 @@ GEM
       term-ansicolor (>= 1.0.4)
     racc (1.4.6)
     rake (0.9.2)
-    rdoc (3.6.1)
+    rbx-require-relative (0.0.5)
+    rdoc (3.8)
     ruby-debug (0.10.4)
       columnize (>= 0.1)
       ruby-debug-base (~> 0.10.4.0)

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.3.9 / 2011-07-05
+
+* Added a LaTeX input filter
+
 === 1.3.8 / 2011-07-05
 
 * Added a converter-plugin framework

data/Manifest

@@ -17,6 +17,7 @@ features/bibtex.feature
 features/entries.feature
 features/issues
 features/issues/braced_strings.feature
+features/issues/latex_filter.feature
 features/issues/number_keys.feature
 features/issues/parse_months.feature
 features/issues/slash_keys.feature

data/README.md

@@ -256,6 +256,34 @@ are parsed and can easily be mapped to their last names:
        END
     => ["Hawthorne", "Melville"]
 
+### Filters
+
+Since version 1.3.8 BibTeX-Ruby comes with a plugin framework for input
+filters. You can use the methods `convert` and `convert!` methods if `Value`,
+`Entry` and `Bibliography` instances to easily convert string values according
+to a given filter. Starting with version 1.3.9 BibTeX-Ruby includes a
+LaTeX filter that depends on the
+[latex-decode gem](http://rubygems.org/gems/latex-decode). Example:
+
+    >> faust = '@book{faust, title = {Faust: Der Trag\"odie Erster Teil}}'
+    >> BibTeX.parse(faust).convert(:latex)[:faust].title
+    => "Faust: Der Tragödie Erster Teil"
+
+Conditional conversions are also supported:
+
+    >> faust1 = '@book{faust1, title = {Faust: Der Trag\"odie Erster Teil}}'
+    >> faust2 = '@book{faust2, title = {Faust: Der Trag\"odie Zweiter Teil}}'
+    >> p BibTeX.parse(faust1 + faust2).convert(:latex) { |e| e.key == :faust2 }.to_s
+		@book{faust1,
+		  title = {Faust: Der Trag\"odie Erster Teil}
+		}
+		@book{faust2,
+		  title = {Faust: Der Tragödie Zweiter Teil}
+		}
+
+If you need to express a condition on the basis of individual fields, use the
+conversion methods of BibTeX::Entry with a block instead (the block will be
+passed the key and value of each field prior to conversion).
 
 ### Conversions
 

data/bibtex-ruby.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = '>= 1.3.6'
   s.rubyforge_project = s.name
 
+  s.add_runtime_dependency('latex-decode', ['>= 0.0.1'])
+
   s.add_development_dependency('rake', ['>= 0.8'])
   s.add_development_dependency('racc', ['>= 1.4'])
   s.add_development_dependency('mini_shoulda', ['>= 0.3'])

data/features/issues/latex_filter.feature

@@ -0,0 +1,18 @@
+Feature: Parse BibTeX files and convert LaTeX to Unicode
+	As a hacker who works with bibliographies
+	I want to be able to parse BibTeX files containing LaTeX strings and
+	convert them to Unicode
+
+	@latex
+	Scenario: A BibTeX file containing a LaTeX umlaut
+		When I parse the following file:
+		"""
+		@misc{issue16,
+		  author = {rbq},
+		  title  = {An umlaut: \"u!},
+		  year   = 2011,
+		}
+		"""
+		Then my bibliography should contain an entry with key "issue16"
+		When I convert all entries using the filter "latex"
+		Then the entry with key "issue16" should have a field "title" with the value "An umlaut: ü!"

data/features/step_definitions/bibtex_steps.rb

@@ -26,6 +26,9 @@ When /^I replace and join all strings(?: in my bibliography)$/ do
   @bibliography.replace_strings.join_strings
 end
 
+When /^I convert all entries using the filter "([^"]*)"$/ do |filter|
+  @bibliography.convert(filter)
+end
 
 
 Then /^my bibliography should contain the following objects:$/ do |table|
@@ -85,4 +88,8 @@ end
 
 Then /^the string "([^"]*)" should be "([^"]*)"$/ do |key, value|
   assert_equal value, @bibliography.strings[key.to_sym].v.to_s
+end
+
+Then /^the entry with key "([^"]*)" should have a field "([^"]*)" with the value "([^"]*)"$/ do |key, field, value|
+  assert_equal value, @bibliography[key.to_sym][field.to_sym].to_s
 end

data/lib/bibtex/bibliography.rb

@@ -134,6 +134,7 @@ module BibTeX
     # entry). @see Entry#convert!
     def convert (filter)
       @entries.each_value { |e| e.convert!(filter) if !block_given? || yield(e) }
+      self
     end
     		
     #

data/lib/bibtex/filters/latex.rb

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

data/lib/bibtex/version.rb

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

metadata

@@ -2,7 +2,7 @@
 name: bibtex-ruby
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.3.8
+  version: 1.3.9
 platform: ruby
 authors: 
 - Sylvester Keil
@@ -14,8 +14,19 @@ date: 2011-07-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: latex-decode
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -23,10 +34,10 @@ dependencies:
         version: "0.8"
   type: :development
   prerelease: false
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: racc
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -34,10 +45,10 @@ dependencies:
         version: "1.4"
   type: :development
   prerelease: false
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: mini_shoulda
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -45,10 +56,10 @@ dependencies:
         version: "0.3"
   type: :development
   prerelease: false
-  version_requirements: *id003
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: mynyml-redgreen
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -56,10 +67,10 @@ dependencies:
         version: "0.7"
   type: :development
   prerelease: false
-  version_requirements: *id004
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: autowatchr
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -67,10 +78,10 @@ dependencies:
         version: "0.1"
   type: :development
   prerelease: false
-  version_requirements: *id005
+  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   name: cucumber
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -78,10 +89,10 @@ dependencies:
         version: "0.10"
   type: :development
   prerelease: false
-  version_requirements: *id006
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: json
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -89,10 +100,10 @@ dependencies:
         version: "1.5"
   type: :development
   prerelease: false
-  version_requirements: *id007
+  version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   name: ruby-prof
-  requirement: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -100,10 +111,10 @@ dependencies:
         version: "0.10"
   type: :development
   prerelease: false
-  version_requirements: *id008
+  version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   name: gnuplot
-  requirement: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -111,10 +122,10 @@ dependencies:
         version: "2.3"
   type: :development
   prerelease: false
-  version_requirements: *id009
+  version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   name: rdoc
-  requirement: &id010 !ruby/object:Gem::Requirement 
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -122,7 +133,7 @@ dependencies:
         version: "3.6"
   type: :development
   prerelease: false
-  version_requirements: *id010
+  version_requirements: *id011
 description: A (fairly complete) BibTeX library and parser written in Ruby. Includes a name parser and supports regular BibTeX entries, @comments, string replacement via @string. Allows for easy export/conversion to formats such as YAML, JSON, and XML.
 email: http://sylvester.keil.or.at
 executables: []
@@ -147,6 +158,7 @@ files:
 - features/bibtex.feature
 - features/entries.feature
 - features/issues/braced_strings.feature
+- features/issues/latex_filter.feature
 - features/issues/number_keys.feature
 - features/issues/parse_months.feature
 - features/issues/slash_keys.feature
@@ -227,7 +239,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -4114590851027997026
+      hash: 2367743903630420638
       segments: 
       - 0
       version: "0"