document_similarity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 893721c03a2ab0df63e2162fd929c948993ad434
+  data.tar.gz: da6aafb771d0bd8f8b2652029f23a5d0d8fd4c48
+SHA512:
+  metadata.gz: e3bab9599ecfb6de011d796c51a7cdfa163ad21bc1e005460edbfd9dab6c6c780b42b62b2574b0e7b2acd1ee8e9e742e647bbf2a79ae440f638591d72e382205
+  data.tar.gz: '044906bab542739d945c3c39ed781ff611045949cd3e4b2fad0dba42bb10b4cf3f8283e5fc22b8c98f0ae1df050176543cc41ca2a0f28937991fdbf268f2e3da'

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    document_similarity (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  document_similarity!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Shintaro Morikawa
+
+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,51 @@
+# DocumentSimilarity
+
+Calculate cosine similarity between given 2 sentence strings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'document_similarity'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install document_similarity
+
+## Usage
+
+```ruby
+require 'document_similarity'
+
+DocumentSimilarity.similarity("AAA BBB CCC", "AAA BBB CCC")
+# => 1.0
+
+DocumentSimilarity.similarity("AAA BBB CCC", "AAA BBB DDD")
+# => 0.6666666666666666
+
+DocumentSimilarity.similarity("AAA BBB CCC", " DDD EEE FFF")
+# => 0.0
+
+DocumentSimilarity.similarity("AAA BBB CCC", "aaa bbb ccc")
+# => 1.0
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/morishin/document_similarity.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "document_similarity"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/document_similarity.gemspec

@@ -0,0 +1,22 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "document_similarity/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "document_similarity"
+  spec.version       = DocumentSimilarity::VERSION
+  spec.authors       = ["Shintaro Morikawa"]
+  spec.email         = ["sntr92@gmail.com"]
+  spec.summary       = "Calculate cosine similarity between given 2 sentence strings"
+  spec.homepage      = "https://github.com/morishin/document_similarity"
+  spec.license       = "MIT"
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/document_similarity.rb

@@ -0,0 +1,20 @@
+require 'matrix'
+require 'document_similarity/version'
+
+module DocumentSimilarity
+  def self.similarity(document, another_document)
+    document_words = document.downcase.split(' ')
+    another_document_words = another_document.downcase.split(' ')
+    all_words = (document_words + another_document_words).uniq
+    document_vector = self.document_vector(document_words, all_words)
+    another_document_vector = self.document_vector(another_document_words, all_words)
+    cosine_similarity = document_vector.inner_product(another_document_vector) / (document_vector.norm * another_document_vector.norm)
+    cosine_similarity
+  end
+
+  private
+
+  def self.document_vector(document_words, all_words)
+    Vector.elements(all_words.map { |word| document_words.select { |document_word| document_word == word }.size / document_words.size.to_f })
+  end
+end

data/lib/document_similarity/version.rb

@@ -0,0 +1,3 @@
+module DocumentSimilarity
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: document_similarity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shintaro Morikawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- sntr92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- document_similarity.gemspec
+- lib/document_similarity.rb
+- lib/document_similarity/version.rb
+homepage: https://github.com/morishin/document_similarity
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Calculate cosine similarity between given 2 sentence strings
+test_files: []