tco 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94ecede596bc95edcd19290a9cdb8220eb64a9a6
-  data.tar.gz: 5bb02dc3efa44a85fa79c2b9af4550489360b08e
+  metadata.gz: 68e7ffb606d28f3c346906e055d3e7ccf36af5e5
+  data.tar.gz: f6874a5cc654e36e9eb3d26b94d0fc876cd0a6b4
 SHA512:
-  metadata.gz: b2b8caeefe0f8aabc4976422ecd4a4558e2d31d545ed8b4d23e9fdbe4fb3854da21394150ad46c3178f4c89af8ed26cb6ec6776e5e3d0ac7875fe0f4ad192bce
-  data.tar.gz: bf03af845a23893bd97b7f5897251f6e907640e6ef23ccd514978599ddbd66a9ea720c18daad6dd52189f3f95370bbc9426ef29eed1b4bf515e24e4b2b146fa9
+  metadata.gz: 4fc1871dd26de790f23bdd58bcd44881f3dad0a3896139fd735896745eb32d48bf96015f3aa2769b6fb71cebca84bd5930d1c96f0a1a914cc5e2d66853030b7f
+  data.tar.gz: 62efa2e47ad194e7dcab4f870c3809ed1f0470c06387b4457188ac4b46780562baf6374c0f72d54dc2f770dde0c11394ce48774ec814b2da95fe7a41be89aa51

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+env:
+  global:
+    - RUBY_GC_MALLOC_LIMIT=90000000
+    - RUBY_GC_HEAP_FREE_SLOTS=200000
+
+matrix:
+  fast_finish: true
+
+before_install:
+  - cp gemrc ~/.gemrc
+
+script: "bundle exec rspec"

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+## 0.1.2 (2014-05-10)
+
+Features:
+
+  - added a config option to globally disable colouring
+
+Bugfixes:
+
+  - the 'options' section is now handled properly
+  - a few docs improvements
+
+## 0.1.1 (2014-04-24)
+
+Features:
+
+  - added Tco#configure (a simpler way to change the configuration)
+
+Bugfixes:
+
+  - the `-d` option works again

data/README.md

@@ -1,6 +1,10 @@
 # tco - terminal colours made simple
 
 [![Gem Version](https://badge.fury.io/rb/tco.png)](http://badge.fury.io/rb/tco)
+[![Inline docs](http://inch-pages.github.io/github/pazdera/tco.png)](http://inch-pages.github.io/github/pazdera/tco)
+[![Build Status][BS img]][Build Status]
+[Build Status]: https://travis-ci.org/pazdera/tco
+[BS img]: https://travis-ci.org/pazdera/tco.png
 
 The purpose of the **tco** gem is to make colouring in the terminal as
 convenient and as simple as possible. It provides a library for your Ruby gems
@@ -33,7 +37,7 @@ string into 15 parts. Check out the following examples.
 The `tco` terminal utility allows you to do the simple things you might need
 in your bash scripts:
 
-[![Using tco to colour text](http://linuxwell.com/assets/images/posts/tco-terminal.png)](http://linuxwell.com/assets/images/posts/tco-terminal.png)
+[![Using tco to colour text](http://broken.build/assets/images/posts/tco-terminal.png)](http://broken.build/assets/images/posts/tco-terminal.png)
 
 However, using `tco` directly from Ruby gives you much more flexibility. The
 following short piece of code will draw a rainbow inside your terminal:
@@ -48,7 +52,7 @@ rainbow = ["#622e90", "#2d3091", "#00aaea", "#02a552", "#fdea22", "#eb443b", "#f
 end
 ```
 
-[![tco showing a simple rainbow](http://linuxwell.com/assets/images/posts/tco-rainbow.png)](http://linuxwell.com/assets/images/posts/tco-rainbow-2.png)
+[![tco showing a simple rainbow](http://broken.build/assets/images/posts/tco-rainbow.png)](http://broken.build/assets/images/posts/tco-rainbow.png)
 
 And if you add a bit of `rmagick` to the equation, you can even render whole
 images in your terminal with no more than 10 lines of code.
@@ -64,7 +68,7 @@ Magick::Image.read("tux.png")[0].each_pixel do |pixel, col, row|
 end
 ```
 
-[![Tux drawn with tco](http://linuxwell.com/assets/images/posts/tco-tux.png)](http://linuxwell.com/assets/images/posts/tco-tux.png)
+[![Tux drawn with tco](http://broken.build/assets/images/posts/tco-tux.png)](http://broken.build/assets/images/posts/tco-tux.png)
 
 These were just the basic things you can do with `tco`. There are many more
 options and features available, many of them are described in the **Usage**
@@ -115,17 +119,15 @@ top of the user and system config files.
 ```ruby
 require "tco"
 
-tco_conf = Tco::config
-
-tco_conf["names"]["white"] = "#000"
-tco_conf["styles"]["pass"] = {
-  "fg" => "#000",
-  "bg" => "#00ff00",
-  "bright" => false,
-  "underline" => false,
-}
-
-Tco::reconfigure tco_conf
+Tco::configure do |tco_conf|
+  tco_conf.names["white"] = "#000"
+  tco_conf.styles["pass"] = {
+    "fg" => "#000",
+    "bg" => "#00ff00",
+    "bright" => false,
+    "underline" => false,
+  }
+end
 ```
 
 Apart from that, the library then contains a few more advanced things which
@@ -211,7 +213,8 @@ configuration file would look like this:
 ```yaml
 # This is unnecessary (extended palette is enabled by default).
 # However, you can set this to ansi if you use an older terminal.
-palette: "extended"
+options:
+    palette: "extended"
 
 colour_values:
     "@0": "#3b3b3b"

data/gemrc

@@ -0,0 +1,2 @@
+install: --no-rdoc --no-ri
+update:  --no-rdoc --no-ri

data/lib/tco.rb

@@ -88,7 +88,7 @@ module Tco
   def self.config
     @config
   end
-  
+
   def self.configure
     c = config
     yield(c)

data/lib/tco/colouring.rb

@@ -34,6 +34,7 @@ module Tco
     def initialize(configuration)
       @palette = Palette.new configuration.options["palette"]
       @output_type = configuration.options["output"]
+      @disabled = configuration.options["disabled"]
 
       configuration.colour_values.each do |id, value|
         @palette.set_colour_value(parse_colour_id(id), parse_rgb_value(value))
@@ -57,7 +58,9 @@ module Tco
     # line). This is due to some problems I've been having with some
     # terminal emulators not handling multi-line coloured sequences well.
     def decorate(string, (fg, bg, bright, underline))
-      return string unless STDOUT.isatty || @output_type == :raw
+      if (!STDOUT.isatty) || @output_type == :raw || @disabled
+        return string
+      end
 
       fg = get_colour_instance fg
       bg = get_colour_instance bg

data/lib/tco/config.rb

@@ -30,7 +30,8 @@ module Tco
     def initialize(locations=[])
       @options = {
         "palette" => "extended",
-        "output"  => "term"
+        "output"  => "term",
+        "disabled" => false
       }
       @colour_values = {}
       @names = {
@@ -67,10 +68,13 @@ module Tco
       if conf_file.has_key? "options"
         if conf_file["options"].is_a? Hash
           conf_file["options"].each do |id, value|
-            @colour_values[id] = value
+            @options[id] = case id
+              when "disabled" then parse_bool value
+              else value
+            end
           end
         else
-          raise "The 'colour_values' config option must be a hash."
+          raise "The 'options' config option must be a hash."
         end
       end
 

data/lib/tco/version.rb

@@ -22,5 +22,5 @@
 # THE SOFTWARE.
 
 module Tco
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/lib_spec.rb

@@ -0,0 +1,142 @@
+# tco - terminal colouring application and library
+# Copyright (c) 2013, 2014 Radek Pazdera
+
+# MIT License
+
+# 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.
+
+require "tco"
+require "tco/config"
+
+describe Tco do
+  describe "String class extension" do
+    before :all do
+      config = Tco::Config.new
+      config.options["palette"] = "extended"
+      config.options["output"] = "raw"
+      Tco::reconfigure config
+    end
+
+    describe "#fg" do
+      it "works with references" do
+        result = Tco::fg "@17", "London"
+        result.should eql "\e[38;5;17mLondon\e[0m"
+      end
+
+      it "works with rgb" do
+        result = Tco::fg "#00005F", "London"
+        result.should eql "\e[38;5;17mLondon\e[0m"
+      end
+
+      it "works with hex" do
+        result = Tco::fg "0x00005F", "London"
+        result.should eql "\e[38;5;17mLondon\e[0m"
+      end
+
+      it "works with names" do
+        result = Tco::fg "black", "London"
+        result.should eql "\e[38;5;0mLondon\e[0m"
+      end
+
+      it "fails with references lesser than zero" do
+        expect { Tco::fg "@-17", "London" }.to raise_error
+      end
+
+      it "fails with references bigger than 255" do
+        expect { Tco::fg "@256", "London" }.to raise_error
+      end
+
+      it "fails with bad hex colours" do
+        expect { Tco::fg "0x00ZZ00", "London" }.to raise_error
+      end
+
+      it "fails with bad colour names" do
+        expect { Tco::fg "apple", "London" }.to raise_error
+      end
+    end
+
+    describe "#bg" do
+      it "works with references" do
+        result = Tco::bg "@17", "London"
+        result.should eql "\e[48;5;17mLondon\e[0m"
+      end
+
+      it "works with rgb" do
+        result = Tco::bg "#00005F", "London"
+        result.should eql "\e[48;5;17mLondon\e[0m"
+      end
+
+      it "works with hex" do
+        result = Tco::bg "0x00005F", "London"
+        result.should eql "\e[48;5;17mLondon\e[0m"
+      end
+
+      it "works with names" do
+        result = Tco::bg "black", "London"
+        result.should eql "\e[48;5;0mLondon\e[0m"
+      end
+
+      it "fails with references lesser than zero" do
+        expect { Tco::bg "@-17", "London" }.to raise_error
+      end
+
+      it "fails with references bigger than 255" do
+        expect { Tco::bg "@256", "London" }.to raise_error
+      end
+
+      it "fails with bad hex colours" do
+        expect { Tco::bg "0x00ZZ00", "London" }.to raise_error
+      end
+
+      it "fails with bad colour names" do
+        expect { Tco::bg "apple", "London" }.to raise_error
+      end
+    end
+
+    describe "#bright" do
+      it "makes the fond bold" do
+        result = Tco::bright "London"
+        result.should eql "\e[1mLondon\e[0m"
+      end
+    end
+
+    describe "#underline" do
+      it "underlines the text" do
+        result = Tco::underline "London"
+        result.should eql "\e[4mLondon\e[0m"
+      end
+    end
+
+    it "can be combined" do
+      result = Tco::bg "@17", Tco::fg("@17", Tco::underline(Tco::bright "London"))
+      result.should eql "\e[48;5;17m\e[38;5;17m\e[4m\e[1mLondon\e[0m\e[0m\e[0m\e[0m"
+    end
+  end
+
+  describe "Configuration" do
+    it "disables colouring" do
+      Tco::configure do |c|
+        c.options["disabled"] = true
+      end
+
+      result = Tco::fg "#00005F", "London"
+      result.should eql "London"
+    end
+  end
+end

data/tco.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bundler", "~> 1.5"
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
+  s.add_runtime_dependency 'rspec'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tco
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Radek Pazdera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 2014-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: |-
   tco is a commandline tool and also a Ruby module that
                        allows its users to easily colourize the terminal
@@ -64,6 +78,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -73,6 +89,7 @@ files:
 - examples/tux.png
 - examples/tux.rb
 - examples/union_jack.rb
+- gemrc
 - lib/tco.rb
 - lib/tco/colouring.rb
 - lib/tco/config.rb
@@ -80,6 +97,7 @@ files:
 - lib/tco/parser.rb
 - lib/tco/style.rb
 - lib/tco/version.rb
+- spec/lib_spec.rb
 - spec/parser_spec.rb
 - spec/string_ext_spec.rb
 - spec/tco_spec.rb
@@ -111,6 +129,7 @@ signing_key:
 specification_version: 4
 summary: A tool and a library for terminal output colouring
 test_files:
+- spec/lib_spec.rb
 - spec/parser_spec.rb
 - spec/string_ext_spec.rb
 - spec/tco_spec.rb