citero_renderers 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2ac9337d99806004919e883bcde7e07cf4d9333
+  data.tar.gz: 3e936ba1f9a98933b16a046e5191dca915c81e84
+SHA512:
+  metadata.gz: d0d2959b04c2cc4b53a41c2ab90fccbf43687d44134a15ad57fb1c48e261ab58b416dd7fad4e24149519f634a64fefc2868a0025906456cae51e4748ce8b172c
+  data.tar.gz: 0ee0106e933ea4840edfcf84879d5ac19eb0c80b48274cebfa0487e8a78456d58f02a4ff70155f29560b93b88032c34b979f1326e8061621e8cca2a384cf7e0c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 NYU Division of Libraries
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= CiteroRenderers
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CiteroRenderers'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/citero_renderers.rb

@@ -0,0 +1,25 @@
+module CiteroRenderers
+  class CiteroRenderersRailTie < ::Rails::Railtie
+    config.after_initialize do
+      require 'citero_renderers/bibtex_renderable'
+      require 'citero_renderers/ris_renderable'
+      require 'citero_renderers/mime_types/ris_mime_type'
+      require 'citero_renderers/mime_types/bibtex_mime_type'
+      require 'action_controller/metal/renderers'
+      # Adds a renderer for BibTeX.
+      ActionController.add_renderer :bibtex do |bibtex,option|
+        bibtex.extend CiteroRenderers::BibtexRenderable unless bibtex.respond_to?(:to_bibtex)
+        filename = (bibtex.respond_to?(:to_param) and bibtex.class.respond_to?(:acts_as_citable)) ? bibtex.to_param : "export"
+        bibtex = bibtex.to_bibtex
+        send_data bibtex, type: Mime::Type.lookup(:bibtex), disposition: "attachment; filename=#{filename}.bib"
+      end
+      # Adds a renderer for RIS.
+      ActionController.add_renderer :ris do |ris, option|
+        ris.extend CiteroRenderers::RisRenderable unless ris.respond_to?(:to_ris)
+        filename = (ris.respond_to?(:to_param) and ris.class.respond_to?(:acts_as_citable)) ? ris.to_param : "export"
+        ris = ris.to_ris()
+        send_data ris, type: Mime::Type.lookup(:ris), disposition: "attachment; filename=#{filename}.ris"
+      end
+    end
+  end
+end

data/lib/citero_renderers/bibtex_renderable.rb

@@ -0,0 +1,7 @@
+module CiteroRenderers
+  module BibtexRenderable
+    def to_bibtex
+      self.collect { |r| r.to_bibtex if r.respond_to? :to_bibtex }.join("\n\n")
+    end
+  end
+end

data/lib/citero_renderers/mime_types/bibtex_mime_type.rb

@@ -0,0 +1,6 @@
+module CiteroRenderers
+  module MimeTypes
+    # Mime type for bibtex and an alias, bib
+    Mime::Type.register "application/x-bibtex", :bibtex, [:bib], [:bib]
+  end
+end

data/lib/citero_renderers/mime_types/ris_mime_type.rb

@@ -0,0 +1,6 @@
+module CiteroRenderers
+  module MimeTypes
+    # Mime type for RIS
+    Mime::Type.register "application/x-research-info-systems", :ris
+  end
+end

data/lib/citero_renderers/ris_renderable.rb

@@ -0,0 +1,7 @@
+module CiteroRenderers
+  module RisRenderable
+    def to_ris
+      self.collect { |r| r.to_ris if r.respond_to? :to_ris}.join("\n\n")
+    end
+  end
+end

data/lib/citero_renderers/version.rb

@@ -0,0 +1,3 @@
+module CiteroRenderers
+  VERSION = "1.0.1"
+end

data/spec/lib/bibtex_renderable_spec.rb

@@ -0,0 +1,39 @@
+require './spec/spec_helper'
+
+describe CiteroRenderers::BibtexRenderable do
+
+  context 'object is an array' do
+    let(:bibtex_renderable_array) { array.extend CiteroRenderers::BibtexRenderable }
+    context 'array is empty' do
+      let(:array) { Array.new }
+      it 'returns an empty string' do
+        expect(bibtex_renderable_array.to_bibtex).to eql('')
+      end
+    end
+    context 'array has one citero object' do
+      let(:array) { [Citero.map("itemType: book").from_csf] }
+      it 'returns an empty string' do
+        expect(bibtex_renderable_array.to_bibtex).to eql("@book{????\n}")
+      end
+    end
+    context 'array has one active record' do
+      let(:array) { [RecordChangedField.create!(data: "itemType: book", from_format: "csf")] }
+      it 'returns an empty string' do
+        expect(bibtex_renderable_array.to_bibtex).to eql("@book{????\n}")
+      end
+    end
+    context 'array has many citero objects' do
+      let(:array) { [Citero.map("itemType: book").from_csf, Citero.map("itemType: book").from_csf] }
+      it 'returns an empty string' do
+        expect(bibtex_renderable_array.to_bibtex).to eql("@book{????\n}\n\n@book{????\n}")
+      end
+    end
+    context 'array has many active records' do
+      let(:array) { [RecordChangedField.create!(data: "itemType: book", from_format: "csf"),
+                     RecordChangedField.create!(data: "itemType: book", from_format: "csf")] }
+      it 'returns an empty string' do
+        expect(bibtex_renderable_array.to_bibtex).to eql("@book{????\n}\n\n@book{????\n}")
+      end
+    end
+  end
+end

data/spec/lib/ris_renderable_spec.rb

@@ -0,0 +1,39 @@
+require './spec/spec_helper'
+
+describe CiteroRenderers::RisRenderable do
+
+  context 'object is an array' do
+    let(:ris_renderable_array) { array.extend CiteroRenderers::RisRenderable }
+    context 'array is empty' do
+      let(:array) { Array.new }
+      it 'returns an empty string' do
+        expect(ris_renderable_array.to_ris).to eql('')
+      end
+    end
+    context 'array has one citero object' do
+      let(:array) { [Citero.map("itemType: book").from_csf] }
+      it 'returns an empty string' do
+        expect(ris_renderable_array.to_ris).to eql("TY  - BOOK\nER  -\n\n")
+      end
+    end
+    context 'array has one active record' do
+      let(:array) { [RecordChangedField.create!(data: "itemType: book", from_format: "csf")] }
+      it 'returns an empty string' do
+        expect(ris_renderable_array.to_ris).to eql("TY  - BOOK\nER  -\n\n")
+      end
+    end
+    context 'array has many citero objects' do
+      let(:array) { [Citero.map("itemType: book").from_csf, Citero.map("itemType: book").from_csf] }
+      it 'returns an empty string' do
+        expect(ris_renderable_array.to_ris).to eql("TY  - BOOK\nER  -\n\n\n\nTY  - BOOK\nER  -\n\n")
+      end
+    end
+    context 'array has many active records' do
+      let(:array) { [RecordChangedField.create!(data: "itemType: book", from_format: "csf"),
+                     RecordChangedField.create!(data: "itemType: book", from_format: "csf")] }
+      it 'returns an empty string' do
+        expect(ris_renderable_array.to_ris).to eql("TY  - BOOK\nER  -\n\n\n\nTY  - BOOK\nER  -\n\n")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rails/all'
+require 'rspec/rails'
+require 'citero_renderers/ris_renderable'
+require 'citero_renderers/bibtex_renderable'
+require 'acts_as_citable'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :record_changed_fields, :force => true do |t|
+    t.string :data
+    t.string :from_format
+  end
+end
+
+class RecordChangedField < ActiveRecord::Base
+  acts_as_citable do |c|
+    c.format_field = 'from_format'
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: citero_renderers
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- hab278
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: citero-jruby
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: activerecord-jdbcsqlite3-adapter
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: acts_as_citable
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: Renders citero objects for Rails applications.
+email:
+- hab278@nyu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/citero_renderers.rb
+- lib/citero_renderers/bibtex_renderable.rb
+- lib/citero_renderers/ris_renderable.rb
+- lib/citero_renderers/version.rb
+- lib/citero_renderers/mime_types/bibtex_mime_type.rb
+- lib/citero_renderers/mime_types/ris_mime_type.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- spec/spec_helper.rb
+- spec/lib/bibtex_renderable_spec.rb
+- spec/lib/ris_renderable_spec.rb
+homepage: https://github.com/NYULibraries/citero_renderers
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.1.9
+signing_key:
+specification_version: 4
+summary: Renderers for some citero objects.
+test_files:
+- spec/spec_helper.rb
+- spec/lib/bibtex_renderable_spec.rb
+- spec/lib/ris_renderable_spec.rb