luck 0.0.0

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.yardoc
+doc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Daniel Danopia
+
+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,21 @@
+Luck
+====
+
+Luck is a ncurses-like CLI UI system, written in pure Ruby.
+
+The origin of the name is that it is the opposite of "curses".
+
+Luck was developed for [Remora](http://github.com/danopia/remora) but
+any application can use it now that I packaged it as a gem.
+
+
+Usage
+-----
+
+TODO
+
+
+Copyright
+---------
+
+Copyright (c) 2010 Daniel Danopia. See {file:LICENSE} for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "luck"
+    gem.summary = %Q{Pure-ruby CLI UI system}
+    gem.description = %Q{Pure-ruby CLI UI system. Includes multiple panes in a display and multiple controls in a pane. luck is lucky (as opposed to ncurses being cursed)}
+    gem.email = "me.github@danopia.net"
+    gem.homepage = "http://github.com/danopia/luck"
+    gem.authors = ["Daniel Danopia"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+#~ require 'rake/testtask'
+#~ Rake::TestTask.new(:test) do |test|
+  #~ test.libs << 'lib' << 'test'
+  #~ test.pattern = 'test/**/*_test.rb'
+  #~ test.verbose = true
+#~ end
+
+#~ begin
+  #~ require 'rcov/rcovtask'
+  #~ Rcov::RcovTask.new do |test|
+    #~ test.libs << 'test'
+    #~ test.pattern = 'test/**/*_test.rb'
+    #~ test.verbose = true
+  #~ end
+#~ rescue LoadError
+  #~ task :rcov do
+    #~ abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  #~ end
+#~ end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  YARD::Rake::YardocTask.new do |t|
+    extra_files = %w(LICENSE)
+    t.files = ['lib/**/*.rb']
+    t.options = ["--files=#{extra_files.join(',')}"]
+  end
+rescue LoadError
+  task :yard do
+    abort "YARD is not available. In order to run yard, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/luck/control.rb

@@ -0,0 +1,35 @@
+module Luck
+class Control
+  attr_accessor :pane, :display, :x1, :y1, :x2, :y2
+  
+  def initialize pane, x1, y1, x2, y2, &blck
+    @pane = pane
+    @display = pane.display
+    @x1, @y1 = x1, y1
+    @x2, @y2 = x2, y2
+    
+    instance_eval &blck if blck
+  end
+  
+  def x1
+    @pane.x1 + ((@x1 < 0) ? (@pane.width + @x1) : @x1)
+  end
+  def y1
+    @pane.y1 + ((@y1 < 0) ? (@pane.height + @y1) : @y1)
+  end
+  
+  def x2
+    @pane.x1 + ((@x2 < 0) ? (@pane.width + @x2 + 1) : @x2)
+  end
+  def y2
+    @pane.y1 + ((@y2 < 0) ? (@pane.height + @y2 + 1) : @y2)
+  end
+  
+  def width
+    x2 - x1
+  end
+  def height
+    y2 - y1
+  end
+end
+end

data/lib/luck/display.rb

@@ -0,0 +1,160 @@
+module Luck
+class Display
+  attr_accessor :width, :height, :client, :panes, :buffer, :dirty, :active_control
+  
+  def initialize client
+    @client = client
+    @panes = {}
+    @dirty = true
+    prepare_modes
+    
+    size = terminal_size
+    @width = size[1]
+    @height = size[0]
+  end
+  
+  def pane name, *args, &blck
+    @panes[name] = Pane.new(self, *args, &blck)
+  end
+  
+  def place row, col, text
+    print "\e[#{row.to_i};#{col.to_i}H#{text}"
+  end
+  def color codes
+    "\e[#{codes}m"
+  end
+  
+  def cursor=(show)
+    print "\e[?25h" if show
+    print "\e[?25l" unless show
+    $stdout.flush
+  end
+  
+  def dirty! pane=nil
+    if pane && @dirty.is_a?(Array) && !(@dirty.include?(pane))
+      @dirty << pane
+    elsif pane && !@dirty
+      @dirty = [pane]
+    elsif !pane
+      @dirty = true
+    end
+  end
+  
+  def handle
+    handle_stdin
+    
+    size = terminal_size
+    if @width != size[1] || @height != size[0]
+      @width = size[1]
+      @height = size[0]
+      dirty!
+    end
+    
+    return unless @dirty
+    redraw @dirty
+    @dirty = false
+  end
+  
+  def redraw panes=true
+    print "\e[H\e[J" if panes == true # clear all and go home
+    self.cursor = active_control
+    
+    panes = @panes.keys if panes == true
+    
+    panes.each do |key|
+      @panes[key].redraw
+    end
+    print "\e[u"
+    
+    $stdout.flush
+  end
+  
+  def handle_stdin
+    $stdin.read_nonblock(1024).each_char do |chr|
+      active_control.handle_char chr if active_control
+      #~ if chr == "\n"
+        #~ next if @buffer.empty?
+        #~ 
+        #~ if @buffer.to_i.to_s == @buffer && @results
+          #~ index = @buffer.to_i - 1
+          #~ next if index < 0 || index > @results.size
+          #~ 
+          #~ song = @results[index]
+          #~ @client.queue << song
+          #~ 
+          #~ unless @client.now_playing
+            #~ Thread.new do
+              #~ @client.queue.play_radio
+            #~ end
+          #~ end
+          #~ 
+          #~ @buffer = ''
+          #~ panes[:main].data[0] = @buffer.empty? ? (@search || '') : ''
+          #~ self.cursor = false
+        #~ else
+          #~ @search = @buffer
+          #~ @results = @client.search_songs(@search)['Return']
+          #~ panes[:main].data = @results.map do |result|
+            #~ "#{(@results.index(result)+1).to_s.rjust 2}) #{result['Name']} - #{result['ArtistName']} - #{result['AlbumName']}"
+          #~ end
+          #~ panes[:main].data.unshift @search
+          #~ panes[:main].title = "Search Results for #{@search}"
+#~ 
+          #~ @buffer = ''
+          #~ self.cursor = false
+        #~ end
+      #~ else
+      #~ @buffer << chr
+      #~ @buffer.gsub!(/.\177/, '')
+      #~ @buffer.gsub!("\177", '')
+      #~ panes[:main].data[0] = @buffer.empty? ? (@search || '') : ''
+      #~ self.cursor = !(@buffer.empty?)
+      #~ end
+    end
+    
+    self.cursor = active_control
+    $stdout.flush
+    
+  rescue Errno::EAGAIN
+  rescue EOFError
+  end
+  
+  ######################################
+  # this is all copied from cashreg :P #
+  ######################################
+
+  # yay grep
+  TIOCGWINSZ = 0x5413
+  TCGETS = 0x5401
+  TCSETS = 0x5402
+  ECHO   = 8 # 0000010
+  ICANON = 2 # 0000002
+
+  # thanks google for all of this
+  def terminal_size
+    rows, cols = 25, 80
+    buf = [0, 0, 0, 0].pack("SSSS")
+    if $stdout.ioctl(TIOCGWINSZ, buf) >= 0 then
+      rows, cols, row_pixels, col_pixels = buf.unpack("SSSS")
+    end
+    return [rows, cols]
+  end
+
+  # had to convert these from C... fun
+  def prepare_modes
+    buf = [0, 0, 0, 0, 0, 0, ''].pack("IIIICCA*")
+    $stdout.ioctl(TCGETS, buf)
+    @old_modes = buf.unpack("IIIICCA*")
+    new_modes = @old_modes.clone
+    new_modes[3] &= ~ECHO # echo off
+    new_modes[3] &= ~ICANON # one char @ a time
+    $stdout.ioctl(TCSETS, new_modes.pack("IIIICCA*"))
+    self.cursor = false
+  end
+  def undo_modes # restore previous terminal mode
+    $stdout.ioctl(TCSETS, @old_modes.pack("IIIICCA*"))
+    print "\e[2J\e[H" # clear all and go home
+    self.cursor = true # show the mouse
+  end
+end
+end

data/lib/luck/label.rb

@@ -0,0 +1,46 @@
+module Luck
+class Label < Control
+  attr_accessor :alignment, :text
+  
+  def initialize *args
+    @alignment = :left
+    @text = 'Label'
+    super
+  end
+  
+  def align direction
+    @alignment = direction
+  end
+  
+  def align_text text
+    case @alignment
+      when :center
+        text.center width
+      when :right
+        text.rjust width
+      else
+        text.ljust width
+    end
+  end
+  
+  def redraw
+    if text.empty?
+      @display.place y1, x1, ' ' * width
+      return
+    end
+    
+    row = y1
+    text.each_line do |line|
+      line.chomp!
+      length = line.size
+      offset = 0
+      while offset < width || offset == 0
+        @display.place row, x1, align_text(line[offset, width])
+        row += 1
+        offset += width
+        return if row >= y2
+      end
+    end
+  end
+end
+end

data/lib/luck/listbox.rb

@@ -0,0 +1,33 @@
+module Luck
+class ListBox < Control
+  attr_accessor :data, :numbering, :hanging_indent
+  
+  def initialize *args
+    @data = []
+    @hanging_indent = 0
+    super
+  end
+  
+  def number!
+    @numbering = true
+    @hanging_indent = 4
+  end
+  
+  def redraw
+    row = y1
+    data.first(height).each_with_index do |line, index|
+      line = line.to_s
+      line = "#{(index + 1).to_s.rjust 2}. #{line}" if @numbering
+      length = line.size
+      offset = 0
+      while offset < length || offset == 0
+        @display.place row, x1 + ((offset > 0) ? @hanging_indent : 0), line[offset, width - ((offset > 0) ? @hanging_indent : 0)]
+        row += 1
+        offset += width - ((offset > 0) ? @hanging_indent : 0)
+        break if row >= y2
+      end
+      break if row >= y2
+    end
+  end
+end
+end

data/lib/luck/pane.rb

@@ -0,0 +1,76 @@
+module Luck
+class Pane
+  attr_accessor :display, :x1, :y1, :x2, :y2, :title, :controls
+  
+  def initialize display, x1, y1, x2, y2, title, controls={}, &blck
+    @display = display
+    @x1, @y1 = x1, y1
+    @x2, @y2 = x2, y2
+    @title, @controls = title, controls
+    
+    instance_eval &blck if blck
+  end
+  
+  def control name, type, *args, &blck
+    @controls[name] = type.new(self, *args, &blck)
+  end
+  
+  def x1
+    (@x1 < 0) ? (@display.width + @x1 + 1) : @x1
+  end
+  def y1
+    (@y1 < 0) ? (@display.height + @y1 + 1) : @y1
+  end
+  
+  def x2
+    (@x2 < 0) ? (@display.width + @x2 + 1) : @x2
+  end
+  def y2
+    (@y2 < 0) ? (@display.height + @y2 + 1) : @y2
+  end
+  
+  def width
+    x2 - x1
+  end
+  def height
+    y2 - y1
+  end
+  
+  def redraw
+    draw_frame
+    draw_contents
+  end
+  
+  def draw_contents
+    controls.each_value do |control|
+      control.redraw
+    end
+  end
+  
+  def topbar
+    title = " * #{@title} * "
+    left = (((width - 1).to_f / 2) - (title.size.to_f / 2)).to_i
+
+    if title.size >= width
+      "#{@display.color '1;34'} #{@title[0, width - 3].center(width - 3)} #{@display.color '0;2'}"
+    else
+      title_colored = "#{@display.color '1;34'}#{title}#{@display.color '0;2'}"
+      ('-' * left) + title_colored + ('-' * (width - 1 - title.size - left))
+    end
+  end
+
+  def draw_frame
+    bottombar = '-' * (width - 1)
+    fillerbar = ' ' * (width - 1)
+
+    print @display.color('0;2')
+    @display.place y1, x1, "+#{topbar}+"
+    @display.place y2, x1, "+#{bottombar}+"
+
+    (y1 + 1).upto y2 - 1 do |row|
+      @display.place row, x1, "|#{fillerbar}|"
+    end
+    print @display.color('0')
+  end
+end
+end

data/lib/luck/progressbar.rb

@@ -0,0 +1,53 @@
+module Luck
+class ProgressBar < Control
+  attr_accessor :maximum, :value, :precap, :bar, :arrow, :blank, :postcap
+  
+  def initialize *args
+    @maximum = 1
+    @value = 0
+    @precap = '['
+    @bar = '='
+    @arrow = '>'
+    @blank = ' '
+    @postcap = ']'
+    super
+  end
+  
+  def percentage
+    @value.to_f / @maximum.to_f
+  end
+  
+  def template str
+    @precap, @bar, @arrow, @blank, @postcap = str.unpack 'aaaaa'
+  end
+  
+  def redraw
+    @display.place y1, x1, @precap + (@bar * (percentage * (width - @precap.size - @postcap.size)) + @arrow).ljust(width - @precap.size - @postcap.size, @blank) + @postcap
+  end
+end
+
+class DoubleProgressBar < ProgressBar
+  attr_accessor :maximum2, :value2, :bar2, :arrow2
+  
+  def initialize *args
+    @maximum2 = 1
+    @value2 = 0
+    @bar2 = '-'
+    @arrow2 = '>'
+    super
+  end
+  
+  def percentage2
+    @value2.to_f / @maximum2.to_f
+  end
+  
+  def template str
+    @precap, @bar2, @arrow2, @bar, @arrow, @blank, @postcap = str.unpack 'aaaaaaa'
+  end
+  
+  def redraw
+    super
+    @display.place y1, x1, @precap + (@bar2 * (percentage2 * (width - @precap.size - @postcap.size)) + @arrow2)
+  end
+end
+end

data/lib/luck/textbox.rb

@@ -0,0 +1,46 @@
+module Luck
+class TextBox < Label
+  attr_accessor :multiline, :handler, :label
+  
+  def initialize *args
+    @label = ''
+    @text = 'Input box'
+    super
+  end
+  
+  def redraw
+    super
+    
+    case @alignment
+      when :center
+        text.center width
+      when :right
+        text.rjust width
+      else
+        @display.place y1, x1 + text.size, "\e[s"
+    end
+    #print "\e[s" # save
+  end
+  
+  def on_submit &blck
+    @handler = blck
+  end
+  
+  def text
+    return @text if @label.empty?
+    "#{@label}: #{@text}"
+  end
+  
+  def handle_char char
+    if char == "\n" && !@multiline
+      @handler.call @text if @handler
+      @text = ''
+    elsif char == "\177"
+      @text.slice! -1
+    else
+      @text += char
+    end
+    redraw
+  end
+end
+end

data/lib/luck.rb

@@ -0,0 +1,9 @@
+Luck = Module.new
+
+require 'luck/display'
+require 'luck/pane'
+require 'luck/control'
+require 'luck/listbox'
+require 'luck/progressbar'
+require 'luck/label'
+require 'luck/textbox'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: luck
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Daniel Danopia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-07 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Pure-ruby CLI UI system. Includes multiple panes in a display and multiple controls in a pane. luck is lucky (as opposed to ncurses being cursed)
+email: me.github@danopia.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/luck.rb
+- lib/luck/control.rb
+- lib/luck/display.rb
+- lib/luck/label.rb
+- lib/luck/listbox.rb
+- lib/luck/pane.rb
+- lib/luck/progressbar.rb
+- lib/luck/textbox.rb
+has_rdoc: true
+homepage: http://github.com/danopia/luck
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Pure-ruby CLI UI system
+test_files: []
+