globs 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33e33b53ea61ac120c9a50e88a9eaf5f9c59843808d5c25edf9af003d3a2b42a
-  data.tar.gz: 0f59998761ed6675653e669b99391283653fd6ac09579240d97a0d3c1da47e6d
+  metadata.gz: 853fae28b48ce579ade6a922bb4198169c88e156fe9bde5a789b42a57073630c
+  data.tar.gz: fd6666c02bb0277079692af6112c13e6b073c452cd1b2cc77c8f509ba2031fd5
 SHA512:
-  metadata.gz: 756c66b3af815aab238b66ed95fb4c133bcf448933de922f4838e2255dca68db4c3f8f75850bacfe8cfc19f931671855638e062d09f636a55f6f5d01f8325396
-  data.tar.gz: 915e3ddc3aaf39dbc29c9bcc24fc8b7a6ffaa1210d33b6f1f3d316cee3d116272ebbd9982ddaba0b909d94cb8e4486eb6340d0af83df3fc15803c5cec36f5d29
+  metadata.gz: 52b355fa6f04a5cb23a702875dd7c609304ab9728ee515a9fb0618db272a72cd6046b9d5a86b5981877424faa23c185e1b4c0f9b8ce5737cdadd5909f2a9f932
+  data.tar.gz: 7451f0ef91f72265744d3e424fa27659a50287eccc0bcacf0aeb102bdaff39a9ffe3704ed338a0bfb16160808cb43e5f9cd653ad52e966c4211c5b47695c1a6b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    globs (0.0.1)
+    globs (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/lib/globs/version.rb

@@ -1,3 +1,3 @@
 module Globs
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/globs.rb

@@ -3,20 +3,32 @@ require "globs/version"
 # Container for Globs methods, currently only static as the public api
 # footprint is relatively small.
 #
-# It should be noted that I'll be exceptionally verbose in the comments
-# of this code as it's an interesting usecase for learning to combine
-# map, flat_map, and reduce for permutation-type generators.
-#
-# More than likely I'll write a tutorial on how the code works later and
-# link to it in these comments for the exceptionally curious. It'd be roughly
-# a 2.5 / 5 for difficulty.
-#
 # @author baweaver
 # @since 0.0.1
 #
 module Globs
   extend self
 
+  # Opening brace of a Glob expression
+  OPENING_BRACE         = /\{/
+
+  # Closing brace of a Glob expression
+  CLOSING_BRACE         = /\}/
+
+  # StringScanner is not 0 indexed. Offset for index.
+  SCANNER_INDEX_OFFSET  = 1
+
+  # We don't want to include the brace in our final set, so offset the index
+  # to compensate
+  BRACE_POSITION_OFFSET = 1
+
+  # Full positional offset for the braces and scanner's non-zero index
+  POSITION_OFFSET       = SCANNER_INDEX_OFFSET + BRACE_POSITION_OFFSET
+
+  # End of the string position, used to clarify difference between
+  # explicit EOS and positional offsets
+  END_OF_STRING         = -1
+
   # Shorthand for `puts expand(str)` for outputting to STDOUT for
   # unix-like piping.
   #
@@ -36,6 +48,9 @@ module Globs
   #
   # @since 0.0.1
   #
+  # @note
+  #   Modified to use StringScanner in 0.0.3 for more accurate tokenization
+  #
   # @example
   #
   #   ```
@@ -43,38 +58,91 @@ module Globs
   #   => ["test.a.1.com", "test.a.2.com", "test.b.1.com", "test.b.2.com"]
   #   ```
   #
-  # @note
-  #   While this _could_ be made into a tokenization type process for speed
-  #   reasons there's very little reason to do so immediately. The current
-  #   implementation is far more proof of concept than anything.
-  #
-  #   If speed needs to happen to arise from usage, PRs are welcome to
-  #   optimize this method, but the public api should remain the same.
-  #
   # @param string [String]
   #   Glob-like string to be expanded
   #
   # @return [Array[String]]
   #   All expansions of the glob-like string
   def expand(string)
-    string
-      .split(/\{|\}/)
-      .map { |cs| interpret_glob_set(cs.split(/, */)) }
-      .reduce { |sets, cs|
-        sets.flat_map { |s| cs.map { |c| s + c } }
+    scanner = StringScanner.new(string)
+    results = ['']
+
+    until scanner.eos?
+      beginning     = scanner.pos
+      start, finish = next_expression_positions!(scanner)
+
+      # There are no further expressions in the string if the start position is
+      # negative.
+      #
+      # Proceed to move the scanner's cursor to the end of the string and take
+      # the rest of the string to append to the current result items.
+      if start.negative?
+        scanner.pos  = string.size
+
+        non_glob_str = string[beginning..END_OF_STRING]
+        expressions  = ['']
+      else
+        non_glob_str = string[beginning..(start - POSITION_OFFSET)]
+        expressions  = interpret_expression(string[start..finish])
+      end
+
+      resulting_expressions = expressions.map { |exp| non_glob_str + exp }
+
+      results = results.flat_map { |res|
+        resulting_expressions.map { |exp| res + exp }
       }
+    end
+
+    results
   end
 
-  # Interprets a set of glob expressions, looking for items like ranges. When
-  # it finds such an item, it expands the range into an array to flatten into
-  # the set of possible values for a section.
+  # Finds the beginning and end of the next expression set in the string. If
+  # an expression set is not found, it will return END_OF_STRING for either
+  # of the positions being absent.
+  #
+  # @since 0.0.3
   #
-  # @param set [Array[String]]
-  #   Unexpanded glob set
+  # @mutates
+  #
+  # @note
+  #   This will mutate the given StringScanner and cause it to move its
+  #   associated cursor to the end of the last-found expression.
+  #
+  #   If an expression is not found, it will register the last known beginning
+  #   position, as `scan_until` will simply return nil and not change the
+  #   cursor position if something is not found.
+  #
+  # @param scanner [StringScanner]
+  #   Current StringScanner being used to tokenize and scan the glob expression
+  #   string
+  #
+  # @return [Array[Integer, Integer]]
+  #   Starting and ending positions of the next expression, excluding braces
+  private def next_expression_positions!(scanner)
+    return [END_OF_STRING, END_OF_STRING] unless scanner.scan_until(OPENING_BRACE)
+    start = scanner.pos
+
+    return [start, END_OF_STRING] unless scanner.scan_until(CLOSING_BRACE)
+    finish = scanner.pos
+
+    [start, finish - POSITION_OFFSET]
+  end
+
+  # Interprets a glob expression to extract permutatable items from it.
+  #
+  # @since 0.0.3
+  #
+  # @param string [String]
+  #   String to interpret as a glob expression
   #
   # @return [Array[String]]
-  #   Fully expanded glob sets
-  private def interpret_glob_set(set)
-    set.flat_map { |s| s.include?('..') ? Range.new(*s.split('..')).to_a : s }
+  #   Collection of permutable strings to iterate over when constructing a
+  #   final glob set
+  private def interpret_expression(string)
+    string
+      .split(/, */)
+      .flat_map { |exp|
+        exp.include?('..') ? Range.new(*exp.split('..')).to_a : exp
+      }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: globs
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Brandon Weaver
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-12 00:00:00.000000000 Z
+date: 2019-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler