bigtinker 0.97 → 0.98

data/lib/zip/zipfilesystem.rb

@@ -1,9 +1,42 @@
-require 'zip/zip'
+require 'lib/zip/zip'
 
 module Zip
+
+  # The ZipFileSystem API provides an API for accessing entries in 
+  # a zip archive that is similar to ruby's builtin File and Dir 
+  # classes.
+  #
+  # Requiring 'zip/zipfilesystem' includes this module in ZipFile
+  # making the methods in this module available on ZipFile objects.
+  #
+  # Using this API the following example creates a new zip file 
+  # <code>my.zip</code> containing a normal entry with the name
+  # <code>first.txt</code>, a directory entry named <code>mydir</code>
+  # and finally another normal entry named <code>second.txt</code>
+  #
+  #   require 'zip/zipfilesystem'
+  #   
+  #   Zip::ZipFile.open("my.zip", Zip::ZipFile::CREATE) {
+  #     |zipfile|
+  #     zipfile.file.open("first.txt", "w") { |f| f.puts "Hello world" }
+  #     zipfile.dir.mkdir("mydir")
+  #     zipfile.file.open("mydir/second.txt", "w") { |f| f.puts "Hello again" }
+  #   }
+  #
+  # Reading is as easy as writing, as the following example shows. The 
+  # example writes the contents of <code>first.txt</code> from zip archive
+  # <code>my.zip</code> to standard out.
+  #
+  #   require 'zip/zipfilesystem'
+  #   
+  #   Zip::ZipFile.open("my.zip") {
+  #     |zipfile|
+  #     puts zipfile.file.read("first.txt")
+  #   }
+
   module ZipFileSystem
 
-    def initialize
+    def initialize # :nodoc:
       mappedZip = ZipFileNameMapper.new(self)
       @zipFsDir  = ZipFsDir.new(mappedZip)
       @zipFsFile = ZipFsFile.new(mappedZip)
@@ -11,14 +44,26 @@ module Zip
       @zipFsFile.dir = @zipFsDir
     end
 
+    # Returns a ZipFsDir which is much like ruby's builtin Dir (class)
+    # object, except it works on the ZipFile on which this method is
+    # invoked
     def dir
       @zipFsDir
     end
     
+    # Returns a ZipFsFile which is much like ruby's builtin File (class)
+    # object, except it works on the ZipFile on which this method is
+    # invoked
     def file
       @zipFsFile
     end
-    
+
+    # Instances of this class are normally accessed via the accessor
+    # ZipFile::file. An instance of ZipFsFile behaves like ruby's
+    # builtin File (class) object, except it works on ZipFile entries.
+    #
+    # The individual methods are not documented due to their
+    # similarity with the methods in File
     class ZipFsFile
 
       attr_writer :dir
@@ -198,7 +243,7 @@ module Zip
 	@mappedZip.get_entry(fileName).size
       end
       
-      # nil for not found and nil for directories
+      # Returns nil for not found and nil for directories
       def size?(fileName)
 	entry = @mappedZip.find_entry(fileName)
 	return (entry == nil || entry.directory?) ? nil : entry.size
@@ -367,6 +412,12 @@ module Zip
       end
     end
 
+    # Instances of this class are normally accessed via the accessor
+    # ZipFile::dir. An instance of ZipFsDir behaves like ruby's
+    # builtin Dir (class) object, except it works on ZipFile entries.
+    #
+    # The individual methods are not documented due to their
+    # similarity with the methods in Dir
     class ZipFsDir
       
       def initialize(mappedZip)
@@ -431,7 +482,7 @@ module Zip
       alias rmdir  delete
       alias unlink delete
       
-      def mkdir(entryName, permissionInt = 0)
+      def mkdir(entryName, permissionInt = 0755)
         @mappedZip.mkdir(entryName, permissionInt)
       end
       
@@ -441,7 +492,7 @@ module Zip
 
     end
 
-    class ZipFsDirIterator
+    class ZipFsDirIterator # :nodoc:all
       include Enumerable
 
       def initialize(arrayOfFileNames)
@@ -481,7 +532,7 @@ module Zip
 
     # All access to ZipFile from ZipFsFile and ZipFsDir goes through a
     # ZipFileNameMapper, which has one responsibility: ensure
-    class ZipFileNameMapper
+    class ZipFileNameMapper # :nodoc:all
       include Enumerable
 
       def initialize(zipFile)
@@ -520,7 +571,7 @@ module Zip
                         &continueOnExistsProc)
       end
 
-      def mkdir(fileName, permissionInt = 0)
+      def mkdir(fileName, permissionInt = 0755)
         @zipFile.mkdir(expand_to_entry(fileName), permissionInt)
       end
 

data/lib/zip/ziprequire.rb

@@ -1,6 +1,35 @@
-require 'zip/zip'
+# With ziprequire you can load ruby modules from a zip file. This means
+# ruby's module include path can include zip-files.
+#
+# The following example creates a zip file with a single entry 
+# <code>log/simplelog.rb</code> that contains a single function 
+# <code>simpleLog</code>: 
+#
+#   require 'zip/zipfilesystem'
+#   
+#   Zip::ZipFile.open("my.zip", true) {
+#     |zf| 
+#     zf.file.open("log/simplelog.rb", "w") { 
+#       |f|
+#       f.puts "def simpleLog(v)"
+#       f.puts '  Kernel.puts "INFO: #{v}"'
+#       f.puts "end"
+#     }
+#   }
+#
+# To use the ruby module stored in the zip archive simply require
+# <code>zip/ziprequire</code> and include the <code>my.zip</code> zip 
+# file in the module search path. The following command shows one 
+# way to do this:
+#
+#   ruby -rzip/ziprequire -Imy.zip  -e " require 'log/simplelog'; simpleLog 'Hello world' "
 
-class ZipList
+#$: << 'data/rubycode.zip' << 'data/rubycode2.zip'
+
+
+require 'lib/zip/zip'
+
+class ZipList #:nodoc:all
   def initialize(zipFileList)
       @zipFileList = zipFileList
   end
@@ -23,7 +52,7 @@ class ZipList
 end
 
 
-module Kernel
+module Kernel #:nodoc:all
   alias :oldRequire :require
 
   def require(moduleName)

data/rwd_files/HowTo_BigTinker.txt

@@ -10,8 +10,7 @@ BigTinker is loaded with tinker applets  RubyWebDialogs and the rwdtinker framew
 6. show a calendar
 7. address book
 8. lookup word definitions
-9. run Unix fortune program
-10. Read Gutenberg books
+
 
 Includes a hello world application to help building your own.
 
@@ -106,8 +105,21 @@ http://www.erikveen.dds.nl/rubywebdialogs/index.html
 Thanks, Steven Gibson
 
 == Changelog
+version 0.98
+  updated for rwdtinker 1.85
+  added rwdschedule back in
+
 version 0.97
- updated for rwdtinker 1.82
+   updated for rwdtinker 1.82
+   switch to po files for translation files
+   add beginning of Hindi po file
+   added more Japanese strings
+   changed handling of lang change = in the tinkerwin2variables.cnf file the [0] setting of $langarray will be the language choosen.
+   refactored init.rb to move routines into lib/rwdtinker modules
+   condensed config files from 5 -> 3
+   fixed document launch bug 
+   add $KCODE = 'u'
+   move help files to rwd_files directory
  
 version 0.96
  update for rwdtinker 1.80

data/rwd_files/HowTo_Schedule.txt

@@ -0,0 +1,265 @@
+= rwdschedule - for rwdtinker and RubyWebDialogs
+
+rwdschedule is a simple little database  
+
+The GUI interface used is RubyWebDialogs 
+
+RubyWebDialogs is a platform independent graphical user interface for Ruby applications. It generates HTML and serves it with an internal HTTP server, so you can use your favorite web browser as the front end for your Ruby application. All this means, that it can be used on almost every platform, like Ruby itself. http://www.erikveen.dds.nl/rubywebdialogs/
+
+== Quick Start
+ Start the program by typing 
+ ruby init.rb
+
+ Then point your web browser to:
+ http://localhost:7705/
+
+Then enter the event date you want to search for in the browser form and press Search.
+  200412december1a
+browser should fill with the event information.
+To exit, press the x inside the browser window.
+
+
+== How to Use the Schedule Book (rwdschedule)
+
+There are two ways to add records to schedule book.
+
+== Adding Records
+
+1. Use the "Edit Event" tab
+      The first field is the most important. It is the filename that
+      will be created. I use the event date starting with yearmonthday
+      2005january11
+
+      The following lines for entry are for you to fill in as you want.
+      When you are finished press the Save Changes button 
+      
+      You use this same screen for editing an already saved event
+
+2. Manually add an entry for a event record
+      You can use a text editor to create a record
+      put information on separate lines. You can have as many lines as you want
+      name the file with starting with date and end with .nam
+      2005january11 6 pm dinner party.nam
+
+      Save your file to the schedules/ subdirectory
+      
+
+== Viewing an schedule book entry:
+
+
+Go to "View event" tab
+
+       Click on the list events button.
+      
+       Click on the date you want
+       
+       Then click the "Open" button
+       
+       If it finds the record it will open it. It displays the record 
+       as text  under the "Open" button.
+
+
+== Event Utilities
+
+Click on "Event Utilites" tab
+
+  You can rename event filenames
+  You can delete events
+  
+== Sync for multiple computers
+
+ If you are like me, you have more than one system
+ I use rwdTinker at home on my Linux laptop
+ at work I use it on XP
+ on the go I use rwdtinker on my Zaurus PDA
+ So I am adding schedule events on different machines.
+ There is  a function to help sync the separate systems
+  
+ in "Selection Panel" click on "Open Schedule Sync Window"
+ 
+ First you need your ftp details set in the
+ configuration/rwdschedule.cnf file
+ 
+ you can upload your events from your local schedules directory to the ftp site
+ you can download events from the ftp site to your local updates directory
+ you can perform a sync which finds remote events and adds them to your local
+ schedules directory
+ 
+ There is a button to delete the update directory when finished
+
+== Show Month
+
+  Click on "Show Month" tab
+   enter 
+    Year: 2005
+    Month: 1
+    Click on show month
+    
+    It will display one month
+  
+== ics files
+
+      You can create an ics file
+      you can view a raw ics file 
+      Rename ics File
+      Delete ics File
+      
+== Using over a Network
+  
+To serve the application over your local LAN,change the last line in the
+init.rb file to something like:
+RwdTinker.file(RWDFile).serve(8080, "-r" ? ".rwduids" : nil)
+Then you should be able to login at: http://yourhostname:8080
+
+You have to authorize yourself. The .rwuids example is a string with
+the name of the authorization file, relative to the home directory
+of the user that started the service. This file has to be in the form of:
+
+user1 = password
+user2 = pass phrase
+
+Thus the file .rwduids might contain:
+
+erik = secret
+
+== Requirements:
+RubyWebDialogs - I am using 0.0.11 2004-3-9
+
+Ruby I am using version 1.8.2
+
+
+I have tested this under Linux-Debian kernel 2.6.9
+
+== PROBLEMS:
+It is easy to type a date with a space after it. That will have a somewhat invisible space 
+in it.
+
+don't type in the extension .sch
+
+Closing the browser doesn't terminate the application. You have to use the application's close-button  And terminating the application doesn't terminate the application when running in network mode. You just log out.
+
+Don't use the back-button of the browser! Strange and unpredictable things may and will happen!
+
+
+== contacts
+  For more information see:
+ http://rwdapplications.rubyforge.org/wiki/wiki.pl
+
+
+ For more information about RubyWebDialogs see:
+ http://www.erikveen.dds.nl/rubywebdialogs/index.html
+
+
+Steven Gibson
+steven@superant.com
+
+== Changelog
+version 1.06
+ update for rwdtinker 1.84
+ moved schedule directory to under rwd_files
+ moved lib files to lib directory
+ updated locale files to po files
+
+version 1.05
+ update for rwdtinker 1.80
+ 
+Version 1.04
+ updated for rwdtinker 1.75
+ 
+Version 1.03
+ updated for rwdtinker 1.69
+ minor change to config file setup
+ 
+Version 1.02
+ correct config file handling
+ add menu to main window of appletange
+ changed menu names to be more consistent
+ corrected download routine
+ 
+ 
+Version 1.01
+ changed schedule configuration screen
+ updated for rwdtinker 1.66
+ new helpabout
+ new documents list
+ 
+Version 1.00
+ fixed sync download 
+ added more unit tests
+ 
+Version 0.99
+  updated for rwdtinker version 1.64
+  changed handling of application name returned
+  added jump seletion options
+  added some unit tests
+
+version 0.98
+ updated for rwdtinker version 1.61 
+ add in test harness
+
+
+version 0.97
+ added rconftool use to update configuration files
+ changed applet removal to not use external rm
+ removed version number from directory name
+
+version 0.96
+ added export ics record
+ added end time for ics create record 
+
+version 0.95
+ added ics file view tab
+ added ics file creation tab
+ ics file rename and deletion tab
+ reorganized schedule edit screen for future isc output
+ corrected typo on menu tab
+
+version 0.94
+ added RwdSchedule Menu tab for easier navigation
+ wider text boxes for contact information
+ Improvement to context sensitive help
+ updated for rwdtinker 1.51 - finds available port and remote control
+
+version 0.93
+ added some context sensitive help
+ added edit config file and reload config variables
+ change to tinker context help script
+ updated for rwdtinker 1.47
+ factored month calendar display - should be more readable
+ fixed l10n calls for calendar for Dutch
+ added archive function for old events
+ 
+version 0.92
+ Added delete update files function in sync tab
+
+version 0.91
+ updated for rwdtinker 1.44 - refactored gui files
+ Changed gui directory names - more like  Java package titles
+
+version 0.9
+ added back window for sync tasks
+ added configuration viewing
+ added ftp file download for sync
+ added ftp file upload for sync
+ add update files and schedule sync compares
+ 
+version 0.8
+ updated for rwdtinker 1.42 - semi-live updates
+  
+version 0.7
+ updated for rwdtinker 1.4
+ addition to documentation
+
+version 0.6
+ updated for rwdtinker 1.3
+ 
+version 0.5
+ added edit commands to change event record
+ Rename event
+ Delete event
+ changed order of event list - descending = oldest at top
+ 
+version 0.4
+added configuration file with location of schedules directory
+add date selection to view event tab
+updated to version 1.0 of rwdtinker