the_great_escape 0.1.0 → 0.1.03

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a0943d518495527937a0ef408fc8e6a04ceb421
-  data.tar.gz: 4cf7908c808f16455bb0133148e96103c2ffb5db
+  metadata.gz: 7e75689468950eda885a5aed37c8fc56cd1f40cd
+  data.tar.gz: 6ca487bc62ee3a9e50b3c7c1d9cce02a4a652a34
 SHA512:
-  metadata.gz: 7871d5212d6cb67f6f9d3495e01f7eb508fce0baeafac607133c09328c1c0fe5eb9803bf384ecf810fcf8c38fc980c0558a4f34359150cf587c4576c873d5597
-  data.tar.gz: 8c207b8d6baafffc6e0e1e19af890dcc4795437cde7390fb5b7341a1413cf13b8fbe16ccb059e24380fc9d8a2e7e03cd960ab552c1ad4e1643d7e15985a81c62
+  metadata.gz: a020e8b4f6f89dc1ad27234f210bcbb550a83aa365957f56c08962c8a04d254df09b26a2ba714a313768099c709201f604c48fa830489941a8c98d2afc3a77aa
+  data.tar.gz: 96193a1b0ceefe7dd067eeb660b40247a3d5d37165b5666347499723c72a53fec8c3f2650f6e9f3c9d7a7415d35c644c05fa721baaa6878094437ad7ed24f2a6

data/.gitignore

@@ -8,3 +8,5 @@
 /spec/reports/
 /tmp/
 *.sw*
+the_great_escape-*.gem
+*.md.html

data/README.md

@@ -2,28 +2,24 @@
 My first gem, the great escape. Seeing if your string contains SGR or other ASCII codes can be tricky, as when you print them to the screen they change the color/formatting of your terminal whether you want them to our not! Dumping results in more characters you have to either escape or sift through by eye. All the_great_escape does is escape strings that contain special sequences such as SGR parameters.
 
 # Installation
-1. Add this line to your application's Gemfile:
-
+* Add this line to your application's Gemfile:
 ```ruby
 gem 'the_great_escape'
 ```
-
-1. cd into your project's root:
+* cd into your project's root:
 ```
 $ cd my_project
 ```
-1. execute:
+* execute:
 ```
 $ bundle install
 ```
 ## Usage
-
-1. Require the_great_escape at the top of the file
+* Require the_great_escape at the top of the file
 ```ruby
 require 'the_great_escape'
 ```
-
-1. And now use!
+* And now use!
 ```ruby
 require 'the_great_escape'
 
@@ -47,10 +43,10 @@ puts string.scan /\\e\[\d+m$/ # ["\\e[31m"] scan returns the SGR code at the end
 puts "\e[0" # reset your terminal to its default style if you run this code.
 ```
 ## Methods:
-Method  |  Arguments  |  Example Usage | Description
-------- | ----------- | ------------ | -
-escape  | string |  escaped = escape "hell \e[31m" |escapes the string passed to it so it can be safely printed later. Does not invalidate the string
-escape_puts  | string | escape_putis "hell \e[31m" | escapes the string passed to it and prints it immediately to the console
+| Method        | Example Usage | Description |
+| ------------- | ---------------------- | --- |
+| escape  STRING |  escaped = escape "hell \e[31m" | escapes the string passed to it so it can be safely printed later. Does not invalidate the string |
+| escape_puts STRING | escape_puts "hell \e[31m"  | escapes the string passed to it and prints it immediately to the console |
 
 # Contributing
 Okay, I'm pretty new to Ruby and utterly new to git so I've created this to learn about string escapement, git collaboration and how to package, release and install gems. Regardless, to contribute:

data/lib/the_great_escape/escaper.rb

@@ -5,7 +5,7 @@ module TheGreatEscape
 		end
 
 		def escape string
-			string.dump.gsub /"/, ''
+			string.to_s.dump.gsub /"/, ''
 		end
 	end
 end

data/lib/the_great_escape/version.rb

@@ -1,3 +1,3 @@
 module TheGreatEscape
-  VERSION = "0.1.0"
+  VERSION = "0.1.03"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: the_great_escape
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.03
 platform: ruby
 authors:
 - jaytarka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-11 00:00:00.000000000 Z
+date: 2015-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler