scholar 0.1.1 → 0.1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a90a3bff79b16dfad4e4bc5bc09406a5f2e152bc
+  data.tar.gz: fbf2f945a7ac9972cc10e0d28fcaa15e24e36143
+SHA512:
+  metadata.gz: 21f72e1dbc403101ab21360ede3b307a71ed95ca77602e86b30200755b0c570140bfd6f8ff6efe10d4c0ccb16b54ec1671143dd1ba79760f897f49b3a2d3feb2
+  data.tar.gz: f616eb866b88c827380d1b88722d502b53310a0dbf6ec1b8e5ef57932a760e7f2465c941bec2eb8b15ba9d08bb79155eec83364776b7c5ba841b83ede6cceba5

data/.rspec

@@ -1,3 +1,4 @@
 --format Fuubar
 --color
+--order random
 --drb

data/.ruby-version

@@ -1 +1 @@
-1.9.3-p385
+2.0.0-p247

data/Gemfile

@@ -20,4 +20,7 @@ group :test do
   gem 'fuubar', '~> 1.1.0'
 
   gem 'cane', :platforms => :mri
+
+  gem 'simplecov', '0.7.1'
+  gem 'coveralls', '0.6.3'
 end

data/Gemfile.lock

@@ -1,50 +1,67 @@
 PATH
   remote: .
   specs:
-    scholar (0.1.1)
-      activesupport (~> 3.2.11)
+    scholar (0.1.1.1)
+      activesupport (~> 4.0.0)
       faraday (~> 0.8.7)
       faraday_middleware (~> 0.9.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (3.2.11)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    addressable (2.3.3)
-    cane (2.5.0)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    atomic (1.1.14-java)
+    cane (2.6.0)
       parallel
-    coderay (1.0.8)
-    crack (0.3.2)
+    coderay (1.0.9)
+    colorize (0.6.0)
+    coveralls (0.6.3)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
     diff-lcs (1.1.3)
     factory_girl (4.2.0)
       activesupport (>= 3.0.0)
-    faraday (0.8.7)
-      multipart-post (~> 1.1)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
     faraday_middleware (0.9.0)
       faraday (>= 0.7.4, < 0.9)
-    ffi (1.6.0-java)
-    fuubar (1.1.0)
+    ffi (1.9.0-java)
+    fuubar (1.1.1)
       rspec (~> 2.0)
       rspec-instafail (~> 0.2.0)
-      ruby-progressbar (~> 1.0.0)
-    i18n (0.6.1)
+      ruby-progressbar (~> 1.0)
+    i18n (0.6.5)
     log_buddy (0.7.0)
-    method_source (0.8.1)
-    multi_json (1.5.0)
+    method_source (0.8.2)
+    mime-types (1.25)
+    minitest (4.7.5)
+    multi_json (1.8.2)
     multipart-post (1.2.0)
-    parallel (0.6.1)
-    pry (0.9.11.4)
+    parallel (0.9.0)
+    pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
-    pry (0.9.11.4-java)
+    pry (0.9.12.2-java)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
       spoon (~> 0.0)
-    rake (10.0.3)
+    rake (10.1.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
       rspec-expectations (~> 2.12.0)
@@ -54,11 +71,22 @@ GEM
       diff-lcs (~> 1.1.3)
     rspec-instafail (0.2.4)
     rspec-mocks (2.12.2)
-    ruby-progressbar (1.0.2)
-    slop (3.4.3)
-    spoon (0.0.3)
+    ruby-progressbar (1.2.0)
+    safe_yaml (0.9.7)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.4.6)
+    spoon (0.0.4)
       ffi
     spork (0.9.2)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    thread_safe (0.1.3-java)
+      atomic
+    tzinfo (0.3.38)
     vcr (2.4.0)
     webmock (1.8.11)
       addressable (>= 2.2.7)
@@ -70,6 +98,7 @@ PLATFORMS
 
 DEPENDENCIES
   cane
+  coveralls (= 0.6.3)
   factory_girl (~> 4.2.0)
   fuubar (~> 1.1.0)
   log_buddy (~> 0.7.0)
@@ -77,6 +106,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 2.12.0)
   scholar!
+  simplecov (= 0.7.1)
   spork (~> 0.9.2)
   vcr (~> 2.4.0)
   webmock (~> 1.8.0)

data/README.md

@@ -1,4 +1,6 @@
-# Scholar [![Build Status](https://secure.travis-ci.org/noted/scholar.png)](https://travis-ci.org/noted/scholar)
+# Scholar
+
+[![Gem Version](https://badge.fury.io/rb/scholar.png)](https://rubygems.org/gems/scholar) [![Build Status](https://secure.travis-ci.org/noted/scholar.png)](https://travis-ci.org/noted/scholar) [![Code Climate](https://codeclimate.com/github/noted/scholar.png)](https://codeclimate.com/github/noted/scholar) [![Coverage Status](https://coveralls.io/repos/noted/scholar/badge.png?branch=master)](https://coveralls.io/r/noted/scholar)
 
 Scholar is a Ruby library for building [MLA citations](http://www.mla.org/) for scholarly works. Just pass Scholar your data and it'll do the rest.
 
@@ -50,9 +52,9 @@ salinger.html # => Salinger, J. D. <em>Catcher in the Rye</em>. Boston: Little,
 
 `Scholar::Citation.new` only takes a `Hash` with the attributes associated with the source.
 
-### Required Keys
+#### Required Keys
 
-#### Global Attributes
+##### Global Attributes
 
 All source types can (and must) take these fields.
 
@@ -61,7 +63,7 @@ Key             | Description
 `:type`         | The type of publication you're citing ([see the wiki for a list of supported types](types)). Must be a `Symbol` object.
 `:contributors` | An array of contributors (see below for details). If there are no contributors, pass an empty `Array`.
 
-##### Contributors
+###### Contributors
 
 The `:contributors` key is an array of hashes that define contributors. Here's an example.
 
@@ -107,10 +109,6 @@ Key       | Description
 `:last`   | The contributor's last name (surname).
 `:suffix` | Any suffixes or titles the contributor has ("PhD", "Esq", "Jr", "KBD", et cetera). Omit any periods.
 
-## Supported Ruby Versions
-
-Scholar is tested on MRI version 1.9.2, 1.9.3, and 2.0.0.
-
 ### Search
 
 ```ruby
@@ -118,17 +116,19 @@ search = Scholar::Search.new("harry potter")
 search.results # => [#<Scholar::Citation>, #<Scholar::Citation>, ...]
 ```
 
+## Supported Ruby Versions
+
+Scholar is tested on MRI versions 1.9.2, 1.9.3, and 2.0.0, JRuby 1.7.3, and Rubinius 2.0.0.
+
 ## 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]
+4. Write code until all tests (ran with `bundle exec rspec`) passes.
+5. Add documentation for your feature or bug fix.
+6. Add, commit, and push your changes.
+7. [Submit a pull request.][pr]
 
 [types]: https://github.com/noted/scholar/wiki/Supported-Types
 [fork]: http://help.github.com/fork-a-repo/

data/lib/scholar.rb

@@ -1,5 +1,3 @@
-require 'json'
-
 require 'active_support/all'
 
 require 'faraday'

data/lib/scholar/citation.rb

@@ -47,6 +47,14 @@ module Scholar
       @raw = @attributes.clone
       @attributes.delete(:type)
 
+      @attributes.each do |k, v|
+        if v.is_a?(Fixnum)
+          @attributes[k] = v.to_s
+        end
+      end
+
+      @attributes.delete_if {|k, v| v.nil? || v.empty? }
+
       if @attributes[:contributors]
         @attributes = Scholar::Utilities.contributors!(@attributes)
       end
@@ -69,10 +77,5 @@ module Scholar
 
       hash
     end
-
-    # Returns the Citation object in JSON form.
-    def to_json
-      hash = self.to_hash.to_json
-    end
   end
 end

data/lib/scholar/search.rb

@@ -35,6 +35,21 @@ module Scholar
       self
     end
 
+    # Return as hash.
+    def to_hash
+      hash = {}
+
+      instance_variables.each do |v|
+        hash[v.to_s[1..-1].to_sym] = instance_variable_get(v)
+      end
+
+      hash[:results].each do |c|
+        hash[:results][hash[:results].index(c)] = c.to_hash
+      end
+
+      hash
+    end
+
     private
 
     def perform!(query)

data/lib/scholar/utilities/contributor.rb

@@ -40,6 +40,8 @@ module Scholar
           data[:role] = :author
         end
 
+        data.delete_if {|k, v| v.nil? || v.empty? }
+
         @order = order
 
         @attributes = order!(data)

data/scholar.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "scholar"
-  gem.version       = "0.1.1"
+  gem.version       = "0.1.1.1"
   gem.authors       = ["Ethan Turkeltaub"]
   gem.email         = ["ethan.turkeltaub@gmail.com"]
   gem.description   = %q{Generate valid MLA citations.}
@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency 'activesupport', '~> 3.2.11'
+  gem.add_dependency 'activesupport', '~> 4.0.0'
   gem.add_dependency 'faraday', '~> 0.8.7'
   gem.add_dependency 'faraday_middleware', '~> 0.9.0'
 end

data/spec/factories/contributor.rb

@@ -15,7 +15,7 @@ FactoryGirl.define do
     trait :last do
       hash = {
         :role => :author,
-        :first => "Les",
+        :first => "L",
         :middle => "Randy",
         :last => "Grossman",
         :suffix => "Esq"

data/spec/scholar/citation_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Scholar::Citation do
+  let(:c) do
+    Scholar::Citation.new({
+      :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
+
+  describe "#to_hash" do
+    it { c.to_hash.keys.should =~ [:attributes, :raw, :html] }
+  end
+end

data/spec/scholar/search_spec.rb

@@ -5,16 +5,21 @@ describe Scholar::Search do
     VCR.insert_cassette 'search', :record => :all
   end
 
-  describe ".new" do
-    let(:search) do
-      Scholar::Search.new("foobar")
-    end
+  let(:search) do
+    Scholar::Search.new("foobar")
+  end
 
+  describe ".new" do
     it { search.query.should eql "foobar" }
     it { search.results.should be_an_instance_of Array }
     it { search.results[0].should be_an_instance_of Scholar::Citation }
   end
 
+  describe "#to_hash" do
+    it { search.to_hash.keys.should =~ [:query, :results] }
+    it { search.to_hash[:results][0].should be_an_instance_of Hash }
+  end
+
   after do
     VCR.eject_cassette
   end

data/spec/scholar/utilities/contributor_spec.rb

@@ -5,7 +5,7 @@ describe Scholar::Utilities::Contributor 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" }
+    it { c.name.should eql "Grossman, L. R., Esq" }
   end
 
   context "non-author" do
@@ -25,6 +25,6 @@ describe Scholar::Utilities::Contributor do
     end
 
     it { first.name.should eql "Sample, John Q., PhD" }
-    it { last.name.should eql "Les R. Grossman, Esq" }
+    it { last.name.should eql "L. R. Grossman, Esq" }
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,13 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start
+
 require 'spork'
 
 Spork.prefork do

metadata

@@ -1,36 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: scholar
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.1.1
 platform: ruby
 authors:
 - Ethan Turkeltaub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-30 00:00:00.000000000 Z
+date: 2013-10-19 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
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.11
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -88,6 +81,7 @@ files:
 - scholar.gemspec
 - spec/factories/contributor.rb
 - spec/factories/contributor_list.rb
+- spec/scholar/citation_spec.rb
 - spec/scholar/search_spec.rb
 - spec/scholar/source_spec.rb
 - spec/scholar/sources/book_spec.rb
@@ -99,37 +93,31 @@ files:
 homepage: http://github.com/noted/scholar
 licenses:
 - MIT
+metadata: {}
 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: 1067264813
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1067264813
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Generate valid MLA citations.
 test_files:
 - spec/factories/contributor.rb
 - spec/factories/contributor_list.rb
+- spec/scholar/citation_spec.rb
 - spec/scholar/search_spec.rb
 - spec/scholar/source_spec.rb
 - spec/scholar/sources/book_spec.rb