jota 0.8.0

data/INSTALL

@@ -0,0 +1,145 @@
+
+$Id: INSTALL 37 2009-02-09 10:06:02Z dz $
+
+Jota is a written in the Ruby programming language and uses GTK+ Widgets.
+
+To set up a working run time environment to have to install the
+following packages:
+
+- Ruby interpreter		often already installed
+- GTK+ libraries		comes with Gnome, you probably have it already
+- libglade			a library for loadable user interfaces
+				part of the GTK+ project
+- 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
+-------------
+
+For the common operating systems you can use the following command:
+
+* Ubuntu/Debian
+
+  % apt-get install libglade2-ruby1.8 rubygems
+
+
+* FreeBSD
+
+  % portinstall ruby18-libglade2 ruby18-gems
+
+	or
+
+  % cd /usr/ports/devel/ruby-libglade2
+  % make
+  % make install
+
+
+* Fedora (unfinished)
+
+  % yum install ... 
+
+
+* OpenSUSE
+
+  Does not work for 11.0, probably 10.0 and maybe 11.1. Sorry!
+
+  At first, install the packages ruby and rubygems from the standard SUSE
+  repositories. Because the other GTK+ related packages that you will 
+  need are not in these repositories, you have to fetch and install the 
+  RPMs manually. Read 
+    http://ruby-gnome2.sourceforge.jp/hiki.cgi?Install+Guide+for+SUSE
+  and fetch the tgz, e.g. 
+
+  % wget http://franz.hob-bruneck.info/downloads/suse100/ruby-gnome2/0.14.1/\
+    ruby-gnome2-0.14.1.suse100.tar.gz
+
+  Create a temporary directory somewhere
+  
+  % mkdir opensuse.tmp
+  % cd opensuse.tmp
+
+  Unpack and install the necessary RPMs
+
+  % tar xvfz ../ruby-gnome2*.tar.gz
+  % rpm -i ruby-glib2*
+  % rpm -i ruby-atk*
+  % rpm -i ruby-pango*
+  % rpm -i --nodeps ruby-gdkpixbuf2*
+  % rpm -i ruby-gtk2*
+  % rpm -i ruby-libglade2*
+
+
+
+* Windows
+
+  Windows of course has no sophisticated package management. You have to
+  download and install the following by hand.
+
+  Go to http://ruby-gnome2.sourceforge.jp/#Ruby-GNOME2+Win32+GUI+Installer
+  and follow the three steps. In short:
+
+  1. install http://rubyforge.org/frs/download.php/17357/ruby185-22.exe
+     (enable RubyGems)
+  2. install http://prdownloads.sourceforge.net/ruby-gnome2/ruby-gnome2-0.16.0-1-i386-mswin32.exe?download
+
+
+INSTALLING
+----------
+
+Now install Jota as a ruby gem:
+
+	gem install jota 
+
+alternatively, download jota-$VERSION.gem and install it with
+
+	gem install jota-$VERSION.gem
+
+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
+-------
+
+Unix:
+
+Normally, binaries installed through gems should be in the path, so you
+can simply invoke Jota with the command jota
+
+If the binary is not in the path, you have to find out the full pathname. 
+This is gems dependant. For Ubuntu Linux, the full name is 
+/var/lib/gems/1.8/bin/jota
+
+Windows:
+
+You can run Jota through: Start->Execute: "Jota" or create a shortcut and
+point it to C:\Ruby\bin\jota.cmd
+
+
+UPDATING
+--------
+
+gem update jota
+
+  or
+
+gem uninstall jota
+gem install jota
+gem cleanup jota
+

data/bin/jota

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# $Id: jota 28 2009-01-22 09:20:48Z dz $
+
+begin
+  require 'jota'
+rescue LoadError
+  require 'rubygems'
+  require 'jota'
+end
+
+Jota.new.run_gui

data/bin/jotacli

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+# $Id: jotacli 28 2009-01-22 09:20:48Z dz $
+
+begin
+  require 'jota'
+rescue LoadError
+  require 'rubygems'
+  require 'jota'
+end
+
+Jota.new.run_cli

data/lib/app_error.rb

@@ -0,0 +1,5 @@
+
+# $Id: app_error.rb 28 2009-01-22 09:20:48Z dz $
+
+class AppError < StandardError
+end

data/lib/cli.rb

@@ -0,0 +1,277 @@
+
+# $Id: cli.rb 37 2009-02-09 10:06:02Z dz $
+
+# if you use vim and don't like folds type zR
+
+require 'clip'
+require 'clip_array'
+require 'preferences'
+
+begin
+	require 'cmd'
+rescue LoadError
+	require 'rubygems'
+	require 'cmd'
+end
+
+class JotaCli < Cmd
+
+require 'tempfile'
+prompt_with :prompt_command
+
+doc :open,	"Open clip file"
+doc :close,	"Close clip file"
+doc :create,	"Create a new empty clip file"
+doc :list,	"List clips with type, index number and title"
+doc :edit,	"Edit clip with $EDITOR (or /usr/bin/vi if not set)"
+doc :show,	"Show contents of clip"
+doc :new,	"Create a new clip"
+doc :delete,	"Delete a clip"
+doc :default,	"Set default command"
+doc :page,	"Show content of clip through $PAGER"
+
+
+def do_open(args)
+#{{{1
+	filename = args.to_s
+	@data.close if @data
+	begin
+		@data = ClipArray.open(filename)
+	rescue SystemCallError, AppError => msg
+		puts msg
+		@data = nil
+	end
+end #}}}1
+
+def do_close
+#{{{1
+	return if @data.nil?
+
+	@data.close
+	@data = nil
+end #}}}1
+
+def do_create(args)
+#{{{1
+	filename = args.to_s
+	@data.close if @data
+	begin
+		@data = ClipArray.create(filename)
+	rescue AppError => msg
+		puts msg
+		@data = nil
+	end
+end #}}}1
+
+def do_list
+#{{{1
+	return if @data.nil?
+
+	@data.each_index do | i |
+		print "%2d %s %s\n" % [
+			i+1, 
+			type_to_char(@data[i].type),
+			@data[i].title]
+	end
+end #}}}1
+
+def do_edit(args)
+#{{{1
+	index = get_index(args)
+	return if index.nil?
+
+	file = Tempfile.new("jotacli")
+	filename = file.path
+	print_verbose "creating temporary file '#{filename}'"
+
+	file.puts @data[index].title
+	file.puts @data[index].data
+	file.close
+
+	if ENV["EDITOR"] then
+		cmdline = ENV["EDITOR"]
+	else
+		cmdline = "/usr/bin/vi"
+	end
+	cmdline = "%s %s" % [cmdline, filename]
+	print_verbose "executing '#{cmdline}'"
+
+	if system(cmdline) then
+		file = File.open(filename,"r")
+		lines = file.readlines
+		@data[index].title = lines[0].chomp
+		@data[index].data = lines[1..lines.length-1].join("")
+		file.close
+	else
+		puts "Error executing '#{cmdline}' with exit code #{$?}"
+	end
+
+	File.unlink(filename)
+
+	# because of this save we do not not need autosave for the cli version
+	@data.save
+end #}}}1
+
+def do_show(args)
+#{{{1
+	index = get_index(args)
+	return if index.nil?
+
+	puts @data[index].title
+	puts @data[index].data
+end #}}}1
+
+def do_delete(args)
+#{{{1
+	index = get_index(args)
+	return if index.nil?
+
+	@data.current_index = index
+
+	if pref("deletesave_enable") and not @data.current.empty? then
+		deletefile = expand_filename(pref("deletesave_file"),
+			@data.dirname, @data.filename)
+	end
+
+	begin
+		@data.current.append_as_mbox(deletefile)
+	rescue SystemCallError => msg
+		puts msg
+	end
+
+	@data.delete
+end #}}}1
+
+def do_new
+#{{{1
+	return if @data.nil?
+
+	@data.new
+end #}}}1
+
+def do_page(args)
+#{{{1
+	index = get_index(args)
+	return if index.nil?
+
+	file = Tempfile.new("jotacli")
+	filename = file.path
+	print_verbose "creating temporary file '#{filename}'"
+
+	file.puts @data[index].title
+	file.puts @data[index].data
+	file.close
+
+	if ENV["PAGER"] then
+		cmdline = ENV["PAGER"]
+	else
+		cmdline = "/bin/more"
+	end
+	cmdline = "%s %s" % [cmdline, filename]
+	print_verbose "executing '#{cmdline}'"
+
+	if not system(cmdline) then
+		puts "Error executing '#{cmdline}' with exit code #{$?}"
+	end
+
+	File.unlink(filename)
+end #}}}1
+
+def do_default(args)
+#{{{1
+	if args.nil? or args == "" then
+		puts "Default command is '#{@default_command}'"
+	elsif args =~ /^(show|edit|page)$/ then
+		@default_command = args
+	else
+		puts "Illegal default command. Valid are show, edit, and page"
+	end
+end #}}}1
+
+private
+
+def setup
+#{{{1
+	puts "#{Version::PROGRAM_NAME} #{Version::STRING} ready"
+	puts "Type 'help' for commands"
+
+	@data = nil
+	@default_command = "page"
+end #}}}1
+
+def command_missing(command, args)
+#{{{1
+	case @default_command
+	when "show"
+		do_show(command)
+	when "edit"
+		do_edit(command)
+	when "page"
+		do_page(command)
+	end
+end #}}}1
+
+def prompt_command
+#{{{1
+	if @data.nil? then
+		"> "
+	else
+		@data.filename+"> "
+	end
+end #}}}1
+
+def postloop
+#{{{1
+	@data.save if @data
+end #}}}1
+
+def type_to_char(t)
+#{{{1
+	case t
+	when :text
+		return "t"
+	when :pref
+		return "p"
+	else
+		return "?"
+	end	
+end #}}}1
+
+def get_index(str)
+#{{{1
+	return nil if @data.nil? or str.nil?
+
+	if str =~ /^\d+$/ then
+		result = str.to_i - 1
+	else
+		result = nil
+		re = Regexp.new(str,Regexp::IGNORECASE)
+		@data.each_index do | i |
+			if @data[i].title.match(re) then
+				result = i
+				break
+			end
+		end
+		if result.nil? then
+			return nil
+		end
+	end
+	if result < 0 or result >= @data.length then
+		return nil
+	else
+		return result
+	end
+end #}}}1
+
+def pref(key)
+#{{{1
+	if @data.nil? then
+		return Preferences.defaults[key]
+	else
+		@data.pref[key]
+	end
+end #}}}1
+
+end # class
+
+# vim600: set foldmethod=marker:

data/lib/clip.rb

@@ -0,0 +1,137 @@
+
+# $Id: clip.rb 37 2009-02-09 10:06:02Z dz $
+
+# if you use vim and don't like folds type zR
+
+require 'time'
+require 'version'
+
+class Clip
+
+
+# Instance Variables
+#	data	String	""	text (*every* line ends with an LF)
+#	wrap	Boolean	false	line wrap?
+#	type	Symbol	:text	:text, :pref
+#	title	String	""	first line of clip (without LF)
+#	created	Time	now	creation time
+#	pos	Int 	0	saved cursor position
+
+
+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
+
+def Clip.from_mbox(str)
+#{{{1
+	# "From_" line already removed
+	cl = Clip.new
+	in_header = true
+	str.each_line do | line  |
+		if in_header then
+			if line == "\n" then
+				in_header = false
+				next
+			end
+			#(key, value) = line.split(/\s*:\s*/,2)	
+			# stricter pattern to preserve leading spaces
+			(key, value) = line.split(/\s*: /,2)	
+			value.chomp!
+			case key.downcase
+			when "x-wrap"
+				cl.wrap = (value.downcase == "true")
+			when "subject"
+				cl.title = value
+			when "date"
+				cl.created = Time.parse(value)
+			when "content-type"
+				case value
+				when "text/plain"
+					cl.type = :text
+				when "application/x-jota-pref"
+					cl.type = :pref
+				else
+					cl.type = :text		# safe fallback type
+				end
+			end
+		else
+			cl.data << line
+		end
+	end
+	return cl
+end #}}}1
+
+def to_mbox
+#{{{1
+	str = ""
+	str << "Date: %s\n" % @created.ctime
+	str << "Subject: %s\n" % @title
+	case @type
+	when :text
+		str << "Content-Type: text/plain\n"
+	when :pref
+		str << "Content-Type: application/x-jota-pref\n"
+	end
+	str << "X-Wrap: %s\n" % @wrap.to_s
+	str << "X-Saved-By: %s %s\n" % [
+		Version::PROGRAM_NAME, Version::STRING]
+	str << "\n"
+	str << @data
+	return str
+end #}}}1
+
+def Clip.from_hash(hash)
+#{{{1
+	cl = Clip.new
+	case hash["type"]
+	when :text
+		cl.wrap = hash["wrap"]
+		cl.data = hash["data"]
+		cl.title = hash["title"]
+		cl.created = hash["created"]
+	end
+	return cl
+end #}}}1
+
+def to_hash
+#{{{1
+	hash = Hash.new
+	hash["type"] = @type
+	hash["wrap"] = @wrap
+	hash["data"] = @data
+	hash["title"] = @title
+	hash["created"] = @created
+	return hash
+end #}}}1
+
+def append_as_mbox(file_and_path)
+#{{{1
+	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
+
+def empty?
+#{{{1
+	# strip also removes LFs
+	return @data.strip == "" && @title.strip == ""
+end #}}}1
+
+def ==(clip)
+#{{{1
+	return self.to_hash == clip.to_hash
+end #}}}1
+
+end #class
+
+# vim600: set foldmethod=marker: