string-builder 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 968a9ed0e66b05ba5ebf1097c4eb93cfc261a4cb4d5a7834716d237bc828c80d
-  data.tar.gz: 8ce225e70fc36e5c6fd987dcc8703273b714e8d33c4911b870b7a677cd27a829
+  metadata.gz: e9be05a5fa8302af3f75659e915cd1ed84f8c87ff6ff5ec177d1dde71910e66a
+  data.tar.gz: 6c3840f7d0ae83a84ad66439ea370b3a25f36dfaee0512c6aeaebb549f0d3253
 SHA512:
-  metadata.gz: 43aa802365254956bf79c3fc0e6ee84e542a0c55ff456c78b867ac17f51e9030fe1ffa14f3bcbbd5b3bc723219c6f0fde97ad12842550e67a7241c865bcf2231
-  data.tar.gz: 95a2668b3bc77a84a5b24c4f8cf446d3b9d3f8a58ceb958ac1604776c1547b58eebfa3eec4347b9a7928f7b348a81ecb9c3fdb7c17e2601625756fbcb2ed9144
+  metadata.gz: 8a7d470f28efeb3c0fff8539d908a105f406a8f6b2eeba496c5be6bdd61356cee33a6b96dcac7e663ee2d781c9d4ba991b28027c980e1b03fb44c9123a917493
+  data.tar.gz: 2af21fb239aef87a7ca89f06c7ee4b020f930f5a9c75aef42dc08c0b948f5ad9ff49897264608cc2b385b73062e74e604b2fad82ba9d4c7b2f2a1a07ccaeb9d6

data/README.md

@@ -4,7 +4,7 @@
 
 # String::Builder
 
-Modified and extended port of the [String::Builder](https://crystal-lang.org/api/0.20.3/String/Builder.html#build%28capacity%3AInt%3D64%2C%26block%29%3AString-class-method) IO-style initializer for the `String` class of the Crystal programming language.
+Modified and extended port of the [String::Builder](https://crystal-lang.org/api/0.20.3/String/Builder.html#build%28capacity%3AInt%3D64%2C%26block%29%3AString-class-method) IO-style initializer for the `String` class of the Crystal programming language in the form of a Ruby gem refinement module.
 
 ## Methods
 
@@ -67,6 +67,16 @@ If no block is given, then the object converted to a string (with `to_s`) is ret
 
 ##### Examples
 
+```ruby
+foobar = String.build do |s|
+  s << 'fii'
+  s.gsub!('ii','oo')
+  s << 'bar'
+end
+
+foobar #=> "foobar"
+```
+
 ```ruby
 foobar = String.build 'foo' do |s|
   s << 'bop'
@@ -97,6 +107,20 @@ foobar #=> "foobar"
 foo #=> "foo"
 ```
 
+#### `String.[]`
+
+Takes arbitrarily many objects (with splat), converts them to strings and contatenates them (takes the product with the empty string).
+
+##### Examples
+
+```ruby
+String[]                       #=> ""
+String[3]                      #=> "3"
+String['Hello','World','!']    #=> "HelloWorld!"
+String[{k: 'v'}, 3, %i[a b c]] #=> "{:k=>\"v\"}3[:a, :b, :c]"
+String[*['a', 2, :z]]          #=> "a2z"
+```
+
 ## Detailed example
 
 This example shows how to make a simple logger by constructing log messages with `String::Builder`.
@@ -200,54 +224,6 @@ end
 # CANNOT use String::Builder methods in the global scope
 ```
 
-## Limitations of string building in Ruby and Crystal
-
-The [String::Builder](https://crystal-lang.org/api/0.20.3/String/Builder.html) class of the Crystal programming language provides an initializer method for the `String` class called `build` which is essentially an optimized version of Ruby's `StringIO`.
-
-Ruby's `StringIO` and Crystal's `String::Builder` are great because it essentially turns strings into IO objects, allowing you to pass a block into the constructor (yielding `self`) which leads to nice chaining such as:
-
-```ruby
-# Ruby - StringIO
-test = StringIO.open do |s|
-  s << 'Hello '
-  s << 'World!'
-  s.string
-end
-#=> "Hello World!"
-```
-
-Note the necessary `StringIO#string` method call. Since we are yielding a `StringIO` object, we must convert it to a `String` at the end. This is a bit cleaner in Crystal:
-
-```ruby
-# Crystal - String::Builder
-test = String.build do |s|
-  s << "Hello "
-  s << "World!"
-end
-#=> "Hello World!"
-```
-
----
-
-However, since **neither** of these two implementations yield a `String` object, you can't use `String` methods to mutate the object:
-
-```ruby
-# Ruby - StringIO
-test = StringIO.open do |s|
-  s << 'Hello '
-  s << 'World!'
-  s.upcase!
-  s.string
-end
-#=> ... undefined method `upcase!' for #<StringIO:0x00007fe0bc09d810> (NoMethodError)
-```
+## Further information
 
-```ruby
-# Crystal - String::Builder
-test = String.build do |s|
-  s << "Hello "
-  s << "World!"
-  s.gsub!("!", "?")
-end
-#=> ... undefined method 'gsub!' for String::Builder
-```
+For more information about string-building in Ruby and Crystal, [read this blog post](https://www.eonuonga.com/posts/2018/06/07/limitations-of-string-building).

data/lib/string/builder.rb

@@ -1,6 +1,8 @@
 module String::Builder
   refine String.singleton_class do
 
+    def [](*args) args.map(&:to_s)*self.new end
+
     def build(obj = String.new)
       return obj.to_s unless block_given?
       yield builder = self.new
@@ -8,7 +10,7 @@ module String::Builder
     end
 
     def respond_to?(id, private = false)
-      id.to_sym == :build ? true : super
+      %i[[] build].include?(id.to_sym) ? true : super
     end
 
   end

data/string-builder.gemspec

@@ -3,11 +3,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "string-builder"
-  spec.version       = "2.1.1"
+  spec.version       = "2.2.0"
   spec.authors       = ["Edwin Onuonga"]
   spec.email         = ["edwinonuonga@gmail.com"]
 
-  spec.summary       = %q{Modified and extended port of the String::Builder IO-style initializer for the String class of the Crystal programming language.}
+  spec.summary       = %q{Modified and extended port of the String::Builder IO-style initializer for the String class of the Crystal programming language in the form of a Ruby gem refinement module.}
   spec.homepage      = "https://www.github.com/eonu/string-builder"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: string-builder
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Edwin Onuonga
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-07 00:00:00.000000000 Z
+date: 2018-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,5 +94,6 @@ rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Modified and extended port of the String::Builder IO-style initializer for
-  the String class of the Crystal programming language.
+  the String class of the Crystal programming language in the form of a Ruby gem refinement
+  module.
 test_files: []