boring 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 501d6772ed706a459f07dfacd62431999d84b895
+  data.tar.gz: 438dd560e08eab5e64489492966a2996f1d25ab0
+SHA512:
+  metadata.gz: 223141196fc24c84918f8aa214447913305236aecff6edfdd93115fc9c96f1a9b301b0e2e1a6560f8311f45d540031e7df9b9a0912cb1c673a4ddb0596b9ea9a
+  data.tar.gz: 641ca8d373ca77f9ac357f94fe8a119fbaf59799b26475e3a52bec6c0be878ae2472bbb8c8ae2910c1b456ee1d7cd2cb5eb00ca9025e305cd0b67e370bd722d2

data/README.markdown

@@ -0,0 +1,46 @@
+Boring
+======
+
+Shake free the shackles of color; resist the tyranny of fun!
+
+Boring will strip ANSI escape sequences.  For instance some utilities may use ansi escapes to colorize their output, or make some particularly important thing blink.  This is great great in your terminal, but looks pretty poor in an email, and can cause some log processors to choke up.  The solution? Make the text boring!
+
+Usage
+-----
+
+Assuming you have some test results that look like this:
+
+~~~
+test_result.log:
+Failure:
+test_comments_generate_change_reports(ActivityStreamTest)
+~~~
+
+You can strip escape sequences with `boring`:
+
+~~~
+$ boring test_result.log
+Failure:
+test_comments_generate_change_reports(ActivityStreamTest)
+~~~ 
+
+You can also use `boring` as a Ruby library:
+
+~~~ ruby
+require 'boring'
+
+boring = Boring.new
+boring.scrub("Failure!")
+#=> "Failure!"
+~~~
+
+Installation
+------------
+
+Install `boring` with rubygems:
+
+    gem install boring
+
+-----
+
+Adam Sanderson, http://www.monkeyandcrow.com

data/bin/boring

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+require_relative '../lib/boring'
+
+opts = OptionParser.new do |opts|    
+  opts.banner = "Usage: #{$0} [options] file_1 ..."
+  
+  opts.on("-E", "--encoding", "Set encoding, default: #{Encoding.default_external}") do |encoding|
+    Encoding.default_external = encoding
+  end
+    
+  opts.on("--version", "Print version") do
+    puts Boring::VERSION
+    exit
+  end
+  
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+
+opts.parse! ARGV
+
+boring = Boring.new
+boring.pipe(ARGF, STDOUT)

data/lib/boring.rb

@@ -0,0 +1,59 @@
+require_relative './version'
+
+class Boring
+  # ANSI Escape sequence byte ranges:
+  # 
+  # CSI Parameter bytes:    "0123456789:;<=>?"
+  # CSI Intermediate bytes: " !\"\#$%&'()*+,-./"
+  # CSI Finishing byte:     "@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~"
+  #
+  # References: http://en.wikipedia.org/wiki/ANSI_escape_code
+  #             https://www.gnu.org/software/teseq/manual/html_node/Escape-Sequence-Recognition.html
+  #
+  ESCAPE_SEQUENCE = /
+    \x1B             # Escape sequences start with an ESC char
+    ( 
+      [\x20-\x2F]*
+      [\x40-\x5A\x5C-\x7E]
+      
+      |
+      
+      \[               # Start CSI sequence
+      [\x30-\x3F]+     # CSI Parameter bytes
+      [\x20-\x2F]*     # CSI Intermediate bytes
+      [\x40-\x7E]      # CSI Finishing byte  
+    )
+  /x
+  
+  # Default escape replacement
+  REPLACEMENT = ""
+  
+  attr_reader :replacement
+  
+  # Create a new Boring string scrubber.  An optional replacement string may be used
+  # for any ANSI escape sequences.
+  def initialize(replacement=REPLACEMENT)
+    @replacement = replacement
+  end
+  
+  # Pipe data from io_in to io_out and scrub it along the way.
+  def pipe(io_in, io_out)
+    # Since we know that an escape may not contain a newline, we can process
+    # this line by line.
+    io_in.each_line do |line|
+      io_out << scrub(line)
+    end
+  end
+  
+  # Removes escape sequences from str.
+  def scrub(str)
+    str.gsub(ESCAPE_SEQUENCE, replacement)
+  end
+  
+  # Removes escape sequences from str in place.
+  def scrub!(str)
+    str.gsub!(ESCAPE_SEQUENCE, replacement)
+    str
+  end
+  
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+class Boring
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: boring
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Sanderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-11 00:00:00.000000000 Z
+dependencies: []
+description: Shake free the shackles of color; resist the tyranny of fun! Easily strips
+  ANSI escape sequences.
+email:
+- netghost@gmail.com
+executables:
+- boring
+extensions: []
+extra_rdoc_files: []
+files:
+- README.markdown
+- bin/boring
+- lib/boring.rb
+- lib/version.rb
+homepage: https://github.com/adamsanderson/boring
+licenses: []
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Strip ANSI escape sequences.
+test_files: []