rubyshelltools 0.0.2 → 0.0.3

data/README.md

@@ -1,18 +1,34 @@
 Ruby Shell Tools
 ================
 
-RST Version 0.0.1 is an experimental Ruby2-gem by Andreas Altendorfer <andreas@altendorfer.at>
+RubyShellTools, RST is an experimental Ruby2-gem by Andreas Altendorfer <andreas@altendorfer.at>
+
+
+Inspired by this [talk about nodoc][] and by the clean style of
+[Martin's code][],  I've playing around with Ruby2, Yard, and my idea of
+clean code with this gem named 'RubyShellTools' (short RST, but this
+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 ...
+
 
 Install from rubygems.org
 -------------------------
+ 
+Find the gem at [RubyGems.org][]
 
     gem install rubyshelltools
+    export RST_DATA=$HOME/.rst # default:  GEM_PATH/rubyshelltools/data
+    export RST_ENV=production  # defaults: development
+    rst --help
 
 
-Clone from Github
------------------
+Clone/Fork from Github
+----------------------
 
-You can clone the project from **[Github](https://github.com/iboard/rst)**
+You can clone from or fork the project at => [Github][]
 
     git clone git://github.com/iboard/rst.git
 
@@ -32,7 +48,7 @@ Usage
 
 see file EXAMPLES.md:
 
- * [At Github](https://github.com/iboard/rst/blob/master/assets/docs/examples.md#examples)
+ * [EXAMPLES on Github][]
  * [loacal copy](./file.examples.html)
  
 or run
@@ -48,39 +64,77 @@ Documentation
 run `yard; open doc/index.html` to build the rdocs and open
 it in your browser.
 
-The documentation can be found also at
-[dav.iboard.cc](http://dav.iboard.cc/container/rst-doc)
+The latest version is online at my [DAV-server][] too.
+
+Browsing the code
+-----------------
+
+  **modules**
+  
+ Modules are the core of this project. Within the directory
+ `lib/modules` you'll find
+
+     * calendar           # Everything about Calendars 
+       * calendar         # The Calendar-module and -class
+       * eventable        # Eventable API (module to make a class an event)
+       * calendar_event   # CalendarEvent-class
+      
+     * persistent         # Make things persistent
+       * persistent       # The Persistent-Module defines Persistentable/API
+       * store            # The abstract Store-class
+       * memory_store     # Store-descendant for a non-persistent memory-store
+       * disk_store       # Store-descendant using ruby-PStore to save to disk
+
+
+  **command-line implementation**
+  
+     * ./rst.rb           # Defines global Constants and the Logger
+     * ./lib/rst.rb       # Defines the class RstCommand used for the
+                          #   command-line-implementation
+     * ./lib/load.rb      # requires all necessary files
+                          #   used by bin/rst and spec/spec_helper.rb
+     * ./bin/rst          # Loads the library and instantiates a
+                          #   RstCommand-object
+
+  **RstCommand**
+
+Can handle two commands by now: 
+
+_ls_, 
+  the directory-listing, is coded
+inline and does a simple Dir for the given wildcards.
+
+_print_calendar_,
+  opens the calendar-file (all calendars are stored in one file) and acts on the calendar 
+named by the --name parameter. It uses _DiskStore_ to make the calendars
+persistent.
+
+      cal = find_calendar( Persistent::DiskStore.new(CALENDAR_FILE) )
+      cal.list_days(options[:from], options[:to], options[:show_empty]).compact.join("\n")
+  
+
 
 TDD
 ---
 
 And as always we are **green**
 
-You can find the current output of [simplecov][] at [dav.iboard.cc](http://dav.iboard.cc/container/rst-coverage)
-
-
-> $ rake
->
-> Finished in _a few_ seconds
->
-> _n_ examples, 0 failures
->
-> Coverage report generated for RSpec to rst/coverage. _n_ / _n+-0_ LOC (**100.0%**) covered.
->
-> $ yard
->
-> Files:          _n_
->
-> Modules:         _n_ (    0 undocumented)
->
-> Classes:         _n_ (    0 undocumented)
->
-> Constants:      _n_ (    0 undocumented)
->
-> Methods:        _n_ (    0 undocumented)
->
-> **100.00% documented**
+See the current [coverage output][] (generated with [simplecov][])
+
+Running `rake` and `yard` from the project-directory the output should include
+the following lines ...
+
+    Finished in _a few_ seconds
+    _n_ examples, *0* failures
+    Coverage report generated for RSpec to rst/coverage. _n_ / _n+-0_ LOC (**100.0%**) covered.
+    **100.00% documented**
+
+To run specs you can use rake-tasks
 
+    rake [test]      # Run Module-specs w/o command-line calls (default)
+    rake all         # Run all tests including specs/commands
+    rake commands    # Run command-specs only (slower because of system-calls)
+    rake modules     # Run module-specs only
 
 License
 =======
@@ -99,3 +153,10 @@ Copyright
 
 
 [simplecov]: http://github.com/colszowka/simplecov 
+[RubyGems.org]: https://rubygems.org/gems/rubyshelltools
+[coverage output]: http://dav.iboard.cc/container/rst-coverage
+[Github]: https://github.com/iboard/rst
+[EXAMPLES on Github]: https://github.com/iboard/rst/blob/master/assets/docs/examples.md#examples
+[DAV-Server]: http://dav.iboard.cc/container/rst-doc
+[talk about nodoc]: http://www.youtube.com/watch?v=tCw7CpRvYOE
+[Martin's code]: https://github.com/snusnu

data/assets/docs/examples.md

@@ -90,3 +90,21 @@ The full set of parameters is
 * --empty ...... show empty lines
 * --no-empty ... show no empty lines (default)
 
+
+Save defaults
+=============
+
+You can save options with `--save-defaults` and then cal rst without
+options to execute it with command and saved-options 
+
+    $ rst calendar --from '1964-01-01' --to today --save-defaults
+    Defaults Saved
+    Mon, Aug 31 1964: Birthday Andreas Altendorfer
+    
+    $ rst
+    Mon, Aug 31 1964: Birthday Andreas Altendorfer
+
+You can delete saved options with `--clear-defaults` or list saved
+options with `--list-defaults`
+
+

data/bin/rst

@@ -8,4 +8,5 @@ include RST
 
 
 # Run rst from commandline
-puts RstCommand.new(ARGV).run
+output = RstCommand.new(ARGV).run
+puts output unless output.blank?

data/lib/core_extensions/string.rb

@@ -0,0 +1,9 @@
+
+# Monkeypatch string with some useful methods
+class String
+  # @return [Boolean] - true if self is empty or filled with spaces only
+  def blank?
+    self.strip == ''
+  end
+end
+

data/lib/errors/store_errors.rb

@@ -1,6 +1,25 @@
 module RST
 
   # Exception thrown when an abstract method is called
-  class AbstractMethodCallError < NotImplementedError; end
+  class AbstractMethodCallError < NotImplementedError
+
+    def initialize message='Please define '
+      _message = [ message, format_backtrace(caller_locations(2,1)), 'Called from:']
+      (3..24).to_a.each do |n|
+        _message << format_backtrace(caller_locations(n,1))
+      end
+      super(_message.join(" => "))
+    end
+
+    private
+
+    # Output the filename and line of a backtrace-step
+    # @param [Array] l - one caller_location-line
+    # @return [String]
+    def format_backtrace(l)
+      "%s in %s:%d" % [l[0].label,File.basename(l[0].path),l[0].lineno]
+    end
+
+  end
 
 end

data/lib/load.rb

@@ -21,6 +21,7 @@ unless defined? LIB_LOADED
 
   $LOAD_PATH.unshift(File.expand_path('../core_extensions',__FILE__))
   require 'numeric'
+  require 'string'
   require 'mutex'
 
   $LOAD_PATH.unshift(File.expand_path('../errors',__FILE__))

data/lib/modules/calendar/calendar.rb

@@ -68,6 +68,8 @@ module RST
       include Persistent::Persistentable
       include CalendarHelper
 
+      # @group public api
+
       attr_reader :name, :start_date, :end_date, :events
    
       # @param [String] _name Name and persistent-id of this calendar.
@@ -129,7 +131,6 @@ module RST
       end
       
   
-      private
       # All events on the given date
       # @param [Date] date 
       # @return [Array] of [CalendarEvents]
@@ -137,19 +138,17 @@ module RST
         events.select { |event| event.event_date == date }
       end
       
-      # Convert strings to a date
-      # @param [Date|Time|String] param - default is 'today'
-      # @return [Date|Time]
-      def parse_date_param(param=Date.today)
-        ensure_date(param)
-      end
+      # @endgroup
+
+      private
+      # @group private api
 
       # Output date and Events on this date in one line
       # @param [Date] _date
       # @param [Boolean] show_empty - do output lines with no events
       # @return [String]
       def format_events_for(_date,show_empty=false)
-        if show_empty || (_line=event_headlines_for(_date)) != ''
+        if  (_line=event_headlines_for(_date)) != '' || show_empty
           "%s: %s" % [_date.strftime(DEFAULT_DATE_FORMAT), _line]
         end
       end
@@ -161,6 +160,15 @@ module RST
         events_on(_date).map(&:event_headline).join(' + ').strip
       end
   
+      # @endgroup 
+
+      # Convert strings to a date
+      # @param [Date|Time|String] param - default is 'today'
+      # @return [Date|Time]
+      def parse_date_param(param=Date.today)
+        ensure_date(param)
+      end
+
     end
 
   end

data/lib/modules/calendar/eventable.rb

@@ -3,7 +3,8 @@ module RST
 
     # Inject Eventable to any Class to make it event-able in a Calendar
     # You have to define a method :event_headline for the class
-    # in order to list the event in a Calendar
+    # in order to list the event in a Calendar.
+    #
     # @example
     #
     #   class Birthday < Struct.new(:name,:dob)
@@ -17,7 +18,7 @@ module RST
     #     def event_headline
     #       "It's #{name}'s Birthday"
     #     end
-    #  end
+    #   end
     #
     # @see RST::Calendar::Calendar
     module Eventable

data/lib/modules/persistent/disk_store.rb

@@ -56,9 +56,16 @@ module RST
           s[object.id] = object
         end
       end
-     
+
       private
 
+      # @param [Object] object - the object to be removed.
+      def remove_object(object)
+        @store.transaction do |s|
+          s.delete(object.id)
+        end
+      end
+
       # Initialize a PStore-instance
       # @see store_path
       def setup_backend
@@ -75,10 +82,17 @@ module RST
       #
       #     ~/.rst-data/development/store.data
       # 
-      # if no environment-variables defined, the defaulsts will be STOREPATH and 'development'
+      # if no environment-variables defined, the defaults will be STOREPATH and 'development'
       # @see STOREPATH
       # @return [String] 
       def store_path
+        @store_path ||= build_store_path
+      end
+
+      # build the path from ENV-vars and create the directory
+      # if necessary
+      # @return [String] full path of data-file for current environment
+      def build_store_path
         prefix = ENV['RST_DATA'] || RST::STOREPATH
         env = ENV['RST_ENV'] || 'development'
         _dir = File.join( prefix, env )
@@ -86,12 +100,6 @@ module RST
         File.join(_dir, filename)
       end
 
-      # @param [Object] object - the object to be removed.
-      def remove_object(object)
-        @store.transaction do |s|
-          s.delete(object.id)
-        end
-      end
     end
 
   end

data/lib/modules/persistent/store.rb

@@ -71,20 +71,20 @@ module RST
       # @return Enumerable
       # @abstract Overwrite in descendants thus it returns an Enumerable of all objects in the store
       def all
-        raise AbstractMethodCallError.new("Please, overwrite #{__callee__} in #{self.class.to_s}")
+        raise AbstractMethodCallError.new
       end
 
       # Delete the store
       # @abstract - override this method in descendants thus the store removes all objects.
       def delete!
-        raise AbstractMethodCallError.new("Please, overrwrite #{__callee__} in #{self.class.to_s}")
+        raise AbstractMethodCallError.new
       end
 
       # Find and update or add an object to the store
       # @param [Object] object
       # @abstract - override in other StoreClasses
       def update(object)
-        raise AbstractMethodCallError.new("Please, overrwrite #{__callee__} in #{self.class.to_s}")
+        raise AbstractMethodCallError.new
       end
 
       # @endgroup
@@ -114,19 +114,19 @@ module RST
       # objects-array, PStore, database-connection,...
       # @abstract - Overwrite in descendants thus they initialize the store.
       def setup_backend
-        raise AbstractMethodCallError.new("Please override method :setup_backend in class #{self.class.to_s}")
+        raise AbstractMethodCallError.new
       end
 
       # Make sure the current state of objects is stored
       # @abstract - Overwrite in descendants thus every object gets persistently stored.
       def sync_store
-        raise AbstractMethodCallError.new("Please override method :sync_store in class #{self.class.to_s}")
+        raise AbstractMethodCallError.new
       end
 
       # @param [Object] object
       # @abstract - override in concrete StoreClasses
       def remove_object(object)
-        raise AbstractMethodCallError.new("Please, overrwrite #{__callee__} in #{self.class.to_s}")
+        raise AbstractMethodCallError.new
       end
 
     end

data/lib/rst.rb

@@ -1,5 +1,6 @@
 require 'optparse'
 require 'ostruct'
+require_relative './modules/persistent/persistent'
 
 # # Ruby Shell Tools main namespace RST
 #
@@ -41,7 +42,10 @@ module RST
 
     # Initialize the Command-runner with arguments and parse them.
     def initialize(args)
+      load_defaults
       parse_options(args)
+      @command ||= args.shift
+      @files = args
     end
 
     # Call 'run_options' and 'run_command', reject empty returns and join
@@ -62,7 +66,6 @@ module RST
     # @see #run_options
     # @see #run_option
     def parse_options(args)
-      @options = DEFAULT_OPTIONS
       OptionParser.new do |opts|
         opts.banner = 'Usage: rst [COMMAND [COMMAND ....]] [options] [FILES..]'
 
@@ -108,6 +111,18 @@ module RST
           @options[:show_empty] = show
         end
 
+        opts.on('--save-defaults', 'Save given params as defaults') do |v|
+          @options[:save_defaults] = v
+        end
+
+        opts.on('--list-defaults', 'list saved defaults') do |v|
+          @options[:list_defaults] = v
+        end
+
+        opts.on('--clear-defaults', 'Save given params as defaults') do |v|
+          @options[:clear_defaults] = v
+        end
+
         opts.separator 'Commands:'
 
         opts.separator <<-EOT
@@ -140,11 +155,12 @@ module RST
     # @see #command
     # @return [String]
     def run_command
-      case @command=ARGV.shift
+      case @command
       when nil, 'nil', 'null'
         ''
       when 'ls'
-        directory_listing(ARGV.empty? ? ['*'] : ARGV)
+        @files << '*' if @files.empty?
+        directory_listing( @files )
       when 'cal', 'calendar'
         print_calendar
       else
@@ -196,6 +212,12 @@ module RST
         list_calendars
       when 'delete_calendar'
         delete_calendar
+      when 'save_defaults'
+        save_defaults
+      when 'list_defaults'
+        list_defaults
+      when 'clear_defaults'
+        clear_defaults
       else
         nil #noop ignore unknown options likely it's a param for an argument
       end
@@ -240,7 +262,7 @@ module RST
       puts "Binary : #{$0}"
       puts "Command: #{command}"
       puts "Options: #{options.map(&:inspect).join(', ')}"
-      puts "Files  : #{ARGV.any? ? ARGV[1..-1].join(', ') : ''}"
+      puts "Files  : #{@files.join(', ')}"
     end
 
     # @group HELPERS
@@ -274,6 +296,47 @@ module RST
       end
     end
 
+    # Save the given command and options as defaults
+    def save_defaults
+      store = Persistent::DiskStore.new('defaults')
+      options.delete(:save_defaults)
+      defaults = Defaults.new( command, options )
+      store << defaults
+      "Defaults saved"
+    end
+
+    # Load Defaults
+    def load_defaults
+      @options||=DEFAULT_OPTIONS
+      store = Persistent::DiskStore.new('defaults')
+      _defaults = store.find('defaults')
+      if _defaults
+        @command = _defaults.command
+        @options.merge! _defaults.options
+      end
+    end
+
+    # List saved defaults
+    def list_defaults
+      store = Persistent::DiskStore.new('defaults')
+      defaults = store.find('defaults')
+      "Command: #{defaults.command}\nOptions:\n#{list_options(defaults.options)}" if defaults
+    end
+
+    # delete saved defaults
+    def clear_defaults
+      store = Persistent::DiskStore.new('defaults')
+      store.delete!
+    end
+
+    # print options
+    # @param [Hash] _options
+    def list_options(_options)
+      _options.map { |_o|
+        "--#{_o[0]} #{_o[1]}"
+      }.join("\n")
+    end
+
   end
 
   # @group HELPER CLASSES
@@ -290,6 +353,26 @@ module RST
   class EventOptions < Struct.new(:date,:label,:calendar_name,)
   end
 
+  # Defaults Store
+  # @api private
+  class Defaults
+    include Persistent::Persistentable
+
+    attr_reader :command
+    attr_reader :options
+
+    def id
+      'defaults'
+    end
+
+    # @param [String] command
+    # @param [Hash] options
+    def initialize(command,options)
+      @command = command
+      @options = options
+    end
+  end
+
 
 
 end

data/rst.rb

@@ -3,7 +3,7 @@ require 'logger'
 # # Ruby Shell Tools Top-level file
 module RST
   # Gem-version
-  VERSION   = '0.0.2'
+  VERSION   = '0.0.3'
 
   # 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.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-17 00:00:00.000000000 Z
+date: 2013-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -71,6 +71,7 @@ files:
 - ./rst.rb
 - lib/core_extensions/mutex.rb
 - lib/core_extensions/numeric.rb
+- lib/core_extensions/string.rb
 - lib/errors/store_errors.rb
 - lib/load.rb
 - lib/modules/calendar/calendar.rb