csl 1.0.0.pre23 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23b9a4f1447a95e1b46a96a403ff301b1ab93f32
-  data.tar.gz: 0355a94ad1f0be978d1a8e243c99aa6ad4d9ee5e
+  metadata.gz: 74e127a1013d127c41a6347da7c25756a0d3814d
+  data.tar.gz: 2f318db850403ee396c43e39dfb7be716559ac69
 SHA512:
-  metadata.gz: 41f1534aea931e42092073d7408b3105805f30a4e7656b53b63504e80b3eae1d4d5c0e08a704c7e3181b49a8482e0303a176a9561a4c097f196e7f14ce40e306
-  data.tar.gz: 0fd8a4e0eada2d438c213ff18495dfa6f8e153f2a079217f87e9d971c1fc31d4d30853999404396b7556800f92182e7f9e48b146404020390d0003f5086cbf3a
+  metadata.gz: 7ecf845a872d83a9393cca66ce068575cc314931521cb3fd4009eced2b1ada5a7caa8d48ff39ae89cf7b878a538e59cd7ae5b7523b1e295dda47d4c43c25565a
+  data.tar.gz: 5496e604da7d3a7130959161fe09ebac68d6a6cd2d652036dabc9a2adbe234f3288510be89f9a35f2607dd7f9874a01e70f1ca31cb9788efb3ab51511760aaaa

data/README.md

@@ -1,8 +1,8 @@
 CSL-Ruby
 ========
-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.
+CSL-Ruby provides a Ruby parser and a comprehensive API for the
+[Citation Style Language](http://citationstyles.org) (CSL), an XML-based
+format to describe the formatting of citations, notes and bibliographies.
 
 [![Build Status](https://secure.travis-ci.org/inukshuk/csl-ruby.png?branch=master)](http://travis-ci.org/inukshuk/csl-ruby)
 
@@ -20,7 +20,94 @@ 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.
+styles and locales. To make the styles and locales available, simply
+`require 'csl/styles`.
+
+Usage
+-----
+CSL-Ruby is broadly aimed at two very different usage scenarios: on the one
+hand, you can use the parser to load existing styles and locales and
+manipulate, query or otherwise work with them using a dedicated API: that is
+to say, you do not have to resort to XML-related methods of access, but can
+make use of a large set of library methods which are specific to CSL. This
+is useful, primarily, for citation processors like
+[CiteProc-Ruby](https://github.com/inukshuk/citeproc-ruby).
+
+On the other hand, CSL-Ruby makes it easy to create new styles and locales
+using Ruby; this is useful, for example, if you need to change or adapt
+styles on-the-fly or for writing an interactive style editor.
+
+To get you started, here are a few usage examples; for the full set of
+available features, please consult the
+[API documentation](http://rubydoc.info/gems/csl/).
+
+    require 'csl'
+
+    # Load a style from the Zotero style repository
+    jps = CSL::Style.load 'http://zotero.org/styles/american-journal-of-political-science'
+
+    # Query style information
+    jps.title #-> "American Journal of Political Science"
+    jps.independent? #-> true
+    jps.citation_format #-> :"author-date"
+
+    # Validate style against the CSL schema
+    jps.valid? #-> true
+
+    # Load another style
+    amc = CSL::Style.load 'http://zotero.org/styles/applied-mathematics-and-computation'
+    
+    amc.independent? #-> false
+    
+    # Load the independent parent style
+    parent = amc.independent_parent
+    parent.title #-> "Elsevier (numeric, with titles)"
+
+    # Load standard CSL styles and locales from csl-styles gem
+    # Requires you to gem install csl-styles
+    require 'csl/styles'
+
+    # Load a locally installed style
+    apa = CSL::Style.load :apa
+
+    # Fetch the a macro
+    authors = apa.macros['authors'].children[0]
+    #-> #<CSL::Style::Names variable="author" children=[2]>
+    
+    # Load a locally installed locale
+    fr = CSL::Locale.load :fr
+    
+    # Translate a term
+    fr.translate 'editor' #-> "éditeur"
+    fr.translate 'editor', plural: true #-> "éditeurs"
+    fr.translate 'editor', form: 'short' #-> "éd."
+    
+    # Ordinalize a number
+    fr.ordinalize 42 #=> "42ᵉ"
+    fr.ordinalize 3, form: 'long' => "troisième"
+
+    # Create a new style
+    style = CSL::Style.new
+    
+    style.id = 'http://www.zotero.org/styles/my-style'
+    style.title = 'My Style'
+
+    # Add the default license for CSL styles
+    style.default_license!
+    
+    # Access the style as XML
+    style.to_xml
+    
+    # Access the style as XML (pretty printed)
+    style.to_s
+
+Dependencies
+------------
+CSL-Ruby was written with portability in mind. For performance reasons it
+will use [Nokogiri ](http://nokogiri.org) for XML parsing and validation
+if available; however, CSL-Ruby will fallback to REXML from the Ruby standard
+library. In order to use Nokogiri, simply `gem install nokogiri` or add it
+to your Gemfile.
 
 Development
 -----------
@@ -28,7 +115,7 @@ The CSL-Ruby source code is [hosted on GitHub](https://github.com/inukshuk/csl-r
 You can check out a copy of the latest code using Git:
 
     $ git clone https://github.com/inukshuk/csl-ruby.git
-    
+
 To get started, install the development dependencies and run all tests:
 
     $ cd csl-ruby
@@ -43,10 +130,10 @@ example, fix the bug and submit a pull request.
 
 Copyright
 ---------
-Copyright 2012 President and Fellows of Harvard College.
-
 Copyright 2009-2013 Sylvester Keil. All rights reserved.
 
+Copyright 2012 President and Fellows of Harvard College.
+
 License
 -------
-CiteProc is dual licensed under the AGPL and the FreeBSD license.
+CSL-Ruby is dual licensed under the AGPL and the FreeBSD license.

data/csl.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.summary     = 'A Ruby CSL parser and library'
   s.description =
     """
-		A Ruby parser and library for the Citation Style Language (CSL),
+		A Ruby parser and full API for the Citation Style Language (CSL),
 		an open XML-based language to describe the formatting of citations
 		and bibliographies.
 		"""
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.license     = 'AGPL'
   s.date        = Time.now.strftime('%Y-%m-%d')
 
-  s.add_dependency('namae', ['~>0.3'])
+  s.add_dependency('namae', ['~>0.7'])
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/csl/compatibility.rb

@@ -3,9 +3,27 @@ class Symbol
   include Comparable
 
   def <=>(other)
-    return unless other.kind_of? Symbol
+    return unless other.kind_of?(Symbol)
     to_s <=> other.to_s
   end
+
+  def match(pattern)
+    str = to_s
+
+    case pattern
+    when Regexp
+      match_data = pattern.search_region(str, 0, str.bytesize, true)
+      Regexp.last_match = match_data
+      return match_data.full[0] if match_data
+    when String
+      raise TypeError, "type mismatch: String given"
+    else
+      pattern =~ str
+    end
+  end
+
+  alias =~ match
+
 end unless Symbol.is_a?(Comparable)
 
 class Module

data/lib/csl/info.rb

@@ -156,7 +156,7 @@ module CSL
 
     def default_license?
       has_rights? && rights[:license] == Schema.default_license &&
-        rights.to_s == Schema.default_rights_string
+        rights.text == Schema.default_rights_string
     end
 
     def default_license!

data/lib/csl/locale/date.rb

@@ -54,7 +54,7 @@ module CSL
       has_no_children
 
       attr_struct :name, :form, :'range-delimiter',
-        *Schema.attr(:formatting, :periods)
+        :'strip-periods', *Schema.attr(:formatting)
 
       include CSL::DatePart
     end

data/lib/csl/schema.rb

@@ -10,8 +10,7 @@ module CSL
     
     @default_license = 'http://creativecommons.org/licenses/by-sa/3.0/'
     @default_rights_string =
-      "This work is licensed under a Creative Commons Attribution-Share Alike 3.0 License: #{@default_license}"
-
+      '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
@@ -69,18 +68,9 @@ module CSL
       :delimiter => %w{
         delimiter
       },
-      :display => %w{
-        block left-margin right-inline indent
-      },
       :font => %w{
         font-style font-variant font-weight text-decoration vertical-align
       },
-      :quotes => %w{
-        quotes
-      },
-      :periods => %w{
-        strip-periods
-      },
       :name => %w{
         name-form name-delimiter and delimiter-precedes-et-al initialize-with
         delimiter-precedes-last et-al-min et-al-use-first et-al-subsequent-min
@@ -103,7 +93,7 @@ module CSL
     
     @attributes.each_value { |v| v.map!(&:to_sym).freeze }
 
-    @attributes[:formatting] = [:'text-case'].concat(
+    @attributes[:formatting] = [:'text-case', :display].concat(
       @attributes.values_at(:affixes, :font).flatten)
 
     @attributes.freeze

data/lib/csl/style/choose.rb

@@ -21,7 +21,7 @@ module CSL
         end
 
         def matcher(match = attributes[:match])
-          case match
+          case match.to_s
           when 'any'
             :any?
           when 'none'
@@ -37,8 +37,9 @@ module CSL
           type, match = attribute.to_s.split(/-(any|all|none)$/, 2)
 
           # subtle: if the default matcher is :none? and there
-          # is no override we to use :any? in the nested lists
-          # to avoid double negation during evaluation
+          # is no override we want to use :any? inside the nested
+          # lists to avoid double negation during evaluation of
+          # the entire expression!
 
           if match.nil?
             match = matcher

data/lib/csl/style/date.rb

@@ -4,8 +4,8 @@ module CSL
     class Date < Node
       attr_defaults :'date-parts' => 'year-month-day'
 
-      attr_struct :name, :form, :'range-delimiter', :'date-parts', :variable,
-        *Schema.attr(:display, :formatting, :delimiter)
+      attr_struct :name, :form, :'range-delimiter', :'date-parts',
+				:variable, *Schema.attr(:formatting, :delimiter)
 
       attr_children :'date-part'
 
@@ -49,11 +49,11 @@ module CSL
       end
 
       def numeric?
-        attributes[:form].to_s =~ /^numeric$/i
+        form =~ /^numeric$/i
       end
 
       def text?
-        attributes[:form].to_s =~ /^text$/i
+        form =~ /^text$/i
       end
 
       def has_date_parts?
@@ -69,8 +69,8 @@ module CSL
     class DatePart < Node
       has_no_children
 
-      attr_struct :name, :form, :'range-delimiter',
-        *Schema.attr(:formatting, :periods)
+      attr_struct :name, :form, :'range-delimiter', :'strip-periods',
+        *Schema.attr(:formatting)
 
       include CSL::DatePart
     end

data/lib/csl/style/group.rb

@@ -13,7 +13,7 @@ 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, :display, :delimiter))
+      attr_struct(*Schema.attr(:formatting, :affixes, :delimiter))
       
       def delimiter
         attributes.fetch(:delimiter, '')

data/lib/csl/style/label.rb

@@ -11,8 +11,8 @@ module CSL
     # is used instead of the local attribute.
     class Label < Node
 
-      attr_struct :variable, :form, :plural,
-        *Schema.attr(:formatting, :periods)
+      attr_struct :variable, :form, :plural, :'strip-periods',
+        *Schema.attr(:formatting)
 
       has_no_children
 
@@ -57,11 +57,11 @@ module CSL
       end
 
       def always_pluralize?
-        attributes[:plural].to_s =~ /^always$/i
+        attribute?(:plural) && attributes[:plural] =~ /^always$/i
       end
 
       def never_pluralize?
-        attributes[:plural].to_s =~ /^never$/i
+        attribute?(:plural) && attributes[:plural] =~ /^never$/i
       end
 
       # @return [Boolean] whether or not the {Label} is inside a {Names} node

data/lib/csl/style/names.rb

@@ -3,7 +3,7 @@ module CSL
 
     class Names < Node
 
-      attr_struct :variable, *Schema.attr(:names, :delimiter, :affixes, :display, :font)
+      attr_struct :variable, *Schema.attr(:names, :delimiter, :affixes, :font)
 
       attr_children :name, :'et-al', :label, :substitute
 

data/lib/csl/style/number.rb

@@ -4,8 +4,7 @@ module CSL
     # Numbers are CSL rendering elements which output the number variable
     # selected with the required variable attribute.
     class Number < Node
-      attr_struct :variable, :form, :'text-case',
-        *Schema.attr(:affixes, :display, :font)
+      attr_struct :variable, :form, *Schema.attr(:formatting)
 
       has_no_children
 
@@ -22,29 +21,29 @@ module CSL
       end
 
       def form
-        attributes[:form]
+        attributes[:form].to_s
       end
 
       # @return [Boolean] whether or not the number's format is set to
       #   :numeric; also returns true if the number's form attribute is not
       #   set or nil.
       def numeric?
-        !has_form? || form.to_sym == :numeric
+        !has_form? || form == 'numeric'
       end
 
-      # @return [Boolean] whether or not the number's format is set to :ordinal
+      # @return [Boolean] whether or not the number's format is set to 'ordinal
       def ordinal?
-        has_form? && form.to_sym == :ordinal
+        has_form? && form == 'ordinal'
       end
 
-      # @return [Boolean] whether or not the number's format is set to :'long-ordinal'
+      # @return [Boolean] whether or not the number's format is set to 'long-ordinal'
       def long_ordinal?
-        has_form? && form.to_sym == :'long-ordinal'
+        has_form? && form == 'long-ordinal'
       end
 
-      # @return [Boolean] whether or not the number's format is set to :roman
+      # @return [Boolean] whether or not the number's format is set to 'roman'
       def roman?
-        has_form? && form.to_sym == :roman
+        has_form? && form == 'roman'
       end
     end
 

data/lib/csl/style/text.rb

@@ -3,7 +3,7 @@ module CSL
 
     class Text < Node
       attr_struct :variable, :macro, :term, :form, :plural, :value,
-        *Schema.attr(:formatting, :display, :quotes, :periods)
+				:quotes, :'strip-periods', *Schema.attr(:formatting)
 
       has_no_children
 

data/lib/csl/version.rb

@@ -1,3 +1,3 @@
 module CSL  
-  VERSION = '1.0.0.pre23'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/spec/csl/style/number_spec.rb

@@ -52,6 +52,7 @@ module CSL
       
       it 'returns false if the form attribute is set to :ordinal' do
         Style::Number.new(:form => 'ordinal').should be_ordinal
+        Style::Number.new(:form => :ordinal).should be_ordinal
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: csl
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre23
+  version: 1.0.0
 platform: ruby
 authors:
 - Sylvester Keil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-14 00:00:00.000000000 Z
+date: 2013-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: namae
@@ -16,15 +16,15 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.3'
-description: "\n\t\tA Ruby parser and library for the Citation Style Language (CSL),\n\t\tan
+        version: '0.7'
+description: "\n\t\tA Ruby parser and full API for the Citation Style Language (CSL),\n\t\tan
   open XML-based language to describe the formatting of citations\n\t\tand bibliographies.\n\t\t"
 email:
 - http://sylvester.keil.or.at
@@ -132,9 +132,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3