rubyfocus 0.5.9 → 0.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80ef3e4cecd0eadf4c382649ebc6e0bec02f5ef0
-  data.tar.gz: 18d49a1f6c59c97058918fb1d6e9684c131cf467
+  metadata.gz: a081be1af0e05194f95e7de7e5e4452a53605971
+  data.tar.gz: 84f7160ffec7195233677897531a7c128eed5bb6
 SHA512:
-  metadata.gz: 104abdd65cbbf6d662786395c28d0a4ac67febbe1fea637dee88b2f46d3d58006ad59e190e8810a126261816a29c888082995d80090d4c172de767379369e80a
-  data.tar.gz: 04a52e5c3d0cb037c3b93d1d6082e808804045261d6a912710eb562295cdf97fd937063fb03b5b57ef3403fc580591c822d9f66975fc3a8e149b930b9a8594bf
+  metadata.gz: aa6f406623b728c990eb1d79877a1485437383a427563fdf16ad657e325bed552fbcecec7eeb0b59388a4e026809470dc5831a4b4de91dc0df10ec019d28b0b6
+  data.tar.gz: c5ca0640fc7d3643d8b1c6946dd533c9e4f1ea2f99cb6b054ce7d5f2d8ce933bb23dd672ec21b713df1bd2e3457a283ee2b141f30cbe09b8f3e006840b1e333f

data/CHANGELOG.md

@@ -0,0 +1,125 @@
+# Change log
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## Unreleased
+
+### Added
+* `Fetcher#encrypted?` will tell you if a fetcher is looking at an encrypted folder or not.
+
+### Changed
+
+* `Document#update` will error if you try to update based on an encrypted fetcher.
+* HISTORY.md is now CHANGELOG.md
+* Reformatted Changelog to match KaC format
+
+## [0.5.11] - 2016-09-20
+
+### Added
+* `Document#overwrite_element` now allows you to perform V1-style replacements to the database, if you really want to.
+* Should now be able to deal with either V1 or V2 patch files.
+
+### Changed
+* Major changelog reformat!
+
+## [0.5.10] - 2016-09-07
+
+### Fixed
+* Projects will no longer be demoted to tasks if a project patch doesn't contain a "<project>" tag.
+
+## [0.5.9] - 2016-09-04
+
+### Fixed
+* Blank entries in updates are now treated as "no change", rather than "new value is nil".
+
+## [0.5.8] - 2016-09-02
+
+### Fixed
+* Projects inside folders were being reported as having no container, due to empty `<task/`> tags. Now fixed.
+
+## [0.5.7] - 2016-09-02
+
+### Fixed
+* Empty `<project/>` tags in a task description will no longer cause Rubyfocus to treat said task as a project.
+
+## [0.5.6] - 2016-09-01
+
+### Added
+* Added `Time.safely_parse`, which will not choke on empty strings or nil values
+
+### Fixed
+* `conditional_set` will no longer choke on empty string for times
+
+## [0.5.5] - 2016-05-18
+
+### Fixed
+
+* If there are no patches, `Fetcher#head`s will return the ID of the base file.
+* `Fetcher#head` will now return the ID of the most recent patch, not the patch itself.
+* * `RankedItem#contained_within?` will now check against all objects matching a block or hash, rather than just the first one that the document can find.
+
+### Added
+* `Searchable` objects will now respond to `find_all`, which is an alias of `select`.
+
+## [0.5.4] - 2016-02-08
+
+### Fixed
+* `LocalFetcher` will now try the default App Store location if it can't find anything at the normal location.
+
+## [0.5.3] - 2016-02-04
+
+### Fixed
+* Re-did the code determining whether a task was blocked. Now tasks are considered blocked if their immediate container is blocked.
+* Caching some task filters on the `Task` class was causing issues. Removed caching, which shouldn't hit performance much.
+
+## [0.5.2] - 2016-02-04
+
+### Added
+* Whoops! Did I leave HTTParty out of the gem install list? My bad!
+
+## [0.5.1] - 2016-02-03
+
+### Fixed
+* `Task#next_available_task` should no longer cause errors when a project has no tasks.
+
+## [0.5.0] - 2016-01-20
+
+### Added
+* `Fetcher#head` returns the most recent patch.
+* `Fetcher#can_reach_head_from?(id)` will inform you if you can get to the head from a given ID. 
+
+## [0.4.0] - 2016-01-01
+
+* Happy new year!
+
+### Added
+* RankedItems can look at their ancestry much more easily, using RankedItem#ancestry and RankedItem#contained_within?
+* Documents now forbid elements with duplicate IDs unless Document#allow_duplicate_ids is set to true.
+* Patchers now treate CREATE nodes on elements whose IDs already exist in the database as UPDATE nodes
+
+### Changed
+* Container IDRef is now located on RankedItem, rather than having several on each RankedItem subclass.
+
+### 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
+
+### Changed
+* IDRefs will now return `nil` if the relevant ID is not set.
+
+## [0.3.0] - 2015-10-17
+
+### Added
+* Now supports remote syncing with the Omni Sync Server!
+
+## [0.2.0] - 2015-10-11
+
+### Changed
+* Will now turn tasks into projects and projects into tasks if the user has done this in OmniFocus.
+* Rubyfocus::Patch now does patch application, rather than delegating to the Fetcher.
+
+## [0.1.0] - 2015-10-10
+
+### Added
+* Hello, world!

data/README.md

@@ -1,4 +1,4 @@
-# Version: 0.5.9
+# Version: 0.5.11
 
 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!
 
@@ -22,7 +22,7 @@ Now build and install it!
 
 ```
 gem build rubyfocus.gemspec
-gem install rubyfocus-0.5.9.gem
+gem install rubyfocus-0.5.11.gem
 ```
 
 # Usage

data/lib/rubyfocus/document.rb

@@ -70,6 +70,7 @@ class Rubyfocus::Document
 	# Use the linked fetcher to update the document
 	def update
 		if fetcher
+			raise RuntimeError, "Rubyfocus cannot currently read encrypted databases." if fetcher.encrypted?
 			fetcher.update_full(self)
 		else
 			raise RuntimeError, "Tried to update a document with no fetcher."
@@ -137,8 +138,8 @@ class Rubyfocus::Document
 
 	# Update an element in-place by applying xml. This method also takes into account:
 	# * new nodes (i.e. silently creates if required)
-	# * tasks upgraded to projects
-	# * projects downgraded to tasks
+	# * tasks upgraded to projects (if task has a non-empty <project> element)
+	# * projects downgraded to tasks (if project has an empty <project> element)
 	# Note that unlike add_element, this takes pure XML
 	def update_element(node)
 		element = self[node["id"]]
@@ -146,13 +147,24 @@ class Rubyfocus::Document
 		# Does element already exist?
 		if element
 			# Quick check: is it a task being upgraded to a project?
-			if element.class == Rubyfocus::Task && Rubyfocus::Project.matches_node?(node)
+			# Upgrade criteria: non-empty project tag
+			if(
+				element.class == Rubyfocus::Task &&
+				(node / "project *").size > 0
+				)
+
 				# Upgrade
 				new_node = element.to_project
 				new_node.apply_xml(node)
 				add_element(new_node, overwrite:true)
 			# or is the project being downgraded to a task?
-			elsif element.class == Rubyfocus::Project && !Rubyfocus::Project.matches_node?(node)
+			# Downgrade criteria: presence of an empty project tag
+			elsif(
+				element.class == Rubyfocus::Project &&
+				(node / "project").size > 0 &&
+				(node / "project *").size == 0
+				)
+
 				# Downgrade
 				new_node = element.to_task
 				new_node.apply_xml(node)
@@ -167,6 +179,21 @@ class Rubyfocus::Document
 		end
 	end
 
+	# Update an element in-place by creating a new element, deleting the old, and adding the new.
+	# This method is chiefly used for patching OF documents using V1 patches. Properties not explicitly
+	# mentioned in the patch are reverted to their default values.
+	# This method also takes into account:
+	# * new nodes (i.e. silently creates if required)
+	# * tasks upgraded to projects (if task has a <project> element)
+	# * projects downgraded to tasks (if project has no <project> element)
+	# Note that unlike add_element, this takes pure XML
+	def overwrite_element(node)
+		element = self[node["id"]]
+		self.remove_element(element) if element
+
+		Rubyfocus::Parser.parse(self, node)
+	end
+
 	#-------------------------------------------------------------------------------
 	# Searchable stuff
 	def elements

data/lib/rubyfocus/fetchers/fetcher.rb

@@ -56,6 +56,11 @@ class Rubyfocus::Fetcher
 		return false
 	end
 
+	# Is this fetcher encrypted?
+	def encrypted?
+		raise RuntimeError, "Method Fetcher#encrypted? called for abstract class Fetcher."
+	end
+
 	#---------------------------------------
 	# Patching methods
 

data/lib/rubyfocus/fetchers/local_fetcher.rb

@@ -52,6 +52,11 @@ class Rubyfocus::LocalFetcher < Rubyfocus::Fetcher
 		coder.map = {"location" => @location}
 	end
 
+	# Is this fetcher fetching encrypted data?
+	def encrypted?
+		File.exists?(File.join(self.location, "encrypted"))
+	end
+
 	#---------------------------------------
 	# Location file setters and getters
 

data/lib/rubyfocus/fetchers/oss_fetcher.rb

@@ -49,26 +49,35 @@ class Rubyfocus::OSSFetcher < Rubyfocus::Fetcher
 		end
 	end
 
-	# Fetches a list of every patch file
-	def patches
-		@patches ||= begin
+	# Fetches a list of all files contained within the database
+	def files
+		@files ||= begin
 			response = self.fetcher.get(url, digest_auth: auth).body
 			# Text is in first table, let's assume
 			table = response[/<table>(.*?)<\/table>/m,1]
 			if table
-				links = table.scan(/<a href="([^"]+)"/).flatten.select{ |f| f.end_with?(".zip") }
-				links.map{ |u| Rubyfocus::Patch.new(self,u) }
+				table.scan(/<a href="([^"]+)"/).flatten
 			else
 				[]
 			end
 		end
 	end
 
+	# Fetches a list of every patch file
+	def patches
+		@patches ||= files.select{ |f| f.end_with?(".zip") }.map{ |u| Rubyfocus::Patch.new(self,u) }
+	end
+
 	# Fetches the contents of a given patch file
 	def patch(file)
 		fetch_file(file)
 	end
 
+	# Is this encrypted?
+	def encrypted?
+		files.find{ |f| File.basename(f) == "encrypted" }
+	end
+
 	# Save to disk
 	def encode_with(coder)
 		coder.map = {

data/lib/rubyfocus/items/project.rb

@@ -42,10 +42,13 @@ class Rubyfocus::Project < Rubyfocus::Task
 
 		#First, set project
 		p = n.at_xpath("xmlns:project")
-		conditional_set(:singleton, 			p.at_xpath("xmlns:singleton"))					{ |e| e.inner_html == "true" }
-		conditional_set(:review_interval, p.at_xpath("xmlns:review-interval") ) 	{ |e| Rubyfocus::ReviewPeriod.from_string(e.inner_html) }
-		conditional_set(:last_review, 		p.at_xpath("xmlns:last-review"))				{ |e| Time.safely_parse e.inner_html }
-		conditional_set(:status,					p.at_xpath("xmlns:status"))							{ |e| e.inner_html.to_sym }							
+		# We're not always going to have a project! And this *doesn't* mean that this project is demoted
+		if p
+			conditional_set(:singleton, 			p.at_xpath("xmlns:singleton"))					{ |e| e.inner_html == "true" }
+			conditional_set(:review_interval, p.at_xpath("xmlns:review-interval") ) 	{ |e| Rubyfocus::ReviewPeriod.from_string(e.inner_html) }
+			conditional_set(:last_review, 		p.at_xpath("xmlns:last-review"))				{ |e| Time.safely_parse e.inner_html }
+			conditional_set(:status,					p.at_xpath("xmlns:status"))							{ |e| e.inner_html.to_sym }							
+		end
 	end
 
 	alias_method :singleton?, :singleton

data/lib/rubyfocus/patch.rb

@@ -11,6 +11,9 @@ class Rubyfocus::Patch
 	# The file the patch loads from
 	attr_accessor :file
 
+	# What version of patch file is this? Determined from XML file
+	attr_accessor :version
+
 	# These record the transformation in terms of patch ID values.
 	attr_accessor :from_ids, :to_id
 
@@ -59,6 +62,26 @@ class Rubyfocus::Patch
 
 		str ||= fetcher.patch(self.file)
 	  doc = Nokogiri::XML(str)
+
+	  # Root should be an <omnifocus> and have an XMLNS
+	  # XMLNS should be one of:
+	  # * http://www.omnigroup.com/namespace/OmniFocus/v1
+	  # * http://www.omnigroup.com/namespace/OmniFocus/v2
+	  omnifocus = doc.root
+	  if omnifocus.name == "omnifocus"
+	  	xmlns = omnifocus.namespace && omnifocus.namespace.href
+	  	case xmlns
+	  	when "http://www.omnigroup.com/namespace/OmniFocus/v1"
+	  		self.version = 1
+	  	when "http://www.omnigroup.com/namespace/OmniFocus/v2"
+	  		self.version = 2
+	  	else
+	  		raise ArgumentError, "Unrecognised namespace #{xmlns.inspect} for Omnifocus patch file."
+	  	end
+	  else
+	  	raise ArgumentError, "Root element should be <omnifocus>, instead was <#{omnifocus.name}>."
+		end
+
 	  doc.root.children.select{ |n| !n.text?}.each do |child|
 	  	case child["op"]
 	  	when "update"
@@ -95,8 +118,18 @@ class Rubyfocus::Patch
 
 	# Apply this patch to a document.
 	def apply_to!(document)
-		# Updates modify elements
-		self.update.each{ |node| document.update_element(node) }
+		load_data
+		
+		# Updates depend on version!
+		if version == 1
+			#V1 updates overwrite elements
+			self.update.each{ |node| document.overwrite_element(node) }
+		elsif version == 2
+			#V2 updates actually update elements
+			self.update.each{ |node| document.update_element(node) }
+		else
+			raise RuntimeError, "Cannot run updates using Version #{version.inspect} OF patches!"
+		end
 		
 		# Deletes remove elements
 		self.delete.each{ |node| document.remove_element(node["id"]) }

data/version.txt

@@ -1 +1 @@
-0.5.9
+0.5.11

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyfocus
 version: !ruby/object:Gem::Version
-  version: 0.5.9
+  version: 0.5.11
 platform: ruby
 authors:
 - Jan-Yves Ruzicka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-04 00:00:00.000000000 Z
+date: 2016-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -78,7 +78,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- HISTORY.md
+- CHANGELOG.md
 - README.md
 - lib/rubyfocus.rb
 - lib/rubyfocus/core_ext.rb
@@ -131,4 +131,3 @@ signing_key:
 specification_version: 4
 summary: Pure ruby bridge to OmniFocus.
 test_files: []
-has_rdoc: 

data/HISTORY.md

@@ -1,81 +0,0 @@
-# History
-
-## 0.5.9 // 2016-09-04
-
-Further Omnifocus database format changes result in shennanigans with rubyfocus. All fixed.
-
-* [Fixed] Blank entries in updates are now treated as "no change", rather than "new value is nil".
-
-## 0.5.8 // 2016-09-02
-
-Heading off edge cases, again a result of the new Omnifocus database format
-
-* [Fixed] Projects inside folders were being reported as having no container, due to empty `<task/`> tags. Now fixed.
-
-## 0.5.7 // 2016-09-02
-
-A quick fix for the new OF database format
-
-* [Fixed] Empty `<project/>` tags in a task description will no longer cause Rubyfocus to treat said task as a project.
-
-## 0.5.6 // 2016-09-01
-
-* [New] Added `Time.safely_parse`, which will not choke on empty strings or nil values
-* [Fixed] `conditional_set` will no longer choke on empty string for times
-
-## 0.5.5 // 2016-05-18
-
-* [Fixed] If there are no patches, `Fetcher#head`s will return the ID of the base file.
-* [Fixed] `Fetcher#head` will now return the ID of the most recent patch, not the patch itself.
-* [New] `Searchable` objects will now respond to `find_all`, which is an alias of `select`.
-* [Fixed] `RankedItem#contained_within?` will now check against all objects matching a block or hash, rather than just the first one that the document can find.
-
-## 0.5.4 // 2016-02-08
-
-* [Fixed] `LocalFetcher` will now try the default App Store location if it can't find anything at the normal location.
-
-## 0.5.3 // 2016-02-04
-
-* [Fixed] Re-did the code determining whether a task was blocked. Now tasks are considered blocked if their immediate container is blocked.
-* [Fixed] Caching some task filters on the `Task` class was causing issues. Removed caching, which shouldn't hit performance much.
-
-## 0.5.2 // 2016-02-04
-
-* [Fixed] Whoops! Did I leave HTTParty out of the gem install list? My bad!
-
-## 0.5.1 // 2016-02-03
-
-* [Fixed] `Task#next_available_task` should no longer cause errors when a project has no tasks.
-
-## 0.5.0 // 2016-01-20
-
-Now work out how close to (or far from) the head of your document you are!
-
-* [New] `Fetcher#head` returns the most recent patch.
-* [New] `Fetcher#can_reach_head_from?(id)` will inform you if you can get to the head from a given ID. 
-
-## 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!
-
-## 0.2.0 // 2015-10-11
-
-* [Bugfix] Will now turn tasks into projects and projects into tasks if the user has done this in OmniFocus.
-* [Bugfix] Rubyfocus::Patch now does patch application, rather than delegating to the Fetcher.
-
-## 0.1.0 // 2015-10-10
-
-* Hello, world!