csl 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4f4e2dd15fcca560abf0a5d5527097bf02d95ba
-  data.tar.gz: f8aa36164f892d1b45c86dc23d4f360d0c3c03c0
+  metadata.gz: 817790ad5486590a4f7f83ba761a6c80dd86c4e8
+  data.tar.gz: d2bbaa7cc6980ca486425e635378a4f7c5323ce3
 SHA512:
-  metadata.gz: aad6d6d7102be615407a550b3cfbb7aeca23a5c3aff00b2d896b512f66325ee9fcb5fd61482976b63b91adc07eb03317648d609812f15df9fa244b17f4492200
-  data.tar.gz: 691ec4b1b95f4d01e8cfa41f7ec60e49986eac63436313d6cea1122e0c46bb9f839fefc147d06aab21c4e83e7f1ce5da0e1c48b222a9205c51f9796869afbd9e
+  metadata.gz: 175868d94c06e78355ca2f511f0ce9c256d301f3e88dc83aa316cb6ace02c73a31b285b1b095e1d7639bfa2b32e958210723523e6ad11cba956c003f7a29b378
+  data.tar.gz: ba50730dee3d8c1735a79597ed5caae09d02162fdbbe4adcb4ec51e6af5d6f35db96b2a74043f304f70b8aa87c3111c0b225821e170628270098f9b9451b3925

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -10,3 +10,4 @@ Gemfile.lock
 *.gem
 .ruby-version
 .rvm
+.bundle

data/.simplecov

@@ -1,2 +1,4 @@
 SimpleCov.start do
-end
+  add_filter 'spec/'
+  add_filter 'features/'
+end

data/.travis.yml

@@ -1,22 +1,16 @@
 language: ruby
 bundler_args: --without debug extra
+script: bundle exec rake test_with_coveralls
 rvm:
+  - 2.1.0
   - 2.0.0
-  - 1.9.2
   - 1.9.3
-  - jruby-18mode
   - jruby-19mode
-  - rbx-18mode
-  - rbx-19mode
-  - 1.8.7
-  - ree
+  - jruby-head
+  - rbx
 notifications:
   email:
     recipients:
       - sylvester@keil.or.at
     on_success: change
     on_failure: always
-matrix:
-  allow_failures:
-    - rvm: jruby-19mode
-    - rvm: rbx-19mode

data/AGPL

@@ -631,7 +631,7 @@ the "copyright" line and a pointer to where the full notice is found.
 
     CSL-Ruby. A Ruby CSL parser and library.
 		Copyright 2012 President and Fellows of Harvard College.
-		Copyright 2009-2013 Sylvester Keil. All rights reserved.
+		Copyright 2009-2014 Sylvester Keil. All rights reserved.
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU Affero General Public License as published by

data/BSDL

@@ -1,7 +1,7 @@
 CSL-Ruby. A Ruby CSL parser and library.
 
 Copyright 2012 President and Fellows of Harvard College.
-Copyright 2009-2013 Sylvester Keil. All rights reserved.
+Copyright 2009-2014 Sylvester Keil. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
@@ -26,4 +26,4 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 The views and conclusions contained in the software and documentation are
 those of the authors and should not be interpreted as representing official
-policies, either expressed or implied, of the copyright holder.
+policies, either expressed or implied, of the copyright holder.

data/Gemfile

@@ -5,28 +5,38 @@ group :development, :test do
   gem 'rake', '~>10.0'
   gem 'rspec', '~>2.13'
   gem 'cucumber', '~>1.2'
+  gem 'simplecov', '~>0.8', :require => false
+  gem 'rubinius-coverage', :platform => :rbx
+  gem 'coveralls', :require => false
 end
 
 group :debug do
-  gem 'ruby-debug', :platforms => [:mri_18, :jruby]
-  gem 'debugger', :platforms => [:mri_19]
-  gem 'debugger2', :platforms => [:mri_20]
+  gem 'ruby-debug', :require => false, :platforms => [:jruby]
+  gem 'debugger', :require => false, :platforms => [:mri]
+  gem 'rubinius-debugger', :require => false, :platforms => :rbx
+  gem 'rubinius-compiler', :require => false, :platforms => :rbx
 end
 
 group :optional do
-  gem 'nokogiri', '~>1.5'
+  gem 'nokogiri', '~> 1.6'
 end
 
 group :extra do
-  gem 'simplecov', '~>0.6'
+  gem 'guard', '~>2.2'
+  gem 'guard-rspec'
+  gem 'guard-cucumber'
+  gem 'rb-fsevent', '~>0.9', :platforms => [:ruby]
 
-  gem 'guard', '~>1.2'
-  gem 'guard-rspec', '~>1.1'
-  gem 'guard-cucumber', '~>1.2'
-  gem 'rb-fsevent', '~>0.9.1', :platforms => [:mri_19, :mri_20, :rbx]
+  gem 'yard', '~>0.8', :platforms => [:mri]
+  gem 'redcarpet', '~>3.0', :platforms => [:mri]
+end
 
-  gem 'yard', '~>0.8', :platforms => [:mri_19, :mri_20]
-  gem 'redcarpet', '~>2.1', :platforms => [:mri_19, :mri_20]
+group :rbx do
+  platform :rbx do
+    gem 'rubysl', '~>2.0'
+    gem 'json', '~>1.8'
+    gem 'racc'
+  end
 end
 
-# vim: syntax=ruby
+# vim: syntax=ruby

data/README.md

@@ -4,7 +4,9 @@ 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)
+[![Build Status](https://secure.travis-ci.org/inukshuk/csl-ruby.png)](http://travis-ci.org/inukshuk/csl-ruby)
+[![Coverage Status](https://coveralls.io/repos/inukshuk/csl-ruby/badge.png?branch=master)](https://coveralls.io/r/inukshuk/csl-ruby?branch=master)
+[![Dependency Status](https://gemnasium.com/inukshuk/csl-ruby.png)](https://gemnasium.com/inukshuk/csl-ruby)
 
 Styles and Locales
 ------------------
@@ -31,7 +33,7 @@ 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).
+[CiteProc-Ruby](https://github.com/inukshuk/citeproc).
 
 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
@@ -56,9 +58,9 @@ available features, please consult the
 
     # 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)"
@@ -73,31 +75,31 @@ available features, please consult the
     # 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
 
@@ -127,10 +129,17 @@ If you've found a bug or have a question, please open an issue on the
 Or, for extra credit, clone the CSL-Ruby repository, write a failing
 example, fix the bug and submit a pull request.
 
+Credits
+-------
+Thanks to Rintze M. Zelle, Sebastian Karcher, Frank G. Bennett, Jr.,
+and Bruce D'Arcus of CSL and citeproc-js fame for their support!
+
+Thanks to Google and the Berkman Center at Harvard University for supporting
+this project as part of [Google Summer of Code](https://developers.google.com/open-source/soc/).
 
 Copyright
 ---------
-Copyright 2009-2013 Sylvester Keil. All rights reserved.
+Copyright 2009-2014 Sylvester Keil. All rights reserved.
 
 Copyright 2012 President and Fellows of Harvard College.
 

data/Rakefile

@@ -18,8 +18,9 @@ task :console, [:script] do |t,args|
   ARGV.clear
 
   require 'irb'
+  require 'irb/completion'
   require 'csl'
-  
+
   IRB.conf[:SCRIPT] = args.script
   IRB.start
 end
@@ -35,6 +36,10 @@ Cucumber::Rake::Task.new(:cucumber) do |t|
   t.profile = 'default'
 end
 
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+task :test_with_coveralls => [:spec, :cucumber, 'coveralls:push']
+
 task :release do |t|
   system "gem build csl.gemspec"
   system "git tag #{CSL::VERSION}"

data/csl.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |s|
   s.license     = 'AGPL'
   s.date        = Time.now.strftime('%Y-%m-%d')
 
+  s.required_ruby_version = '>= 1.9.3'
+
   s.add_dependency('namae', ['~>0.7'])
 
   s.files        = `git ls-files`.split("\n")
@@ -29,7 +31,7 @@ Gem::Specification.new do |s|
   s.executables  = []
   s.require_path = 'lib'
 
-  s.has_rdoc      = 'yard'  
+  s.has_rdoc      = 'yard'
 end
 
-# vim: syntax=ruby
+# vim: syntax=ruby

data/features/parser/choose.feature

@@ -0,0 +1,16 @@
+Feature: Parse CSL choose nodes
+	As a hacker of CSL styles
+	I want to be able to parse CSL choose nodes
+	
+	Scenario: Single if nodes 
+		When I parse the CSL string
+			"""
+      <choose>
+        <if type="bill legal_case legislation" match="none"></if>
+      </choose>
+			"""
+		Then the nodename should be "choose"
+    And the node should have 1 blocks
+    And the block number 1's nodename should be "if"
+    And the block number 1's class should be "CSL::Style::Choose::Block"
+

data/features/step_definitions/parser_steps.rb

@@ -28,3 +28,13 @@ end
 Then /^the (\w+) number (\d+) should( not)? be a (\w+)$/ do |name, offset, negate, predicate|
   @csl.send("#{name}s")[offset.to_i - 1].send("#{predicate}?").should == negate.nil?
 end
+
+Then /^the (\w+) number (\d+)'s (\w+) should( not)? be "([^"]*)"$/ do |name, offset, method, negate, expected|
+  actual = @csl.send("#{name}s")[offset.to_i - 1].send(method).to_s
+  
+  if negate.nil?
+    actual.should == expected
+  else
+    actual.should_not == expected
+  end
+end

data/features/support/env.rb

@@ -1,8 +1,22 @@
 begin
   require 'simplecov'
-  require 'debugger'
+  require 'coveralls' if ENV['CI']
 rescue LoadError
   # ignore
 end
 
-require 'csl'
+begin
+  case
+  when RUBY_PLATFORM < 'java'
+    require 'debug'
+    Debugger.start
+  when defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+    require 'rubinius/debugger'
+  else
+    require 'debugger'
+  end
+rescue LoadError
+  # ignore
+end
+
+require 'csl'

data/lib/csl.rb

@@ -30,9 +30,12 @@ require 'csl/locale/date'
 require 'csl/locale/term'
 require 'csl/locale/style_options'
 
+require 'csl/name_options'
+
 require 'csl/style'
 require 'csl/style/bibliography'
 require 'csl/style/citation'
+require 'csl/style/sort'
 require 'csl/style/choose'
 require 'csl/style/date'
 require 'csl/style/group'
@@ -44,9 +47,9 @@ require 'csl/style/number'
 require 'csl/style/text'
 
 module CSL
-  
+
   module_function
-  
+
   def parse(*arguments)
     Parser.instance.parse(*arguments)
   end
@@ -54,7 +57,7 @@ module CSL
   def parse!(*arguments)
     Parser.instance.parse!(*arguments)
   end
-  
+
   def validate(node)
     Schema.validate(node)
   end
@@ -63,4 +66,4 @@ module CSL
     Schema.valid?(node)
   end
 
-end
+end

data/lib/csl/compatibility.rb

@@ -1,19 +1,13 @@
+module CSL
+  module_function
 
-class Symbol
-  include Comparable
-
-  def <=>(other)
-    return unless other.kind_of?(Symbol)
-    to_s <=> other.to_s
-  end
-
-  def match(pattern)
-    to_s.match(pattern)
+  def silence_warnings
+    original_verbosity, $VERBOSE = $VERBOSE, nil
+    yield
+  ensure
+    $VERBOSE = original_verbosity
   end
-
-  alias =~ match
-
-end unless Symbol.is_a?(Comparable)
+end
 
 class Module
   if RUBY_VERSION < '1.9'
@@ -51,11 +45,11 @@ module CSL
     end
   else
     def encode_xml_text(string)
-      string.encode(:xml => :text)
+      string.encode(string.encoding, :xml => :text)
     end
 
     def encode_xml_attr(string)
-      string.encode(:xml => :attr)
+      string.encode(string.encoding, :xml => :attr)
     end
   end
 end

data/lib/csl/info.rb

@@ -86,8 +86,9 @@ module CSL
     end
 
     # Ruby 1.8 still has Object#id methods so the attr_children generator
-    # has not created those; since #id is deprecated in 1.8.7 we're
+    # may not have created those; since #id is deprecated in 1.8.7 we're
     # forcing the override anyway. Live dangerously!
+    remove_method :id
 
     # @return [Id] the id text node
     def id
@@ -280,4 +281,4 @@ module CSL
   end
 
 
-end
+end

data/lib/csl/locale.rb

@@ -20,10 +20,9 @@ module CSL
     # Default languages/regions.
     # Auto-detection is based on these lists.
     @regions = Hash[*%w{
-      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
+      af ZA 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
     }.map(&:to_sym)].freeze
 
     @languages = @regions.invert.merge(Hash[*%w{
@@ -37,9 +36,10 @@ module CSL
       attr_accessor :default
       attr_reader :languages, :regions
 
-      def load(input = Locale.default)
-        input = normalize input if input.to_s =~ tag_pattern
-        super
+      def load(input = nil)
+        input ||= Locale.default
+        input = normalize input if input.to_s =~ @tag_pattern
+        super(input)
       end
 
       # Normalizes an IETF tag; adds a language's default region or a
@@ -57,7 +57,7 @@ module CSL
         tag = tag.to_s.strip
 
         raise ArgumentError, "not a valid IETF tag: #{tag.inspect}" unless
-          tag =~ tag_pattern
+          tag =~ @tag_pattern
 
         language, region = tag.split(/-/)
 
@@ -66,10 +66,6 @@ module CSL
 
         tag
       end
-
-      private
-
-      attr_reader :tag_pattern
     end
 
     attr_defaults :version => Schema.major_version,
@@ -134,11 +130,6 @@ module CSL
       yield self if block_given?
     end
 
-    def initialize_copy(other)
-      super
-      @language, @region = other.language, other.region
-    end
-
 
     def added_to(node)
       raise ValidationError, "not allowed to add locale to #{node.nodename}" unless
@@ -200,11 +191,25 @@ module CSL
 
     # @return [String, nil] the term's translation
     def translate(name, options = {})
+      return unless has_terms?
+
       term = terms.lookup name, options
       term && term.to_s(options)
     end
     alias t translate
 
+    # Stores a translation in the locale's term registry.
+    # @see Terms#store
+    def store(*arguments)
+      unless has_terms?
+        self << CSL::Locale::Terms.new
+      end
+
+      terms.store(*arguments)
+      self
+    end
+    alias learn store
+
     # Ordinalizes the passed-in number using either the ordinal or
     # long-ordinal forms defined by the locale. If a long-ordinal form is
     # requested but not available, the regular ordinal will be returned
@@ -250,6 +255,72 @@ module CSL
       [number, ordinal.to_s(options)].join
     end
 
+    # @return [Boolean] true when the option limit-day-ordinals-to-day-1 is true
+    def limit_day_ordinals?
+      return false unless has_options? && options.attribute?(:'limit-day-ordinals-to-day-1')
+      !!(options[:'limit-day-ordinals-to-day-1'].to_s =~ /^true$/i)
+    end
+
+    def limit_day_ordinals!
+      unless has_options?
+        children[:'style-options'] = StyleOptions.new
+      end
+
+      options[:'limit-day-ordinals-to-day-1'] = true
+    end
+
+    # @return [Boolean] true when the option punctuation-in-quote is true
+    def punctuation_in_quote?
+      return false unless has_options? && options.attribute?(:'punctuation-in-quote')
+      !!(options[:'punctuation-in-quote'].to_s =~ /^true$/i)
+    end
+    alias punctuation_in_quotes? punctuation_in_quote?
+
+    def punctuation_in_quote!
+      unless has_options?
+        children[:'style-options'] = StyleOptions.new
+      end
+
+      options[:'punctuation-in-quote'] = true
+    end
+    alias punctuation_in_quotes! punctuation_in_quote!
+
+    # Puts localized quotes around the passed-in string.
+    # @return [String] the quoted string
+    def quote(string, escape = false)
+      oq, cq = t('open-quote'), t('close-quote')
+
+      return string if oq.nil? || cq.nil? || (oq.empty? && cq.empty?)
+
+      if escape
+        oq = CSL.encode_xml_text(oq)
+        cq = CSL.encode_xml_text(cq)
+      end
+
+      string = replace_with_inner_quotes(string, oq, cq, escape)
+
+      if punctuation_in_quotes?
+        "#{oq}#{string}#{cq}"
+      else
+        string, punctuation = string.split(/([\.,])$/, 2)
+
+        "#{oq}#{string}#{cq}#{punctuation}"
+      end
+    end
+
+    def replace_with_inner_quotes(string, open, close, escape = false)
+      oq, cq = t('open-inner-quote'), t('close-inner-quote')
+
+      return string if oq.nil? || cq.nil? || (oq.empty? && cq.empty?)
+
+      if escape
+        oq = CSL.encode_xml_text(oq)
+        cq = CSL.encode_xml_text(cq)
+      end
+
+      string.gsub(/(#{open}|"\b)/, oq).gsub(/(#{close}|\b")/, cq)
+    end
+
     # @example
     #   locale.each_term { |term| block } #-> locale
     #   locale.each_term                  #-> enumerator
@@ -364,9 +435,11 @@ module CSL
 
     private
 
+    alias original_locale_attribute_assignments attribute_assignments
+
     def attribute_assignments
       if root?
-        super.push('xml:lang="%s"' % to_s)
+        original_locale_attribute_assignments
       else
         'xml:lang="%s"' % to_s
       end
@@ -410,4 +483,4 @@ module CSL
     end
   end
 
-end
+end