str_sanitizer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b538c943e4d55ad6963787e0959efa1bdc2c22e1
-  data.tar.gz: d0c9877e414a122aba5837fcf040e96e8f3064ea
+  metadata.gz: 40adee975fa727815aab7c0c5342b29aa314141d
+  data.tar.gz: 61bf3734eb9e0498d0340c336c906279b29accc6
 SHA512:
-  metadata.gz: e6c2d75091881c70ade7114a0e057df01e338d43221a6d3882b39ff4aa0b798a25e352911a1240a0a0afc8b11503fe4dc75b0884ada0a7985beb6fb59e7e64c7
-  data.tar.gz: 8c5da11e494e9d36f4734c7d1cfc543a81a8d707d7aa7738d14e925380cd35c76538b348d7f75f321dc0a03053726e2f5ed2d021c5a502b92c705f9384f30854
+  metadata.gz: 3ef826fb0f755c512fd636b6ba678041191517af6c6ba62f716ef17fe248022a8368ec38bf0339d06c055151930eebec476670adfd7161ccc590cbddc06f5832
+  data.tar.gz: 07efaf0dac8247d325828b0711dd4f13e8d9310a42b4818a6470e4536ee8b6e1efb286cbdf7a715d68dd69e00cd8e61bdb8b2ddfdfc6142c90abeb9ed85dabc0

data/.travis.yml

@@ -1,5 +1,14 @@
 sudo: false
+
 language: ruby
+
 rvm:
   - 2.3.1
+  - 2.1.5
+  - 2.0.0
+  - 1.9.3
+
 before_install: gem install bundler -v 1.15.3
+
+notifications:
+  email: false

data/CHANGELOG.md

@@ -1,4 +1,9 @@
+## StrSanitizer 0.2.0 (August 09, 2017) ##
+
+* Changed the structure of the module in `lib/str_sanitizer/quotes.rb` file. Removed the `InstanceMethods` module and `included` class method of `Quotes` module. Remove the `ClassMethods` class too from `Quotes` module. Re-structured the whole module.
+* Use `extend` instead of `include` in `StrSanitizer` class for using other modules methods. (To use the instance methods of any modules as class methods)
+* Add documentation about the methods in `Quotes` module.
+
 ## StrSanitizer 0.1.1 (August 07, 2017) ##
 
 *  In v0.1.0, the single_quote method wasn't working properly. This release fixes it.
-*  

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://badge.fury.io/rb/str_sanitizer.svg)](https://badge.fury.io/rb/str_sanitizer)
 # StrSanitizer
 
 Welcome to this gem. This gem is about String Sanitization. This gem sanitizes the string which is given.
@@ -21,15 +22,30 @@ Or install it yourself as:
 
 ## Usage
 
-##### To escape quotes of a string
+- To escape quotes of a string
 ```ruby
 require "str_sanitizer"
 
-hello = "He said, 'Hello!'"
-StrSanitizer.double_quote hello # => He said, \'Hello!\' 
+hello = 'He said, "Hello!"'
+StrSanitizer.double_quote(hello) # => He said, \"Hello!\" 
 
-hello = 'She said, "Hello!"'
-StrSanitizer.single_quote hello # => She said, \"Hello!\"
+hello = "She said, 'Hello!'"
+StrSanitizer.single_quote(hello) # => She said, \'Hello!\'
+
+both_quotes = "They said, \"Don't do it!\""
+StrSanitizer.both_quotes(both_quotes) # => They said, \"Don\'t do it!\"
+```
+You can also check if the string has any quote or not
+```ruby
+no_quote = "Hello, there."
+single_quote = "It's going down."
+double_quote = "He said, \"Hello\""
+
+StrSanitizer.has_any_quote?(no_quote) # => nil
+StrSanitizer.has_both_quotes?(no_quote) # => nil
+
+StrSanitizer.has_single_quotes?(single_quote) # => true
+StrSanitizer.has_double_quotes?(double_quote) # => true
 ```
 
 ## Development

data/lib/str_sanitizer/quotes.rb

@@ -1,21 +1,95 @@
+
 class StrSanitizer
+
+  # This module sanitizes the given string by adding backslash (\) before quote
+  # It also can check if a string has any quote or not.
+  #
+  # Author:     Jakaria (mailto: jakariablaine120@gmail.com)
+  # Copyright:  Copyright (c) 2017 Jakaria
+  
   module Quotes
-    def self.included(base)
-      base.send(:include, InstanceMethods)
-      base.send(:extend, ClassMethods)
+    
+    # Find any double quote (") in a string and add backslash (\) before the double quote.
+    # 
+    # Params:
+    # +str+:: A +string+ which has double quote that needs to be escaped.
+    #
+    # Returns:
+    # +String+:: The string which was passed to the parameter with escaped double quotes.
+    def double_quote(str)
+      str.gsub(/"/, /\\"/.source)
     end
 
-    module InstanceMethods
+    # Find any single quote (') in a string and add backslash (\) before the single quote.
+    # 
+    # Params:
+    # +str+:: A +string+ which has single quote that needs to be escaped.
+    #
+    # Returns:
+    # +String+:: The string which was passed to the parameter with escaped single quotes.
+    def single_quote(str)
+      str.gsub(/'/, /\\'/.source)
     end
 
-    module ClassMethods
-      def double_quote(str)
-        str.gsub(/"/, /\\"/.source)
-      end
+    # Find any single quote (') and double quote (") in a string and add backslash (\)
+    # before the single quote and double quote (").
+    # 
+    # Params:
+    # +str+:: A +string+ which has single quote and double quote that need to be escaped.
+    #
+    # Returns:
+    # +String+:: The string which was passed to the parameter with escaped single quote and
+    # double quote.
+    def both_quotes(str)
+      single_quote(double_quote(str))
+    end
+
+    # Search through the given string to see if it has any single quote (').
+    #
+    # Params:
+    # +str+:: A +string+ which needs to be checked for single quote.
+    # +pos+:: From where it should start searching. +Default+ is 0.
+    #
+    # Returns:
+    # +Boolean|Nil+:: Returns true if it has any single quote, nil for no single quote
+    def has_single_quote?(str, pos = 0)
+      true if str.match("'", pos)
+    end
+
+    # Search through the given string to see if it has any double quote (").
+    #
+    # Params:
+    # +str+:: A +string+ which needs to be checked for double quote.
+    # +pos+:: From where it should start searching. +Default+ is 0.
+    #
+    # Returns:
+    # +Boolean|Nil+:: Returns true if it has any double quote, nil for no double quote
+    def has_double_quote?(str, pos = 0)
+      true if str.match('"', pos)
+    end
+
+    # Search through the given string to see if it has both, single (') and double quote (").
+    #
+    # Params:
+    # +str+:: A +string+ which needs to be checked for both quotes.
+    # +pos+:: From where it should start searching. +Default+ is 0.
+    #
+    # Returns:
+    # +Boolean|Nil+:: Returns true if it has both quotes, nil for no quote.
+    def has_both_quotes?(str, pos = 0)
+      true if has_single_quote?(str, pos) && has_double_quote?(str, pos)
+    end
 
-      def single_quote(str)
-        str.gsub(/'/, /\\'/.source)
-      end
+    # Search through the given string to see if it has any quote.
+    #
+    # Params:
+    # +str+:: A +string+ which needs to be checked for any quote.
+    # +pos+:: From where it should start searching. +Default+ is 0.
+    #
+    # Returns:
+    # +Boolean|Nil+:: Returns true if it has any quote, nil for no quote
+    def has_any_quote?(str, pos = 0)
+      true if has_single_quote?(str, pos) || has_double_quote?(str, pos)
     end
   end
 end

data/lib/str_sanitizer/version.rb

@@ -1,3 +1,3 @@
 class StrSanitizer
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/str_sanitizer.rb

@@ -1,6 +1,28 @@
+# The MIT License (MIT)
+# 
+# Copyright (c) 2017 Jakaria Blaine
+# 
+# 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.
+
 require "str_sanitizer/version"
 require "str_sanitizer/quotes"
 
 class StrSanitizer
-  include Quotes
+  extend Quotes
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: str_sanitizer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jakaria Blaine
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-07 00:00:00.000000000 Z
+date: 2017-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler