rubyfocus 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61a752ab5129ed61bbe2f963646d66ef2e1b3b97
-  data.tar.gz: e19a2a1e78254bd70b72379ddf4bcd77520e9c04
+  metadata.gz: 63565e849764d58187bc270c714a509aec780ff5
+  data.tar.gz: 91c1408da7a1764a625d0ebd1434441dde52cd79
 SHA512:
-  metadata.gz: 663d2e0ca73d48a96079b9bec2435226ff8bb7d807abb7a9e8d4d7c86b0ea9038f458722d8e8692f5cd411f50bfbaf6c7428cc4976f1e26bdcf6cab7f3b5a2da
-  data.tar.gz: 81d92aab4bc7fce3d8d6d376836c6e7154aceae519a143c6782d61c1dd4426b5e678e2bf634d75b3825d0cb3d5fb74597baf6c48e2251aa1565b4e93062478d0
+  metadata.gz: 2f2925e0baae0e08eaf043a7dea9120446ab15b99729f9319c3c47e73feafe7246262879fa409734f0fce6e7566571a3711e3023d56217ec83af77a33ebdaad7
+  data.tar.gz: 119909f3d146a97f0d4cd7b3fd0c1afff0425220c8acfd235f6635609a3fe2fdfd33f3106bf51cbc85481a65c43dc991a01f68cf1f4d5110e91b5d2421c10166

data/README.md

@@ -1,8 +1,14 @@
+# Version: 0.4.0
+
 Rubyfocus is a one-way (read-only) ruby bridge to OmniFocus. Analyse, store, inspect, or play with your projects and tasks in OmniFocus from the comfort and flexibility of ruby!
 
 # Installation
 
-Rubyfocus is a ruby gem. It's not currently hosted on rubygems, though, so you'll have to download and install locally.
+## Via rubygems
+
+```
+gem install rubyfocus
+```
 
 ## Via git
 
@@ -16,7 +22,7 @@ Now build and install it!
 
 ```
 gem build rubyfocus.gemspec
-gem install rubyfocus-0.1.0.gem
+gem install rubyfocus-0.3.0.gem
 ```
 
 # Usage
@@ -64,13 +70,13 @@ d.projects.first.tasks
 
 What if you want to select only certain projects? Sure, you can use standard `Array#find` or `Array#select` methods, but you can also make use of a hash of values:
 
-```
+```ruby
 d.projects.select(name: "Sample project")
 ```
 
 Once you have your objects, you can query them for more information:
 
-```
+```ruby
 t = d.tasks.first
 t.name # => "Sample task"
 t.project.name # => "Sample project"
@@ -102,11 +108,25 @@ Rubyfocus makes use of this by fetching and reading OmniFocus' local store on yo
 
 Other goals include:
 
-* Updating via the [Omni Sync Server](https://manage.sync.omnigroup.com/) rather than relying on local files.
-* A couple of example projects using rubyfocus
+* Registering with the Omni Sync Server, so you don't need to always delete + reinstantiate the database.
+* Determining when you're "detached" from the latest version on the OSS.
+* A couple of example projects using rubyfocus (especially a static webpage generator for kanban)
 
 # History
 
+## 0.4.0 // 2016-01-01
+
+* Happy new year!
+* [Modified] Container IDRef is now located on RankedItem, rather than having several on each RankedItem subclass.
+* [New] RankedItems can look at their ancestry much more easily, using RankedItem#ancestry and RankedItem#contained_within?
+* [New] Documents now forbid elements with duplicate IDs unless Document#allow_duplicate_ids is set to true.
+* [New] Patchers now treate CREATE nodes on elements whose IDs already exist in the database as UPDATE nodes
+* [Fixed] Patchers will now interpret missing parameters as "default values" e.g. project update without `status` parameter assumed to be active.
+
+## 0.3.1 // 2015-12-31
+
+* [Bugfix] IDRefs will now return +nil+ if the relevant ID is not set.
+
 ## 0.3.0 // 2015-10-17
 
 * [New] Now supports remote syncing with the Omni Sync Server!

data/lib/rubyfocus/document.rb

@@ -53,7 +53,7 @@ class Rubyfocus::Document
 	end
 
 	# Initialize with a URL, for remote fetching.
-	# Not implemented yet
+	# Not implemented yet TODO implement
 	def self.from_url(url)
 		raise RuntimeError, "Rubyfocus::Document.from_url not yet implemented."
 		# new(Rubyfocus::RemoteFetcher.new(url))
@@ -96,9 +96,22 @@ class Rubyfocus::Document
 	end
 	private :ivar_for
 
-	# Add an element. Element should be a Project, Task, Context, Folder, or Setting
-	# We assume whoever does this will set document appropriately on the element
-	def add_element(e)
+	# Add an element. Element should be a Project, Task, Context, Folder, or Setting.
+	# If overwrite set to false and ID already occurs in the document, throw an error.
+	# If ID is nil, throw an error.
+	def add_element(e, overwrite:false)
+		# Error check
+		raise(Rubyfocus::DocumentElementException, "Adding element to document, but it has no ID.") if e.id.nil?
+		raise(Rubyfocus::DocumentElementException, "Adding element to document, but element with this ID already exists.") if !overwrite && has_id?(e.id)
+
+		# Otherwise, full steam ahead
+		e.document = self
+
+		if (dupe_element = self[e.id]) && overwrite
+			remove_element(dupe_element)
+		end
+
+		# Add to the correct array
 		dest = ivar_for(e)
 		if dest
 			dest << e
@@ -108,12 +121,12 @@ class Rubyfocus::Document
 	end
 
 	# Remove an element from the document.
-	# We assume whoever does this is smart enough to also set the element's #document value
-	# to nil
 	def remove_element(e)
 		e = self[e] if e.is_a?(String)
 		return if e.nil?
 
+		e.document = nil
+
 		dest = ivar_for(e)
 		if dest
 			dest.delete(e)
@@ -131,16 +144,26 @@ class Rubyfocus::Document
 	# For Searchable include
 	alias_method :array, :elements
 
+
 	#-------------------------------------------------------------------------------
 	# Find elements from id
 	def [] search_id
 		self.elements.find{ |elem| elem.id == search_id }
 	end
 
+	# Check if the document has an element of a given ID
+	def has_id?(id)
+		self.elements.any?{ |e| e.id == id }
+	end
+
 	#---------------------------------------
 	# YAML export
 
 	def save(file)
 		File.open(file, "w"){ |io| io.puts YAML::dump(self) }
 	end
-end
+end
+
+#-------------------------------------------------------------------------------
+# Exceptions
+class Rubyfocus::DocumentElementException < Exception; end

data/lib/rubyfocus/includes/idref.rb

@@ -6,7 +6,7 @@ module Rubyfocus
 					name_id = "#{name}_id".to_sym
 					attr_accessor name_id
 					define_method(name) do
-						return document && document.find(send(name_id))
+						return document && (id_value = send(name_id)) && document.find(id_value)
 					end
 
 					define_method("#{name}=") do |o|

data/lib/rubyfocus/items/context.rb

@@ -4,7 +4,6 @@ class Rubyfocus::Context < Rubyfocus::RankedItem
 		return (node.name == "context")
 	end
 
-	idref :container
 	attr_accessor :location
 
 	def apply_xml(n)

data/lib/rubyfocus/items/folder.rb

@@ -4,8 +4,6 @@ class Rubyfocus::Folder < Rubyfocus::RankedItem
 		return (node.name == "folder")
 	end
 	
-	idref :container
-
 	def apply_xml(n)
 		super(n)
 		conditional_set(:container_id, n.at_xpath("xmlns:folder")){ |e| e["idref"] }

data/lib/rubyfocus/items/item.rb

@@ -13,8 +13,6 @@ class Rubyfocus::Item
 	attr_accessor :id, :added, :modified, :document
 
 	def initialize(document=nil, n=nil)
-		self.document = document
-
 		case n
 		when Nokogiri::XML::Element
 			apply_xml(n)
@@ -24,6 +22,8 @@ class Rubyfocus::Item
 				send(setter,v) if respond_to?(setter)
 			end
 		end
+		
+		document.add_element(self) if document
 	end
 
 	def apply_xml(n)
@@ -45,14 +45,6 @@ class Rubyfocus::Item
 		inspect_properties.each_with_object({}){ |s,hsh| hsh[s] = self.send(s) }
 	end
 
-	#---------------------------------------
-	# Document set/get methods
-	def document= d
-		@document.remove_element(self) if @document
-		@document = d
-		@document.add_element(self) if @document
-	end
-
 	#-------------------------------------------------------------------------------
 	# Private inspect methods
 

data/lib/rubyfocus/items/ranked_item.rb

@@ -1,6 +1,25 @@
 class Rubyfocus::RankedItem < Rubyfocus::NamedItem
 	attr_accessor :rank
 
+	# Ranked items also happen to be contained items
+	idref :container
+
+	# Retrieve a full list of the parents of this item. [0] = immediate parent
+	def ancestry
+		if container
+			[container] + container.ancestry
+		else
+			[]
+		end
+	end
+
+	# Is this item contained within another? You may supply an object, string or integer ID, hash of properties,
+	# or proc to run on each item.
+	def contained_within?(object)
+		object = document.find(object) if [String, Fixnum, Hash, Proc].include?(object.class)
+		ancestry.include?(object)
+	end
+
 	def apply_xml(n)
 		super(n)
 		conditional_set(:rank, n.at_xpath("xmlns:rank")){ |e| e.inner_html.to_i }

data/lib/rubyfocus/items/task.rb

@@ -15,7 +15,7 @@ class Rubyfocus::Task < Rubyfocus::RankedItem
 	# * document
 
 	attr_accessor :note, :flagged, :order, :start, :due, :completed
-	idref :container, :context
+	idref :context
 
 	def initialize(document, n=nil)
 		@order = :sequential

data/lib/rubyfocus/patch.rb

@@ -92,45 +92,32 @@ class Rubyfocus::Patch
 		end
 	end
 
-	# Apply this patch to a document. Who needs error checking amirite?
+	# Apply this patch to a document.
 	def apply_to!(document)
 		# Updates modify elements
-		self.update.each do |node|
-			elem = document[node["id"]]
-
-			# Tasks can become projects and v.v.: check this.
-			if [Rubyfocus::Task, Rubyfocus::Project].include?(elem.class)
-				should_be_project = (node.at_xpath("xmlns:project") != nil)
-				if (elem.class == Rubyfocus::Project) && !should_be_project
-					elem.document = nil # Remove this from current document
-					elem = elem.to_task # Convert to task
-					elem.document = document # Insert again!
-				elsif (elem.class == Rubyfocus::Task) && should_be_project
-					elem.document = nil # Remove this from current document
-					elem = elem.to_project # Convert to task
-					elem.document = document # Insert again!
-				end
-			end
-
-			elem.apply_xml(node) if elem
-		end
-
+		self.update.each{ |node| update_node(document, node) }
+		
 		# Deletes remove elements
-		self.delete.each do |node|
-			document.remove_element(node["id"])
-		end
+		self.delete.each{ |node| document.remove_element(node["id"]) }
 
 		# Creates make new elements
-		self.create.each do |node|
-			if Rubyfocus::Parser.parse(document, node).nil?
-				raise RuntimeError, "Encountered unparsable XML during patch reading: #{node}."
-			end
-		end
+		self.create.each{ |node| update_node(document, node) }
 
 		# Modify current patch_id to show new value
 		document.patch_id = self.to_id
 	end
 
+	# Atomic node update code
+	def update_node(document, node)
+		# Create new element with correct ID. Then add to document, overwriting previous element(s)
+		new_node = Rubyfocus::Parser.parse(nil, node)
+		if new_node
+			document.add_element(new_node, overwrite: true)
+		else
+			raise(RuntimeError, "Encountered unparsable XML during patch reading: #{node}.")
+		end
+	end
+
 	# String representation
 	def to_s
 		if from_ids.size == 1

data/version.txt

@@ -1 +1 @@
-0.3.1
+0.4.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyfocus
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jan-Yves Ruzicka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-29 00:00:00.000000000 Z
+date: 2016-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri