embrace 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7a68687b49b752093867e4dceebd1500a7eb02d
-  data.tar.gz: f0117298d06412edda85916b9306d78fe203543d
+  metadata.gz: 75b37f0f9a63be6227d517a43fd646e59be725d9
+  data.tar.gz: 626f977a239048160e1ed9494d37e6933f4e3c54
 SHA512:
-  metadata.gz: fed4641a0817635b2f1f817805104e38ef082261d1ae5ce9e4a5aa9c4d1b41e7de7e4e7d01eade8b14339d116992329866197a8908afd45d2ccb4cfc3c140178
-  data.tar.gz: 69248b4b2cbfb302ca889c840bdfd9682c3d83e565f9c378158405427266e21ed280c60e39eda9812c22bf9d65d255b424541363896e8a251ae9417c71ede4ad
+  metadata.gz: 8fbc5529b32346338814f34d0ea9cb4dc18c7d44ed41439e5ada2e1ee4524326cbbfab191ea2b4b247e2cf2ff53d7000b4d0b08825c9de83392364b8fd5e902d
+  data.tar.gz: a6ff5d1f94a1d09c49be21cf218d170407444e2c79bd5948fcf72d6e780fed00d6515e4923199dee15d09a526413f0a8a60e16b46cf89f8426d12a5070de0eab

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.travis.yml

@@ -1,5 +1,16 @@
 sudo: false
+
 language: ruby
 rvm:
   - 2.3.1
+
 before_install: gem install bundler -v 1.13.6
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - john+embrace@carney.id.au
+    on_failure: change
+    on_success: never

data/README.md

@@ -1,8 +1,97 @@
 # Embrace
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/embrace`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version][gem-badge]][gem]
+[![Build status][build-badge]][build]
+[![Coverage Status][coverage-badge]][coverage]
 
-TODO: Delete this and the text above, and describe your gem
+Embrace is a simply library for bracketing strings, or parts of strings. While it focuses on common
+bracketing styles - `()`, `[]`, and `{}` - you can use custom styles, and even wrap text in arbitrary
+strings.
+
+## Usage
+
+The simplest way to use Embrace is to use its `String` refinements. Just put the following in your
+file, module or class.
+
+```ruby
+require "embrace"
+
+module MyModule
+  using Embrace
+
+  # ...
+end
+```
+
+If you want Embrace's `String` methods to be available globally, then include `Embrace::StringMethods`
+in an app initializer somewhere.
+
+```ruby
+require "embrace"
+
+String.include Embrace::StringMethods
+```
+
+### Basic bracketing methods
+
+Whether you use the refinements, or include the string methods, the following string methods will become
+available:
+
+```
+"text".bracket      # => "[text]"
+"text".parenthesize # => "(text)"
+"text".brace        # => "{text}"
+```
+
+### Custom bracket styles
+
+Each of the methods accepts a `style` parameter, which will be used to bracket the text. Note that the
+style should include both opening and closing strings, but is otherwise entirely arbitrary. The first
+half of the style will be placed before the text, and the second half will be placed after the text. If
+the style is an odd length, the extra character will go after the text.
+
+```ruby
+"text".bracket(style: "<b></b>")   # => "<b>text</b>"
+"text".parenthesize(style: "<-->") # => "<-text->"
+"text".brace(style: "«»")          # => "«text»"
+```
+
+### Bracketing portions of text
+
+All of the Embrace methods accept a `pattern` parameter. If supplied, then only the matching portions of
+the string will be bracketed.
+
+```ruby
+"the quick brown fox.".parenthesize                       # => "(the quick brown fox.)"
+"the quick brown fox.".parenthesize(pattern: /quick|fox/) # => "the (quick) brown (fox)."
+```
+
+### Wrapping text in arbitrary strings
+
+If you need to wrap text in asymmetrical strings, then you can supply an array as the `style` parameter.
+
+```ruby
+"the quick brown fox.".bracket(style: %w{ beginning> <end }) # => "beginning>the quick brown fox.<end"
+```
+
+Note that only the first two elements of the array will be use.
+
+### Module function
+
+`bracket` is available as a module function in the `Embrace` module.
+
+```ruby
+Embrace.bracket("some text", style: "<i></i>") # => "<i>some text</i>"
+```
+
+### Currying
+
+Finally, you can create a "curried" version of `Embrace.bracket`.
+
+```ruby
+wrapper = Embrace.bracketer(style: "()", pattern: "text")
+[ "some text", "some more text" ].map(&wrapper) # => [ "some (text)", "some more (text)" ]
+```
 
 ## Installation
 
@@ -20,22 +109,29 @@ Or install it yourself as:
 
     $ gem install embrace
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+ You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update
+the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the
+version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/embrace. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/embrace. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+[gem-badge]:        https://badge.fury.io/rb/embrace.svg
+[gem]:              http://badge.fury.io/rb/embrace
+[build-badge]:      https://travis-ci.org/johncarney/embrace.svg?branch=master
+[build]:            https://travis-ci.org/johncarney/embrace
+[coverage-badge]:   https://img.shields.io/coveralls/johncarney/embrace.svg
+[coverage]:         https://coveralls.io/r/johncarney/embrace?branch=master

data/embrace.gemspec

@@ -21,7 +21,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.1.0"
+
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake",    "~> 10.0"
   spec.add_development_dependency "rspec",   "~> 3.0"
+  spec.add_development_dependency "coveralls"
 end

data/lib/embrace/brackets.rb

@@ -6,8 +6,7 @@ module Embrace
 
     def split(style)
       i = style.size / 2
-      j = style.size - i
-      [ style[0...i], style[j..-1] ]
+      [ style[0...i], style[i..-1] ]
     end
   end
 

data/lib/embrace/string_methods.rb

@@ -1,19 +1,15 @@
 module Embrace
   module StringMethods
-    def wrap(*with)
-      Embrace.wrap(self, *with)
+    def bracket(style: "[]", **options)
+      Embrace.bracket(self, style: style, **options)
     end
 
-    def bracket(style: "[]")
-      Embrace.bracket(self, style: style)
+    def parenthesize(style: "()", **options)
+      Embrace.bracket(self, style: style, **options)
     end
 
-    def parenthesize(style: "()")
-      Embrace.bracket(self, style: style)
-    end
-
-    def brace(style: "{}")
-      Embrace.bracket(self, style: style)
+    def brace(style: "{}", **options)
+      Embrace.bracket(self, style: style, **options)
     end
   end
 end

data/lib/embrace/version.rb

@@ -1,3 +1,3 @@
 module Embrace
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/lib/embrace.rb

@@ -3,71 +3,19 @@ require "embrace/brackets"
 require "embrace/string_methods"
 
 module Embrace
-  using Brackets
-
   refine String do
     include StringMethods
   end
 
   module_function
 
-  # wrap
-
-  def wrap(text, before, after)
-    "#{before}#{text}#{after}"
-  end
-
-  def wrap_if(text, *with, &test)
-    return text unless test.yield text
-
-    wrap(text, *with)
-  end
-
-  def wrap_unless(text, *with, &test)
-    return text if test.yield text
-
-    wrap(text, *with)
-  end
-
-  # wrapper
-
-  def wrapper(*with)
-    ->(text) { wrap(text, *with) }
-  end
-
-  def if_wrapper(*with, &test)
-    ->(text) { wrap_if(text, *with, &test) }
-  end
-
-  def unless_wrapper(*with, &test)
-    ->(text) { wrap_unless(text, *with, &test) }
-  end
-
-  # bracket
-
-  def bracket(text, style:)
-    wrap(text, *Brackets(style))
-  end
-
-  def bracket_if(text, style:, &test)
-    wrap_if(text, *Brackets(style), &test)
-  end
-
-  def bracket_unless(text, style:, &test)
-    wrap_unless(text, *Brackets(style), &test)
-  end
-
-  # bracketer
-
-  def bracketer(style:)
-    wrapper(*Brackets(style))
-  end
-
-  def if_bracketer(style:, &test)
-    if_wrapper(*Brackets(style), &test)
+  def bracket(text, style:, pattern: /\A.*\z/)
+    opening, closing = Brackets(style)
+    text.gsub(pattern, "#{opening}\\0#{closing}")
   end
 
-  def unless_bracketer(style:, &test)
-    unless_wrapper(*Brackets(style), &test)
+  def bracketer(style:, **options)
+    brackets = Brackets(style)
+    ->(text) { bracket(text, style: brackets, **options)}
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: embrace
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - John Carney
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-12 00:00:00.000000000 Z
+date: 2016-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Simple library for enclosing text in brackets, or anything else that
   takes your fancy.
 email:
@@ -60,6 +74,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -87,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="