ripl-rocket 0.1.0

data/.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems' unless defined? Gem
+require File.dirname(__FILE__) + "/lib/ripl/rocket"
+ 
+Gem::Specification.new do |s|
+  s.name        = "ripl-rocket"
+  s.version     = Ripl::Rocket::VERSION
+  s.authors     = ["Jan Lelis"]
+  s.email       = "mail@janlelis.de"
+  s.homepage    = "http://github.com/janlelis/ripl-rocket"
+  s.summary     = "Rocketize your ripl output."
+  s.description = "Lets you display the ripl result as a comment on the same line."
+  s.required_rubygems_version = ">= 1.3.6"
+  s.add_dependency 'ripl', '>= 0.3.0'
+  s.add_dependency 'unicode-display_width', '>= 0.1.1'
+  s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc} ext/**/*.{rb,c} **/deps.rip]) + %w{Rakefile .gemspec}
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
+  s.license = 'MIT'
+end

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+== 0.1.0
+* Initial release.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT LICENSE
+
+Copyright (c) 2011 Jan Lelis
+
+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,35 @@
+== Description
+This {ripl}[http://github.com/cldwalker/ripl] plugin lets you output your result as a comment (using the #=> rocket).
+
+== Install
+Install the gem with:
+
+  gem install ripl-colorize_output
+
+== Usage
+
+Add to your <tt>~/.riplrc</tt>
+
+  require 'ripl/rocket'
+
+== Configuration
+
+There is a <tt>Ripl.config[:rocket_mode]</tt> setting. If it is set to </tt>false</tt>, the rocket is not used.
+
+The default option is <tt>:auto</tt>, which means the rocket will be used, if there is enough space on the last line and there has not been too much standard output.
+
+Set it to any other true value and the plugin will always use the rocket.
+
+You can change the rocket prompt with <tt>Ripl.config[:rocket_prompt]</tt> and set a color with <tt>Ripl.config[:rocket_color]</tt>
+
+== Bugs / TODO
+
+Input methods are currently not supported.
+
+== Copyright
+
+Thanks to genki for the original idea :).
+
+Copyright (c) 2011 Jan Lelis <http://rbjl.net> released under the MIT license.
+
+J-_-L

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rake'
+require 'fileutils'
+
+def gemspec
+  @gemspec ||= eval(File.read('.gemspec'), binding, '.gemspec')
+end
+
+desc "Build the gem"
+task :gem => :gemspec do
+  sh "gem build .gemspec"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version} --no-rdoc --no-ri}
+end
+
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
+end
+
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
+end

data/deps.rip

@@ -0,0 +1,2 @@
+ripl >=0.3.0
+unicode-display_width >=0.1.1

data/lib/ripl/rocket.rb

@@ -0,0 +1,117 @@
+require 'ripl'
+require 'unicode/display_width'
+
+module Ripl
+  module Rocket
+    VERSION = '0.1.0'
+
+    TPUT = {
+      :sc   => `tput sc`,
+      :rc   => `tput rc`,
+      :cuu1 => `tput cuu1`,
+      :cuf1 => `tput cuf1`,
+    }
+
+    COLORS = {
+      :nothing      => '0;0',
+      :black        => '0;30',
+      :red          => '0;31',
+      :green        => '0;32',
+      :brown        => '0;33',
+      :blue         => '0;34',
+      :purple       => '0;35',
+      :cyan         => '0;36',
+      :light_gray   => '0;37',
+      :dark_gray    => '1;30',
+      :light_red    => '1;31',
+      :light_green  => '1;32',
+      :yellow       => '1;33',
+      :light_blue   => '1;34',
+      :light_purple => '1;35',
+      :light_cyan   => '1;36',
+      :white        => '1;37',
+    }
+
+    class << self
+      def reset_output_height
+        @height_counter = []
+      end
+
+      def get_height(data)
+        lines      = data.to_s.count("\n")
+        long_lines = data.to_s.split("\n").inject(0){ |sum, line|
+          sum + (line.display_size / `tput cols`.to_i)
+        }
+        lines + long_lines
+      end
+
+      def track_output_height(data)
+        @height_counter ||= []
+        @height_counter << get_height(data)
+      end
+
+      def output_height
+        1 + ( @height_counter == [0] ? 0 : @height_counter.reduce(:+) || 0 )
+      end
+    end
+
+    module Shell
+      def loop_eval(input)
+        Ripl::Rocket.reset_output_height
+        super
+      end
+
+      def print_result(result)
+        return if @error_raised
+        if config[:rocket_mode]
+          # get important data
+          screen_length = `tput cols`.to_i
+          screen_height = `tput lines`.to_i
+          last_line_without_prompt = @input.split("\n").last || ''
+          offset = (last_line_without_prompt.display_size + prompt.display_size ) % screen_length.to_i
+          output_length = result.inspect.display_size
+          rocket_length = config[:rocket_prompt].display_size
+          stdout_height  = Ripl::Rocket.output_height
+          color_config = config[:rocket_color]
+          color_code   = !color_config || color_config.to_s[/^[\d;]+$/] ?
+            color_config : Ripl::Rocket::COLORS[color_config.to_sym]
+          colored_rocket = color_code ? "\e[#{ color_code }m#{ config[:rocket_prompt] }\e[0;0m"
+                                      : config[:rocket_prompt]
+
+          # auto rocket mode:  only display rocket if line has enough space left
+          line_too_long   = screen_length <= offset + rocket_length + output_length
+          height_too_long = stdout_height >= screen_height
+          if !(config[:rocket_mode] == :auto && ( line_too_long || height_too_long ) )
+            if !height_too_long
+              print TPUT[:sc] +                   # save cursor position
+                    TPUT[:cuu1]*stdout_height +   # move cursor upwards    to the original input line
+                    TPUT[:cuf1]*offset +          # move cursor rightwards to the original input offset
+                    colored_rocket +              # draw rocket prompt
+                    format_result(result).sub( /^#{result_prompt}/, '' ) +         # draw result (without prompt)
+                    TPUT[:rc] +                   # restore cursor position
+                    ( config[:rocket_mode] != :auto && line_too_long  ? "\n" : '') # add a line for always-rocket mode
+
+            else # too much stdout, but in "always rocket mode"
+              puts colored_rocket +              # draw rocket prompt
+                   format_result(result).sub( /^#{result_prompt}/, '' )            # draw result (without prompt)
+            end
+            return
+          end
+        end
+        # else: no rocket ;)
+        super
+      end
+    end
+
+    # load stream extensions
+    require File.dirname(__FILE__) + "/rocket/stream_ext"
+  end
+end
+
+Ripl::Shell.include Ripl::Rocket::Shell
+
+Ripl.config[:rocket_mode]     = :auto  if Ripl.config[:rocket_mode].nil?
+Ripl.config[:rocket_prompt] ||= " #=> "
+Ripl.config[:rocket_color]  ||= :blue
+
+# J-_-L

data/lib/ripl/rocket/stream_ext.rb

@@ -0,0 +1,18 @@
+# hook into streams to count lines used in stdout
+class << $stdout
+  alias write_without_rocket write
+  def write(data)
+    Ripl::Rocket.track_output_height data
+    write_without_rocket data
+  end
+end
+
+class << $stderr
+  alias write_without_rocket write
+  def write(data)
+    Ripl::Rocket.track_output_height data
+    write_without_rocket data
+  end
+end
+
+# J-_-L

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: ripl-rocket
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jan Lelis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ripl
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: unicode-display_width
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id002
+description: Lets you display the ripl result as a comment on the same line.
+email: mail@janlelis.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE.txt
+files: 
+- lib/ripl/rocket/stream_ext.rb
+- lib/ripl/rocket.rb
+- LICENSE.txt
+- README.rdoc
+- CHANGELOG.rdoc
+- deps.rip
+- Rakefile
+- .gemspec
+has_rdoc: true
+homepage: http://github.com/janlelis/ripl-rocket
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rocketize your ripl output.
+test_files: []
+