tabscroll 0.0.1 → 1.0.1

data/README.md

@@ -0,0 +1,73 @@
+# tabscroll - Neat guitar tab scroller.
+
+`tabscroll` is a (Ruby-powered) guitar tab scroller on the terminal.
+
+It supports forward and backwards auto-scrolling and currently
+reads a nice range of guitar tabs.
+
+## Usage and Screenshots
+
+    $ tabscroll my-guitar-tab.txt
+
+Running on a small terminal
+![big screen](http://www.alexdantas.net/projects/tabscroll/screenshots/screen1.png "Small Screen")
+
+The help window on a big screen
+![big screen](http://www.alexdantas.net/projects/tabscroll/screenshots/screen2.png "Big Screen")
+
+## Guitar tab file format and troubleshooting
+
+`tabscroll` only works with textual guitar tabs, not chords with lyrics.
+
+It attempts to read any kind of tab format (although it works better with tabs
+exported from _Guitar Pro_). For now it requires you to split each tab row with
+a blank line. For example, this would work:
+
+      E  S S S S S  S Q    S S S S    E  S S S S S  S E  S S S S S  S
+    --0--------0------0----L---0-1-|--0----------0h-1-0----------0h-1-|
+    --1----------0h-1-1----L-1-----|--1----1----------1----1----------|
+    ------------------0----L-------|--2--2-----2------0--0-----0------|
+    -----0-2----------2----L-------|--3------3--------2------2--------|
+    --3------3--------3----L-------|----------------------------------|
+    -------------------------------|----------------------------------|
+
+      E  S S S S S S E  S S S S  S S    E  S S S S S  S E  S S S S S  S
+    --0----3---0-----5--3---0------0-|--L----------0h-1-0----------3p-1-|
+    --1----------1-3-0--------3p-0---|--1----1----------1----1----------|
+    --2--2---2-------0----0----------|--2--2-----2------0--0-----0------|
+    ---------------------------------|--3------3--------2------2--------|
+    --0------------------------------|----------------------------------|
+    -----------------3------3--------|----------------------------------|
+
+But this wouldn't:
+
+    --0--------0------0----L---0-1-|--0----------0h-1-0----------0h-1-|
+    --1----------0h-1-1----L-1-----|--1----1----------1----1----------|
+    ------------------0----L-------|--2--2-----2------0--0-----0------|
+    -----0-2----------2----L-------|--3------3--------2------2--------|
+    --3------3--------3----L-------|----------------------------------|
+    -------------------------------|----------------------------------|
+    --0----3---0-----5--3---0------0-|--L----------0h-1-0----------3p-1-|
+    --1----------1-3-0--------3p-0---|--1----1----------1----1----------|
+    --2--2---2-------0----0----------|--2--2-----2------0--0-----0------|
+    ---------------------------------|--3------3--------2------2--------|
+    --0------------------------------|----------------------------------|
+    -----------------3------3--------|----------------------------------|
+
+So if something bad happens and the program crashes, edit the tab making sure to
+keep a consistent tab format (6 in 6 lines, or 5 in 5) each with a blank line
+inbetween.
+
+At worse, please comment (add `#` at the start of) any line that's not the tab
+(you know, author info, instructions, etc). Sorry for the inconvenience, I plan
+to improve a lot the detection of tabs on the future.
+
+## Contact
+
+Hi, I'm Alexandre Dantas! Thanks for having interest in this project. Please
+take the time to visit any of the links below.
+
+* `tabscroll` homepage: http://www.alexdantas.net/projects/tabscroll
+* Contact: `eu @ alexdantas.net`
+* My homepage: http://www.alexdantas.net
+

data/bin/tabscroll

@@ -2,71 +2,17 @@
 #
 # The main `tabscroll` executable
 
-require 'tabscroll'
+# Is this considered ugly?
+require_relative '../lib/tabscroll'
+require_relative '../lib/tabscroll/settings'
 
-begin
-  filename = ARGV[0]
-  if not filename
-    puts "Usage:"
-    puts "	$ #{PROGRAM_NAME} (filename)"
-    exit 666
-  end
-
-  $engine = Engine.new
-  if not $engine
-    puts 'Failed to start curses!'
-    exit 1337
-  end
-  $engine.timeout 10
-
-  win = Screen.new(0, 1, $engine.width, $engine.height - 2)
-  track = Track.new win
-  track.load filename
-  track.auto_scroll true
-
-  titlebar  = Screen.new(0, 0, $engine.width, 1)
-  statusbar = Screen.new(0, ($engine.height - 1), $engine.width, 1)
+# class TabScroll expects this hash, watch out!
+$settings = {}
 
-  bars_hidden = false
-  finished = false
-  while not finished
-    # WHY DOES GETCH CLEARS UP THE WHOLE SCREEN?
-    # IT DOESNT MAKE ANY SENSE
-    c = $engine.getchar
-    case c
-    when 'e'
-      track.end
-    when 'a'
-      track.begin
-    when 'h'
-      show_help_window
-    when 'o'
-      bars_hidden = (bars_hidden ? false : true)
-      Curses::clear
-    when '<'
-      track.scroll -5
-    when '>'
-      track.scroll 5
-    when Curses::KEY_LEFT
-      track.speed -= 1
-    when Curses::KEY_RIGHT
-      track.speed += 1
-    when Curses::KEY_DOWN, Curses::KEY_UP
-      track.speed = 0
-    when 'q'
-      quit
-    end
-
-    track.update
-    track.show
-    if not bars_hidden
-      titlebar.mvaddstr(0, 0, "#{filename} (#{track.percent_completed}%) ", Engine::Colors[:cyan])
-      titlebar.mvaddstr_right(0, "  Speed: #{track.speed}", Engine::Colors[:cyan])
-
-      statusbar.mvaddstr_left(0, "#{PROGRAM_NAME} v#{PROGRAM_VERSION} - press `h` for help", Engine::Colors[:green])
-    end
-  end
+begin
+  $settings = Settings.new
+  $settings.parse ARGV
 
-  quit
+  TabScroll::run $settings[:filename]
 end
 

metadata

@@ -1,16 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: tabscroll
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Alexandre Dantas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-13 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies: []
-description: Scrolls a textual guitar tab on the terminal.
+description: |
+  Scrolls a textual guitar tab on the terminal.
+  It supports forward and backwards auto-scrolling and currently
+  reads a nice range of guitar tabs.
 email:
 - eu@alexdantas.net
 executables:
@@ -18,17 +21,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/tabscroll.rb
-- lib/tabscroll/engine.rb
-- lib/tabscroll/screen.rb
-- lib/tabscroll/track.rb
-- lib/tabscroll/popup.rb
-- lib/tabscroll/timer.rb
 - bin/tabscroll
+- LICENSE
+- README.md
+- CHANGELOG.md
 homepage: http://www.alexdantas.net/projects/tabscroll
 licenses:
 - GPL-3.0
-metadata: {}
+metadata:
+  github: http://www.github.com/alexdantas/tabscroll
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/tabscroll.rb

@@ -1,40 +0,0 @@
-# The main executable file.
-
-require_relative 'tabscroll/engine'
-require_relative 'tabscroll/screen'
-require_relative 'tabscroll/track'
-require_relative 'tabscroll/popup'
-
-# Global vars
-$engine = nil
-PROGRAM_NAME    = "tabscroll"
-PROGRAM_VERSION = "0.0.1"
-
-# Terminates program's execution normally, finishing the engine.
-def quit
-  $engine.exit
-  exit 0
-end
-
-# Displays a help window, waiting for a keypress.
-def show_help_window
-  title = 'Help'
-  text  = <<END_OF_TEXT
-         q  quit
-         h  help/go back
-left/right  auto-scroll left/right
-   up/down  stop auto-scrolling
-       </>  step scroll left/right
-         o  toggle status/title bars
-
-
-#{PROGRAM_NAME} v#{PROGRAM_VERSION}
-homepage  alexdantas.net/projects/tabscroll
-author    Alexandre Dantas <eu@alexdantas.net>
-END_OF_TEXT
-
-  pop = Popup.new(title, text)
-  will_quit = pop.show
-  quit if will_quit
-end
-

data/lib/tabscroll/engine.rb

@@ -1,95 +0,0 @@
-
-require 'curses'
-
-# The main interface with Curses.
-#
-# This acts as a middleman, abstracting away curses' details.
-class Engine
-
-  # All possible colors.
-  Colors = {
-    :black   => 1,
-    :white   => 2,
-    :red     => 3,
-    :yellow  => 4,
-    :magenta => 5,
-    :blue    => 6,
-    :green   => 7,
-    :cyan    => 8
-  }.freeze
-
-  # Initializes Ncurses with minimal +width+ and +height+.
-  #
-  def initialize(min_width=nil, min_height=nil)
-    @has_colors = nil
-
-    @screen = Curses::init_screen
-    return nil if not @screen
-
-    if min_width and min_height
-      cur_width  = @screen.maxx
-      cur_height = @screen.maxy
-
-      if cur_width < @width or cur_height < @height
-        self.exit
-        $stderr << "Error: Screen size too small (#{cur_width}x#{cur_height})\n"
-        $stderr << "Please resize your terminal to at least #{@width}x#{@height}\n"
-        return nil
-      end
-    end
-
-    @has_colors = Curses.has_colors?
-    if @has_colors
-      Curses.start_color
-      Curses.use_default_colors # will use default background
-
-      # Initializes:   constant          foreground             bg
-      Curses.init_pair(Colors[:white],   Curses::COLOR_BLACK,   -1)
-      Curses.init_pair(Colors[:blue],    Curses::COLOR_BLUE,    -1)
-      Curses.init_pair(Colors[:red],     Curses::COLOR_RED,     -1)
-      Curses.init_pair(Colors[:green],   Curses::COLOR_GREEN,   -1)
-      Curses.init_pair(Colors[:magenta], Curses::COLOR_MAGENTA, -1)
-      Curses.init_pair(Colors[:yellow],  Curses::COLOR_YELLOW,  -1)
-      Curses.init_pair(Colors[:cyan],    Curses::COLOR_CYAN,    -1)
-    end
-
-    Curses::cbreak
-    Curses::curs_set 0
-    Curses::noecho
-    Curses::nonl
-    Curses::stdscr.keypad = true # extra keys
-  end
-
-  def width
-    return Curses::cols
-  end
-
-  def height
-    return Curses::lines
-  end
-
-  def exit
-    Curses::refresh
-    Curses::close_screen
-  end
-
-  def set_color color
-    if @has_colors
-      @screen.attron Curses::color_pair(color)
-      return self
-    else
-      return nil
-    end
-  end
-
-  def getchar
-    return Curses::getch
-  end
-
-  # +timeout+ says how many milliseconds we wait for a key to be
-  # pressed.
-  def timeout timeout
-    Curses::timeout = timeout
-  end
-end
-

data/lib/tabscroll/popup.rb

@@ -1,60 +0,0 @@
-
-require_relative 'screen.rb'
-
-# A simple centralized popup.
-#
-# It resizes as you place the text on it.
-class Popup < Screen
-
-  def initialize(title, text)
-    @title = title
-    @text = []
-    text.each_line do |line|
-      @text += [line.chomp]
-    end
-
-    max_width  = title.length
-    max_height = 1
-
-    @text.each do |line|
-      max_width   = line.length if line.length > max_width
-      max_height += 1
-    end
-
-    max_width  += 2 # left-right borders
-    max_height += 1 # down border
-
-    x = Curses::cols/2  - max_width/2
-    y = Curses::lines/2 - max_height/2
-
-    super(x, y, max_width, max_height)
-    self.background ' '
-    self.box
-
-    self.mvaddstr_center(0, title, Engine::Colors[:cyan])
-
-    y = 1
-    @text.each do |line|
-      self.mvaddstr(1, y, line)
-      y += 1
-    end
-  end
-
-  def show
-    finished = false
-    while not finished
-      c = Curses::getch
-      case c
-      when 'q'
-        return true
-      when 'h'
-        finished = true
-      end
-    end
-
-    Curses::stdscr.clear
-    Curses::stdscr.refresh
-    return false
-  end
-end
-

data/lib/tabscroll/screen.rb

@@ -1,125 +0,0 @@
-
-require 'curses'
-
-# A segment of the terminal screen.
-#
-# BUG WARNING HACK FUCK
-# Whenever I use @win.attrset/@win.setpos/@win.addch
-# it doesn't work at all.
-# Apparently, when I do this, Curses::getch clears up
-# the entire screen.
-#
-# DO NOT DO THIS
-#
-class Screen
-  attr_reader :width, :height
-
-  # Creates a Screen at `x` `y` `w` `h`.
-  def initialize(x, y, w, h)
-    @win = Curses::Window.new(h, w, y, x)
-    @width  = w
-    @height = h
-  end
-
-  # Sets the current color of the Screen.
-  def set_color color
-    Curses::attrset(Curses::color_pair color)
-  end
-
-  # Executes a block of code encapsulated within a color on/off.
-  # Note that the color can be overrided.
-  def with_color(color=nil)
-    Curses::attron(Curses::color_pair color) if color
-    yield
-    Curses::attroff(Curses::color_pair color) if color
-  end
-
-  # Puts a character +c+ on (+x+, +y+) with optional +color+.
-  def mvaddch(x, y, c, color=nil)
-    return if x < 0 or x >= @width
-    return if y < 0 or y >= @height
-
-    self.with_color color do
-      Curses::setpos(@win.begy + y, @win.begx + x)
-      Curses::addch c
-    end
-  end
-
-  # Puts a string +str+ on (+x+, +y+) with optional +color+.
-  def mvaddstr(x, y, str, color=nil)
-    return if x < 0 or x >= @width
-    return if y < 0 or y >= @height
-
-    self.with_color color do
-#      @win.setpos(@win.begy + y, @win.begx + x)
-#      @win.addstr str
-      Curses::setpos(@win.begy + y, @win.begx + x)
-      Curses::addstr str
-    end
-  end
-
-  # Puts a string +str+ centered on +y+ with optional +color+.
-  def mvaddstr_center(y, str, color=nil)
-    x = (@width/2) - (str.length/2)
-    self.mvaddstr(x, y, str, color)
-  end
-
-  def mvaddstr_left(y, str, color=nil)
-    self.mvaddstr(0, y, str, color)
-  end
-
-  def mvaddstr_right(y, str, color=nil)
-    x = @width - str.length
-    self.mvaddstr(x, y, str, color)
-  end
-
-  # Erases all of the Screen's contents
-  def clear
-    @win.clear
-  end
-
-  # Commits the changes on the Screen.
-  def refresh
-    @win.refresh
-  end
-
-  # Moves window so that the upper-left corner is at `x` `y`.
-  def move(x, y)
-    @win.move(y, x)
-  end
-
-  # Resizes window to +width+ and +h+eight.
-  def resize(w, h)
-    @win.resize(h, w)
-    @width  = w
-    @height = h
-  end
-
-  # Set block/nonblocking reads for window.
-  #
-  # * If `delay` is negative, blocking read is used.
-  # * If `delay` is zero, nonblocking read is used.
-  # * If `delay` is positive, waits for `delay` milliseconds and
-  #   returns ERR of no input.
-  def timeout(delay=-1)
-    @win.timeout = delay
-  end
-
-  def background char
-    @win.bkgd char
-    @win.refresh
-  end
-
-  # Sets the Screen border.
-  #
-  # * If all arguments are set, that's ok.
-  # * If only the first 2 arguments are set, they are the vertical
-  #   and horizontal chars.
-  #
-  def box(horizontal=0, vertical=0)
-    @win.box(horizontal, vertical)
-    @win.refresh
-  end
-
-end
-