main 4.3.0 → 4.4.0

data/README

@@ -450,6 +450,48 @@ SAMPLES
     "forty-two"
 
 
+  <========< samples/j.rb >========>
+
+  ~ > cat samples/j.rb
+
+    #!/usr/bin/env ruby
+    
+    require 'open-uri'
+    
+    require 'main'
+    require 'digest/sha2'
+    
+    # you have access to a sequel/amalgalite/sqlite db for free
+    #
+    
+    Main {
+      name :i_can_haz_db
+    
+      db {
+        create_table(:mp3s) do
+          primary_key :id
+          String :url
+          String :sha
+        end unless table_exists?(:mp3s)
+      }
+    
+      def run
+        url = 'http://s3.amazonaws.com/drawohara.com.mp3/ween-voodoo_lady.mp3'
+        mp3 = open(url){|fd| fd.read}
+        sha = Digest::SHA2.hexdigest(mp3)
+    
+        db[:mp3s].insert(:url => url, :sha => sha)
+        p db[:mp3s].all
+        p db
+      end
+    }
+
+  ~ > ruby samples/j.rb
+
+    [{:url=>"http://s3.amazonaws.com/drawohara.com.mp3/ween-voodoo_lady.mp3", :sha=>"54c99ac7588dcfce1e70540b734805e9c69ff98dcca001e6f2bdec140fb0f9dc", :id=>1}, {:url=>"http://s3.amazonaws.com/drawohara.com.mp3/ween-voodoo_lady.mp3", :sha=>"54c99ac7588dcfce1e70540b734805e9c69ff98dcca001e6f2bdec140fb0f9dc", :id=>2}]
+    #<Sequel::Amalgalite::Database: "amalgalite://Users/ahoward/.i_can_haz_db/db.sqlite">
+
+
 
 DOCS
   test/main.rb
@@ -457,6 +499,69 @@ DOCS
   API section below
 
 HISTORY
+  4.4.0
+    - support for automatic sequel/sqlite/amalgalite dbs for persistent state
+      across invocations
+
+        Main {
+          db {
+            create_table :foo do
+              String key
+              String val
+            end unless table_exists? :foo
+          }
+
+          def run
+            db[:foo].create(:key => 'using', :val => 'amalgalite')
+          end
+        }
+
+      - support for automatic config files with auto populated template data
+
+          Main {
+            config :email => 'your.addy@gmail.com', :password => 'pa$$word'
+
+            def run
+              email = config[:email]
+            end
+          }
+
+      - new paramter types :pathname, :path, :slug, :input, and :output 
+
+      - input/output parameters.  can be filenames or '-' to supply
+        stdin/stdout respectively
+
+          Main {
+            input :i
+            output :o
+
+            def run
+              i = params[:i].value
+              o = params[:o].value
+
+              line = i.gets
+              o.puts line
+            end
+          }
+
+       - clean up warnings running with 'ruby -w'
+
+       - fix a failing test
+
+       - ability to ignore parameters in sub modes
+
+          Main {
+            argument :foo
+            argument :bar
+
+            def run
+              p param[:bar].value
+            end
+
+            mode :ignoring do
+              params[:foo].ignore!
+            end
+          }
   4.0.0
     - avoid duping ios.  new methods Main.push_ios! and Main.pop_ios! are
     utilized for testing.  this was done to make it simple to wrap

data/README.erb

@@ -5,9 +5,9 @@ SYNOPSIS
   a class factory and dsl for generating command line programs real quick
 
 URI
+  http://github.com/ahoward/main
   http://codeforpeople.com/lib/ruby/
   http://rubyforge.org/projects/codeforpeople/
-  http://github.com/ahoward/main
 
 INSTALL
   gem install main
@@ -26,6 +26,8 @@ DESCRIPTION
     - parsing user defined ARGV and ENV
     - zero requirements for understanding the obtuse apis of *any* command
       line option parsers
+    - built-in support for persistent state via sqlite/sequel/amalgalite
+    - built-in support for yaml config files
     - leather pants
 
   in short main.rb aims to drastically lower the barrier to writing uniform
@@ -186,6 +188,82 @@ DOCS
   API section below
 
 HISTORY
+  4.4.0
+    - app storage under a dotdir. for example
+
+        Main {
+          name :foobar
+        }
+
+      will have a ~/.foobar/ directory available for storing db/config/etc.
+
+    - support for automatic sequel/sqlite/amalgalite dbs for persistent state
+    across invocations.  the db is automatically created under the main
+    programs dotdir (~/.$appname/db.sqlite)
+
+        Main {
+          db {
+            create_table :foo do
+              String key
+              String val
+            end unless table_exists? :foo
+          }
+
+          def run
+            db[:foo].create(:key => 'using', :val => 'amalgalite')
+          end
+        }
+
+      - support for automatic config files with auto populated template data.
+      the first time the program is run the user's editor will be invoked on a
+      config file pre-populate with the same config.  subsequent invocations
+      will use the user configured values. the config file is stored at
+      ~/.$appname/config.yml
+
+          Main {
+            config :email => 'your.addy@gmail.com', :password => 'pa$$word'
+
+            def run
+              email = config[:email]
+            end
+          }
+
+      - new paramter types :pathname, :path, :slug, :input, and :output 
+
+      - input/output parameters.  can be filenames or '-' to supply
+        stdin/stdout respectively
+
+          Main {
+            input :i
+            output :o
+
+            def run
+              i = params[:i].value
+              o = params[:o].value
+
+              line = i.gets
+              o.puts line
+            end
+          }
+
+       - clean up warnings running with 'ruby -w'
+
+       - fix a failing test
+
+       - ability to ignore parameters in sub modes
+
+          Main {
+            argument :foo
+            argument :bar
+
+            def run
+              p param[:bar].value
+            end
+
+            mode :ignoring do
+              params[:foo].ignore!
+            end
+          }
   4.0.0
     - avoid duping ios.  new methods Main.push_ios! and Main.pop_ios! are
     utilized for testing.  this was done to make it simple to wrap

data/TODO

@@ -1,20 +1,18 @@
+todo:
+  - examples of new features
+  - use map.rb
 
-* support pathname casts
-* support uri casts
-* support filename casts
-* support directory costs
-* support io cast '-' (:input, :output)
-
-* fix weird super bug jeremy found
-
-* figure out how to support '-' ??
-
-* clean up warnings under 'ruby -w'
-* error reporting weird for some errors
-
-===============================================================================
-X calls to abort sometimes lead to STDERR prining twice ;-(
-X main's' with modes, but no run do not operate properly - add default run w/wrap_run!
-X usage fubar when extra chunks are set
-X usage of arguments is fubar when negative arities are used
-X add sanity checks at parameter contruction completion
+done:
+  - clean up warnings under 'ruby -w'
+  - intput/output arguments
+  - support io cast '-' (:input, :output)
+  - slug casts
+  - support uri casts
+  - dotdir support (based on name)
+  - db support
+  - configuration/configfile file support
+  - calls to abort sometimes lead to STDERR prining twice ;-(
+  - main's' with modes, but no run do not operate properly - add default run w/wrap_run!
+  - usage fubar when extra chunks are set
+  - usage of arguments is fubar when negative arities are used
+  - add sanity checks at parameter contruction completion

data/a.rb

@@ -1,6 +1,33 @@
 require 'main'
 
 Main {
-  argument('zero_or_more'){ arity(-1) }
-  run{ p params }
+
+  name :foobar
+
+  db {
+    create_table(:foo) do
+      primary_key :id
+      String :name
+      Float :price
+    end unless table_exists?(:foo)
+  }
+
+  config(
+    :email => 'your.addy@gmail.com',
+    :password => 'yourPa$$word'
+  )
+
+  io
+
+
+  def run
+    #p input.path
+    #p output.path
+    p params.map{|param| param.name}
+    output.puts(:foobar)
+  end
+
+  mode :foo do
+    params[:input].ignore!
+  end
 }

data/lib/main.rb

@@ -2,7 +2,7 @@ module Main
 #
 # top level constants
 #
-  Main::VERSION = '4.3.0' unless
+  Main::VERSION = '4.4.0' unless
     defined? Main::VERSION
   def self.version() Main::VERSION end
 
@@ -13,6 +13,7 @@ module Main
   Main::EXIT_SUCCESS = 0 unless defined? Main::EXIT_SUCCESS
   Main::EXIT_FAILURE = 1 unless defined? Main::EXIT_FAILURE
   Main::EXIT_WARN = 42 unless defined? Main::EXIT_WARN
+  Main::EXIT_WARNING = 42 unless defined? Main::EXIT_WARNING
 #
 # built-in
 #

data/lib/main/cast.rb

@@ -25,7 +25,7 @@ module Main
     end
 
     cast :integer do |obj|
-      Integer obj
+      Float(obj).to_i
     end
 
     cast :float do |obj|
@@ -45,7 +45,7 @@ module Main
     end
 
     cast :uri do |obj|
-      require 'uri'
+      require 'uri' unless defined?(::URI)
       ::URI.parse obj.to_s
     end
 
@@ -55,10 +55,53 @@ module Main
     end
 
     cast :date do |obj|
-      require 'date'
+      require 'date' unless defined?(::Date)
       ::Date.parse obj.to_s
     end
 
+    cast :pathname do |obj|
+      require 'pathname' unless defined?(::Pathname)
+      Pathname.new(obj.to_s)
+    end
+
+    cast :path do |obj|
+      File.expand_path(obj.to_s)
+    end
+
+    cast :input do |obj|
+      case obj.to_s
+        when '-'
+          io = STDIN.dup
+          io.fattr(:path){ '/dev/stdin' }
+          io
+        else
+          io = open(obj.to_s, 'r+')
+          at_exit{ io.close }
+          io
+      end
+    end
+
+    cast :output do |obj|
+      case obj.to_s
+        when '-'
+          io = STDOUT.dup
+          io.fattr(:path){ '/dev/stdout' }
+          io
+        else
+          io = open(obj.to_s, 'w+')
+          at_exit{ io.close }
+          io
+      end
+    end
+
+    cast :slug do |obj|
+      string = [obj].flatten.compact.join('-')
+      words = string.to_s.scan(%r/\w+/)
+      words.map!{|word| word.gsub %r/[^0-9a-zA-Z_-]/, ''}
+      words.delete_if{|word| word.nil? or word.strip.empty?}
+      String(words.join('-').downcase)
+    end
+
     cast :list do |*objs|
       [*objs].flatten.join(',').split(/,/)
     end

data/lib/main/parameter.rb

@@ -109,10 +109,15 @@ module Main
       names.first
     end
 
-    def default 
+    def default(*values)
+      defaults(values) unless values.empty?
       defaults.first
     end
 
+    def default=(value)
+      default(value)
+    end
+
     def typename
       prefix = '--' if type.to_s =~ %r/option/
       "#{ type }(#{ prefix }#{ name })"
@@ -248,6 +253,13 @@ module Main
       end
     end
 
+    def remove
+      main.parameters.delete(self)
+    end
+    alias_method('remove!', 'remove')
+    alias_method('ignore', 'remove')
+    alias_method('ignore!', 'ignore')
+
     class Argument < Parameter
       fattr 'required' => true
 
@@ -527,6 +539,15 @@ module Main
         delete(*a)
         super
       end
+
+      def [](*index)
+        first = index.first
+        if(index.size == 1 and (first.is_a?(String) or first.is_a?(Symbol)))
+          first = first.to_s
+          return detect{|param| param.name == first}
+        end
+        return super
+      end
     end
 
     class DSL

data/lib/main/program/class_methods.rb

@@ -21,11 +21,11 @@ module Main
       fattr('exit_success'){ Main::EXIT_SUCCESS }
       fattr('exit_failure'){ Main::EXIT_FAILURE }
       fattr('exit_warn'){ Main::EXIT_WARN }
+      fattr('exit_warning'){ Main::EXIT_WARNING }
       fattr('parameters'){ Main::Parameter::List[] }
       fattr('can_has_hash'){ Hash.new }
       fattr('mixin_table'){ Hash.new }
 
-      fattr('factory')
       fattr('argv')
       fattr('env')
       fattr('opts')
@@ -35,6 +35,10 @@ module Main
       end
       alias_method 'create', 'factory'
 
+      def factory=(factory)
+        @factory = factory
+      end
+
       class Factory
         def initialize(&block)
           @block = block || lambda{}
@@ -84,6 +88,10 @@ module Main
         instance
       end
 
+      def params
+        parameters
+      end
+
       def evaluate(&block)
         module_eval(&block)
       end
@@ -182,23 +190,23 @@ module Main
       end
 
       def parameter(*a, &b)
-        (parameters << Parameter.create(:parameter, self, *a, &b)).last
+        (parameters << Parameter.create(:parameter, main=self, *a, &b)).last
       end
 
       def argument(*a, &b)
-        (parameters << Parameter.create(:argument, self, *a, &b)).last
+        (parameters << Parameter.create(:argument, main=self, *a, &b)).last
       end
 
       def option(*a, &b)
-        (parameters << Parameter.create(:option, self, *a, &b)).last
+        (parameters << Parameter.create(:option, main=self, *a, &b)).last
       end
 
       def keyword(*a, &b)
-        (parameters << Parameter.create(:keyword, self, *a, &b)).last
+        (parameters << Parameter.create(:keyword, main=self, *a, &b)).last
       end
 
       def environment(*a, &b)
-        (parameters << Parameter.create(:environment, self, *a, &b)).last
+        (parameters << Parameter.create(:environment, main=self, *a, &b)).last
       end
 
       def default_options!
@@ -259,6 +267,86 @@ module Main
         block ||= lambda{}
         define_method(:run, &block) if block
       end
+
+      def dotdir(*dotdir, &block)
+        @dotdir = File.join(Util.home, ".#{ name }") unless defined?(@dotdir)
+
+        @dotdir = dotdir.join('/') unless dotdir.empty?
+
+        if block
+          require 'fileutils' unless defined?(FileUtils)
+          FileUtils.mkdir_p(@dotdir) unless test(?d, @dotdir)
+          Dir.chdir(&block)
+        else
+          @dotdir
+        end
+      end
+
+      def db(*args, &block)
+        unless defined?(@db)
+          require 'sequel' unless defined?(Sequel)
+          require 'amalgalite' unless defined?(Amalgalite)
+          @db = dotdir{ Sequel.amalgalite(db_path) }
+          @db.instance_eval(&block) if block
+        end
+        @db
+      end
+
+      def db_path(*db_path)
+        @db_path = File.join(dotdir, 'db.sqlite') unless defined?(@db_path)
+        @db_path = File.join(*db_path) unless db_path.empty?
+        @db_path
+      end
+
+      def config(*args, &block)
+        unless defined?(@config)
+          require 'yaml' unless defined?(YAML)
+          if test(?s, config_path)
+            @config = YAML.load(IO.read(config_path))
+          else
+            config = args.last.is_a?(Hash) ? args.last : {}
+            lines = config.to_yaml.split(/\n/)
+            dash = lines.shift
+            open(config_path, 'w') do |fd|
+              fd.puts '### you may need to edit this config!'
+              fd.puts
+              fd.puts lines
+            end
+            editor = ENV['EDITOR'] || ENV['EDIT'] || 'vi'
+            system("#{ editor.inspect } #{ config_path }")
+            @config = YAML.load(IO.read(config_path))
+          end
+        end
+        @config
+      end
+
+      def config_path(*config_path)
+        @config_path = File.join(dotdir, 'config.yml') unless defined?(@config_path)
+        @config_path = File.join(*config_path) unless config_path.empty?
+        @config_path
+      end
+
+      def input(*args, &block)
+        first = args.first
+        args.push(:input) unless(first.is_a?(Symbol) or first.is_a?(String))
+        param = argument(*args, &block)
+        param.cast(:input)
+        param
+      end
+
+      def output(*args, &block)
+        first = args.first
+        args.push(:output) unless(first.is_a?(Symbol) or first.is_a?(String))
+        param = argument(*args, &block)
+        param.cast(:output)
+        param
+      end
+
+      def io(*args)
+        i = input(*[args.shift].compact).default('-')
+        o = output(*[args.shift].compact).default('-')
+        [i, o]
+      end
     end
 
     extend ClassMethods

data/lib/main/program/instance_methods.rb

@@ -16,7 +16,7 @@ module Main
 
       %w( 
         program name synopsis description author version
-        exit_status exit_success exit_failure exit_warn
+        exit_status exit_success exit_failure exit_warn exit_warning
         logger_level
         usage
       ).each{|a| fattr(a){ self.class.send a}}
@@ -31,9 +31,9 @@ module Main
       end
 
       %w( debug info warn fatal error ).each do |m|
-        module_eval <<-code
-          def #{ m } *a, &b
-            logger.#{ m } *a, &b
+        module_eval <<-code, __FILE__, __LINE__
+          def #{ m }(*a, &b)
+            logger.#{ m }(*a, &b)
           end
         code
       end
@@ -87,7 +87,6 @@ module Main
       end
 
       def setup_io_restoration
-      return
         @finalizers ||= []
         [STDIN, STDOUT, STDERR].each do |io|
           dup = io.dup
@@ -250,9 +249,9 @@ module Main
       end
 
       %w[ before instead after ].each do |which|
-        module_eval <<-code
-          def error_handler_#{ which } *argv, &block
-            block.call *argv
+        module_eval <<-code, __FILE__, __LINE__
+          def error_handler_#{ which }(*argv, &block)
+            block.call(*argv)
           end
         code
       end
@@ -265,6 +264,26 @@ module Main
         singleton_class.module_eval{ define_method('__instance_eval_block', &block) }
         fcall(self, '__instance_eval_block', *argv, &block)
       end
+
+      def dotdir(&block)
+        self.class.dotdir(&block)
+      end
+
+      def db(&block)
+        self.class.db(&block)
+      end
+
+      def config(&block)
+        self.class.config(&block)
+      end
+
+      def input
+        @input ||= params[:input].value if params[:input]
+      end
+
+      def output
+        @output ||= params[:output].value if params[:output]
+      end
     end
 
     include InstanceMethods

data/lib/main/util.rb

@@ -71,6 +71,20 @@ module Main
 
         return default
       end
+
+      def home
+        home =
+          catch :home do
+            ["HOME", "USERPROFILE"].each do |key|
+              throw(:home, ENV[key]) if ENV[key]
+            end
+            if ENV["HOMEDRIVE"] and ENV["HOMEPATH"]
+              throw(:home, "#{ ENV['HOMEDRIVE'] }:#{ ENV['HOMEPATH'] }")
+            end
+            File.expand_path("~") rescue(File::ALT_SEPARATOR ? "C:/" : "/")
+          end
+        File.expand_path(home)
+      end
     end
 
     BLESS = lambda do |other|

data/main.gemspec

@@ -4,7 +4,7 @@
 Gem::Specification::new do |spec|
   spec.name = "main"
   spec.description = 'a class factory and dsl for generating command line programs real quick'
-  spec.version = "4.3.0"
+  spec.version = "4.4.0"
   spec.platform = Gem::Platform::RUBY
   spec.summary = "main"
 

data/samples/j.rb

@@ -1,14 +1,31 @@
 #!/usr/bin/env ruby
+
+require 'open-uri'
+
 require 'main'
+require 'digest/sha2'
+
+# you have access to a sequel/amalgalite/sqlite db for free
+#
 
 Main {
-  mode( :foo ) {
-    argument( :bar ) {
-      required
-      default 42
-    }
-    run {
-      puts "Doing something with #{params['bar'].value}"
-    }
+  name :i_can_haz_db
+
+  db {
+    create_table(:mp3s) do
+      primary_key :id
+      String :url
+      String :sha
+    end unless table_exists?(:mp3s)
   }
+
+  def run
+    url = 'http://s3.amazonaws.com/drawohara.com.mp3/ween-voodoo_lady.mp3'
+    mp3 = open(url){|fd| fd.read}
+    sha = Digest::SHA2.hexdigest(mp3)
+
+    db[:mp3s].insert(:url => url, :sha => sha)
+    p db[:mp3s].all
+    p db
+  end
 }

data/test/main.rb

@@ -258,7 +258,7 @@ class T < Test::Unit::TestCase
         }
         option('y'){ 
           argument_required
-          process{|*values| values.join.split(',').map{|value| value.upcase}}
+          cast{|*values| values.join.split(',').map{|value| value.upcase}}
         }
         define_method('run'){ param = params }
       }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: main
 version: !ruby/object:Gem::Version 
-  hash: 51
+  hash: 47
   prerelease: false
   segments: 
   - 4
-  - 3
+  - 4
   - 0
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors: 
 - Ara T. Howard
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-07 01:00:00 -06:00
+date: 2010-11-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency