citeproc 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright 2009-2011 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:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+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.

data/README.md

@@ -0,0 +1,2 @@
+CiteProc
+========

data/auto.watchr

@@ -0,0 +1,20 @@
+
+# Rules
+# --------------------------------------------------
+watch( '^spec/.+_spec.rb' ) { |m| rspec m[0] }
+watch( '^lib/(.*)\.rb' ) { |m| rspec "spec/#{m[1]}_spec.rb" }
+
+# Signal Handling
+# --------------------------------------------------
+Signal.trap('QUIT') { rspec 'spec' } # Ctrl-\
+Signal.trap('INT' ) { abort("\n") } # Ctrl-C
+
+def rspec (*paths)
+	paths = paths.reject { |p| !File.exists?(p) }
+	run "bundle exec rspec #{ paths.empty? ? 'spec' : paths.join(' ') }"
+end
+
+def run (cmd)
+  puts cmd
+  system cmd
+end

data/citeproc.gemspec

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'citeproc/version'
+
+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.summary     = 'A cite processor interface.'
+  s.description = 'A a cite processor for Citation Style Language (CSL) styles.'
+  s.license     = 'FreeBSD'
+  s.date        = Time.now.strftime('%Y-%m-%d')
+
+  s.add_runtime_dependency('multi_json', '~>1.0')
+  
+  s.add_development_dependency('cucumber', ['>=1.0.2'])
+  s.add_development_dependency('rspec', ['>=2.6.0'])
+  s.add_development_dependency('watchr', ['>=0.7'])
+
+  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}
+  
+end
+
+# vim: syntax=ruby

data/lib/citeproc.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+
+require 'citeproc/version'
+require 'citeproc/extensions'
+require 'citeproc/errors'
+require 'citeproc/abbreviate'
+require 'citeproc/engine'
+require 'citeproc/processor'
+require 'citeproc/utilities'
+
+CiteProc.extend CiteProc::Utilities

data/lib/citeproc/abbreviate.rb

@@ -0,0 +1,30 @@
+require 'multi_json'
+
+module CiteProc
+  module Abbreviate
+    
+    attr_reader :abbreviations
+    attr_accessor :default_namespace
+    
+    def abbreviations=(abbreviations)
+      @abbreviations = case abbreviations
+      when ::String
+        MultiJson.decode(abbreviations, :symbolize_keys => true)
+      when ::Hash
+       abbreviations.deep_copy
+      else raise ArgumentError, "failed to set abbreviations from #{abbreviations.inspect}"
+      end
+    end
+    
+    # call-seq:
+    # 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(default_namespace || :default) if arguments.length < 3
+      @abbreviations.deep_fetch(*arguments)
+    end
+    
+    alias abbrev abbreviate
+
+  end
+end

data/lib/citeproc/engine.rb

@@ -0,0 +1,126 @@
+require 'forwardable'
+
+module CiteProc
+  
+  class Engine
+    
+    extend Forwardable
+    include Abbreviate
+    
+    @subclasses ||= []
+
+    class << self
+      
+      attr_reader :subclasses, :type, :version
+   
+      private :new
+      
+      def inherited(subclass)
+        subclass.public_class_method :new
+        @subclasses << subclass
+        @subclasses = subclasses.sort_by { |engine| -1 * engine.priority }
+      end
+
+      # Returns the engine class for the given name or nil. If no suitable
+      # class is found and a block is given, executes the block and returns
+      # the result. The list of available engines will be passed to the block.
+      def detect(name)
+        subclasses.detect { |e| e.name == name } ||
+          block_given? ? yield(subclasses) : nil
+      end
+      
+      # Loads the engine with the given name and returns the engine class.
+      def detect!(name)
+        load(name)
+        block_given? ? detect(name, &Proc.new) : detect(name)
+      end
+      
+      # Returns the best available engine class or nil.
+      def autodetect(options = {})
+        klass = subclasses.detect { |e|
+          !options.has_key?(:engine) || e.name == options[:engine] and
+          !options.has_key?(:name) || e.name == options[:name]
+        } || subclasses.first        
+      end
+      
+      # Loads the engine by requiring the engine name.
+      def load(name)
+        require name.gsub(/-/,'/')
+      rescue LoadError => e
+        warn "failed to load #{name} engine: try to gem install #{name}"
+      end
+      
+      # Returns a list of all available engine names.
+      def available
+        subclasses.map(&:engine_name)
+      end
+      
+      def engine_name
+        @name ||= name.gsub(/::/, '-').downcase # returns class name as fallback
+      end
+
+      def priority
+        @priority ||= 0
+      end      
+    end
+
+    attr_accessor :processor, :locales, :style
+
+    def_delegators :@processor, :items, :options
+    
+    
+    def initialize(attributes = {})
+      @processor = attributes[:processor]
+      @abbreviations = attributes[:abbreviations] || { :default => {} }
+      yield self if block_given?
+    end
+
+    def start
+      @started = true
+      self
+    end
+    
+    def stop
+      @started = false
+      self
+    end
+    
+    def started?; !!@started; end
+    
+    alias running? started?
+    
+    [[:name, :engine_name], :type, :version].each do |method_id, target|
+      define_method(method_id) do
+        self.class.send(target || method_id)
+      end
+    end
+    
+    def process
+      raise NotImplementedByEngine
+    end
+    
+    def append
+      raise NotImplementedByEngine
+    end
+    
+    alias append_citation_cluster append
+    
+    def process_citation_cluster
+      raise NotImplementedByEngine
+    end
+        
+    def make_bibliography
+      raise NotImplementedByEngine
+    end
+    
+    def update_items
+      raise NotImplementedByEngine
+    end
+    
+    def update_uncited_items
+      raise NotImplementedByEngine
+    end
+            
+  end
+
+end

data/lib/citeproc/errors.rb

@@ -0,0 +1,17 @@
+module CiteProc
+
+  class Error < StandardError
+    attr_reader :original
+
+    def initialize(message, original = nil)
+      @original = original ? super([message, original.message].join(': ')) : super(message)
+    end    
+  end
+  
+  class EngineError < Error
+  end
+  
+  class NotImplementedByEngine < EngineError
+  end
+  
+end

data/lib/citeproc/extensions.rb

@@ -0,0 +1,44 @@
+
+module CiteProc
+  module Extensions
+    
+    module DeepCopy  
+      def deep_copy
+        Hash[*map { |k,v| [
+          k.is_a?(Symbol) ? k : k.respond_to?(:deep_copy) ? k.deep_copy : k.clone,
+          v.is_a?(Symbol) ? v : v.respond_to?(:deep_copy) ? v.deep_copy : v.clone
+        ]}.flatten]
+      end
+    end
+   
+    module DeepFetch     
+      def deep_fetch(*arguments)
+        arguments.reduce(self) { |s,a| s[a] } rescue nil
+      end
+      
+      def [](*arguments)
+        return super if arguments.length == 1
+        deep_fetch(*arguments)
+      end
+      
+    end
+    
+    module AliasMethods
+      private
+      def alias_methods(*arguments)
+        raise ArgumentError, "wrong number of arguments (#{arguments.length} for 2 or more)" if arguments.length < 2
+        method_id = arguments.shift
+        arguments.each { |a| alias_method method_id, a }
+      end
+    end
+  end
+end
+
+class Hash
+  include CiteProc::Extensions::DeepCopy
+  include CiteProc::Extensions::DeepFetch
+end
+
+# module Kernel
+#   include CiteProc::Extensions::AliasMethods
+# end

data/lib/citeproc/processor.rb

@@ -0,0 +1,24 @@
+
+module CiteProc
+  class Processor
+
+    @defaults ||= {
+      :locale => 'en-US',
+      :style  => 'chicago-author-date',
+      :engine => 'citeproc-js',
+      :format => 'html'
+    }
+
+    class << self
+      attr_reader :defaults
+    end
+
+    attr_reader :options, :engine, :items
+     
+    def initialize(options = {})
+      @options = Processor.defaults.merge(options)
+      @engine = Engine.autodetect(@options).new :processor => self
+    end
+    
+  end
+end

data/lib/citeproc/utilities.rb

@@ -0,0 +1,19 @@
+
+module CiteProc
+  module Utilities
+
+    # call-seq:
+    # process(mode = :bibliography, items, options = {})
+    def process(*arguments)
+    end
+    
+    def cite(items, options = {})
+      process(:citation, items, options)
+    end
+    
+    def bibliography(items, options = {})
+      process(:bibliography, items, options)
+    end
+
+  end
+end

data/lib/citeproc/version.rb

@@ -0,0 +1,3 @@
+module CiteProc
+  VERSION = '0.0.1'.freeze
+end

data/spec/citeproc/abbreviate_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module CiteProc
+  describe 'Abbreviate' do
+    before { Object.class_eval { include Abbreviate } }
+
+    let(:subject) { Object.new }
+        
+    describe '#abbreviations=' do
+      context 'given a hash' do
+        let(:abbrev) { Hash[:foo, :bar] }
+        it 'uses the hash as the new set of abbreviations' do
+          subject.abbreviations = abbrev
+          subject.abbreviations.should == abbrev
+          subject.abbreviations.should_not equal(abbrev)
+        end
+      end
+      
+      context 'given a string' do
+        let(:abbrev) { '{"foo":"bar"}' }
+        it 'uses the hash as the new set of abbreviations' do
+          subject.abbreviations = abbrev
+          subject.abbreviations.should == Hash[:foo,'bar']
+        end
+      end
+    end
+    
+    describe '#abbreviate' do
+    end
+    
+  end
+end

data/spec/citeproc/engine_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module CiteProc
+  describe 'Engine' do
+
+    it 'cannot be instantiated' do
+      lambda { Engine.new }.should raise_error(NoMethodError)
+    end
+    
+    describe 'subclasses' do
+      let(:subject) { Class.new(Engine).new { |e| e.processor = double(:processor) } }
+
+      it 'can be instantiated' do
+        subject.should_not be nil
+      end
+      
+      it 'can be started' do
+        expect { subject.start }.to change { subject.running? }.from(false).to(true)
+      end
+      
+    end
+    
+  end
+end

data/spec/citeproc/extensions_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Hash do
+  let(:hash) { { :a => { :b => { :c => :d } } } }
+  
+
+  describe '#deep_copy' do
+    it { hash.should respond_to(:deep_copy) }
+
+    it 'returns a copy equal to the hash' do
+      hash.deep_copy.should == hash
+    end
+    
+    it 'returns a copy that is not identical to the hash' do
+      hash.deep_copy.should_not equal(hash)
+    end
+    
+    it 'returns a deep copy' do
+      hash.deep_copy[:a].should == hash[:a]
+      hash.deep_copy[:a].should_not equal(hash[:a])
+      hash.deep_copy[:a][:b].should == hash[:a][:b]
+      hash.deep_copy[:a][:b].should_not equal(hash[:a][:b])
+      hash.deep_copy[:a][:b][:c].should == hash[:a][:b][:c]
+    end
+  end
+  
+  describe '#deep_fetch' do
+    # it 'behaves like normal for two arguments' do
+    #   hash.fetch(:b, 42).should == 42
+    # end
+    # 
+    # it 'behaves like normal for one argument and a block' do
+    #   hash.fetch(:b) {42}.should == 42
+    # end
+    
+    it 'returns the value of all the arguments applied as keys' do
+      hash.deep_fetch(:a, :b, :c).should == :d
+    end
+    
+    it 'returns nil if any of the values did not exist' do
+      hash.deep_fetch(:x, :b, :c).should be nil
+      hash.deep_fetch(:a, :x, :c).should be nil
+      hash.deep_fetch(:a, :b, :x).should be nil
+    end
+
+  end
+end

data/spec/citeproc/processor_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+module CiteProc
+  describe 'Processor' do
+    before { Class.new(Engine) }
+    
+    let(:subject) { Processor.new }
+    
+    it { should_not be nil }
+    
+  end
+end

data/spec/citeproc/utilities_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'CiteProc' do
+
+  describe '.process' do
+    it 'is defined' do
+      CiteProc.should respond_to(:process)
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'citeproc'

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: citeproc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sylvester Keil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-03 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &2157053340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157053340
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &2157052700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: *2157052700
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157052100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *2157052100
+- !ruby/object:Gem::Dependency
+  name: watchr
+  requirement: &2157051560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: *2157051560
+description: A a cite processor for Citation Style Language (CSL) styles.
+email: http://sylvester.keil.or.at
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- auto.watchr
+- citeproc.gemspec
+- lib/citeproc.rb
+- lib/citeproc/abbreviate.rb
+- lib/citeproc/engine.rb
+- lib/citeproc/errors.rb
+- lib/citeproc/extensions.rb
+- lib/citeproc/processor.rb
+- lib/citeproc/utilities.rb
+- lib/citeproc/version.rb
+- spec/citeproc/abbreviate_spec.rb
+- spec/citeproc/engine_spec.rb
+- spec/citeproc/extensions_spec.rb
+- spec/citeproc/processor_spec.rb
+- spec/citeproc/utilities_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://inukshuk.github.com/citeproc
+licenses:
+- FreeBSD
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- ! '"CiteProc"'
+- --main
+- README.md
+- --webcvs=http://github.com/inukshuk/citeproc/tree/master/
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A cite processor interface.
+test_files:
+- spec/citeproc/abbreviate_spec.rb
+- spec/citeproc/engine_spec.rb
+- spec/citeproc/extensions_spec.rb
+- spec/citeproc/processor_spec.rb
+- spec/citeproc/utilities_spec.rb
+- spec/spec_helper.rb