strings 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d3712358619d5f8d24a776c05e69e721a95bde5
-  data.tar.gz: 06a4637fe88656f23a5e2d72f88184c6ed2a77fe
+  metadata.gz: 8c727435e43509b7a7e0cc9689156e11d0ce8e8b
+  data.tar.gz: 6c8b48a149487fa5f5531e2a758813b701450fe9
 SHA512:
-  metadata.gz: e486b066d003f2f7445cea67b571b48c6705d34b07a684d489eb179d1fed143c6b9ed2fce4cfab5698e036947e9984c0ef3a47b00c1906141db18e2de8f8819d
-  data.tar.gz: f4f9057f7003aaf5837f40d1d27de423e8288f94f4016c5590af01d0d09e39fd05d431f3090566e0baae0f5b5cb8f5bc195212d1f32e0aa51a95ff8d0b234ba1
+  metadata.gz: c7bc069057ee21ce39c90f6399182679bf5f6a822f84f51a210e5d1e85d94a4090632b9ffa3567a9abec3fd7cb8fceee03118be7cd711bb272652b4f99814fd6
+  data.tar.gz: c6219fcfc87b32052a8be2228ede6f7e40cb4a0634ab18e6cc157eff5783d88a76757f4092560d3dda82fa3b4ee731e494f630ce7417b8f9ba722f90df296aeb

data/.travis.yml

@@ -10,6 +10,7 @@ rvm:
   - 2.2.8
   - 2.3.6
   - 2.4.3
+  - 2.5.0
   - ruby-head
   - jruby-9000
   - jruby-head

data/CHANGELOG.md

@@ -1,7 +1,13 @@
 # Change log
 
+## [v0.1.1] - 2018-02-20
+
+### Added
+* Add ability to refine String class with extensions
+
 ## [v0.1.0] - 2018-01-07
 
 * Inital implementation and release
 
+[v0.1.1]: https://github.com/piotrmurach/verse/compare/v0.1.0...v0.1.1
 [v0.1.0]: https://github.com/piotrmurach/verse/compare/v0.1.0

data/README.md

@@ -84,20 +84,25 @@ Strings::Wrap.wrap(text, 30)
 
 To align a given multiline text within a given `width` use `align`, `align_left`, `align_center` or `align_right`.
 
-Given the following text:
+Given the following multiline text:
 
 ```ruby
-text = "for there is no folly of the beast\nof the earth which\nis not infinitely\noutdone by the madness of men"
+text = <<-TEXT
+for there is no folly of the beast
+of the earth which
+is not infinitely
+outdone by the madness of men
+TEXT
 ```
 
 Passing `text` as first argument, the maximum width and `:direction` to align to:
 
 ```ruby
-String.align(text, 40, direction: :center)
+Strings.align(text, 40, direction: :center)
 # =>
-#  "   for there is no folly of the beast   "
-#  "           of the earth which           "
-#  "           is not infinitely            "
+#  "   for there is no folly of the beast   \n"
+#  "           of the earth which           \n"
+#  "           is not infinitely            \n"
 #  "     outdone by the madness of men      "
 ```
 
@@ -106,9 +111,9 @@ You can also pass `:fill` option to replace default space character:
 ```ruby
 Strings.align(text, 40, direction: :center, fill: '*')
 # =>
-#  "***for there is no folly of the beast***"
-#  "***********of the earth which***********"
-#  "***********is not infinitely************"
+#  "***for there is no folly of the beast***\n"
+#  "***********of the earth which***********\n"
+#  "***********is not infinitely************\n"
 #  "*****outdone by the madness of men******"
 ```
 
@@ -118,10 +123,10 @@ It handles `UTF-8` text:
 text = "ラドクリフ\n、マラソン五輪\n代表に1万m出\n場にも含み"
 Strings.align_left(text, 20)
 # =>
-#  "ラドクリフ          "
-#  "、マラソン五輪      "
-#  "代表に1万m出        "
-#  "場にも含み          "
+#  "ラドクリフ          \n"
+#  "、マラソン五輪      \n"
+#  "代表に1万m出        \n"
+#  "場にも含み          \n"
 ```
 
 ### 2.2 ansi?
@@ -332,22 +337,36 @@ Strings::Wrap.wrap(text, wrap_at)
 
 ## 3. Extending String class
 
-Though it is highly discouraged to polute core Ruby classes, you can add the required methods to `String` class like so:
+Though it is highly discouraged to polute core Ruby classes, you can add the required methods to `String` class by using refinements.
+
+For example, if you wish to only extend strings with `wrap` method do:
 
 ```ruby
-class String
-  def wrap(*args)
-    Strings.wrap(self, *args)
+module MyStringExt
+  refine String do
+    def wrap(*args)
+      Strings.wrap(self, *args)
+    end
   end
 end
 ```
 
-then `wrap` method will be available for all strings in your system:
+then `wrap` method will be available for any strings where refinement is applied:
 
 ```ruby
+using MyStringExt
+
 string.wrap(30)
 ```
 
+However, if you want to include all the **Strings** methods:
+
+```ruby
+require 'strings/extensions'
+
+using Strings::Extensions
+```
+
 ## 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.

data/appveyor.yml

@@ -19,3 +19,5 @@ environment:
     - ruby_version: "23-x64"
     - ruby_version: "24"
     - ruby_version: "24-x64"
+    - ruby_version: "25"
+    - ruby_version: "25-x64"

data/lib/strings.rb

@@ -94,8 +94,8 @@ module Strings
   # @see Strings::Truncate#truncate
   #
   # @api public
-  def truncate(text, truncate_at, options = {})
-    Truncate.truncate(text, truncate_at, options)
+  def truncate(*args)
+    Truncate.truncate(*args)
   end
   module_function :truncate
 
@@ -104,8 +104,8 @@ module Strings
   # @see Strings::Wrap#wrap
   #
   # @api public
-  def wrap(text, wrap_at)
-    Wrap.wrap(text, wrap_at)
+  def wrap(*args)
+    Wrap.wrap(*args)
   end
   module_function :wrap
 end # Strings

data/lib/strings/extensions.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative '../strings'
+
+module Strings
+  module Extensions
+    refine String do
+      def align(*args)
+        Align.align(self, *args)
+      end
+
+      def align_left(*args)
+        Align.align_left(self, *args)
+      end
+
+      def align_right(*args)
+        Align.align_right(self, *args)
+      end
+
+      def ansi?
+        ANSI.ansi?(self)
+      end
+
+      def fold(*args)
+        Fold.fold(self, *args)
+      end
+
+      def pad(*args)
+        Pad.pad(self, *args)
+      end
+
+      def sanitize
+        ANSI.sanitize(self)
+      end
+
+      def truncate(*args)
+        Truncate.truncate(self, *args)
+      end
+
+      def wrap(*args)
+        Wrap.wrap(self, *args)
+      end
+    end
+  end # Extensions
+end # Strings

data/lib/strings/version.rb

@@ -1,3 +1,3 @@
 module Strings
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strings
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-07 00:00:00.000000000 Z
+date: 2018-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode_utils
@@ -105,6 +105,7 @@ files:
 - lib/strings.rb
 - lib/strings/align.rb
 - lib/strings/ansi.rb
+- lib/strings/extensions.rb
 - lib/strings/fold.rb
 - lib/strings/pad.rb
 - lib/strings/padder.rb