frekwenza 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe93d2259013d43219aac982560c795d7e698a03
+  data.tar.gz: 833373b3981ad562cb81ea3372d6f447c0a9d2bc
+SHA512:
+  metadata.gz: aaef936370715683e87b369fc7f578cc9160be2a694fdcf7cd61b2d8a0f6eed1232adc4b933de5d1c7d68c91674ac792b8a80fde8c45941500041d971e0f969e
+  data.tar.gz: e29aa5916853ac534800acd05e64261155b682f420b20e483e64ddc45bc4e6372571adaa19a8850fd768def67746bf4860f5fca44e038c75f62076ebe23c1c61

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+*.swp

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 mathieuripert
+
+MIT License
+
+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,56 @@
+# Frekwenza
+
+This gem is based on [Mathieu Ripert](https://github.com/mathieuripert)'s work, [ruby-tf-idf](https://github.com/mathieuripert/ruby-tf-idf). Some changes are made in the gem, aside from the project structure.
+
+## Usage
+
+Mostly similar with ruby-tf-idf, here's an example right from ruby-tf-idf's readme only with the "RubyTfIdf" part replaced with "Frekwenza".
+
+```
+require 'frekwenza'
+
+corpus = [
+  'A big enough hammer can usually fix anything',
+  'A bird in the hand is a big mistake .',
+  'A bird in the hand is better than one overhead!',
+  'A career is a job that takes about 20 more hours a week.',
+  'A clean desk is a sign of a cluttered desk drawer.',
+  'A cynic smells flowers and looks for the casket.'
+]
+
+limit = 3 #restrict to the top 3 relevant words per document
+
+t = Frekwenza::TfIdf.new corpus, limit
+t.tf_idf
+```
+
+The main difference lies in the stop words. Frekwenza doesn't include hard coded stop words as ruby-tf-idf.  To use stop words in Frekwenza, add the path to the file containing the stop words as the third parameter.
+
+```
+require 'frekwenza'
+
+corpus = [
+  'A big enough hammer can usually fix anything',
+  'A bird in the hand is a big mistake .',
+  'A bird in the hand is better than one overhead!',
+  'A career is a job that takes about 20 more hours a week.',
+  'A clean desk is a sign of a cluttered desk drawer.',
+  'A cynic smells flowers and looks for the casket.'
+]
+
+limit = 3 #restrict to the top 3 relevant words per document
+stop_words = "stop_words.txt"
+
+t = Frekwenza::TfIdf.new corpus, limit, stop_words
+t.tf_idf
+```
+
+The following is an example output of Frekwenza (the format is exactly the same as ruby-tf-idf's).
+
+```
+ [ {"anything"=>0.7781512503836436, "fix"=>0.7781512503836436, "enough"=>0.7781512503836436}, {"mistake"=>0.7781512503836436, "bird"=>0.47712125471966244, "in"=>0.47712125471966244}, {"overhead!"=>0.7781512503836436, "better"=>0.7781512503836436, "one"=>0.7781512503836436}, {"week"=>0.7781512503836436, "career"=>0.7781512503836436, "hours"=>0.7781512503836436}, {"desk"=>1.5563025007672873, "drawer"=>0.7781512503836436, "clean"=>0.7781512503836436}, {"casket"=>0.7781512503836436, "cynic"=>0.7781512503836436, "smells"=>0.7781512503836436}, ... ]
+```
+
+## Special Thanks
+
+[Mathieu Ripert](https://github.com/mathieuripert), author or [ruby-tf-idf](https://github.com/mathieuripert/ruby-tf-idf) gem.

data/frekwenza.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'frekwenza/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "frekwenza"
+  gem.version       = Frekwenza::VERSION
+  gem.authors       = ["Mathieu Ripert", "Edwin Tunggawan"]
+  gem.email         = ["mathieu.ripert@gmail.com", "vcc.edwint@gmail.com"]
+  gem.description   = %q{Term Frequency - Inverse Document Frequency }
+  gem.summary       = %q{Calculating TF-IDF, based on Mathieu Ripert's ruby-tf-idf gem}
+  gem.homepage      = "https://github.com/sdsdkkk/frekwenza"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib", "lib/frekwenza"]
+end

data/lib/frekwenza/stop_words.rb

@@ -0,0 +1,23 @@
+module Frekwenza
+  class StopWords
+    attr_reader :stop_words
+
+    def initialize(file)
+      string = read(file)
+      build_list(string)
+    end
+
+    private
+    def read(file)
+      string = ""
+      File.open(file, "r") do |f|
+        string = f.read
+      end
+      string
+    end
+
+    def build_list(string)
+      @stop_words = string.downcase.gsub(/[^a-z0-9]/, ' ').split(' ').uniq
+    end
+  end
+end

data/lib/frekwenza/tf_idf.rb

@@ -0,0 +1,56 @@
+module Frekwenza
+  class TfIdf
+    attr_reader :tf, :idf, :tf_idf
+
+    def initialize(docs, limit, stop_words_file=nil)
+      @docs = split_docs(docs)
+      @tf = []
+      @idf = {}
+      @tf_idf = []
+      @docs_size = @docs.size
+      calculate_tf_and_idf
+      calculate_tf_idf(limit, stop_words_file)
+    end
+
+    private
+    def split_docs(docs)
+      words = []
+      docs.each do |d|
+        words << d.downcase.gsub(/[^a-z0-9]/, ' ').split(' ')
+      end
+      words
+    end
+
+    def calculate_tf_and_idf
+      @docs.each do |words|
+        terms_freq = words.inject(Hash.new(0)){|h, e| h[e]+=1; h}
+        @tf.push(terms_freq)
+        distinct_words = words.uniq
+        distinct_words.each do |w|
+          if @idf.has_key?(w)
+            y = @docs_size / ( 10**(@idf[w]) )
+            y += 1
+            @idf[w] = Math.log10(@docs_size / y)
+          else
+            @idf[w] = Math.log10(@docs_size)
+          end
+        end
+      end
+    end
+
+    def calculate_tf_idf(limit, stop_words_file)
+      @tf.each do |tf_freq|
+        tfidf = Hash.new(0)
+        tf_freq.each do |k, v|
+          tfidf[k] = @idf[k] * v
+        end
+        if stop_words_file
+          sw = StopWords.new(stop_words_file)
+          tfidf.reject!{|k| sw.stop_words.include?(k)}
+        end
+        tfidf = Hash[tfidf.sort_by{|k, v| -v}[0..limit-1]]
+        @tf_idf.push(tfidf)
+      end
+    end
+  end
+end

data/lib/frekwenza/version.rb

@@ -0,0 +1,3 @@
+module Frekwenza
+  VERSION = "0.0.1"
+end

data/lib/frekwenza.rb

@@ -0,0 +1,3 @@
+require "frekwenza/version"
+require "frekwenza/stop_words"
+require "frekwenza/tf_idf"

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: frekwenza
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mathieu Ripert
+- Edwin Tunggawan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-25 00:00:00.000000000 Z
+dependencies: []
+description: 'Term Frequency - Inverse Document Frequency '
+email:
+- mathieu.ripert@gmail.com
+- vcc.edwint@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE.txt
+- README.md
+- frekwenza.gemspec
+- lib/frekwenza.rb
+- lib/frekwenza/stop_words.rb
+- lib/frekwenza/tf_idf.rb
+- lib/frekwenza/version.rb
+homepage: https://github.com/sdsdkkk/frekwenza
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib/frekwenza
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Calculating TF-IDF, based on Mathieu Ripert's ruby-tf-idf gem
+test_files: []