citeproc-ruby 0.0.6 → 1.0.0

data/spec/citeproc/ruby/renderer/date_spec.rb

@@ -0,0 +1,173 @@
+require 'spec_helper'
+
+module CiteProc
+  module Ruby
+
+    describe 'Renderer#render_date' do
+      let(:renderer) { Renderer.new }
+
+      let(:item) {
+        i = CiteProc::CitationItem.new(:id => 'ID-1')
+        i.data = CiteProc::Item.new(:id => 'ID-1')
+        i
+      }
+
+      describe 'localized rendering' do
+        let(:node) { CSL::Style::Date.new(:variable => 'issued', :form => 'numeric') }
+
+        describe 'given an item issued on January 27th, 2012' do
+          before(:each) { item.data[:issued] = '2012-01-27' }
+
+          it "uses the locale's date parts to render the date" do
+            renderer.render(item, node).should == '01/27/2012'
+          end
+        end
+      end
+
+      describe 'static rendering' do
+        let(:node) { CSL::Style::Date.new(:variable => 'issued') }
+
+        describe 'given an item issued on January 27th, 2012' do
+          before(:each) { item.data[:issued] = '2012-01-27' }
+
+          it 'returns an empty string by default' do
+            renderer.render_date(item, node).should == ''
+          end
+
+          describe 'and given a node with a year part' do
+            before(:each) { node << CSL::Style::DatePart.new(:name => 'year') }
+
+            it 'returns the year as "2012"' do
+              renderer.render_date(item, node).should == '2012'
+            end
+
+            describe 'and a day part' do
+              before(:each) { node << CSL::Style::DatePart.new(:name => 'day') }
+
+              it 'returns "201227"' do
+                renderer.render_date(item, node).should == '201227'
+              end
+
+              it 'applies delimiters when set on the node' do
+                node[:delimiter] = '/'
+                renderer.render_date(item, node).should == '2012/27'
+              end
+
+              describe 'and a month part' do
+                before(:each) { node << CSL::Style::DatePart.new(:name => 'month') }
+
+                it 'returns "201227January"' do
+                  renderer.render_date(item, node).should == '201227January'
+                end
+
+                it 'returns "2012/27/01" when the month form set to "numeric-leading-zeros" and the node has a delimiter "/"' do
+                  node.parts.last[:form] = 'numeric-leading-zeros'
+                  node[:delimiter] = '/'
+                  renderer.render_date(item, node).should == '2012/27/01'
+                end
+              end
+            end
+          end
+        end
+      end
+
+    end
+
+    describe 'Renderer#render_date_part' do
+      let(:renderer) { Renderer.new }
+      let(:node) { CSL::Style::DatePart.new }
+
+      let(:today) { CiteProc::Date.today }
+
+      let(:january) { CiteProc::Date.new([2012, 1]) }
+      let(:december) { CiteProc::Date.new([2012, 12]) }
+      let(:independence) { CiteProc::Date.new([1776, 7, 4]) }
+
+      it 'returns an empty string by default' do
+        renderer.render_date_part(CiteProc::Date.today, node).should == ''
+      end
+
+      describe 'when the name is set to "day"' do
+        before(:each) { node[:name] = 'day' }
+
+        it 'renders the day as number by default' do
+          renderer.render_date_part(today, node).should == today.day.to_s
+        end
+
+        it 'renders the day as an ordinal number when the form is set to "ordinal"' do
+          node[:form] = 'ordinal'
+          renderer.render_date_part(independence, node).should == '4th'
+
+          renderer.locale.limit_day_ordinals!
+          renderer.render_date_part(independence, node).should == '4'
+
+          independence.day = 1
+          renderer.render_date_part(independence, node).should == '1st'
+        end
+      end
+
+      describe 'when the name is set to "month"' do
+        before(:each) { node[:name] = 'month' }
+
+        it "renders the month's full name by default" do
+          renderer.render_date_part(january, node).should == 'January'
+          renderer.render_date_part(december, node).should == 'December'
+        end
+
+        it "renders the month's full name as the long form" do
+          node[:form] = 'long'
+          renderer.render_date_part(january, node).should == 'January'
+        end
+
+        it "renders the month's short name as the short form" do
+          node[:form] = 'short'
+          renderer.render_date_part(january, node).should == 'Jan.'
+        end
+
+        it 'renders the month as number as the numeric form' do
+          node[:form] = 'numeric'
+          renderer.render_date_part(january, node).should == '1'
+        end
+
+        it 'renders the month as number with a leading zero when form is set to numeric-leading-zeros' do
+          node[:form] = 'numeric-leading-zeros'
+          renderer.render_date_part(january, node).should == '01'
+          renderer.render_date_part(december, node).should == '12'
+        end
+
+        it 'renders the name of the season when a season is set' do
+          january.season = 4
+          renderer.render_date_part(january, node).should == 'Winter'
+        end
+      end
+
+      describe 'when the name is set to "year"' do
+        before(:each) { node[:name] = 'year' }
+
+        it 'renders the full year by default' do
+          renderer.render_date_part(today, node).should == today.year.to_s
+        end
+
+        it 'renders the full year when form is set to long' do
+          node[:form] = 'long'
+          renderer.render_date_part(january, node).should == '2012'
+        end
+
+        it 'renders the short year when form is set to short' do
+          node[:form] = 'short'
+          renderer.render_date_part(january, node).should == '12'
+        end
+
+        it 'adds AD if applicable' do
+          renderer.render_date_part(CiteProc::Date.new([200]), node) == '200AD'
+        end
+
+        it 'adds BC if applicable' do
+          renderer.render_date_part(CiteProc::Date.new([-200]), node) == '200BC'
+        end
+      end
+
+    end
+
+  end
+end

data/spec/citeproc/ruby/renderer/group_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+module CiteProc
+  module Ruby
+    describe 'Renderer#render_group' do
+      let(:renderer) { Renderer.new }
+
+      let(:item) {
+        i = CiteProc::CitationItem.new(:id => 'ID-1')
+        i.data = CiteProc::Item.new(:id => 'ID-1')
+        i
+      }
+
+      let(:node) { CSL::Style::Group.new }
+
+      it 'returns an empty string by default' do
+        renderer.render(item, node).should == ''
+
+        node[:prefix] = '!'
+        renderer.render(item, node).should == ''
+      end
+
+      describe 'when there is a text node in the group' do
+        before(:each) { node << CSL::Style::Text.new( :term => 'retrieved') }
+
+        it 'returns the content of the nested node' do
+          renderer.render_group(item, node).should == 'retrieved'
+        end
+
+        it 'applies formatting options to the nested node' do
+          node[:'text-case'] = 'uppercase'
+          renderer.render(item, node).should == 'RETRIEVED'
+        end
+
+        describe 'when there is a second text node in the group' do
+          before(:each) { node << CSL::Style::Text.new( :term => 'from') }
+
+          it 'returns the content of both nested nodes' do
+            renderer.render_group(item, node).should == 'retrievedfrom'
+          end
+
+          describe 'when there is a delimter set on the group node' do
+            before(:each) { node[:delimiter] = ' ' }
+
+            it 'applies the delimiter to the output' do
+              renderer.render_group(item, node).should == 'retrieved from'
+            end
+
+            it 'applies formatting options to the nested nodes only' do
+              node[:'text-case'] = 'uppercase'
+              node[:delimiter] = ' foo '
+              node[:prefix] = '('
+              node[:suffix] = ')'
+              renderer.render(item, node).should == '(RETRIEVED foo FROM)'
+            end
+
+            describe 'when a nested node produces no output' do
+              before(:each) do
+                node << CSL::Style::Text.new( :term => 'fooo')
+                node << CSL::Style::Text.new( :term => 'from')
+              end
+
+              it 'the delimiter does not apply to it' do
+                renderer.render_group(item, node).should == 'retrieved from from'
+              end
+            end
+
+            describe 'when there is a variable-based node in the group' do
+              before(:each) { node << CSL::Style::Text.new( :variable => 'URL') }
+
+              it 'returns the empty string when the variable is not present in the item' do
+                renderer.render_group(item, node).should == ''
+              end
+
+              describe 'when the variable is present' do
+                before(:each) { item.data[:URL] = 'http://example.org' };
+
+                it 'returns all nested renditions' do
+                  renderer.render_group(item, node).should == 'retrieved from http://example.org'
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/citeproc/ruby/renderer/history_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module CiteProc
+  module Ruby
+
+    describe Renderer::History do
+      let(:state) { Renderer::State.new }
+      let(:history) { state.history }
+
+      it 'has an empty citation history' do
+        history.memory['citation'].should == []
+      end
+
+      it 'has an empty bibliography history' do
+        history.memory['bibliogrpahy'].should == []
+      end
+
+      describe '#update' do
+        it 'saves the passed in items for :store!' do
+          lambda {
+            history.update :store!, 'citation', { :x => 1 }
+          }.should change { history.citation }.to([{ :x => 1 }])
+        end
+
+        it 'drops remembered items when they are too old' do
+          lambda {
+            history.update :store!, 'citation', { :x => 1 }
+            history.update :store!, 'citation', { :x => 1 }
+            history.update :store!, 'citation', { :x => 1 }
+            history.update :store!, 'citation', { :x => 1 }
+            history.update :store!, 'citation', { :x => 1 }
+          }.should change { history.citation.length }.to(3)
+        end
+      end
+    end
+
+  end
+end

data/spec/citeproc/ruby/renderer/label_spec.rb

@@ -0,0 +1,225 @@
+require 'spec_helper'
+
+module CiteProc
+  module Ruby
+
+    describe "Renderer#render_label" do
+      let(:renderer) { Renderer.new }
+
+      let(:node) { CSL::Style::Label.new }
+
+      let(:item) {
+        i = CiteProc::CitationItem.new(:id => 'ID-1')
+        i.data = CiteProc::Item.new(:id => 'ID-1')
+        i
+      }
+
+      describe 'given an empty node' do
+        it 'returns an empty string for an empty item' do
+          renderer.render_label(item, node).should == ''
+        end
+
+        it 'returns an empty string for an item with variables' do
+          item.data.edition = 'foo'
+          renderer.render_label(item, node).should == ''
+        end
+      end
+
+
+      # page
+
+      describe "when the node's variable is set to :page" do
+        before(:each) { node[:variable] = :page }
+
+        describe "for an item with no page value" do
+          it 'returns an empty string' do
+            renderer.render_label(item, node).should == ''
+          end
+        end
+
+        describe 'for an item with a page value' do
+          it 'returns the singular label for a number' do
+            item.write_attribute :page, '23'
+            renderer.render_label(item, node).should == 'page'
+          end
+
+          it 'returns the plural label for a page-range' do
+            item.write_attribute :page, '23-24'
+            renderer.render_label(item, node).should == 'pages'
+          end
+
+          it 'returns the plural label for multiple pages' do
+            item.write_attribute :page, '23 & 24'
+            renderer.render_label(item, node).should == 'pages'
+
+            item.write_attribute :page, '23, 24, 25'
+            renderer.render_label(item, node).should == 'pages'
+          end
+
+          describe 'when pluralization is contextual' do
+            before(:each) { node[:plural] = 'contextual' }
+
+            it 'returns the singular label for a number' do
+              item.write_attribute :page, '23'
+              renderer.render_label(item, node).should == 'page'
+            end
+
+            it 'returns the plural label for a page-range' do
+              item.write_attribute :page, '23-24'
+              renderer.render_label(item, node).should == 'pages'
+            end
+          end
+
+          describe 'when pluralization is set to "always"' do
+            before(:each) { node[:plural] = 'always' }
+
+            it 'returns the singular label for a number' do
+              item.write_attribute :page, '1'
+              renderer.render_label(item, node).should == 'pages'
+            end
+
+            it 'returns the plural label for a page-range' do
+              item.write_attribute :page, '1-3'
+              renderer.render_label(item, node).should == 'pages'
+            end
+          end
+
+          describe 'when pluralization is set to "never"' do
+            before(:each) { node[:plural] = 'never' }
+
+            it 'returns the singular label for a number' do
+              item.write_attribute :page, '1'
+              renderer.render_label(item, node).should == 'page'
+            end
+
+            it 'returns the plural label for a page-range' do
+              item.write_attribute :page, '1-3'
+              renderer.render_label(item, node).should == 'page'
+            end
+          end
+        end
+      end
+
+
+      # number-of-pages variable
+
+      describe "when the node's variable is set to :'number-of-pages'" do
+        before(:each) { node[:variable] = 'number-of-pages' }
+
+        describe "for an item with no 'number-of-pages' value" do
+          it 'returns an empty string' do
+            renderer.render_label(item, node).should == ''
+          end
+        end
+
+        describe "for an item with a 'number-of-pages' value" do
+          it 'returns the singular label for number 1' do
+            item.data[:'number-of-pages'] = 1
+            renderer.render_label(item, node).should == 'page'
+          end
+
+          it 'returns the plural label for numbers higher than 1' do
+            item.data[:'number-of-pages'] = '2'
+            renderer.render_label(item, node).should == 'pages'
+
+            item.data[:'number-of-pages'] = 42
+            renderer.render_label(item, node).should == 'pages'
+          end
+
+          describe 'when pluralization is set to "contextual"' do
+            before(:each) { node[:plural] = 'contextual' }
+
+            it 'returns the singular label for number 1' do
+              item.data[:'number-of-pages'] = '1'
+              renderer.render_label(item, node).should == 'page'
+            end
+
+            it 'returns the plural label for numbers higher than 1' do
+              item.data[:'number-of-pages'] = '2'
+              renderer.render_label(item, node).should == 'pages'
+
+              item.data[:'number-of-pages'] = 42
+              renderer.render_label(item, node).should == 'pages'
+            end
+          end
+
+          describe 'when pluralization is set to "always"' do
+            before(:each) { node[:plural] = 'always' }
+
+            it 'returns the singular label for number 1' do
+              item.data[:'number-of-pages'] = 1
+              renderer.render_label(item, node).should == 'pages'
+            end
+
+            it 'returns the plural label for numbers higher than 1' do
+              item.data[:'number-of-pages'] = '2'
+              renderer.render_label(item, node).should == 'pages'
+
+              item.data[:'number-of-pages'] = 42
+              renderer.render_label(item, node).should == 'pages'
+            end
+          end
+
+          describe 'when pluralization is set to "never"' do
+            before(:each) { node[:plural] = 'never' }
+
+            it 'returns the singular label for number 1' do
+              item.data[:'number-of-pages'] = 1
+              renderer.render_label(item, node).should == 'page'
+            end
+
+            it 'returns the plural label for numbers higher than 1' do
+              item.data[:'number-of-pages'] = '2'
+              renderer.render_label(item, node).should == 'page'
+
+              item.data[:'number-of-pages'] = 42
+              renderer.render_label(item, node).should == 'page'
+            end
+          end
+        end
+      end
+
+      # number-of-volumes variable
+
+      describe "when the node's variable is set to :'number-of-volumes'" do
+        before(:each) { node[:variable] = 'number-of-volumes' }
+
+        describe "for an item with a 'number-of-volumes' value" do
+          it 'returns the singular label for number 1' do
+            item.data[:'number-of-volumes'] = 1
+            renderer.render_label(item, node).should == 'volume'
+          end
+
+          it 'returns the plural label for numbers higher than 1' do
+            item.data[:'number-of-volumes'] = '2'
+            renderer.render_label(item, node).should == 'volumes'
+
+            item.data[:'number-of-volumes'] = 42
+            renderer.render_label(item, node).should == 'volumes'
+          end
+        end
+      end
+
+      # locators
+
+      describe "when the node's variable is set to another locator" do
+        before(:each) { node[:variable] = 'locator' }
+
+        describe "for an item with a locator and label" do
+          it "returns the singular label for a single number" do
+            item.locator = 2
+            item.label = 'book'
+            renderer.render_label(item, node).should == 'book'
+          end
+
+          it "returns the plural label for multiple numbers" do
+            item.locator = '23 & 4'
+            item.label = 'book'
+            renderer.render_label(item, node).should == 'books'
+          end
+        end
+      end
+
+    end # render_label
+  end
+end