string_splitter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcb033c8d7804dab11a7756f3fafb06292650c048947d09b01d479e354d2dfa4
-  data.tar.gz: ffc6e4fae751883e2f7731232ccb3b539eb95ff030d716360b284e21339651ad
+  metadata.gz: 128e1b2cc29cb122f3d5040f7c9e115688532c7e68c59f0a5373291e995642f9
+  data.tar.gz: 6b8729b7fb59aa984c1940ff0f9a1a308dded8b77c7db2b3c2a2ad4cdbd8bd52
 SHA512:
-  metadata.gz: b6ccb81fd4b270251f0f1dc4108e67485a9795a3fd8bdb3ce852a5d7498933e0f431da0d60732fc61e9224c4676ee5104858db0e40ed6589e03eb9fa147fc0dc
-  data.tar.gz: f4d011a2fc127645ca5bbf9fbb607d854e021021b69047a7fbdc6ba9124edbdca750901147a0cce22cd80ca05197355de94c9e3bd353b1a1a1ebfde136eefdce
+  metadata.gz: 3aa949fb5ac46369af379e2fd28bc18f7c93746515aea76005d606a4cb9f20426dec353bef8406264078cdccf89cdaca99902d961687f12fb72be08d9f2b0072
+  data.tar.gz: acd982d39a003be78b4548992cf108141e89e51a58f918e10515fb01dd1fd562db319e5c0dc5475d3e74739726e1fd752bbee4850b823705fb9520ff6b05e99f

data/CHANGELOG.md

@@ -1,7 +1,13 @@
+## 0.3.0 - 2018-06-23
+
+- **breaking change**: rename the `default_separator` option to `default_delimiter`
+  - to avoid ambiguity in the code, refer to the input pattern/string as the
+    "delimiter" and the matched string as the "separator"
+
 ## 0.2.0 - 2018-06-22
 
-- **breaking change**: make `index` (AKA `offset`) 0-based and add `position` (AKA `pos`)
-  as the 1-based accessor
+- **breaking change**: make `index` (AKA `offset`) 0-based and add `position`
+  (AKA `pos`) as the 1-based accessor
 
 ## 0.1.0 - 2018-06-22
 

data/README.md

@@ -43,15 +43,15 @@ ss.split("foo bar baz quux", " ")
 ss.split("foo bar baz quux", /\s+/)
 # => ["foo", "bar", "baz", "quux"]
 
-# split on the first separator
+# split at the first delimiter
 ss.split("foo:bar:baz:quux", ":", at: 1)
 # => ["foo", "bar:baz:quux"]
 
-# split on the last separator
+# split at the last delimiter
 ss.split("foo:bar:baz:quux", ":", at: -1)
 # => ["foo:bar:baz", "quux"]
 
-# split at multiple separator positions
+# split at multiple delimiter positions
 ss.split("1:2:3:4:5:6:7:8:9", ":", at: [1..3, -2])
 # => ["1", "2", "3", "4:5:6:7", "8:9"]
 
@@ -76,11 +76,11 @@ and handle a few common cases e.g.:
 * including the separators in the results
 * removing (some) empty fields
 
-But, because the API is squeezed into two overloaded parameters (the separator and the limit),
+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
 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 separator pattern
+to preserve empty fields (negative integer), or use backreferences in a delimiter pattern
 without including its captured subexpressions in the result.
 
 If `split` was being written from scratch, without the baggage of its legacy API,
@@ -106,7 +106,7 @@ ss.split("foo:bar:baz", ":") { |split| split.position == split.count }
 # => ["foo:bar", "baz"]
 ```
 
-As a shortcut, the common case of splitting on separators at one or more positions is supported by an option:
+As a shortcut, the common case of splitting on delimiters at one or more positions is supported by an option:
 
 ```ruby
 ss.split('foo:bar:baz:quux', ':', at: [1, -1]) # => ["foo", "bar:baz", "quux"]
@@ -116,7 +116,7 @@ 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, in practice, formatted in a way
+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.:
 
 ```bash
@@ -156,7 +156,7 @@ line.match(/^(\S+) \s+ (\d+) \s+ (\S+) \s+ (\S+) \s+ (\d+) \s+ (\S+ \s+ \d+ \s+
 ```
 
 But that requires us to specify *everything*. What we really want is a version of `split`
-which allows us to veto splitting for the 6th and 7th separators i.e. control over which
+which allows us to veto splitting for the 6th and 7th delimiters i.e. control over which
 splits are accepted, rather than being restricted to the single, baked-in strategy provided
 by the `limit` parameter.
 
@@ -179,13 +179,13 @@ ss.split(line, at: [1..5, 8])
 
 # VERSION
 
-0.2.0
+0.3.0
 
 # SEE ALSO
 
 ## Gems
 
-- [rsplit](https://github.com/Tatzyr/rsplit) - a reverse-split implementation (only works with string separators)
+- [rsplit](https://github.com/Tatzyr/rsplit) - a reverse-split implementation (only works with string delimiters)
 
 ## Articles
 

data/lib/string_splitter.rb

@@ -13,7 +13,7 @@ require 'values'
 # guns e.g. regex matching or parsing.
 class StringSplitter
   ACCEPT = ->(_split) { true }
-  DEFAULT_SEPARATOR = /\s+/
+  DEFAULT_DELIMITER = /\s+/
   NO_SPLITS = []
 
   Split = Value.new(:captures, :count, :index, :lhs, :rhs, :separator) do
@@ -26,20 +26,20 @@ class StringSplitter
   end
 
   def initialize(
-    default_separator: DEFAULT_SEPARATOR,
+    default_delimiter: DEFAULT_DELIMITER,
     include_captures: true,
     remove_empty: false,
     spread_captures: true
   )
-    @default_separator = default_separator
+    @default_delimiter = default_delimiter
     @include_captures = include_captures
     @remove_empty = remove_empty
     @spread_captures = spread_captures
   end
 
-  attr_reader :default_separator, :include_captures, :remove_empty, :spread_captures
+  attr_reader :default_delimiter, :include_captures, :remove_empty, :spread_captures
 
-  def split(string, delimiter = @default_separator, at: nil, &block)
+  def split(string, delimiter = @default_delimiter, at: nil, &block)
     result, block, splits, count, index = split_common(string, delimiter, at, block)
 
     splits.each do |split|
@@ -67,7 +67,7 @@ class StringSplitter
 
   alias lsplit split
 
-  def rsplit(string, delimiter = @default_separator, at: nil, &block)
+  def rsplit(string, delimiter = @default_delimiter, at: nil, &block)
     result, block, splits, count, index = split_common(string, delimiter, at, block)
 
     splits.reverse!.each do |split|
@@ -110,7 +110,7 @@ class StringSplitter
           # do nothing
         elsif parts.empty? # last split
           result << (!lhs.empty? ? lhs : rhs) if splits.empty?
-        elsif !lhs.empty?
+        elsif rhs.empty?
           # replace the empty rhs with the non-empty lhs
           parts[0] = lhs
         end

data/lib/string_splitter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: string_splitter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - chocolateboy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-22 00:00:00.000000000 Z
+date: 2018-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: values