citeproc 0.0.8 → 0.0.9

data/{LICENSE → BSDL}

@@ -1,4 +1,5 @@
-Copyright 2009-2011 Sylvester Keil. All rights reserved.
+Copyright 2012 President and Fellows of Harvard College.
+Copyright 2009-2012 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:

data/Gemfile

@@ -2,10 +2,21 @@ source :rubygems
 gemspec
 
 group :debug do
-	gem 'ruby-debug', :platforms => [:ruby_18, :jruby]
-	gem 'ruby-debug19', :require => 'ruby-debug', :platforms => [:ruby_19]
+  gem 'debugger', '~>1.1.3', :platform => :mri_19
 end
 
 group :optional do
 	gem 'chronic', '~>0.6'
+	gem 'edtf', '~>1.0.0'
+		
+	gem 'bibtex-ruby', '~>2.0.10', :require => 'bibtex'
+	
+  gem 'simplecov', '~>0.6.4'
+  
+  gem 'unicode_utils', '~>1.3.0', :platform => :mri_19
+  gem 'unicode', '~>0.4.2', :platform => :mri_18
+end
+
+group :extra do
+  gem 'oniguruma', '~>1.1.0', :platform => :mri_18
 end

data/README.md

@@ -1,4 +1,35 @@
 CiteProc
 ========
+CiteProc is a cite processor interface and citation data API based on the
+Citation Style Language (CSL) specifications. To actually process citations
+a dedicated processor engine is required; these can be installed as separate
+gems.
 
-The CiteProc gem is a Ruby abstraction layer for the JSON API used by citeproc-js. To process citations you also require a dedicate processor engine available as a separate gem: these will include citeproc-js, citeproc-ruby and eventually citeproc-hs. As work on these packages is still in progress, please be aware of the following caveats: the 0.0.2 release of citeproc-ruby is still a standalone package and will conflict with this release of citeproc; support will be added in future versions. The citeproc-js gem currently works only in JRuby (using an embedded version of the Rhino JavaScript interpreter) but is going to support other versions of Ruby using different JavaScript runtimes.
+### A word of caution
+As work on this and on the related packages is still in progress, please
+be aware of the following caveats: the 0.0.x branch of citeproc-ruby is still
+a standalone package and will conflict with this release of citeproc; support
+will be added in future versions of the 1.x.x branch.
+
+[![Build Status](https://secure.travis-ci.org/berkmancenter/citeproc.png)](http://travis-ci.org/berkmancenter/citeproc)
+
+
+Citation Data
+-------------
+
+Processor Interface
+-------------------
+
+Credits
+-------
+
+
+Copyright
+---------
+Copyright 2012 President and Fellows of Harvard College.
+
+Copyright 2009-2012 Sylvester Keil. All rights reserved.
+
+License
+-------
+CiteProc is dual licensed under the AGPL and the FreeBSD license.

data/Rakefile

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'bundler'
+begin
+  Bundler.setup
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), './lib'))
+require 'citeproc/version'
+
+
+desc 'Run an IRB session with CiteProc loaded'
+task :console, [:script] do |t,args|
+  ARGV.clear
+
+  require 'irb'
+  require 'citeproc'
+  
+  IRB.conf[:SCRIPT] = args.script
+  IRB.start
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:cucumber)
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/citeproc.gemspec

@@ -8,28 +8,35 @@ Gem::Specification.new do |s|
   s.name        = 'citeproc'
   s.version     = CiteProc::VERSION.dup
   s.platform    = Gem::Platform::RUBY
+  
   s.authors     = ['Sylvester Keil']
-  s.email       = 'http://sylvester.keil.or.at'
-  s.homepage    = 'http://inukshuk.github.com/citeproc'
+  s.email       = ['sylvester@keil.or.at']
+  
+  s.homepage    = 'https://github.com/inukshuk/citeproc'
   s.summary     = 'A cite processor interface.'
-  s.description = 'A a cite processor for Citation Style Language (CSL) styles.'
-  s.license     = 'FreeBSD'
+  s.description =
+    """
+    A cite processor interface for Citation Style Language (CSL) styles.
+    """
+
+  s.license     = 'AGPL'
   s.date        = Time.now.strftime('%Y-%m-%d')
 
-  s.add_runtime_dependency('multi_json', '~>1.0')
+  s.add_runtime_dependency('multi_json', '~>1.3.5')
+  s.add_runtime_dependency('namae', '~>0.1')
   
-  s.add_development_dependency('cucumber', ['>=1.0.2'])
-  s.add_development_dependency('rspec', ['>=2.6.0'])
-  s.add_development_dependency('watchr', ['>=0.7'])
+  s.add_development_dependency('cucumber', ['~>1.2.0'])
+  s.add_development_dependency('rspec', ['~>2.10.0'])
+  s.add_development_dependency('watchr', ['~>0.7'])
+  s.add_development_dependency('rake', ['~>0.9.2'])
+  s.add_development_dependency('yard', ['~>0.8.1'])
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables  = []
   s.require_path = 'lib'
 
-  s.rdoc_options      = %w{--line-numbers --inline-source --title "CiteProc" --main README.md --webcvs=http://github.com/inukshuk/citeproc/tree/master/}
-  s.extra_rdoc_files  = %w{README.md}
-  
+  s.has_rdoc      = 'yard'
 end
 
 # vim: syntax=ruby

data/lib/citeproc.rb

@@ -1,13 +1,11 @@
 
-require 'multi_json'
+require 'date'
 require 'forwardable'
 require 'observer'
 require 'uri'
 
-if ENV['DEBUG']
-  require 'ruby-debug'
-  Debugger.start
-end
+require 'multi_json'
+require 'namae'
 
 require 'citeproc/version'
 
@@ -17,7 +15,11 @@ require 'citeproc/version'
 #
 module CiteProc
   
-  module Converters; end
+  module Converters
+  end
+  
+  module Utilities
+  end
   
 end
 
@@ -34,11 +36,11 @@ require 'citeproc/date'
 require 'citeproc/names'
 
 CiteProc::Variable.class_eval do
-	@factories = Hash.new { |h,k| h.fetch(k.to_sym, CiteProc::Variable) }.merge(
-		Hash[*@types.map { |n,k|
-			[n, CiteProc.const_get(k.to_s.capitalize)]
-		}.flatten]
-	).freeze
+  @factories = Hash.new { |h,k| h.fetch(k.to_s.intern, CiteProc::Variable) }.merge(
+    Hash[*@types.map { |n,k|
+      [n, CiteProc.const_get(k.to_s.capitalize)]
+    }.flatten]
+  ).freeze
 end
 
 require 'citeproc/item'

data/lib/citeproc/abbreviate.rb

@@ -1,5 +1,3 @@
-require 'multi_json'
-
 module CiteProc
 	module Abbreviate
 
@@ -20,8 +18,7 @@ module CiteProc
 				end
 		end
 
-		# call-seq:
-		# abbreviate(namespace = :default, context, word)
+		# @overload abbreviate(namespace = :default, context, word)
 		def abbreviate(*arguments)
 			raise ArgumentError, "wrong number of arguments (#{arguments.length} for 2..3)" unless (2..3).include?(arguments.length)
 			arguments.unshift(namespace || :default) if arguments.length < 3

data/lib/citeproc/assets.rb

@@ -39,8 +39,7 @@ module CiteProc
 			
 			self
 		rescue => e
-			puts e.backtrace.join("\n")
-			raise ArgumentError, "failed to open asset #{input.inspect}: #{e.message}"
+			raise ArgumentError, "failed to open asset #@location (#{input.inspect}): #{e.message}"
 		end
 
 		def name
@@ -66,8 +65,16 @@ module CiteProc
 			end
 			
 			def extend_name(input)
-				name = File.extname(input).empty? ? [input, extension].compact.join : input.to_s.dup
-				name = name.start_with?(prefix.to_s) ? name : [prefix, name].join
+				if File.extname(input) != extension
+				  name = [input, extension].compact.join
+				else
+				  name = input.to_s.dup
+				end
+				
+				unless name.start_with?(prefix.to_s)
+				  name = [prefix, name].join
+				end
+				
 				name
 			end
 

data/lib/citeproc/attributes.rb

@@ -1,16 +1,8 @@
-
 module CiteProc
-  
-	# TODO refactor using a Struct instead of a hash. This will have to convert
-	# the CiteProc/CSL names which are no proper method names.
-	
-	
+    
   module Attributes
     extend Forwardable
-    
 
-		FALSE_PATTERN = (/^(false|no|never)$/i).freeze
-		
     def self.included(base)
       base.extend(ClassMethods)
     end
@@ -19,104 +11,119 @@ module CiteProc
       @attributes ||= {}
     end
     
-		def_delegators :attributes, :length, :empty?
-
-		def [](key)
-			attributes[filter_key(key)]
-		end
-		
-		def []=(key, value)
-			attributes[filter_key(key)] = filter_value(value)
-		end
-		
-		def filter_key(key)
-			key.to_sym
-		end
-		
-		def filter_value(value, key = nil)
-			value.respond_to?(:deep_copy) ? value.deep_copy : value.dup
-		rescue
-			value
-		end
-		
+    def_delegators :attributes, :length, :empty?, :values_at, :key?, :value?
+
+    alias size length
+    
+    def [](key)
+      attributes[filter_key(key)]
+    end
+    
+    def []=(key, value)
+      attributes[filter_key(key)] = filter_value(value)
+    end
+    
+    def filter_key(key)
+      key.to_sym
+    end
+    
+    def filter_value(value, key = nil)
+      value.respond_to?(:deep_copy) ? value.deep_copy : value.dup
+    rescue
+      value
+    end
+    
     def merge(other)
       return self if other.nil?
       
-      case other
-      when String, /^\s*\{/
-        other = MulitJson.decode(other, :symbolize_keys => true)
-      when Hash
-				# do nothing
-      when Attributes
+      case
+      when other.is_a?(String) && /^\s*\{/ =~ other
+        other = MultiJson.decode(other, :symbolize_keys => true)
+      when other.respond_to?(:each_pair)
+        # do nothing
+      when other.respond_to?(:to_hash)
         other = other.to_hash
-			else
-				raise ParseError, "failed to merge attributes and #{other.inspect}"
+      else
+        raise ParseError, "failed to merge attributes and #{other.inspect}"
       end
 
       other.each_pair do |key, value|
-				attributes[filter_key(key)] = filter_value(value, key)
-			end
-      
+        attributes[filter_key(key)] = filter_value(value, key)
+      end
+
       self
     end
 
     alias update merge
     
-		def reverse_merge(other)
-			fail "not implemented yet"
-		end
-
-		def to_hash
-			attributes.deep_copy
-		end
-
-		def to_citeproc
-			Hash[*attributes.map { |k,v|
-				[k.to_s, v.respond_to?(:to_citeproc) ? v.to_citeproc : v.to_s]
-			}.flatten(1)]
-		end
-		
-		def to_json
-			MultiJson.encode(to_citeproc)
-		end
-
-		# Don't expose internals to public API
-		private :filter_key, :filter_value
-		
-		# initialize_copy should be able to access attributes
-		protected :attributes
-		
-
-	
-		# def eql?(other)
-		# 	case
-		# 	when equal?(other)
-		# 		true
-		# 	when self.class != other.class, length != other.length
-		# 		false
-		# 	else
-		# 		other.attributes.each_pair do |key, value|
-		# 			return false unless attributes[key].eql?(value)
-		# 		end
-		# 		
-		# 		true
-		# 	end
-		# end
-		# 
-		# def hash
-		# end
-		
+    def reverse_merge(other)
+      fail "not implemented yet"
+    end
+
+    def to_hash
+      attributes.deep_copy
+    end
+
+    # @return [Hash] a hash-based representation of the attributes
+    def to_citeproc
+      Hash[attributes.map { |k,v|
+        [k.to_s, v.respond_to?(:to_citeproc) ? v.to_citeproc : v.to_s]
+      }]
+    end
+    
+    # @return [String] a JSON string representation of the attributes
+    def to_json
+      MultiJson.encode(to_citeproc)
+    end
+
+    # Don't expose internals to public API
+    private :filter_key, :filter_value
+    
+    # initialize_copy should be able to access attributes
+    protected :attributes
+
+
+    # Two Attribute-based objects are equal if they are the same object,
+    # or if all their attributes are equal using _#eql?_.
+    # 
+    # @param other [Object] the other object
+    # @return [Boolean] whether or not self and passed-in object are equal
+    def eql?(other)
+      case
+      when equal?(other)
+        true
+      when self.class != other.class, length != other.length
+        false
+      else
+        other.attributes.each_pair do |key, value|
+          return false unless attributes[key].eql?(value)
+        end
+        
+        true
+      end
+    end
+
+    # @return [Fixnum] a hash value based on the object's attributes
+    def hash
+      digest = size
+      attributes.each do |attribute|
+        digest ^= attribute.hash
+      end
+      
+      digest
+    end
+    
     module ClassMethods
 
-			def create(parameters)
-				create!(parameters)
-			rescue
-				nil
-			end
+      def create(parameters)
+        create!(parameters)
+      rescue
+        nil
+      end
 
-			def create!(parameters)
-				new.merge(parameters)
-			end
+      def create!(parameters)
+        new.merge(parameters)
+      end
 
       def attr_predicates(*arguments)
         arguments.flatten.each do |field|
@@ -152,12 +159,12 @@ module CiteProc
             attributes[field.to_sym] = value
           end
         end
-        				
+                
         predicate_id = [method_id, '?'].join  
         if predicate && !instance_methods.include?(predicate_id)
           define_method(predicate_id) do
-						v = attributes[field.to_sym]
-						!(v.nil? || (v.respond_to?(:empty?) && v.empty?) || v =~ FALSE_PATTERN)
+            v = attributes[field.to_sym]
+            !(!v || (v.respond_to?(:empty?) && v.empty?) || v.to_s =~ /^(false|no|never)$/i)
           end
           
           has_predicate = ['has_', predicate_id].join