rubyshelltools 0.0.10 → 0.0.11

data/README.md

@@ -11,7 +11,16 @@ name wasn't available at rubygems anymore ;-)
 
 Since bash-history isn't always enough persistent for my daily work, I deal with the idea to create a kinda 'central toolbox' for my shell. RST represents the first steps in this direction. I'm not sure if the 'project' will survive, tho. I'll give it a try.
 
-The first pushed version features a very simple 'ls' and 'calendar'-command. The plan is to play around with the structure of the gem until I'm satisfied and feel comfortable to start implementing more features. There's a ton of ideas what RST could do, I'm just not sure what it shall do. Let's see ...
+Current version features a very simple 'ls' and 'calendar'-command. 
+There is a command-line-version `bin/rst` and a Curses-version `bin/rst-ui`.
+A Sinatra-version will be added later.
+
+**Branches**
+
+* _master_ - core and command-line version
+* _curses_ - core, command-line, and Curses implementation
+
+The plan is to play around with the structure of the gem until I'm satisfied and feel comfortable to start implementing more features. There's a ton of ideas what RST could do, I'm just not sure what it shall do. Let's see ...
 
 
 Install from rubygems.org

data/bin/rst-ui

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+
+require 'curses'
+
+require_relative '../lib/rst'
+require_relative '../lib/load'
+include RST
+
+# ACTIONS CALLED BY MAIN-LOOP
+
+def display_calendar screen,from,to
+  store = Persistent::DiskStore.new(CALENDAR_FILE)
+  screen.clear
+  screen.print_screen( _print_calendar(store, from,to ))
+  screen.status( _print_status_line(from,to))
+end
+
+def clear_screen(screen)
+  screen.clear
+end
+
+def print_year(screen)
+  clear_screen(screen) 
+  screen.print_screen( _year_banner )
+  screen.status( "c=calender, q=quit" )
+end
+
+# HELPERS
+
+def _year_banner
+ [ '', '   RubyShellTools',"   #{VERSION}" ] +
+ `banner -w 32 #{Date.today.year}`.split(/\n/).map{|line|"    #{line}"} +
+ ['']*3
+end
+
+def _print_status_line(from,to)
+  "#{(Time.now+from.weeks).strftime('%Y-%m-%d')} " +
+  "to #{(Time.now+to.weeks).strftime('%Y-%m-%d')} " +
+  "[<up> -5w, <down> +5w, <c> today, <enter> clear]"
+end
+
+def _print_calendar(store, from, to)
+  store.all.map { |calendar|
+    calendar.name + "\n" +
+    calendar.to_text("#{from}w","#{to}w").to_s
+  }.join("\n\n").split(/\n/)
+end
+
+
+# MAIN
+
+# Initialize the controller
+# Loop getch until 'q' is received
+# Arrow-keys changes the range for from and to by months/years
+# Enter clears the screen (shows the current year as banner)
+# 'r' does nothing to demonstrate the noop function ;-)
+# 'q' quits the loop and ends the program.
+# Curses gets shut down when CoursesController gets dropped by the GC.
+CursesController.new(ARGV).tap do |controller|
+
+  from = -1 # show calendar from today -1 week
+  to   = 5  # show calendar to today + 5 weeks
+
+  loop do
+    case Curses.getch
+    when Curses::Key::UP    then from -=  4; to   -=  4; display_calendar(controller,from,to)
+    when Curses::Key::DOWN  then from +=  4; to   +=  4; display_calendar(controller,from,to)
+    when Curses::Key::LEFT  then from -= 52; to   -= 52; display_calendar(controller,from,to)
+    when Curses::Key::RIGHT then from += 52; to   += 52; display_calendar(controller,from,to)
+    when ?c                 then from = -1; to = 5; display_calendar(controller,from,to)
+    when 10                 then print_year(controller)  #ENTER
+    when ?r                 then clear_screen(controller); controller.noop
+    when ?q                 then break
+    end
+  end
+
+end
+

data/lib/curses/curses_controller.rb

@@ -0,0 +1,124 @@
+require 'curses'
+
+module RST
+
+  # Controll the curses-lib
+  # @example
+  #   cc = CursesController.new
+  #   cc.print_scren( ['Line 1', 'Line 2', ...] )
+  #   cc.clear
+  #   cc.status 'It works'
+  #
+  class CursesController
+
+    include Curses
+
+    # Available colors provided by Curses
+    COLORS = [ COLOR_BLACK,COLOR_RED,COLOR_GREEN,COLOR_YELLOW,COLOR_BLUE,
+               COLOR_MAGENTA,COLOR_CYAN,COLOR_WHITE ]
+
+    # @group public api
+
+    # Initialize and register a finalizer to close curses
+    # whenever this object gets destroyed by the GC.
+    def initialize(*)
+      init_curses
+      ObjectSpace.define_finalizer( self, self.class.finalize )
+      clear
+    end
+
+    # Outputs array of lines from 0,0 to max-lines
+    # @param [Array] lines - lines to output
+    def print_screen(lines)
+      color_pair = 1
+      lines.each_with_index do |line,lno|
+        color_pair = color_pair == 1 ? 2 : 1
+        write(lno, 0, block_given? ? yield(line,lno) : line, color_pair)
+        break if lno > height-3
+      end
+    end
+
+
+    # update the status-line
+    # @param [String] message
+    def status(message)
+      message += '-' * (status_line_length - message.length)
+      write(status_line, 0, message, 1 )
+    end
+
+    # No operation - called when an unknown key is pressed
+    # to show any response
+    def noop
+      write(0,0,"NOOP #{Time.now.to_s}"+" "*5)
+    end
+
+    # Clear the screen and rewrite the status-bar
+    def clear
+      Curses.clear
+      status "q=Quit c=Calendar <enter>=Clear screen"
+    end
+
+    #@endgroup
+
+    private
+
+    # Output a line of text and clear to the end of line
+    # @param [Integer] line - the line to write to 0=top of screen
+    # @param [Integer] column - the column to start at 0=left most col.
+    # @param [String] text - the text to write
+    # @param [Integer] color_pair - which color to use (or random)
+    def write(line, column, text, color_pair=@color_pairs.sample)
+      Curses.setpos(line, column)
+      Curses.attron(color_pair(color_pair)|A_NORMAL) do
+        Curses.addstr(text+ ' '*(status_line_length-column-text.length))
+      end
+    end
+
+    # @return [Integer] - number of lines available at current screen
+    def height
+      Curses.lines
+    end
+
+    # Initialize the Curses-environment
+    def init_curses
+      Curses.noecho # do not show typed keys
+      Curses.init_screen
+      Curses.start_color
+      @screen=Curses.stdscr
+      @screen.keypad(true) # enable arrow keys
+      init_colors
+    end
+
+    # Create color-pairs fg/bg for each combination of
+    # given colors (see top of file)
+    def init_colors
+      @color_pairs = []
+      COLORS.each_with_index do |fg,fgi|
+        (COLORS-[fg]).each_with_index do |bg,bgi|
+          Curses.init_pair(fgi*10+bgi,fg,bg)
+          @color_pairs << fgi*10+bgi
+        end
+      end
+    end
+
+    # @return [Integer] - number of columns (width) of the screen
+    def status_line_length
+      Curses.cols
+    end
+
+    # @return [Integer] - bottom of screen
+    def status_line
+      Curses.lines-1
+    end
+
+
+    # Finalize get's called when the CG will free the object.
+    # The call to this function was registered in the constructor.
+    def self.finalize
+      proc do
+        Curses.close_screen
+      end
+    end
+
+  end
+end

data/lib/load.rb

@@ -27,6 +27,9 @@ unless defined? LIB_LOADED
   $LOAD_PATH.unshift(File.expand_path('../errors',__FILE__))
   require 'store_errors'
 
+  $LOAD_PATH.unshift(File.expand_path('../curses',__FILE__))
+  require 'curses_controller'
+
   $LOAD_PATH.unshift(File.expand_path('../modules/calendar',__FILE__))
   require 'calendar'
   require 'eventable'

data/lib/modules/calendar/calendar.rb

@@ -40,8 +40,6 @@ module RST
   #
   module Calendar
 
-    include CalendarHelper
-
     # Calendar has a name and will be stored in Persistent::DiskStore(CALENDAR_FILE)
     # with it's name as the id. Thus you can save different calendars in
     # the same file. If no name is given 'unnamed' will be the default.
@@ -55,7 +53,7 @@ module RST
 
       # @group public API
 
-      attr_reader :name, :start_date, :end_date, :events
+      attr_reader :name, :start_date, :end_date
 
       # @param [String] _name Name and persistent-id of this calendar.
       # @param [Date|Time|String] _start The date when the calendar starts
@@ -66,7 +64,21 @@ module RST
         @name       = _name
         @start_date = parse_date_param(_start)
         @end_date   = parse_date_param(_end)
-        @events     = _events
+        @_events     = _events
+      end
+
+      # Return sorted events
+      # @return [Array] of Event-objects
+      def events
+        (@_events||=[]).sort { |a,b| a.event_date <=> b.event_date }
+      end
+
+      # Remove events from calendar by event-ids
+      # @param [Array] ids - ids to remove
+      def reject_events_by_id!(*ids)
+        @_events.reject! do |e|
+          ids.include?(e.id)
+        end
       end
 
 
@@ -92,7 +104,7 @@ module RST
       # Add Eventables to the calendar
       # @param [Eventable] add - the Object to add
       def <<(add)
-        events << add 
+        @_events << add 
       end
 
       # Calculate the span between start and end in seconds

data/lib/rst.rb

@@ -338,7 +338,7 @@ module RST
     def delete_events
       store = Persistent::DiskStore.new(CALENDAR_FILE)
       calendar = store.find(@options[:name])
-      calendar.events.reject!{|r| @options[:delete_events].include?(r.id)}
+      calendar.reject_events_by_id!(*@options[:delete_events])
       store << calendar
     end
 

data/rst.rb

@@ -3,7 +3,7 @@ require 'logger'
 # # Ruby Shell Tools Top-level file
 module RST
   # Gem-version
-  VERSION   = '0.0.10'
+  VERSION   = '0.0.11'
 
   # Path to the docs used by the software
   DOCS      = File.expand_path('../assets/docs', __FILE__)

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: rubyshelltools
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
+  prerelease: 
 platform: ruby
 authors:
 - Andi Altendorfer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2013-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -41,6 +46,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -48,6 +54,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -56,6 +63,7 @@ description: Tools for the unix shell
 email: andreas@altendorfer.at
 executables:
 - rst
+- rst-ui
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -65,6 +73,7 @@ files:
 - lib/core_extensions/mutex.rb
 - lib/core_extensions/numeric.rb
 - lib/core_extensions/string.rb
+- lib/curses/curses_controller.rb
 - lib/errors/store_errors.rb
 - lib/load.rb
 - lib/modules/calendar/calendar.rb
@@ -77,30 +86,36 @@ files:
 - lib/modules/persistent/store.rb
 - lib/rst.rb
 - bin/rst
+- bin/rst-ui
 - README.md
 - assets/docs/examples.md
 homepage: http://rubygems.org/gems/rubyshelltools
-licenses: []
-metadata: {}
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 991597406818373700
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Ruby Shell Tools
 test_files: []
 has_rdoc: 

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 641f55c4735fc80402667b74f37d8d6b2b91684f
-  data.tar.gz: cce31a850e6ca5f17a5a5b63da41fdcaf3c0a144
-SHA512:
-  metadata.gz: 12b4f4292524d658a3587aa3535b288b43b27dce16ffb5d68c585dfa90fa3d7b98713ae30add0e36a3517d1934cf3b774b47be099485768cd2c352e6b06c8717
-  data.tar.gz: 7a2f0e78844f86bc2da5ad9d3c41b58daefc5b633cc11503fe17e538cf7db133ba57072adaf44e507292375d2c0ecfb73c9db5fcde55dbc970386f4fe9547c3a