scholar 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/cassettes
+spec/reports
+spec/tmp
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--format Fuubar
+--color
+--drb

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p385

data/.travis.yml

@@ -0,0 +1,11 @@
+branches:
+  only:
+    - master
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+script: bundle exec rspec spec
+notifications:
+  email:
+    - ethan.turkeltaub@gmail.com

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'pry'
+  gem 'log_buddy'
+end
+
+group :test do
+  gem 'rspec'
+
+  gem 'factory_girl'
+
+  gem 'spork'
+  gem 'fuubar'
+
+  gem 'cane'
+end

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    scholar (0.1.0)
+      activesupport (~> 3.2.11)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    cane (2.5.0)
+      parallel
+    coderay (1.0.8)
+    diff-lcs (1.1.3)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    fuubar (1.1.0)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.2.0)
+      ruby-progressbar (~> 1.0.0)
+    i18n (0.6.1)
+    log_buddy (0.7.0)
+    method_source (0.8.1)
+    multi_json (1.5.0)
+    parallel (0.6.1)
+    pry (0.9.11.4)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.12.1)
+    ruby-progressbar (1.0.2)
+    slop (3.4.3)
+    spork (0.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cane
+  factory_girl
+  fuubar
+  log_buddy
+  pry
+  rake
+  rspec
+  scholar!
+  spork

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ethan Turkeltaub
+
+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,94 @@
+# Scholar [![Build Status](https://secure.travis-ci.org/noted/scholar.png)](https://travis-ci.org/noted/scholar)
+
+Scholar is a Ruby library for building [MLA citations](http://www.mla.org/) for scholarly works.
+
+```ruby
+salinger = Scholar::Citation.new({
+  :type => :book,
+  :media => :print,
+  :title => "The Catcher in the Rye",
+  :contributors => [
+    {
+      :role => :author,
+      :first => "J",
+      :middle => "D",
+      :last => "Salinger"
+    }
+  ],
+  :publisher => "Little, Brown",
+  :city => "Boston",
+  :year => "1995"
+})
+salinger.html # => Salinger, J. D. <em>Catcher in the Rye</em>. Boston: Little, Brown, 1995.
+```
+
+## Usage
+
+To create a citation, you pass `Scholar::Citation` a hash with the attributes associated with the source. See the specific type on [the wiki](https://github.com/noted/scholar/wiki/Supported-Types) for the attributes available.
+
+### Global Attributes
+
+All source types can take these fields.
+
+* `:type` &mdash; The type of publication you're citing ([see the wiki for a list of supported types](https://github.com/noted/scholar/wiki/Supported-Types)).
+* `:contributors` &mdash; An array of contributors (see below for details).
+
+#### Contributors
+
+The `:contributors` key is an array of hashes that define contributors. Here's an example.
+
+```ruby
+:contributors => [
+  {
+    :role => :author,
+    :first => "Douglas",
+    :middle => "Noel",
+    :last => "Adams"
+  },
+  {
+    :role => :author,
+    :first => "Eion",
+    :last => "Colfer"
+  },
+  {
+    :role => :editor,
+    :first => "John",
+    :last => "Sample",
+    :suffix => "PhD"
+  }
+  {
+    :role => :compiler,
+    :first => "Steve",
+    :last => "Jobs"
+  },
+  {
+    :role => :translator,
+    :first => "Bill",
+    :last => "Gates"
+  }
+]
+```
+
+Each hash can take the following fields:
+
+* `:role` &mdash; Can be `:author`, `:editor`, `:translator`, `:compiler`.
+* `:first` &mdash; The person's name.
+* `:middle` &mdash; The person's middle name (will convert to middle initial).
+* `:last` &mdash; The person's surname.
+* `:suffix` &mdash; Any suffixes the person has ("PhD", "Esq", "Jr", etc). Omit periods.
+
+## Contributing
+
+1. [Fork the repository.][fork]
+2. [Create a topic branch.][branch]
+3. Add tests for your unimplemented feature or bug fix.
+4. Run `bundle exec rspec`. If your tests pass, return to step 3.
+5. Implement your feature or bug fix.
+6. Run `bundle exec rspec`. If your tests fail, return to step 5.
+7. Add documentation for your feature or bug fix.
+8. Add, commit, and push your changes.
+9. [Submit a pull request.][pr]
+
+[fork]: http://help.github.com/fork-a-repo/
+[branch]: http://learn.github.com/p/branching.html
+[pr]: http://help.github.com/send-pull-requests/

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/scholar.rb

@@ -0,0 +1,10 @@
+require 'json'
+require 'active_support/all'
+
+require_relative 'scholar/utilities'
+require_relative 'scholar/citation'
+require_relative 'scholar/source'
+
+# Allows for the creation of scholarly MLA citations.
+module Scholar
+end

data/lib/scholar/citation.rb

@@ -0,0 +1,55 @@
+module Scholar
+
+  # A Citation object containing the attributes of the
+  # citation and the HTML citation itself.
+  class Citation
+
+    # The pieces of data in the Citation.
+    attr_reader :attributes
+
+    # The actual HTML citation.
+    attr_reader :html
+
+    # Creates a new Citation from the given attributes.
+    #
+    # ==== Attributes
+    #
+    # * +options+ - The attributes of the Citation.
+    #
+    # ==== Options
+    #
+    # * +:type+ - Not optional. The type of source you are citing.
+    # * +:contributors+ - An array of hashes of contributors.
+    #
+    # ==== Examples
+    #
+    #   citation = Scholar::Citation.new({
+    #     :type => :book,
+    #     :title => "Foobar",
+    #     :contributors => [
+    #       {
+    #         :role => :author,
+    #         :first => "John",
+    #         :last => "Sample"
+    #       }
+    #     ]
+    #   })
+    #
+    # Obviously, you'd include more than that, but you need to see the
+    # specific sources for more documentation.
+    def initialize(options = {})
+      source = "Scholar::Sources::#{options[:type].to_s.camelize}".constantize
+
+      @attributes = options
+      @attributes.delete(:type)
+
+      @attributes = Scholar::Utilities.contributors!(@attributes)
+      @attributes = Scholar::Utilities.order!(@attributes, source.sequence)
+
+      attributes = @attributes.clone
+      attributes = Scholar::Utilities.format!(attributes, source.rules)
+
+      @html = Scholar::Utilities.concatenate!(attributes)
+    end
+  end
+end

data/lib/scholar/source.rb

@@ -0,0 +1,59 @@
+module Scholar
+
+  # The basis for sources. Inherit from this class to create
+  # other types of sources.
+  class Source < Utilities
+    class << self
+
+      # Defines the order of attributes for Sources.
+      #
+      # ==== Attributes
+      #
+      # * +arr+ - Array of Symbols (keys). This is the order the hash's key will be in.
+      def sequence(arr = nil)
+        unless arr.nil?
+          @@sequence = arr
+        end
+
+        self.descendants.empty? ? @@sequence : nil
+      end
+
+      # Defines what actions need to be taken on the attributes.
+      #
+      # ==== Attributes
+      #
+      # * +block+ - A block of +rule+ definitions. The rule definition should call a method in Scholar::Utilities::Formatters.
+      #
+      # ==== Example
+      #
+      #   rules do
+      #     rule(:foo) {|v| italicize(v) }
+      #   end
+      def rules(&block)
+        if block
+          @@rules ||= []
+
+          self.class_eval(&block)
+        else
+          self.descendants.empty? ? @@rules : nil
+        end
+      end
+
+      # Defines a specific action to be taken on an attribute.
+      #
+      # ==== Attributes
+      #
+      # * +key+ - The key of the hash to take the action on. Symbol.
+      # * +action+ - The action to take on the key. Should be a method within Scholar::Utilities::Formatters.
+      def rule(key, &action)
+        @@rules << [key, action]
+      end
+    end
+  end
+
+  # A collection of different source types.
+  module Sources
+  end
+
+  Dir[File.dirname(__FILE__) + '/sources/*.rb'].each {|file| require file }
+end

data/lib/scholar/sources/book.rb

@@ -0,0 +1,55 @@
+module Scholar
+  module Sources
+
+    # A normal book.
+    class Book < Scholar::Source
+      sequence [
+        :authors,
+        :title,
+        :editors,
+        :compilers,
+        :translators,
+        :edition,
+        :volume,
+        :city,
+        :publisher,
+        :year,
+        :media,
+        :series
+      ]
+
+      rules do
+        rule(:authors)     {|v| period(v) }
+
+        rule(:title)       {|v| italicize(v) }
+        rule(:title)       {|v| period(v) }
+
+        rule(:editors)     {|v| replace("Ed. #{v}") }
+        rule(:editors)     {|v| period(v) }
+
+        rule(:compilers)   {|v| replace("Comp. #{v}") }
+        rule(:compilers)   {|v| period(v) }
+
+        rule(:translators) {|v| replace("Trans. #{v}") }
+        rule(:translators) {|v| period(v) }
+
+        rule(:edition)     {|v| replace("#{ordinal(v)} ed") }
+        rule(:edition)     {|v| period(v) }
+
+        rule(:volume)      {|v| replace("Vol. #{v}") }
+        rule(:volume)      {|v| period(v) }
+
+        rule(:city)        {|v| colon(v) }
+
+        rule(:publisher)   {|v| comma(v) }
+
+        rule(:year)        {|v| period(v) }
+
+        rule(:media)       {|v| capitalize(v) }
+        rule(:media)       {|v| period(v) }
+
+        rule(:series)      {|v| period(v) }
+      end
+    end
+  end
+end

data/lib/scholar/utilities.rb

@@ -0,0 +1,10 @@
+module Scholar
+
+  # Manifest various utilities to change attributes correctly.
+  class Utilities
+    Dir[File.dirname(__FILE__) + '/utilities/*.rb'].each {|file| require file }
+
+    extend Scholar::Utilities::Formatters
+    extend Scholar::Utilities::Data
+  end
+end

data/lib/scholar/utilities/contributor.rb

@@ -0,0 +1,96 @@
+module Scholar
+  class Utilities
+
+    # A person associated with a work.
+    class Contributor
+
+      # The data associated with the person.
+      attr_reader :attributes
+
+      # The name in the correct format.
+      attr_reader :name
+
+      # Create a Contributor.
+      #
+      # ==== Attributes
+      #
+      # * +hash+ - The data associated with the Contributor.
+      # * +order+ - Last-name first (+:last+) or first-name first (+:first+).
+      #
+      # ==== Options
+      #
+      # * +:first+ - The name of the Contributor.
+      # * +:middle+ - The middle name of the Contributor. Will be shortened to an initial.
+      # * +:last+ - The surname of the Contributor.
+      # * +:suffix+ - The suffix of the Contributor (PhD, Esq, etc).
+      #
+      # ==== Examples
+      #
+      #   Scholar::Utilities::Contributor.new({:first => "Douglas", :last => "Adams"})
+      def initialize(hash, order = :first)
+        @order = order
+
+        @attributes = order!(hash)
+        @name = name!(@attributes)
+      end
+
+      # Reorders the name of the Contributor with the given order.
+      #
+      # ==== Attributes
+      #
+      # * +order+ - Either +:first+ or +:last+ name first.
+      def reorder!(order)
+        @order = order
+
+        @attributes = order!(@attributes, order)
+        @name = name!(@attributes)
+
+        if @name[-2, 2] == ".," # Fix this.
+          @name = @name[0..-3]
+        end
+
+        self
+      end
+
+      private
+
+      # Order according to the sequence.
+      def order!(hash, method = @order)
+        if method == :last
+          sequence = [:role, :last, :first, :middle, :suffix]
+        else
+          sequence = [:role, :first, :middle, :last, :suffix]
+        end
+
+        ordered = Scholar::Utilities.order!(hash, sequence)
+      end
+
+      # Generate the name with the given hash.
+      def name!(attributes)
+        hash = attributes.clone
+
+        [:role, :order].each do |k|
+          hash.delete(k)
+        end
+
+        if hash[:first].length == 1
+          hash[:first] = "#{hash[:first]}."
+        end
+
+        if hash[:middle]
+          hash[:middle] = "#{hash[:middle][0,1].upcase}."
+        end
+
+        if @order == :last || hash[:suffix]
+          hash[:last] = "#{hash[:last]},"
+        end
+
+        if @order == :last && hash[:middle]
+          hash[:middle] = "#{hash[:middle]},"
+        end
+
+        hash.values.compact.reject(&:empty?).join(' ').squish
+      end
+    end
+  end
+end

data/lib/scholar/utilities/contributor_list.rb

@@ -0,0 +1,62 @@
+module Scholar
+  class Utilities
+
+    # A list of Contributors.
+    class ContributorList
+
+      # An Array of Contributors.
+      attr_reader :contributors
+
+      # The names in MLA format.
+      attr_reader :names
+
+      # Create a list of Contributors.
+      #
+      # ==== Attributes
+      #
+      # * +contributors+ - An Array of Contributors or an Array of Hashes.
+      # * +role+ - Either +:author:+ or +:nonauthor+.
+      #
+      # ==== Examples
+      #
+      #   Scholar::Utilities::ContributorList.new([
+      #     {
+      #       :first => "Douglas",
+      #       :last => "Adams"
+      #     },
+      #     {
+      #       :first => "Eion",
+      #       :last => "Colfer"
+      #     }
+      #   ])
+      def initialize(contributors, role = :nonauthor)
+        @names = ""
+
+        contributors.each do |c|
+          if c.is_a?(Hash)
+            contributors[contributors.index(c)] = Contributor.new(c)
+          end
+        end
+
+        contributors.each do |c|
+          if contributors.index(c) == 0 && role == :author
+            c.reorder!(:last)
+          else
+            c.reorder!(:first)
+          end
+
+          @names << c.name
+
+          unless contributors.last == c
+            @names << ", "
+          end
+        end
+
+        @contributors = contributors
+        @role = role
+
+        return self
+      end
+    end
+  end
+end

data/lib/scholar/utilities/data.rb

@@ -0,0 +1,68 @@
+module Scholar
+  class Utilities
+
+    # Utilities for dealing with hashes and actually creating the
+    # citations.
+    module Data
+
+      # Concatenates hashes values into space-separated String.
+      def concatenate!(attributes)
+        attributes.values.compact.reject(&:empty?).join(' ').squish
+      end
+
+      # Take contributors in hash and makes a ContributorList for each role.
+      def contributors!(attributes)
+        data = attributes[:contributors]
+
+        attributes.delete(:contributors)
+
+        contributors = {}
+        data.each do |c|
+          role = c[:role].to_s.pluralize.to_sym
+
+          if contributors.has_key?(role)
+            contributors[role] << c
+          else
+            contributors[role] = [c]
+          end
+        end
+
+        contributors.each do |role, list|
+          if role == :authors
+            contributors[role] = ContributorList.new(list, :author).names
+          else
+            contributors[role] = ContributorList.new(list).names
+          end
+        end
+
+        attributes.merge(contributors)
+      end
+
+      # Formats the keys of a hash with given rules.
+      def format!(attributes, rules = [])
+        rules.each do |key, action|
+          unless attributes[key].nil?
+            attributes[key] = Scholar::Utilities.instance_eval do
+              action.call(attributes[key])
+            end
+          end
+        end
+
+        attributes
+      end
+
+      # Re-orders a hash based on a template.
+      def order!(hash, template)
+        ordered = ActiveSupport::OrderedHash.new
+
+        template.each do |key|
+          if hash[key]
+            ordered[key] = hash[key]
+          end
+        end
+
+        ordered
+      end
+    end
+  end
+end

data/lib/scholar/utilities/formatters.rb

@@ -0,0 +1,58 @@
+module Scholar
+  class Utilities
+
+    # String formatters.
+    module Formatters
+
+      # Capitalize the first character of a String.
+      def capitalize(str)
+        str.to_s.capitalize
+      end
+
+      # Add carets (<>) around String.
+      def carets(str)
+        "&#60;#{str.to_s}&#62;"
+      end
+
+      # Add a colon to the end of a String.
+      def colon(str)
+        "#{str.to_s}:"
+      end
+
+      # Add a comma to the end of a String.
+      def comma(str)
+        "#{str.to_s},"
+      end
+
+      # Add <em> tags around a String to italicize it.
+      def italicize(str)
+        "<em>#{str.to_s}</em>"
+      end
+
+      # Return the ordinal form of an integer (1 turns into 1st, etc).
+      def ordinal(int)
+        ActiveSupport::Inflector.ordinalize(int.to_i)
+      end
+
+      # Add a period to the end of a String.
+      def period(str)
+        "#{str.to_s}."
+      end
+
+      # Wrap a String in quotes.
+      def quotes(str)
+        "&#8220;#{str.to_s}&#8221;"
+      end
+
+      # Replace with a String.
+      def replace(str)
+        str.to_s
+      end
+
+      # Add +<u>+ tags around a String to italicize it.
+      def underline(str)
+        "<u>#{str.to_s}</u>"
+      end
+    end
+  end
+end

data/scholar.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "scholar"
+  gem.version       = "0.1.0"
+  gem.authors       = ["Ethan Turkeltaub"]
+  gem.email         = ["ethan.turkeltaub@gmail.com"]
+  gem.description   = %q{Generate valid MLA citations.}
+  gem.summary       = %q{Generate valid MLA citations.}
+  gem.homepage      = "http://github.com/noted/scholar"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'activesupport', '~> 3.2.11'
+end

data/spec/factories/contributor.rb

@@ -0,0 +1,27 @@
+FactoryGirl.define do
+  factory :contributor, class: Scholar::Utilities::Contributor do
+    trait :first do
+      hash = {
+        :role => :editor,
+        :first => "John",
+        :middle => "Quentin",
+        :last => "Sample",
+        :suffix => "PhD"
+      }
+
+      initialize_with { Scholar::Utilities::Contributor.new(hash) }
+    end
+
+    trait :last do
+      hash = {
+        :role => :author,
+        :first => "Les",
+        :middle => "Randy",
+        :last => "Grossman",
+        :suffix => "Esq"
+      }
+
+      initialize_with { Scholar::Utilities::Contributor.new(hash, :last) }
+    end
+  end
+end

data/spec/factories/contributor_list.rb

@@ -0,0 +1,47 @@
+FactoryGirl.define do
+  factory :contributors, class: Scholar::Utilities::ContributorList do
+    trait :author do
+      arr = [
+        {
+          :role => :author,
+          :first => "John",
+          :last => "Green"
+        },
+        {
+          :role => :author,
+          :first => "Douglas",
+          :middle => "Noel",
+          :last => "Adams"
+        },
+        {
+          :role => :author,
+          :first => "Neil",
+          :middle => "deGrasse",
+          :last => "Tyson",
+          :suffix => "PhD"
+        }
+      ]
+
+      initialize_with { Scholar::Utilities::ContributorList.new(arr, :author) }
+    end
+
+    trait :nonauthor do
+      arr = [
+        {
+          :role => :editor,
+          :first => "Carl",
+          :last => "Sagan"
+        },
+        {
+          :role => :editor,
+          :first => "Neil",
+          :middle => "deGrasse",
+          :last => "Tyson",
+          :suffix => "PhD"
+        }
+      ]
+
+      initialize_with { Scholar::Utilities::ContributorList.new(arr) }
+    end
+  end
+end

data/spec/scholar/source_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Scholar::Source do
+  let(:s) { Scholar::Source }
+
+  describe ".sequence" do
+    context "passed Array" do
+      let(:sequence) { s.sequence([:foo, :bar]) }
+
+      it { s.sequence.should be_nil }
+    end
+
+    context "no arguments" do
+      let(:sequence) { s.sequence }
+
+      it { s.sequence.should be_nil }
+    end
+  end
+
+  describe ".rules" do
+    context "passed rule definitions" do
+      let(:rules) { s.rules { rules(:foo) {|v| "#{v}"} } }
+
+      it { s.sequence.should be_nil }
+    end
+
+    context "no arguments" do
+      it { s.sequence.should be_nil }
+    end
+  end
+
+  describe ".rule" do
+    let(:rule) { s.rule(:foo) {|v| "#{v}"} }
+
+    it { rule.pop[0].should eql(:foo) }
+    it { rule.pop[1].should be_an_instance_of Proc }
+  end
+end

data/spec/scholar/sources/book_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Scholar::Sources::Book do
+  let(:data) do
+    {
+      :type => :book,
+      :media => :print,
+      :title => "The Hitchhiker's Guide to the Galaxy",
+      :contributors => [
+        {
+          :role => :author,
+          :first => "Douglas",
+          :middle => "Noel",
+          :last => "Adams"
+        },
+        {
+          :role => :editor,
+          :first => "Peter",
+          :last => "Guzzardi"
+        },
+        {
+          :role => :translator,
+          :first => "Les",
+          :last => "Grossman"
+        },
+        {
+          :role => :compiler,
+          :first => "Eion",
+          :last => "Colfer"
+        }
+      ],
+      :edition => 1,
+      :volume => 1,
+      :publisher => "Random House",
+      :city => "London",
+      :year => "1972",
+      :series => "The Hitchhiker's Guide to the Galaxy"
+    }
+  end
+
+  let(:citation) do
+    "Adams, Douglas N. <em>The Hitchhiker's Guide to the Galaxy</em>. Ed. Peter Guzzardi. Comp. Eion Colfer. Trans. Les Grossman. 1st ed. Vol. 1. London: Random House, 1972. Print. The Hitchhiker's Guide to the Galaxy."
+  end
+
+  let(:c) { Scholar::Citation.new(data) }
+
+  it { c.html.should eql citation }
+end

data/spec/scholar/utilities/contributor_list_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Scholar::Utilities::ContributorList do
+  context "authors" do
+    let(:c) { build(:contributors, :author) }
+
+    it { c.should be_an_instance_of Scholar::Utilities::ContributorList }
+    it { c.names.should eql "Green, John, Douglas N. Adams, Neil D. Tyson, PhD"}
+  end
+
+  context "non-authors" do
+    let(:c) { build(:contributors, :nonauthor) }
+
+    it { c.should be_an_instance_of Scholar::Utilities::ContributorList }
+    it { c.names.should eql "Carl Sagan, Neil D. Tyson, PhD"}
+  end
+end

data/spec/scholar/utilities/contributor_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Scholar::Utilities::Contributor do
+  context "author" do
+    let(:c) { build(:contributor, :last) }
+
+    it { c.should be_an_instance_of Scholar::Utilities::Contributor }
+    it { c.name.should eql "Grossman, Les R., Esq" }
+  end
+
+  context "non-author" do
+    let(:c) { build(:contributor, :first) }
+
+    it { c.should be_an_instance_of Scholar::Utilities::Contributor }
+    it { c.name.should eql "John Q. Sample, PhD"}
+  end
+
+  describe "#reorder!" do
+    let(:first) { build(:contributor, :first) }
+    let(:last)  { build(:contributor, :last) }
+
+    before do
+      first.reorder!(:last)
+      last.reorder!(:first)
+    end
+
+    it { first.name.should eql "Sample, John Q., PhD" }
+    it { last.name.should eql "Les R. Grossman, Esq" }
+  end
+end

data/spec/scholar/utilities/data_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe Scholar::Utilities::Data do
+  let(:s) { Scholar::Utilities }
+
+  describe "#concatenate!" do
+    let(:hash) do
+      { :foo => "bar ", :bar => "foo", :foobar => "barfoo" }
+    end
+
+    let(:c) { s.concatenate!(hash) }
+
+    it { c.should eql "bar foo barfoo" }
+  end
+
+  describe "#contributors!" do # Clean this up.
+    let(:pre) do
+      {
+        :foo => "bar",
+        :contributors => [
+          {
+            :role => :author,
+            :first => "John",
+            :last => "Green"
+          },
+          {
+            :role => :author,
+            :first => "Carl",
+            :last => "Sagan"
+          },
+          {
+            :role => :editor,
+            :first => "Neil",
+            :middle => "deGrasse",
+            :last => "Tyson",
+            :suffix => "PhD"
+          },
+          {
+            :role => :translator,
+            :first => "Dalai",
+            :last => "Lama"
+          }
+        ]
+      }
+    end
+
+    let(:post) do
+      {
+        :foo => "bar",
+        :authors => "Green, John, Carl Sagan",
+        :editors => "Neil D. Tyson, PhD",
+        :translators => "Dalai Lama"
+      }
+    end
+
+    let(:c) { s.contributors!(pre) }
+
+    it { c.should eql post }
+  end
+
+  describe "#format!" do
+    let(:hash) do
+      { :foo => "Barfoo", :bar => "Foobar" }
+    end
+
+    let(:rules) do
+      Scholar::Source.rules do
+        rule(:foo) {|v| italicize(v) }
+        rule(:bar) {|v| underline(v) }
+      end
+    end
+
+    let(:result) do
+      { :foo => "<em>Barfoo</em>", :bar => "<u>Foobar</u>" }
+    end
+
+    let(:c) { s.format!(hash, rules) }
+
+    it { c.should eql result }
+  end
+
+  describe "#order!" do
+    let(:hash) do
+      { :foobar => "Foo to the bar to the foo.", :bar => "Hello there.", :abc => "123" }
+    end
+
+    let(:sequence) do
+      [ :abc, :foobar, :bar ]
+    end
+
+    let(:h) { s.order!(hash, sequence) }
+
+    it { h.keys.should eql sequence }
+  end
+end

data/spec/scholar/utilities/formatters_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe Scholar::Utilities::Formatters do
+  let(:s) { Scholar::Utilities }
+
+  describe ".capitalize" do
+    let(:str) { s.capitalize("foo") }
+
+    it { str.should eql "Foo" }
+  end
+
+  describe ".carets" do
+    let(:str) { s.carets("foo") }
+
+    it { str.should eql "<foo>" }
+  end
+
+  describe ".colon" do
+    let(:str) { s.colon("foo") }
+
+    it { str.should eql "foo:" }
+  end
+
+  describe ".comma" do
+    let(:str) { s.comma("foo") }
+
+    it { str.should eql "foo," }
+  end
+
+  describe ".italicize" do
+    let(:str) { s.italicize("foo") }
+
+    it { str.should eql "<em>foo</em>" }
+  end
+
+  describe ".ordinal" do
+    let(:int) { s.ordinal(1) }
+
+    it { int.should eql "1st" }
+  end
+
+  describe ".period" do
+    let(:str) { s.period("foo") }
+
+    it { str.should eql "foo." }
+  end
+
+  describe ".quotes" do
+    let(:str) { s.quotes("foo") }
+
+    it { str.should eql "&#8220;foo&#8221;" }
+  end
+
+  describe ".replace" do
+    let(:str) { s.replace("foo") }
+
+    it { str.should eql "foo" }
+  end
+
+  describe ".underline" do
+    let(:str) { s.underline("foo") }
+
+    it { str.should eql "<u>foo</u>" }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'spork'
+
+Spork.prefork do
+  require 'rspec'
+  require 'factory_girl'
+
+  require 'log_buddy'
+
+  require_relative '../lib/scholar'
+
+  FactoryGirl.find_definitions
+
+  RSpec.configure do |c|
+    c.include FactoryGirl::Syntax::Methods
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: scholar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ethan Turkeltaub
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.11
+description: Generate valid MLA citations.
+email:
+- ethan.turkeltaub@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/scholar.rb
+- lib/scholar/citation.rb
+- lib/scholar/source.rb
+- lib/scholar/sources/book.rb
+- lib/scholar/utilities.rb
+- lib/scholar/utilities/contributor.rb
+- lib/scholar/utilities/contributor_list.rb
+- lib/scholar/utilities/data.rb
+- lib/scholar/utilities/formatters.rb
+- scholar.gemspec
+- spec/factories/contributor.rb
+- spec/factories/contributor_list.rb
+- spec/scholar/source_spec.rb
+- spec/scholar/sources/book_spec.rb
+- spec/scholar/utilities/contributor_list_spec.rb
+- spec/scholar/utilities/contributor_spec.rb
+- spec/scholar/utilities/data_spec.rb
+- spec/scholar/utilities/formatters_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/noted/scholar
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -551428721
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -551428721
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Generate valid MLA citations.
+test_files:
+- spec/factories/contributor.rb
+- spec/factories/contributor_list.rb
+- spec/scholar/source_spec.rb
+- spec/scholar/sources/book_spec.rb
+- spec/scholar/utilities/contributor_list_spec.rb
+- spec/scholar/utilities/contributor_spec.rb
+- spec/scholar/utilities/data_spec.rb
+- spec/scholar/utilities/formatters_spec.rb
+- spec/spec_helper.rb