string-builder 2.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04362e749e0f89971291f469659cb489ef05e5c13016e60039c1efa1a0b8f0eb
+  data.tar.gz: 0f19ec17b5d0621f23640febb72e27373d291b1ecfd7cf8a5fe0c911b9a2c43d
+SHA512:
+  metadata.gz: 46d9608d486bbf449b43d20ba78d9b350a7fa91f40bbd17a51b681f0406d7a3c4cca83a4acc4ed8cd5f2fb1eeebe8caf5afb25d50e344b8db8fa2a5a8f4425ca
+  data.tar.gz: ff9788db4215af48c64a74dcbea2564ffb4972425a86ea8065124d5fef5f11aec32c1659f7cb64bba85dd22247e997f5930933148875bc31c4053be6647a2905

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Edwin Onuonga
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+[![Build Status](https://travis-ci.org/eonu/string-builder.svg?branch=master)](https://travis-ci.org/eonu/string-builder)
+![Gem](https://img.shields.io/gem/v/string-builder.svg)
+[![License](https://img.shields.io/github/license/eonu/string-builder.svg)](https://github.com/eonu/string-builder/blob/master/LICENSE)
+
+# String::Builder
+
+Modified port of the [String::Builder IO initializer](https://crystal-lang.org/api/0.20.3/String/Builder.html#build%28capacity%3AInt%3D64%2C%26block%29%3AString-class-method) for the String class of the Crystal programming language.
+
+## 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)
+```
+
+```ruby
+# Crystal - String::Builder
+test = String.build do |s|
+  s << "Hello "
+  s << "World!"
+  s.gsub!("!", "?")
+end
+#=> ... undefined method 'gsub!' for String::Builder
+```
+
+**That's where this gem comes in!**
+
+## Example
+
+This example shows how to make a simple logger by constructing log messages with `String::Builder`.
+
+> **NOTE**:
+> - You can pass an optional argument before the block, specifying what the starting string (or any object that has a working `to_s` method) should be.
+> - Since the block `yield`s a `String` object, `String::Builder` allows you to mutate the string itself as seen in this example with the `String#gsub!` method.
+
+```ruby
+class Logger
+  using String::Builder
+  %i[error success info warning].each do |severity|
+    define_method(severity) do |message|
+      String.build Time.now.strftime("[%H:%M:%Ss] ") do |s|
+        s << "(#{__FILE__}) "
+        s << "#{severity.to_s.upcase} » #{message}"
+        s.gsub! '?', '!'
+      end
+    end
+  end
+end
+
+logger = Logger.new
+
+logger.error 'String::Builder is good?'
+#=> [03:54:53s] (lib/string-builder.rb) ERROR » String::Builder is good!
+
+logger.success 'String::Builder is good?'
+#=> [03:54:55s] (lib/string-builder.rb) SUCCESS » String::Builder is good!
+
+logger.info 'String::Builder is good?'
+#=> [03:54:57s] (lib/string-builder.rb) INFO » String::Builder is good!
+
+logger.warning 'String::Builder is good?'
+#=> [03:54:59s] (lib/string-builder.rb) WARNING » String::Builder is good!
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'string-builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install string-builder
+
+## Usage
+
+This monkey-patch is in the form of a `refinement`. This means that you will have to call the following `using` directive within the scope that you want the `String.build` class method to be monkey-patched into the `String` class:
+
+```ruby
+require 'string/builder'
+using String::Builder
+```
+
+Though you should typically avoid doing this in the global scope (unless you really need to), and instead only use the monkey-patch where you need it - inside your specific modules or classes:
+
+```ruby
+require 'string/builder'
+
+class A
+  using String::Builder
+  # CAN use String.build in this class
+end
+
+module B
+  # CANNOT use String.build in this module
+end
+
+# CANNOT use String.build in the global scope
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "string-builder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/string/builder.rb

@@ -0,0 +1,15 @@
+module String::Builder
+  refine String.singleton_class do
+    def build(obj = String.new)
+      if block_given?
+        yield builder = self.new
+        obj.dup.to_s << builder
+      else
+        obj.to_s
+      end
+    end
+    def respond_to?(symbol, include_all=false)
+      ((list = self.methods(false).dup) << :build).include? symbol
+    end
+  end
+end

data/lib/string-builder.rb

@@ -0,0 +1 @@
+require 'string/builder'

data/string-builder.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "string-builder"
+  spec.version       = "2.0.1"
+  spec.authors       = ["Edwin Onuonga"]
+  spec.email         = ["edwinonuonga@gmail.com"]
+
+  spec.summary       = %q{Modified port of the String::Builder IO initializer for the String class of the Crystal programming language.}
+  spec.homepage      = "https://www.github.com/eonu/string-builder"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.7"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: string-builder
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+platform: ruby
+authors:
+- Edwin Onuonga
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: 
+email:
+- edwinonuonga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/string-builder.rb
+- lib/string/builder.rb
+- string-builder.gemspec
+homepage: https://www.github.com/eonu/string-builder
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Modified port of the String::Builder IO initializer for the String class
+  of the Crystal programming language.
+test_files: []