tabscroll 1.0.40 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee12d935ef76ceb70ff47c224fb0b9eb03a670b1
-  data.tar.gz: 4d9f7d721e110bd9105329e6524d7a332577f535
+  metadata.gz: 99b7ce3438c86990d1e371a58dc0344faec3c2b2
+  data.tar.gz: f0dec39df6e7178087f25220cb97ab2d089008ca
 SHA512:
-  metadata.gz: f63aa0639af372c80a70742876933614d22f9596761f0d3c199b0bb1e23881515c7227eccdc5a4b8088de6765003d5d25646d7defefc89488489dc93524e475a
-  data.tar.gz: 8954f7d1eb656939bb70c249470de5dd2ca17c9e6690dc135c71cc6f2466dd646cfde1ff71c5f9cc8f5e6360001cc5c96a225e1589a805a2005d5c1ad37319e2
+  metadata.gz: a5f0afba94716225f46ae66bc70ba01c1169d38eaa53e3076bc0d165e93ae4650b9502cd7d084bacfbbe8fb0e4a0e7624ea3908147f9c1fe454082a07429937f
+  data.tar.gz: 9ca2e31c3ecfeb97cef96a1123315ef499f6bc28a49eb4e80bf4cdf7d84e0ff75871770cb7a3de2f8340628f2db8570f89d2333f38b6feb0406a10c169176cef

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 <!-- My awesome changelog -->
 
+## 1.1.0 (Oct 14, 2013)
+
+IMPROVEMENTS:
+
+* Added a sample file so users can test the program without
+  having a guitar tab on their system.
+
 ## 1.0.40 (Oct 10, 2013)
 
 BUG FIXES:

data/bin/tabscroll

@@ -13,6 +13,13 @@ begin
   $settings = Settings.new
   $settings.parse ARGV
 
-  TabScroll::run $settings[:filename]
+ # We'll provide a sample file so the user can test the program
+  if $settings[:run_sample_file]
+    filename = $settings[:sample_filename]
+  else
+    filename = $settings[:filename]
+  end
+
+  TabScroll::run filename
 end
 

data/lib/tabscroll.rb

@@ -13,11 +13,18 @@ require 'tabscroll/version'
 # (Settings class).
 module TabScroll
 
-  # Executes the whole program, loading contents in `filename`.
+  # Starts the Curses engine and parses `filename`, finally
+  # displaying things onscreen.
   def self.run filename
+
+    if not File.exists? filename
+      puts "Error: File '#{filename}' doesn't exist."
+      exit 69
+    end
+
     @engine = Engine.new
     if not @engine
-      puts 'Failed to start curses!'
+      puts "Error: Failed to start Curses!"
       exit 1337
     end
     @engine.timeout 10
@@ -48,24 +55,24 @@ module TabScroll
         bars_hidden = (bars_hidden ? false : true)
         Curses::clear
       when '<'
-        track.scroll -5
+        track.scroll -10
       when '>'
-        track.scroll 5
+        track.scroll 10
       when Curses::KEY_LEFT
         track.speed -= 1
       when Curses::KEY_RIGHT
         track.speed += 1
-      when Curses::KEY_DOWN, Curses::KEY_UP
+      when Curses::KEY_DOWN, Curses::KEY_UP, ' '
         track.speed = 0
       when 'q'
-        $enigne.exit
-        return nil
+        @engine.exit
+        exit
       end
 
       track.update
       track.show
       if not bars_hidden
-        titlebar.mvaddstr(0, 0, "#{filename} (#{track.percent_completed}%) ", Engine::Colors[:cyan])
+        titlebar.mvaddstr(0, 0, "#{File.basename filename} (#{track.percent_completed}%) ", Engine::Colors[:cyan])
         titlebar.mvaddstr_right(0, "  Speed: #{track.speed}", Engine::Colors[:cyan])
 
         statusbar.mvaddstr_left(0, "tabscroll v#{VERSION} - press `h` for help", Engine::Colors[:green])
@@ -80,22 +87,26 @@ module TabScroll
   def self.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
+                  q  quit
+                  h  help/go back
+         left/right  auto-scroll left/right
+  up/down/space bar  stop auto-scrolling
+                </>  step scroll left/right
+                  o  toggle status/title bars
 
+        _|_  _. |_   _  _ ._ _  | |
+         |_ (_| |_) _> (_ | (_) | | #{VERSION}
 
-tabscroll v#{VERSION}
-homepage  alexdantas.net/projects/tabscroll
-author    Alexandre Dantas <eu@alexdantas.net>
+ 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
+    if will_quit
+      @engine.exit
+      exit
+    end
   end
 end
 

data/lib/tabscroll/settings.rb

@@ -12,6 +12,21 @@ class Settings
   def initialize
     @settings = {}
     @settings[:filename] = nil
+
+    # We have a way to test the program.
+    # We're distributing a sample tab file with the Gem so
+    # when users run `tabscroll --sample` they can see
+    # how the program works.
+    # This setting enables it
+    @settings[:run_sample_file] = false
+
+    # And this is the absolute filename of the file
+    # distributed with the gem.
+    # It'll be `../../sample_tab.txt` based on `settings.rb` path.
+    filename = File.expand_path("../../", __FILE__)
+    filename = File.dirname filename
+    filename += "/sample_tab.txt"
+    @settings[:sample_filename] = filename
   end
 
   # Sets options based on commandline arguments `args`.
@@ -23,8 +38,13 @@ class Settings
 
       # Make output beautiful
       parser.separator ""
-      parser.separator "Specific options:"
+      parser.separator "Options:"
+
+      parser.on("--sample", "Run `tabscroll` with sample file") do
+        @settings[:run_sample_file] = true
+      end
 
+      # These options appear if no other is given.
       parser.on_tail("-h", "--help", "Show this message") do
         puts parser
         exit
@@ -37,7 +57,7 @@ class Settings
     end
     opts.parse! args
 
-    # After parsing all '--args' and '-a' we will check if
+    # After parsing all dashed arguments we will check if
     # the user has provided a filename.
     #
     # The first argument without a leading '-' will be
@@ -49,7 +69,7 @@ class Settings
       end
     end
 
-    if not @settings[:filename]
+    if not @settings[:filename] and not @settings[:run_sample_file]
       puts opts
       exit 666
     end

data/lib/tabscroll/track.rb

@@ -59,8 +59,11 @@ class Track
     # I will also make every line have the same width
     # as of the biggest one.
 
-    # Any tab line MUST have EITHER ---1---9--| OR |---3----0
-    tab_line = /[-[:alnum:]]\||\|[-[:alnum:]]/
+    # Any tab line MUST have EITHER:
+    # ---1---9--|
+    # or
+    # |---3----0
+    tab_line = /[-[:alnum:]*]\||\|[-[:alnum:]*]/
 
     # Duration of each note only has those chars.
     # So we look for anything BUT these chars.

data/lib/tabscroll/version.rb

@@ -1,3 +1,3 @@
 module TabScroll
-  VERSION = '1.0.40'
+  VERSION = '1.1.0'
 end

data/tabscroll.gemspec

@@ -1,4 +1,4 @@
-# Adding lib directory to load path
+# Adding ./lib directory to load path
 lib = File.expand_path('../lib', __FILE__)
 $:.unshift lib unless $:.include? lib
 
@@ -20,7 +20,7 @@ END_OF_DESCRIPTION
   s.homepage    = 'http://www.alexdantas.net/projects/tabscroll'
   s.license     = "GPL-3.0"
 
-  # Including everything that's on `git`
+  # Including everything that's checked out on git
   s.files       = `git ls-files`.split($/)
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = ['lib']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabscroll
 version: !ruby/object:Gem::Version
-  version: 1.0.40
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexandre Dantas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -49,6 +49,7 @@ files:
 - lib/tabscroll/timer.rb
 - lib/tabscroll/track.rb
 - lib/tabscroll/version.rb
+- sample_tab.txt
 - tabscroll.gemspec
 homepage: http://www.alexdantas.net/projects/tabscroll
 licenses: