globs 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27981a3aaa22feac105986f68020cd41b1d2f38f3f4492b13405dc785539dadf
-  data.tar.gz: 4aa999a5689ded981ae89216c066eb0c0c7b008ac509913c858e180a561d886b
+  metadata.gz: 33e33b53ea61ac120c9a50e88a9eaf5f9c59843808d5c25edf9af003d3a2b42a
+  data.tar.gz: 0f59998761ed6675653e669b99391283653fd6ac09579240d97a0d3c1da47e6d
 SHA512:
-  metadata.gz: 82d16b20b0c77b8a94dca4e13f1ec54e677f9ebf450e99bd368ca002929ed3f524c95a28329bad58923cdfacd9654096084485826cd578893ec132b3f84d5e36
-  data.tar.gz: 3aaf66d343ac7b5d55a7e9a2659e3aa65f1daa0f21802316ae8fbc5f26c57ad1aececcb1563481d7466cabee6d09e7b7322b70aa05a5da5110c70b57d452a06f
+  metadata.gz: 756c66b3af815aab238b66ed95fb4c133bcf448933de922f4838e2255dca68db4c3f8f75850bacfe8cfc19f931671855638e062d09f636a55f6f5d01f8325396
+  data.tar.gz: 915e3ddc3aaf39dbc29c9bcc24fc8b7a6ffaa1210d33b6f1f3d316cee3d116272ebbd9982ddaba0b909d94cb8e4486eb6340d0af83df3fc15803c5cec36f5d29

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# compiled gems
+*.gem

data/lib/globs/version.rb

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

data/lib/globs.rb

@@ -1,8 +1,61 @@
 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
 
+  # Shorthand for `puts expand(str)` for outputting to STDOUT for
+  # unix-like piping.
+  #
+  # @since 0.0.2
+  #
+  # @param string [String]
+  #   Glob-like string to be expanded
+  #
+  # @return [NilClass]
+  #   Only outputs to STDOUT, returning `nil` from the actual
+  #   method call
+  def puts(string)
+    puts expand(string)
+  end
+
+  # Expands a glob-like string into all possible interpretations of it.
+  #
+  # @since 0.0.1
+  #
+  # @example
+  #
+  #   ```
+  #   Globs.expand("test.{a, b}.{1, 2}.com")
+  #   => ["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(/\{|\}/)
@@ -12,6 +65,15 @@ module Globs
       }
   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.
+  #
+  # @param set [Array[String]]
+  #   Unexpanded glob set
+  #
+  # @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 }
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: globs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Brandon Weaver