powerpack 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b1dee25575ff6e8b6dc5b84b6a6a2f000389e00
-  data.tar.gz: 4eed3f28b561507e70a1828a6fcc74cf6e8a4c22
+  metadata.gz: b5ae47f06545fa305812faece61d4a22a32f29cf
+  data.tar.gz: ffc7a033f26e64169194bd31fd0e0d3a97ddb145
 SHA512:
-  metadata.gz: 41e393fc5b3b067fd7551533d13c128f5357387485417812eaa318c3f96feea99f5ee15318d7e74e633540adc07dbf944d3d4a9af78274c18250cf83cc4e4541
-  data.tar.gz: a68471ecde73ac4a51273971bf936c7621950d3e27d8ced65786153397d9f7104236e2f1840d63c93d429e71fd58e9041f8419826a57f6e61872ad3b59b4e7e6
+  metadata.gz: ea7099ee760815ad0b5257690a2cc48925c677956f7b51f9a974fe1d19f31b3cd4fcadd9b6ac09b7f57815923d71774ccca763a234785ed34495c48377d8609a
+  data.tar.gz: 298cd5779cd56510d5089f85c23b8cc7b74920cd0be906682c6b214af047c7786d72f4410dc0c017f9931bc2137b17096ebb1222b16d548790b89f2a21997431

data/README.md

@@ -22,12 +22,13 @@ Or install it yourself as:
 ## Extensions
 
 * [Hash](http://rdoc.info/github/bbatsov/powerpack/Hash)
-** [#symbolize_keys](http://rdoc.info/github/bbatsov/powerpack/Hash#symbolize_keys-instance_method)
+    * [#symbolize_keys](http://rdoc.info/github/bbatsov/powerpack/Hash#symbolize_keys-instance_method)
 * [String](http://rdoc.info/github/bbatsov/powerpack/String)
-** [#blank?](http://rdoc.info/github/bbatsov/powerpack/String#blank?-instance_method)
-** [#format](http://rdoc.info/github/bbatsov/powerpack/String#format-instance_method)
-** [#strip_indent](http://rdoc.info/github/bbatsov/powerpack/String#strip_indent-instance_method)
-** [#strip_margin](http://rdoc.info/github/bbatsov/powerpack/String#strip_margin-instance_method)
+    * [#blank?](http://rdoc.info/github/bbatsov/powerpack/String#blank?-instance_method)
+    * [#format](http://rdoc.info/github/bbatsov/powerpack/String#format-instance_method)
+    * [#strip_indent](http://rdoc.info/github/bbatsov/powerpack/String#strip_indent-instance_method)
+    * [#strip_margin](http://rdoc.info/github/bbatsov/powerpack/String#strip_margin-instance_method)
+    * [#squish](http://rdoc.info/github/bbatsov/powerpack/String#squish-instance_method)
 
 ## Documentation
 

data/lib/powerpack/hash/symbolize_keys.rb

@@ -1,7 +1,11 @@
 unless Hash.method_defined? :symbolize_keys
   class Hash
-    # The method behaves like turns the keys of the hash to symbols.
-    # It returns a copy of the original hash.
+    # Converts the keys of the hash to symbols.
+    #
+    # @return [Hash] a copy of the original hash with its keys converted to symbols.
+    #
+    # @example
+    #   { 'one' => 1, 'two' => 2 }.symbolize_keys #=> { :one => 1, :two => 2 }
     def symbolize_keys
       Hash[map { |(k, v)| [k.to_sym, v] }]
     end

data/lib/powerpack/string.rb

@@ -2,3 +2,4 @@ require_relative 'string/blank'
 require_relative 'string/format'
 require_relative 'string/strip_indent'
 require_relative 'string/strip_margin'
+require_relative 'string/squish'

data/lib/powerpack/string/blank.rb

@@ -1,9 +1,20 @@
 unless String.method_defined? :blank?
   class String
-    # Returns true for empty strings and string with
-    # only whitespace in them.
+    # Checks whether a string is blank.
+    #
+    # @return [String] `true` is the string is empty or contains only
+    # whitespace, `false` otherwise
+    #
+    # @example
+    #   ''.blank? #=> true
+    #
+    # @example
+    #   '    '.blank? #=> true
+    #
+    # @example
+    #   '  test'.blank? #=> false
     def blank?
-      self.empty? || self.strip.empty?
+      empty? || strip.empty?
     end
   end
 end

data/lib/powerpack/string/format.rb

@@ -1,6 +1,14 @@
 unless String.method_defined? :format
   class String
-    # The method behaves like `Kernel#sprintf` and `String#%`.
+    # A nicer alternative to `Kernel#sprintf` and `String#%`.
+    #
+    # @return [String] the formatted string
+    #
+    # @example
+    #   'This is %s!'.format('Sparta') #=> 'This is Sparta!'
+    #
+    # @example
+    #   '%d + %d'.format([1, 2]) #=> '1 + 2'
     def format(*args)
       super(self, *(args.flatten(1)))
     end

data/lib/powerpack/string/squish.rb

@@ -0,0 +1,14 @@
+unless String.method_defined? :squish
+  class String
+    # Strips leading and trailing whitespace and squashes internal whitespace.
+    #
+    # @return [String] a string with not leading and traling whitespace and no
+    # consecutive whitespace characters inside it
+    #
+    # @example
+    #   ' Peter   Parker'.squish #=> 'Peter Parker'
+    def squish
+      strip.gsub(/\s+/, ' ')
+    end
+  end
+end

data/lib/powerpack/string/strip_indent.rb

@@ -5,14 +5,14 @@ unless String.method_defined? :strip_indent
     #
     # @example
     #
-    # code = <<-END.strip_indent
-    #   def test
-    #     some_method
-    #     other_method
-    #   end
-    # END
+    #   code = <<-END.strip_indent
+    #     def test
+    #       some_method
+    #       other_method
+    #     end
+    #   END
     #
-    # => "def\n  some_method\n  \nother_method\nend"
+    #   #=> "def\n  some_method\n  \nother_method\nend"
     def strip_indent
       leading_space = scan(/^[ \t]*(?=\S)/).min
       indent = leading_space ? leading_space.size : 0

data/lib/powerpack/string/strip_margin.rb

@@ -5,14 +5,14 @@ unless String.method_defined? :strip_margin
     #
     # @example
     #
-    # code = <<-END.strip_margin('|')
-    #   |def test
-    #   |  some_method
-    #   |  other_method
-    #   |end
-    # END
+    #   code = <<-END.strip_margin('|')
+    #     |def test
+    #     |  some_method
+    #     |  other_method
+    #     |end
+    #   END
     #
-    # => "def\n  some_method\n  \nother_method\nend"
+    #   #=> "def\n  some_method\n  \nother_method\nend"
     def strip_margin(margin_character)
       margin = '\\' + margin_character
       gsub(/^\s+#{margin}/, '')

data/lib/powerpack/version.rb

@@ -1,3 +1,3 @@
 module Powerpack
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/powerpack/string/squish_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'String#squish' do
+  it 'strips leading and trailing whitespace' do
+    expect(' Peter   '.squish).to eq('Peter')
+  end
+
+  it 'compacts internal whitespace' do
+    expect("Peter\r\n \t   Parker".squish).to eq('Peter Parker')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: powerpack
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Bozhidar Batsov
@@ -86,6 +86,7 @@ files:
 - lib/powerpack/string.rb
 - lib/powerpack/string/blank.rb
 - lib/powerpack/string/format.rb
+- lib/powerpack/string/squish.rb
 - lib/powerpack/string/strip_indent.rb
 - lib/powerpack/string/strip_margin.rb
 - lib/powerpack/version.rb
@@ -93,6 +94,7 @@ files:
 - spec/powerpack/hash/symbolize_keys_spec.rb
 - spec/powerpack/string/blank_spec.rb
 - spec/powerpack/string/format_spec.rb
+- spec/powerpack/string/squish_spec.rb
 - spec/powerpack/string/strip_indent_spec.rb
 - spec/powerpack/string/strip_margin_spec.rb
 - spec/spec_helper.rb
@@ -124,6 +126,7 @@ test_files:
 - spec/powerpack/hash/symbolize_keys_spec.rb
 - spec/powerpack/string/blank_spec.rb
 - spec/powerpack/string/format_spec.rb
+- spec/powerpack/string/squish_spec.rb
 - spec/powerpack/string/strip_indent_spec.rb
 - spec/powerpack/string/strip_margin_spec.rb
 - spec/spec_helper.rb