dookie-keywords_maker 0.2

data/History.txt

@@ -0,0 +1,12 @@
+== 0.2 2009-01-05
+
+* Added limit to keywords array
+* Refatoring
+
+== 0.1 2009-01-05
+
+* The major features are working
+
+== 0.0.0 2009-01-04
+
+* Preparing the GEM Structure

data/README.rdoc

@@ -0,0 +1,59 @@
+= Keywords Maker
+
+== Description
+
+A gem which returns the keywords related with your text. It's very relevant for webpages with articles, news, posts, and so on.
+
+== Features
+
+* Extends the String class. It creates a keywords method that returns 10 keywords.
+
+== Synopsis
+
+  require 'rubygems'
+  require 'keywords_maker'
+  
+  text = <<-TEXT
+    O bubble sort, ou ordenação por flutuação (literalmente "por bolha"), é um algoritmo de ordenação dos mais simples. A ideia é percorrer o vector diversas vezes, a cada passagem fazendo flutuar para o topo o menor elemento da sequência. Essa movimentação lembra a forma como as bolhas em um tanque de água procuram seu próprio nível, e disso vem o nome do algoritmo.
+
+    No melhor caso, o algoritmo executa n2 / 2 operações relevantes, onde n representa o número de elementos do vector. No pior caso, são feitas 2n2 operações. No caso médio, são feitas 5n2 / 2 operações. A complexidade desse algoritmo é de Ordem quadrática. Por isso, ele não é recomendado para programas que precisem de velocidade e operem com quantidade elevada de dados.
+
+    O algoritmo pode ser descrito em pseudo-código como segue abaixo. V é um VECTOR de elementos que podem ser comparados e n é o tamanho desse vector.
+  TEXT
+  
+  text.keywords # => ["algoritmo", "caso", "elementos", "feitas", "ideia", "nivel", "operacoes", "ordenacao", "sort", "vector"]
+  
+  text.keywords(5) # => ["algoritmo", "caso", "feitas", "operacoes", "vector"]
+  
+  Bubble::KeywordsMaker::Blacklist.words = %w(caso feitas ideia nao nivel topo abaixo diversas n2)
+  text.keywords # => ["algoritmo", "bolha", "elementos", "operacoes", "ordenacao", "passagem", "simples", "sort", "vector", "velocidade"]
+
+== Install
+
+  sudo gem sources -a http://gems.github.com
+  sudo gem install dookie-keywords_maker
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 Bruno Azisaka Maciel
+
+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/lib/bubble/keywords_maker/blacklist.rb

@@ -0,0 +1,47 @@
+require 'singleton'
+
+module Bubble
+  module KeywordsMaker
+    class Blacklist
+      include Singleton
+      
+      attr_accessor :words, :locate
+      
+      def self.words=(array)
+        instance.words = array
+      end
+      
+      def self.words
+        black = %w([a-z] [0-9]+)
+
+        black << Bubble::KeywordsMaker::Blacklist.instance.locate::Blacklist
+        
+        black << Bubble::KeywordsMaker::Blacklist.instance.words
+        black.flatten
+      end
+      
+      def self.regexp
+        %r(^(#{words.join('|')})$)
+      end
+      
+      def self.locate=(locate)
+        instance.locate = locate
+      end
+      
+      def initialize
+        self.words = []
+        self.locate = Bubble::KeywordsMaker::Default::PtBr
+      end
+    end
+    
+    module Default
+      module PtBr
+        Blacklist = %w(ou de da do desse na no por para que era um uma uns umas como se ser sao em essa com pode)
+      end
+      
+      module EnUs
+        Blacklist = %w(is are were was did do where what of the it in to and)
+      end
+    end
+  end
+end

data/lib/bubble/keywords_maker/counter.rb

@@ -0,0 +1,43 @@
+module Bubble
+  module KeywordsMaker
+    class Counter
+      def initialize(text)
+        @text = strip(text).downcase
+      end
+      
+      def words
+        @words = @text.split(/[\s+\.;\,\?!\\\/\(\)\"\']/)
+        @words.delete('')
+        @words
+      end
+      
+      def counted
+        results = {}
+        words.each { |word| results[word] += 1 rescue results[word] = 1 }
+        results
+      end
+      
+      def keywords
+        sanitized
+      end
+      
+      protected
+      def sanitized
+        sorted.delete_if { |v| v =~ Blacklist::regexp }
+      end
+      
+      def sorted
+        counted.sort_by { |k, v| v }.reverse.map { |k, v| k }
+      end
+      
+      def strip(text)
+        require 'unicode'
+        
+        Unicode::normalize_KD(text).unpack('U*').select { |cp|
+          cp < 0x300 || cp > 0x036F
+        }.pack('U*')
+      end
+    end
+  end
+end
+

data/lib/bubble/keywords_maker/keywords.rb

@@ -0,0 +1,15 @@
+module Bubble
+  module KeywordsMaker
+    class Keywords
+      attr_accessor :original_text
+      
+      def initialize(text)
+        self.original_text = text
+      end
+      
+      def keywords(limit = 10)
+        Counter.new(original_text).keywords[0...limit].sort
+      end
+    end
+  end
+end

data/lib/keywords_maker.rb

@@ -0,0 +1,18 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Bubble
+  module KeywordsMaker
+    VERSION = '0.2'
+  end
+end
+
+require 'bubble/keywords_maker/blacklist'
+require 'bubble/keywords_maker/counter'
+require 'bubble/keywords_maker/keywords'
+
+class String  
+  def keywords
+    @keywords ||= Bubble::KeywordsMaker::Keywords.new(self).keywords
+  end
+end

data/test/test_blacklist.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestBlacklist < Test::Unit::TestCase
+  include Bubble::KeywordsMaker
+  include Bubble::KeywordsMaker::Default
+  
+  context "A Blacklist instance" do
+    should "receive a array as argument" do
+      Blacklist.words = %w(testing now)
+    end
+    
+    should "return the array with the words" do
+      assert(Blacklist.words.include?('testing'))
+      assert(Blacklist.words.include?('now'))
+    end
+    
+    should "return the words as a regexp" do
+      assert_kind_of(Regexp, Blacklist.regexp)
+      
+      assert(Blacklist.regexp =~ 'testing')
+      assert(Blacklist.regexp =~ 'now')
+    end
+    
+    should "be PtBr" do
+      Blacklist.locate = PtBr
+      
+      assert_equal(PtBr, Blacklist.instance.locate)
+    end
+    
+    should "be EnUs" do
+      Blacklist.locate = EnUs
+      
+      assert_equal(EnUs, Blacklist.instance.locate)
+    end
+  end
+  
+end

data/test/test_counter.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestCounter < Test::Unit::TestCase
+  include Bubble::KeywordsMaker
+  
+  context "A KeywordsMaker object from a text" do
+    setup do
+      @text = File.open(File.join(File.dirname(__FILE__), '/resources', '/bubble-ptbr.txt')).readlines.join('\n')
+      @counter = Counter.new(@text)
+    end
+
+    should "count the words frequencies" do
+      assert_kind_of(Hash, @counter.counted)
+      assert_equal(5, @counter.counted['algoritmo'])
+      assert_equal(2, @counter.counted['ordenacao'])
+    end
+    
+    should "return all keywords" do
+      assert_kind_of(Array, @counter.keywords)
+      assert_equal(74, @counter.keywords.size)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'stringio'
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require File.dirname(__FILE__) + '/../lib/keywords_maker'

data/test/test_keywords.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestCounter < Test::Unit::TestCase
+  include Bubble::KeywordsMaker
+  
+  context "A KeywordsMaker object from a text" do
+    setup do
+      @text = File.open(File.join(File.dirname(__FILE__), '/resources', '/bubble-ptbr.txt')).readlines.join('\n')
+      @km = Keywords.new(@text)
+      Blacklist.words = %w()
+    end
+    
+    should "return the original text" do
+      assert_equal(@text, @km.original_text)
+    end
+    
+    should "return the keywords" do
+      assert_kind_of(Array, @km.keywords)
+      assert_equal(%w(algoritmo caso elementos feitas ideia nivel operacoes ordenacao sort vector), @km.keywords)
+    end
+    
+    should "return the keywords with blacklist" do
+      Blacklist.words = %w(caso feitas ideia nao nivel topo abaixo diversas n2)
+      assert_equal(%w(algoritmo bolha elementos operacoes ordenacao passagem simples sort vector velocidade), @km.keywords)
+    end
+    
+    should "return 5 keywords" do
+      assert_equal(5, @km.keywords(5).size)
+      assert_equal(%w(algoritmo caso feitas operacoes vector), @km.keywords(5))
+    end
+    
+    should "return 5 keywords with blacklist" do
+      Blacklist.words = %w(caso feitas nivel topo abaixo diversas n2)
+      assert_equal(5, @km.keywords(5).size)
+      assert_equal(%w(algoritmo elementos operacoes ordenacao vector), @km.keywords(5))
+    end
+  end
+  
+  context "When the locate is EnUs" do
+    setup do
+      Blacklist.locate = Default::EnUs
+      @text = File.open(File.join(File.dirname(__FILE__), '/resources', '/bubble-enus.txt')).readlines.join('\n')
+      @km = Keywords.new(@text)
+    end
+
+    should "return the keywords" do
+      assert_equal(%w(algorithm average bubble complexity list sort sorted sorting through worst-case), @km.keywords)
+    end
+  end
+  
+end

data/test/test_keywords_maker.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestKeywordsMaker < Test::Unit::TestCase
+  context "A big text" do
+    setup do
+      @text = File.open(File.join(File.dirname(__FILE__), '/resources', '/bubble-ptbr.txt')).readlines.join('\n')
+      Bubble::KeywordsMaker::Blacklist.locate = Bubble::KeywordsMaker::Default::PtBr
+    end
+
+    should "have these keywords" do
+      assert_equal(%w(algoritmo caso elementos feitas ideia nivel operacoes ordenacao sort vector), @text.keywords)
+    end
+    
+    should "return the keywords with blacklist" do
+      Bubble::KeywordsMaker::Blacklist.words = %w(caso feitas ideia nao nivel topo abaixo diversas n2)
+      
+      assert_equal(%w(algoritmo bolha elementos operacoes ordenacao passagem simples sort vector velocidade), @text.keywords)
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: dookie-keywords_maker
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Bruno Azisaka Maciel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-05 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: unicode
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.1"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: A gem which returns the keywords related with your text. It's very relevant for webpages with articles, news, posts, and so on.
+email: 
+- bruno@dookie.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.rdoc
+files: 
+- History.txt
+- README.rdoc
+- lib/keywords_maker.rb
+- lib/bubble/keywords_maker/keywords.rb
+- lib/bubble/keywords_maker/counter.rb
+- lib/bubble/keywords_maker/blacklist.rb
+- test/test_blacklist.rb
+- test/test_counter.rb
+- test/test_helper.rb
+- test/test_keywords.rb
+- test/test_keywords_maker.rb
+has_rdoc: true
+homepage: 
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: keywords_maker
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A gem which returns the keywords related with your text
+test_files: 
+- test/test_blacklist.rb
+- test/test_counter.rb
+- test/test_helper.rb
+- test/test_keywords.rb
+- test/test_keywords_maker.rb