string_splitter 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce843d4e98a02b464296d78d6be21f9fd7ce179b8156889f799280594250072c
-  data.tar.gz: 4a378aaa5c951224b3091c3e1bf5d55c5a61f6c5395f9cf820ba008b6b1b7af6
+  metadata.gz: 582dd9d8bae0421a49348bf0ccade081a4cc448e8e27943dcb67004b1b684f6d
+  data.tar.gz: 10990476dec6bf7edc909cd8558d0404fd9295820238ac527ebf3294454815a2
 SHA512:
-  metadata.gz: 68f9104ab3c5145322e5027814062a52692e854240a47df3e456d3a5d5c04f213a7875741aa00c6dd7bd5abb71e48f9e09b3d9dc5eb9bb488ef314849952c277
-  data.tar.gz: b2cdb8d72ef41459085580192db7e2792025ed16a84bda7a27b82e148bcd40eddb9b9fe2b5b866d9417085b8560905e1667516db843cd57aa8712639462766f9
+  metadata.gz: 666914aa76ca9f425dc7ef60b0110dbb1239fad3ae44ac49ba0ee59531b93d800cb2ca475c524ee359dbde4b21a0b97a89fa3f6910bb78d1b6737729ffddc1a9
+  data.tar.gz: 4c9522bcc4e858a98e4b9c79abe2ecf845b0a8209479b802637936215c0a5c02e9c0853f103779618636774ec5ce55a7157ea8144eaadaa97f918a94e062d4e9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.5.1 - 2018-07-01
+
+- set StringSplitter::VERSION when `string_splitter.rb` is loaded
+- doc tweaks
+
 ## 0.5.0 - 2018-06-26
 
 - don't treat string delimiters as patterns

data/README.md

@@ -11,6 +11,7 @@
 - [SYNOPSIS](#synopsis)
 - [DESCRIPTION](#description)
 - [WHY?](#why)
+- [COMPATIBILITY](#compatibility)
 - [VERSION](#version)
 - [SEE ALSO](#see-also)
   - [Gems](#gems)
@@ -36,30 +37,47 @@ gem "string_splitter"
 require "string_splitter"
 
 ss = StringSplitter.new
+```
+
+**Same as `String#split`**
 
-# same as String#split
+```ruby
 ss.split("foo bar baz quux")
 ss.split("foo bar baz quux", " ")
 ss.split("foo bar baz quux", /\s+/)
 # => ["foo", "bar", "baz", "quux"]
+```
+
+**Split at the first delimiter**
 
-# split at the first delimiter
+```ruby
 ss.split("foo:bar:baz:quux", ":", at: 1)
 # => ["foo", "bar:baz:quux"]
+```
+
+**Split at the last delimiter**
 
-# split at the last delimiter
+```ruby
 ss.split("foo:bar:baz:quux", ":", at: -1)
 # => ["foo:bar:baz", "quux"]
+```
 
-# split at multiple delimiter positions
+**Split at multiple delimiter positions**
+
+```ruby
 ss.split("1:2:3:4:5:6:7:8:9", ":", at: [1..3, -2])
 # => ["1", "2", "3", "4:5:6:7", "8:9"]
+```
 
-# split from the right
+**Split from the right**
+
+```ruby
 ss.rsplit("1:2:3:4:5:6:7:8:9", ":", at: [1..3, 5])
 # => ["1:2:3:4", "5:6", "7", "8", "9"]
+```
+**Full control via a block**
 
-# full control via a block
+```ruby
 result = ss.split('a:a:a:b:c:c:e:a:a:d:c', ":") do |split|
   split.index > 0 && split.lhs == split.rhs
 end
@@ -68,16 +86,16 @@ end
 
 # DESCRIPTION
 
-Many languages have built-in string `split` functions/methods. They behave similarly
+Many languages have built-in `split` functions/methods for strings. They behave similarly
 (notwithstanding the occasional [surprise](https://chriszetter.com/blog/2017/10/29/splitting-strings/)),
 and handle a few common cases e.g.:
 
 * limiting the number of splits
-* including the separators in the results
+* including the separator(s) in the results
 * removing (some) empty fields
 
 But, because the API is squeezed into two overloaded parameters (the delimiter and the limit),
-achieving the desired effects can be tricky. For instance, while `String#split` removes empty
+achieving the desired results can be tricky. For instance, while `String#split` removes empty
 trailing fields (by default), it provides no way to remove *all* empty fields. Likewise, the
 cramped API means there's no way to e.g. combine a limit (positive integer) with the option
 to preserve empty fields (negative integer), or use backreferences in a delimiter pattern
@@ -117,7 +135,8 @@ ss.split('foo:bar:baz:quux', ':', at: [1, -1]) # => ["foo", "bar:baz", "quux"]
 I wanted to split semi-structured output into fields without having to resort to a regex or a full-blown parser.
 
 As an example, the nominally unstructured output of many Unix commands is often formatted in a way
-that's tantalizingly close to being machine-readable, apart from a few pesky exceptions e.g.:
+that's tantalizingly close to being [machine-readable](https://en.wikipedia.org/wiki/Delimiter-separated_values),
+apart from a few pesky exceptions e.g.:
 
 ```bash
 $ ls -l
@@ -177,9 +196,14 @@ ss.split(line, at: [1..5, 8])
 # => ["-rw-r--r--", "1", "user", "users", "87", "Jun 18 18:16", "CHANGELOG.md"]
 ```
 
+# COMPATIBILITY
+
+StringSplitter is tested and supported on all versions of Ruby [supported by the ruby-core team](https://www.ruby-lang.org/en/downloads/branches/),
+i.e., currently, Ruby 2.3 and above.
+
 # VERSION
 
-0.5.0
+0.5.1
 
 # SEE ALSO
 
@@ -201,3 +225,4 @@ Copyright © 2018 by chocolateboy.
 
 This is free software; you can redistribute it and/or modify it under the
 terms of the [Artistic License 2.0](http://www.opensource.org/licenses/artistic-license-2.0.php).
+

data/lib/string_splitter.rb

@@ -1,13 +1,14 @@
 # frozen_string_literal: true
 
 require 'values'
+require_relative 'string_splitter/version'
 
 # This class extends the functionality of +String#split+ by:
 #
 #   - providing full control over which splits are accepted or rejected
 #   - adding support for splitting from right-to-left
-#   - encapsulating splitting options/preferences in instances rather than trying to
-#     cram them into overloaded method parameters
+#   - encapsulating splitting options/preferences in the splitter rather
+#     than trying to cram them into overloaded method parameters
 #
 # These enhancements allow splits to handle many cases that otherwise require bigger
 # guns e.g. regex matching or parsing.
@@ -47,7 +48,7 @@ class StringSplitter
     reject: exclude,
     &block
   )
-    result, block, splits, count, index = split_common(
+    result, splits, block = split_init(
       string: string,
       delimiter: delimiter,
       select: select,
@@ -55,8 +56,10 @@ class StringSplitter
       block: block
     )
 
-    splits.each do |split|
-      split = Split.with(split.merge({ index: (index += 1), count: count }))
+    count = splits.length
+
+    splits.each_with_index do |split, index|
+      split = Split.with(split.merge({ index: index, count: count }))
       result << split.lhs if result.empty?
 
       if block.call(split)
@@ -70,7 +73,7 @@ class StringSplitter
 
         result << split.rhs
       else
-        # append the rhs
+        # concatenate the rhs
         result[-1] = result[-1] + split.separator + split.rhs
       end
     end
@@ -89,7 +92,7 @@ class StringSplitter
     reject: exclude,
     &block
   )
-    result, block, splits, count, index = split_common(
+    result, splits, block = split_init(
       string: string,
       delimiter: delimiter,
       select: select,
@@ -97,8 +100,10 @@ class StringSplitter
       block: block
     )
 
-    splits.reverse!.each do |split|
-      split = Split.with(split.merge({ index: (index += 1), count: count }))
+    count = splits.length
+
+    splits.reverse!.each_with_index do |split, index|
+      split = Split.with(split.merge({ index: index, count: count }))
       result.unshift(split.rhs) if result.empty?
 
       if block.call(split)
@@ -156,11 +161,18 @@ class StringSplitter
     [result, splits]
   end
 
-  # setup common to both split methods
-  def split_common(string:, delimiter:, select:, reject:, block:)
+  # takes a hash of options passed to +split+ or +rsplit+ and returns a:
+  #
+  #   [result, splits, block]
+  #
+  # triple, where `result` is the return value of the method, `splits` is an array
+  # of hashes containing the lhs/rhs, separator and captures of each split, and
+  # `block` is a proc which specifies whether each split should be accepted or
+  # rejected
+  def split_init(string:, delimiter:, select:, reject:, block:)
     unless (match = string.match(delimiter))
       result = (@remove_empty && string.empty?) ? [] : [string]
-      return [result, block, NO_SPLITS, 0, -1]
+      return [result, NO_SPLITS, block]
     end
 
     select = Array(select)
@@ -180,10 +192,9 @@ class StringSplitter
     parts = string.split(/(#{delimiter})/, -1)
     remove_trailing_empty_field!(parts, ncaptures)
     result, splits = splits_for(parts, ncaptures)
-    count = splits.length
-    block ||= positions ? match_positions(positions, action, count) : ACCEPT_ALL
+    block ||= positions ? match_positions(positions, action, splits.length) : ACCEPT_ALL
 
-    [result, block, splits, count, -1]
+    [result, splits, block]
   end
 
   # increment back-references so they remain valid when the outer capture

data/lib/string_splitter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class StringSplitter
-  VERSION = '0.5.0'
+  VERSION = '0.5.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: string_splitter
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - chocolateboy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: values