string_splitter 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa94b66f61dc3f1970d92b7fa4fb01ba0932262338c124592f539a2f3b4e7ca3
-  data.tar.gz: 0b415f82cfe372bdc9fd0e72d26beeb5071fc02f31e6fa5c02606d3837680506
+  metadata.gz: d922735ed5c3b8acdc9f0fa0d0c439f0293e1b72739dd1f6b9ef9018a332f6c9
+  data.tar.gz: b61f3b6e827675abd5fe1457a000735c4ae4a4a11dc858fc705b783820230fce
 SHA512:
-  metadata.gz: 5efaba21a21e25b4b3f54a505f35cf16bba346427dfe4694554de6a1e917160e08cab9be65e80fd7d7407ba82cf5e876fff21ca2607e2da4fc137f3907b2322a
-  data.tar.gz: 37ac5c38859a8ed4036e68d9e588c58c8aa63e6ce2a47066dc1d02b115564cc187c505bec4b066a20981eedb21d210f01d019715ab9d91c9dc88f6e320763a3c
+  metadata.gz: f226e28ffb81f405ac986c01bf0cdb4270512d0a595d89d7d77ad1b53ed25dd122dac084887de26e26293d214906709724f018b83353a9928209257f6c80bc9e
+  data.tar.gz: f56357c60d8d52ff577a1ee5c4d16bbd4082bf29853dc3593fad3eefd6670a345ed245534944f5972fca1909e7e16526351eab898e4832d7cb2054ec86be4851

data/CHANGELOG.md

@@ -1,8 +1,14 @@
+## 0.7.3 - 2020-08-24
+
+#### Changes
+
+- avoid exposing an internal Split method inside blocks
+
 ## 0.7.2 - 2020-08-22
 
 #### Fixes
 
-  - fix/test default delimiter + `remove_empty_fields`
+- fix/test default delimiter + `remove_empty_fields`
 
 ## 0.7.1 - 2020-08-22
 

data/README.md

@@ -90,8 +90,8 @@ ss.split("1:2:3:4:5:6", ":", reject: [1, -1])
 **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"]
+ss.rsplit("1:2:3:4:5:6:7:8:9", ":", at: [1..3, -1])
+# => ["1", "2:3:4:5:6", "7", "8", "9"]
 ```
 
 **Split with negative, descending, and infinite ranges**
@@ -297,7 +297,7 @@ currently, Ruby 2.5 and above.
 
 # VERSION
 
-0.7.2
+0.7.3
 
 # SEE ALSO
 

data/lib/string_splitter.rb

@@ -19,7 +19,7 @@ require_relative 'string_splitter/version'
 #
 # Implementation-wise, we split the string either with String#split, or with a custom
 # scanner if the delimiter may contain captures (since String#split doesn't handle
-# them correctly) and parse the resulting tokens into an array of Split objects with
+# them correctly), and parse the resulting tokens into an array of Split objects with
 # the following attributes:
 #
 #   - captures:  separator substrings captured by parentheses in the delimiter pattern
@@ -40,6 +40,9 @@ class StringSplitter
   #
   # the delimiter is /(\W)/ and the separators are ":" and "::"
 
+  # pull in the StringSplitter::Split#update! method
+  using Split::Refinements
+
   ACCEPT_ALL = ->(_split) { true }
   DEFAULT_DELIMITER = /\s+/.freeze
   REMOVE = [].freeze
@@ -160,8 +163,8 @@ class StringSplitter
   #     if the splits array is empty, the caller returns this array immediately
   #     without any further processing
   #
-  #   - splits: an array of hashes containing the lhs, rhs, separator and captured
-  #     separator substrings for each split
+  #   - splits: an array of Split objects exposing the lhs, rhs, separator and
+  #     captured separator substrings for each split
   #
   #   - count: the number of splits
   #
@@ -274,7 +277,7 @@ class StringSplitter
   end
 
   # takes a string and a delimiter pattern (regex or string) and splits it along
-  # the delimiter, returning an array of objects (hashes) representing each split.
+  # the delimiter, returning an array of objects representing each split.
   # e.g. for:
   #
   #   parse("foo:bar:baz:quux", ":")
@@ -282,14 +285,14 @@ class StringSplitter
   # we return:
   #
   #   [
-  #       { lhs: "foo", rhs: "bar", separator: ":", captures: [] },
-  #       { lhs: "bar", rhs: "baz", separator: ":", captures: [] },
-  #       { lhs: "baz", rhs: "quux", separator: ":", captures: [] },
+  #       Split.new(lhs: "foo", rhs: "bar",  separator: ":", captures: []),
+  #       Split.new(lhs: "bar", rhs: "baz",  separator: ":", captures: []),
+  #       Split.new(lhs: "baz", rhs: "quux", separator: ":", captures: []),
   #   ]
   #
   def parse(string, delimiter)
     # has_names = delimiter.is_a?(Regexp) && !delimiter.names.empty?
-    result = []
+    splits = []
     start = 0
 
     # we don't use the argument passed to the +scan+ block here because it's a
@@ -304,15 +307,15 @@ class StringSplitter
       next if separator.empty? && (index.zero? || after == string.length)
 
       lhs = string.slice(start, index - start)
-      result.last.rhs = lhs unless result.empty?
+      splits.last.rhs = lhs unless splits.empty?
 
       # this is correct for the last/only match, but gets updated to the next
       # match's lhs for other matches
       rhs = match.post_match
 
-      # captures = (has_names ? Captures.new(match) : match.captures)
+      # captures = has_names ? Captures.new(match) : match.captures
 
-      result << Split.new(
+      splits << Split.new(
         captures: match.captures,
         lhs: lhs,
         rhs: rhs,
@@ -324,7 +327,7 @@ class StringSplitter
       start = after
     end
 
-    result
+    splits
   end
 
   # returns a lambda which splits at (i.e. accepts or rejects splits at, depending
@@ -341,11 +344,11 @@ class StringSplitter
   #
   # and
   #
-  #   ss.split("1:2:3:4:5:6:7:8:9", ":", -3..)
+  #   ss.split("1:2:3:4:5:6:7:8:9", ":", at: -3..)
   #
   # translates to:
   #
-  #   ss.split("foo:bar:baz:quux", ":", at: 6..8)
+  #   ss.split("1:2:3:4:5:6:7:8:9", ":", at: 6..8)
   #
   def compile(positions, action, count)
     # XXX note: we don't use modulo, because we don't want

data/lib/string_splitter/split.rb

@@ -2,8 +2,25 @@
 
 class StringSplitter
   class Split
+    # expose the +update!+ method as a refinement to StringSplitter but don't
+    # expose it to blocks
+    #
+    # idea based on a suggestion here (as an alternative to a `friend` modifier):
+    # https://bugs.ruby-lang.org/issues/12962#note-5
+    module Refinements
+      refine Split do
+        def update!(count:, index:)
+          @count = count
+          @index = index
+          @position = index + 1
+          freeze
+        end
+      end
+    end
+
     attr_reader :captures, :count, :index, :lhs, :position, :rhs, :separator
     attr_writer :rhs
+
     alias pos position
 
     def initialize(captures:, lhs:, rhs:, separator:)
@@ -40,12 +57,5 @@ class StringSplitter
     end
 
     alias rpos rposition
-
-    def update!(count:, index:)
-      @count = count
-      @index = index
-      @position = index + 1
-      freeze
-    end
   end
 end

data/lib/string_splitter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: string_splitter
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - chocolateboy
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-22 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler