acts_as_citable 3.0.0.pre.alpha → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1f1b516b3d1f541999ac2f4ebda15cc6659937f
-  data.tar.gz: 3d1cc5721a6544a46faf4c6331b8b8a4e8574a79
+  metadata.gz: cf0b8e90ec3161886f4b85e4b2cee8702831a59e
+  data.tar.gz: f0cdfcdf6987acedb5218dc131d5edc98b53f447
 SHA512:
-  metadata.gz: 494c3b61b0c597b457f547312657252e73a3bca1941343e5d4328b96c61ba7a6918a84b9cfd3db7b1b2896b410b4276b8065b6a01f2279e8e46cd65331e94c3f
-  data.tar.gz: 006c2ef87af1538efde0008a69afdb4367bd35f5585322289b89448cd1bd1ce271b57fa958bfe5239b06b36787b7e7634081a60b7399c2f13936f4b54dd6e1d4
+  metadata.gz: 517b32709ccd880fb81304de8fdd5c40f4e466e4f73a4088c73c8f18f5f0baa7e557b1d05a5c9dc435124e841022c1b15bb76986be8a81a9f3554097b2106646
+  data.tar.gz: 469020ec48f364b1d294a3b790d54ca7b9cdd59544d9b2671dfd5ec85ad84101ebfe9fd467d39e7dcba43ff69d41076b6a183c9a354fa5995d97361ec8f2f483

data/lib/acts_as_citable/base.rb

@@ -2,7 +2,7 @@ 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
@@ -12,17 +12,17 @@ module ActsAsCitable
     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
@@ -43,7 +43,7 @@ module ActsAsCitable
         super
       end
     end
-    
+
     # Returns true if the method can be evaluated to a method name
     # and parameter.
     def respond_to? meth, include_private=false
@@ -53,7 +53,7 @@ module ActsAsCitable
         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.
@@ -61,25 +61,28 @@ module ActsAsCitable
       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
+
+
+ActiveSupport.on_load(:active_record) do
+  extend ActsAsCitable
 end
- 
-ActiveRecord::Base.extend ActsAsCitable

data/lib/acts_as_citable/version.rb

@@ -1,3 +1,3 @@
 module ActsAsCitable
-  VERSION = "3.0.0-alpha"
+  VERSION = "3.0.0"
 end

data/test/acts_as_citable_test.rb

@@ -5,84 +5,10 @@ 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?(:to_refworks_tagged)
-    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_equal "TY  - BOOK\nER  -\n\n", rec.to_ris
-    assert_equal "@book{????\n}", rec.to_bibtex
-    assert_equal "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", rec.to_openurl
-    assert_equal "{\"source\":\"book\",\"book\":{\"title\":null},\"pubtype\":{\"main\":\"pubnonperiodical\"},\"pubnonperiodical\":{},\"contributors\":[]}", rec.to_easybib
-    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_equal "TY  - BOOK\nER  -\n\n", rec.to_ris
-    assert_equal "@book{????\n}", rec.to_bibtex
-    assert_equal "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", rec.to_openurl
-    assert_equal "{\"source\":\"book\",\"book\":{\"title\":null},\"pubtype\":{\"main\":\"pubnonperiodical\"},\"pubnonperiodical\":{},\"contributors\":[]}", rec.to_easybib
-    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
-  
-  test "should be able to convert to an export STYLE" do
-    rec = Record.new(:data => "itemType: book", :format => "csf")
-    assert_equal "<div class=\"csl-bib-body\">\n  <div class=\"csl-entry\"> (n.d.).</div>\n</div>", rec.to_apa
-    assert_equal "<div class=\"csl-bib-body\">\n  <div class=\"csl-entry\"> Print.</div>\n</div>", rec.to_mla
-    assert_equal "<div class=\"csl-bib-body\">\n\n[CSL STYLE ERROR: reference with no printed form.]\n</div>", rec.to_chicago_author_date
-  end
-end
+end

data/test/dummy/README.rdoc

@@ -1,261 +1,28 @@
-== Welcome to Rails
+== README
 
-Rails is a web-application framework that includes everything needed to create
-database-backed web applications according to the Model-View-Control pattern.
+This README would normally document whatever steps are necessary to get the
+application up and running.
 
-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.
+Things you may want to cover:
 
-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.
+* Ruby version
 
-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.
+* System dependencies
 
+* Configuration
 
-== Getting Started
+* Database creation
 
-1. At the command prompt, create a new Rails application:
-       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+* Database initialization
 
-2. Change directory to <tt>myapp</tt> and start the web server:
-       <tt>cd myapp; rails server</tt> (run with --help for options)
+* How to run the test suite
 
-3. Go to http://localhost:3000/ and you'll see:
-       "Welcome aboard: You're riding Ruby on Rails!"
+* Services (job queues, cache servers, search engines, etc.)
 
-4. Follow the guidelines to start developing your application. You can find
-the following resources handy:
+* Deployment instructions
 
-* 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.
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.