citeproc 0.0.3 → 0.0.6

data/lib/citeproc.rb

@@ -1,10 +1,26 @@
 
 require 'multi_json'
 require 'forwardable'
+require 'observer'
+require 'uri'
 
+if ENV['DEBUG']
+  require 'ruby-debug'
+  Debugger.start
+end
 
 require 'citeproc/version'
 
+#
+# CiteProc processes bibliographic data and formats it according to a style
+# defined in CSL (Citation Style Language).
+#
+module CiteProc
+  
+  module Converters; end
+  
+end
+
 require 'citeproc/compatibility'
 require 'citeproc/extensions'
 
@@ -36,3 +52,21 @@ require 'citeproc/processor'
 require 'citeproc/utilities'
 
 CiteProc.extend CiteProc::Utilities
+
+
+CiteProc::Converters.class_eval do
+
+  # Define all converters (all classes have been loaded at this point)
+  CiteProc.constants.each do |name|
+    klass = CiteProc.const_get(name)
+  
+    if klass.instance_of?(Class) && klass.respond_to?(:create)
+      
+      define_method(name) do |obj|
+        obj.instance_of?(klass) ? obj : klass.create(obj)
+      end
+      
+    end
+  end
+  
+end

data/lib/citeproc/abbreviate.rb

@@ -1,30 +1,34 @@
 require 'multi_json'
 
 module CiteProc
-  module Abbreviate
-    
-    attr_reader :abbreviations
-    attr_accessor :default_namespace
-    
-    def abbreviations=(abbreviations)
-      @abbreviations = case abbreviations
-      when ::String
-        MultiJson.decode(abbreviations, :symbolize_keys => true)
-      when ::Hash
-       abbreviations.deep_copy
-      else raise ArgumentError, "failed to set abbreviations from #{abbreviations.inspect}"
-      end
-    end
-    
-    # call-seq:
-    # abbreviate(namespace = :default, context, word)
-    def abbreviate(*arguments)
-      raise ArgumentError, "wrong number of arguments (#{arguments.length} for 2..3)" unless (2..3).include?(arguments.length)
-      arguments.unshift(default_namespace || :default) if arguments.length < 3
-      @abbreviations.deep_fetch(*arguments)
-    end
-    
-    alias abbrev abbreviate
+	module Abbreviate
 
-  end
+		attr_accessor :namespace
+
+		def abbreviations
+			@abbreviations ||= { :default => {} }
+		end
+
+		def abbreviations=(abbreviations)
+			@abbreviations = case abbreviations
+				when ::String
+					MultiJson.decode(abbreviations, :symbolize_keys => true)
+				when ::Hash
+					abbreviations.deep_copy
+				else
+					raise ArgumentError, "failed to set abbreviations from #{abbreviations.inspect}"
+				end
+		end
+
+		# call-seq:
+		# abbreviate(namespace = :default, context, word)
+		def abbreviate(*arguments)
+			raise ArgumentError, "wrong number of arguments (#{arguments.length} for 2..3)" unless (2..3).include?(arguments.length)
+			arguments.unshift(namespace || :default) if arguments.length < 3
+			@abbreviations.deep_fetch(*arguments)
+		end
+
+		alias abbrev abbreviate
+
+	end
 end

data/lib/citeproc/assets.rb

@@ -1,66 +1,106 @@
-require 'uri'
-
 module CiteProc
-  module Asset
-    
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-    
-    attr_accessor :asset
-    
-    alias to_s asset
 
-    def inspect
-      to_s.inspect
-    end
-    
-    module ClassMethods
-      
-      attr_accessor :root, :extension, :prefix
-      
-      def load(asset)
-        instance = new
-        case
-        when File.exists?(asset)
-          instance.asset = read(asset)
-        when File.exists?(File.join(root.to_s, extend_name(asset)))
-          instance.asset = read(File.join(root.to_s, extend_name(asset)))
-        else
-          instance.asset = asset
-        end
-        instance
-      end
-      
-      private
+	module Asset
+
+		def self.included(base)
+			base.extend(ClassMethods)
+		end
+
+		attr_reader :asset, :location
+		
+		def open?
+			!asset.nil?
+		end
+		
+		def open(input)
+			case
+			when input.respond_to?(:read)
+				@location = nil
+				@asset = input.read
+			when input.to_s =~ /^\s*</
+				@location = nil
+				@asset = input.to_s.dup
+			else
+				case
+				when File.exists?(input)
+					@location = input
+				when File.exists?(self.class.extend_name(input))
+					@location = self.class.extend_name(input)
+				when File.exists?(self.class.extend_path(input))
+					@location = self.class.extend_path(input)
+				else
+					@location = input
+				end
+
+				Kernel.open(@location, 'r:UTF-8') do |io|
+					@asset = io.read
+				end
+			end
+			
+			self
+		rescue => e
+			puts e.backtrace.join("\n")
+			raise ArgumentError, "failed to open asset #{input.inspect}: #{e.message}"
+		end
+
+		def name
+			File.basename(location, self.class.extension).sub(Regexp.new("^#{self.class.prefix}"), '')
+		end
+		
+		alias to_s asset
+
+		def inspect
+			"#<CiteProc::#{self.class.name} #{name}>"
+		end
+		
+		module ClassMethods
+
+			attr_accessor :root, :extension, :prefix
+
+			def open(path_or_name)
+				new.open(path_or_name)
+			end
+
+			def extend_path(input)
+				File.join(root.to_s, extend_name(input))
+			end
+			
+			def extend_name(input)
+				name = File.extname(input).empty? ? [input, extension].compact.join : input.to_s.dup
+				name = name.start_with?(prefix.to_s) ? name : [prefix, name].join
+				name
+			end
+
+		end
+
+	end
+
+	class Style
+		
+		include Asset
+		
+		@root = '/usr/local/share/citation-style-language/styles'.freeze
+		@extension = '.csl'.freeze
+		
+	end
 
-      def read(name)
-        io = open(name, 'r:UTF-8')
-        io.read
-      ensure
-        io.close
-      end
+	class Locale
+		
+		include Asset
+		
+		@root = '/usr/local/share/citation-style-language/locales'.freeze
+		@extension = '.xml'.freeze
+		@prefix = 'locales-'.freeze
+		
+		
+		def language
+			name.split('-')[0]
+		end
+		
+		def region
+			name.split('-')[1]
+		end
+		
+	end
 
-      def extend_name(file)
-        file = File.extname(file).empty? ? [file, extension].compact.join : file
-        file = file.start_with?(prefix.to_s) ? file : [prefix,file].join
-        file
-      end
-    end
-    
-  end
-  
-  class Style
-    include Asset
-    @root = '/usr/local/share/citation-style-language/styles'.freeze
-    @extension = '.csl'.freeze
-  end
-  
-  class Locale
-    include Asset
-    @root = '/usr/local/share/citation-style-language/locales'.freeze
-    @extension = '.xml'.freeze
-    @prefix = 'locales-'
-  end
-    
 end

data/lib/citeproc/bibliography.rb

@@ -1,180 +1,199 @@
 
 module CiteProc
 
-	# = Bibliography
-	#
-	# Typically a Bibliography is returned by the Processor. It contains a list
-	# of references and formatting options. 
-	#
-	# A Bibliography can be created from (and exported to) CiteProc JSON
-	# bibliographies; these consist of a	two-element list, composed of a
-	# JavaScript array containing certain formatting parameters, and a list of
-	# strings representing bibliography entries.
-	#
-	# == Bibliography Formatting Options
-	#
-	# :offset => 0
-	#   Some citation styles apply a label (either a number or an alphanumeric
-	#   code) to each bibliography entry, and use this label to cite
-	#   bibliography items in the main text. In the bibliography, the labels
-	#   may either be hung in the margin, or they may be set flush to the
-	#   margin, with the citations indented by a uniform amount to the right.
-	#   In the latter case, the amount of indentation needed depends on the
-	#   maximum width of any label. The :offset option gives the maximum
-	#   number of characters that appear in any label used in the
-	#   bibliography. The client that controls the final rendering of the
-	#   bibliography string should use this value to calculate and apply a
-	#   suitable indentation length.
-	#
-	# :entry_spacing => 0
-	#   An integer representing the spacing between entries in the
-	#   bibliography.
-	#
-	# :line_spacing => 0
-	#   An integer representing the spacing between the lines within each
-	#   bibliography entry.
-	#
-	# :indent => 0
-	#   The number of em-spaces to apply in hanging indents within the
-	#   bibliography.
-	#
-	# :align => false
-	#   When the second-field-align CSL option is set, this returns either
-	#   "flush" or "margin". The calling application should align text in
-	#   bibliography output as described in the CSL specification. Where
-	#   second-field-align is not set, this return value is set to false.
-	#
-	class Bibliography
+  # = Bibliography
+  #
+  # Typically a Bibliography is returned by the Processor. It contains a list
+  # of references and formatting options. 
+  #
+  # A Bibliography can be created from (and exported to) CiteProc JSON
+  # bibliographies; these consist of a  two-element list, composed of a
+  # JavaScript array containing certain formatting parameters, and a list of
+  # strings representing bibliography entries.
+  #
+  # == Bibliography Formatting Options
+  #
+  # :offset => 0
+  #   Some citation styles apply a label (either a number or an alphanumeric
+  #   code) to each bibliography entry, and use this label to cite
+  #   bibliography items in the main text. In the bibliography, the labels
+  #   may either be hung in the margin, or they may be set flush to the
+  #   margin, with the citations indented by a uniform amount to the right.
+  #   In the latter case, the amount of indentation needed depends on the
+  #   maximum width of any label. The :offset option gives the maximum
+  #   number of characters that appear in any label used in the
+  #   bibliography. The client that controls the final rendering of the
+  #   bibliography string should use this value to calculate and apply a
+  #   suitable indentation length.
+  #
+  # :entry_spacing => 0
+  #   An integer representing the spacing between entries in the
+  #   bibliography.
+  #
+  # :line_spacing => 0
+  #   An integer representing the spacing between the lines within each
+  #   bibliography entry.
+  #
+  # :indent => 0
+  #   The number of em-spaces to apply in hanging indents within the
+  #   bibliography.
+  #
+  # :align => false
+  #   When the second-field-align CSL option is set, this returns either
+  #   "flush" or "margin". The calling application should align text in
+  #   bibliography output as described in the CSL specification. Where
+  #   second-field-align is not set, this return value is set to false.
+  #
+  class Bibliography
 
-		@defaults = {
-			:offset => 0,
-			:entry_spacing => 0,
-			:line_spacing => 0,
-			:indent => 0,
-			:align => false
-		}.freeze
-		
-		
-		# citeproc-js and csl attributes are often inconsistent or difficult
-		# to use as symbols/method names, so we're using different names at the
-		# cost of making conversion to and from the json format more difficult
-		
-		@cp2rb = {
-			'maxoffset' => :offset,
-			'entryspacing' => :entry_spacing,
-			'linespacing' => :line_spacing,
-			'hangingindent' => :indent,
-			'second-field-align' => :align
-		}
-		
-		@rb2cp = @cp2rb.invert.freeze
-		@cp2rb.freeze
-		
-		class << self
-			
-			attr_reader :defaults, :cp2rb, :rb2cp
-			
-			# Create a new Bibliography from the passed-in string or array.
-			def parse(input)
-				case
-				when input.is_a?(String)
-					parse(MultiJson.decode(input))
-					
-				when input.is_a?(Array) && input.length == 2
-					options, references = input
+    @defaults = {
+      :offset => 0,
+      :entry_spacing => 0,
+      :line_spacing => 0,
+      :indent => 0,
+      :align => false
+    }.freeze
+    
+    
+    # citeproc-js and csl attributes are often inconsistent or difficult
+    # to use as symbols/method names, so we're using different names at the
+    # cost of making conversion to and from the json format more difficult
+    
+    @cp2rb = {
+      'maxoffset' => :offset,
+      'entryspacing' => :entry_spacing,
+      'linespacing' => :line_spacing,
+      'hangingindent' => :indent,
+      'second-field-align' => :align
+    }
+    
+    @rb2cp = @cp2rb.invert.freeze
+    @cp2rb.freeze
+    
+    class << self
+      
+      attr_reader :defaults, :cp2rb, :rb2cp
+      
+      # Create a new Bibliography from the passed-in string or array, or nil
+      # if the input cannot be parsed.
+      def create(input)
+        create!(input)
+      rescue
+        nil
+      end
+      
+      # Create a new Bibliography from the passed-in string or array. Raises
+      # ParseError if the input cannot be parsed.
+      def create!(input)
+        case
+        when input.is_a?(String)
+          create!(MultiJson.decode(input))
+          
+        when input.is_a?(Array) && input.length == 2
+          options, references = input
 
-					new do |b|
-						b.concat(references)
-						b.errors.concat(options.fetch('bibliography_errors', []))
-						
-						b.preamble, b.postamble = options['bibstart'], options['bibend']
-						
-						(options.keys & cp2rb.keys).each do |k|
-							b.options[cp2rb[k]] = options[k]
-						end
-					end
-				
-				else
-					raise ParseError, "failed to create Bibliography from #{input.inspect}"
-				end
-			end
-			
-		end
-		
-		include Comparable
-		include Enumerable
-				
-		extend Forwardable
+          new do |b|
+            b.concat(references)
+            b.errors.concat(options.fetch('bibliography_errors', []))
+            
+            b.prefix, b.suffix = options['bibstart'], options['bibend']
+            
+            (options.keys & cp2rb.keys).each do |k|
+              b.options[cp2rb[k]] = options[k]
+            end
+          end
+        
+        else
+          raise ParseError, "failed to create Bibliography from #{input.inspect}"
+        end
+      end
+      
+    end
+    
+    include Comparable
+    include Enumerable
+        
+    extend Forwardable
 
-		attr_reader :options, :errors, :references
+    attr_reader :options, :errors, :references
 
-		attr_accessor :preamble, :postamble
+    attr_accessor :prefix, :suffix
 
-		alias before preamble
-		alias after postamble
-		
-		def_delegators :@references, :[], :[]=, :<<, :push, :unshift, :pop,
-			:concat, :include?, :index, :length, :empty?
-		
-		def initialize(options = {})
-			@options = Bibliography.defaults.merge(options)
-			@errors, @references = [], []
-			
-			yield self if block_given?
-		end
-		
-		def initialize_copy(other)
-			@options = other.options.dup
-			@errors, @references = other.errors.dup, other.references.dup
-		end
+    # Bibliographies quack sorta like an Array
+    def_delegators :@references, :length, :empty?, :[], :include?, :index
 
-		def has_errors?
-			!errors.empty?
-		end
-		
-		alias errors? has_errors?
-		
-		def each
-			if block_given?
-				references.each(&Proc.new)
-				self
-			else
-				to_enum
-			end
-		end
-		
-		def <=>(other)
-			return nil unless other.respond_to?(:references)
-			references <=> other.references
-		end
+    # Some delegators should return self
+    [:push, :<<, :unshift, :concat].each do |m|
+      define_method(m) do |*arguments, &block|
+        references.send(m, *arguments, &block)
+        self
+      end
+    end
+    
+    
+    def initialize(options = {})
+      @options = Bibliography.defaults.merge(options)
+      @errors, @references = [], []
+      
+      yield self if block_given?
+    end
+    
+    def initialize_copy(other)
+      @options = other.options.dup
+      @errors, @references = other.errors.dup, other.references.dup
+    end
 
-		def citeproc_options
-			Hash[*options.map { |k,v|
-					[Bibliography.rb2cp[k] || k.to_s, v]
-				}.flatten]
-		end
-		
-		def to_citeproc
-			[
-				citeproc_options.merge({		
-		      'bibstart' => preamble,
-		      'bibend' => postamble,
-		      'bibliography_errors' => errors
-				}),
-				
-				references
-				
-			]
-		end
-		
-		def to_json
-			MultiJson.encode(to_citeproc)
-		end
-		
-		def inspect
-			"#<CiteProc::Bibliography @references=[#{references.length}], @errors=[#{errors.length}]>"
-		end
-		
-	end
-	
+    def has_errors?
+      !errors.empty?
+    end
+    
+    alias errors? has_errors?
+    
+    def join(connector = "\n")
+      [prefix, references.join(connector), suffix].join
+    end
+    
+    def each
+      if block_given?
+        references.each(&Proc.new)
+        self
+      else
+        to_enum
+      end
+    end
+    
+    def <=>(other)
+      return nil unless other.respond_to?(:references)
+      references <=> other.references
+    end
+
+    def citeproc_options
+      Hash[*options.map { |k,v|
+          [Bibliography.rb2cp[k] || k.to_s, v]
+        }.flatten]
+    end
+    
+    def to_citeproc
+      [
+        citeproc_options.merge({    
+          'bibstart' => prefix,
+          'bibend' => suffix,
+          'bibliography_errors' => errors
+        }),
+        
+        references
+        
+      ]
+    end
+    
+    def to_json
+      MultiJson.encode(to_citeproc)
+    end
+    
+    def inspect
+      "#<CiteProc::Bibliography @references=[#{references.length}], @errors=[#{errors.length}]>"
+    end
+    
+  end
+  
 end