fun_with_string_colors 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDgyMGU1MzMyNWY3MzIwNWY4NGFjZTk3NGRhNmI4Yjk2NjRjMThkNg==
+  data.tar.gz: !binary |-
+    Yjk0YzUzZDIyYWM5YjdlOTc5YzAzMTI5YzYxYTNjMGEzZWIwNjc3Mw==
+SHA512:
+  metadata.gz: !binary |-
+    ZWZlNzgyZDJmOTMzNDZjMDEzZmFlMWIyYTk2M2FlNDY4NWI1OTMzYWE3Yzkw
+    ZmQ5ZjA3NzFlZTQyMjVkOWE5NTQ3MzFmNzg4ZDc2ZjBkM2QzMDlmZGZjYTI5
+    NjA5NDRiNGU0ODI5Y2Y4M2NlOGNmM2RmMjMwOWY0M2NkZTdhMmM=
+  data.tar.gz: !binary |-
+    NDhmYzdhMTU3MThkNzg3ODU4OWZhNWQxNzM1NTQ3NDRkNDI5YWE5MzlhMzNh
+    YmNkZmU2MjkwMDhkMGI1ZmMyNmZhMDkyNjUyMTliMGE2NjIzZWYwMTg4Njll
+    ZDhiMjJlZGRhZmZhMDZkMzc0ZWMwOGY1MmY4NzBmMzkzOWYyOGY=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  # gem "shoulda", "~> 3.5"
+  # gem "rdoc", "~> 3.12"
+  # gem "bundler", "~> 1.0"
+  # gem "jeweler", "~> 2.0.1"
+  # gem "simplecov", ">= 0.8"
+  gem "fun_with_testing", "~> 0.0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Bryce Anderson
+
+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.

data/README.rdoc

@@ -0,0 +1,27 @@
+= fun_with_string_colors
+
+Paint your strings for prettier console output
+
+require 'fun_with_color_strings'
+
+FunWith::StringColors.activate
+String.colorize( true )
+puts "Hello World".paint(:pink)
+
+
+
+== Contributing to fun_with_string_colors
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Bryce Anderson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "fun_with_string_colors"
+  gem.homepage = "http://github.com/darthschmoo/fun_with_string_colors"
+  gem.license = "MIT"
+  gem.summary = "Paint your strings for prettier console output."
+  gem.description = "Paint your strings for prettier console output.  Description should not equal summary."
+  gem.email = "keeputahweird@gmail.com"
+  gem.authors = ["Bryce Anderson"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fun_with_string_colors #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/fun_with/string_colors/string_paint_extensions.rb

@@ -0,0 +1,20 @@
+module FunWith
+  module StringColors
+    module StringPaintExtensions
+      # When set to false, no color codes are added.  Good for 
+      # adding colors only when output goes to interactive shell
+      def colorize( setting = nil )
+        @colorize_setting = setting unless setting.nil?
+        @colorize_setting
+      end
+      
+      def colorize?
+        @colorize_setting
+      end
+      
+      def colorize_if_tty_out( out = STDOUT )
+        self.colorize( out.tty? )
+      end
+    end
+  end
+end

data/lib/fun_with/string_colors/string_paint_inclusions.rb

@@ -0,0 +1,75 @@
+module FunWith
+  module StringColors
+    module StringPaintInclusions
+      ############################## COLORS!!! ###############################
+      ANSI_COLORS = {
+        :bold       => "1",
+        :dim        => "2",
+        :underline  => "4",
+        :blink      => "5",
+        :reverse    => "7",
+        :invisible  => "8",
+        :clear      => "8",
+        :black      => "30",
+        :red        => "31",
+        :green      => "32",
+        :brown      => "33",
+        :yellow     => "33",   # synonym :brown
+        :blue       => "34",
+        :magenta    => "35",
+        :pink       => "35",   # synonym :magenta
+        :cyan       => "36",
+        :gray       => "39",
+        :bg_black   => "40",
+        :bg_red     => "41",
+        :bg_green   => "42",
+        :bg_brown   => "43",
+        :bg_yellow  => "43",   # synonym :bg_brown
+        :bg_blue    => "44",
+        :bg_magenta => "45",
+        :bg_pink    => "45",   # synonym :bg_magenta
+        :bg_cyan    => "46",
+        :bg_gray    => "47"
+      }
+      
+      ANSI_COLOR_TERMINATORS = {
+        :reverse => "\e[27m",
+        7        => "\e[27m",
+        :bold    => "\e[22m",
+        1        => "\e[22m"
+      }
+
+      def paint( *colors )
+        if paint?
+          rval = self.dup
+          terminations = []
+          
+          for color in colors
+            case color
+            when :reset, :unpaint
+              regex = /\e\[\d+m/
+              rval = rval.gsub( regex, '' )
+              terminations = []
+            when Symbol
+              if ANSI_COLORS[color]
+                rval = "\e[#{ANSI_COLORS[color]}m#{rval}"
+                terminations << (ANSI_COLOR_TERMINATORS[color] || "\e[0m")
+              end
+            when /^\d+$/, Integer # you can give numbers/number strings directly
+              rval = "\e[#{ANSI_COLORS[color] || color}m#{rval}"
+              terminations << (ANSI_COLOR_TERMINATORS[color.to_i] || "\e[0m")
+            end
+          end
+
+          rval + terminations.uniq.join
+        else
+          self
+        end
+      end
+
+      def paint?
+        self.class.colorize?
+      end
+    end
+  end
+end

data/lib/fun_with/string_colors.rb

@@ -0,0 +1,8 @@
+module FunWith
+  module StringColors
+    def self.activate
+      String.send( :include, StringPaintInclusions )
+      String.send( :extend, StringPaintExtensions )
+    end
+  end
+end

data/lib/fun_with_string_colors.rb

@@ -0,0 +1,3 @@
+require_relative File.join( "fun_with", "string_colors" )
+require_relative File.join( "fun_with", "string_colors", "string_paint_extensions" )
+require_relative File.join( "fun_with", "string_colors", "string_paint_inclusions" )

data/test/helper.rb

@@ -0,0 +1,45 @@
+require "fun_with_testing"
+# require 'simplecov'
+# 
+# module SimpleCov::Configuration
+#   def clean_filters
+#     @filters = []
+#   end
+# end
+# 
+# SimpleCov.configure do
+#   clean_filters
+#   load_adapter 'test_frameworks'
+# end
+# 
+# ENV["COVERAGE"] && SimpleCov.start do
+#   add_filter "/.rvm/"
+# end
+# 
+# require 'rubygems'
+# require 'bundler'
+
+# begin
+#   Bundler.setup(:default, :development)
+# rescue Bundler::BundlerError => e
+#   $stderr.puts e.message
+#   $stderr.puts "Run `bundle install` to install missing gems"
+#   exit e.status_code
+# end
+# 
+# require 'minitest'
+# require 'shoulda'
+
+# $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+# $LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require_relative( File.join( "..", "lib", "fun_with_string_colors" ) )
+
+FunWith::StringColors.activate
+String.colorize( true )
+
+# class Test::Unit::TestCase
+# end
+# 
+class FunWith::StringColors::TestCase < FunWith::Testing::TestCase
+end

data/test/test_fun_with_string_colors.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class TestFunWithStringColors < FunWith::StringColors::TestCase
+  should "test basics" do
+    assert defined?( FunWith::StringColors )
+    assert defined?( FunWith::StringColors::StringPaintExtensions )
+    
+    assert FunWith::StringColors.respond_to?( :activate )
+    FunWith::StringColors.activate
+    
+    assert defined?( String::ANSI_COLORS )
+    
+    for method in [:paint, :paint?]
+      assert "".respond_to?(method), "String.new doesn't respond to #{method.inspect}"
+    end
+  end
+  
+  should "print prettily" do
+    for color in String::ANSI_COLORS.keys
+      puts "[" + "Hello World".paint(color) + "]" + "[" + "Hello World".paint(color, :bold) + "]" + "[" + "Hello World".paint(color, :bold, :reverse ) + "]" + "[" + "Hello World".paint(color, :bold, :reverse, :reset ) + "]"
+    end
+    
+    str = ""
+    for color in %w("1 2 3 4 5 6 7 8 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107)
+      str <<  "#{color}: #{ 'hello world'.paint(color) } <done>\n"
+    end
+    
+    puts str
+  end
+  
+  should "clear strings properly" do
+    s1 = "hello"
+    s2 = "hello".paint( :bold, :reverse, :bg_pink, :blue, :underline )
+    puts "#{s1}  =>  #{s2}"
+    assert_equal s1, s2.paint( :reset )
+  end
+  
+  should "not alter output when .paint() receives nil/unrecognized" do
+    assert_equal "hello", "hello".paint(nil)
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: fun_with_string_colors
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Bryce Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fun_with_testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.0'
+description: Paint your strings for prettier console output.  Description should not
+  equal summary.
+email: keeputahweird@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/fun_with/string_colors.rb
+- lib/fun_with/string_colors/string_paint_extensions.rb
+- lib/fun_with/string_colors/string_paint_inclusions.rb
+- lib/fun_with_string_colors.rb
+- test/helper.rb
+- test/test_fun_with_string_colors.rb
+homepage: http://github.com/darthschmoo/fun_with_string_colors
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Paint your strings for prettier console output.
+test_files: []