bocadillo 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 511ca3c5532cc2753317809342c469d5a9a427d7
+  data.tar.gz: eba82f473f1cae5d3dca6d8dcf10a7cd7fe2da88
+SHA512:
+  metadata.gz: dae9ca582edf5025b3d216b380d7a35fe365eefc2e614cc9d3014b2a36ad7e705b9ecdfd2a482b1a5cf4c0e46e571bafc0a63e5bfec0e34ead50b4a3fe60cd3b
+  data.tar.gz: b5aa4a0408e9bd7a90eb147cc40a766c4c120fd841d2cd70a4a5080dfc8b062f7984969e9d35436e54f62f16c42ccf0228f7750f84e2e4b1ff639d48aed9a625

data/LICENSE.md

@@ -0,0 +1,18 @@
+Copyright (c) 2017, Claudio Procida
+
+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,41 @@
+[![Build Status](https://travis-ci.org/emeraldion/bocadillo.svg?branch=master)](https://travis-ci.org/emeraldion/bocadillo)
+
+# bocadillo
+
+Converts a list of strings into a compact, readable representation with delimiters of choice
+
+```
+bocadillo 'alba,albero,albergo,alberto'
+# => alb(a|er(go|o|to))
+
+bocadillo 'aria:arianna' ':' '[' '+' ']'
+# => aria[+nna]
+```
+
+## What?
+
+In Spanish, [bocadillo](https://es.wiktionary.org/wiki/bocadillo) means sandwich. The name hints at the strings being sliced and interleaved with bread, the delimiters. Bocadillo is the Ruby port of the PHP package [Tramezzino](https://packagist.org/packages/emeraldion/tramezzino).
+
+## Why?
+
+Useful when you need to pass long lists of URL params
+
+## Ruby Gem
+
+Add it to your Ruby project as a [Ruby Gem](https://rubygems.org):
+
+```sh
+gem install bocadillo
+```
+
+Then have it your way:
+
+```ruby
+
+```
+
+## License
+
+Copyright (c) 2017, Claudio Procida
+
+[MIT](https://opensource.org/licenses/MIT)

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/bocadillo

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'bocadillo'
+
+if (ARGV.length < 1)
+  Bocadillo::Usage.print
+  exit 1
+end
+
+args = Bocadillo::Args.get
+arr = args[:string].split(args[:separator])
+puts Bocadillo.encode(arr, args[:preamble], args[:delimiter], args[:terminator])

data/lib/bocadillo.rb

@@ -0,0 +1,19 @@
+class Bocadillo
+  def self.encode(arr, preamble = '(', divider = '|', terminator = ')')
+    arr.sort!
+    Serializer.serialize({
+      'l' => '',
+      'c' => Cover.cover(arr)
+    }, preamble, divider, terminator)
+  end
+
+  def self.decode(str, preamble = '(', divider = '|', terminator = ')')
+    Parser.parse(str, preamble, divider, terminator)
+  end
+end
+
+require 'bocadillo/args'
+require 'bocadillo/cover'
+require 'bocadillo/parser'
+require 'bocadillo/serializer'
+require 'bocadillo/usage'

data/lib/bocadillo/args.rb

@@ -0,0 +1,18 @@
+class Bocadillo::Args
+  def self.get
+    i = -1
+    str = ARGV[i+=1]
+    separator = ARGV[i+=1] || ','
+    preamble = ARGV[i+=1] || '('
+    delimiter = ARGV[i+=1] || '|'
+    terminator = ARGV[i+=1] || ')'
+
+  	{
+  		:string => str,
+  		:separator => separator,
+  		:preamble => preamble,
+  		:delimiter => delimiter,
+  		:terminator => terminator
+  	}
+  end
+end

data/lib/bocadillo/cover.rb

@@ -0,0 +1,52 @@
+class Bocadillo::Cover
+  def self.cover(arr = [], x0 = 0, y = 0, l = nil)
+    l = arr.length if l.nil?
+    # Check bad input
+    if x0 >= l
+      # Error: past assigned slice
+      return false
+    end
+    if x0 > arr.length - 1
+      # Error: past array length
+      return false;
+    end
+
+    if y > arr[x0].length - 1
+      if x0 === l - 1
+        # Termination of rightmost string
+        return [nil]
+      end
+      # The string at x0 was only as long as y0, so call on the next item
+      return [nil].concat(self.cover(arr, x0 + 1, y, l))
+    end
+
+    # Initialize non-trivial return structure
+    u = {
+      'l' => arr[x0][y],
+      'c' => []
+    }
+    r = [u]
+
+    # Spread in width until we find either the end, or a different char
+    x = x0
+    loop do
+      m = false
+      if x < l && arr[x0][y] === arr[x][y]
+        m = true 
+        x += 1
+      end
+      break unless m
+    end
+
+    # If we haven't covered the full length of the assigned slice, launch
+    # on the pair (x + 1, y0) with the original length l.
+    if x < l
+      r.concat(self.cover(arr, x, y, l))
+    end
+
+    # Launch on the tail of the string at s[x0] from the position y
+    u['c'].concat(self.cover(arr, x0, y + 1, x))
+
+    r
+  end
+end

data/lib/bocadillo/parser.rb

@@ -0,0 +1,31 @@
+class Bocadillo::Parser
+  def self.parse(str, preamble, divider, terminator)
+    arr = []
+    i = 0
+    j = 0
+    k = 0
+    
+    while i < str.length do
+      if str[i, str.length].index(preamble) === 0 # (
+        t = arr[j + k]
+        arr.insert(j + k + 1, t)
+        i += preamble.length
+      elsif str[i, str.length].index(divider) === 0 # |
+        k += 1
+        t = arr[j + k]
+        arr.insert(j + k, t)
+        i += divider.length
+      elsif str[i, str.length].index(terminator) === 0 # )
+        arr.slice!(j + k + 1, 1)
+        j += k
+        k = 0
+        i += terminator.length
+      else
+        # trivial case, just keep appending to i+j-th string
+        arr[j + k] = (arr[j + k]||'') + str[i]
+        i += 1
+      end
+    end
+    arr
+  end
+end

data/lib/bocadillo/serializer.rb

@@ -0,0 +1,23 @@
+class Bocadillo::Serializer
+  def self.serialize(tree, preamble, divider, terminator, nested = false)
+    return '' if tree.nil?
+
+    head = [tree['l']]
+    if tree['c'].length === 0
+      return head
+    end
+
+    if tree['c'].length === 1
+      tail = [self.serialize(tree['c'][0], preamble, divider, terminator, true)]
+    else
+      suffixes = tree['c'].map do |suffix|
+        Bocadillo::Serializer.serialize(suffix, preamble, divider, terminator, true)
+      end
+      tail = [suffixes.join(divider)]
+      if nested
+        tail = [preamble].concat(tail).concat([terminator]);
+      end
+    end
+    return head.concat(tail).join('')
+  end
+end

data/lib/bocadillo/usage.rb

@@ -0,0 +1,16 @@
+class Bocadillo::Usage
+  def self.print
+  	puts <<END
+Usage:
+	bocadillo <string> [<separator> [<child preamble> [<child separator> [<child terminator>]]]]
+
+Examples:
+	bocadillo 'alba,albero,albino'
+	# => alb(a|ero|ino)
+
+	bocadillo 'alba:albero:albino' ':' '[' ',' ']'
+	# => alb[a,ero,ino]
+
+END
+  end
+end

data/test/test_bocadillo.rb

@@ -0,0 +1,103 @@
+require 'test/unit'
+require 'bocadillo'
+require 'yaml'
+
+class BocadilloTest < Test::Unit::TestCase
+  def setup
+    @fixture_file = 'test/fixtures/arrays.yml'
+    @fixtures = YAML.load_file(@fixture_file)
+  end
+
+  def test_encode
+    # It should return the string unaltered if the array has a single element
+    assert_equal 'albero',
+      Bocadillo.encode(['albero'], '(', '|', ')')
+  end
+
+  def test_encode_no_common_radix
+    # Strings without a common radix
+    assert_equal 'a|b|c',
+      Bocadillo.encode(['a', 'b', 'c'], '(', '|', ')')
+    assert_equal 'albero|fiore',
+      Bocadillo.encode(@fixtures['ALBERO_FIORE'], '(', '|', ')')
+  end
+
+  def test_encode_common_radix
+    # Strings with a common radix
+    assert_equal 'alb(a|er(go|o|to))',
+      Bocadillo.encode(@fixtures['ALB_A_ER_GO_O_TO'], '(', '|', ')')
+    assert_equal 'pesc(a(|tore)|h(eria|iera))',
+      Bocadillo.encode(@fixtures['PESCA_TORE_H_ERIA_IERA'], '(', '|', ')')
+    assert_equal 'mar(e|i(a|na(|io)|o))',
+      Bocadillo.encode(@fixtures['MARE_INA_IO_IA'], '(', '|', ')')
+  end
+
+  def test_encode_mixed_strings
+    # Mixed strings
+    assert_equal 'alb(a|er(go|o|to))|pesc(a(|tore)|h(eria|iera))',
+      Bocadillo.encode(@fixtures['ALB_A_ER_GO_O_TO'].clone.concat(@fixtures['PESCA_TORE_H_ERIA_IERA']), '(', '|', ')')
+  end
+
+  def test_encode_scrambled_order
+    # Order of input doesn't matter
+    assert_equal Bocadillo.encode(@fixtures['ALBERO_FIORE'].reverse, '(', '|', ')'),
+      Bocadillo.encode(@fixtures['ALBERO_FIORE'], '(', '|', ')')
+    assert_equal Bocadillo.encode(@fixtures['ALB_A_ER_GO_O_TO'].reverse, '(', '|', ')'),
+      Bocadillo.encode(@fixtures['ALB_A_ER_GO_O_TO'], '(', '|', ')')
+  end
+
+  def test_encode_isin
+    @fixture_file = 'test/fixtures/parser.yml'
+    @fixtures = YAML.load_file(@fixture_file)
+
+    # A real life example
+    assert_equal @fixtures['ISIN']['string'], Bocadillo.encode(@fixtures['ISIN']['array'], '(', '|', ')')
+  end
+
+  def test_decode
+    # It should return the string unaltered if the array has a single element
+    assert_equal ['albero'],
+      Bocadillo.decode('albero', '(', '|', ')')
+  end
+
+  def test_decode_no_common_radix
+    # Strings without a common radix
+    assert_equal ['a', 'b', 'c'],
+      Bocadillo.decode('a|b|c', '(', '|', ')')
+    assert_equal @fixtures['ALBERO_FIORE'],
+      Bocadillo.decode('albero|fiore', '(', '|', ')')
+  end
+
+  def test_decode_common_radix
+    # Strings with a common radix
+    assert_equal @fixtures['ALB_A_ER_GO_O_TO'].sort,
+      Bocadillo.decode('alb(a|er(go|o|to))', '(', '|', ')')
+    assert_equal @fixtures['PESCA_TORE_H_ERIA_IERA'].sort,
+      Bocadillo.decode('pesc(a(|tore)|h(eria|iera))', '(', '|', ')')
+    assert_equal @fixtures['MARE_INA_IO_IA'].sort,
+      Bocadillo.decode('mar(e|i(a|na(|io)|o))', '(', '|', ')')
+  end
+
+  def test_decode_mixed_strings
+    # Mixed strings
+    assert_equal @fixtures['ALB_A_ER_GO_O_TO'].clone.concat(@fixtures['PESCA_TORE_H_ERIA_IERA']).sort,
+      Bocadillo.decode('alb(a|er(go|o|to))|pesc(a(|tore)|h(eria|iera))', '(', '|', ')')
+  end
+
+  def test_decode_scrambled_order
+    # Order of input does matter
+    assert_not_equal Bocadillo.decode('albero|fiore', '(', '|', ')'),
+      Bocadillo.decode('fiore|albero', '(', '|', ')')
+    assert_not_equal Bocadillo.decode('alb(er(o|to|go)|a)', '(', '|', ')'),
+      Bocadillo.decode('alb(a|er(go|o|to))', '(', '|', ')')
+  end
+
+  def test_decode_isin
+    @fixture_file = 'test/fixtures/parser.yml'
+    @fixtures = YAML.load_file(@fixture_file)
+
+    # A real life example
+    assert_equal @fixtures['ISIN']['array'],
+      Bocadillo.decode(@fixtures['ISIN']['string'], '(', '|', ')')
+  end
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: bocadillo
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Claudio Procida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-18 00:00:00.000000000 Z
+dependencies: []
+description: Converts a list of strings into a compact, readable representation with
+  delimiters of choice
+email: claudio.procida@gmail.com
+executables:
+- bocadillo
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/bocadillo
+- lib/bocadillo.rb
+- lib/bocadillo/args.rb
+- lib/bocadillo/cover.rb
+- lib/bocadillo/parser.rb
+- lib/bocadillo/serializer.rb
+- lib/bocadillo/usage.rb
+- test/test_bocadillo.rb
+homepage: http://rubygems.org/gems/bocadillo
+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.6.8
+signing_key: 
+specification_version: 3
+summary: Compacts a list of strings
+test_files:
+- test/test_bocadillo.rb