the_great_escape 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a0943d518495527937a0ef408fc8e6a04ceb421
+  data.tar.gz: 4cf7908c808f16455bb0133148e96103c2ffb5db
+SHA512:
+  metadata.gz: 7871d5212d6cb67f6f9d3495e01f7eb508fce0baeafac607133c09328c1c0fe5eb9803bf384ecf810fcf8c38fc980c0558a4f34359150cf587c4576c873d5597
+  data.tar.gz: 8c207b8d6baafffc6e0e1e19af890dcc4795437cde7390fb5b7341a1413cf13b8fbe16ccb059e24380fc9d8a2e7e03cd960ab552c1ad4e1643d7e15985a81c62

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.sw*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in the_great_escape.gemspec
+gemspec

data/README.md

@@ -0,0 +1,62 @@
+# TheGreatEscape
+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:
+
+```ruby
+gem 'the_great_escape'
+```
+
+1. cd into your project's root:
+```
+$ cd my_project
+```
+1. execute:
+```
+$ bundle install
+```
+## Usage
+
+1. Require the_great_escape at the top of the file
+```ruby
+require 'the_great_escape'
+```
+
+1. And now use!
+```ruby
+require 'the_great_escape'
+
+string = "hell \e[31mworld"
+puts string # prints hell world to your screen. But everything is now in red! All you wanted to do was test your string contained an SGR code and now your terminal has been possessed!
+puts string.dump # prints "hell \e[31mworld", complete with quotations. This can be confusing for newbies who are trying to write Regexes for strings containing SGR codes (such as myself)
+
+escape_puts string # prints hell \e[31mworld Nice. Now you can see why your regex isn't working :P
+
+# Using TheGreatEscape's escape method over dump does have a distinct advantage. It doesn't invalidate your code:
+original_string = "hell \e[31m"
+
+string = original_string.dump
+puts string # prints "hell \\e[31m"
+puts string.scan /\\e\[\d+m$/ # [] scan returns an empty array because string ends in a " not an m thanks to the in-place dump
+
+string = escape original_string
+puts string # prints hell \\e[31m which is easier to read
+puts string.scan /\\e\[\d+m$/ # ["\\e[31m"] scan returns the SGR code at the end of string because string still ends in an m, despite the in-place escape
+##
+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
+
+# 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:
+
+1. Fork it ( https://github.com/[my-github-username]/the_great_escape/fork )
+1. Create your feature branch (`git checkout -b my_new_feature`)
+1. Commit your changes (`git commit -am 'Add my_new_feature'`)
+1. Push to the branch (`git push origin my_new_feature`)
+1. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "the_great_escape"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/the_great_escape/escaper.rb

@@ -0,0 +1,11 @@
+module TheGreatEscape
+	module Escaper
+		def escape_puts string
+			STDOUT.puts(escape string)
+		end
+
+		def escape string
+			string.dump.gsub /"/, ''
+		end
+	end
+end

data/lib/the_great_escape/version.rb

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

data/lib/the_great_escape.rb

@@ -0,0 +1,5 @@
+require 'the_great_escape/escaper'
+
+class Object
+	include TheGreatEscape::Escaper
+end

data/the_great_escape.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'the_great_escape/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "the_great_escape"
+  spec.version       = TheGreatEscape::VERSION
+  spec.authors       = ["jaytarka"]
+  spec.email         = ["jaytarka@hotmail.com"]
+
+	spec.summary       = 'Prints escaped strings to console'
+	spec.description	 = 'Escape strings with the Object#escape method. This escapes them so they can printed safely but they are not invalidated. Escape and print strings with one method with Object#escape_puts'
+  spec.homepage      = 'https://github.com/jaytarka/the_great_escape'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rspec", "~> 3.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: the_great_escape
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- jaytarka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Escape strings with the Object#escape method. This escapes them so they
+  can printed safely but they are not invalidated. Escape and print strings with one
+  method with Object#escape_puts
+email:
+- jaytarka@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/the_great_escape.rb
+- lib/the_great_escape/escaper.rb
+- lib/the_great_escape/version.rb
+- the_great_escape.gemspec
+homepage: https://github.com/jaytarka/the_great_escape
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Prints escaped strings to console
+test_files: []