csl 1.0.2 → 1.1.0

data/lib/csl/style.rb

@@ -3,6 +3,8 @@ module CSL
   class Style < Node
     types << CSL::Info << CSL::Locale
 
+    include InheritableNameOptions
+
     @default = :apa
 
     @root = '/usr/local/share/csl/styles'.freeze
@@ -14,9 +16,9 @@ module CSL
       include Loader
 
       attr_accessor :default
-      
-      def load(input = Style.default)
-        super
+
+      def load(input = nil)
+        super(input || Style.default)
       end
     end
 
@@ -45,8 +47,7 @@ module CSL
       :independent_parent_link, :independent_parent_link=,
       :has_independent_parent_link?, :title=, :id=, :has_title?, :has_id?,
       :published_at, :updated_at, :citation_format, :citation_format=,
-      :updated_at, :update!, :license, :license=, :default_license?,
-      :default_license!
+      :update!, :license, :license=, :default_license?, :default_license!
 
     def initialize(attributes = {})
       super(attributes, &nil)
@@ -77,6 +78,7 @@ module CSL
       validate.empty?
     end
 
+    remove_method :info # generated by struct_children
     def info
       children[:info] ||= Info.new
     end
@@ -114,6 +116,28 @@ module CSL
       load_related_style_from independent_parent_link
     end
 
+    def demote_non_dropping_particle
+      attributes[:'demote-non-dropping-particle']
+    end
+    alias demote_particle demote_non_dropping_particle
+
+    def demote_non_dropping_particle?
+      attribute?(:'demote-non-dropping-particle')
+    end
+    alias demote_particle? demote_non_dropping_particle?
+
+    def initialize_without_hyphen?
+      attribute?(:'initialize-with-hyphen') && !attributes[:'initialize-with-hyphen']
+    end
+
+    def has_page_range_format?
+      attribute?(:'page-range-format')
+    end
+
+    def page_range_format
+      attributes[:'page-range-format']
+    end
+
     private
 
     def preamble
@@ -124,7 +148,7 @@ module CSL
       # TODO try local first
       Style.load(uri)
     end
-    
+
     def added_macro(node)
       unless node.attribute?(:name)
         raise ValidationError,
@@ -138,10 +162,10 @@ module CSL
 
       macros[node[:name]] = node
     end
-    
+
     def deleted_macro(node)
       macros.delete node[:name]
     end
   end
 
-end
+end

data/lib/csl/style/bibliography.rb

@@ -1,15 +1,52 @@
 module CSL
   class Style
-    
+
     class Bibliography < Node
-      
-      attr_struct :'hanging-indent', :'second-field-align', :'line-spacing',
-        :'entry-spacing', :'note-distance', :'subsequent-author-substitute',
-        :'subsequent-author-substitute-rule', *Schema.attr(:name, :names)
-      
+
+      include InheritableNameOptions
+
+      attr_struct :'subsequent-author-substitute',
+        :'subsequent-author-substitute-rule',
+        *Schema.attr(:bibliography, :name, :names)
+
       attr_children :sort, :layout
-      
+
+      attr_defaults :'line-spacing' => 1, :'entry-spacing' => 1,
+        :'subsequent-author-substitute-rule' => 'complete-all'
+
+      alias sort? has_sort?
+
+      def bibliography_options
+        attributes_for(*Schema.attr(:bibliography))
+      end
+
+      def sort_keys
+        return [] unless sort?
+        children[:sort].descendants
+      end
+
+      def substitute_subsequent_authors?
+        attribute?(:'subsequent-author-substitute')
+      end
+
+      def subsequent_author_substitute
+        attributes[:'subsequent-author-substitute'].to_s
+      end
+
+      def subsequent_author_substitute_rule
+        attributes[:'subsequent-author-substitute-rule'].to_s
+      end
+
+      def substitute_subsequent_authors_completely?
+        return false unless substitute_subsequent_authors?
+        subsequent_author_substitute_rule == 'complete-all'
+      end
+
+      def substitute_subsequent_authors_individually?
+        return false unless substitute_subsequent_authors?
+        subsequent_author_substitute_rule != 'complete-all'
+      end
     end
-    
+
   end
-end
+end

data/lib/csl/style/choose.rb

@@ -3,6 +3,8 @@ module CSL
 
     class Choose < Node
 
+      alias blocks children
+
       class Block < Node
         attr_struct :match, *Schema.attr(:conditionals)
 
@@ -10,7 +12,7 @@ module CSL
 
         class << self
           def matches?(nodename)
-            nodename.to_s =~ /^if(-else)?|else$/
+            nodename === ':if' || nodename === ':elseif' || nodename === ':else'
           end
         end
 
@@ -52,4 +54,4 @@ module CSL
     end
 
   end
-end
+end

data/lib/csl/style/citation.rb

@@ -1,17 +1,16 @@
 module CSL
   class Style
-    
+
     class Citation < Node
-      
-      attr_struct :'cite-group-delimiter', :collapse, :'year-suffix-delimiter',
-        :'after-collapse-delimiter', :'disambiguate-add-names',
-        :'disambiguate-add-givenname', :'disambiguate-add-year-suffix',
-        :'givenname-disambiguation-rule', :'names-delimiter',
-        *Schema.attr(:names, :name)
-    
+
+      include InheritableNameOptions
+
+      attr_struct(*Schema.attr(:citation, :names, :name))
+
       attr_children :sort, :layout
-      
+
+      alias sort? has_sort?
     end
-    
+
   end
-end
+end

data/lib/csl/style/group.rb

@@ -13,18 +13,25 @@ module CSL
     # the Group calls a variable (either directly or via a macro), and
     # b) all variables that are called are empty.
     class Group < Node
-      attr_struct(*Schema.attr(:formatting, :affixes, :delimiter))
+      attr_struct(*Schema.attr(:formatting, :delimiter))
       
       def delimiter
         attributes.fetch(:delimiter, '')
       end
 
-      private
-      
-      def added_child(node)
-        node.attributes.merge formatting_options
+      # Returns only those formatting options applicable to the Group
+      # node itself; not those which are transmitted to the enclosed
+      # elements.
+      #
+      # @return [Hash] the node's formatting options
+      def formatting_options
+        attributes_for :display, *Schema.attr(:affixes) 
+      end
+
+      def inheritable_formatting_options
+        attributes_for :'text-case', *Schema.attr(:font)
       end
     end
     
   end
-end
+end

data/lib/csl/style/label.rb

@@ -77,4 +77,4 @@ module CSL
     end
 
   end
-end
+end

data/lib/csl/style/layout.rb

@@ -1,13 +1,13 @@
 module CSL
   class Style
-    
+
     class Layout < Node
       attr_struct(*Schema.attr(:affixes, :font, :delimiter))
-    
+
       def delimiter
         attributes.fetch(:delimiter, '')
       end
     end
-    
+
   end
-end
+end

data/lib/csl/style/names.rb

@@ -1,12 +1,17 @@
+# encoding: utf-8
+
 module CSL
   class Style
 
     class Names < Node
+      extend InheritsNameOptions
 
-      attr_struct :variable, *Schema.attr(:names, :delimiter, :affixes, :font)
+      attr_struct :variable, *Schema.attr(:delimiter, :affixes, :font)
 
       attr_children :name, :'et-al', :label, :substitute
 
+      inherits :names_options
+
       alias labels label
 
       def initialize(attributes = {})
@@ -16,8 +21,10 @@ module CSL
         yield self if block_given?
       end
 
-      def delimiter
-        attributes.fetch(:delimiter, '')
+      def delimiter(node = nil, style = nil)
+        attributes.fetch(:delimiter) do
+          inherited_names_options(node, style)[:delimiter] || ''
+        end
       end
 
       def has_variable?
@@ -32,15 +39,20 @@ module CSL
 
 
     class Name < Node
+      extend InheritsNameOptions
 
       attr_struct :form, *Schema.attr(:name, :affixes, :font, :delimiter)
 
-      attr_defaults :form => 'long', :delimiter => ', ',
-        :'delimiter-precedes-last' => 'contextual', :initialize => true,
-        :'sort-separator' => ', '
+      # Having default attributes makes inheritance really difficult.
+      #
+      # attr_defaults :form => 'long', :delimiter => ', ',
+      #   :'delimiter-precedes-last' => 'contextual', :initialize => true,
+      #   :'sort-separator' => ', '
 
       attr_children :'name-part'
 
+      inherits :name_options
+
       alias parts name_part
 
       def initialize(attributes = {})
@@ -50,17 +62,29 @@ module CSL
         yield self if block_given?
       end
 
+      def count?
+        attribute?(:form) && attributes[:form] == 'count'
+      end
+
+      def name_options
+        attributes_for :form, :initialize, :'initialize-with', :'sort-separator'
+      end
 
-      def initialize?
-        attributes[:initialize].to_s !~ /^false$/i
+      def initialize_without_hyphen?
+        !root? && root.respond_to?(:initialize_without_hyphen?) &&
+          root.initialize_without_hyphen?
       end
 
       def et_al
-        parent && parent.et_al
+        @et_al || parent && parent.et_al
+      end
+
+      def et_al=(et_al)
+        @et_al = et_al
       end
 
       # @param names [#to_i, Enumerable] the list of names (or its length)
-      # @return [Boolean] whether or not the should be truncate
+      # @return [Boolean] whether or not the list should be truncated
       def truncate?(names, subsequent = false)
         names = names.length if names.respond_to?(:length)
         limit = truncate_when(subsequent)
@@ -79,35 +103,60 @@ module CSL
 
       def truncate_when(subsequent = false)
         if subsequent && attribute?(:'et-al-subsequent-min')
-          attribute[:'et-al-subsequent-min'].to_i
+          attributes[:'et-al-subsequent-min'].to_i
         else
-          attribute[:'et-al-min'].to_i
+          attributes[:'et-al-min'].to_i
         end
       end
 
       def truncate_at(subsequent = false)
         if subsequent && attribute?(:'et-al-subsequent-use-first')
-          attribute[:'et-al-subsequent-use-first'].to_i
+          attributes.fetch(:'et-al-subsequent-use-first', 1).to_i
         else
-          attribute[:'et-al-use-first'].to_i
+          attributes.fetch(:'et-al-use-first', 1).to_i
         end
       end
 
+      def truncate_at!(at)
+        attributes[:'et-al-use-first'] = at.to_i
+        self
+      end
+
+      def truncate_when!(pos)
+        attributes[:'et-al-min'] = pos.to_i
+        self
+      end
+
+      def truncate_subsequent_at!(at)
+        attributes[:'et-al-subsequent-use-first'] = at.to_i
+        self
+      end
+
+      def truncate_subsequent_when!(pos)
+        attributes[:'et-al-subsequent-min'] = pos.to_i
+        self
+      end
+
       # @return [String] the delimiter between family and given names
       #   in sort order
       def sort_separator
-        attributes[:'sort-separator'].to_s
+        attributes[:'sort-separator'] || ', '
       end
 
       # @return [String] the delimiter between names
       def delimiter
-        attributes[:delimiter].to_s
+        attributes[:delimiter] || ', '
       end
 
       def name_as_sort_order?
         attribute?(:'name-as-sort-order')
       end
 
+      def name_as_sort_order_at?(position)
+        return false unless name_as_sort_order?
+        all_names_as_sort_order? || position == 1 && first_name_as_sort_order?
+      end
+
       def name_as_sort_order
         attributes[:'name-as-sort-order'].to_s
       end
@@ -115,14 +164,91 @@ module CSL
       alias sort_order name_as_sort_order
 
       def first_name_as_sort_order?
-        attributes[:'name-as-sort-order'].to_s =~ /^first$/i
+        !!(attributes[:'name-as-sort-order'].to_s =~ /^first$/i)
       end
 
       def all_names_as_sort_order?
-        attributes[:'name-as-sort-order'].to_s =~ /^all$/i
+        !!(attributes[:'name-as-sort-order'].to_s =~ /^all$/i)
+      end
+
+      def first_name_as_sort_order!
+        attributes[:'name-as-sort-order'] = 'first'
+        self
+      end
+
+      def all_names_as_sort_order!
+        attributes[:'name-as-sort-order'] = 'all'
+        self
+      end
+
+      def delimiter_precedes_et_al?(names)
+        names = names.length if names.respond_to?(:length)
+
+        case
+        when delimiter_never_precedes_et_al?
+          false
+        when delimiter_always_precedes_et_al?
+          true
+        when delimiter_precedes_et_al_after_inverted_name?
+          name_as_sort_order_at?(names.to_i)
+        else
+          names.to_i > 1
+        end
+      end
+
+      # @return [Boolean] whether or not the delimmiter should
+      #   always be inserted before et-al
+      def delimiter_always_precedes_et_al?
+        !!(attributes[:'delimiter-precedes-et-al'].to_s =~ /^always$/i)
+      end
+
+      # Set the :'delimiter-precedes-et-al' attribute to 'always'.
+      # @return [self] self
+      def delimiter_always_precedes_et_al!
+        attributes[:'delimiter-precedes-et-al'] = 'always'
+        self
+      end
+
+      alias delimiter_precedes_et_al! delimiter_always_precedes_et_al!
+
+
+      # @return [Boolean] whether or not the delimiter should
+      #   never be inserted before et-al
+      def delimiter_never_precedes_et_al?
+        !!(attributes[:'delimiter-precedes-et-al'].to_s =~ /^never$/i)
+      end
+
+      # Set the :'delimiter-precedes-et-al' attribute to 'never'
+      # @return [self] self
+      def delimiter_never_precedes_et_al!
+        attributes[:'delimiter-precedes-et-al'] = 'never'
+        self
+      end
+
+      # @return [Boolean] whether or not the delimtier should
+      #   be inserted between before et-al depending on the
+      #   number of names rendered
+      def delimiter_contextually_precedes_et_al?
+        return true unless attribute?[:'delimiter-precedes-et-al']
+        !!(attributes[:'delimiter-precedes-et-al'].to_s =~ /^contextual/i)
+      end
+
+      # Set the :'delimiter-precedes-et-al' attribute to 'contextual'
+      # @return [self] self
+      def delimiter_contextually_precedes_et_al!
+        attributes[:'delimiter-precedes-et-al'] = 'contextual'
+        self
+      end
+
+      def delimiter_precedes_et_al_after_inverted_name?
+        !!(attributes[:'delimiter-precedes-et-al'].to_s =~ /^after-inverted-name/i)
+      end
+
+      def delimiter_precedes_et_al_after_inverted_name!
+        attributes[:'delimiter-precedes-et-al'] = 'after-inverted-name'
+        self
       end
 
-      
       # @param names [#to_i, Enumerable] the list of names (or its length)
       # @return [Boolean] whether or not the delimiter will be inserted between
       #   the penultimate and the last name
@@ -136,7 +262,7 @@ module CSL
           false
         when delimiter_always_precedes_last?
           true
-        when delimiter_precedeces_last_after_inverted_name?
+        when delimiter_precedes_last_after_inverted_name?
           if name_as_sort_order?
             all_names_as_sort_order? || names.to_i == 2
           else
@@ -180,6 +306,7 @@ module CSL
       # @return [Boolean] whether or not the should be inserted between the
       #   penultimate and the last name depending on the number of names
       def delimiter_contextually_precedes_last?
+        return true unless attribute?(:'delimiter-precedes-last')
         !!(attributes[:'delimiter-precedes-last'].to_s =~ /^contextual/i)
       end
 
@@ -203,20 +330,32 @@ module CSL
         attributes[:'et-al-use-last'].to_s =~ /^true$/
       end
 
+      def ellipsis
+        "#{delimiter}… "
+      end
+
       def connector
         c = attributes[:and]
         c == 'symbol' ? '&' : c
       end
+
+      def connector=(c)
+        attributes[:and] = c
+      end
     end
 
     class NamePart < Node
       has_no_children
       attr_struct :name, :'text-case', *Schema.attr(:affixes, :font)
+
+      def name
+        attributes[:name]
+      end
     end
 
     class EtAl < Node
       has_no_children
-      attr_struct :term, *Schema.attr(:affixes, :font)
+      attr_struct :term, :'text-case', *Schema.attr(:affixes, :font)
 
       attr_defaults :term => 'et-al'
     end
@@ -226,4 +365,4 @@ module CSL
 
 
   end
-end
+end