citeproc 1.0.0.pre12 → 1.0.0

data/lib/citeproc/date.rb

@@ -200,6 +200,7 @@ module CiteProc
 
     include Attributes
 
+
     alias attributes value
     protected :value, :attributes
 
@@ -214,7 +215,7 @@ module CiteProc
         require date_parser
         @parsers << ::Object.const_get(module_id)
       rescue LoadError
-        warn "failed to load `#{date_parser}' gem"
+        # warn "failed to load `#{date_parser}' gem"
       end
     end
 
@@ -272,16 +273,15 @@ module CiteProc
       end
 
       alias now today
-
     end
 
 
-    attr_predicates :circa, :season, :literal, :'date-parts'
-
     # Make Date behave like a regular Ruby Date
-    def_delegators :to_ruby,
-      *::Date.instance_methods(false).reject { |m| m.to_s =~ /^to_s$|^inspect$|start$|^\W|uncertain|season/ }
+    def_delegators :to_ruby, *::Date.instance_methods(false).reject { |m|
+      m.to_s =~ /^[\W_]|[!=_]$|^(to_s|inspect|dup|clone|change)$|^(marshal|season|year|month|day|certain|uncertain)/
+    }
 
+    attr_predicates :circa, :season, :literal, :'date-parts'
 
     def initialize(value = {})
       super
@@ -292,6 +292,14 @@ module CiteProc
       @value = other.value.deep_copy
     end
 
+    def marshal_dump
+      to_citeproc
+    end
+
+    def marshal_load(value)
+      replace(value)
+    end
+
     def merge(other)
       super
       convert_parts!
@@ -330,7 +338,7 @@ module CiteProc
             DateParts.new(value.max)
           ]}
       when value.is_a?(String) && /^\s*\{/ =~ value
-        return replace(MultiJson.decode(value, :symbolize_keys => true))
+        return replace(::JSON.parse(value, :symbolize_names => true))
       when value.respond_to?(:to_s)
         @value = Date.parse!(value.to_s).value
       else
@@ -340,9 +348,11 @@ module CiteProc
       self
     end
 
+    remove_method :date_parts
+
     # @return [Array<DateParts>]
     def date_parts
-      @value[:'date-parts'] ||= []
+      value[:'date-parts'] ||= []
     end
 
     alias parts  date_parts
@@ -442,14 +452,14 @@ module CiteProc
     # Marks the date as uncertain
     # @return [self]
     def uncertain!
-      @value[:circa] = true
+      value[:circa] = true
       self
     end
 
     # Marks the date as a certain date
     # @return [self]
     def certain!
-      @value[:circa] = false
+      value[:circa] = false
       self
     end
 
@@ -479,7 +489,7 @@ module CiteProc
 
     # @return [Hash] a hash representation of the date.
     def to_citeproc
-      cp = @value.stringify_keys
+      cp = value.stringify_keys
 
       # Convert (or suppress empty) date-parts
       if parts.all?(&:empty?)
@@ -505,7 +515,8 @@ module CiteProc
 
     def <=>(other)
       case other
-      when Date
+      when CiteProc::Date
+        return nil if season? || other.season?
         parts <=> other.parts
       when ::Date
         parts <=> [other]

data/lib/citeproc/engine.rb

@@ -25,7 +25,7 @@ module CiteProc
       def default
         @default ||= autodetect or warn 'no citeproc engine found'
       end
-      
+
       # Returns the engine class for the given name or nil. If no suitable
       # class is found and a block is given, executes the block and returns
       # the result. The list of available engines will be passed to the block.
@@ -42,6 +42,8 @@ module CiteProc
 
       # Returns the best available engine class or nil.
       def autodetect(options = {})
+        load('citeproc-ruby') if subclasses.empty?
+
         subclasses.detect { |e|
           !options.has_key?(:engine) || e.name == options[:engine] and
           !options.has_key?(:name) || e.name == options[:name]
@@ -66,13 +68,12 @@ module CiteProc
 
       def priority
         @priority ||= 0
-      end      
+      end
     end
 
     attr_accessor :processor
 
-    def_delegators :@processor, :options, :abbreviations, :style, :locale,
-      :items, :language, :region, :abbreviate
+    def_delegators :@processor, :options, :abbreviate
 
     def initialize(processor = nil)
       @processor = processor
@@ -97,6 +98,10 @@ module CiteProc
       raise NotImplementedByEngine
     end
 
+    def render
+      raise NotImplementedByEngine
+    end
+
     def update_items
       raise NotImplementedByEngine
     end

data/lib/citeproc/errors.rb

@@ -6,14 +6,14 @@ module CiteProc
     def initialize(message, original = $!)
       @original = original
 			super(message)
-    end    
+    end
   end
-  
+
 	ParseError = Class.new(Error)
-		
+
   EngineError = Class.new(Error)
-  
+
   NotImplementedByEngine = Class.new(Error)
-  
+
   RenderingError = Class.new(Error)
-end
+end

data/lib/citeproc/extensions.rb

@@ -1,38 +1,38 @@
 
 module CiteProc
   module Extensions
-    
-		module Underscore
-			def underscore(word)
-				word = word.to_s.dup
-	      word.gsub!(/::/, '/')
-	      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-	      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
-	      word.tr!('-', '_')
-	      word.downcase!
-	      word
-			end
-		end
-		
+
+    module Underscore
+      def underscore(word)
+        word = word.to_s.dup
+        word.gsub!(/::/, '/')
+        word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+        word.tr!('-', '_')
+        word.downcase!
+        word
+      end
+    end
+
     module DeepCopy
       # See Matz, Flanagan: 'The Ruby Programming Language', p.83
       def deep_copy
         Marshal.load(Marshal.dump(self))
       end
     end
-   
-    module DeepFetch     
+
+    module DeepFetch
       def deep_fetch(*arguments)
         arguments.reduce(self) { |s,a| s[a] } rescue nil
       end
-      
+
       def [](*arguments)
         return super if arguments.length == 1
         deep_fetch(*arguments)
       end
-      
+
     end
-    
+
     # shamelessly copied from active_support
     module SymbolizeKeys
       def symbolize_keys
@@ -41,53 +41,53 @@ module CiteProc
           options
         end
       end
-      
+
       def symbolize_keys!
         replace(symbolize_keys)
       end
 
     end
 
-		module StringifyKeys
-	    def stringify_keys
-	      inject({}) do |options, (key, value)|
-	        options[(key.to_s rescue key) || key] = value
-	        options
-	      end
-	    end
-    
-	    def stringify_keys!
-	      replace(symbolize_keys)
-	    end
-		end
-    
-		module CompactJoin
-			def compact_join(delimiter = ' ')
-				reject { |t| t.nil? || (t.respond_to?(:empty?) && t.empty?) }.join(delimiter)
-			end
-		end
-		
-		# based and compatible to the active support version
-		# module ToSentence
-		# 	def to_sentence(options = {})
-		# 		options = {
-		# 			:words_connector => ", ",
-		# 			:two_words_connector => " and ",
-		# 			:last_word_connector => ", and "
-		# 		}.merge!(options)
-		# 
-		# 		case length
-		# 		when 0
-		# 			""
-		# 		when 1
-		# 			self[0].to_s.dup
-		# 		when 2
-		# 			"#{self[0]}#{options[:two_words_connector]}#{self[1]}"
-		# 		else
-		# 			"#{self[0...-1].join(options[:words_connector])}#{options[:last_word_connector]}#{self[-1]}"
-		# 		end
-		# 	end
-		# end
+    module StringifyKeys
+      def stringify_keys
+        inject({}) do |options, (key, value)|
+          options[(key.to_s rescue key) || key] = value
+          options
+        end
+      end
+
+      def stringify_keys!
+        replace(symbolize_keys)
+      end
+    end
+
+    module CompactJoin
+      def compact_join(delimiter = ' ')
+        reject { |t| t.nil? || (t.respond_to?(:empty?) && t.empty?) }.join(delimiter)
+      end
+    end
+
+    # based and compatible to the active support version
+    # module ToSentence
+    #   def to_sentence(options = {})
+    #     options = {
+    #       :words_connector => ", ",
+    #       :two_words_connector => " and ",
+    #       :last_word_connector => ", and "
+    #     }.merge!(options)
+    #
+    #     case length
+    #     when 0
+    #       ""
+    #     when 1
+    #       self[0].to_s.dup
+    #     when 2
+    #       "#{self[0]}#{options[:two_words_connector]}#{self[1]}"
+    #     else
+    #       "#{self[0...-1].join(options[:words_connector])}#{options[:last_word_connector]}#{self[-1]}"
+    #     end
+    #   end
+    # end
 
     module AliasMethods
       private
@@ -101,10 +101,10 @@ module CiteProc
 end
 
 class Hash
-	warn "citeproc: re-defining Hash#deep_copy, this may cause conflicts with other libraries" if method_defined?(:deep_copy)
+  warn "citeproc: re-defining Hash#deep_copy, this may cause conflicts with other libraries" if method_defined?(:deep_copy)
   include CiteProc::Extensions::DeepCopy
 
-	warn "citeproc: re-defining Hash#deep_copy, this may cause conflicts with other libraries" if method_defined?(:deep_fetch)
+  warn "citeproc: re-defining Hash#deep_copy, this may cause conflicts with other libraries" if method_defined?(:deep_fetch)
   include CiteProc::Extensions::DeepFetch
 
   include CiteProc::Extensions::SymbolizeKeys unless method_defined?(:symbolize_keys)
@@ -112,15 +112,15 @@ class Hash
 end
 
 class Array
-	include CiteProc::Extensions::CompactJoin
-	# include CiteProc::Extensions::ToSentence unless method_defined?(:to_sentence)	
-	
-	warn "citeproc: re-defining Array#deep_copy, this may cause conflicts with other libraries" if method_defined?(:deep_copy)
+  include CiteProc::Extensions::CompactJoin
+  # include CiteProc::Extensions::ToSentence unless method_defined?(:to_sentence)
+
+  warn "citeproc: re-defining Array#deep_copy, this may cause conflicts with other libraries" if method_defined?(:deep_copy)
   include CiteProc::Extensions::DeepCopy
 end
 
 class String
-	include CiteProc::Extensions::Underscore unless method_defined?(:underscore)
+  include CiteProc::Extensions::Underscore unless method_defined?(:underscore)
 end
 
 # module Kernel

data/lib/citeproc/item.rb

@@ -84,16 +84,37 @@ module CiteProc
     end
 
 
+    # Returns a CitationItem with a copy of this item
+    # attached as data.
+    #
+    # If given, number is added as the item's
+    # citation-number variable.
+    #
+    # @params [Fixnum] number the item's citation-number
+    # @returns [CitationItem] a citation item for this item
+    def cite(number = nil)
+      CitationItem.new :id => id do |c|
+        c.data = dup
+        c.data[:'citation-number'] = number unless number.nil?
+      end
+    end
+
     def observable_read_attribute(key)
       value = original_read_attribute(key)
+      return if suppressed?(key)
+      value
     ensure
       changed
       notify_observers :read, key, value
     end
 
     alias original_read_attribute read_attribute
+    alias unobservable_read_attribute read_attribute
+
     alias read_attribute observable_read_attribute
 
+    # Update [] alias!
+    alias [] read_attribute
 
     # @param name [Symbol] the name of the variable
     #
@@ -111,6 +132,20 @@ module CiteProc
       read_attribute name
     end
 
+    def language
+      unobservable_read_attribute(:language)
+    end
+
+    # An Item is interpreted as being English unless it has
+    # an attribute 'language' set to something other than 'en'.
+    #
+    # @return [Boolean] whether or not this is an English Item
+    def english?
+      lang = language
+      lang.nil? || lang == 'en'
+    end
+    alias en? english?
+
     # Calls a block once for each field in the item, passing the field's
     # name-value pair as parameters.
     #
@@ -133,7 +168,6 @@ module CiteProc
         to_enum
       end
     end
-
     alias each_pair each
 
     # Calls a block once for each field in the item, passing the field's
@@ -158,6 +192,30 @@ module CiteProc
       end
     end
 
+    def suppressed?(key)
+      suppressed.include?(key.to_s)
+    end
+
+    def suppress!(*keys)
+      keys.flatten.each do |key|
+        suppressed << key.to_s
+      end
+
+      suppressed.sort!
+      suppressed.uniq!
+
+      self
+    end
+
+    def suppressed
+      @suppressed ||= []
+    end
+
+    def ==(other)
+      return false unless other.is_a?(Item)
+      id == other.id
+    end
+
     def <=>(other)
       return nil unless other.is_a?(Attributes)
       eql?(other) ? 0 : length <=> other.length
@@ -210,4 +268,4 @@ module CiteProc
     end
   end
 
-end
+end