csl 1.0.2 → 1.1.0

data/lib/csl/locale/term.rb

@@ -21,6 +21,28 @@ module CSL
 
       alias each each_child
 
+      # @example
+      #   terms.store(term)
+      #   terms.store('book', ['book', 'books'])
+      #   terms.store('book', 'bk', :form => 'short')
+      #
+      # Shorthand method to stores a new term translations.
+      #
+      # @param [Term, String] the term; or the the term's name
+      # @param [String] the term's translation
+      # @param [Hash] additional term attributes
+      #
+      # @return [self]
+      def store(term, translation = nil, options = nil)
+        unless term.is_a?(Term)
+          term = Term.new(:name => term)
+          term.attributes.merge(options) unless options.nil?
+          term.set(*translation)
+        end
+
+        self << term
+      end
+
       # If a style uses a term in a form that is undefined, there is a
       # fallback to other forms: "verb-short" first falls back to "verb",
       # "symbol" first falls back to "short", and "verb" and "short" both
@@ -151,7 +173,7 @@ module CSL
         delete_children tmp
       end
 
-      private
+      protected
 
       # @!attribute [r] registry
       # @return [Hash] a private registry to map term names to the respective
@@ -163,6 +185,8 @@ module CSL
       #   term objects for quick ordinal look-up
       attr_reader :ordinals
 
+      private
+
       def added_child(term)
         raise ValidationError, "failed to register term #{term.inspect}: name attribute missing" unless
           term.attribute?(:name)
@@ -214,7 +238,7 @@ module CSL
 
         def specialize(options)
           specialized = {}
-          
+
           options.each do |key, value|
             key = key.to_sym
 
@@ -330,6 +354,21 @@ module CSL
 
       alias plural pluralize
 
+      alias singular= single=
+      alias plural= multiple=
+
+      def set(singular, plural = nil)
+        if plural.nil?
+          self.text = singular
+        else
+          self.single = singular
+          self.multiple = plural
+        end
+
+        self
+      end
+
+
       # @!method masculine?
       # @return [Boolean] whether or not the term is masculine
 

data/lib/csl/name_options.rb

@@ -0,0 +1,44 @@
+module CSL
+  module InheritableNameOptions
+    def inheritable_name_options
+      options = attributes_for(*Schema.attr(:name))
+
+      if attribute?(:'name-delimiter')
+        options[:delimiter] = attributes[:'name-delimiter']
+      end
+
+      if attribute?(:'name-form')
+        options[:form] = attributes[:'name-form']
+      end
+
+      options
+    end
+
+    def inheritable_names_options
+      return {} unless attribute? :'names-delimiter'
+      { :delimiter => attributes[:'names-delimiter'] }
+    end
+  end
+
+  module InheritsNameOptions
+    def inherits(name)
+      inheritable_options = "inheritable_#{name}".to_sym
+
+      define_method("inherited_#{name}") do |node, style|
+        options = {}
+
+        if node.respond_to?(inheritable_options)
+          options = node.send(inheritable_options).merge(options)
+        end
+
+        style ||= root
+
+        if !root? && style.respond_to?(inheritable_options)
+          options = style.send(inheritable_options).merge(options)
+        end
+
+        options
+      end
+    end
+  end
+end

data/lib/csl/node.rb

@@ -137,8 +137,10 @@ module CSL
             attr_reader :keys
           end
 
-          def initialize(attrs = {})
-            super(*attrs.symbolize_keys.values_at(*keys))
+          CSL.silence_warnings do
+            def initialize(attrs = {})
+              super(*attrs.symbolize_keys.values_at(*keys))
+            end
           end
 
           # @return [<Symbol>] a list of symbols representing the names/keys
@@ -190,6 +192,7 @@ module CSL
 
             self
           end
+          alias merge! merge
 
           # @overload values_at(selector, ... )
           #   Returns an array containing the attributes in self according
@@ -231,9 +234,7 @@ module CSL
 
     def initialize_copy(other)
       super
-      @attributes = self.class.create_attributes(other.attributes)
-      @children = self.class.create_children
-      @parent, @ancestors, @descendants, @siblings, @root, @depth = nil
+      initialize(other.attributes)
     end
 
     def deep_copy
@@ -246,6 +247,19 @@ module CSL
       copy
     end
 
+    def merge!(options)
+      attributes.merge!(options)
+      self
+    end
+
+    def reverse_merge!(options)
+      options.each_pair do |key, value|
+        attributes[key] = value unless attribute? key
+      end
+
+      self
+    end
+
     # @return [Boolean] whether or not the node has default attributes
     def has_default_attributes?
       !default_attributes.empty?
@@ -417,9 +431,41 @@ module CSL
       }.compact]
     end
 
+    
     # @return [Hash] the node's formatting options
     def formatting_options
-      attributes_for Schema.attr(:formatting)
+      options = attributes_for Schema.attr(:formatting)
+
+      if !root? && parent.respond_to?(:inheritable_formatting_options)
+        parent.inheritable_formatting_options.merge(options)
+      else
+        options
+      end
+    end
+
+    # Whether or not page ranges should be formatted when
+    # rendering this node.
+    #
+    # Page ranges must be formatted if the node is part of
+    # a {Style} with a page-range-format value.
+    #
+    # @return [Boolean] whether or not page ranges should
+    #   be formatted
+    def format_page_ranges?
+      root.respond_to?(:has_page_range_format?) && root.has_page_range_format?
+    end
+
+    def page_range_format
+      return unless format_page_ranges?
+      root.page_range_format
+    end
+
+    def strip_periods?
+      attribute?(:'strip-periods') && !!(attributes[:'strip-periods'].to_s =~ /^true$/i)
+    end
+
+    def quotes?
+      attribute?(:'quotes') && !!(attributes[:'quotes'].to_s =~ /^true$/i)
     end
 
     def <=>(other)
@@ -536,6 +582,8 @@ module CSL
       true
     end
 
+    remove_method :empty?
+
     def empty?
       text.nil? || text.empty?
     end

data/lib/csl/parser.rb

@@ -7,21 +7,21 @@ module CSL
     include Singleton
 
     attr_accessor :parser
-    
+
     @engines = {
       :nokogiri => lambda { |source|
         Nokogiri::XML::Document.parse(source, nil, nil,
-          Nokogiri::XML::ParseOptions::DEFAULT_XML | Nokogiri::XML::ParseOptions::NOBLANKS)
+          Nokogiri::XML::ParseOptions::DEFAULT_XML | Nokogiri::XML::ParseOptions::NOBLANKS | Nokogiri::XML::ParseOptions::NOENT)
       },
       :default  => lambda { |source|
         REXML::Document.new(source, :compress_whitespace => :all, :ignore_whitespace_nodes => :all)
       }
     }
-    
+
     class << self
       attr_reader :engines
     end
-    
+
     def initialize
       require 'nokogiri'
       @parser = Parser.engines[:nokogiri]
@@ -29,23 +29,23 @@ module CSL
       require 'rexml/document'
       @parser = Parser.engines[:default]
     end
-    
+
     def parse(*arguments)
       parse!(*arguments)
     rescue
       nil
     end
-    
+
     def parse!(source, scope = Node)
       root = parser[source].children.detect { |child| !skip?(child) }
       parse_tree root, scope
     end
 
     private
-    
+
     def parse_node(node, scope = Node)
       attributes, text = parse_attributes(node), parse_text(node)
-      
+
       if text
         n = TextNode.create node.name, attributes
         n.text = text
@@ -54,26 +54,26 @@ module CSL
         scope.create node.name, attributes
       end
     end
-    
+
     def parse_attributes(node)
       Hash[*node.attributes.map { |n, a|
         [n.to_sym, a.respond_to?(:value) ? a.value : a.to_s]
       }.flatten]
     end
-    
+
     def parse_tree(node, scope = Node)
       return nil if node.nil?
-      
+
       root = parse_node node, scope
       scope = specialize_scope(root, scope)
-      
+
       node.children.each do |child|
         root << parse_tree(child, scope) unless comment?(child)
       end unless root.textnode?
-      
+
       root
     end
-    
+
     def parse_text(node)
       if node.respond_to?(:has_text?)
         node.has_text? && node.text
@@ -82,7 +82,7 @@ module CSL
         child && child.respond_to?(:text?) && child.text? && child.text
       end
     end
-    
+
     def comment?(node)
       node.respond_to?(:comment?) && node.comment? ||
         node.respond_to?(:node_type) &&
@@ -103,5 +103,5 @@ module CSL
       end
     end
   end
-  
-end
+
+end

data/lib/csl/schema.rb

@@ -1,17 +1,17 @@
 module CSL
-  
+
   class Schema
-    
+
     @version         = '1.0.1'.freeze
     @major_version   = '1.0'.freeze
 
     @namespace = 'http://purl.org/net/xbiblio/csl'.freeze
     @preamble  = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n".freeze
-    
+
     @default_license = 'http://creativecommons.org/licenses/by-sa/3.0/'
     @default_rights_string =
       'This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 License'
-    
+
     @types = %w{ article article-journal article-magazine article-newspaper
       bill book broadcast chapter entry entry-dictionary entry-encyclopedia
       figure graphic interview legal_case legislation manuscript map
@@ -31,7 +31,7 @@ module CSL
 
       :number => %w{
         chapter-number collection-number edition issue number number-of-pages
-        number-of-volumes volume        
+        number-of-volumes volume
       },
 
       :text => %w{
@@ -60,7 +60,7 @@ module CSL
       [:date,:names,:text,:number].reduce([]) { |s,a| s.concat(@variables[a]) }.sort
 
     @variables.freeze
-    
+
     @attributes = Hash.new { |h,k| h.fetch(k.to_sym, nil) }.merge({
       :affixes => %w{
         prefix suffix
@@ -72,13 +72,22 @@ module CSL
         font-style font-variant font-weight text-decoration vertical-align
       },
       :name => %w{
-        name-form name-delimiter and delimiter-precedes-et-al initialize-with
+        and delimiter-precedes-et-al initialize-with
         delimiter-precedes-last et-al-min et-al-use-first et-al-subsequent-min
         et-al-subsequent-use-first et-al-use-last name-as-sort-order
         sort-separator initialize
       },
       :names => %w{
-        names-delimiter
+        names-delimiter name-delimiter name-form
+      },
+      :bibliography => %w{
+        hanging-indent second-field-align line-spacing entry-spacing
+      },
+      :citation => %w{
+        disambiguate-add-names disambiguate-add-given-name
+        givenname-disambiguation-rule disambiguate-add-year-suffix
+        cite-group-delimiter collapse year-suffix-delimiter
+        after-collapse-delimiter near-note-distance
       },
       :conditionals => %w{
         disambiguate position
@@ -90,7 +99,7 @@ module CSL
         variable variable-any variable-all variable-none
       }
     })
-    
+
     @attributes.each_value { |v| v.map!(&:to_sym).freeze }
 
     @attributes[:formatting] = [:'text-case', :display].concat(
@@ -103,11 +112,11 @@ module CSL
         :form => %w{ numeric numeric-leading-zeros ordinal long short }
       }
     })
-    
+
     @values.freeze
 
     @file = File.expand_path('../../../vendor/schema/csl.rng', __FILE__)
-    
+
     @validators = {
       :nokogiri => lambda { |schema, style|
         begin
@@ -117,12 +126,12 @@ module CSL
           [[0, $!.message]]
         end
       },
-      
+
       :default => lambda { |schema, style|
         raise ValidationError, "please `gem install nokogiri' for validation support"
       }
     }
-    
+
     begin
       # TODO enable java validator when nokogiri issue is fixed
       if RUBY_PLATFORM =~ /java/i
@@ -135,19 +144,19 @@ module CSL
     rescue LoadError
       @validator = @validators[:default]
     end
-    
+
     class << self
-      
+
       attr_accessor :version, :major_version, :namespace, :types,
         :variables, :categories, :attributes, :preamble, :values,
         :default_rights_string, :default_license
-      
+
       private :new
-      
+
       def attr(*arguments)
         attributes.values_at(*arguments).flatten(1)
       end
-      
+
       # Validates the passed-in style or list of styles. The style argument(s)
       # can either be a {Style} object, a style's file handle, XML content
       # or a valid location (wildcards are supported). The method returns
@@ -172,9 +181,9 @@ module CSL
       def validate(node)
         case
         when node.is_a?(Node)
-          validator[schema, node.to_xml]
+          @validator[@schema, node.to_xml]
         when node.respond_to?(:read)
-          validator[schema, node.read]
+          @validator[@schema, node.read]
         when node.is_a?(Enumerable) && !node.is_a?(String)
           node.map { |n| validate(n) }.flatten(1)
         when node.respond_to?(:to_s)
@@ -182,23 +191,23 @@ module CSL
 
           case
           when node =~ /^\s*</
-            validator[schema, node]
+            @validator[@schema, node]
           when File.exists?(node)
-            validator[schema, File.open(node, 'r:UTF-8')]
+            @validator[@schema, File.open(node, 'r:UTF-8')]
           else
             glob = Dir.glob(node)
-            
+
             if glob.empty?
-              validator[schema, Kernel.open(node)]            
+              @validator[@schema, Kernel.open(node)]
             else
-              glob.map { |n| validator[schema, File.open(n, 'r:UTF-8')] }.flatten(1)
+              glob.map { |n| @validator[@schema, File.open(n, 'r:UTF-8')] }.flatten(1)
             end
           end
         else
           raise ArgumentError, "failed to validate #{node.inspect}: not a CSL node"
         end
       end
-      
+
       # Whether or not the passed-in style (or list of styles) is valid.
       #
       # @see validate
@@ -215,11 +224,7 @@ module CSL
       def valid?(style)
         validate(style).empty?
       end
-      
-      private
-      
-      attr_reader :validators, :validator, :schema
     end
-    
-  end  
+
+  end
 end