citero-jruby 1.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ..gemspec
+gemspec

data/README.md

@@ -0,0 +1,45 @@
+citero-jruby
+======================
+[![Build Status](http://jenkins1.bobst.nyu.edu/view/Citation/job/citero-jruby/badge/icon)](http://jenkins1.bobst.nyu.edu/view/Citation/job/citero-jruby/)
+[![Build Status](https://secure.travis-ci.org/NYULibraries/citero-jruby.png?branch=master)](http://travis-ci.org/NYULibraries/citero-jruby)
+[![Dependency Status](https://gemnasium.com/NYULibraries/citero-jruby.png)](https://gemnasium.com/NYULibraries/citero-jruby)
+[![Code Climate](https://codeclimate.com/github/NYULibraries/citero-jruby.png)](https://codeclimate.com/github/NYULibraries/citero-jruby)
+[![Gem Version](https://badge.fury.io/rb/citero-jruby.png)](http://badge.fury.io/rb/citero-jruby)
+[![Coverage Status](https://coveralls.io/repos/NYULibraries/citero-jruby/badge.png?branch=master)](https://coveralls.io/r/NYULibraries/citero-jruby)
+
+
+A JRuby wrapper for the Citero, enables use of the Citero in JRuby. See [Citero](https://github.com/NYULibraries/citero).
+
+Usage Details
+==============
+
+To use Citero simply pass in your data into the Citero module via the map method. Then call the method that specifies the from format and
+the method that specifies what format you want to translate to.
+
+
+    Citero.map("itemType: book").from\_csf.to_ris		# Returns a string with the value TY  - BOOK\n\nER  -\n\n
+
+
+You can find available formats via:
+
+    Citero.from_formats		# List of from formats (Array)
+    						# pnx, xerxes_xml, ris, openurl, bibtex, csf*
+    Citero.to_formats		# List of to formats (Array)
+    						# ris, openurl, bibtex, easybib, csf*
+*CSF is Citero Standard Form, it's an internal mapping DSL. 
+
+To call a method, simply append the format name after either from\_ or to\_. 
+Note, you must call from\_ before to\_ and map before anything else.
+
+    csf = Citero.map("itemType: book").from_csf
+    csf.to_ris			# ->	TY  - BOOK\n\nER  -\n\n
+    csf.to_openurl		# ->	rft.ulr_ver=Z39.88-2004&rft.ctx_ver=Z39.88-2004&rft.rfr_id=info:sid/libraries.nyu.edu:citero&rft_val_fmlt=info:ofi/fmt:kev:mtx:book&rft.genre=book
+    csf.to_easybib		# ->	{"source":"book","book":{"title":null},"pubtype":{"main":"pubnonperiodical"},"pubnonperiodical":{},"contributors":[{}]}
+    csf.to_bibtex		# ->	@book{????}
+
+Finally, this gem allows you to interact with the CSF object, you can call the _csf_ method.
+
+    rec = Citero.map("itemType: book").from_csf
+    csf = rec.csf
+    p csf.itemType # => Prints ['book']
+    p csf.keys # => Prints ['itemType']

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rake/testtask'
+require 'git'
+require 'fileutils'
+
+begin
+  require 'bundler/setup'
+  require "bundler/gem_tasks"
+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 = 'doc'
+  rdoc.title    = 'citero-jruby'
+  rdoc.options << '--line-numbers'
+  rdoc.options << '--markup markdown'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('app/**/*.rb')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/*.rb']
+  t.verbose = true
+end
+
+desc "Push latest rdoc and rdocs to gh-pages"
+task :ghpages do
+  g = Git.open(Dir.pwd)
+  FileUtils.mv("coverage/", "coverage.bak/", :force => true)
+  FileUtils.mv("doc/", "doc.bak/", :force => true)
+  g.checkout(g.branch('gh-pages'))
+  g.pull("origin", "gh-pages")
+  FileUtils.rm_r("coverage", :force => true)
+  FileUtils.mv("coverage.bak/", "coverage/", :force => true)
+  FileUtils.rm_r("doc", :force => true)
+  FileUtils.mv("doc.bak/", "doc/", :force => true)
+  g.add(".")
+  g.commit_all("Update coverage and rdocs.")
+  g.push("origin", "gh-pages")
+  FileUtils.cp_r("coverage/", "coverage.bak/")
+  FileUtils.cp_r("doc/", "doc.bak/")
+  g.checkout(g.branch('devel'))
+  FileUtils.mv("coverage.bak/", "coverage/", :force => true)
+  FileUtils.mv("doc.bak/", "doc/", :force => true)
+end
+
+desc "Run tests"
+task :default => :test

data/lib/citero-jruby.rb

@@ -0,0 +1 @@
+require 'citero-jruby/base'

data/lib/citero-jruby/CSF.rb

@@ -0,0 +1,56 @@
+module Citero
+  
+  # Java is required in this module.
+  require 'java'
+  require 'citero-jruby/citero.jar'
+  
+  #CSF class, used to interact directly with available metadata.
+  class CSF
+    # CSF object from Citero that is to be used
+    CSF = Java::EduNyuLibraryCitero::CSF
+    
+    # Initialize the CSF object with data
+    def initialize data
+      @csf = CSF::new(data)
+    end
+    
+    # The method_missing override checks to see if the called method
+    # can be evaluated to a key, then stores it and calls it if it can.
+    # For example, .itemType or .authors.
+    def method_missing(meth, *args, &block)
+      # Check to see if it can be evaluated
+      if(matches? meth)
+        #Defines the method and caches it to the class
+        self.class.send(:define_method, meth) do
+          # Splits the method and parameter. See formatize and directionize
+          @csf::config()::getStringArray(meth.to_s).to_a
+        end
+        # calls the method
+        send meth, *args, &block
+      else
+        super
+      end
+    end
+    
+    # Returns true if the method can be evaluated to a key
+    def respond_to? meth, include_private=false
+      if(matches? meth)
+        return true
+      else
+        super
+      end
+    end
+    
+    # Private method. Checks to see if the method name is a valid key
+    # for the configuration file.
+    def matches? meth
+      @csf::config()::containsKey(meth.to_s)
+    end
+    private :matches?
+    
+    # A list of keys that is available in this properties configuration
+    def keys
+      @keys ||= Array.new(@csf::config()::getKeys.collect {|key| key})
+    end
+  end
+end

data/lib/citero-jruby/base.rb

@@ -0,0 +1,148 @@
+require 'citero-jruby/CSF'
+# Citero class, used in builder form as Citero.map("some data").from_format.to_format
+module Citero
+
+  # Import of an important java enum type
+  java_import Java::EduNyuLibraryCitero::Formats
+
+  # Calling the map method creates a new instance of the Base class, with splatter operator passed in
+  def self.map *args
+    Base.new *args
+  end
+
+  # List of available formats Citero exports to as a module class method for quick checks.
+  def self.to_formats
+    @to_formats ||= formats :isDestinationFormat
+  end
+  
+  # List of available formats Citero exports from as a module class method for quick checks.
+  def self.from_formats
+    @from_formats ||= formats :isSourceFormat
+  end
+  
+  private
+  def self.formats meth
+    Formats::values.select {|format| format.send(meth) }.collect {|format| format.name.downcase}
+  end
+  
+  # The Base class is the true wrapper for citation
+  class Base
+    
+    # Import of important java files.
+    JavaCitero = Java::EduNyuLibraryCitero::Citero
+    
+    
+    # The constructor, takes input data taken from the parent module
+    # and creates an instance of the Citero java object. 
+    # Returns itself for builder patttern.
+    def initialize data
+      @citero = JavaCitero::map(data)
+      self
+    end
+    
+    # The from method is private, it takes in a format and gets
+    # the appropriate Format java class and then calls
+    # the from method in the Citero java object and stores its
+    # return value in an instance variable.
+    # Returns itself.
+    def from format
+      #Formats are enums in java, so they are all uppercase
+      @citero = @citero::from(Formats::valueOf(format.upcase))
+      self
+    #rescue any exceptions, if the error is not caught in JAR, most likely a 
+    #problem with the data
+    rescue Exception => e
+      raise TypeError, "Mismatched data for #{format}"
+    end
+    private :from
+    
+    # The to method is private, it takes in a format and gets
+    # the appropriate Format java class and then calls
+    # the to method in the Citero java object and returns the
+    # return value as a string.
+    def to format
+      #Formats are enums in java, so they are all uppercase
+      @citero::to(Formats::valueOf(format.upcase))
+    #rescue any exceptions, if the error is not caught in JAR, most likely a 
+    #problem with the source format
+    rescue Exception => e
+      raise ArgumentError, "Missing a source format. Use from_[format] first."
+    end
+    private :to
+    
+    # Returns a CSF object 
+    def csf
+      CSF::new(self.to_csf)
+    # Rescue all exceptions, but mostly likeley a problem with the source format.
+    rescue Exception => e
+      raise ArgumentError, "Missing a source format. Use from_[format] first."
+    end
+    
+    # The method_missing override checks to see if the called method
+    # can be evaluated to a method name and parameter, then stores it
+    # and calls it if it can.
+    # For example, to_csf or from_pnx. pnx_to will not work.
+    def method_missing(meth, *args, &block)
+      # Check to see if it can be evaluated
+      if(matches? meth)
+        #Defines the method and caches it to the class
+        self.class.send(:define_method, meth) do
+          # Splits the method and parameter. See formatize and directionize
+          send directionize(meth).to_sym, formatize(meth)
+        end
+        # calls the method
+        send meth, *args, &block
+      else
+        super
+      end
+    end
+    
+    # Returns true if the method can be evaluated to a method name
+    # and parameter.
+    def respond_to? meth, include_private=false
+      if(matches? meth)
+        return true
+      else
+        super
+      end
+    end
+    
+    # Private method. Checks to see if the method name is in the list of methods
+    # that can accept the formats, and checks to see if the formats are in a list
+    # of formats as defined by the Java enum Format.
+    def matches? meth
+      directions.include? directionize(meth) and method("#{directionize(meth)}_formats").call.include? formatize(meth)
+    end
+    private :matches?
+    
+    # Splits the method to get its direction, or method ie to and from.
+    def directionize meth, delimiter="_"
+      meth.to_s.split(delimiter, 2).first
+    end
+    private :directionize
+    
+    # Splits the method to get its format, or parameter ie csf or ris.
+    def formatize meth, delimiter="_"
+      meth.to_s.split(delimiter, 2).last
+    end
+    private :formatize
+    
+    # List of available directions or methods.
+    def directions
+      @directions ||= ["to", "from"]
+    end
+    private :directions
+    
+    # List of available formats Citero exports to.
+    def to_formats
+      @to_formats ||= Citero.to_formats
+    end
+    private :to_formats
+    
+    # List of available formats Citero exports from.
+    def from_formats
+      @from_formats ||= Citero.from_formats
+    end
+    private :from_formats
+  end
+end

data/lib/citero-jruby/version.rb

@@ -0,0 +1,4 @@
+module Citero
+  # Citeros current version
+  VERSION = "1.0.1"
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: citero-jruby
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 1.0.1
+platform: ruby
+authors:
+- hab278
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: git
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: json
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    none: false
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: !binary |-
+          MA==
+    none: false
+  prerelease: false
+  type: :development
+description: Leverages a Maven and a custom JAR and wraps it with JRuby
+email: hab278@nyu.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/citero-jruby.rb
+- lib/citero-jruby/base.rb
+- lib/citero-jruby/citero.jar
+- lib/citero-jruby/CSF.rb
+- lib/citero-jruby/version.rb
+- Rakefile
+- Gemfile
+- README.md
+homepage:
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2
+      version: !binary |-
+        MA==
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 2
+      version: !binary |-
+        MA==
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: Tool to translate between bibliographic formats.
+test_files: []