string-irc 0.2.3 → 0.3.0

data/.rspec

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

data/.travis.yml

@@ -1,6 +1,6 @@
 # https://github.com/travis-ci/travis-ci/wiki/.travis.yml-options
 rvm:
   - 1.8.7
-  - 1.9.2
   - 1.9.3
+  - 2.0.0
   - ruby-head

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.3.0
+
+Features:
+
+  - add original color scheme such as '#rainbow' and '#seven_eleven'

data/Gemfile.lock

@@ -1,27 +1,32 @@
 PATH
   remote: .
   specs:
-    string-irc (0.2.1)
-      net-irc (~> 0.0.9)
+    string-irc (0.3.0)
+      net-irc (>= 0.0.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.1.3)
+    json (1.7.7)
     net-irc (0.0.9)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.1)
+    rake (10.0.3)
+    rdoc (3.12.1)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
+    rspec-mocks (2.12.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.1.3)
-  rspec (~> 2.9.0)
+  rake (>= 0.9.2.2)
+  rdoc (>= 3.11)
+  rspec (>= 2.11.0)
   string-irc!

data/README.md

@@ -1,61 +1,124 @@
 # string-irc - Add color codes for mIRC compatible client.
-
 [![Build Status](https://secure.travis-ci.org/banyan/string-irc.png)](http://travis-ci.org/banyan/string-irc)
-[<img src="https://gemnasium.com/banyan/string-irc.png" />](https://gemnasium.com/banyan/string-irc)
-Description
----
-
-Port of http://search.cpan.org/~hirose/String-IRC-0.04/ from Perl to Ruby.
-
-Compatibility
----
-
-Tested under Ruby 1.9.2 and Ruby 1.8.7.
-
-See current status at [Travis CI](http://travis-ci.org/banyan/string-irc).
-
-Getting Started
----
-
-    require 'string-irc'
 
-    si1 = StringIrc.new('hello')
-    si1.red.underline
-    si2 = StringIrc.new('world').yellow('green').bold
-    msg = "#{si1.to_s} #{si2.to_s}" # You must add #to_s, this is the diffrence from original.
+## Description
 
-Usage
----
-
-    si.COLOR([BG_COLOR])
-
-    Add color code and return StringIRC object. BG_COLOR is
-    optional. Available COLOR and BC_COLOR are as follows.
-
-    white
-    black
-    blue navy
-    green
-    red
-    brown maroon
-    purple
-    orange olive
-    yellow
-    light_green lime
-    teal a_green blue_cyan
-    light_cyan cyan aqua
-    light_blue royal
-    pink light_purple fuchsia
-    grey
-    light_grey silver
-
-    #bold, #underline, #inverse are available method.
-
-    si.bold
-    si.underline
-    si.inverse
-
-Copyright
----
+Port of http://search.cpan.org/~hirose/String-IRC-0.04/ from Perl to Ruby.
 
-MIT License
+## Compatibility
+
+* Ruby 2.0.0
+* Ruby 1.9.3
+* Ruby 1.8.7
+
+## Getting Started
+
+```
+$ gem install string-irc
+```
+
+```ruby
+require 'string-irc'
+
+si1 = StringIrc.new('hello')
+si1.red.underline.to_s
+si2 = StringIrc.new('world').yellow('green').bold.to_s
+message = "#{si1} #{si2}"
+p message # => "\u001F\u000304hello\u000F \u0002\u000308,03world\u000F"
+```
+
+### Caveats
+
+* To strigfy StringIrc instance, you have to add #to_s method. This API is diffrence from original one.
+
+### Try with IRC
+
+* There is example code in `example` directory, try with IRC how looks it.
+
+## Usage
+
+```
+string_irc_instance.COLOR([BG_COLOR])
+```
+
+* Color scheme
+
+<table>
+  <tr>
+    <th>foreground, and background</th>
+  </tr>
+  <tr>
+    <td>white</td>
+  </tr>
+  <tr>
+    <td>black</td>
+  </tr>
+  <tr>
+    <td>blue, navy</td>
+  </tr>
+  <tr>
+    <td>green</td>
+  </tr>
+  <tr>
+    <td>red</td>
+  </tr>
+  <tr>
+    <td>brown, maroon</td>
+  </tr>
+  <tr>
+    <td>purple</td>
+  </tr>
+  <tr>
+    <td>orange, olive</td>
+  </tr>
+  <tr>
+    <td>yellow</td>
+  </tr>
+  <tr>
+    <td>light_green, lime</td>
+  </tr>
+  <tr>
+    <td>teal, a_green, blue_cyan</td>
+  </tr>
+  <tr>
+    <td>light_cyan, cyan, aqua</td>
+  </tr>
+  <tr>
+    <td>light_blue, royal</td>
+  </tr>
+  <tr>
+    <td>pink, light_purple, fuchsia</td>
+  </tr>
+  <tr>
+    <td>grey</td>
+  </tr>
+  <tr>
+    <td>light_grey, silver</td>
+  </tr>
+</table>
+
+* Decorate method
+
+```
+#bold
+#underline
+#inverse
+```
+
+* Original color scheme (currently it's only available as foreground color)
+
+<table>
+  <tr>
+    <th>foreground only</th>
+  </tr>
+  <tr>
+    <td>rainbow</td>
+  </tr>
+  <tr>
+    <td>seven_eleven</td>
+  </tr>
+</table>
+
+## Copyright
+
+Copyright (c) 2012 Kohei Hasegawa. See LICENSE for [details](http://banyan.mit-license.org/).

data/lib/string-irc.rb

@@ -1,7 +1,6 @@
-# -*- coding: utf-8 -*-
+# coding: utf-8
 
 class StringIrc
-
   COLOR_CODE = "\x03" # \u0003
   BOLD       = "\x02" # \u0002
   UNDERLINE  = "\x1f" # \u001F
@@ -27,27 +26,50 @@ class StringIrc
     15 => %w(light_grey silver),
   }
 
+  ORIGINAL_COLOR_SCHEME = {
+    "rainbow"      => %w(red orange yellow green blue light_blue purple), # order is referred: http://ja.wikipedia.org/wiki/%E8%99%B9
+    "seven_eleven" => %w(orange green red)
+  }
+
   def initialize(string = nil)
     @string = string
   end
 
-  color_name_table = {}
+  @@color_name_table = {}
 
-  COLOR_TABLE.each do | code, colors |
+  COLOR_TABLE.each do |code, colors|
     colors.each do |color|
-      color_name_table[color] = code
-      define_method(color) do | *args |
+      @@color_name_table[color] = code
+      define_method(color) do |*args|
         bg_color = args.first || nil
-        if (!!bg_color and color_name_table.include?(bg_color))
-          color_code = "#{COLOR_CODE}#{sprintf("%02d,%02d", code, color_name_table[bg_color])}"
+        raise ArgumentError, "`#{bg_color}' is not allowed to use as background color" if ORIGINAL_COLOR_SCHEME.include?(bg_color)
+        if bg_color && @@color_name_table.include?(bg_color)
+          color_code = "#{COLOR_CODE}#{"%02d,%02d" % [code, @@color_name_table[bg_color]]}"
         else
-          color_code = "#{COLOR_CODE}#{sprintf("%02d", code)}"
+          color_code = "#{COLOR_CODE}#{"%02d" % code}"
         end
         add_code_l(color_code)
       end
     end
   end
 
+  ORIGINAL_COLOR_SCHEME.each do |key, order|
+    define_method(key) do |*args|
+      index    = 0
+      bg_color = args.first || nil
+      @string = @string.each_char.map { |char|
+        order = index % ORIGINAL_COLOR_SCHEME[key].size
+        index += 1
+        if bg_color && @@color_name_table.include?(bg_color)
+          "#{COLOR_CODE}#{"%02d,%02d" % [@@color_name_table[ORIGINAL_COLOR_SCHEME[key][order]], @@color_name_table[bg_color]]}#{char}"
+        else
+          "#{COLOR_CODE}#{"%02d" % @@color_name_table[ORIGINAL_COLOR_SCHEME[key][order]]}#{char}"
+        end
+      }.join
+      self
+    end
+  end
+
   def bold
     add_code_l BOLD
   end

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+
 require 'rspec'
 require 'string-irc'
 
@@ -8,5 +9,4 @@ require 'string-irc'
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-  
 end

data/spec/string-irc_spec.rb

@@ -1,77 +1,58 @@
-# encoding: utf-8
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+# coding: utf-8
+require 'spec_helper'
 
 describe StringIrc do
-  share_examples_for 'when it first created' do
-    specify { should be_an_instance_of StringIrc }
-  end
-
-  context 'with an argument "hello"' do
-    subject { StringIrc.new('hello') }
-
-    it_should_behave_like 'when it first created' do
-      its(:to_s) { should == "hello\x0f" }
+  subject { StringIrc.new('hello') }
+
+  describe '#to_s' do
+    context 'when only foreground color passed in' do
+      StringIrc::COLOR_TABLE.each do |color, codes|
+        codes.each do |code|
+          context "foreground color: #{code}" do
+            it { expect(subject.send(code).to_s).to eq("\x03#{ "%02d" % color }hello\x0f") }
+          end
+        end
+      end
     end
 
-    context "single color" do
-      its("red.to_s")          { should == "\x0304hello\x0f" }
-      its("blue.to_s")         { should == "\x0302hello\x0f" }
-      its("blue_cyan.to_s")    { should == "\x0310hello\x0f" }
-      its("light_purple.to_s") { should == "\x0313hello\x0f" }
+    context 'when foreground color and background color are passed in' do
+      StringIrc::COLOR_TABLE.each do |color, codes|
+        codes.each do |code|
+          context "foreground color and background color: #{code}" do
+            it { expect(subject.send(code, code).to_s).to eq("\x03#{ "%02d" % color },#{ "%02d" % color }hello\x0f") }
+          end
+        end
+      end
     end
 
-    context "decoration" do
-      its("bold.to_s")      { should == "\x02hello\x0f" }
-      its("underline.to_s") { should == "\x1fhello\x0f" }
-      its("inverse.to_s")   { should == "\x16hello\x0f" }
+    context 'when colors are not passed in' do
+      it { expect(subject.to_s).to eq("hello\x0f") }
     end
+  end
 
-    context "complex" do
-      its("bold.yellow.to_s")                   { should == "\x0308\x02hello\x0f" }
-      its("bold.yellow.underline.to_s")         { should == "\x1f\x0308\x02hello\x0f" }
-      its("bold.yellow.underline.inverse.to_s") { should == "\x16\x1f\x0308\x02hello\x0f" }
+  context "when decorating method passed in" do
+    describe '#bold' do
+      it { expect(subject.bold.to_s).to eq("\x02hello\x0f") }
     end
 
-    context "complex" do
-      its("bold.yellow.to_s")                   { should == "\x0308\x02hello\x0f" }
-      its("bold.yellow.underline.to_s")         { should == "\x1f\x0308\x02hello\x0f" }
-      its("bold.yellow.underline.inverse.to_s") { should == "\x16\x1f\x0308\x02hello\x0f" }
+    describe '#underline' do
+      it { expect(subject.underline.to_s).to eq("\x1fhello\x0f") }
     end
 
-    context "bg-color" do
-      describe 'yellow("red").to_s' do
-        it { subject.yellow("red").to_s.should == "\x0308,04hello\x0f" }
-      end
-      describe 'red("yellow").to_s' do
-        it { subject.red("yellow").to_s.should == "\x0304,08hello\x0f" }
-      end
-      describe 'red("cyan").to_s' do
-        it { subject.red("cyan").to_s.should == "\x0304,11hello\x0f" }
-      end
+    describe '#inverse' do
+      it { expect(subject.inverse.to_s).to eq("\x16hello\x0f") }
     end
   end
 
-  context "without an argument" do
-    subject { StringIrc.new }
-
-    it_should_behave_like "when it first created" do
-      its(:to_s) { should == "\x0f" }
-    end
-
-    context "single color" do
-      its("red.to_s") { should == "\x0304\x0f" }
-    end
-
-    context "decoration" do
-      its("bold.to_s")      { should == "\x02\x0f" }
-      its("underline.to_s") { should == "\x1f\x0f" }
-      its("inverse.to_s")   { should == "\x16\x0f" }
+  context "when original color scheme method passed in" do
+    describe '#rainbow' do
+      it { expect(subject.rainbow.to_s).to eq("\x0304h\x0307e\x0308l\x0303l\x0302o\x0f") }
+      it { expect(subject.rainbow("black").to_s).to eq("\x0304,01h\x0307,01e\x0308,01l\x0303,01l\x0302,01o\x0f") }
     end
 
-    context "complex" do
-      its("bold.yellow.to_s")                   { should == "\x0308\x02\x0f" }
-      its("bold.yellow.underline.to_s")         { should == "\x1f\x0308\x02\x0f" }
-      its("bold.yellow.underline.inverse.to_s") { should == "\x16\x1f\x0308\x02\x0f" }
+    describe '#seven_eleven' do
+      it { expect(subject.seven_eleven.to_s).to eq("\x0307h\x0303e\x0304l\x0307l\x0303o\x0f") }
+      it { expect(subject.seven_eleven("black").to_s).to eq("\x0307,01h\x0303,01e\x0304,01l\x0307,01l\x0303,01o\x0f") }
     end
   end
 end

data/string-irc.gemspec

@@ -13,12 +13,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "string-irc"
   gem.require_paths = ["lib"]
-  gem.version       = "0.2.3"
+  gem.version       = "0.3.0"
 
   # dependencies
-  gem.add_development_dependency "rspec",   "~> 2.9.0"
-  gem.add_development_dependency "bundler", "~> 1.1.3"
-  gem.add_development_dependency 'rake',    '~> 0.9.2.2' # need for Travis CI
-  gem.add_development_dependency 'rdoc',    '~> 3.11'    # need for Travis CI
-  gem.add_runtime_dependency     "net-irc", "~> 0.0.9"
+  gem.add_runtime_dependency     "net-irc", ">= 0.0.9"
+  gem.add_development_dependency "rspec",   ">= 2.11.0"
+  gem.add_development_dependency 'rake',    '>= 0.9.2.2' # need for Travis CI
+  gem.add_development_dependency 'rdoc',    '>= 3.11'    # need for Travis CI
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: string-irc
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,60 +12,69 @@ cert_chain: []
 date: 2012-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70325208808020 !ruby/object:Gem::Requirement
+  name: net-irc
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.9.0
-  type: :development
+        version: 0.0.9
+  type: :runtime
   prerelease: false
-  version_requirements: *70325208808020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.9
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &70325207455720 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.1.3
+        version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70325207455720
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70325207449120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70325207449120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70325208828460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.11'
   type: :development
   prerelease: false
-  version_requirements: *70325208828460
-- !ruby/object:Gem::Dependency
-  name: net-irc
-  requirement: &70325208828000 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.0.9
-  type: :runtime
-  prerelease: false
-  version_requirements: *70325208828000
+        version: '3.11'
 description: add color codes for mIRC compatible client
 email:
 - ameutau@gmail.com
@@ -76,13 +85,13 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
-- VERSION
-- examples/client.rb
+- example/client.rb
 - lib/string-irc.rb
 - spec/spec_helper.rb
 - spec/string-irc_spec.rb
@@ -100,19 +109,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 131660736276985680
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 131660736276985680
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: add color codes for mIRC compatible client
 test_files:
 - spec/spec_helper.rb
 - spec/string-irc_spec.rb
-has_rdoc: 

data/VERSION

@@ -1 +0,0 @@
-0.1.3