citesight 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a923e35cd2ee4dfb162449aba2f5c1fb50358efe
-  data.tar.gz: 606aeba079bda3f0ebb5248d22bbfa28b301e5df
+  metadata.gz: 7e11117f9c3c2e1eacd42126bc7a97ed7841ee28
+  data.tar.gz: a0dfd14a313ec7ece65bed421eb335fdda9427de
 SHA512:
-  metadata.gz: da9e7c7f486d9f04ba1a7e8e046adb90fb53dacb868aceca082a1ec22fa67548c99c6b71c79e1b8749a23d6a79be80845b60147d4d724805802c05937769a0dc
-  data.tar.gz: b63e4978e3e02a876cf8ee09c9a28e0f8049eb68f8b80872abe6902f30df1f734c839397c5563fe2cb5d07bde9383e7256f2a91ae138bb67598e08a52d5b480f
+  metadata.gz: ace1dc22e05ee5eebe3383d075d8965ab503209bbd14dd8d72ca042aff3608c7497404fd1d5acebe5317c35b5e6c973604f527665f7425cbfa26503436da5b3e
+  data.tar.gz: 49ab665d7ea38767d508681707a15c0c6063dad04df974354e352a859311e4bf6b2b00b9c673391e0b5a6498102a777ac76c91a3fe4106ce4ea78f58bc15bba2

data/.bundle/config

@@ -0,0 +1 @@
+--- {}

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+*_ignoreme.*
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.1.0
+
+branches:
+  only:
+    - master
+    - develop
+    - /^rel-.*$/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+gemspec
+
+group :test do
+  gem 'rake'
+  gem 'json'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Soumya Ray
+
+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,28 @@
+#citesight
+[![Gem Version](https://badge.fury.io/rb/citesight.svg)](http://badge.fury.io/rb/citesight)
+[![Build Status](https://travis-ci.org/soumyaray/citesight.svg?branch=master)](https://travis-ci.org/soumyaray/citesight)
+
+home: [https://github.com/soumyaray/citesight](https://github.com/soumyaray/citesight)
+Gem to extract and report on citations in an academic text
+
+## Usage
+This gem may be used as a command line utility or called from code
+
+### CLI:
+    citesight mydoc.txt
+
+### Code example:
+    require 'citesight'
+    require 'pp'
+
+    contents = File.read("spec/testfiles/large_test.txt", :encoding => "UTF-8")
+    cites = PaperCitations.unique_cites(contents)
+
+    puts "\nTotal unique citations: #{cites.count}"
+    PP.pp(Hash[cites])
+
+    top_cite = cites.sort_by { |_c, count| count}.reverse.first[0]
+    puts "\nYour top citation: #{top_cite}"
+
+    top_cite_indexes = PaperCitations.index_of_cite(contents, top_cite)
+    puts "It was cited at locations: #{top_cite_indexes.join(', ')}"

data/Rakefile

@@ -0,0 +1,6 @@
+task :default => :spec
+
+desc 'Run specs'
+task :spec do
+  sh 'ruby -I lib spec/citesight_spec.rb'
+end

data/bin/citesight

@@ -1,5 +1,6 @@
 #!/usr/bin/env ruby
 
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 require 'citesight'
 require 'pp'
 
@@ -9,7 +10,9 @@ fail ArgumentError, "Usage:  get_citations [filename]\n" if ARGV.count == 0
 
 contents = File.open(ARGV[0], 'r').read
 
-results = PaperCitations.unique_cites(contents).sort_by { |c, _| c.downcase }
+results = CiteSight::PaperCitations.unique_cites(contents).sort_by do |c, _|
+  c.downcase
+end
 
 puts "Top citations:\n"
 PP.pp(Hash[results.sort_by { |_cite, count| count }.reverse.take(5)])

data/citesight.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'citesight/version'
+
+Gem::Specification.new do |s|
+  s.name        =  'citesight'
+  s.version     =  CiteSight::VERSION
+  s.date        =  CiteSight::DATE
+
+  s.executables << 'citesight'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-rg'
+
+  s.summary     =  'Citation extractor and analyzer'
+  s.description =  'Extract and analyze citations from APA style text'
+  s.authors     =  ['Soumya Ray']
+  s.email       =  'soumya.ray@gmail.com'
+
+  s.files       =  `git ls-files`.split("\n")
+  s.test_files  =  `git ls-files -- {test,spec,features}/*`.split("\n")
+  
+  s.homepage    =  'https://github.com/soumyaray/citesight'
+  s.license     =  'MIT'
+end

data/lib/citesight.rb

@@ -1,55 +1 @@
-# This class extracts and counts APA-style citations in a paper.
-# The unique_cites method returns a hash of citations and counts
-# in the order in which they were encountered.
-class PaperCitations
-  def self.unique_cites(contents)
-    new(contents).unique_cites
-  end
-
-  def self.index_of_cite(contents, cite)
-    new(contents).index_of_cite(cite)
-  end
-
-  def initialize(contents)
-    @contents = contents
-  end
-
-  def unique_cites
-    clean_cites = @contents.scan(cite_match).map do |c|
-      remove_punctuation(c[0])
-    end
-
-    Hash[clean_cites.group_by { |c| c }.map { |cit, num| [cit, num.count] }]
-  end
-
-  ##
-  # Returns array of citation locations (index) in manuscript
-  #
-  #     contents = File.read('./spec/testfiles/test.txt')
-  #     PaperCitations.index_cite(contents, 'Peters et al. 2007')
-  #     # => [219, 500]
-  def index_of_cite(cite)
-    cite_parts = cite.split
-    author_s = cite_parts.take(cite_parts.size-1).join(' ')
-    year_s = cite_parts.last
-    @contents.enum_for(:scan, /(#{author_s}#{possessive}?#{year(year_s)})/
-                      ).map { Regexp.last_match.begin(0) }
-  end
-
-  private
-
-  def prefix() '(([dD]e|[vV]an[ ]?[dD]er)[ ]?)' end
-  def author() "(#{prefix}?[A-Z][[:alpha:]\'\u2019\-]+)" end
-  def other_authors() "([ ]and[ ]#{author} | ([ ]et[ ]al.){1})" end
-  def possessive() "([\'\u2019]s|[\'\u2019])" end
-  def year_literal() "[1-2][0-9]{3}[a-z]?" end
-  def year(yr) "([ ][\(]?#{yr}[,\)\;])" end
-
-  def cite_match
-    /( #{author}{1}#{other_authors}?#{possessive}?#{year(year_literal)} )/x
-  end
-
-  def remove_punctuation(cite)
-    cite.gsub(/[\(\),;]|([\'\u2019]s)/, '').gsub(/[\'\u2019]\s/, ' ')
-  end
-end
+require 'citesight/paper_citations.rb'

data/lib/citesight/paper_citations.rb

@@ -0,0 +1,57 @@
+# This class extracts and counts APA-style citations in a paper.
+# The unique_cites method returns a hash of citations and counts
+# in the order in which they were encountered.
+module CiteSight
+  class PaperCitations
+    def self.unique_cites(contents)
+      new(contents).unique_cites
+    end
+
+    def self.index_of_cite(contents, cite)
+      new(contents).index_of_cite(cite)
+    end
+
+    def initialize(contents)
+      @contents = contents
+    end
+
+    def unique_cites
+      clean_cites = @contents.scan(cite_match).map do |c|
+        remove_punctuation(c[0])
+      end
+
+      Hash[clean_cites.group_by { |c| c }.map { |cit, num| [cit, num.count] }]
+    end
+
+    ##
+    # Returns array of citation locations (index) in manuscript
+    #
+    #     contents = File.read('./spec/testfiles/test.txt')
+    #     PaperCitations.index_cite(contents, 'Peters et al. 2007')
+    #     # => [219, 500]
+    def index_of_cite(cite)
+      cite_parts = cite.split
+      author_s = cite_parts.take(cite_parts.size-1).join(' ')
+      year_s = cite_parts.last
+      @contents.enum_for(:scan, /(#{author_s}#{possessive}?#{year(year_s)})/
+                        ).map { Regexp.last_match.begin(0) }
+    end
+
+    private
+
+    def prefix() '(([dD]e|[vV]an[ ]?[dD]er)[ ]?)' end
+    def author() "(#{prefix}?[A-Z][[:alpha:]\'\u2019\-]+)" end
+    def other_authors() "([ ]and[ ]#{author} | ([ ]et[ ]al.){1})" end
+    def possessive() "([\'\u2019]s|[\'\u2019])" end
+    def year_literal() "[1-2][0-9]{3}[a-z]?" end
+    def year(yr) "([ ][\(]?#{yr}[,\)\;])" end
+
+    def cite_match
+      /( #{author}{1}#{other_authors}?#{possessive}?#{year(year_literal)} )/x
+    end
+
+    def remove_punctuation(cite)
+      cite.gsub(/[\(\),;]|([\'\u2019]s)/, '').gsub(/[\'\u2019]\s/, ' ')
+    end
+  end
+end

data/lib/citesight/version.rb

@@ -0,0 +1,4 @@
+module CiteSight
+  VERSION = '0.1.2'
+  DATE    = '2016-05-10'
+end

data/spec/citesight_spec.rb

@@ -0,0 +1,48 @@
+require 'minitest/autorun'
+require 'minitest/rg'
+require './spec/minitest_helper.rb'
+
+describe 'Paper', 'A text document' do
+
+  describe 'when there are citations in the text' do
+    before do
+      @results = CiteSight::PaperCitations.unique_cites(TEST_CONTENTS)
+    end
+
+    it 'should fine the right citations' do
+      @results.must_equal TEST_CITES
+    end
+  end
+
+  describe 'when there are no citations to be found' do
+    it 'should return an empty hash' do
+      no_cites_txt = 'these are not the citations you are looking for'
+      # TODO: check return of empty hash
+    end
+  end
+end
+
+describe 'Cases', 'Test different citation cases' do
+  TEST_CASES.keys.each do |k|
+    it "can detect #{k}" do
+      CiteSight::PaperCitations.unique_cites(TEST_CASES[k]["case"]).to_a\
+        .must_equal(TEST_CASES[k]["result"])
+    end
+  end
+end
+
+describe 'Indexes', 'Accurately find index of different citations' do
+  it "can find the right index for all citations" do
+    TEST_CITES.map do |cite, _count|
+      TEST_INDEXES[cite].must_equal \
+                CiteSight::PaperCitations.index_of_cite(TEST_CONTENTS, cite)
+    end
+  end
+end
+
+## Produce hash of all cite indexes:
+# Hash[
+#   TEST_CITES.map do |cite, count|
+#     [cite, PaperCitations.index_cite(doc, cite)]
+#   end
+# ]

data/spec/minitest_helper.rb

@@ -0,0 +1,44 @@
+require 'json'
+require './lib/citesight.rb'
+
+TEST_CONTENTS = File.read('./spec/testfiles/test.txt')
+
+TEST_CITES =
+  {
+    "Charlton 2002" => 1,
+    "Griffiths 2000" => 1,
+    "Peters et al. 2007" => 2,
+    "Ma and Agarwal 2007" => 1,
+    "Hur 2007" => 2,
+    "Oreg 1995b" => 1,
+    "Ray 2000" => 2,
+    "Ma et al. 2002" => 3,
+    "Griffins 2000" => 1,
+    "O'Hern 2010" => 1,
+    "McDonald 2003" => 1,
+    "Wa'el et al. 1993" => 1,
+    "van der Aalst 2004" => 1,
+    "De Boor 1980" => 1
+  }
+
+TEST_INDEXES =
+  {
+    "Charlton 2002"=>[40],
+    "Griffiths 2000"=>[97],
+    "Peters et al. 2007"=>[219, 500],
+    "Ma and Agarwal 2007"=>[174],
+    "Hur 2007"=>[146, 490],
+    "Oreg 1995b"=>[318],
+    "Ray 2000"=>[346, 432],
+    "Ma et al. 2002"=>[272, 377, 407],
+    "Griffins 2000"=>[522],
+    "O'Hern 2010"=>[566],
+    "McDonald 2003"=>[634],
+    "Wa'el et al. 1993"=>[583],
+    "van der Aalst 2004"=>[697],
+    "De Boor 1980"=>[729]
+  }
+
+TEST_CASES = File.open('./spec/testfiles/test_cases.json', 'r') do |f|
+  JSON.load(f)
+end

data/spec/testfiles/large_test.txt

@@ -0,0 +1 @@
+
                Effects		Base Model		Proposed Model		Full Model

data/spec/testfiles/large_test_results.txt

@@ -0,0 +1,98 @@
+Top citations:
+{"Kim et al. 2005"=>13,
+ "Polites and Karahanna 2012"=>12,
+ "Turel et al. 2011b"=>11,
+ "Limayem et al. 2007"=>7,
+ "Kelley and Berridge 2002"=>5}
+
+Total unique citations: 90
+{"Aarts and Dijksterhuis 2000"=>3,
+ "Agarwal and Karahanna 2000"=>2,
+ "Ainslie 2001"=>2,
+ "Bagozzi and Yi 1988"=>2,
+ "Bagozzi et al. 2003"=>5,
+ "Bargh et al. 2001"=>2,
+ "Berke and Hyman 2000"=>1,
+ "Bhattacherjee 2001"=>1,
+ "Browne et al. 1993"=>1,
+ "Caplan 2002"=>3,
+ "Chak and Leung 2004"=>3,
+ "Charlton 2002"=>1,
+ "Charlton and Danforth 2010"=>1,
+ "Chou and Ting 2003"=>1,
+ "Corder and Corder 1974"=>1,
+ "Davis 2001"=>2,
+ "Davis et al. 1989"=>1,
+ "Davis et al. 1992"=>1,
+ "Davis et al. 2002"=>2,
+ "deGuinea and Markus 2009"=>1,
+ "Everitt and Robbins 2005"=>1,
+ "Fornell and Larcker 1981"=>2,
+ "Gollwitzer 1996"=>1,
+ "Gray 1970"=>2,
+ "Gray and McNaughton 2000"=>2,
+ "Griffiths 2000"=>1,
+ "Grodner and Reid 2010"=>1,
+ "Grover et al. 2011"=>1,
+ "Hampton et al. 2011"=>2,
+ "Harrison 1968"=>1,
+ "Harrison and Zajonc 1970"=>1,
+ "Holden 2001"=>2,
+ "Huang et al. 2009"=>1,
+ "Hur 2006"=>2,
+ "Jasperson et al. 2005"=>2,
+ "Jennett et al. 2008"=>3,
+ "Jöreskog and Sörbom 1996"=>1,
+ "Kelley and Berridge 2002"=>5,
+ "Kim 2009"=>2,
+ "Kim and Malhotra 2005"=>2,
+ "Kim and Son 2009"=>1,
+ "Kim et al. 2005"=>13,
+ "Kuss and Griffiths 2011"=>1,
+ "Lankton et al. 2010"=>1,
+ "Leary et al. 2005"=>1,
+ "Limayem and Hirt 2003"=>2,
+ "Limayem et al. 2007"=>7,
+ "Louis and Sutton 1991"=>2,
+ "Lunden 2012"=>2,
+ "Mellor et al. 2008"=>1,
+ "Mittal 1988"=>1,
+ "Moore and Benbasat 1991"=>1,
+ "Morahan-Martin and Schumacher 2000"=>3,
+ "Nicolaou and McKnight 2006"=>1,
+ "Oreg 2003"=>1,
+ "Peters et al. 2007"=>1,
+ "Phillips 2009"=>1,
+ "Podsakoff et al. 2003"=>1,
+ "Polites and Karahanna 2012"=>12,
+ "Robinson and Berridge 1993"=>5,
+ "Robinson and Berridge 2003"=>4,
+ "Rokeach 1960"=>1,
+ "Salaway et al. 2008"=>1,
+ "Seah and Cairns 2008"=>2,
+ "Segars 1997"=>1,
+ "Shotton 1991"=>1,
+ "Smith and Brenner 2012"=>1,
+ "Sutton 1987"=>1,
+ "Thadani and Cheung 2011"=>1,
+ "Tokunaga 2011"=>1,
+ "Turel and Serenko 2012"=>4,
+ "Turel et al. 2011"=>3,
+ "Turel et al. 2011a"=>3,
+ "Turel et al. 2011b"=>11,
+ "van der Heijden 2004"=>1,
+ "Venkatesh and Davis 2000"=>1,
+ "Venkatesh et al. 2000"=>1,
+ "Venkatesh et al. 2003"=>2,
+ "Venkatesh et al. 2008"=>1,
+ "Verplanken and Orbell 2003"=>1,
+ "Verplanken and Wood 2006"=>1,
+ "Verplanken et al. 1998"=>2,
+ "Wang 2001"=>2,
+ "Wang and Chu 2007"=>2,
+ "Wixom and Todd 2005"=>1,
+ "Yang and Tung 2007"=>1,
+ "Yellowlees and Marks 2007"=>1,
+ "Young 1998"=>2,
+ "Young 2004"=>2,
+ "Zait and Bertea 2011"=>1}

data/spec/testfiles/no_match.txt

@@ -0,0 +1,3 @@
+this file shouldn't pick up any citations even if
+there are years (like 2000) in it or names like McDonald or
+stray numbers 2000.

data/spec/testfiles/test.txt

@@ -0,0 +1,13 @@
+TEST CASES:
+special \u2019 quotes: from Charlton’s (2002) global measure
+trailing apostrophe: in Griffiths’ (2000) and others
+Single author: from Hur (2007) and
+Two authors: Ma and Agarwal (2007)
+More than two authors: Peters et al.’s (2007) major work similar to others (Ma et al. 2002)
+Possessive first author: even Oreg's (1995b) paper citing Ray's (2000) work
+Short names: Ma et al.'s (2002)
+Fragment1: Ma et al. (2002) et al. (Ray 2000) both published before 2005.
+Multiple cites: in (Hur 2007, Peters et al.’s 2007, Griffins' 2000) from
+Apostrophes in names: (O'Hern 2010) and Wa'el et al. (1993) or
+Capitals within names: from McDonald (2003) we gather that
+Multiword last names: even from van der Aalst (2004) or others (De Boor 1980).

data/spec/testfiles/test_cases.json

@@ -0,0 +1,54 @@
+{
+  "special u2019 quotes": {
+    "case": "from Charlton’s (2002) global measure",
+    "result": [["Charlton 2002", 1]]
+  },
+  "trailing apostrophe": {
+    "case": "in Griffiths’ (2000) and others",
+    "result": [["Griffiths 2000", 1]]
+  },
+  "single author": {
+    "case": "from Hur (2007) and",
+    "result": [["Hur 2007", 1]]
+  },
+  "two authors": {
+    "case": "Ma and Agarwal (2007)",
+    "result": [["Ma and Agarwal 2007", 1]]
+  },
+  "more than two authors": {
+    "case": "Peters et al.’s (2007) major work",
+    "result": [["Peters et al. 2007", 1]]
+  },
+  "possesive first author": {
+    "case": "even Hur's (2007) paper citing Ray's (2000) work",
+    "result": [["Hur 2007", 1], ["Ray 2000", 1]]
+  },
+  "character in year": {
+    "case": "Oreg's (1995b) paper and Venkatesh (2003a)",
+    "result": [["Oreg 1995b", 1], ["Venkatesh 2003a", 1]]
+  },
+  "short last name": {
+    "case": "from Ma et al. (2002) we find that",
+    "result": [["Ma et al. 2002", 1]]
+  },
+  "fragment1": {
+    "case": "Ma et al. (2002) et al. (2000)",
+    "result": [["Ma et al. 2002", 1]]
+  },
+  "multiple cites": {
+    "case": "in (Hur 2007, Peters et al.’s 2007, Griffiths' 2000) from",
+    "result": [["Hur 2007", 1], ["Peters et al. 2007", 1], ["Griffiths 2000", 1]]
+  },
+  "apostrophes in name": {
+    "case": "We've seen (O'Hern 2010) and Wa'el et al. (1993) say",
+    "result": [["O'Hern 2010", 1], ["Wa'el et al. 1993", 1]]
+  },
+  "capital letters within names": {
+    "case": "from McDonald (2003) we gather that",
+    "result": [["McDonald 2003", 1]]
+  },
+  "multiword last names": {
+    "case":   "even from van der Aalst (2004) or others (De Boor 1980) claim",
+    "result": [["van der Aalst 2004", 1], ["De Boor 1980", 1]]
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: citesight
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Soumya Ray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-30 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -45,8 +45,25 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/citesight.rb
+- ".bundle/config"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
 - bin/citesight
+- citesight.gemspec
+- lib/citesight.rb
+- lib/citesight/paper_citations.rb
+- lib/citesight/version.rb
+- spec/citesight_spec.rb
+- spec/minitest_helper.rb
+- spec/testfiles/large_test.txt
+- spec/testfiles/large_test_results.txt
+- spec/testfiles/no_match.txt
+- spec/testfiles/test.txt
+- spec/testfiles/test_cases.json
 homepage: https://github.com/soumyaray/citesight
 licenses:
 - MIT
@@ -67,8 +84,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Citation extractor and analyzer
-test_files: []
+test_files:
+- spec/citesight_spec.rb
+- spec/minitest_helper.rb
+- spec/testfiles/large_test.txt
+- spec/testfiles/large_test_results.txt
+- spec/testfiles/no_match.txt
+- spec/testfiles/test.txt
+- spec/testfiles/test_cases.json