csl 1.0.0.pre10 → 1.0.0.pre11

data/README.md

@@ -4,26 +4,39 @@ CSL-Ruby is a Ruby parser and library for the Citation Style Language (CSL),
 an XML-based format to describe the formatting of citations, notes and
 bibliographies.
 
-[![Build Status](https://secure.travis-ci.org/berkmancenter/csl-ruby.png?branch=master)](http://travis-ci.org/berkmancenter/csl-ruby)
+[![Build Status](https://secure.travis-ci.org/inukshuk/csl-ruby.png?branch=master)](http://travis-ci.org/inukshuk/csl-ruby)
+
+Styles and Locales
+------------------
+You can load CSL styles and locales by passing a respective XML string, file
+name, or URL. You can also load styles and locales by name if the
+corresponding files are installed in your local styles and locale directories.
+By default, CSL-Ruby looks for CSL styles and locale files in
+
+    /usr/local/share/csl/styles
+    /usr/local/share/csl/locales
+
+You can change these locations by changing the value of `CSL::Style.root` and
+`CSL::Locale.root` respectively.
+
+Alternatively, you can `gem install csl-styles` to install all official CSL
+styles and locales.
 
 Development
 -----------
-The CSL-Ruby source code is [hosted on GitHub](https://github.com/berkmancenter/csl-ruby).
+The CSL-Ruby source code is [hosted on GitHub](https://github.com/inukshuk/csl-ruby).
 You can check out a copy of the latest code using Git:
 
-    $ git clone https://github.com/berkmancenter/csl-ruby.git
+    $ git clone https://github.com/inukshuk/csl-ruby.git
     
-To get started, install the development dependencies, fetch the latest CSL
-styles and locales, and run all tests:
+To get started, install the development dependencies and run all tests:
 
     $ cd csl-ruby
-    $ git submodule init
-    $ git submodule update
     $ bundle install
     $ rake
 
 If you've found a bug or have a question, please open an issue on the
-[issue tracker](https://github.com/berkmancenter/csl-ruby/issues).
+[issue tracker](https://github.com/inukshuk/csl-ruby/issues).
 Or, for extra credit, clone the CSL-Ruby repository, write a failing
 example, fix the bug and submit a pull request.
 

data/lib/csl/loader.rb

@@ -5,11 +5,13 @@ module CSL
   # appropriate root, prefix and extension values and a parse method that
   # will be passed the contents of the asset data.
   #
+  # @note
+  #   Base classes are exepcted to define a #parse method.
   module Loader
-    
+
     attr_accessor :root, :prefix, :extension
-    
-    # call-seq:
+
+    # @example
     #   Style.load(:apa)                         -> style
     #   Style.load('chicago-author.csl')         -> style
     #   Locale.load('en')                        -> locale
@@ -18,6 +20,9 @@ module CSL
     # Resolves the passed-in path/name or string and loads the asset data.
     # The data will be passed on to the #parse method of the base class.
     # Typically, this will return a new instance of the class.
+    #
+    # @note
+    #   The base class is exepcted to define a #parse method.
     def load(input)
       case
       when input.respond_to?(:read)
@@ -25,7 +30,7 @@ module CSL
       when input.to_s =~ /^\s*</
         data = input
       else
-                
+
 				case
 				when File.exists?(input.to_s)
 					location = input
@@ -43,16 +48,23 @@ module CSL
       end
 
 			parse(data)
-			
+
 		rescue => e
 			raise ParseError, "failed to load #{input.inspect}: #{e.message}"
     end
-    
+
+    def list
+      Dir["#{root}/#{prefix}*#{extension}"].map do |path|
+        File.basename(path, extension).sub(/^#{prefix}/, '')
+      end
+    end
+    alias ls list
+
     # Extends the passed-in string to a full path.
     def extend_path(string)
       File.join(root.to_s, extend_name(string))
     end
-    
+
     # Extends the passed-in string to a style/locale name, by prefixing and
     # appending the default name prefix and extension.
     def extend_name(string)
@@ -61,18 +73,13 @@ module CSL
       else
         name = string.to_s.dup
       end
-      
+
       unless name.start_with?(prefix.to_s)
         name = [prefix, name].join
       end
-      
-      name
-    end
 
-    # The base class is exepcted to redefine the #parse method.
-    def parse(data)
-      raise 'Not Implemented'
+      name
     end
   end
-  
+
 end

data/lib/csl/locale.rb

@@ -7,14 +7,15 @@ module CSL
     types << CSL::Info
 
     include Comparable
-    
+
     @default = 'en-US'.freeze
 
-    @root = File.expand_path('../../../vendor/locales', __FILE__).freeze
+    @root = '/usr/local/share/csl/locales'.freeze
 
     @extension = '.xml'.freeze
     @prefix = 'locales-'.freeze
 
+    @tag_pattern = /^[a-z]{2}(-[A-Z]{2})?|-[A-Z]{2}$/
 
     # Default languages/regions.
     # Auto-detection is based on these lists.
@@ -22,11 +23,11 @@ module CSL
       af ZA ar AR bg BG ca AD cs CZ da DK de DE el GR en US es ES et EE fa IR
       fr FR he IL hu HU is IS it IT ja JP km KH ko KR mn MN nb NO nl NL nn NO
       pl PL pt PT ro RO ru RU sk SK sl SI sr RS sv SE th TH tr TR uk UA vi VN
-      zh CN zh TW
+      zh CN
     }.map(&:to_sym)].freeze
 
     @languages = @regions.invert.merge(Hash[*%w{
-      AT de BR pt CA en CH de GB en
+      AT de BR pt CA en CH de GB en TW zh
     }.map(&:to_sym)]).freeze
 
 
@@ -36,18 +37,39 @@ module CSL
       attr_accessor :default
       attr_reader :languages, :regions
 
-      def parse(data)
-        node = CSL.parse!(data, self)
-
-        raise ParseError, "root node is not a locale: #{node.inspect}" unless
-          node.is_a?(self)
-
-        node
-      end
-      
       def load(input = Locale.default)
+        input = normalize input if input.to_s =~ tag_pattern
         super
       end
+
+      # Normalizes an IETF tag; adds a language's default region or a
+      # region's default language.
+      #
+      # @example
+      #   Locale.normalize("en")  #-> "en-US"
+      #   Locale.normalize("-BR") #-> "pt-BR"
+      #
+      # @raise [ArgumentError] if the passed-in string is no IETF tag
+      #
+      # @param tag [String] an IETF tag to be normalized
+      # @return [String] the normalized IETF tag
+      def normalize(tag)
+        tag = tag.to_s.strip
+
+        raise ArgumentError, "not a valid IETF tag: #{tag.inspect}" unless
+          tag =~ tag_pattern
+
+        language, region = tag.split(/-/)
+
+        return [language, regions[language.to_sym]].compact.join('-') if region.nil?
+        return [languages[region.to_sym], region].join('-') if language.empty?
+
+        tag
+      end
+
+      private
+
+      attr_reader :tag_pattern
     end
 
     attr_defaults :version => Schema.version, :xmlns => Schema.namespace
@@ -56,20 +78,20 @@ module CSL
     attr_children :'style-options', :info, :date, :terms
 
 		has_language
-		
+
     attr_accessor :region
 
     alias_child :metadata, :info
     alias_child :dates, :date
     alias_child :options, :style_options
 
-    private :attributes
+    protected :attributes
     undef_method :[]=
 
     # @example
     #   Locale.new                                         #-> default
     #   Locale.new('en')                                   #-> American English
-    #   Locale.new('en', :'punctuation-in-quote' => fales) #-> with style-options
+    #   Locale.new('en', :'punctuation-in-quote' => false) #-> with style-options
     #   Locale.new(:lang => 'en-GB', :version => '1.0')    #-> British English
     #
     # Returns a new locale. In the first form, the language/regions is set
@@ -90,7 +112,7 @@ module CSL
 
           attributes, options = arguments
         else
-          attributes, locale, options = {}, arguments
+          attributes, locale, options = {}, *arguments
         end
       when 2
         attributes, locale, options = {}, *arguments
@@ -109,10 +131,10 @@ module CSL
       yield self if block_given?
     end
 
-    # TODO
-    # def initialize_copy(other)
-    #   @options = other.options.dup
-    # end
+    def initialize_copy(other)
+      super
+      @language, @region = other.language, other.region
+    end
 
 
     def added_to(node)
@@ -162,21 +184,7 @@ module CSL
 		#
 		# @return [self]
     def set(locale)
-      language, region = locale.to_s.scan(/([a-z]{2})?(?:-([A-Z]{2}))?/)[0].map do |tag|
-        tag.respond_to?(:to_sym) ? tag.to_sym : nil
-      end
-
-      case
-      when language && region
-        @language, @region = language, region
-      when language
-        @language, @region = language, Locale.regions[language]
-      when region
-        @language, @region = Locale.languages[region], region
-      else
-        raise ArgumentError, "not a valid locale string: #{locale.inspect}"
-      end
-
+      @language, @region = Locale.normalize(locale).split(/-/).map(&:to_sym)
       self
     end
 
@@ -246,6 +254,22 @@ module CSL
       validate.empty?
     end
 
+		# @return [Locale]
+		def merge(*others)
+			deep_copy.merge!(*others)
+		end
+
+		# @return [self]
+		def merge!(*others)
+			others.each do |other|
+			  merge_options other
+			  merge_dates other
+			end
+
+			self
+		end
+
+
     # Locales are sorted first by language, then by region; sort order is
     # alphabetical with the following exceptions: the default locale is
     # prioritised; in case of a language match the default region of that
@@ -302,6 +326,38 @@ module CSL
       Schema.preamble.dup
     end
 
+		# @param other [Locale] an other locale whose options should be merged
+		# @return [self]
+		def merge_options(other)
+		  return self unless other.has_options?
+
+		  if has_options?
+		    options.attributes.merge! other.options.attributes
+		  else
+		    add_child other.options.dup
+		  end
+
+		  self
+		end
+
+		# @param other [Locale] an other locale whose date nodes should be merged
+		# @return [self]
+    def merge_dates(other)
+      return self unless other.has_dates?
+
+      if has_dates?
+        other.each_date do |date|
+          delete_children each_date.select { |d| d[:form] == date[:form] }
+          add_child date.deep_copy
+        end
+      else
+        other.each_date do |date|
+          add_child date.deep_copy
+        end
+      end
+
+      self
+    end
   end
 
 end

data/lib/csl/locale/date.rb

@@ -1,39 +1,39 @@
-module CSL  
+module CSL
   class Locale
-    
+
     # A localized Date comprises a set of formatting rules for dates.
 		class Date < Node
-		  
-		  attr_struct :form, :'text-case', *Schema.attr(:font, :delimiter)
+
+		  attr_struct :form, *Schema.attr(:formatting, :delimiter)
 		  attr_children :'date-part'
-		  
+
 		  alias parts  date_part
 		  alias locale parent
-		
+
 		  def initialize(attributes = {})
 		    super(attributes)
 		    children[:'date-part'] = []
-		
+
 		    yield self if block_given?
 		  end
-	  
+      
 			def added_to(node)
 				raise ValidationError, "parent must be locale node: was #{node.inspect}" unless node.is_a?(Locale)
 			end
-			
+
       %w{ text numeric }.each do |type|
         define_method("#{type}?") { attributes.form == type }
       end
-      
+
 		end
 
 		# DatePart represent the localized formatting options for an individual
 		# date part (day, month, or year).
 		class DatePart < Node
-      has_no_children    
-      
-      attr_struct :name, :form, :'range-delimiter', :'text-case',
-        *Schema.attr(:affixes, :font, :periods)
+      has_no_children
+
+      attr_struct :name, :form, :'range-delimiter',
+        *Schema.attr(:formatting, :periods)
 
       %w{ day month year }.each do |part|
         define_method("#{part}?") do
@@ -42,7 +42,7 @@ module CSL
       end
 
 		end
-		
-		
+
+
   end
 end

data/lib/csl/locale/ordinalize.rb

@@ -37,7 +37,9 @@ module CSL
       raise ArgumentError, "unable to ordinalize #{number}; integer expected" unless
         number.respond_to?(:to_i)
 
-      number, query = number.to_i, ordinalize_query_for(options)
+      number = number.to_i
+      
+      
 
       key = query[:name]
 
@@ -97,8 +99,17 @@ module CSL
     
     private
     
-    # @return [Hash] a valid ordinalize query; the name attribute is a format string
-    def ordinalize_query_for(options)
+    def normalize_gender_options(options)
+      gender = (options[:'gender-form'] || options[:gender]).to_s
+      unless gender.empty? || gender =~ /^n/i
+        q[:'gender-form'] = (gender =~ /^m/i) ? 'masculine' : 'feminine'
+      end
+    end
+
+    def normalize_plural_options(options)
+    end
+    
+    def ordinalize_options_for(options)
       q = { :name => 'ordinal-%02d' }
 
       unless options.nil?
@@ -106,10 +117,6 @@ module CSL
           q[:name] = 'long-ordinal-%02d'
         end
 
-        gender = (options[:'gender-form'] || options[:gender]).to_s
-        unless gender.empty? || gender =~ /^n/i
-          q[:'gender-form'] = (gender =~ /^m/i) ? 'masculine' : 'feminine'
-        end
       end
 
       q

data/lib/csl/locale/style_options.rb

@@ -1,10 +1,11 @@
 module CSL
 	class Locale
-		
+
 		class StyleOptions < Node
 			has_no_children
-			attr_defaults :'punctuation-in-quote' => false
+			attr_defaults :'punctuation-in-quote' => false,
+			  :'limit-day-ordinals-to-day-1' => false
 		end
-		
+
 	end
 end