keepyourhead 0.2.0

data/lib/Keepyourhead/Version.rb

@@ -0,0 +1,43 @@
+module KeepYourHead
+
+module Project
+	Major = 0
+	Minor = 2
+	Subminor = 0 
+
+	FileMajor = 0
+	FileMinor = 1
+
+	VERSION = [Major,Minor, Subminor].join(".")
+	FILE_VERSION=[FileMajor, FileMinor].join(".")
+
+	GEM = "keepyourhead"
+	NAME = "KeepYourHead"
+	AUTHOR = "Oliver Burghard"
+	EMAIL = "OliverBurghard@web.de"
+	AUTHOR_WITH_EMAIL = "#{AUTHOR} (#{EMAIL})"
+	HOMEPAGE = "http://keepyourhead.rubyforge.org"
+	SUMMARY = "KeepYourHead is a latex based flashcard trainer under GPL3"
+	DESCRIPTION =<<END
+#{SUMMARY}. It includes an editor as well as an trainer. Flashcards are build in latex. Latex is a powerful tool for \
+descriping documents. The Flashcards are checked by letting the user judge if he knew the answer well enough.
+END
+	
+	COPYRIGHT = "Copyright 2008 Oliver Burghard"
+
+	LICENSE = ::File.open( Resources::system("../COPYING.txt"), "r" ) { |file| file.readlines.join("") }
+
+
+	BANNER = <<END
+	#{NAME}
+	#{COPYRIGHT}
+	Released under the GPL
+END
+
+end
+
+end
+
+module Project 
+	include KeepYourHead::Project
+end

data/lib/Keepyourhead/database/Base.rb

@@ -0,0 +1,77 @@
+#	Copyright 2008 Burghard Oliver
+#
+#	This file is part of KeepYourHead.
+#
+#	KeepYourHead is free software: you can redistribute it and/or modify
+#	it under the terms of the GNU General Public License as published by
+#	the Free Software Foundation, either version 3 of the License, or
+#	(at your option) any later version.
+#
+#	KeepYourHead is distributed in the hope that it will be useful,
+#	but WITHOUT ANY WARRANTY; without even the implied warranty of
+#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#	GNU General Public License for more details.
+#
+#	You should have received a copy of the GNU General Public License
+#	along with KeepYourHead.  If not, see <http://www.gnu.org/licenses/>.
+
+
+module KeepYourHead
+module Database
+	class BaseItem
+#		def parent
+#			objectFromNode @node.parent
+#		end
+
+		def parent
+			throw ExceptionNotImplemented.new
+#overwrite
+		end
+
+		def remove
+			parent.itemRemove self
+		end
+
+		def previous
+			parent.itemPrevious self
+		end
+		def next
+			parent.itemNext self
+		end
+		def children
+			[]
+		end
+	end
+	
+	class BaseItemWithXml < BaseItem
+		def self.my_define_method(*args, &proc)
+			define_method(*args, &proc)
+		end
+
+		include XmlAccessor
+
+		attr_reader :file, :node
+
+		def initialize( file, node)
+			@file = file
+			@node = node
+
+			assert @node
+			assert @file
+		end
+		
+		def objectFromNode(node, &proc)
+			file.objectFromNode(node, &proc)
+		end
+
+		def parent
+			objectFromNode @node.parent
+		end
+
+		def database
+			file.database
+		end
+	end	
+end 
+
+end

data/lib/Keepyourhead/database/BaseStatistic.rb

@@ -0,0 +1,63 @@
+#	Copyright 2008 Burghard Oliver
+#
+#	This file is part of KeepYourHead.
+#
+#	KeepYourHead is free software: you can redistribute it and/or modify
+#	it under the terms of the GNU General Public License as published by
+#	the Free Software Foundation, either version 3 of the License, or
+#	(at your option) any later version.
+#
+#	KeepYourHead is distributed in the hope that it will be useful,
+#	but WITHOUT ANY WARRANTY; without even the implied warranty of
+#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#	GNU General Public License for more details.
+#
+#	You should have received a copy of the GNU General Public License
+#	along with KeepYourHead.  If not, see <http://www.gnu.org/licenses/>.
+
+
+module KeepYourHead
+module BaseStatistic
+		def collectFlashcards
+			items.map{ |item| 
+				item.collectFlashcards
+			}.flatten
+		end
+		
+		
+		
+		def count
+			items.map{ |item| item.count }.inject(0) { |a,b| a+b }
+		end
+		def countActive
+			items.map{ |item| item.countActive }.inject(0) { |a,b| a+b }
+		end
+		def countPassive
+			items.map{ |item| item.countPassive }.inject(0) { |a,b| a+b }
+		end
+
+		def distribution
+			all = items.map{ |item| item.distribution }
+
+			distribution = []
+			
+			while all.inject(false) { |ret,set| ret ||= (set.length > 0) }
+				sum = 0
+				all.each { |set| 
+					sum += set.pop || 0
+				}
+				distribution << sum
+			end
+
+			distribution = distribution.reverse
+
+			distribution
+		end
+
+		def removeStatistics
+			items.each{ |item| item.removeStatistics }
+		end
+end
+
+
+end

data/lib/Keepyourhead/database/BaseTopicFlashcardContainer.rb

@@ -0,0 +1,43 @@
+#	Copyright 2008 Burghard Oliver
+#
+#	This file is part of KeepYourHead.
+#
+#	KeepYourHead is free software: you can redistribute it and/or modify
+#	it under the terms of the GNU General Public License as published by
+#	the Free Software Foundation, either version 3 of the License, or
+#	(at your option) any later version.
+#
+#	KeepYourHead is distributed in the hope that it will be useful,
+#	but WITHOUT ANY WARRANTY; without even the implied warranty of
+#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#	GNU General Public License for more details.
+#
+#	You should have received a copy of the GNU General Public License
+#	along with KeepYourHead.  If not, see <http://www.gnu.org/licenses/>.
+
+
+module KeepYourHead
+module Database
+	class BaseTopicFlashcardContainer < BaseItemWithXml
+		
+		include BaseStatistic
+
+		xml = XmlAccessorElementList.new self, :item, /^topic|flashcard$/,
+			proc { |item,node|
+				item.objectFromNode(node) { 
+					case node.name
+					when "topic"
+						Topic.new item.file, node  
+					when "flashcard"
+						Flashcard.new item.file, node  
+					end
+				} 
+			}
+
+		xml.addRead
+		xml.addInsert :onItemInsert
+		xml.addRemove :onItemRemove
+	end
+end 
+
+end

data/lib/Keepyourhead/database/Collection.rb

@@ -0,0 +1,43 @@
+#	Copyright 2008 Burghard Oliver
+#
+#	This file is part of KeepYourHead.
+#
+#	KeepYourHead is free software: you can redistribute it and/or modify
+#	it under the terms of the GNU General Public License as published by
+#	the Free Software Foundation, either version 3 of the License, or
+#	(at your option) any later version.
+#
+#	KeepYourHead is distributed in the hope that it will be useful,
+#	but WITHOUT ANY WARRANTY; without even the implied warranty of
+#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#	GNU General Public License for more details.
+#
+#	You should have received a copy of the GNU General Public License
+#	along with KeepYourHead.  If not, see <http://www.gnu.org/licenses/>.
+
+
+module KeepYourHead
+module Database
+	class Collection < BaseTopicFlashcardContainer
+		def initialize( file, node )
+			super file, node
+		end
+
+		XmlAccessor::addElementText self, :name, "name", :onItemChange, proc { |item, v| v || "" } 
+		
+		XmlAccessor::addElementText self, :originAuthor, "OriginAuthor", :onItemChange, proc { |item, v| v || "" } 
+		XmlAccessor::addElementText self, :originType, "OriginType", :onItemChange, proc { |item, v| v || "" } 
+		XmlAccessor::addElementText self, :originDate, "OriginDate", :onItemChange, proc { |item, v| v || "" } 
+		
+		XmlAccessor::addElementCData self, :latexHeader, "LatexHeader", :onItemChange, proc { |item, v| v || "" } 
+		XmlAccessor::addElementCData self, :latexAppend, "LatexAppend", :onItemChange, proc { |item, v| v || "" } 
+		XmlAccessor::addElementCData self, :latexPrepend, "LatexPrepend", :onItemChange, proc { |item, v| v || "" } 
+		
+		def self.createNode( file )
+			obj = Collection.new file, REXML::Element.new( "collection" )
+			obj.name = "neue Collection"
+			obj.node
+		end
+	end
+end 
+end

data/lib/Keepyourhead/database/Database.rb

@@ -0,0 +1,139 @@
+#	Copyright 2008 Burghard Oliver
+#
+#	This file is part of KeepYourHead.
+#
+#	KeepYourHead is free software: you can redistribute it and/or modify
+#	it under the terms of the GNU General Public License as published by
+#	the Free Software Foundation, either version 3 of the License, or
+#	(at your option) any later version.
+#
+#	KeepYourHead is distributed in the hope that it will be useful,
+#	but WITHOUT ANY WARRANTY; without even the implied warranty of
+#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#	GNU General Public License for more details.
+#
+#	You should have received a copy of the GNU General Public License
+#	along with KeepYourHead.  If not, see <http://www.gnu.org/licenses/>.
+
+
+module KeepYourHead
+module Database
+	class Database
+		def items
+			files
+		end
+		include BaseStatistic
+
+		def initialize
+			@viewers = []
+			@files = []
+
+			load
+		end
+	
+		def files
+			@files
+		end
+
+		def load
+			($preferences[:files] || []).each { |filename|
+				fileOpen filename if ::File.exist?( filename)
+			}
+		end
+		def writeBack
+			$preferences[:files] = files.map{ |file| file.filename }.compact
+		end
+		
+		def saveAllChanged
+			files.each { |file|
+				file.save if file.changed
+			}
+		end
+
+		def fileOpen(filename)
+			filename = ::File.expand_path filename
+
+			
+			if not files.map{ |file| file.filename }.include? filename then
+				file = KeepYourHead::Database::File.open( self, filename )
+			
+				@files << file
+				file.viewerAdd self
+				viewersSend :onItemInsert, file
+			end
+		end
+		def fileNew
+			file = Database::File.createNew self
+			@files << file
+			file.viewerAdd self
+			viewersSend :onItemInsert, file
+		end
+		def fileClose(file)
+			file.viewerRemove self
+			@files.delete file
+			viewersSend :onItemRemove, file
+		end
+
+
+# helper for moving files up and down
+		def moveUp( file )
+			assert file.kind_of?(Database::File)
+
+			viewersSend :onItemRemove, file
+			index = files.index file
+			assert index
+			files.delete_at(index)
+			files.insert([index-1,0].max,file)
+			viewersSend :onItemInsert, file
+		end
+		def moveDown( file )
+			assert file.kind_of?(Database::File)
+
+			viewersSend :onItemRemove, file
+			index = files.index file
+			assert index
+			files.delete_at(index)
+			files.insert([index+1,files.length].min,file)
+			viewersSend :onItemInsert, file
+		end
+
+
+		def viewerAdd( v )
+			@viewers << v unless @viewers.include? v
+		end
+
+		def viewerRemove( v )
+			@viewers.delete v
+		end
+
+		def viewersSend( name, *args )
+			assert name
+
+			@viewers.each{ |v| 
+				v.send name, *args 
+			}
+		end
+
+
+
+
+
+		def onItemChange(item)
+			viewersSend :onItemChange, item
+		end
+		def onItemRemove(item)
+			viewersSend :onItemRemove, item
+		end
+		def onItemInsert(item)
+			viewersSend :onItemInsert, item
+		end
+		def onReload(file)
+			viewersSend :onReload, file
+		end
+		
+
+	end
+end
+
+end
+

data/lib/Keepyourhead/database/File.rb

@@ -0,0 +1,224 @@
+#	Copyright 2008 Burghard Oliver
+#
+#	This file is part of KeepYourHead.
+#
+#	KeepYourHead is free software: you can redistribute it and/or modify
+#	it under the terms of the GNU General Public License as published by
+#	the Free Software Foundation, either version 3 of the License, or
+#	(at your option) any later version.
+#
+#	KeepYourHead is distributed in the hope that it will be useful,
+#	but WITHOUT ANY WARRANTY; without even the implied warranty of
+#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#	GNU General Public License for more details.
+#
+#	You should have received a copy of the GNU General Public License
+#	along with KeepYourHead.  If not, see <http://www.gnu.org/licenses/>.
+
+
+module KeepYourHead
+module Database
+	class File
+		def items
+			root.collections
+		end
+		include BaseStatistic
+
+		attr_reader :filename
+		attr_reader :changed
+		attr_reader :root
+		attr_reader :database
+
+# should not be called direct
+		def initialize(database)
+			@dom = nil
+			@styles = {}
+
+
+			@database = database
+			
+			@viewers = []
+			viewerAdd(self)
+		end
+	
+
+		def file
+			self
+		end
+
+
+
+		def viewerAdd( v )
+			@viewers << v unless @viewers.include? v
+		end
+
+		def viewerRemove( v )
+			@viewers.delete v
+		end
+
+		def viewersSend( name, *args )
+			assert name
+
+			@viewers.each{ |v| 
+				v.send name, *args 
+			}
+		end
+
+
+
+
+		#is his own visitor
+		def onItemChange(item)
+			setChanged if item.file == self
+		end
+		def onItemRemove(item)
+			setChanged if item.file == self
+		end
+		def onItemInsert(item)
+			setChanged if item.file == self
+		end
+		def onReload(file)
+			@changed = false
+		end
+		
+		
+# should not be called direct
+		def loadFile(filename)
+			assert @dom == nil
+
+			@filename = filename 
+			
+			::File.open( @filename ) { |file|
+				@dom = REXML::Document.new file
+			}
+
+			reload
+		end
+
+# should not be called direct
+		def loadContent(contents)
+			assert @dom == nil
+
+			@filename = nil 
+			@dom = REXML::Document.new(contents)
+
+			reload
+		end
+
+		
+		def self.open(database, filename)
+			ret = File.new database
+			ret.loadFile filename
+			ret
+		end
+
+		def self.createNew(database)
+			ret = self.new database
+			content = "<flashcard_database version=\"#{Application::FILE_VERSION}\" />"
+			ret.loadContent content
+			ret.setChanged
+			ret
+		end
+
+		def filename=(filename)
+			@filename = filename
+			viewersSend :onItemChange, self
+		end
+
+		
+		
+		def reload
+			@mapObjectFromNode = {}
+			
+			node = REXML::XPath.first( @dom, "flashcard_database" )
+
+			throw Exception.new("file not a flashcard database") unless node
+			
+#			@root = FileRoot.new self, node
+			@root = objectFromNode(node) { || FileRoot.new self, node }
+
+			viewersSend "onReload", self
+		end
+		
+		
+		def objectFromNode(node)
+			@mapObjectFromNode[node] ||= yield
+			@mapObjectFromNode[node]
+		end
+
+
+		def normalizeWhitespace( parent )
+			if parent.kind_of?( REXML::Parent ) and 
+				parent.children.select { |c| c.kind_of?(REXML::Element) }.length > 0 then
+				
+				remove = []
+				parent.each { |node|
+					remove << node if node.kind_of?(REXML::Text)
+				}
+				remove.each { |node| parent.delete node }
+				
+				
+				indent = -1 #because the root is also counted
+				i = parent.parent
+				while i and i.kind_of?(REXML::Element) do
+					indent += 1
+					i = i.parent
+				end
+
+				parent.children.each { |c| parent.insert_before c, REXML::Text.new( "\n" + "  " * (indent+1), true )  }
+				parent.insert_after parent.children.last, REXML::Text.new( "\n" + "  " * indent, true )
+			end
+
+			if parent.kind_of?( REXML::Parent ) then
+				parent.children.each { |node|
+					normalizeWhitespace node
+				}
+			end
+		end
+
+
+		def save
+			assert @filename
+			
+			FileUtils::mv( @filename, @filename + "~" ) if ::File.exist?(@filename)
+			saveAs @filename
+		end
+
+		def saveAs(filename)
+			assert filename
+
+			self.filename = filename
+			
+			normalizeWhitespace @dom.root
+
+			::File.open( self.filename, "w" ) { |file|
+				@dom.write file
+			}
+			@changed = false
+		end
+
+		def setChanged
+			@changed = true
+		end
+
+		
+
+
+
+		def style(name)
+			if not @styles[name] then
+				s = KeepYourHead::Database::Style.getStyle(name)
+				assert s
+				@styles[name] = s.new(self)
+			end
+			
+			assert @styles[name]
+			@styles[name]
+		end
+	end
+
+
+end
+
+
+end