rubyshelltools 0.0.8 → 0.0.9

data/README.md

@@ -69,6 +69,19 @@ The latest version is online at my [DAV-server][] too.
 Browsing the code
 -----------------
 
+  **To get a glue what's goin on**
+
+  do a `rspec --format d specs/` in the project's root
+
+        Command-line arguments
+          --verbose - should list interpreted options and files with --verbose
+          ls - should list files with 'ls'
+          --help - should print help
+          --examples - should print out examples from doc/examples.md
+        
+        ..... cut out a lot of lines .....
+
+  
   **modules**
   
  Modules are the core of this project. Within the directory

data/assets/docs/examples.md

@@ -7,39 +7,43 @@ rst --help
 Print out available options and commands
   
     $ rst --help
-    Usage: rst [COMMAND] [options] [FILES..]
-
-    Options:
-        -v, --[no-]verbose               Run verbosely
-            --examples                   Show some usage examples
-        -h, --help                       Print help
-        -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
-            --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.
 
+        Usage: rst [COMMAND] [options] [FILES..]
+
+        Options:
+            -v, --[no-]verbose               Run verbosely
+                --examples                   Show some usage examples
+            -h, --help                       Print help
+            -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
+                --list-calendars             List available calendars
+                --delete-calendar CALENDARNAME
+                                             Delete an calendar and all it's entries!
+                --delete-events ID[,ID,...]  delete entries from calendar
+                --[no-]empty                 Show empty entries
+            -i, --with-ids                   List entries with ids
+            -d, --dump                       Dump calendar-events
+                --save-defaults              Save given params as defaults
+                --list-defaults              list saved defaults
+                --clear-defaults             delete previously saved defaults
+            -p, --print-calendar             Print calendar
+
+        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 *
 --------
 
@@ -121,14 +125,14 @@ Print a pretty calendar
         $ rst cal -n work --print-calendar
         
              April 2013        EVENTS:
-        Su Mo Tu We Th Fr Sa   Wed, Apr 24 2013: RailsConf2013 7h Abflug München + TÜV-Audit
+        Su Mo Tu We Th Fr Sa   Wed, Apr 24 2013: RailsConf2013 7h Departure Munich + TUV Audit
             1  2  3  4  5  6   Mon, Apr 29 2013: RailsConf2013
          7  8  9 10 11 12 13   Tue, Apr 30 2013: RailsConf2013
         14 15 16 17 18 19 20   Wed, May 01 2013: RailsConf2013
         21 22 23 24 25 26 27   Thu, May 02 2013: RailsConf2013
         28 29 30               Fri, May 03 2013: RailsConf2013
-                               Sat, May 04 2013: RailsConf2013 Ankunft München
-                               Mon, May 06 2013: Prüfung Romy
+                               Sat, May 04 2013: RailsConf2013 Arrival Munich
+                               Mon, May 06 2013: Exam Romy
               May 2013
         Su Mo Tu We Th Fr Sa
                   1  2  3  4

data/lib/modules/calendar/calendar.rb

@@ -89,13 +89,14 @@ module RST
       include Persistent::Persistentable
       include CalendarHelper
 
-      # @group public api
+      # @group public API
 
       attr_reader :name, :start_date, :end_date, :events
 
       # @param [String] _name Name and persistent-id of this calendar.
       # @param [Date|Time|String] _start The date when the calendar starts
       # @param [Date|Time|String] _end   The date when the calendar ends
+      # @param [Array] _events initial events
       # @see DEFAULT_CALENDAR_NAME
       def initialize(_name=DEFAULT_CALENDAR_NAME, _start=nil, _end=nil, _events=[])
         @name       = _name
@@ -177,34 +178,65 @@ module RST
       # events within given date-range
       # @param [String|Date] from - Start on date
       # @param [String|Date] to - End on date
-      # @return [String]
+      # @param [Boolean] empty - show empty lines (dates without events)
+      # @param [Boolean] ids - show ids of each event
+      # @return [String]|nil
       def to_text(from,to,empty=false,ids=false)
         unless (_content=list_days(from,to)).empty?
           left_column=build_cal(ensure_date(from),ensure_date(to))
           right_column=("EVENTS:\n"+list_days(from,to,empty,ids).join("\n")).split(/\n/)
-          rows = [] 
-          source = left_column.count > right_column.count ? left_column : right_column
-          source.each_with_index do |_r,idx|
-            rows << "%-22.22s %s " % [ left_column[idx].to_s+"     ", right_column[idx].to_s ]
-          end
-          rows.join("\n").gsub(/\s*$/,'')
+          render_2col_lines(left_column, right_column)
         end
       end
       # @endgroup
 
       private
-      # @group private api
+      # @group private API
 
+      # Format a 2 column text-output
+      # @example
+      #
+      #       $ bin/rst -p
+      #       work
+      #            April 2013        EVENTS:
+      #       Su Mo Tu We Th Fr Sa   Wed, Apr 24 2013: RailsConf2013 7h Abflug München + TÜV-Audit
+      #           1  2  3  4  5  6   Mon, Apr 29 2013: RailsConf2013
+      #        7  8  9 10 11 12 13   Tue, Apr 30 2013: RailsConf2013
+      #       14 15 16 17 18 19 20   Wed, May 01 2013: RailsConf2013
+      #       21 22 23 24 25 26 27   Thu, May 02 2013: RailsConf2013
+      #       28 29 30               Fri, May 03 2013: RailsConf2013
+      #                              Sat, May 04 2013: RailsConf2013 Ankunft München
+      #                              Mon, May 06 2013: Exam Romy
+      #            May 2013
+      #       Su Mo Tu We Th Fr Sa
+      #       1  2  3  4
+      #       5  6  7  8  9 10 11
+      #       12 13 14 15 16 17 18
+      #       19 20 21 22 23 24 25
+      #       26 27 28 29 30 31V
+      #
+      # @param [Array] left - lines for the left column
+      # @param [Array] right - lines for the right column
+      # @return [String] - 2 column text-lines
+      def render_2col_lines(left,right)
+        source = left.count > right.count ? left : right
+        rows = []
+        source.each_with_index do |_r,idx|
+          rows << "%-22.22s %s " % [ left[idx].to_s+"     ", right[idx].to_s ]
+        end
+        rows.join("\n").gsub(/\s*$/,'')
+      end
 
-      # Uses OS'cal-command to format a small calendar for a given month
+      # Uses OS' cal-command to format a small calendar for a given month
       # @param [Date|String] from - start on date
       # @param [Date|String] to - end on date
-      # @return [Arra] of text-lines
+      # @return [Array] of text-lines
       def build_cal from, to
         (from..to).map{ |d| [d.month, d.year ] }.uniq.map { |m,y|
           `cal #{m} #{y}`
         }.join("\n").split(/\n/)
       end
+
       # Output date and Events on this date in one line
       # @param [Date] _date
       # @param [Boolean] show_empty - do output lines with no events

data/lib/modules/calendar/calendar_event.rb

@@ -3,7 +3,7 @@ module RST
   module Calendar
 
     # A CalendarEvent happens on a given date and has a label. 
-    # It's can be used in a Calendar
+    # It can be used in a Calendar
     # @see Calendar::Calendar
     # @see Calendar::Eventable
     # @example

data/lib/modules/persistent/persistent.rb

@@ -60,11 +60,10 @@ module RST
       def move_store store
         if @store && @store != store
           raise NotImplementedError.new('An object can\'t be moved to another store')
-        elsif @store == store
-          self
-        else
+        elsif @store != store
           @store = store
         end
+        self.store
       end
     end
 

data/lib/modules/persistent/store.rb

@@ -43,11 +43,18 @@ module RST
       end
 
       # @param [Array|String] ids or id to search
+      # @yield [Object] for each object found
       # @return [nil]    if nothing found
       # @return [Object] if exactly one object found
       # @return [Array]  of objects with matching ids if more than one matched
       def find(*ids)
-        flatten all.select { |obj| ids.include?(obj.id) }
+        if block_given?
+          all.select { |obj| ids.include?(obj.id) }.each do |obj|
+            yield(obj)
+          end
+        else
+          flatten all.select { |obj| ids.include?(obj.id) }
+        end
       end
 
 

data/lib/rst.rb

@@ -41,6 +41,9 @@ module RST
     attr_reader :command
 
     # Initialize the Command-runner with arguments and parse them.
+    # @example
+    #   app = RstCommand.new(ARGV)
+    #   app.run()
     def initialize(args)
       load_defaults
       parse_options(args)
@@ -70,20 +73,32 @@ module RST
       OptionParser.new do |opts|
         opts.banner = 'Usage: rst [COMMAND] [options] [FILES..]'
 
+        opts.separator "\nCommands:"
+        opts.separator <<-EOT
+          nil .......... no command. Interpret options only (useful in combination with -v)
+          ls ........... list directory and files
+          cal[endar] ... print a calendar. See Calendar-options.
+        EOT
+        .gsub(/^\s+/,'    ')
+
         opts.separator "\nOptions:"
 
         opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
           @options[:verbose] = v
         end
 
-        opts.on('--examples', 'Show some usage examples') do |x|
+        opts.on('--examples', 'Show usage examples') do |x|
           @options[:examples] = x
         end
 
-        opts.on('-h', '--help', 'Print help') do |h|
+        opts.on('-h', '--help', 'Print (this) help') do |h|
           puts opts
         end
 
+        opts.separator ''
+        opts.separator 'Calendar-options:'
+
+        opts.separator '  Calendar-metadata'
         opts.on('-f', '--from DATE', String, 'Set from-date') do |from|
           @options[:from] = from
         end
@@ -92,11 +107,12 @@ module RST
           @options[:to] = to
         end
 
-        opts.on('-n', '--name NAME', String, 'Use this name for the command') do |name|
+        opts.on('-n', '--name NAME', String, 'Use this name for eg. calendar') do |name|
           @options[:name] = name
         end
 
-        opts.on('-e', '--new-event [DATE,]STRING', Array, 'Add an event') do |date,name|
+        opts.separator '  Events'
+        opts.on('-e', '--new-event [DATE,]STRING', Array, 'Add an event to NAME') do |date,name|
           if name.nil?
             name = date
             date = Date.today
@@ -104,18 +120,30 @@ module RST
           @options[:new_event] = {date: date, label: name}
         end
 
+        opts.on('--delete-events ID[,ID,...]',Array, 'delete entries from calendar NAME') do |ids|
+          @options[:delete_events] = ids
+        end
+
+        opts.separator '  Calendar-actions'
+
+        opts.on('-p', '--print-calendar', 'Print calendar') do |p|
+          @options[:print_calendar] = p
+        end
+
+        opts.on('-d', '--dump', 'Dump calendar-events' ) do |d|
+          @options[:dump] = d
+        end
+
         opts.on('--list-calendars', 'List available calendars') do
           @options[:list_calendars] = true
         end
 
-        opts.on('--delete-calendar CALENDARNAME', String, 'Delete an calendar and all it\'s entries!') do |name|
+        opts.on('--delete-calendar CALNAME', String, 'Delete an calendar and all it\'s entries!') do |name|
           @options[:delete_calendar] = name
         end
 
-        opts.on('--delete-events ID[,ID,...]',Array, 'delete entries from calendar') do |ids|
-          @options[:delete_events] = ids
-        end
 
+        opts.separator '  Output-options'
         opts.on('--[no-]empty', 'Show empty entries') do |show|
           @options[:show_empty] = show
         end
@@ -124,10 +152,8 @@ module RST
           @options[:with_ids] = ids
         end
 
-        opts.on('-d', '--dump', 'Dump calendar-events' ) do |d|
-          @options[:dump] = d
-        end
-
+        opts.separator ''
+        opts.separator 'Other options:'
         opts.on('--save-defaults', 'Save given params as defaults') do |v|
           @options[:save_defaults] = v
         end
@@ -140,22 +166,8 @@ module RST
           @options[:clear_defaults] = v
         end
 
-        opts.on('-p', '--print-calendar', 'Print calendar') do |p|
-          @options[:print_calendar] = p
-        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+/,'    ')
-
         opts.separator ''
-        opts.separator 'DATE-FORMATS FOR --new-event:'
+        opts.separator 'DATE-formats used in --to, --form, and  --new-event:'
         opts.separator <<-EOT
           omitted....... today
           today ........ today
@@ -375,8 +387,7 @@ module RST
     def save_defaults
       store = Persistent::DiskStore.new('defaults')
       options.delete(:save_defaults)
-      defaults = Defaults.new( command, options )
-      store << defaults
+      store << Defaults.new( command, options )
       "Defaults saved"
     end
 

data/rst.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyshelltools
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors: