spiffup 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23845e2c21b57bc74f6cf81f3efa544851bbaa30
+  data.tar.gz: f04543f5bbfc64d8dd9417e0e21135f21b58ca96
+SHA512:
+  metadata.gz: 7fc3f2759d1a3970ed90153a7beaf3b70c7e906aa0f2d19c758b61d309ad77ef1966dd314000ea51c5e04a50c6564306647da6ecbe236ae0c342e0954828a84d
+  data.tar.gz: 98d480c1ee8a86ac4b670b0a7d663fcffd119f2eda0dda07d4988c2c05f26b95f93ac91c96726f2a63bf65fdeb0c782f15ce0cbf982252c7c9361999c7796796

data/.gitignore

@@ -0,0 +1,3 @@
+.idea
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Paul Duncan
+
+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.md

@@ -0,0 +1,62 @@
+# Spiffup
+
+Make your stdout shine
+
+## Presentation
+
+This library provides means to 'prettify' output in Ruby.
+
+## Installation
+
+### Gemfile
+```ruby
+gem 'spiffup'
+```
+
+### Terminal
+```bash
+gem install -V spiffup
+```
+
+## Usage
+
+### Output colorization via tags
+
+Output can be colorized simply by adding tags within the text:
+The *RST* tag can be used to reset the color.
+Bold text can be produced by using the 'BXXX' tag constants (BGREEN, BRED, ...).
+
+```ruby
+require 'spiffup'
+puts "This is #{Spiffup::GREEN}green#{Spiffup::RST}"
+```
+
+### Direct string colorization
+
+Entire strings can be directly colorized by using the monkey-patched methods _.red_, _.green_, _.blue_, ...
+Also available are _.bred_, _.bgreen_, _.bblue_ methods for *bold* text.
+
+```ruby
+require 'spiffup'
+currency = 'CHF'
+amount = 52.4
+price = "#{amount} #{currency}"
+puts "Total price: #{price.green}"
+```
+
+### Available Colors
+
+The 8 classical terminal colors are available as the following:
+
+* black
+* red
+* green
+* brown
+* blue
+* magenta
+* cyan
+* gray
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+	t.pattern = 'test/**/test*.rb'
+end
+
+task :default => :test

data/lib/spiffup/string_color.rb

@@ -0,0 +1,15 @@
+# Spiffup
+# by Eresse <eresse@eresse.net>
+
+# Internal Includes
+require 'spiffup/term_color'
+
+# Monkey-patch String Class
+class String
+
+	# Attach Color Methods
+	Spiffup::TermColor::COLS.each do |col, idx|
+		define_method(col) { "#{Spiffup::TermColor::col idx}#{self}#{Spiffup::TermColor::RST}" }
+		define_method("b#{col}") { "#{Spiffup::TermColor::col idx, true}#{self}#{Spiffup::TermColor::RST}" }
+	end
+end

data/lib/spiffup/string_tags.rb

@@ -0,0 +1,16 @@
+# Spiffup
+# by Eresse <eresse@eresse.net>
+
+# Internal Includes
+require 'spiffup/term_color'
+
+# Spiffup Module
+module Spiffup
+
+	# Define String Tags
+	RST = TermColor::RST
+	TermColor::COLS.each do |col, idx|
+		const_set col.upcase, TermColor.col(idx)
+		const_set "B#{col.upcase}", TermColor.col(idx, true)
+	end
+end

data/lib/spiffup/term_color.rb

@@ -0,0 +1,34 @@
+# Spiffup
+# by Eresse <eresse@eresse.net>
+
+# Spiffup Module
+module Spiffup
+
+	# Term Color Module
+	module TermColor
+
+		# Colors
+		COLS = {
+			black: 0,
+			red: 1,
+			green: 2,
+			brown: 3,
+			blue: 4,
+			magenta: 5,
+			cyan: 6,
+			gray: 7
+		}
+
+		# Reset
+		RST = "\033[0m"
+
+		# Generate Color
+		# Generates a Terminal Color Code for a given color
+		# @param [Fixnum] x The desired color-index
+		# @param [boolean] bold When true, generate bold effect
+		# @return [String] A Terminal Color Code
+		def self.col x, bold = false
+			"\033[#{bold ? 1 : 0};#{30 + x}m"
+		end
+	end
+end

data/lib/spiffup/version.rb

@@ -0,0 +1,9 @@
+# Spiffup
+# by Eresse <eresse@eresse.net>
+
+# Spiffup Module
+module Spiffup
+
+	# Version
+	VERSION = '0.2.1'
+end

data/lib/spiffup.rb

@@ -0,0 +1,13 @@
+# Spiffup
+# by Eresse <eresse@eresse.net>
+
+# Internal Includes
+require 'spiffup/version'
+require 'spiffup/term_color'
+require 'spiffup/string_tags'
+require 'spiffup/string_color'
+
+# Spiffup Module
+# Root Module for Spiffup
+module Spiffup
+end

data/spiffup.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spiffup/version'
+
+Gem::Specification.new do |spec|
+	spec.name = 'spiffup'
+	spec.version = Spiffup::VERSION
+	spec.authors = ['Eresse']
+	spec.email = ['eresse@eresse.net']
+
+	spec.summary = 'Make your stdout shine'
+	spec.description = 'Provides means to \'prettify\' output in Ruby'
+	spec.homepage = 'http://redmine.eresse.net/projects/spiffup'
+	spec.license = 'MIT'
+
+	spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+	spec.require_paths = ['lib']
+
+	spec.add_development_dependency 'bundler'
+	spec.add_development_dependency 'rake'
+	spec.add_runtime_dependency 'minitest'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: spiffup
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Eresse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides means to 'prettify' output in Ruby
+email:
+- eresse@eresse.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/spiffup.rb
+- lib/spiffup/string_color.rb
+- lib/spiffup/string_tags.rb
+- lib/spiffup/term_color.rb
+- lib/spiffup/version.rb
+- spiffup.gemspec
+homepage: http://redmine.eresse.net/projects/spiffup
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Make your stdout shine
+test_files: []