super_strip 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bee232baf49e10fdbec6f4090c3b68ec0a424898
-  data.tar.gz: 47b40de7ed23fd8c2f0ccfdaeceb111b2b494bdf
+  metadata.gz: 781b066a9a40c10dad47ba8778b7ca2c188da440
+  data.tar.gz: ef1d2fe7992e5304e02fd4c5c6e50a6ef274f271
 SHA512:
-  metadata.gz: c262bf59e34ec44c36bc1a8eb37258ef73f84b81fbe103ae1b3a617fd637422c3e9e7c688b21698650c1f1a30080d9e2f2652c6d7182e67d2e720663f9e43158
-  data.tar.gz: 2909e84f9a18943ed1bba72f54f2ab208f6724d11658464d7b5b7f28ab5a12176ccc3f97987e67ba0b1fe4bf5ef29a184dc3c9c283544713110ff7a001764e47
+  metadata.gz: 6b1a35b61c0093f9be96db9909764cdb469ea018336dd7775150296c7ded00e860063fb5e1507dc026b042850c4183da246cdc06ebeaaa5280f00c36f40ea5cb
+  data.tar.gz: 8dca684b9b27538f7ffbb80495e0f49c8ac36c5f5669d2e0ab0a54b73272eb60db4ccc3df4a4549385ada16b7ef3c9d070cbcf9d177795c3a70b9405b7e37d9c

data/README.md

@@ -1,9 +1,11 @@
 # SuperStrip
 
-Utility module to strip special white spaces.
-`String#strip` removes white spaces in string, but not special white spaces for example `\u3000` (commonly used in Japanese), `\u3164` (HANGUL FILLER).
+Another version of strip methods to strip special white spaces.
+`String#strip` removes white spaces in string, but not special white spaces for example `\u3000` (IDEOGRAPHIC SPACE, commonly used in Japanese), `\u3164` (HANGUL FILLER).
 
-SuperStrip provides another lstrip, rstrip, strip functions.
+[![Build Status](https://travis-ci.org/pompopo/super_strip.svg?branch=master)](https://travis-ci.org/pompopo/super_strip)
+[![Gem Version](https://badge.fury.io/rb/super_strip.svg)](https://badge.fury.io/rb/super_strip)
+[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
 
 ## Installation
 
@@ -17,9 +19,28 @@ gem 'super_strip'
 
 ```
 str = '　string　'
-SuperStrip.strip(str) #=> 'string'
-SuperStrip.lstrip(str) #=> 'string　'
-SuperStrip.rstrip(str) #=> '　string'
+str.super_strip #=> 'string'
+str.super_lstrip #=> 'string　'
+str.super_rstrip #=> '　string'
+
+# destructive methods
+# These return nil if no spaces are removed
+str1 = str.dup
+str1.super_strip! #=> 'string'
+str1 #=> 'string'
+
+str2 = str.dup
+str2.super_lstrip! #=> 'string '
+str2 #=> 'string '
+
+str3 = str.dup
+str3.super_rstrip! #=> ' string'
+str3 #=> ' string'
+```
+
+If you want to remove all spaces in string, you can use `SuperStrip::WHITE_SPACES` constant.
+```
+' s t r i n g '.delete SuperStrip::WHITE_SPACES.join #=> 'string'
 ```
 
 ## Development

data/lib/super_strip.rb

@@ -1,23 +1,45 @@
 require 'super_strip/version'
 
-# Utility module to remove special white spaces
-module SuperStrip
-  class << self
-    def lstrip(str)
-      str.split('').drop_while do |point|
-        WHITE_SPACES.include?(point)
-      end.join
-    end
-
-    def rstrip(str)
-      lstrip(str.reverse).reverse
-    end
-
-    def strip(str)
-      lstrip(rstrip(str))
-    end
+# Special version of strip methods to remove special white spaces
+class String
+  def super_lstrip
+    split('').drop_while do |point|
+      SuperStrip::WHITE_SPACES.include?(point)
+    end.join
+  end
+
+  def super_rstrip
+    reverse.super_lstrip.reverse
+  end
+
+  def super_strip
+    super_lstrip.super_rstrip
+  end
+
+  def super_lstrip!
+    do_change(:super_lstrip)
+  end
+
+  def super_rstrip!
+    do_change(:super_rstrip)
+  end
+
+  def super_strip!
+    do_change(:super_strip)
+  end
+
+  private
+
+  def do_change(method)
+    after = send(method)
+    changed = self != after
+    replace(after)
+    self if changed
   end
+end
 
+# define special white spaces
+module SuperStrip
   WHITE_SPACES = %W(
     \u0009
     \u0020

data/lib/super_strip/version.rb

@@ -1,3 +1,3 @@
 module SuperStrip
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/super_strip.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['pompopo']
   spec.email         = ['pompopo@gmail.com']
 
-  spec.summary       = 'Utility module to strip special white spaces.'
-  spec.description   = 'SuperStrip provides another lstrip, rstrip, strip functions.'
+  spec.summary       = 'Provide another version of strip methods to strip special white spaces.'
+  spec.description   = 'SuperStrip provides another version of lstrip, rstrip, strip, lstrip!, rstrip!, strip! functions. They can remove special white spaces such as `IDEOGRAPHIC SPACE`.'
   spec.homepage      = 'https://github.com/pompopo/super_strip'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: super_strip
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - pompopo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-28 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: SuperStrip provides another lstrip, rstrip, strip functions.
+description: SuperStrip provides another version of lstrip, rstrip, strip, lstrip!,
+  rstrip!, strip! functions. They can remove special white spaces such as `IDEOGRAPHIC
+  SPACE`.
 email:
 - pompopo@gmail.com
 executables: []
@@ -96,5 +98,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Utility module to strip special white spaces.
+summary: Provide another version of strip methods to strip special white spaces.
 test_files: []