filtra 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccc63236a847c7b4c2347971bfe34c9f1d626ffd
-  data.tar.gz: 07314242e0e61a2c2ca4864595c19ff465eecfe9
+  metadata.gz: 4f9741d13beea3287c5f17a9a2813f3e0551ab8e
+  data.tar.gz: 3cc0f425d04f04e95ad829ec7f40d7a8fb42c01a
 SHA512:
-  metadata.gz: 028302d2483b95f9d1cdd5ef5dcd1b6473c3e6396df55782345bc2c69573973436280a20888cc0afb224d32229b4515816c898b9b6850ae215ab3bf64a29e4fd
-  data.tar.gz: 056aa38ab2ad934be534801f89b02866c9352a93a66237f8b759f8662fabfd81ae24da1ff1b8198ff9c074d86d8fda7b01b8a9cf3c7f7d2a3c3ed12497bf7c6b
+  metadata.gz: 7f84c2f04f98e8625e06c5db0efd501b184cb434883b137db786e5025475b311b7585df3d35128143baf18d90e4e181ed2790a9b02c99c48a3942cc9ac5f3d7d
+  data.tar.gz: aef5a827c6f01331f88f3e1c55baaae101d144683868161737d0f047960a44dbbb62da2ca33bff41edc5562827d5954cda5d1c7c679dec20a41b8d74176cd1b7

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Filtra Changelog
+
+## [0.0.2] - 2015-07-26
+
+### Added
+- Changelog

data/README.md

@@ -18,3 +18,62 @@ $ gem install filtra
 
 ## Usage
 
+The simplest usage is with default options:
+
+```ruby
+filtro = Filtra.new()
+words = %w(Running fishes Among the Coast line coast)
+result = filtro.call(words)
+puts result.inspect
+#=> ["running", "fishes", "among", "the", "coast", "line"]
+```
+
+With default options, the case was changed and the word **coast** appears only once. Not really exciting, uh?.
+
+If, for some reason you want to keep the casing, then this happens:
+
+```ruby
+filtro = Filtra.new(keep_case: true)
+words = %w(Running fishes Among the Coast line coast)
+result = filtro.call(words)
+puts result.inspect
+#=> ["Running", "fishes", "Among", "the", "Coast", "line", "coast"]
+```
+
+Now you see the word **coast** appears two times. That's because the casing.
+
+Now, let's add some stemming to the mix.
+
+```ruby
+filtro = Filtra.new(stem: true)
+words = %w(Running run fishes Among the Coast line coast)
+result = filtro.call(words)
+puts result.inspect
+#=> ["run", "fish", "among", "the", "coast", "line"]
+```
+
+Stemming makes this a bit more interesting, thinking in indexing this later, right?
+
+Now, let's make this *really* fun. Let's add a list of stopwords.
+
+```ruby
+filtro = Filtra.new(stopwords: Filtra.stopwords )
+words = %w(this can be a nice idea that might not work)
+result = filtro.call(words)
+puts result.inspect
+#=> ["can", "nice", "idea", "might", "work"]
+```
+
+Bundled with Filtra there's a list of common stopwords, but you can just pass your own.
+
+```ruby
+filtro = Filtra.new(stopwords: %w(this that those there))
+words = %w(this can be a nice idea that might not work)
+result = filtro.call(words)
+puts result.inspect
+#=> ["can", "be", "a", "nice", "idea", "might", "not", "work"]
+```
+
+
+And that's pretty much it. The code is simple, go take a look. And drop a line to julian@porta.sh if you have something to say.
+

data/filtra.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name              = "filtra"
-  s.version           = "0.0.1"
+  s.version           = "0.0.2"
   s.summary           = "Filtra filters an array of tokens to be indexed"
   s.description       = "Filtra filters an array of tokens or words so they can be indexed by Busca, the simple redis search"
   s.authors           = ["Julián Porta"]

data/lib/Filtra/text.rb

@@ -6,13 +6,12 @@ class Filtra
             out = []
             keep_case = opts[:keep_case] || false
             stem = opts[:stem] || false
-            # keep case
-            # stemm
+            stopwords = opts[:stopwords] || []
             words.each do |word|
                 word.downcase! unless keep_case                
                 out.push( stem ? word.stem : word)
             end
-            out.uniq
+            out.uniq - stopwords
         end
     end
 end

data/lib/filtra.rb

@@ -2,8 +2,6 @@ class Filtra
     
     Dir[File.dirname(__FILE__) + '/Filtra/*.rb'].each {|file| require file }
 
-    attr_reader :filtro
-
     def initialize(filtro = Filtra::Text, opts = {})
         if filtro.respond_to?(:call)
             @filtro = filtro
@@ -18,5 +16,8 @@ class Filtra
         @filtro.call(words, @opts)
     end
 
+    def self.stopwords
+        %w(a about above after again against all am an and any are aren't as at be because been before being below between both but by can't cannot could couldn't did didn't do does doesn't doing don't down during each few for from further had hadn't has hasn't have haven't having he he'd he'll he's her here here's hers herself him himself his how how's i i'd i'll i'm i've if in into is isn't it it's its itself let's me more most mustn't my myself no nor not of off on once only or other ought our ours ourselves out over own same shan't she she'd she'll she's should shouldn't so some such than that that's the their theirs them themselves then there there's these they they'd they'll they're they've this those through to too under until up very was wasn't we we'd we'll we're we've were weren't what what's when when's where where's which while who who's whom why why's with won't would wouldn't you you'd you'll you're you've your yours yourself yourselves)
+    end
 
 end

data/tests/filtra_test.rb

@@ -23,3 +23,19 @@ test "Filtra::Text should filter and downcase some words" do
     result = filtro.call(words)
     assert_equal result, %w(Running fishes Among the Coast line coast)
 end
+
+
+test "stopwords should stop words from being indexed" do
+    filtro = Filtra.new(stopwords: %w(this that those there))
+    words = %w(this can be a nice idea that might not work)
+    result = filtro.call(words)
+    assert_equal result, %w(can be a nice idea might not work)
+end
+
+test "stopwords from Filtra.stopwords" do
+    filtro = Filtra.new(stopwords: Filtra.stopwords )
+    words = %w(this can be a nice idea that might not work)
+    result = filtro.call(words)
+    assert_equal result, %w(can nice idea might work)
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filtra
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Julián Porta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest
@@ -47,8 +47,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - LICENSE
 - README.md
+- filtra-0.0.1.gem
 - filtra.gemspec
 - lib/Filtra/text.rb
 - lib/filtra.rb