rubyshelltools 0.0.5 → 0.0.6

data/assets/docs/examples.md

@@ -7,7 +7,7 @@ rst --help
 Print out available options and commands
   
     $ rst --help
-    Usage: rst [COMMAND [COMMAND ....]] [options] [FILES..]
+    Usage: rst [COMMAND] [options] [FILES..]
 
     Options:
         -v, --[no-]verbose               Run verbosely
@@ -16,16 +16,28 @@ Print out available options and commands
         -f, --from DATE                  Set from-date
         -t, --to DATE                    Set to-date
         -n, --name NAME                  Use this name for the command
-        -e, --new-event DATE,STRING      Add an event
+        -e, --new-event [DATE,]STRING    Add an event
             --list-calendars             List available calendars
             --delete-calendar CALENDARNAME
                                          Delete an calendar and all it's entries!
             --[no-]empty                 Show empty entries
+            --save-defaults              Save given params as defaults
+            --list-defaults              list saved defaults
+            --clear-defaults             delete previously saved defaults
+
     Commands:
         nil .......... no command. Interpret options only (useful in combination with -v)
         ls ........... list directory and files
         cal[endar] ... print a calendar --from --to
 
+    DATE-FORMATS FOR --new-event:
+        omitted....... today
+        today ........ today
+        nDWM ......... today + n days, weeks, months eg 1w, 2d[ays], 1M[ONTH]
+        yyyy-mm-dd
+        dd.mm.yyyy
+        mm/dd/yyyy
+
         use --example for a more detailed list of commands.
 
 rst ls *
@@ -59,11 +71,13 @@ overwrite this by defining env-vars for RST_DATA and RST_ENV
     
     $ export RST_DATA=$HOME/.rst/data
     $ export RST_ENV=production
+    
     $ rst cal --new-event='1964-08-31,Birthday Andreas Altendorfer'
     $ rst cal -e 'today,Win the jackpot'  # e is an abbreviation for --new-event
     $ rst cal -f 1964/1                   # f is an abbreviation for --from
     Mon, Aug 31 1964: Birthday Andreas Altendorfer
     Fri, Mar 15 2013: Win the jackpot
+    
     $ find $HOME/.rst
     /Users/you/.rst
     /Users/you/.rst/data
@@ -74,6 +88,8 @@ overwrite this by defining env-vars for RST_DATA and RST_ENV
     birthdays           : 5 entries
     work                : 2 entries
     
+    $ rst -e 1w,Some Event  # entered on Tue, Jan 01 2013
+    Added: Tue, Jan 08 2013: Some Event 
 
 The full set of parameters is
 

data/bin/rst

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 
-require File.expand_path('../../rst', __FILE__)
 require_relative '../lib/rst'
 require_relative '../lib/load'
 include RST

data/lib/modules/calendar/calendar.rb

@@ -51,7 +51,7 @@ module RST
           param
         elsif param =~ /today/i || param.nil?
           Date.today 
-        elsif param =~ /\d+[wmd]/i
+        elsif param =~ /\d+[a-zA-Z]/i
           get_today_plus(param)
         else 
           Date.parse(param)
@@ -62,7 +62,7 @@ module RST
       # @param [String] param nDWM n=Number Day Weeks Months
       def get_today_plus(param)
         offset = 0
-        param.scan(/(\d+)([dwm])/i) do |count,unit|
+        param.scan(/(\d+)([a-z])/i) do |count,unit|
           offset = case unit[0].downcase
           when 'd'
             count.to_i.days
@@ -145,9 +145,9 @@ module RST
       # @param [String|Date] end_on   - output ends on this day
       # @param [Boolean] show_empty   - output days with no events
       # @return [Array] of Strings DATE: EVENT + EVENT + ....
-      def list_days(start_on=start_date,end_on=end_date,show_empty=false)
+      def list_days(start_on=start_date,end_on=end_date,show_empty=false,show_ids=false)
         (parse_date_param(start_on)..parse_date_param(end_on)).to_a.map { |_date|
-          format_events_for(_date,show_empty)
+          format_events_for(_date,show_empty,show_ids)
         }.compact
       end
       
@@ -158,7 +158,16 @@ module RST
       def events_on(date)
         events.select { |event| event.event_date == date }
       end
-      
+
+
+      # Dump calendar events
+      # @return [String]
+      def dump
+        events.map { |event|
+          '"%s,%s"' % [ event.event_date.strftime('%Y-%m-%d'), event.event_headline ]
+        }.join("\n")
+      end
+
       # @endgroup
 
       private
@@ -168,17 +177,25 @@ module RST
       # @param [Date] _date
       # @param [Boolean] show_empty - do output lines with no events
       # @return [String]
-      def format_events_for(_date,show_empty=false)
-        if  (_line=event_headlines_for(_date)) != '' || show_empty
-          "%s: %s" % [_date.strftime(DEFAULT_DATE_FORMAT), _line]
+      # @param [Boolean] show_ids - output ids for events
+      def format_events_for(_date,show_empty=false,show_ids=false)
+        if  (_line=event_headlines_for(_date,show_ids)) != '' || show_empty
+          (show_ids ? "%s:\n  %s" : "%s: %s") % [_date.strftime(DEFAULT_DATE_FORMAT), _line]
         end
       end
 
       # Concatenate headlines of all events on this date
       # @param [Date] _date
+      # @param [Boolean] _show_ids
       # @return [String]
-      def event_headlines_for(_date)
-        events_on(_date).map(&:event_headline).join(' + ').strip
+      def event_headlines_for(_date,_show_ids=false)
+        if !_show_ids
+          events_on(_date).map(&:event_headline).join(' + ').strip
+        else
+          events_on(_date).map{|e|
+            "%s > %s" % [e.respond_to?(:id) ? e.id : 'n/a' ,e.event_headline]
+          }.join("\n  ").strip
+        end
       end
   
       # @endgroup 

data/lib/modules/calendar/calendar_event.rb

@@ -20,7 +20,7 @@ module RST
     #
     class CalendarEvent 
 
-      attr_reader :event_date, :label
+      attr_reader :event_date, :label, :id
 
       include Eventable
       include CalendarHelper
@@ -29,6 +29,7 @@ module RST
       # @param [String] _label - Events name
       def initialize(_date,_label)
         @label = _label
+        @id ||= SecureRandom::hex(4)
         schedule! ensure_date(_date)
       end
 

data/lib/rst.rb

@@ -112,10 +112,22 @@ module RST
           @options[:delete_calendar] = name
         end
 
+        opts.on('--delete-events ID[,ID,...]',Array, 'delete entries from calendar') do |ids|
+          @options[:delete_events] = ids
+        end
+
         opts.on('--[no-]empty', 'Show empty entries') do |show|
           @options[:show_empty] = show
         end
 
+        opts.on('-i', '--with-ids', 'List entries with ids') do |ids|
+          @options[:with_ids] = ids
+        end
+
+        opts.on('-d', '--dump', 'Dump calendar-events' ) do |d|
+          @options[:dump] = d
+        end
+
         opts.on('--save-defaults', 'Save given params as defaults') do |v|
           @options[:save_defaults] = v
         end
@@ -128,20 +140,25 @@ module RST
           @options[:clear_defaults] = v
         end
 
+        opts.separator ''
         opts.separator 'Commands:'
 
         opts.separator <<-EOT
           nil .......... no command. Interpret options only (useful in combination with -v)
           ls ........... list directory and files
           cal[endar] ... print a calendar --from --to
+        EOT
+        .gsub(/^\s+/,'    ')
 
-          DATE-FORMATS FOR --new-event
-          ommit ........ today
+        opts.separator ''
+        opts.separator 'DATE-FORMATS FOR --new-event:'
+        opts.separator <<-EOT
+          omitted....... today
           today ........ today
+          nDWM ......... today + n days, weeks, months eg 1w, 2d[ays], 1M[ONTH]
           yyyy-mm-dd
           dd.mm.yyyy
           mm/dd/yyyy
-          nDWM ......... today + n days, weeks, months eg 1w, 2d[ays], 1M[ONTH]
         EOT
         .gsub(/^\s+/,'    ')
 
@@ -203,7 +220,7 @@ module RST
     # @return [Array] - one string Date: Event + Event + ... for each day.
     def print_calendar
       cal = find_calendar( Persistent::DiskStore.new(CALENDAR_FILE) )
-      cal.list_days(options[:from], options[:to], options[:show_empty]).compact.join("\n")
+      cal.list_days(options[:from], options[:to], options[:show_empty], options[:with_ids]).compact.join("\n")
     end
 
     # @group EXECUTE ACTION FROM OPTIONS
@@ -223,6 +240,10 @@ module RST
         "Added: %s: %s" % [new_event.event_date.strftime(DEFAULT_DATE_FORMAT), new_event.event_headline.strip]
       when 'list_calendars'
         list_calendars
+      when 'dump'
+        dump_calendar
+      when 'delete_events'
+        delete_events
       when 'delete_calendar'
         delete_calendar
       when 'save_defaults'
@@ -267,6 +288,27 @@ module RST
       }
     end
 
+    # Dump the calendar(s), thus the output can be used as input for -e again
+    # if no name-param is given all calendars are dumped.
+    # if name-param is given only the named calendar gets dumped.
+    # @return [String]
+    def dump_calendar
+      store = Persistent::DiskStore.new(CALENDAR_FILE)
+      store.all.map { |calendar|
+        calendar.dump if calendar.name == @options[:name] || @options[:name].blank?
+      }.compact.join("\n")
+    end
+
+    # Delete events with given IDs from calendar
+    # @example
+    #   rst -n calname --delete-ids=34a4,44b3
+    def delete_events
+      store = Persistent::DiskStore.new(CALENDAR_FILE)
+      calendar = store.find(@options[:name])
+      calendar.events.reject!{|r| @options[:delete_events].include?(r.id)}
+      store << calendar
+    end
+
     # Output the previous interpreted and parsed arguments
     # Called when --verbose is given as an option
     # @example

data/rst.rb

@@ -3,7 +3,7 @@ require 'logger'
 # # Ruby Shell Tools Top-level file
 module RST
   # Gem-version
-  VERSION   = '0.0.5'
+  VERSION   = '0.0.6'
 
   # Path to the docs used by the software
   DOCS      = File.expand_path('../assets/docs', __FILE__)
@@ -15,6 +15,10 @@ module RST
   # @see Persistent::DiskStore
   DEFAULT_STORE_FILENAME = 'rst_data.pstore'
 
+  # The length of an Eventable's id.
+  # @see Calendar::Eventable.id
+  EVENT_HEX_ID_LENGTH = 4
+
   # intialize the logger
   # @example Usage
   #   RST.logger.info('This will output to STDERR')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyshelltools
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-29 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet