jota 0.8.1 → 0.9.0dev2

data/INSTALL

@@ -1,5 +1,5 @@
 
-$Id: INSTALL 39 2009-02-17 10:19:31Z dz $
+$Id: INSTALL 248 2010-04-11 10:07:21Z dz $
 
 Jota is a written in the Ruby programming language and uses GTK+ Widgets.
 
@@ -13,9 +13,6 @@ following packages:
 - Ruby bindings for GTK+ and libglade
 - Ruby Gems			the Ruby packet manager
 
-If you want to use the command line version of Jota, you will need the
-'Cmd' gem: gem install cmd
-
 
 PREREQUISITES
 -------------
@@ -82,9 +79,11 @@ For the common operating systems you can use the following command:
   Go to http://ruby-gnome2.sourceforge.jp/hiki.cgi?Install+Guide+for+Windows
   and follow the three steps. In short:
 
-  1. install http://rubyforge.org/frs/download.php/17357/ruby185-22.exe
-     (enable RubyGems). Install into default installation diectory.
-  2. install http://prdownloads.sourceforge.net/ruby-gnome2/ruby-gnome2-0.16.0-1-i386-mswin32.exe?download
+  1. Install Ruby from
+     http://rubyforge.org/frs/download.php/47082/ruby186-27_rc2.exe
+     (enable RubyGems). Install into default installation directory.
+  2. Install GTK+ Bindingf for Ruby from
+     http://prdownloads.sourceforge.net/ruby-gnome2/ruby-gnome2-0.16.0-1-i386-mswin32.exe?download
 
 
 INSTALLING
@@ -102,20 +101,6 @@ On Windows Vista you must execute gem as administrator. To do so enter
 "gem install jota" in the run box (Start menu, at the bottom) and hit
 Ctrl-Shift-Enter. Then accept the UAC dialog with "Continue".
 
-If you get the error "ERROR:  While executing gem ... (RuntimeError)" and 
-"jota requires cmd >= 0.7.2", you have an older version of gems that does not
-resolve dependencies on its own.
-
-So you have to
-
-	gem install cmd
-
-before
-
-	gem install jota
-
-(Only if you want to use joacli)
-
 
 
 RUNNING
@@ -147,3 +132,15 @@ gem uninstall jota
 gem install jota
 gem cleanup jota
 
+
+DEVELOPMENT TOOLS
+-----------------
+
+If you want to contribute to the development of Jota you need the following
+tools:
+
+- rake		"make" supplement with ruby syntax
+- rdoc		inline documentation generator
+- rtags		"tags" for ruby code
+
+

data/LICENSE

@@ -0,0 +1,26 @@
+
+  Copyright (c) 2008-2010 Derik van Zuetphen <dz@426.ch>
+  All rights reserved.
+
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions
+  are met:
+
+  1. Redistributions of source code must retain the above copyright
+     notice, this list of conditions and the following disclaimer.
+  2. Redistributions in binary form must reproduce the above copyright
+     notice, this list of conditions and the following disclaimer in the
+     documentation and/or other materials provided with the distribution.
+  3. The name of the author may not be used to endorse or promote products
+     derived from this software without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
+  THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/bin/jota

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
-# $Id: jota 45 2009-05-08 09:27:26Z dz $
-
+# $Id: jota 68 2010-01-04 14:23:45Z dz $
 begin
   require 'jota'
 rescue LoadError

data/bin/jota.bat

@@ -0,0 +1,7 @@
+@echo off
+
+rem $Id$
+
+if "%1" == "-v" set ruby="ruby" else set ruby="rubyw"
+%ruby% jota.rb %1 %2 %3 %4 %5 %6 %7 %8 %9
+exit

data/lib/app_error.rb

@@ -1,5 +1,5 @@
 
-# $Id: app_error.rb 28 2009-01-22 09:20:48Z dz $
+# $Id: app_error.rb 68 2010-01-04 14:23:45Z dz $
 
 class AppError < StandardError
 end

data/lib/clip.rb

@@ -1,7 +1,5 @@
 
-# $Id: clip.rb 46 2009-05-08 09:27:55Z dz $
-
-# if you use vim and don't like folds type zR
+# $Id: clip.rb 257 2010-05-02 19:47:26Z dz $
 
 require 'time'
 require 'version'
@@ -21,17 +19,15 @@ class Clip
 attr_accessor :wrap, :title, :created, :pos, :type, :data
 
 def initialize 
-#{{{1
 	@data = ""	# no lines at all, "\n" would be 1 empty line
 	@wrap = false
 	@type = :text
 	@title = ""
 	@created = Time.now
 	@pos = 0
-end #}}}1
+end 
 
 def Clip.from_mbox(str)
-#{{{1
 	# "From_" line already removed
 	cl = Clip.new
 	in_header = true
@@ -68,10 +64,9 @@ def Clip.from_mbox(str)
 		end
 	end
 	return cl
-end #}}}1
+end 
 
 def to_mbox
-#{{{1
 	str = ""
 	charset = "UTF-8"
 
@@ -97,10 +92,9 @@ def to_mbox
 	str << @data
 
 	return str
-end #}}}1
+end 
 
 def Clip.from_hash(hash)
-#{{{1
 	cl = Clip.new
 	case hash["type"]
 	when :text
@@ -110,10 +104,9 @@ def Clip.from_hash(hash)
 		cl.created = hash["created"]
 	end
 	return cl
-end #}}}1
+end 
 
 def to_hash
-#{{{1
 	hash = Hash.new
 	hash["type"] = @type
 	hash["wrap"] = @wrap
@@ -121,43 +114,29 @@ def to_hash
 	hash["title"] = @title
 	hash["created"] = @created
 	return hash
-end #}}}1
-
-def append_as_mbox(file_and_path)
-#{{{1
-	print_verbose "append to mbox '#{file_and_path}'"
-	File.open(file_and_path,"a") do | f |
-		f.print "From %s@localhost %s\n" % 
-			[Version::PROGRAM_NAME, Time.now.ctime]
-		f.print(to_mbox)
-	end
-end #}}}1
+end 
+
 
 def empty?
-#{{{1
 	# strip also removes LFs
 	return @data.strip == "" && @title.strip == ""
-end #}}}1
+end 
 
 def ==(clip)
-#{{{1
 	return self.to_hash == clip.to_hash
-end #}}}1
+end 
 
 # POSSIBLE CASES FOR TEXT <-> TITLE/DATA CONVERSION
-# # {{{1
-# #       text                                    title   data
-# # a)    ""                              1)      ""      ""
-# # b)    abc                             2)      abc     ""
-# # c)    abc\n                           2)      abc     ""
-# # d)    abc\n                           3)      abc     def\n
-# #       def
-# # e)    abc\n                           3)      abc     def\n
-# #       def\n
-# # }}}1
+#       text                                    title   data
+# a)    ""                              1)      ""      ""
+# b)    abc                             2)      abc     ""
+# c)    abc\n                           2)      abc     ""
+# d)    abc\n                           3)      abc     def\n
+#       def
+# e)    abc\n                           3)      abc     def\n
+#       def\n
 
 def text
-#{{{1
 	if @title == "" and @data == "" then
 		# map (1) to (a)
 		return ""
@@ -165,10 +144,9 @@ def text
 		# map (2) to (b) and (3) to (d)
 		return "%s\n%s" % [@title,@data]
 	end
-end #}}}1
+end 
 
 def text=(str)
-# {{{1
 	# map (a),(b) to (c) and (d) to (e)
 	str = str.chomp + "\n"
 	
@@ -177,9 +155,15 @@ def text=(str)
 					# the last elem is empty
 	@title = arr[0]			# first elem = first line
 	@data = arr[1..-1].join("\n")	# second to last elem
-end #}}}1
+end 
 
+# Return modified title for easier readabiliy
+def title!
+	if @title == "" then
+		return "..."
+	else
+		return @title
+	end
+end
 
 end #class
-
-# vim: set foldmethod=marker:

data/lib/clip_array.rb

@@ -1,7 +1,6 @@
 
-# $Id: clip_array.rb 53 2009-09-24 14:22:04Z dz $
+# $Id: clip_array.rb 271 2010-07-29 18:56:41Z dz $
 
-# if you use vim and don't like folds type zR
 
 
 require 'app_error'
@@ -19,7 +18,6 @@ class ClipArray < Array
 #	filename	String		ni	name of current file
 #	dirname		String		ni	directory of current file
 #	file		File		ni	current File object
-#	autosave_thread	Thread		nil	thread for autosaving
 
 
 attr_reader :current_index, :file, :filename, :dirname, :file_and_path
@@ -27,49 +25,43 @@ attr_accessor :pref
 
 # Clear array and reset index
 def clear
-#{{{1
 	super
 	@current_index = -1
-end #}}}1
+end
 
 # Clear array and create one empty clip
 def clear1
-#{{{1
 	clear
 	self << Clip.new
-end #}}}1
+end
 
 def initialize
-#{{{1
 	clear
 	@file = nil
 	@filename = nil
 	@pref = Preferences.defaults
-	@autosave_thread = nil
 	print_verbose "initializing clip array"
-end #}}}1
+end 
 
 def <<(clip)
-#{{{1
 	push(clip)
 	@current_index = length-1
 	return self
-end #}}}1
+end 
 
 def set_file(file,file_and_path)
-#{{{1
 	@file = file
 	@file_and_path = file_and_path
 	@filename = File.basename(file_and_path)
 	@dirname = File.dirname(file_and_path)
-end #}}}1
+end 
 
 #
 #	Export
 #
 
 #def save_as_mbox(filename)
-##{{{1
+#
 #	filename = get_filename(filename,:save)
 #
 #	puts "# saving clips to '#{filename}', format mbox" if $VERBOSE
@@ -78,15 +70,15 @@ end #}}}1
 #	write_mbox(f)
 #	self.each do | clip |
 #		f.print "From %s@localhost %s\n" % 
-#			[Version::PROGRAM_NAME, Time.now.ctime]
+#			[Version::PROGRAM_NAMELC, Time.now.ctime]
 #		f.print(escape_from(clip.to_mbox.chomp))
 #		f.print("\n")
 #	end
 #	f.close
-#end #}}}1
+#end 
 #
 #def save_as_yaml(filename)
-##{{{1
+#
 #	filename = get_filename(filename,:save)
 #
 #	arr = Array.new
@@ -99,34 +91,41 @@ end #}}}1
 #	File.open(filename,"w") do | file |
 #		YAML::dump(arr, file)
 #	end
-#end #}}}1
+#end 
 
 #def ClipArray.load(filename,format)
-##{{{1
+#
 #	case format
 #	when :mbox
 #		return ClipArray.load_from_mbox(filename)
 #	when :yaml
 #		return ClipArray.load_from_yaml(filename)
 #	end
-#end #}}}1
+#end 
 
 def goto_regexp(re)
-#{{{1
-	if re =~ /^\s*\d+\s*$/ then
-		self.current_index = re.to_i-1
+	return nil if re.nil?
+
+	md = re.match(/^\s*#(\d+)\s*$/)
+	if md then
+		index = md[1].to_i
+		if index < 1 or index > length then
+			return nil
+		end
+		@current_index = index-1
+		return @current_index
 	else
 		self.each_index do | i |
 			if self[i].title.match(re) then
 				@current_index = i
-				break
+				return @current_index
 			end
 		end
+		return nil
 	end
-end #}}}1
+end 
 
 def current_index=(num)
-#{{{1
 	if num < 0 then
 		@current_index = 0
 	elsif num >= length then
@@ -135,28 +134,25 @@ def current_index=(num)
 		@current_index = num
 	end
 	print_verbose "going to clip #{@current_index+1}"
-end #}}}1
+end 
 
 def next
-#{{{1
 	if @current_index < length-1 then
 		@current_index += 1
 		print_verbose "going to next clip #{@current_index+1}"
 	end
 	return self
-end #}}}1
+end 
 
 def prev
-#{{{1
 	if @current_index > 0 then
 		@current_index -= 1
 		print_verbose "going to previous clip #{@current_index+1}"
 	end
 	return self
-end #}}}1
+end 
 
 def delete
-#{{{1
 	if @current_index == length-1 then
 		new_current_index = @current_index - 1
 	else
@@ -172,23 +168,26 @@ def delete
 		@current_index = new_current_index
 	end
 	
-end #}}}1
+end 
 
 def new
-#{{{1
-	c = Clip.new
-	push(c)
-	@current_index = length-1
-	print_verbose "creating new clip #{@current_index+1}"
-end #}}}1
+	if length > 0 and self[length-1].empty? then
+		@current_index = length-1
+		print_verbose "last clip alread empty, going to last clip"
+	else
+		c = Clip.new
+		push(c)
+		@current_index = length-1
+		print_verbose "creating new clip #{@current_index+1}"
+	end
+end 
 
 def current
-#{{{1
 	return self[@current_index]
-end #}}}1
+end 
 
 #def ClipArray.load_from_yaml(filename)
-##{{{1
+#
 #	filename = get_filename(filename,:open)
 #	ca = self.new
 #
@@ -207,10 +206,10 @@ end #}}}1
 #
 #	ca.current_index = ca.length - 1
 #	return ca
-#end #}}}1
+#end 
 #
 #def ClipArray.load_from_mbox(filename)
-##{{{1
+#
 #	ca = self.new
 #	str = nil
 #
@@ -224,10 +223,40 @@ end #}}}1
 #	end
 #
 #	return ca
-#end #}}}1
+#end 
+
+#
+#	Locking
+#
+
+def ClipArray.obtain_shared_lock(file)
+	release_lock(file)	# necessary for win32
+
+	# a shared, non-blocking lock
+	print_debug "obtaining SHARED LOCK on '#{file.path}'"
+	if not file.flock(File::LOCK_SH|File::LOCK_NB) then
+		print_debug "  cannot lock"
+		#file.flock(File::LOCK_SH)		TODO
+	end
+end 
+
+def ClipArray.obtain_exclusive_lock(file)
+	release_lock(file)	# necessary for win32
+
+	# an exclusive, non-blocking lock
+	print_debug "obtaining EXCLUSIVE LOCK on '#{file.path}'"
+	if not file.flock(File::LOCK_EX|File::LOCK_NB) then
+		print_debug "  cannot lock"
+		#file.flock(File::LOCK_EX)		TODO
+	end
+end 
+
+def ClipArray.release_lock(file)
+	print_debug "releasing LOCK from '#{file.path}'"
+	file.flock(File::LOCK_UN)
+end 
 
 def ClipArray.create(file_and_path)
-#{{{1
 	print_verbose "creating file '#{file_and_path}'"
 
 	if File.exists?(file_and_path) then
@@ -240,19 +269,18 @@ def ClipArray.create(file_and_path)
 		ca.set_file(file,file_and_path)
 		
 		# test if writable
-		obtain_exclusive_lock(file)
+		ClipArray.obtain_exclusive_lock(file)
 
-		obtain_shared_lock(file)
+		ClipArray.obtain_shared_lock(file)
 	rescue Exception
 		file.close if file
 		raise
 	end
 
 	return ca
-end #}}}1
+end 
 
 def ClipArray.open(file_and_path)
-#{{{1
 	print_verbose "opening file '#{file_and_path}'"
 
 	begin
@@ -261,77 +289,58 @@ def ClipArray.open(file_and_path)
 		ca.set_file(file,file_and_path)
 
 		# test if writable
-		obtain_exclusive_lock(file)
+		ClipArray.obtain_exclusive_lock(file)
 
-		obtain_shared_lock(file)
+		ClipArray.obtain_shared_lock(file)
 	rescue Exception
 		file.close if file
 		raise
 	end
 
 	return ca
-end #}}}1
+end 
 
 def save
-#{{{1
 	if @file.nil? then
 		return
 	end
 
 	print_verbose "saving file '#{@filename}'"
 
-	obtain_exclusive_lock(@file)
+	ClipArray.obtain_exclusive_lock(@file)
 	@file.truncate(0)
 	@file.rewind
 	write_mbox(@file)
 	@file.flush
-	obtain_shared_lock(@file)
-end #}}}1
+	ClipArray.obtain_shared_lock(@file)
+end 
+
+def append(file)
+	print_verbose "append to mbox '#{file}'"
+	File.open(file,"a") do | f |
+		f.print "From %s@localhost %s\n" % 
+			[Version::PROGRAM_NAMELC, Time.now.ctime]
+		f.print(escape_from(self[@current_index].to_mbox.chomp))
+		f.print("\n")
+	end
+end 
 
 def close
-#{{{1
-	autosave(0)
 	save
 	print_verbose "closing file '#{@filename}'"
 	if @file then
-		release_lock(@file)
+		ClipArray.release_lock(@file)
 		@file.close
 	end
 	@file = nil
 	@filename = nil
 	clear
-end #}}}1
-
-def autosave(seconds)
-#{{{1
-	print_debug "autosave(#{seconds}) called"
-	if @autosave_thread then
-		print_debug " killing old thread"
-		@autosave_thread.kill
-		@autosave_thread = nil
-	end
-
-	if seconds == 0 then
-		print_debug " returning because seconds==0"
-		return
-	end
-
-	print_verbose "starting autosave thread"
-	@autosave_thread = Thread.new do
-		while true
-			print_verbose "autosaving at #{Time.now}"
-			save
-			sleep(seconds)
-		end
-	end
-end #}}}1
-
+end 
 
 private 
 
 
 def ClipArray.read_mbox(file)
-#{{{1
 	ca = self.new
 	first_line = true
 	str = ""
@@ -379,10 +388,9 @@ def ClipArray.read_mbox(file)
 
 	ca.current_index = ca.length - 1
 	return ca
-end #}}}1
+end 
 
 def write_mbox(file)
-#{{{1
 	print_debug "writing clips, mbox format"
 	i = 1
 
@@ -394,14 +402,12 @@ def write_mbox(file)
 
 	([pc]+self).each do | clip |
 		file.print "From %s@localhost %s\n" % 
-			[Version::PROGRAM_NAME, Time.now.ctime]
+			[Version::PROGRAM_NAMELC, Time.now.ctime]
 		file.print(escape_from(clip.to_mbox.chomp))
 		file.print("\n")
 		print_debug "  #{i}: '#{clip.title}'"
 		i += 1
 	end
-end #}}}1
+end 
 
 end # class
-
-# vim: set foldmethod=marker: