citeproc 1.0.0.pre10 → 1.0.0.pre11

data/lib/citeproc/date.rb

@@ -72,7 +72,7 @@ module CiteProc
     # The {DateParts} class encapsulates the year, month and day parts of a
     # date; it is used internally by {Date} variables and not supposed to
     # be used in an external context.
-    class DateParts < Struct.new(:year, :month, :day)
+    DateParts = Struct.new(:year, :month, :day) do
       include Comparable
 
       def initialize(*arguments)
@@ -194,6 +194,9 @@ module CiteProc
       end
     end
 
+    #
+    # CiteProc::Date
+    #
 
     include Attributes
 

data/lib/citeproc/errors.rb

@@ -15,4 +15,5 @@ module CiteProc
   
   NotImplementedByEngine = Class.new(Error)
   
+  RenderingError = Class.new(Error)
 end

data/lib/citeproc/variable.rb

@@ -11,7 +11,7 @@ module CiteProc
 
     extend Forwardable
     include Comparable
-    
+
     @fields = Hash.new { |h,k| h.fetch(k.to_sym, nil) }.merge({
       :date => %w{
         accessed container event-date issued original-date submitted
@@ -21,12 +21,12 @@ module CiteProc
         author collection-editor composer container-author recipient editor
         editorial-director illustrator interviewer original-author translator
       },
-      
+
       :number => %w{
         chapter-number collection-number edition issue number number-of-pages
-        number-of-volumes volume        
+        number-of-volumes volume
       },
-      
+
       :text => %w{
         abstract annote archive archive_location archive-place authority
         call-number citation-label citation-number collection-title
@@ -38,36 +38,36 @@ module CiteProc
         title title-short URL version year-suffix
       }
     })
-    
+
     @fields.each_value { |v| v.map!(&:to_sym) }
-    
+
     @types = Hash.new { |h,k| h.fetch(k.to_sym, nil) }.merge(
       Hash[*@fields.keys.map { |k| @fields[k].map { |n| [n,k] } }.flatten]
     ).freeze
-    
+
     @fields[:name] = @fields[:names]
     @fields[:dates] = @fields[:date]
     @fields[:numbers] = @fields[:number]
-    
+
     @fields[:all] = @fields[:any] =
       [:date,:names,:text,:number].reduce([]) { |s,a| s.concat(@fields[a]) }.sort
 
     @fields.freeze
 
     @markup = /<[^>]*>/.freeze
-    
-    
+
+
     class << self
-  
+
       # @!attribute [r] fields
       # @return [{Symbol => Array<Symbol>}] mapping of variable types to
       #   their respective field names
       attr_reader :fields
-      
+
       # @!attribute [r] types
       # @return [{Symbol => Symbol}] mapping of field names to variable types
       attr_reader :types
-      
+
       # @!attribute [r] factories
       # @return [{Symbol => Class}] mapping of field names to their respective
       #   Variable classes
@@ -76,7 +76,7 @@ module CiteProc
       # @!attribute markup
       # @return [Regexp] pattern used to strip markup off values
       attr_accessor :markup
-      
+
       # Creates a new {Variable} instance using the passed-in field name
       # to distinguish which {Variable} class to use as factory. This
       # method returns nil if the creation fails.
@@ -105,8 +105,8 @@ module CiteProc
       rescue
         nil
       end
-      
-      
+
+
       # Creates a new {Variable} instance using the passed-in field name
       # to distinguish which {Variable} class to use as factory.
       #
@@ -132,20 +132,20 @@ module CiteProc
 
     def_delegators :@value, :to_s,
       *::String.instance_methods(false).select {|m| m.to_s =~ /!$/ }
-    
+
     def_delegators :to_s, :=~, :===,
       *::String.instance_methods(false).reject {|m| m.to_s =~ /^\W|!$|to_s/ }
 
-    
+
     # Creates new Variable for the passed-in value
     def initialize(value = nil)
       replace(value)
     end
-    
+
     def initialize_copy(other)
       @value = other.value.dup
     end
-    
+
 
     # The replace method is typically called by the Variable's constructor. It
     # will try to set the Variable to the passed in value and should accept
@@ -182,8 +182,29 @@ module CiteProc
 			Number.romanize(to_i)
 		end
 
+		# Tokenizes the variable's value according to the rules of CSL number
+		# extraction. Note that this method returns an emtpy array unless
+		# the variable has numeric content.
+		#
+		# @see numeric?
+		#
+		# For numeric variables, this method normalizes delimiters and
+		# separators: numbers separated by a hyphen are stripped of intervening
+		# spaces ("2 - 4" becomes "2-4"). Numbers separated by a comma receive
+		# one space after the comma ("2,3" and "2 , 3" become "2, 3"), while
+		# numbers separated by an ampersand receive one space before and one
+		# after the ampsersand ("2&3" becomes "2 & 3").
+		#
+		# The array returned by this method contains all numbers and tokens
+		# as separate strings.
+		#
+		# @example
+		#   Variable.new('2,3').tokenize    #-> ['2', ', ', '3']
+		#   Variable.new('2  - 4').tokenize #-> ['2', '-', '4']
+		#
     # @return [Array<String>] tokenizes the variable's value
     def tokenize
+			return [] unless numeric?
       numbers = to_s.dup
 
       numbers.gsub!(/\s*,\s*/, ', ')
@@ -192,6 +213,7 @@ module CiteProc
 
       numbers.split(/(\s*[,&-]\s*)/)
     end
+		alias extract_numbers tokenize
 
 		# Tests whether the variable contains numeric content. Content is
 		# considered numeric if it solely consists of numbers. Numbers may have
@@ -210,24 +232,24 @@ module CiteProc
     def to_i
      to_s =~ /([+-]?\d+)/ && $1.to_i || 0
     end
-    
+
     # @return [Float] the first (!) numeric or floating point data contained
     #   in the variable's value; zero if no numeric data is present
     def to_f
       to_s =~ /([+-]?\d[\d,\.]*)/ && $1.tr(',','.').to_f || 0.0
     end
-    
+
     # @return [String] the variable's value stripped of markup
     def strip_markup
       gsub(Variable.markup, '')
     end
-    
+
     # Strips markup off the variable's value.
     # @return [self]
     def strip_markup!
       gsub!(Variable.markup, '')
-    end 
-    
+    end
+
     # Compares the variable with the passed-in value. If other responds
     # to {#strip_markup} the stripped strings will be compared; otherwise
     # both objects will be converted to and compared as strings.
@@ -249,7 +271,7 @@ module CiteProc
     # @!method to_s
     # @return [String] the variable's value as a string
     alias to_citeproc to_s
-    
+
     # @return [String] a JSON string representation of the variable
     def to_json
       MultiJson.encode(to_citeproc)
@@ -259,7 +281,7 @@ module CiteProc
     def inspect
       "#<#{self.class.name} #{to_s.inspect}>"
     end
-    
+
   end
 
   # A CiteProc Variable used for string values.

data/lib/citeproc/version.rb

@@ -1,3 +1,3 @@
 module CiteProc
-  VERSION = '1.0.0.pre10'.freeze
+  VERSION = '1.0.0.pre11'.freeze
 end

data/spec/citeproc/date_spec.rb

@@ -2,12 +2,12 @@ require 'spec_helper'
 
 module CiteProc
   describe Date do
-    
+
     class Date
       describe DateParts do
         it { should_not be_nil }
         it { should be_empty }
-      
+
         describe 'sorting' do
           it 'treats [2003] as less than [2003,1]' do
             DateParts.new(2003).should be < DateParts.new(2003,1)
@@ -32,46 +32,46 @@ module CiteProc
           it 'treats [-50] as less than [-50,12]' do
             DateParts.new(-50).should be < DateParts.new(-50,12)
           end
-          
+
           it 'treats [1994,1,23] as less than today' do
             DateParts.new(1994,1,23).should be < ::Date.today
-          end          
+          end
         end
-        
+
         describe '#dup' do
           let(:date) { DateParts.new(1991,8,22) }
-          
+
           it 'creates a copy that contains the same parts' do
             date.dup.to_a.should == [1991,8,22]
           end
-          
+
           it 'does not return self' do
             date.dup.should_not equal(date)
             date.dup.should == date
           end
         end
-        
+
         describe '#update' do
           it 'accepts a hash' do
             DateParts.new.update(:month => 2, :year => 80).to_a.should == [80,2,nil]
           end
-          
+
           it 'accepts an array' do
             DateParts.new.update([80,2]).to_a.should == [80,2,nil]
           end
         end
-        
+
         describe '#strftime' do
           it 'formats the date parts according to the format string' do
             DateParts.new(1998,2,4).strftime('FOO %0m%0d%y').should == 'FOO 020498'
           end
         end
-        
+
         describe 'to_citeproc' do
           it 'returns an empty list by default' do
             DateParts.new.to_citeproc.should == []
           end
-          
+
           it 'returns a list with the year if only the year is set' do
             DateParts.new(2001).to_citeproc.should == [2001]
           end
@@ -80,37 +80,37 @@ module CiteProc
             DateParts.new(0,0).to_citeproc.should == [0,0]
           end
         end
-        
+
         describe '#open?' do
           it 'returns false by default' do
             DateParts.new.should_not be_open
           end
-          
+
           it 'returns false for [1999,8,24]' do
             DateParts.new(1999, 8, 24).should_not be_open
           end
-          
+
           it 'returns true for [0]' do
             DateParts.new(0).should be_open
           end
         end
       end
     end
-    
-    
+
+
     let(:ad2k) { Date.create('date-parts' => [[2000]])}
     let(:may) { Date.create('date-parts' => [[2000, 5]])}
     let(:first_of_may) { Date.create('date-parts' => [[2000, 5, 1]])}
-    
+
     let(:bc100) { Date.create('date-parts' => [[-100]]) }
     let(:bc50) { Date.create('date-parts' => [[-50]]) }
     let(:ad50) { Date.create('date-parts' => [[50]]) }
     let(:ad100) { Date.create('date-parts' => [[100]]) }
 
     it { should_not be nil }
-    
+
     it { should_not be_numeric }
-    
+
     describe '.new' do
       it 'accepts a hash as input' do
         Date.new(:literal => 'Summer').to_s.should == 'Summer'
@@ -119,19 +119,19 @@ module CiteProc
       it 'accepts a hash as input and converts date parts' do
         Date.new(:'date-parts' => [[2003,2]]).parts[0].should be_a(Date::DateParts)
       end
-      
+
       it 'accepts a fixnum and treats it as the year' do
         Date.new(1666).year.should == 1666
       end
-      
+
       it 'accepts a date' do
         Date.new(::Date.new(1980,4)).month.should == 4
       end
-      
+
       it 'accepts a date and creates date parts' do
         Date.new(::Date.new(1980,4)).parts[0].to_citeproc.should == [1980,4,1]
       end
-      
+
       it 'is empty by default' do
         Date.new.should be_empty
       end
@@ -163,7 +163,7 @@ module CiteProc
       it 'accepts inclusive date ranges' do
         Date.new(::Date.new(2009) .. ::Date.new(2011)).end_date.year.should == 2011
       end
-      
+
       it 'accepts EDTF date strings' do
         Date.new('2009?-03-19').should be_uncertain
       end
@@ -172,27 +172,27 @@ module CiteProc
         Date.new('2009-03-19/2010-11-21').parts.map(&:to_citeproc).should == [[2009,3,19],[2010,11,21]]
       end
     end
-    
+
 		describe '.parse' do
 			it 'returns nil by default' do
 				Date.parse('').should be nil
 				Date.parse(nil).should be nil
 			end
-			
+
 			it 'parses date strings' do
 				Date.parse('2004-10-26').year.should == 2004
 			end
 		end
-		
+
     describe '.create' do
       it 'should accept parameters and return a new instance' do
         Date.create('date-parts' => [[2001, 1]]).year.should == 2001
       end
     end
-    
+
     describe '#dup' do
       let(:date) { Date.new([1991,8]) }
-      
+
       it 'creates a copy that contains the same parts' do
         date.dup.parts.map(&:to_citeproc).should == [[1991,8]]
       end
@@ -201,30 +201,30 @@ module CiteProc
         date.dup.should_not be_uncertain
         date.uncertain!.dup.should be_uncertain
       end
-      
+
       it 'makes a deep copy of attributes' do
         expect { date.dup.uncertain! }.not_to change { date.uncertain? }
       end
-      
+
       it 'makes a deep copy of date parts' do
         expect { date.dup.parts[0].update(:year => 2012) }.not_to change { date.year }
       end
-      
+
       it 'does not return self' do
         date.dup.should_not equal(date)
         date.dup.should == date
       end
     end
-    
-    describe 'literal dates' do      
+
+    describe 'literal dates' do
       it 'is not literal by default' do
         Date.new.should_not be_literal
       end
-      
+
       it 'is literal if it contains only a literal field' do
         Date.create(:literal => 'foo').should be_literal
       end
-      
+
       it 'is literal if it contains a literal field' do
         Date.create('date-parts' => [[2000]], :literal => 'foo').should be_literal
       end
@@ -234,22 +234,22 @@ module CiteProc
       it 'is no season by default' do
         Date.new.should_not be_season
       end
-      
+
       it 'is a season if contains only a season field' do
         Date.new(:season => 'Winter').should be_season
       end
 
       it 'is a season if contains a season field' do
         Date.new(:'date-parts' => [[2001]], :season => 'Winter').should be_season
-      end      
+      end
     end
-    
+
     describe 'uncertain dates' do
       it 'are uncertain' do
         Date.new({ 'date-parts' => [[-225]], 'circa' => '1' }).should be_uncertain
         Date.new { |d| d.parts = [[-225]]; d.uncertain! }.should_not be_certain
       end
-      
+
       describe '#(un)certain!' do
         it 'returns self' do
           ad2k.uncertain!.should equal(ad2k)
@@ -257,16 +257,16 @@ module CiteProc
         end
       end
     end
-    
+
     describe 'sorting' do
       it 'dates with more date-parts will come after those with fewer parts' do
         (ad2k < may  && may < first_of_may).should be true
       end
-      
+
       it 'negative years are sorted inversely' do
         [ad50, bc100, bc50, ad100].sort.map(&:year).should == [-100, -50, 50, 100]
       end
-      
+
       it 'can be compared to dates' do
         ad50.should be < ::Date.new(50,2)
         ad50.should be > ::Date.new(49)
@@ -277,7 +277,7 @@ module CiteProc
       it 'returns nil by default' do
         Date.new.start_date.should be_nil
       end
-      
+
       it 'returns a ruby date when date-parts are set' do
         Date.new(1999).start_date.year.should == 1999
       end
@@ -287,16 +287,16 @@ module CiteProc
       it 'returns nil by default' do
         Date.new.end_date.should be_nil
       end
-      
+
       it 'returns nil when there is a single date-parts set' do
         Date.new(1312).end_date.should be_nil
       end
-      
+
       it 'returns a ruby date when date-parts are a closed range' do
         Date.new(1999..2000).end_date.year.should == 2000
       end
     end
-    
+
     describe '#-@' do
       it 'inverts the year' do
         (-ad50).should == bc50
@@ -310,7 +310,7 @@ module CiteProc
     end
 
 		describe 'b.c. and a.d.' do
-			
+
 			it 'the year 993 is a.d.' do
 				Date.new(993).should be_ad
 			end
@@ -338,11 +338,11 @@ module CiteProc
 			it 'the year -33 is b.c.' do
 				Date.new(-33).should be_bc
 			end
-			
+
 			it 'today is not a.d.' do
 				Date.today.should_not be_ad
 			end
-			
+
 			it 'today is not b.c.' do
 				Date.today.should_not be_bc
 			end
@@ -350,22 +350,22 @@ module CiteProc
 			it 'the year 2000 is not a.d.' do
 				ad2k.should_not be_ad
 			end
-			
+
 		end
-		
+
 		describe '#empty?' do
 		  it 'returns true by default' do
 		    Date.new.should be_empty
 		  end
-		  
+
 		  it 'returns true when it contains no date parts' do
 		    Date.new({}).should be_empty
 		  end
-		  
+
 		  it 'returns false for today' do
 		    Date.today.should_not be_empty
 		  end
-		  
+
 		  it 'returns false for literal dates' do
 		    Date.new(:literal => 'foo').should_not be_empty
 		  end
@@ -374,8 +374,8 @@ module CiteProc
 		    Date.new(:season => 'Summer').should_not be_empty
 		  end
 		end
-				
-    describe '#to_json' do    
+
+    describe '#to_json' do
       it 'supports simple parts' do
         Date.new(%w{2000 1 15}).to_json.should == '{"date-parts":[[2000,1,15]]}'
       end
@@ -387,7 +387,7 @@ module CiteProc
       it 'supports integer parts' do
         Date.new([2000, 1, 15]).to_json.should == '{"date-parts":[[2000,1,15]]}'
       end
-        
+
       it 'supports mixed parts' do
         Date.new(['2000', 1, '15']).to_json.should == '{"date-parts":[[2000,1,15]]}'
       end
@@ -399,7 +399,7 @@ module CiteProc
       it 'treats seasons as a strings' do
         Date.create({:season => '1', 'date-parts' => [[1950]]}).to_json.should =~ /"season":"1"/
       end
-      
+
       it 'supports seasons' do
         Date.create({:season => 'Trinity', 'date-parts' => [[1975]]}).to_json.should =~ /"season":"Trinity"/
       end
@@ -415,7 +415,7 @@ module CiteProc
       it 'supports closed ranges' do
         Date.new([[2000,11],[2000,12]]).to_json.should == '{"date-parts":[[2000,11],[2000,12]]}'
       end
-      
+
       it 'supports open ranges' do
         Date.new([[2000,11],[0,0]]).to_json.should == '{"date-parts":[[2000,11],[0,0]]}'
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: citeproc
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre10
+  version: 1.0.0.pre11
   prerelease: 6
 platform: ruby
 authors:
@@ -162,7 +162,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3211648624536269637
+      hash: 1049133668296705127
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: