quotinator 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## Version 0.0.3 (2013-08-01)
+ - Cleaded up the code more.
+ - Added CHANGELOG and README files
+
+## Version 0.0.2 (2013-08-01)
+ - Split out all substitutions into separate functions allowing everything, or only some things to be modified.
+ - Added "about" function.
+
+## Version 0.0.1 (2013-08-01)
+
+ - Initial Release

data/README.md

@@ -0,0 +1,39 @@
+# The Quotinator
+================
+
+## Background
+
+Blah
+
+## Usage
+
+Just include The Quotinator to your gemfile:
+> `gem "quotinator"`
+
+Then call any of the functions while passing in the string you wish to clean up. 
+> `Quotinator.replace("It's your text, why not clean it up?")`
+
+## Available functions
+
+*about*
+Outputs a brief description of what the gem does. Pretty much a useless function. 
+
+*replace(txt)*
+Shorthand function for `replace_all()`
+
+*replace_all(txt)*
+Function which handles replacing all known "special" characters.
+
+*doublequotes(txt)*
+Replaces only the special double quotation marks
+  
+*singlequotes(txt)*
+Replaces only the special single quotation marks
+  
+*ellipsis(txt)*
+Replaces only the special ellipsis (...)
+  
+*longdash(txt)*
+Replaces only the special long dash
+
+

data/lib/quotinator.rb

@@ -8,21 +8,13 @@ class Quotinator
     puts "its text with the basic counterparts."
   end
   
+  # Just a shorthand function for the replace_all function. 
   def self.replace(txt)
-    # To be depreciated...
-    txt.gsub!(/”/,'"')
-    txt.gsub!(/“/,'"')
-    txt.gsub!(/’/,"'")
-    txt.gsub!(/‘/,"'")
-    txt.gsub!(/…/,"...")
-    txt.gsub!(/ /," ")
-    txt.gsub!(/—/,"-")
-    # There seems to be two different sets of special quotes.
-    txt.gsub!(/”/,'"')
-    txt.gsub!(/“/,'"')
-    return txt
+    return replace_all(txt)
   end
   
+  # txt.gsub!(/ /," ") ?? Need to figure this character out.
+  
   def self.replace_all(txt)
     txt = doublequotes(txt)
     txt = singlequotes(txt)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quotinator
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ bindir: bin
 cert_chain: []
 date: 2013-08-01 00:00:00.000000000 Z
 dependencies: []
-description: A simple gem to replace the special character from Microsoft products
+description: A simple gem to replace the special characters from Microsoft products
   to their basic equivalents.
 email: eric@ercubed.com
 executables: []
@@ -19,6 +19,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/quotinator.rb
+- CHANGELOG.md
+- README.md
 homepage: http://rubygems.org/gems/quotinator
 licenses:
 - MIT