incite 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+.rbenv-version

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "dust"
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 TODO: Write your name
+
+MIT License
+
+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.md

@@ -0,0 +1,48 @@
+# Overview [![Incite Build Status][Build Icon]][Build Status]
+
+[Build Status]: http://travis-ci.org/tfwright/incite
+[Build Icon]: https://secure.travis-ci.org/tfwright/incite.png?branch=master
+
+Incite is in alpha alpha stage.  It's useless, don't install it.
+
+# Usage
+
+* Note: This syntax is very experimental, and will likely--no, definitely--change in a radical way (see above).
+
+```
+irb> require 'lib/incite'
+=> true
+```
+
+First you need to instantiate a source you want to cite:
+
+```
+irb> source = Incite::Source.new
+=> #<Incite::Source:0x8c5f0>
+```
+
+Sources don't require any parameters to be created, but obviously you're not going to get a very useful citation:
+
+```
+irb> source.citation(:note)
+=> ", <em></em> (: , ), ."
+```
+
+So lets add some metadata and try again. When we're talking about citations, proper attribution is usually the most pressing task:
+
+```
+irb> source.authors = ["Some Guy", "Smart Gal"]
+=> ["Some Guy", "Smart Gal"]
+irb> source.citation(:note)
+=> "Smart Gal and Some Guy, <em></em> (: , ), ."
+```
+
+OK.  That's a little better.  It's even sorted them for you!  Unfortunately...it also spat out a bunch of garbage relating to other unavailable data.  In the future the plan is for Incite to be intelligent about how to format 'partial' sources (this has begun to be implemented, but needs to be a lot more robust).
+
+# Other future plans
+
+* Integration with various bibliographies (Google Books, Amazon, &c?)
+* Citation text
+* Source types
+* Minimal validations of metadata
+* Different type of formats (to_s, to_rtf)

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'	  	
+task :default => :test
+
+
+Rake::TestTask.new(:test) do |t|	  	
+  t.libs << 'test'	  	
+  t.pattern = 'test/**/*_test.rb'	  	
+  t.verbose = true	  	
+end

data/incite.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "incite/version"
+
+Gem::Specification.new do |s|
+  s.name        = "incite"
+  s.version     = Incite::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Thomas Wright"]
+  s.email       = ["tfwright@gmail.com"]
+  s.homepage    = "http://github.com/tfwright/incite"
+  s.summary     = %q{Ruby lib for formatting bibliographical data}
+  s.description = %q{Incite is an academic citation library that lets you easily define objects for typical academic sources (eg. books, articles) which can be used to output formatted html for a variety of bibliographical formats (eg. Chicago Manual of Style, MLA). Right now only CMS is supported.  Incite is in alpha alpha stage. It's useless, don't install it.}
+
+  s.add_development_dependency 'rake', '~> 0.9.2.2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/incite.rb

@@ -0,0 +1,11 @@
+require "incite/version"
+
+require 'incite/citation'
+require 'incite/source'
+require 'incite/entry'
+require 'incite/note'
+require 'incite/reference'
+require 'incite/inline'
+
+module Incite
+end

data/lib/incite/citation.rb

@@ -0,0 +1,38 @@
+module Incite
+  class Citation
+    attr_accessor :source
+    
+    def initialize(source)
+      self.source = source
+      validate_required_attributes!
+    end
+    
+    private
+    
+      def formatted_pages
+        source.pages.map { |p| p.is_a?(Range) ? "#{p.first}-#{p.last}" : p }.join(", ")
+      end
+    
+      def formatted_contributors(type)
+        ordered_contributors = source.send(type).sort_by { |c| c.split(" ").last }
+        case ordered_contributors.size
+        when 2
+          ordered_contributors.join(" and ")
+        when 3..5
+          ordered_contributors.first + " et al."
+        else
+          ordered_contributors.first
+        end.to_s
+      end
+      
+      def validate_required_attributes!
+        raise ArgumentError, "Source lacks attributes required to construct citation" unless valid_source?
+      end
+      
+      def valid_source?
+        true
+      end
+        
+  end
+
+end

data/lib/incite/entry.rb

@@ -0,0 +1,9 @@
+module Incite
+  class Entry < Incite::Citation
+    
+    def to_html
+      "#{formatted_contributors(:authors)}. <em>#{source.title}</em>. #{source.city}: #{source.publisher}, #{source.year}."
+    end
+    
+  end
+end

data/lib/incite/inline.rb

@@ -0,0 +1,9 @@
+module Incite
+  class Inline < Incite::Citation
+    
+    def to_html
+      "(#{formatted_contributors(:authors)}. #{source.year}, #{formatted_pages})"
+    end
+    
+  end
+end

data/lib/incite/note.rb

@@ -0,0 +1,48 @@
+module Incite
+  class Note < Incite::Citation
+    
+    REQUIRED_ATTRS = %w(authors title publisher year pages)
+    
+    def to_html
+      relevant_attributes = %w(authors title translators editors volume edition city publisher year pages)
+      relevant_attributes.inject("") do |string, attribute|
+        string << format_segment_for(attribute)
+      end
+    end
+    
+    private
+    
+      def format_segment_for(attribute)
+        case attribute
+        when "authors"
+          formatted_contributors(:authors) + ", "
+        when "title"
+          "<em>#{source.title}</em>"
+        when "translators"
+          ", trans. #{formatted_contributors(:translators)}" if source.translators.any?
+        when "editors"
+          ", ed. #{formatted_contributors(:editors)}" if source.editors.any?
+        when "volume"
+          ", vol. #{source.volume}" if source.volume
+        when "edition"
+          ", #{source.edition} ed." if source.edition
+        when "city"
+          segment = " ("
+          segment << "#{source.city}: " if source.city
+          segment
+        when "publisher"
+          "#{source.publisher}, "
+        when "year"
+          "#{source.year}), "
+        when "pages"
+          "#{formatted_pages}."
+        end.to_s
+      end
+      
+      def valid_source?
+        source.has_attributes?(REQUIRED_ATTRS)
+      end
+    
+  end
+end
+

data/lib/incite/reference.rb

@@ -0,0 +1,9 @@
+module Incite
+  class Reference < Incite::Citation
+    
+    def to_html
+      "#{formatted_contributors(:authors)}. #{source.year}. <em>#{source.title}</em>. #{source.city}: #{source.publisher}."
+    end
+    
+  end
+end

data/lib/incite/source.rb

@@ -0,0 +1,29 @@
+module Incite
+  class Source
+    
+    attr_accessor :title, :authors, :publisher, :city, :year, 
+      :pages, :editors, :edition, :volume, :translators
+    
+    def initialize(attrs={})
+      attrs.each do |attr, value|
+        self.send("#{attr}=", value)
+      end
+      self.pages ||= []
+      self.authors ||= []
+      self.editors ||= []
+      self.translators ||= []
+    end
+    
+    def citation(type)
+      citation = Incite.const_get(type.to_s.capitalize).new(self).to_html
+    end
+    
+    def has_attributes?(attrs)
+      !attrs.map do |attr|
+        value = send(attr)
+        (value.is_a?(Array) && value.any?) || (!value.is_a?(Array) && !value.nil?)
+      end.include?(false)
+    end
+    
+  end
+end

data/lib/incite/version.rb

@@ -0,0 +1,3 @@
+module Incite
+  VERSION = "0.0.1"
+end

data/test/incite/citation_test.rb

@@ -0,0 +1,51 @@
+require "test_helper"
+
+unit_tests do
+  
+  test "initializes with source" do
+    source = Incite::Source.new
+    citation = Incite::Citation.new(source)
+    assert_not_nil citation.source
+  end
+  
+  test "formats two authors sorting alphabetically joined with 'and'" do
+    source = Incite::Source.new(:authors => ["Han Solo", "James Kirk"])
+    citation = Incite::Citation.new(source)
+    Incite::Citation.publicize_methods do 
+      assert_equal "James Kirk and Han Solo", citation.formatted_contributors(:authors)
+    end
+  end
+  
+  test "formats three authors with first and 'et al'" do
+    source = Incite::Source.new(:authors => ["Han Solo", "James Kirk", "Cat Stevens"])
+    citation = Incite::Citation.new(source)
+    Incite::Citation.publicize_methods do 
+      assert_equal "James Kirk et al.", citation.formatted_contributors(:authors)
+    end
+  end
+  
+  test "formats one author simply" do
+    source = Incite::Source.new(:authors => ["Han Solo"])
+    citation = Incite::Citation.new(source)
+    Incite::Citation.publicize_methods do 
+    assert_equal "Han Solo", citation.formatted_contributors(:authors)
+    end
+  end
+  
+  test "formats array of pages for display in html" do
+    source = Incite::Source.new(:pages => [(45..49), 51])
+    citation = Incite::Citation.new(source)
+    Incite::Citation.publicize_methods do 
+      assert_equal "45-49, 51", citation.formatted_pages
+    end
+  end
+  
+  test "returns an empty string when there are no contributors" do
+    source = Incite::Source.new
+    citation = Incite::Citation.new(source)
+    Incite::Citation.publicize_methods do 
+      assert_equal "", citation.formatted_contributors(:authors)
+    end
+  end
+  
+end

data/test/incite/entry_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+
+unit_tests do
+  
+  test "displays html for a works cited entry" do
+    source = Incite::Source.new(:authors => ["Han Solo", "James Kirk"], :publisher => "Random House",
+      :city => "New York", :year => 1983, :title => "Memoirs from Space", :pages => [(45..49), 51])
+    entry = Incite::Entry.new(source)
+    assert_equal "James Kirk and Han Solo. <em>Memoirs from Space</em>. New York: Random House, 1983.", entry.to_html
+  end
+  
+end

data/test/incite/inline_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+
+unit_tests do
+  
+  test "displays html for an in-text citation" do
+    source = Incite::Source.new(:authors => ["Han Solo", "James Kirk"], :publisher => "Random House",
+      :city => "New York", :year => 1983, :title => "Memoirs from Space", :pages => [(45..49), 51])
+    inline = Incite::Inline.new(source)
+    assert_equal "(James Kirk and Han Solo. 1983, 45-49, 51)", inline.to_html
+  end
+  
+end

data/test/incite/note_test.rb

@@ -0,0 +1,27 @@
+require "test_helper"
+
+unit_tests do
+
+  test "displays html for a footnote or endnote" do
+    source = Incite::Source.new(:authors => ["Han Solo", "James Kirk"], :publisher => "Random House",
+      :city => "New York", :year => 1983, :title => "Memoirs from Space", :pages => [(45..49), 51],
+      :translators => ["Kooky Kookaboora"], :editors => ["Lil Rascal"], :volume => 1, :edition => 2)
+    note = Incite::Note.new(source)
+    assert_equal "James Kirk and Han Solo, <em>Memoirs from Space</em>, trans. Kooky Kookaboora, ed. Lil Rascal, vol. 1, 2 ed. (New York: Random House, 1983), 45-49, 51.", note.to_html
+  end
+  
+  test "omits optional fields without including related formatting and punctuation" do
+    source = Incite::Source.new(:authors => ["Han Solo", "James Kirk"], :publisher => "Random House",
+      :year => 1983, :title => "Memoirs from Space", :pages => [(45..49), 51])
+    note = Incite::Note.new(source)
+    assert_equal "James Kirk and Han Solo, <em>Memoirs from Space</em> (Random House, 1983), 45-49, 51.", note.to_html
+  end
+  
+  test "raises error if source lacks required attributes" do
+    source = Incite::Source.new
+    assert_raises ArgumentError do
+      Incite::Note.new(source)
+    end
+  end
+  
+end

data/test/incite/reference_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+
+unit_tests do
+  
+  test "displays html for a reference" do
+    source = Incite::Source.new(:authors => ["Han Solo", "James Kirk"], :publisher => "Random House",
+      :city => "New York", :year => 1983, :title => "Memoirs from Space", :pages => [(45..49), 51])
+    reference = Incite::Reference.new(source)
+    assert_equal "James Kirk and Han Solo. 1983. <em>Memoirs from Space</em>. New York: Random House.", reference.to_html
+  end
+  
+end

data/test/incite/source_test.rb

@@ -0,0 +1,43 @@
+require "test_helper"
+
+unit_tests do
+  
+  test "initializes with metadata hash attr" do
+    source = Incite::Source.new(:title => "Test title")
+    assert_equal("Test title", source.title)
+  end
+  
+  test "can be initialized without attrs" do
+    assert_nothing_raised do
+      source = Incite::Source.new
+    end
+  end
+  
+  test "outputs html for a given type of citation" do
+    source = Incite::Source.new(:authors => ["Han Solo", "James Kirk"], :publisher => "Random House",
+      :city => "New York", :year => 1983, :title => "Memoirs from Space", :pages => [(45..49), 51])
+    assert_equal "James Kirk and Han Solo. <em>Memoirs from Space</em>. New York: Random House, 1983.", source.citation(:entry)
+  end
+  
+  test "correctly interprets lowercase citation types" do
+    source = Incite::Source.new
+    assert_nothing_raised do
+      source.citation(:entry)
+    end
+  end
+  
+  test "returns true if every element in array is an array with at least one element or not nil" do
+    source = Incite::Source.new(:authors => ["Test Author"], :title => "Test Title")
+    Incite::Source.publicize_methods do 
+      assert source.has_attributes?([:authors, :title])
+    end
+  end
+  
+  test "returns false if every element in array is an array with at least one element or not nil" do
+    source = Incite::Source.new(:authors => [], :title => "Test Title")
+    Incite::Source.publicize_methods do 
+      assert !source.has_attributes?([:authors, :title])
+    end
+  end
+  
+end

data/test/incite_test.rb

@@ -0,0 +1,2 @@
+require "test_helper"
+

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+# Require vendor libs
+Dir[File.join(File.dirname(__FILE__), '..', 'vendor', '**', 'lib')].each do |path|
+  $: << path
+end
+
+require 'incite'
+require 'dust'
+
+# For testing private methods
+# Usage: Klass.publicize_methods { Klass.new.private_method_name }
+# http://blog.jayfields.com/2007/11/ruby-testing-private-methods.html
+class Class
+  def publicize_methods
+    saved_private_instance_methods = self.private_instance_methods
+    self.class_eval { public(*saved_private_instance_methods) }
+    yield
+    self.class_eval { private(*saved_private_instance_methods) }
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: incite
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Thomas Wright
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 9
+        - 2
+        - 2
+        version: 0.9.2.2
+  type: :development
+  version_requirements: *id001
+description: Incite is an academic citation library that lets you easily define objects for typical academic sources (eg. books, articles) which can be used to output formatted html for a variety of bibliographical formats (eg. Chicago Manual of Style, MLA). Right now only CMS is supported.  Incite is in alpha alpha stage. It's useless, don't install it.
+email: 
+- tfwright@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- incite.gemspec
+- lib/incite.rb
+- lib/incite/citation.rb
+- lib/incite/entry.rb
+- lib/incite/inline.rb
+- lib/incite/note.rb
+- lib/incite/reference.rb
+- lib/incite/source.rb
+- lib/incite/version.rb
+- test/incite/citation_test.rb
+- test/incite/entry_test.rb
+- test/incite/inline_test.rb
+- test/incite/note_test.rb
+- test/incite/reference_test.rb
+- test/incite/source_test.rb
+- test/incite_test.rb
+- test/test_helper.rb
+homepage: http://github.com/tfwright/incite
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.18
+signing_key: 
+specification_version: 3
+summary: Ruby lib for formatting bibliographical data
+test_files: 
+- test/incite/citation_test.rb
+- test/incite/entry_test.rb
+- test/incite/inline_test.rb
+- test/incite/note_test.rb
+- test/incite/reference_test.rb
+- test/incite/source_test.rb
+- test/incite_test.rb
+- test/test_helper.rb