doc_rank 0.0.0.alpha.2 → 0.0.0.alpha.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d561d37c85fb35101c071fb73814f786bac64b0f
-  data.tar.gz: e22786ab6c7d58ba17a1ec3f17fad2fecc4a7e9a
+  metadata.gz: 78aa3f24fc74f25238b5e0888027a4d3debd9b44
+  data.tar.gz: 989694cd61a85196089db8d8a6c3a2977ad14cb7
 SHA512:
-  metadata.gz: d9a15a757324b53834c47431da9d7c165ef550ad9adfa71cca45c35c62ce03cba9403b69ca59481ad46e620258bbe3e19cb8a35e8cd36db19bac92508c84ed32
-  data.tar.gz: 0d1fe0b9b4fa900657b2429eb7244221e2b54a7df53f7e3572be8a2b40fdf5fb3b66d3801578915dc5a3a94a1778306ef840e121dffaf7a9e3ad628f987f8ecd
+  metadata.gz: e1536fe620ca05693665e1524863cfcaaa5cd99d61310641ea196b5580ecd6816d707c0d55e0a22b6a47e44cf708066dad0549684135bcb93a64809bdb57aa59
+  data.tar.gz: c0a0a7b0d9307d51c26aef1c1fe74de3c9de7d4231f6249df076cf9d069a3b1b4036377d30b884fbba372953a597d8de98943819c4844ed5c1e5f78e50620d95

data/CHANGELOG.md

@@ -6,6 +6,15 @@ For more information about changelogs, check
 [Keep a Changelog](http://keepachangelog.com) and
 [Vandamme](http://tech-angels.github.io/vandamme).
 
+## 0.0.0.alpha.3 - 2017
+
+* [FEATURE] Add `DocRank::Ranker#base_doc`
+* [FEATURE] Add `DocRank::Ranker#target_docs`
+* [FEATURE] Add `DocRank::Ranker#scores`
+* [FEATURE] Add `DocRank::Ranker#weighted_scores`
+* [FEATURE] Change `DocRank::Document#keywords to DocRank::Document#weighted_keywords`
+* [FEATURE] Remove `DocRank.compare`
+
 ## 0.0.0.alpha.2 - 2017/09/07
 
 * [FEATURE] Add `DocRank.compare`

data/doc_rank.gemspec

@@ -13,6 +13,8 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/S1v4/doc_rank"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = '>= 2.4'
+
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
@@ -20,13 +22,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "highscore", "~> 1.2.1"
+  spec.add_runtime_dependency "yomu", "~> 0.2.4"
   spec.add_development_dependency "yard", "~> 0.9.9"
-  spec.add_development_dependency "highscore", "~> 1.2.1"
-  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

@@ -1,17 +1,6 @@
 require "doc_rank/version"
-require "doc_rank/document"
+require "doc_rank/ranker"
 
 # A gem to rank document similarities.
 module DocRank
-  # @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

@@ -4,21 +4,23 @@ 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.
+  # name, text, and weighted_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
+    # [Hash] a collection of keywords mapped to their weight.
+    attr_reader :weighted_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
+      @weighted_keywords = Highscore::Content.new(@text).keywords.map do |kw|
+        [kw.text, kw.weight]
+      end.to_h
     end
   end
 end

data/lib/doc_rank/ranker.rb

@@ -0,0 +1,54 @@
+require "doc_rank/document"
+
+# A gem to rank document similarities.
+module DocRank
+  # Ranker ranks documents by keywords and stores them in: scores and weighted_scores.
+  class Ranker
+
+    # [DocRank::Document] the base document.
+    attr_reader :base_doc
+    # [Array<DocRank::Document>] the target documents.
+    attr_reader :target_docs
+
+    # @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 initialize(base, targets)
+      @base_doc = DocRank::Document.new base
+      @base_kws = @base_doc.weighted_keywords
+      @target_docs = Array(targets).map {|target| DocRank::Document.new target }
+    end
+
+    # Rank the target documents based on any keyword matches with the base
+    #   document regardless of weight.
+    # @return [Hash] a hash of document names mapped to their matches.
+    def scores
+      @score ||= rank match_keywords
+    end
+
+    # Rank the target documents based on any keyword matches with the base
+    #   document by summing the weights of any match.
+    # @return [Hash] a hash of document names mapped to their scores.
+    def weighted_scores
+      @weighted_scores ||= rank match_keywords(weighted: true)
+    end
+
+  private
+
+    def match_keywords(options = {})
+      @target_docs.map do |target|
+        target_kws = target.weighted_keywords
+        matches = @base_kws.keys & target_kws.keys
+        score = options[:weighted] ? sum_weights(matches, target_kws) : matches.count
+        [target.name, score]
+      end
+    end
+
+    def sum_weights(matches, target)
+      matches.sum {|match| @base_kws[match] + target[match]}
+    end
+
+    def rank(docs)
+      docs.sort_by{|doc| doc[1]}.to_h
+    end
+  end
+end

data/lib/doc_rank/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doc_rank
 version: !ruby/object:Gem::Version
-  version: 0.0.0.alpha.2
+  version: 0.0.0.alpha.3
 platform: ruby
 authors:
 - s1v4
@@ -9,50 +9,50 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-10 00:00:00.000000000 Z
+date: 2017-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: highscore
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.9
-  type: :development
+        version: 1.2.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.9
+        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
-  type: :development
+        version: 0.2.4
+  type: :runtime
   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: yomu
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.9.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.9.9
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,20 +109,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +144,7 @@ files:
 - doc_rank.gemspec
 - lib/doc_rank.rb
 - lib/doc_rank/document.rb
+- lib/doc_rank/ranker.rb
 - lib/doc_rank/version.rb
 homepage: https://github.com/S1v4/doc_rank
 licenses:
@@ -171,7 +158,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"