libisi 0.3.0 → 0.3.1

data/Manifest

@@ -1,4 +1,6 @@
 LICENSE
+Manifest
+README
 Rakefile
 lib/inifile.rb
 lib/libisi.rb
@@ -74,6 +76,7 @@ lib/libisi/value/base.rb
 lib/libisi/value/property_value.rb
 lib/libisi/value/relation_value.rb
 lib/ordered_hash.rb
+libisi.gemspec
 test/bridge_test.rb
 test/cache_test.rb
 test/chart_test.rb
@@ -86,4 +89,3 @@ test/profile_test.rb
 test/request_test.rb
 test/test
 test/ui_test.rb
-Manifest

data/README

@@ -0,0 +1,177 @@
+Libisi (c) Logintas AG
+
+= Quickstart
+
+Console:
+
+  gem install libisi
+  apt-get install liblog4r-ruby, libruby1.8, libprogressbar-ruby1.8, libcmdparse-ruby
+
+Your script test.rb:
+
+  #!/usr/bin/ruby
+  require "libisi"
+  init_libisi(:ui => "console")
+  
+  args = optparse(:arguments => [["USERNAME","Please provide your username"]])
+  
+  $log.info("Started")
+  if $ui.question("Hello #{args[0]}, yes or now?", :default => true)
+    $log.info("You selected yes")
+
+    $ui.progress_bar("Items",["a","b","z"]) {|v|
+      if $ui.progress_bar_enabled?
+        # print in progressbar
+        $ui.progress_message("Processing item: #{v}")
+      else
+        # print item to console
+        p v
+      end
+      sleep 1
+    }
+
+  else
+    $log.warn("You selected no!")
+  end 
+  
+  exit 0
+
+try:
+  ruby test.rb -h
+  ruby test.rb SOMENAME
+  ruby test.rb --progress SOMENAME
+  ruby test.rb -v SOMENAME
+  ruby test.rb -vv SOMENAME
+
+= Requirements
+
+To use the base functionality, these packages are required
+on debian systems:
+* liblog4r-ruby, libruby1.8, libprogressbar-ruby1.8, libcmdparse-ruby
+
+For additionaly functionalities install these packages:
+* libtmail-ruby1.8,libtext-format-ruby1.8
+
+For generating charts:
+* libjfreechart-java
+
+== Usage
+
+=== Initialize
+
+  #!/usr/bin/ruby
+  require 'libisi'
+  init_libisi(:ui => "console")
+
+= Standard commandline options =
+Parse the commandline options with:
+
+  args = optparse {|o|
+  
+    # additional options  
+    o.on("-d", "--doit","Do something.") do
+      # if you get here the option --doit is given
+      # if mutliple -d exist this will be executed
+      # multiple times
+    end
+  
+    o.on("-c","--config <file>") do |config_file|
+      # config_file is the given argument
+      ...
+    end
+  }
+
+For more information see: http://cmdparse.rubyforge.org
+
+=== Logging
+
+For addidtional information on Log4r see
+ /usr/share/doc/liblog4r-ruby1.8/html/index.html
+or libisi.rb source code how this library is used.
+
+Commandline options added to script:
+  "-q","--quiet"
+  "-v","--verbose"
+
+==== Usage
+Simple logging mechanism. Try to aviod 
+normal brackets. If you use a block like
+$log.info{"Something"} the block will not
+be evaluated if the log level is not enabled.
+
+  $log.warn{"Log"} 
+  $log.debug("abcd") if $log.debug?
+  # same as
+  $log.debug{"abcd"}
+
+Default Logging is only to stdout.
+
+=== Additional Loggers
+
+Normal logger with levels from INFO to FATAL.
+  new_logger("archivlog", "/var/log/archive", :level => Logger::INFO)
+
+Logger that only logs Level SKIPPED.
+  new_logger("only_debug", "/var/log/debugonly", :only => Logger::SKIPPED)
+
+Logger that only logs Level DEBUG with another pattern
+  new_logger("other_format", "/var/temp/debugging", :only => Logger::DEBUG, :pattern => "%d: %m")
+
+For more information on pattern see:
+  /usr/share/doc/liblog4r-ruby1.8/html/rdoc/files/log4r/formatter/patternformatter_rb.html
+
+== More Loglevels
+
+Log with other level, add option :log_levels to initialization.
+  init_libisi(:log_levels => [:CONFIG, :DEBUG, :INFO, :NEW_LEVEL, :WARN, :ERROR, :FATAL])
+
+=== Display Progressbars (console)
+Command line options added by script:
+  "--progress"
+
+If progress is enabled (--progress given on commandline):
+  $ui.progress_bar_enabled?
+
+Or you can enable/disable progress_bar with
+ $ui.enable_progress_bar
+respectively
+ $u.enable_progress_bar(false)
+
+=== Display Progressbar
+Only if --progress is given on commandline.
+
+  progress_bar("Myprogress", amount_of_objects) {
+    ...
+    # increment the progressbar by 1
+    pinc
+    ...
+  }
+
+=== Display Status Information
+You also can display status information
+on the bottom of the progressbar by using
+
+  pinc("Processing")
+  # or
+  pinc("Processing", object.name)
+
+or simply set the message without increment
+the progress with:
+  pmsg("Processing", object.name)
+
+
+= Appendix
+
+SVN:
+* URL: svn+ssh://fpellanda@rubyforge.org/var/svn/libisi/trunk
+* Repository Root: svn+ssh://fpellanda@rubyforge.org/var/svn/libisi
+
+Links:
+* Rubygems: https://rubygems.org/gems/libisi
+* Rubyforge: http://rubyforge.org/projects/libisi/
+
+Release:
+* gem install echoe rubyforge
+* rake manifest
+* rake release
+* rake publish_docs

data/Rakefile

@@ -22,7 +22,7 @@ require 'echoe'
 # Echoe
 # See http://blog.evanweaver.com/files/doc/fauna/echoe/files/README.html
 
-Echoe.new('libisi', '0.3.0') do |p|
+Echoe.new('libisi', '0.3.1') do |p|
   p.description    = "Library for easy and fast shell script developing"
   p.url            = "http://rubyforge.org/projects/libisi/"
   p.author         = "Pellanda Flavio, Copyright Logintas AG"

data/libisi.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{libisi}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Pellanda Flavio, Copyright Logintas AG"]
   s.date = %q{2010-10-27}
   s.description = %q{Library for easy and fast shell script developing}
   s.email = %q{flavio.pellanda@logintas.ch}
-  s.extra_rdoc_files = ["LICENSE", "lib/inifile.rb", "lib/libisi.rb", "lib/libisi/attribute.rb", "lib/libisi/attribute/activerecord.rb", "lib/libisi/attribute/base.rb", "lib/libisi/base.rb", "lib/libisi/bridge.rb", "lib/libisi/bridge/base.rb", "lib/libisi/bridge/java.rb", "lib/libisi/bridge/python.rb", "lib/libisi/cache.rb", "lib/libisi/cache/base.rb", "lib/libisi/cache/file_cache.rb", "lib/libisi/chart.rb", "lib/libisi/chart/base.rb", "lib/libisi/chart/jfreechart.rb", "lib/libisi/chart/jfreechart_generator.rb", "lib/libisi/color.rb", "lib/libisi/color/base.rb", "lib/libisi/color/colortools.rb", "lib/libisi/color/java.rb", "lib/libisi/concept.rb", "lib/libisi/concept/activerecord.rb", "lib/libisi/concept/base.rb", "lib/libisi/doc.rb", "lib/libisi/doc/base.rb", "lib/libisi/doc/html.rb", "lib/libisi/doc/text.rb", "lib/libisi/doc/wiki.rb", "lib/libisi/environment.rb", "lib/libisi/environment/base.rb", "lib/libisi/environment/http.rb", "lib/libisi/environment/rails.rb", "lib/libisi/environment/root.rb", "lib/libisi/fake_logger/logger.rb", "lib/libisi/function/base.rb", "lib/libisi/hal.rb", "lib/libisi/instance.rb", "lib/libisi/instance/activerecord.rb", "lib/libisi/instance/base.rb", "lib/libisi/log.rb", "lib/libisi/mail/base.rb", "lib/libisi/mail/tmail.rb", "lib/libisi/parameter/base.rb", "lib/libisi/property.rb", "lib/libisi/property/base.rb", "lib/libisi/reciever/base.rb", "lib/libisi/reciever/socket.rb", "lib/libisi/relation.rb", "lib/libisi/request.rb", "lib/libisi/request/base.rb", "lib/libisi/request/http.rb", "lib/libisi/response/base.rb", "lib/libisi/task/base.rb", "lib/libisi/task/http.rb", "lib/libisi/tee.rb", "lib/libisi/ui/base.rb", "lib/libisi/ui/console.rb", "lib/libisi/ui/kde.rb", "lib/libisi/ui/nobody.rb", "lib/libisi/ui/rails.rb", "lib/libisi/ui/x11.rb", "lib/libisi/uri.rb", "lib/libisi/uri/activerecord.rb", "lib/libisi/uri/base.rb", "lib/libisi/uri/file.rb", "lib/libisi/uri/ldap.rb", "lib/libisi/uri/mysql.rb", "lib/libisi/value.rb", "lib/libisi/value/attribute_value.rb", "lib/libisi/value/base.rb", "lib/libisi/value/property_value.rb", "lib/libisi/value/relation_value.rb", "lib/ordered_hash.rb", "libisi.gemspec"]
-  s.files = ["LICENSE", "Rakefile", "lib/inifile.rb", "lib/libisi.rb", "lib/libisi/attribute.rb", "lib/libisi/attribute/activerecord.rb", "lib/libisi/attribute/base.rb", "lib/libisi/base.rb", "lib/libisi/bridge.rb", "lib/libisi/bridge/base.rb", "lib/libisi/bridge/java.rb", "lib/libisi/bridge/python.rb", "lib/libisi/cache.rb", "lib/libisi/cache/base.rb", "lib/libisi/cache/file_cache.rb", "lib/libisi/chart.rb", "lib/libisi/chart/base.rb", "lib/libisi/chart/jfreechart.rb", "lib/libisi/chart/jfreechart_generator.rb", "lib/libisi/color.rb", "lib/libisi/color/base.rb", "lib/libisi/color/colortools.rb", "lib/libisi/color/java.rb", "lib/libisi/concept.rb", "lib/libisi/concept/activerecord.rb", "lib/libisi/concept/base.rb", "lib/libisi/doc.rb", "lib/libisi/doc/base.rb", "lib/libisi/doc/html.rb", "lib/libisi/doc/text.rb", "lib/libisi/doc/wiki.rb", "lib/libisi/environment.rb", "lib/libisi/environment/base.rb", "lib/libisi/environment/http.rb", "lib/libisi/environment/rails.rb", "lib/libisi/environment/root.rb", "lib/libisi/fake_logger/logger.rb", "lib/libisi/function/base.rb", "lib/libisi/hal.rb", "lib/libisi/instance.rb", "lib/libisi/instance/activerecord.rb", "lib/libisi/instance/base.rb", "lib/libisi/log.rb", "lib/libisi/mail/base.rb", "lib/libisi/mail/tmail.rb", "lib/libisi/parameter/base.rb", "lib/libisi/property.rb", "lib/libisi/property/base.rb", "lib/libisi/reciever/base.rb", "lib/libisi/reciever/socket.rb", "lib/libisi/relation.rb", "lib/libisi/request.rb", "lib/libisi/request/base.rb", "lib/libisi/request/http.rb", "lib/libisi/response/base.rb", "lib/libisi/task/base.rb", "lib/libisi/task/http.rb", "lib/libisi/tee.rb", "lib/libisi/ui/base.rb", "lib/libisi/ui/console.rb", "lib/libisi/ui/kde.rb", "lib/libisi/ui/nobody.rb", "lib/libisi/ui/rails.rb", "lib/libisi/ui/x11.rb", "lib/libisi/uri.rb", "lib/libisi/uri/activerecord.rb", "lib/libisi/uri/base.rb", "lib/libisi/uri/file.rb", "lib/libisi/uri/ldap.rb", "lib/libisi/uri/mysql.rb", "lib/libisi/value.rb", "lib/libisi/value/attribute_value.rb", "lib/libisi/value/base.rb", "lib/libisi/value/property_value.rb", "lib/libisi/value/relation_value.rb", "lib/ordered_hash.rb", "test/bridge_test.rb", "test/cache_test.rb", "test/chart_test.rb", "test/color_test.rb", "test/concept_test.rb", "test/doc_test.rb", "test/fixtures/test.db", "test/ordered_hash_test.rb", "test/profile_test.rb", "test/request_test.rb", "test/test", "test/ui_test.rb", "Manifest", "libisi.gemspec"]
+  s.extra_rdoc_files = ["LICENSE", "README", "lib/inifile.rb", "lib/libisi.rb", "lib/libisi/attribute.rb", "lib/libisi/attribute/activerecord.rb", "lib/libisi/attribute/base.rb", "lib/libisi/base.rb", "lib/libisi/bridge.rb", "lib/libisi/bridge/base.rb", "lib/libisi/bridge/java.rb", "lib/libisi/bridge/python.rb", "lib/libisi/cache.rb", "lib/libisi/cache/base.rb", "lib/libisi/cache/file_cache.rb", "lib/libisi/chart.rb", "lib/libisi/chart/base.rb", "lib/libisi/chart/jfreechart.rb", "lib/libisi/chart/jfreechart_generator.rb", "lib/libisi/color.rb", "lib/libisi/color/base.rb", "lib/libisi/color/colortools.rb", "lib/libisi/color/java.rb", "lib/libisi/concept.rb", "lib/libisi/concept/activerecord.rb", "lib/libisi/concept/base.rb", "lib/libisi/doc.rb", "lib/libisi/doc/base.rb", "lib/libisi/doc/html.rb", "lib/libisi/doc/text.rb", "lib/libisi/doc/wiki.rb", "lib/libisi/environment.rb", "lib/libisi/environment/base.rb", "lib/libisi/environment/http.rb", "lib/libisi/environment/rails.rb", "lib/libisi/environment/root.rb", "lib/libisi/fake_logger/logger.rb", "lib/libisi/function/base.rb", "lib/libisi/hal.rb", "lib/libisi/instance.rb", "lib/libisi/instance/activerecord.rb", "lib/libisi/instance/base.rb", "lib/libisi/log.rb", "lib/libisi/mail/base.rb", "lib/libisi/mail/tmail.rb", "lib/libisi/parameter/base.rb", "lib/libisi/property.rb", "lib/libisi/property/base.rb", "lib/libisi/reciever/base.rb", "lib/libisi/reciever/socket.rb", "lib/libisi/relation.rb", "lib/libisi/request.rb", "lib/libisi/request/base.rb", "lib/libisi/request/http.rb", "lib/libisi/response/base.rb", "lib/libisi/task/base.rb", "lib/libisi/task/http.rb", "lib/libisi/tee.rb", "lib/libisi/ui/base.rb", "lib/libisi/ui/console.rb", "lib/libisi/ui/kde.rb", "lib/libisi/ui/nobody.rb", "lib/libisi/ui/rails.rb", "lib/libisi/ui/x11.rb", "lib/libisi/uri.rb", "lib/libisi/uri/activerecord.rb", "lib/libisi/uri/base.rb", "lib/libisi/uri/file.rb", "lib/libisi/uri/ldap.rb", "lib/libisi/uri/mysql.rb", "lib/libisi/value.rb", "lib/libisi/value/attribute_value.rb", "lib/libisi/value/base.rb", "lib/libisi/value/property_value.rb", "lib/libisi/value/relation_value.rb", "lib/ordered_hash.rb", "libisi.gemspec"]
+  s.files = ["LICENSE", "Manifest", "README", "Rakefile", "lib/inifile.rb", "lib/libisi.rb", "lib/libisi/attribute.rb", "lib/libisi/attribute/activerecord.rb", "lib/libisi/attribute/base.rb", "lib/libisi/base.rb", "lib/libisi/bridge.rb", "lib/libisi/bridge/base.rb", "lib/libisi/bridge/java.rb", "lib/libisi/bridge/python.rb", "lib/libisi/cache.rb", "lib/libisi/cache/base.rb", "lib/libisi/cache/file_cache.rb", "lib/libisi/chart.rb", "lib/libisi/chart/base.rb", "lib/libisi/chart/jfreechart.rb", "lib/libisi/chart/jfreechart_generator.rb", "lib/libisi/color.rb", "lib/libisi/color/base.rb", "lib/libisi/color/colortools.rb", "lib/libisi/color/java.rb", "lib/libisi/concept.rb", "lib/libisi/concept/activerecord.rb", "lib/libisi/concept/base.rb", "lib/libisi/doc.rb", "lib/libisi/doc/base.rb", "lib/libisi/doc/html.rb", "lib/libisi/doc/text.rb", "lib/libisi/doc/wiki.rb", "lib/libisi/environment.rb", "lib/libisi/environment/base.rb", "lib/libisi/environment/http.rb", "lib/libisi/environment/rails.rb", "lib/libisi/environment/root.rb", "lib/libisi/fake_logger/logger.rb", "lib/libisi/function/base.rb", "lib/libisi/hal.rb", "lib/libisi/instance.rb", "lib/libisi/instance/activerecord.rb", "lib/libisi/instance/base.rb", "lib/libisi/log.rb", "lib/libisi/mail/base.rb", "lib/libisi/mail/tmail.rb", "lib/libisi/parameter/base.rb", "lib/libisi/property.rb", "lib/libisi/property/base.rb", "lib/libisi/reciever/base.rb", "lib/libisi/reciever/socket.rb", "lib/libisi/relation.rb", "lib/libisi/request.rb", "lib/libisi/request/base.rb", "lib/libisi/request/http.rb", "lib/libisi/response/base.rb", "lib/libisi/task/base.rb", "lib/libisi/task/http.rb", "lib/libisi/tee.rb", "lib/libisi/ui/base.rb", "lib/libisi/ui/console.rb", "lib/libisi/ui/kde.rb", "lib/libisi/ui/nobody.rb", "lib/libisi/ui/rails.rb", "lib/libisi/ui/x11.rb", "lib/libisi/uri.rb", "lib/libisi/uri/activerecord.rb", "lib/libisi/uri/base.rb", "lib/libisi/uri/file.rb", "lib/libisi/uri/ldap.rb", "lib/libisi/uri/mysql.rb", "lib/libisi/value.rb", "lib/libisi/value/attribute_value.rb", "lib/libisi/value/base.rb", "lib/libisi/value/property_value.rb", "lib/libisi/value/relation_value.rb", "lib/ordered_hash.rb", "libisi.gemspec", "test/bridge_test.rb", "test/cache_test.rb", "test/chart_test.rb", "test/color_test.rb", "test/concept_test.rb", "test/doc_test.rb", "test/fixtures/test.db", "test/ordered_hash_test.rb", "test/profile_test.rb", "test/request_test.rb", "test/test", "test/ui_test.rb"]
   s.homepage = %q{http://rubyforge.org/projects/libisi/}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Libisi"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Libisi", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{libisi}
   s.rubygems_version = %q{1.3.7}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: libisi
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Pellanda Flavio, Copyright Logintas AG
@@ -27,6 +27,7 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
+- README
 - lib/inifile.rb
 - lib/libisi.rb
 - lib/libisi/attribute.rb
@@ -104,6 +105,8 @@ extra_rdoc_files:
 - libisi.gemspec
 files: 
 - LICENSE
+- Manifest
+- README
 - Rakefile
 - lib/inifile.rb
 - lib/libisi.rb
@@ -179,6 +182,7 @@ files:
 - lib/libisi/value/property_value.rb
 - lib/libisi/value/relation_value.rb
 - lib/ordered_hash.rb
+- libisi.gemspec
 - test/bridge_test.rb
 - test/cache_test.rb
 - test/chart_test.rb
@@ -191,8 +195,6 @@ files:
 - test/request_test.rb
 - test/test
 - test/ui_test.rb
-- Manifest
-- libisi.gemspec
 has_rdoc: true
 homepage: http://rubyforge.org/projects/libisi/
 licenses: []
@@ -203,6 +205,8 @@ rdoc_options:
 - --inline-source
 - --title
 - Libisi
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement