acts_as_citable 1.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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 @@
+= ActsAsCitable
+
+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    = 'ActsAsCitable'
+  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/acts_as_citable/base.rb

@@ -0,0 +1,87 @@
+require 'acts_as_citable/mime_types'
+require 'acts_as_citable/renderers'
+require 'citero-jruby'
+module ActsAsCitable
+  attr_accessor :format_field, :data_field
+  # Set attribute accessors
+  
+  # Hooks into an object to define its 'format' and 'data' fields. These are used to
+  # translate into other forms of metadata.
+  def acts_as_citable &block
+    # Allow for configurations
+    self.format_field = 'format'
+    self.data_field = 'data'
+    if block
+      yield self
+    end
+    
+    # Use procs to define methods that give the data_field and format_field for inherited models.
+    format_string = "#{self.format_field}"
+    data_string = "#{self.data_field}"
+        
+    define_method(:format_field,  Proc.new {format_string} )
+    define_method(:data_field, Proc.new {data_string} )
+    # Include the instance methods found below
+    include InstanceMethods
+  end
+  
+  module InstanceMethods
+    # 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
+          # Uses data_field and format_field to translate the metadata.
+          # debugger
+          Citero.map(_data).send("from_#{_format}").send(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
+      Citero.map("").respond_to?(meth) && ( directionize(meth).eql?("to") || directionize(meth).eql?(meth.to_s) )
+    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
+    
+    def _data
+      self.send(data_field.to_sym)
+    end
+    private :_data
+    
+    def _format
+      self.send(format_field.to_sym)
+    end
+    private :_format
+    
+  end
+  
+end
+ 
+ActiveRecord::Base.extend ActsAsCitable

data/lib/acts_as_citable/mime_types.rb

@@ -0,0 +1,4 @@
+# Mime type for bibtex and an alias, bib
+Mime::Type.register "application/x-bibtex", :bibtex, [:bib], [:bib]
+# Mime type for RIS
+Mime::Type.register "application/x-research-info-systems", :ris

data/lib/acts_as_citable/renderers.rb

@@ -0,0 +1,32 @@
+class Array
+  # Allow array of objects to be translated to ris
+  def to_ris
+     self.collect { |r| r.to_ris if r.respond_to? :to_ris}.join("\n\n")
+   end
+
+   # Allow array of objects to be translated to ris
+   def to_bibtex
+     self.collect { |r| r.to_bibtex if r.respond_to? :to_bibtex }.join("\n\n")
+   end
+end
+
+# Adds a renderer for RIS.
+ActionController::Renderers.add :ris do |ris, options|
+  ris = ris.first if ris.is_a? Array and ris.count == 1
+  filename = (ris.respond_to?(:to_param) and ris.class.respond_to?(:acts_as_citable)) ? ris.to_param : "export"
+  ris = ris.respond_to?(:to_ris) ? ris.to_ris() : ris  
+  ris = "#{options[:callback]}(#{ris})" unless options[:callback].blank?
+  self.content_type ||= Mime::RIS
+  self.send_data ris, filename: "#{filename}.ris"
+end
+
+# Adds a renderer for BibTeX.
+ActionController::Renderers.add :bibtex do |bibtex, options|
+  bibtex = bibtex.first if bibtex.is_a? Array and bibtex.count == 1
+  filename = (bibtex.respond_to?(:to_param) and bibtex.class.respond_to?(:acts_as_citable)) ? bibtex.to_param : "export"
+  bibtex = bibtex.respond_to?(:to_bibtex) ? bibtex.to_bibtex() : bibtex  
+  bibtex = "#{options[:callback]}(#{bibtex})" unless options[:callback].blank?
+  self.content_type ||= Mime::Bibtex
+  self.send_data bibtex, filename: "#{filename}.bib"
+end
+

data/lib/acts_as_citable/version.rb

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

data/lib/acts_as_citable.rb

@@ -0,0 +1 @@
+require 'acts_as_citable/base'

data/lib/tasks/acts_as_citable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_citable do
+#   # Task goes here
+# end

data/test/acts_as_citable_test.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+require 'ruby-debug'
+
+class ActsAsCitableTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, ActsAsCitable
+  end
+end
+
+class RecordTest < ActiveSupport::TestCase
+  test "should check if i can use the record" do
+    assert rec = Record.new( :data => "data", :format => "from_format")
+    assert rec.destroy
+  end
+  
+  test "should check to see if format fields are set" do
+    assert 'format', Record.format_field
+    assert 'from_format', RecordChangedField.format_field
+  end
+  
+  test "should check to see if records can be converted" do
+    rec = Record.new(:data => "itemType: book", :format => "csf")
+    assert rec.respond_to?(:to_ris) 
+    assert rec.respond_to?(:to_bibtex)
+    assert rec.respond_to?(:to_openurl)
+    assert rec.respond_to?(:to_csf)
+    assert rec.respond_to?(:to_easybib)
+    assert rec.respond_to?(:csf)
+    assert rec.destroy
+  end
+  
+  test "should work with models inherited acts_as_citable models" do
+    rec = InheritedRecord.new(:data => "itemType: book", :format => "csf")
+    assert rec.to_ris.eql? "TY  - BOOK\nER  -\n\n"
+    assert rec.to_bibtex.eql? "@book{????\n}"
+    assert rec.to_openurl.eql? "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"
+    assert rec.to_easybib.eql? "{\"source\":\"book\",\"book\":{\"title\":null},\"pubtype\":{\"main\":\"pubnonperiodical\"},\"pubnonperiodical\":{},\"contributors\":[{}]}"
+    assert rec.destroy
+  end
+  
+  test "should check to see if you cannot convert from" do
+    rec = Record.new(:data => "itemType: book", :format => "csf")
+    assert !rec.respond_to?(:from_ris) 
+    assert !rec.respond_to?(:from_bibtex)
+    assert !rec.respond_to?(:from_openurl)
+    assert !rec.respond_to?(:from_csf)
+    assert !rec.respond_to?(:from_pnx)
+  end
+  
+  test "should raise no method error" do
+    rec = Record.new(:data => "itemType: book", :format => "csf")
+    assert_raise NoMethodError do
+       rec.from_ris
+     end
+    assert rec.destroy
+  end
+  
+  test "should be available to convert to" do
+    rec = Record.new(:data => "itemType: book", :format => "csf")
+    assert rec.to_ris.eql? "TY  - BOOK\nER  -\n\n"
+    assert rec.to_bibtex.eql? "@book{????\n}"
+    assert rec.to_openurl.eql? "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"
+    assert rec.to_easybib.eql? "{\"source\":\"book\",\"book\":{\"title\":null},\"pubtype\":{\"main\":\"pubnonperiodical\"},\"pubnonperiodical\":{},\"contributors\":[{}]}"
+    assert rec.destroy
+  end
+  
+  test "new nokogiri xml document" do
+    assert_nothing_raised("New Nokogiri::XML::Document raises an error.") {
+      Nokogiri::XML::Document.new
+    }
+  end
+  
+  test "arrays should be able to convert to ris and bibtex" do
+    arr = Array.new
+    arr << Record.new(:data => "itemType: book", :format => "csf") << Record.create(:data => "itemType: book", :format => "csf")
+    assert arr.to_bibtex
+    assert arr.to_ris
+    arr.each {|rec| assert rec.destroy}
+  end
+  
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/javascripts/test.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/assets/stylesheets/test.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/controllers/test_controller.rb

@@ -0,0 +1,9 @@
+class TestController < ApplicationController
+  respond_to :ris, :bibtex, :json
+  def test
+    rec = Record.create(:data => "itemType: book", :format => "csf")
+    zip = Array.new
+    zip << rec
+    respond_with(zip)
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/helpers/test_helper.rb

@@ -0,0 +1,2 @@
+module TestHelper
+end

data/test/dummy/app/models/inherited_record.rb

@@ -0,0 +1,3 @@
+class InheritedRecord < Record
+  
+end

data/test/dummy/app/models/record.rb

@@ -0,0 +1,4 @@
+class Record < ActiveRecord::Base
+  attr_accessible :data, :format
+  acts_as_citable
+end

data/test/dummy/app/models/record_changed_field.rb

@@ -0,0 +1,6 @@
+class RecordChangedField < ActiveRecord::Base
+  attr_accessible :data, :from_format
+  acts_as_citable do |c|
+    c.format_field = 'from_format'
+  end
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>