iterm2_escape 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7bdf76a379df15ad8ca81c9a56d42bf7fd6ff3e
+  data.tar.gz: 4a7f80ce8687c1a88eddecf2e5e24688ef2e9fe7
+SHA512:
+  metadata.gz: a0ee772746dc60a32f212b6d768b72c7748945b608e1697ebd1569810b035702bc4416cc3739926915d945b7d01cf1f9a1a28814d8a93d361506ccf01eaf5751
+  data.tar.gz: 47f8004d0a7ea58a9a78750e626dcf16cf44ce56fdbb37281a4e5be535a0c760385c68e72de6ee526a85c0ec47fd07abb65045332a20b22e393f38fe04b7a497

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/.travis.yml

@@ -0,0 +1,7 @@
+before_install: gem install bundler -v 1.3.2
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in iterm2_escape.gemspec
+gemspec
+
+group :development, :test do
+  gem 'rspec', '~> 2.13'
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mark Rushakoff
+
+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.

data/README.md

@@ -0,0 +1,32 @@
+# Iterm2Escape
+
+[![Build Status](https://travis-ci.org/mark-rushakoff/iterm2_escape.png)](https://travis-ci.org/mark-rushakoff/iterm2_escape)
+[![Code Climate](https://codeclimate.com/github/mark-rushakoff/iterm2_escape.png)](https://codeclimate.com/github/mark-rushakoff/iterm2_escape)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'iterm2_escape'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iterm2_escape
+
+## Usage
+
+See the examples directory.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = %w(--format documentation --color)
+end
+
+task :default => :spec

data/examples/set_tab_color.rb

@@ -0,0 +1,5 @@
+require 'iterm2_escape'
+
+abort "Usage: #{$0} RED GREEN BLUE" unless ARGV.size == 3
+
+Iterm2Escape::Tab.set_color(*(ARGV.map(&:to_i)))

data/examples/set_titles.rb

@@ -0,0 +1,21 @@
+require 'iterm2_escape'
+require 'getoptlong'
+
+abort "Usage: #{$0} [--tab TABTITLE] [--window WINDOWTITLE] [--all ALLTITLE]" if ARGV.size == 0
+
+opts = GetoptLong.new(
+  ['--tab', '-t', GetoptLong::REQUIRED_ARGUMENT],
+  ['--window', '-w', GetoptLong::REQUIRED_ARGUMENT],
+  ['--all', '-a', GetoptLong::REQUIRED_ARGUMENT]
+)
+
+opts.each do |opt, arg|
+  case opt
+  when '--tab'
+    Iterm2Escape::Tab.title = arg
+  when '--window'
+    Iterm2Escape::Tab.window_title = arg
+  when '--all'
+    Iterm2Escape::Tab.all_titles = arg
+  end
+end

data/iterm2_escape.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iterm2_escape/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "iterm2_escape"
+  spec.version       = Iterm2Escape::VERSION
+  spec.authors       = ["Mark Rushakoff"]
+  spec.email         = ["mark.rushakoff@gmail.com"]
+  spec.description   = %q{A simple interface to iTerm2 proprietary escape codes.}
+  spec.summary       = <<-SUMMARY
+iterm2_escape provides a simple API to set:
+* tab chrome color
+* tab title
+* window title
+SUMMARY
+  spec.homepage      = "https://github.com/mark-rushakoff/iterm2_escape"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/iterm2_escape/tab_color.rb

@@ -0,0 +1,42 @@
+require 'iterm2_escape/writer'
+
+module Iterm2Escape
+  module Tab
+    class << self
+      # Sets the red level of the tab's chrome
+      #
+      # @param [Integer] red Red level (0-255) of the tab's chrome
+      def red=(red)
+        raise ArgumentError, "Value must be in range 0-255" unless (0..255).include?(red)
+        Writer.write "\033]6;1;bg;red;brightness;#{red}\a"
+      end
+
+      # Sets the green level of the tab's chrome
+      #
+      # @param [Integer] green Green level (0-255) of the tab's chrome
+      def green=(green)
+        raise ArgumentError, "Value must be in range 0-255" unless (0..255).include?(green)
+        Writer.write "\033]6;1;bg;green;brightness;#{green}\a"
+      end
+
+      # Sets the blue level of the tab's chrome
+      #
+      # @param [Integer] blue Blue level (0-255) of the tab's chrome
+      def blue=(blue)
+        raise ArgumentError, "Value must be in range 0-255" unless (0..255).include?(blue)
+        Writer.write "\033]6;1;bg;blue;brightness;#{blue}\a"
+      end
+
+      # Sets all the color levels of the tab's chrome
+      #
+      # @param [Integer] red Red level (0-255) of the tab's chrome
+      # @param [Integer] green Green level (0-255) of the tab's chrome
+      # @param [Integer] blue Blue level (0-255) of the tab's chrome
+      def set_color(red, green, blue)
+        self.red = red
+        self.green = green
+        self.blue = blue
+      end
+    end
+  end
+end

data/lib/iterm2_escape/tab_title.rb

@@ -0,0 +1,28 @@
+require 'iterm2_escape/writer'
+
+module Iterm2Escape
+  module Tab
+    class << self
+      # Sets the tab title
+      #
+      # @param [String] title What to use for the tab title
+      def title=(title)
+        Writer.write "\033]1;#{title}\a"
+      end
+
+      # Sets the window title
+      #
+      # @param [String] title What to use for the window title
+      def window_title=(title)
+        Writer.write "\033]2;#{title}\a"
+      end
+
+      # Sets both the tab and window titles
+      #
+      # @param [String] title What to use for the titles
+      def all_titles=(title)
+        Writer.write "\033]0;#{title}\a"
+      end
+    end
+  end
+end

data/lib/iterm2_escape/version.rb

@@ -0,0 +1,3 @@
+module Iterm2Escape
+  VERSION = "1.0.0"
+end

data/lib/iterm2_escape/writer.rb

@@ -0,0 +1,30 @@
+module Iterm2Escape
+  module Writer
+    class << self
+      # Writes the given message if appropriate
+      #
+      # @param [String] message to print to the target
+      # @param [IO] target where to write the message
+      def write(message, target = $stdout)
+        target.write(message) if should_write?(target)
+      end
+
+      # Identifies whether the environment says we should print control messages
+      #
+      # @param [IO] target where to check regarding writing the message
+      def should_write?(target = $stdout)
+        !is_suppressed? && is_iterm? && target.tty?
+      end
+
+      private
+      def is_suppressed?
+        !(ENV['SUPPRESS_ITERM2_ESCAPE_GEM'].nil? || ENV['SUPPRESS_ITERM2_ESCAPE_GEM'].empty?)
+      end
+
+      def is_iterm?
+        # seems like it doesn't *really* matter if we're on iTerm2 -- but let's play it safe
+        ENV['TERM_PROGRAM'] == 'iTerm.app'
+      end
+    end
+  end
+end

data/lib/iterm2_escape.rb

@@ -0,0 +1,6 @@
+require "iterm2_escape/version"
+require "iterm2_escape/tab_color"
+require "iterm2_escape/tab_title"
+
+module Iterm2Escape
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'iterm2_escape'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/tab_color_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Iterm2Escape::Tab do
+  shared_examples_for 'a color' do
+    let(:method) { (color.to_s + '=').to_sym }
+    it 'rejects values less than 0' do
+      expect {
+        Iterm2Escape::Tab.public_send(method, -1)
+      }.to raise_error(ArgumentError, /0-255/)
+    end
+
+    it 'rejects values more than 255' do
+      expect {
+        Iterm2Escape::Tab.public_send(method, 256)
+      }.to raise_error(ArgumentError, /0-255/)
+    end
+
+    it 'accepts values in between 0-255' do
+      Iterm2Escape::Writer.should_receive(:write).with(color_128_message)
+
+      Iterm2Escape::Tab.public_send(method, 128)
+    end
+  end
+
+  let(:color_128_message) { "\033]6;1;bg;#{color};brightness;128\a" }
+
+  describe '.red=' do
+    let(:color) { :red }
+    it_should_behave_like 'a color'
+  end
+
+  describe '.green=' do
+    let(:color) { :green }
+    it_should_behave_like 'a color'
+  end
+
+  describe '.blue=' do
+    let(:color) { :blue }
+    it_should_behave_like 'a color'
+  end
+
+  describe '.set_color' do
+    it 'delegates to red=, green=, blue=' do
+      # papayawhip, a particularly strange-named HTML color
+      Iterm2Escape::Tab.should_receive(:red=).with(255)
+      Iterm2Escape::Tab.should_receive(:green=).with(238)
+      Iterm2Escape::Tab.should_receive(:blue=).with(221)
+
+      Iterm2Escape::Tab.set_color(255, 238, 221)
+    end
+  end
+end

data/spec/tab_title_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Iterm2Escape::Tab do
+  it 'uses the right escape code for the tab title' do
+    Iterm2Escape::Writer.should_receive(:write).with("\033]1;my tab\a")
+    Iterm2Escape::Tab.title = 'my tab'
+  end
+
+  it 'uses the right escape code for the window title' do
+    Iterm2Escape::Writer.should_receive(:write).with("\033]2;my window\a")
+    Iterm2Escape::Tab.window_title = 'my window'
+  end
+
+  it 'uses the right escape code for setting all titles' do
+    Iterm2Escape::Writer.should_receive(:write).with("\033]0;everywhere\a")
+    Iterm2Escape::Tab.all_titles = 'everywhere'
+  end
+end

data/spec/version_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Iterm2Escape do
+  it "has a version" do
+    expect(Iterm2Escape::VERSION).not_to be_nil
+  end
+end

data/spec/writer_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Iterm2Escape::Writer do
+  describe '.should_write?' do
+    let(:subject) { Iterm2Escape::Writer.should_write? }
+
+    before do
+      ENV.stub(:[]).with('SUPPRESS_ITERM2_ESCAPE_GEM').and_return(nil)
+      ENV.stub(:[]).with('TERM_PROGRAM').and_return('iTerm.app')
+    end
+
+    shared_examples "will not write", will_write: false do
+      it "will not write" do
+        expect(subject).to eq(false)
+      end
+    end
+
+    describe 'when everything is lined up' do
+      it 'will write' do
+        expect(subject).to eq(true)
+      end
+    end
+
+    describe 'when it is not iTerm2', will_write: false do
+      before { ENV.stub(:[]).with('TERM_PROGRAM').and_return('Apple_Terminal') }
+    end
+
+    describe 'when $SUPPRESS_ITERM2_ESCAPE_GEM is set', will_write: false do
+      before { ENV.stub(:[]).with('SUPPRESS_ITERM2_ESCAPE_GEM').and_return('1') }
+    end
+
+    describe 'when $stdout is not a TTY', will_write: false do
+      before { $stdout.stub(:tty?).and_return(false) }
+    end
+  end
+
+  describe '.write' do
+    describe 'when .should_write? is true' do
+      before { Iterm2Escape::Writer.stub(:should_write?).and_return(true) }
+      it 'writes to $stdout by default' do
+        $stdout.should_receive(:write).with('Hi')
+        Iterm2Escape::Writer.write('Hi')
+      end
+
+      it 'writes to the target arg if provided' do
+        target = double('target')
+        target.should_receive(:write).with('Hello')
+        Iterm2Escape::Writer.write('Hello', target)
+      end
+    end
+
+    describe 'when .should_write? is false' do
+      before { Iterm2Escape::Writer.stub(:should_write?).and_return(false) }
+      it 'does not write' do
+        target = double('target')
+        target.should_not_receive(:write)
+        Iterm2Escape::Writer.write('Hi', target)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: iterm2_escape
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mark Rushakoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: A simple interface to iTerm2 proprietary escape codes.
+email:
+- mark.rushakoff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/set_tab_color.rb
+- examples/set_titles.rb
+- iterm2_escape.gemspec
+- lib/iterm2_escape.rb
+- lib/iterm2_escape/tab_color.rb
+- lib/iterm2_escape/tab_title.rb
+- lib/iterm2_escape/version.rb
+- lib/iterm2_escape/writer.rb
+- spec/spec_helper.rb
+- spec/tab_color_spec.rb
+- spec/tab_title_spec.rb
+- spec/version_spec.rb
+- spec/writer_spec.rb
+homepage: https://github.com/mark-rushakoff/iterm2_escape
+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.0.2
+signing_key: 
+specification_version: 4
+summary: 'iterm2_escape provides a simple API to set: * tab chrome color * tab title
+  * window title'
+test_files:
+- spec/spec_helper.rb
+- spec/tab_color_spec.rb
+- spec/tab_title_spec.rb
+- spec/version_spec.rb
+- spec/writer_spec.rb