RubyGems - doc_rank - Versions diffs - 0.0.0.alpha.1 → 0.0.0.alpha.2 - Mend

doc_rank 0.0.0.alpha.1 → 0.0.0.alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03bc0a33ae8336edd2ec2ef6bc81e69b4e14b73c
-  data.tar.gz: 994f820a2eb61efbf85b9626a93fb52ad2b944a2
+  metadata.gz: d561d37c85fb35101c071fb73814f786bac64b0f
+  data.tar.gz: e22786ab6c7d58ba17a1ec3f17fad2fecc4a7e9a
 SHA512:
-  metadata.gz: aabe0a61a8fd011f01d184f9613016e3c4b34bd69bdd73f86a09723f105d237b656b41825b1e55f8a3434a85abe1494d75fbc46ae62ce0f254f1d7ad2b663059
-  data.tar.gz: 918065545aed599263c8c0fef283e52ac468abaf398d122a476ca4e09e2759748165a24106053c73e9a1e3a63f93480fd0ae6bed6268aa33a0d0a6f3e37550d1
+  metadata.gz: d9a15a757324b53834c47431da9d7c165ef550ad9adfa71cca45c35c62ce03cba9403b69ca59481ad46e620258bbe3e19cb8a35e8cd36db19bac92508c84ed32
+  data.tar.gz: 0d1fe0b9b4fa900657b2429eb7244221e2b54a7df53f7e3572be8a2b40fdf5fb3b66d3801578915dc5a3a94a1778306ef840e121dffaf7a9e3ad628f987f8ecd

data/.travis.yml CHANGED Viewed

@@ -3,3 +3,6 @@ language: ruby
 rvm:
   - 2.4.1
 before_install: gem install bundler -v 1.15.4
+script:
+  - bundle exec rspec
+  - bundle exec yard stats | grep "100.00% documented"

data/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,14 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+For more information about changelogs, check
+[Keep a Changelog](http://keepachangelog.com) and
+[Vandamme](http://tech-angels.github.io/vandamme).
+## 0.0.0.alpha.2 - 2017/09/07
+* [FEATURE] Add `DocRank.compare`
+* [FEATURE] Add `DocRank::Document#text`
+* [FEATURE] Add `DocRank::Document#name`
+* [FEATURE] Add `DocRank::Document#keywords`

data/README.md CHANGED Viewed

@@ -1,8 +1,13 @@
 # DocRank
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/doc_rank`. To experiment with that code, run `bin/console` for an interactive prompt.
+Returns a similarity score between one or many documents against a base document (keyword comparison).
-TODO: Delete this and the text above, and describe your gem
+[![Build Status](http://img.shields.io/travis/S1v4/doc_rank/master.svg)](https://travis-ci.org/S1v4/doc_rank)
+[![Code Climate](http://img.shields.io/codeclimate/github/S1v4/doc_rank.svg)](https://codeclimate.com/github/S1v4/doc_rank)
+[![Online docs](http://img.shields.io/badge/docs-✓-green.svg)](http://www.rubydoc.info/gems/doc_rank/frames)
+[![Gem Version](http://img.shields.io/gem/v/doc_rank.svg)](http://rubygems.org/gems/doc_rank)
+The **source code** is available on [GitHub](https://github.com/S1v4/doc_rank) and the **documentation** on [RubyDoc](http://www.rubydoc.info/gems/doc_rank/frames).
 ## Installation

data/doc_rank.gemspec CHANGED Viewed

@@ -6,7 +6,7 @@ require "doc_rank/version"
 Gem::Specification.new do |spec|
   spec.name          = "doc_rank"
   spec.version       = DocRank::VERSION
-  spec.authors       = ["s1v4", "sganous"]
+  spec.authors       = ["s1v4", "sergeg"]
   spec.email         = ["hdao61@gmail.com", "sergeyganous@gmail.com"]
   spec.summary       = %q{Returns a similarity score between one or many documents against a base document (keyword comparison).}
@@ -21,12 +21,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.add_development_dependency "yard", "~> 0.9.9"
-  spec.add_development_dependency "presume", "~> 0.0.4"
   spec.add_development_dependency "highscore", "~> 1.2.1"
-  spec.add_development_dependency "docx", "~> 0.2.07"
-  spec.add_development_dependency "pdf-reader", "~> 2.0.0"
+  spec.add_development_dependency "yomu", "~> 0.2.4"
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
 end

data/lib/doc_rank.rb CHANGED Viewed

@@ -1,5 +1,17 @@
 require "doc_rank/version"
+require "doc_rank/document"
+# A gem to rank document similarities.
 module DocRank
-  # Your code goes here...
+  # @return [Hash] a hash of document names mapped to their score.
+  # @param [String] base the file by which target documents are scored againsts.
+  # @param [Array<String>] targets a single file or many files used for comparison.
+  def self.compare(base, targets)
+    base_keywords = DocRank::Document.new(base).keywords.map(&:text)
+    Array(targets).map do |target|
+      doc = DocRank::Document.new target
+      matches = base_keywords & doc.keywords.map(&:text)
+      [doc.name, matches.size]
+    end.sort_by{|doc| doc[1]}.to_h
+  end
 end

data/lib/doc_rank/document.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require 'yomu'
+require 'highscore'
+# A gem to rank document similarities.
+module DocRank
+  # Document holds the contents of a document (.pdf, .docx, .txt) and has methods:
+  # name, text, and keywords.
+  class Document
+    # [String] the name of the document.
+    attr_reader :name
+    # [String] the text content of the document.
+    attr_reader :text
+    # [Highscore::Keyword] a collection of keyword objects.
+    attr_reader :keywords
+    # @param [String] file The path to the file.
+    def initialize(file_path)
+      @text = Yomu.new(file_path).text
+      @name = File.basename file_path
+      @keywords = Highscore::Content.new(@text).keywords
+    end
+  end
+end

data/lib/doc_rank/version.rb CHANGED Viewed

@@ -1,3 +1,4 @@
 module DocRank
-  VERSION = "0.0.0.alpha.1"
+  #DockRank SemVer-compatible gem version.
+  VERSION = "0.0.0.alpha.2"
 end

metadata CHANGED Viewed

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: doc_rank
 version: !ruby/object:Gem::Version
-  version: 0.0.0.alpha.1
+  version: 0.0.0.alpha.2
 platform: ruby
 authors:
 - s1v4
-- sganous
+- sergeg
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-09-06 00:00:00.000000000 Z
+date: 2017-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -26,105 +26,105 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.9
 - !ruby/object:Gem::Dependency
-  name: presume
+  name: highscore
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 1.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
-  name: highscore
+  name: yomu
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 0.2.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
-  name: docx
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.07
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.07
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: pdf-reader
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -148,6 +148,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -156,6 +157,7 @@ files:
 - bin/setup
 - doc_rank.gemspec
 - lib/doc_rank.rb
+- lib/doc_rank/document.rb
 - lib/doc_rank/version.rb
 homepage: https://github.com/S1v4/doc_rank
 licenses: