idftags 0.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec135ce8c1deaea30ed837e3c237499732ef6a95
+  data.tar.gz: 45d5083727cd8c1afc4331e4f159a5acc95e6ab3
+SHA512:
+  metadata.gz: 92f0f020b18a19571fed563bfd8748907f936566ec79a54a92b5584782a062b2c8922ac3a8b92caae03393ce16ace8e1ee3cae4b270b22d0d88fe18a316f8a77
+  data.tar.gz: c3d593a18adee689b103944842eb2fff1a8b01253266abf913e6ac844452cca5366ed4a7f7e6408daef42f7c2a0fe27c232111161bda1af4cf6eadd0148a31c6

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in idftags.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Stefan Neidig
+
+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,116 @@
+# IDFTags
+
+IDFTags extracts tags (or significant words) from a string using the inverse document frequency algorithm. You can find more about this [here](https://en.wikipedia.org/wiki/Tf%E2%80%93idf#Definition)
+
+In summary the algorithm considers a document, which is a string a and computes the weighted frequency within that document. This tells us how common the word is. In fact the more interesting value is the inverse document frequency. For this we consider a list of documents and calculate the weighted frequency of a term in all that documents. Multiply this values for the term and you have the tdidf value. Based on this value you can rank the terms of a document and pick the first n values, which are your tags.
+
+### What is this?
+
+This is a library to generate tags from a document based on other documents to calculate the meaning of a word. So you have to provide a list of documents to get proper results. This applies very well to titles or content of form posts (like for example stackoverflow). This gem is not meant to extract tags using self learning algorithms, which are solely based on the single document itself. Keep that in mind. There will be an example to showcase the gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'IDFTags'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install IDFTags
+
+## Usage
+### Basic 
+IDFtags needs a document and a list of documents to calculate both the document frequency and inverse document freuency of terms. So let be the document and documents respectively
+
+```ruby
+document = 'This is a document'
+documents = ['A sample sentence', 'Another sample sentence']
+```
+
+Then you can retrieve the three most prominent tags of the document by 
+
+```ruby
+require 'idftags'
+
+idftags = IDFTags::IDFTags.new
+tags = idftags.tags document, documents, 3
+```
+
+### Custom weights
+You can also use custom weights to refine the output. This is especially useful when dealing with longer documents.
+
+```ruby
+require 'idftags'
+
+idftags = IDFTags::IDFTags.new :weight_log_norm, :weight_probabilistic_inverse_frequency
+tags = idftags.tags 'document', ['document1', 'document2']
+```
+Currently available weights:
+
+| document frequency | inverse document frequency             |
+|--------------------|----------------------------------------|
+| weight_binary      | weight_unary                           |
+| weight_raw         | weight_inverse_frequency               |
+| weight_log_norm    | weight_inverse_frequency_smooth        |
+| weight_double_norm | weight_probabilistic_inverse_frequency |
+
+Take a look at https://en.wikipedia.org/wiki/Tf%E2%80%93idf#Term_frequency_2 for a more in depth explanation and recommendation of what weights you should choose.
+
+### Bad words
+Usually you want to exclude certain words from the parsing process since they do not carry any information whatsoever. An exmaple of such words are 'a', 'and', 'I', 'to' and so on. You can exclude them by providing a so called bad word lexicon. Currently we support bad word lexica by locale.
+
+```ruby
+require 'idftags'
+
+lexicon = IDFTags::BadWordLexicon.new :en, ['a', 'to']
+lexicon.add('I')
+lexicon.add_all(['my', 'me'])
+
+idftags = IDFTags::IDFTags.new 
+idftags.register_bad_word_lexicon lexicon
+
+idftags.tags 'I want to see me', [....] # -> ['see', 'want']
+```
+You can also create bad word lexica from yaml files.
+```ruby
+require 'idftags'
+
+lexicon = IDFTags::BadWordLexicon.from_yml 'path/to/file.yml'
+```
+whereas a yml file should look like this
+```yaml
+en:
+    common:
+        yes: 'yes'
+        no: 'no'
+    test:
+        nested:
+            cool: 'cool'
+        nested2:
+            nice: 'nice'
+```
+To unregister a bad word lexicon simply do 
+```ruby
+idftags.unregister_bad_word_lexicon :en
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/IDFTags. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "idftags"
+
+# 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

data/bin/setup

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

data/idftags.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'IDFTags/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "idftags"
+  spec.version       = IDFTags::VERSION
+  spec.authors       = ["Stefan Neidig"]
+  spec.email         = ["stefan@rpdev.net"]
+
+  spec.summary       = %q{IDFTags generates tags based on text and documents.}
+  spec.description   = %q{IDFTags generates tags based on text and documents. It uses inverse document frequency to calculate the meaning of words.}
+  spec.homepage      = "https://github.com/dasheck0/idftags"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/IDFTags/bad_word_lexicon.rb

@@ -0,0 +1,50 @@
+require 'yaml'
+
+module IDFTags
+  class BadWordLexicon
+
+    attr_accessor :locale
+    attr_reader :bad_words
+
+    def initialize locale, bad_words = []
+      @locale = locale
+      @bad_words = bad_words
+    end
+
+    def add bad_word
+      @bad_words << bad_word if bad_word
+      @bad_words.uniq!
+    end
+
+    def add_all bad_words
+      @bad_words += bad_words if bad_words
+      @bad_words.uniq!
+    end
+
+    def self.from_yml filename
+      if File.exist? filename
+        content = YAML.load_file(filename)
+
+        result = BadWordLexicon.new content.keys.first.to_sym
+        result.traverse(content) { |node|
+          result.add node
+        }
+
+        result
+      end
+    end
+
+    def traverse hash, &blk
+      case hash
+        when Hash
+          hash.each { |_, v| traverse(v, &blk) }
+        when Array
+          hash.each { |v| traverse(v, &blk) }
+        else
+          blk.call(hash)
+      end
+
+    end
+
+  end
+end

data/lib/IDFTags/inverse_document_frequency.rb

@@ -0,0 +1,51 @@
+require_relative './utilities'
+
+module IDFTags
+  class InverseDocumentFrequency
+
+    attr_accessor :weight
+
+    def initialize weight = :weight_inverse_frequency
+      raise Exception("Weight #{weight} is not defined. Available weights are #{weights}") unless weights.include? weight
+      @weight = weight
+    end
+
+    def inverse_document_frequency term, documents
+      self.send(weight, term, documents)
+    end
+
+    private
+
+    def weights
+      private_methods.select { |method|
+        method.to_s.split('_').first == 'weight'
+      }.map(&:to_sym)
+    end
+
+    def weight_unary term, documents
+      1
+    end
+
+    def weight_inverse_frequency term, documents
+      return 0 if term.nil? or documents.nil? or documents.empty?
+      Math.log(documents.length.to_f / (1 +Utilities.document_frequency(term, documents)))
+    end
+
+    def weight_inverse_frequency_smooth term, documents
+      return 0 if term.nil? or documents.nil? or documents.empty?
+      Math.log((1+documents.length.to_f) / (1+Utilities.document_frequency(term, documents)))
+    end
+
+    def weight_inverse_frequency_max term, documents
+
+    end
+
+    def weight_probabilistic_inverse_frequency term, documents
+      return 0 if term.nil? or documents.nil? or documents.empty?
+      nt = Utilities.document_frequency(term, documents)
+      Math.log((documents.length.to_f - nt) / (1 + nt))
+
+    end
+
+  end
+end

data/lib/IDFTags/term_frequency.rb

@@ -0,0 +1,43 @@
+module IDFTags
+  class TermFrequency
+
+    attr_accessor :weight
+
+    def initialize weight = :weight_raw
+      raise Exception("Weight #{weight} is not defined. Available weights are #{weights}") unless weights.include? weight
+      @weight = weight
+    end
+
+    def term_frequency term, document
+      self.send(weight, term, document)
+    end
+
+    private
+
+    def weights
+      private_methods.select { |method|
+        method.to_s.split('_').first == 'weight'
+      }.map(&:to_sym)
+    end
+
+    def weight_binary term, document
+      return 0 if document.nil? or term.nil?
+      document.include?(term) ? 1 : 0
+    end
+
+    def weight_raw term, document
+      Utilities.raw_frequency term, document
+    end
+
+    def weight_log_norm term, document
+      return 0 if document.nil? or term.nil?
+      Math.log(1 + weight_raw(term, document))
+    end
+
+    def weight_double_norm term, document, k = 0.5
+      return 0 if document.nil? or term.nil?
+      k + (1-k) * weight_raw(term, document).to_f / Utilities.max_frequency(document)
+    end
+
+  end
+end

data/lib/IDFTags/utilities.rb

@@ -0,0 +1,22 @@
+module IDFTags
+  class Utilities
+
+    def self.max_frequency document
+      return 0 if document.nil? or document.empty?
+      document.split.map { |term| raw_frequency(term, document) }.max
+    end
+
+    def self.raw_frequency term, document
+      return 0 if term.nil? or document.nil?
+      document.split.map(&:strip).select { |t| t == term }.count
+    end
+
+    def self.document_frequency term, documents
+      return 0 if term.nil? or documents.nil?
+      documents.select { |document|
+        raw_frequency(term, document) > 0
+      }.count
+    end
+
+  end
+end

data/lib/IDFTags/version.rb

@@ -0,0 +1,3 @@
+module IDFTags
+  VERSION = "0.2.2"
+end

data/lib/idftags.rb

@@ -0,0 +1,54 @@
+require 'IDFTags/version'
+require 'IDFTags/inverse_document_frequency'
+require 'IDFTags/term_frequency'
+require 'IDFTags/bad_word_lexicon'
+
+module IDFTags
+
+  class IDFTags
+
+    attr_accessor :tf, :idf
+
+    def initialize td_weight = :weight_raw, idf_weight = :weight_inverse_frequency
+      @tf = TermFrequency.new td_weight
+      @idf = InverseDocumentFrequency.new idf_weight
+      @bad_word_lexica = []
+    end
+
+    def tags document, documents, tag_count = 5
+      extract_terms(document).map { |term|
+        [term, tfidf(term, document, documents)]
+      }.sort_by { |v| v.last}.reverse[0..(tag_count-1)].map(&:first)
+    end
+
+    def register_bad_word_lexicon bad_word_lexicon
+      lexicon = @bad_word_lexica.select { |l| l.locale == bad_word_lexicon.locale }.first
+
+      if lexicon
+        lexicon.add_all bad_word_lexicon.bad_words
+      else
+        @bad_word_lexica << bad_word_lexicon
+      end
+    end
+
+    def unregister_bad_word_lexicon locale
+      @bad_word_lexica.delete_if { |l| l.locale == locale }
+    end
+
+    private
+
+    def extract_terms document
+      prepare_document(document).split.uniq - @bad_word_lexica.map{ |l| l.nil? ? [] : l.bad_words.map(&:downcase) }.flatten.uniq
+    end
+
+    def prepare_document document
+      document.downcase.gsub(/(\,|\.)/, '') if document
+    end
+
+    def tfidf term, document, documents
+      @idf.inverse_document_frequency(term, documents) * @tf.term_frequency(term, document)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: idftags
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Stefan Neidig
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-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.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: rspec
+  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'
+description: IDFTags generates tags based on text and documents. It uses inverse document
+  frequency to calculate the meaning of words.
+email:
+- stefan@rpdev.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- idftags.gemspec
+- lib/IDFTags/bad_word_lexicon.rb
+- lib/IDFTags/inverse_document_frequency.rb
+- lib/IDFTags/term_frequency.rb
+- lib/IDFTags/utilities.rb
+- lib/IDFTags/version.rb
+- lib/idftags.rb
+homepage: https://github.com/dasheck0/idftags
+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.4.6
+signing_key: 
+specification_version: 4
+summary: IDFTags generates tags based on text and documents.
+test_files: []