separa 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6a8d611823d678984ca8c293a069fbf6a202156
-  data.tar.gz: dfdbe90a9abeaf81a989c9653a82c0cf295cba71
+  metadata.gz: 3f1473a4f606c3fe324c23ef40d6415774476fef
+  data.tar.gz: 59f26263e9ab27476361ebe6723ed9bbdb1f1990
 SHA512:
-  metadata.gz: 9905516337c8682f76a845c093633686158a55056f7fc3a8742512b0a7a2443c1d335e2b03ca9fcf7210cb272408aab766cb68b16b11a578e7f5d87f1f34b47a
-  data.tar.gz: b5ac4c97b2fc0644548dc8ca0551007fdbbc9655507073ff0de6223c9655a155ead53cfd6f11a72a13c465b99815134d838ce6d0e56abf74e7f2a377fe99d69f
+  metadata.gz: 79710d6e1abe160fd512d4c8a2ce6176ddcdee2e401c1d2836b50a5d5df36a97d3f8599dabea7f2a4edc8e9ad336e8eff901e0d908b5bbcb77ac95242436cdb6
+  data.tar.gz: d5b64d73087a76e06f00159cb0a16dd90098fdfbb1121c816ce30c8bd31e52aa71912093486e10954e11c6ace7711aca782981bbef25da2f2a13bbc68461f642

data/.gitignore

@@ -1 +1 @@
-.idea/
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Separa Changelog
+
+## [0.0.3] - 2015-07-26
+
+### Changed
+- Fixed arrays in [Separa::Obj](./lib/Separa/obj.rb)
+
+### Added
+- Changelog

data/README.md

@@ -6,7 +6,7 @@ Separa splits chunks of text into tokens to be indexed
 Description
 -----------
 
-Separa splits chunks of text or ruby objects into tokens to be indexed by [Busca](https://github.com/Porta/busca), the simple redis search
+Separa splits chunks of text or ruby objects into tokens to be indexed by [Busca](https://github.com/Porta/busca), the simple redis search.
 
 ## Installation
 
@@ -18,3 +18,64 @@ $ gem install separa
 
 ## Usage
 
+The simplest possible usage is with default options:
+
+```ruby
+separa = Separa.new
+words = "This is a bunch of words. Separated"
+result = separa.call(words)
+puts result.inspect
+# ["This", "is", "a", "bunch", "of", "words", "", "Separated"]
+```
+
+You'll notice a few things here:
+* There's an empty element between `words` and `Separated`
+* Words kept their capitalization
+
+That's all intended. Separa only takes care of spliting the string into an array. It is up to you to filter later that array.
+
+Separa comes bundled with two 'Separators', but you can roll your own (more on that later).
+The separator usage is fairly simple, just pass the separator to the `Separa.new` constructor.
+
+[Separa::Text](./lib/Separa/text.rb) Splits a string of text into an array. You can pass a regexp to be used on the split.
+
+[Separa::Obj](./lib/Separa/obj.rb) Splits a ruby hash into an array. This is where things get interesting.
+Let's see a example:
+
+```ruby
+separa = Separa.new(Separa::Obj)
+h = { uno: 1, dos: 2, tres: {uno: 'one', dos: 'two'} }
+result = separa.call(h)
+puts result.inspect
+# ["uno:1", "dos:2", "tres.uno:one", "tres.dos:two"]
+```
+
+By default, Separa::Obj will use a semicollon divide the object key and it's value. You can change that passing a different divider.
+
+```ruby
+separa = Separa.new(Separa::Obj, divider: '-')
+h = { uno: 1, dos: 2, tres: {uno: 'one', dos: 'two'} }
+result = separa.call(h)
+puts result.inspect
+# ["uno-1", "dos-2", "tres.uno-one", "tres.dos-two"]
+```
+
+
+## Roll your own separator
+
+Writting your own separator is fairly simple. You only need to take care of 3 things.
+
+* It should respond to a `call` method.
+* The `call` method should receive 2 parameters. The string to split and a hash with options.
+* It should return an array. (Actually, returning an array isn't required, but recommended. I mean, that's *half* of the objective of this library, right?)
+
+Take a look at the bundled separators if you need inspiration:
+
+[Separa::Text](./lib/Separa/text.rb)
+
+[Separa::Obj](./lib/Separa/obj.rb)
+
+The code is pretty straightforward.
+
+Have fun splitting your strings, and drop a line to julian@porta.sh if you have something to say.
+

data/lib/Separa/obj.rb

@@ -1,15 +1,30 @@
 class Separa
-    module Obj
-        
-        def self.call(text, opts)
-          divider = opts[:divider] || ':'
-          res = wonderflat(text)
-          res.map{|k, v| "#{k.to_s}#{divider}#{v.to_s}"}
-        end
+  module Obj
+
+    def self.call(obj, opts)
+      divider = opts[:divider] || ':'
+      res = wonderflat(obj)
+      res.map{|pair,_| "#{pair.keys[0].to_s}#{divider}#{pair.values[0].to_s}"}
+    end
+  
+    def self.wonderflat(obj, memo = [])
+      return {
+        memo.join('.') => obj
+      } unless obj.respond_to?(:inject)
       
-        def self.wonderflat(hash, k = [])
-          return {k.join('.') => hash} unless hash.is_a?(Hash)
-          hash.inject({}){ |h, v| h.merge! self.wonderflat(v[-1], k + [v[0]]) }
-        end        
+      obj.inject([]) do |out_array, _val|
+        (head, *_tail) = _val
+        tail = _tail.pop
+        case tail
+          when Array
+            tail.map do |tail_elem|
+              out_array.push self.wonderflat(tail_elem, memo + [ head ])
+            end              
+          else
+            out_array.push self.wonderflat( tail, memo + [ head ])
+          end
+          out_array.flatten
+      end
     end
+  end
 end

data/lib/separa.rb

@@ -5,6 +5,8 @@ class Separa
     attr_reader :separador
 
     def initialize(separador = Separa::Text, opts = {})
+        
+
         if separador.respond_to?(:call)
             @separador = separador
             @opts = opts

data/makefile

@@ -1,2 +1,2 @@
 test:
-	cutest ./tests/*_test.rb
+		cutest ./tests/*_test.rb

data/separa.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name              = "separa"
-  s.version           = "0.0.2"
+  s.version           = "0.0.3"
   s.summary           = "Separa splits chunks of text into tokens to be indexed"
   s.description       = "Separa splits chunks of text into tokens to be indexed by Busca, the simple redis search"
   s.authors           = ["Julián Porta"]
   s.email             = ["julian@porta.sh"]
-  s.homepage          = "http://github.com/Porta/separa"
+  s.homepage          = "https://github.com/Porta/separa"
   s.files             = `git ls-files`.split("\n")
   s.license           = "MIT"
   s.add_development_dependency "cutest", '~>1.2'

data/tests/separa_test.rb

@@ -1,12 +1,11 @@
 require File.expand_path("../lib/separa", File.dirname(__FILE__))
 
-
 setup do
 	
 end
 
 test "default separator should be text" do
-	sep = Separa.new()
+    sep = Separa.new()
     assert_equal sep.separador, Separa::Text
 end
 
@@ -51,9 +50,10 @@ test "Separa::Obj should separate Obj into key:value pairs" do
     assert_equal result, ['uno:1', 'dos:2', 'tres.uno:one', 'tres.dos:two']
 end
 
-test "Separa::Obj should separate Obj into key.value pairs" do
-    sep = Separa.new(Separa::Obj, divider: '.')
-    h = { uno: 1, dos: 2, tres: {uno: 'one', dos: 'two'} }
-    result = sep.call(h)
-    assert_equal result, ['uno.1', 'dos.2', 'tres.uno.one', 'tres.dos.two']
-end
+test "Separa::Obj should separate Obj into key:value pairs, even with arrays" do
+    sep = Separa.new(Separa::Obj)
+    h = { uno: 1, dos: 2, tres: [:uno, :dos, :tres] }
+    result = sep.call(h)    
+    assert_equal result, ['uno:1', 'dos:2', 'tres:uno', 'tres:dos', 'tres:tres']
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: separa
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Julián Porta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-03 00:00:00.000000000 Z
+date: 2015-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cutest
@@ -33,6 +33,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - LICENSE
 - README.md
 - lib/Separa/obj.rb
@@ -41,7 +42,7 @@ files:
 - makefile
 - separa.gemspec
 - tests/separa_test.rb
-homepage: http://github.com/Porta/separa
+homepage: https://github.com/Porta/separa
 licenses:
 - MIT
 metadata: {}