omniboard 1.1.1 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2e2d60b99706bc348ecdf70a1e4f1851346f0316
-  data.tar.gz: a38acea769d7d5cfb9baa852816970dd1f462096
+SHA256:
+  metadata.gz: 15db7647454acd44ef5c675928f18dcea5172075745470acf7e5388059310c98
+  data.tar.gz: f1de449bc7bb14adc915796f1106a450bc6a8375d805dbaecede74bb2552d184
 SHA512:
-  metadata.gz: 1e0fadb02d7333a293538b4f342cf9a7da530d75052f55524ab642b8e1eaeef01575aa0ee8e112b0c32dd9b781e975667d27c1bba24c9c2f8183444097581ae9
-  data.tar.gz: c84e7be8a6a55cf2e0e4f5ffff26f0655959e5400e0fc2767c2f3da7198b6fc2c7de0f7f09ccc95dd20ba34ff30fee897ec5ad55f2989b872d5cf05050a3af85
+  metadata.gz: 88ee622465d0e65f071b4aa5f079b4dc771d1802b1428dfe006fa2c5d7d77d28c5470ac96fc06a2b178217bb45f5dfa053b806b1d45125c032b14c8ac2baa876
+  data.tar.gz: 232967a418d4aa6a1736edc4b712c6eadc75794838830b47eeec95fd87ce12a59a7476433b2241f913d0c0072df6be65947edaba10eb87f07b0baf1523cc1d54

data/CHANGELOG.md

@@ -0,0 +1,131 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/) 
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+# [1.2.4] - 2019-04-04
+
+### Changed
+
+* Updated gem dependencies from "trollop" to "optimist"
+
+# [1.2.3] - 2017-12-18
+
+### Changed
+
+* Updated Readme to discuss common issues with custom columns.
+
+# [1.2.2] - 2017-12-10
+
+### Changed
+
+* Updated `rubyfocus` version dependency.
+
+# [1.2.1] - 2017-01-07
+
+### Changed
+* Projects which are deferred will no longer show up in the active column
+
+### Fixed
+* Omniboard will no longer choke on unnamed projects
+
+# [1.2.0] - 2016-11-15
+
+### Added
+* You can now specify the `colour` of a column: all projects within that column will be coloured appropriately, regardless of what group they're in.
+
+### Changed
+* Projects with nil names are now represented as empty strings when using `ProjectWrapper#to_s`.
+* Updated README to reflect `colour` property.
+
+# [1.1.2] - 2016-10-10
+ 
+### Changed
+* HISTORY is now CHANGELOG. Formatting based on Keep a Changelog.
+* Edited README so examples on colouring groups are better.
+* Non-group rendering in `column.erb` is slightly prettier.
+
+### Fixed
+* Default config docs now work properly without giving you errors.
+* Will no longer try to load non-html files in the columns directory.
+* Updated dependency version for RubyFocus.
+
+## [1.1.1] - 2016-09-09
+
+### Added
+* `Omniboard::Column.reset_columns` allows you to wipe the global register of columns. Useful for unit testing.
+* `Omniboard::Column.reset_config` now takes the option `:all` to wipe all configuration fields.
+
+### Fixed
+* The `config.rb` template file will now let you have projects that are not contained within folders.
+
+## [1.1.0] - 2016-08-29
+
+### Added
+* You can now add custom CSS to your board. Any CSS in the file `custom.css` (inside your config file) will be included in the output HTML file. See the readme for more information.
+
+## [1.0.1] - 2016-08-01
+
+### Fixed
+* Fixing CDATA tags within javascript - allows me to parse as XHTML while keeping JS all good.
+* Improved display of column header numbers.
+
+## [1.0.0] - 2016-07-08
+
+### Added
+* `Omniboard::document=` is available if you just want to set Omniboard's document variable by yourself without all that hassle of loading from file.
+* If your document has no fetcher, it's always considered to be at head.
+* Substantial changes to how groups work. You may now return any object from a `group_by` method, and use that object to sort your groups before displaying names. See the Readme for more information on how to use the updated groups.
+* You can now custom colour your groups! See the Readme for more information.
+* The column's `icon` methods may now return an array of `[icon, alt]`, for supplying popup information on icons.
+* You can add a "refresh" link to the top of the page using the `refresh_link` property inside `config`.
+* Setting `hide_dimmed` on a column will automatically hide dimmed projects on page load
+* Set project counts using the `display_project_counts` property on columns. Can be set to `all`, `active`, or `marked`.
+
+## [0.4.0] - 2016-06-27
+
+### Added
+* Added some shiny CSS for the project details - notes and remaining tasks lists should be a bit sexier
+
+
+### Changed
+* Project notes will now show basic styling (italics, bold, underline; better paragraphs).
+* Projects now show due and deferral dates (when appropriate) in the project overlay
+
+## [0.3.3] - 2016-05-23
+
+### Added
+* Omniboard works out when your document is out of date, or even when it's become detached from the head of your omnifocus database, and lets you know.
+
+### Fixed
+* `Group` now has a default `light_colour` method - no more errors if you don't group your projects!
+
+
+## [0.3.1] - 2016-02-13
+
+### Fixed
+* Remove console.log() debugging in js functions
+* Previous change to hide/show code resulted in a non-functioning info overlay. Now fixed.
+
+## [0.3.0] - 2016-02-12
+
+### Added
+* You can now set a block property to `nil` to avoid running any block (including any defaults).
+
+## [0.2.1] - 2016-02-09
+
+### Fixed
+* Added `trollop` to list of runtime dependencies
+
+## [0.2.0] - 2016-02-08
+
+### Changed
+* Project groups will hide themselves if every child project has been hidden.
+
+### Added
+* Added `Column#filter_button`, which allows you to add a button filtering out dimmed tasks.
+
+## [0.1.0] - 2016-02-04
+
+Hello, world!

data/README.md

@@ -16,7 +16,7 @@ Omniboard comes as a gem, although it's not currently hosted on rubygems or the
 git clone https://github.com/jyruzicka/omniboard.git
 cd omniboard
 gem build omniboard.gemspec
-gem install omniboard-1.1.1.gem
+gem install omniboard-1.2.3.gem
 ```
 
 Alternatively, add it to your `Gemfile`:
@@ -33,6 +33,13 @@ Once installed, use the built-in binary:
 omniboard
 ```
 
+or try the following to see the kanban in your web browser:
+
+```
+omniboard -o kanban.html
+open kanban.html 
+```
+
 To see the possible flags, run:
 
 ```
@@ -81,6 +88,7 @@ end
 * **hide_dimmed**: When set to true, dimmed projects will be automatically hidden on page load. By default, set to false.
 * **display_project_counts**: Set this to `:all`, `:active`, or `:marked`. Will display the total number of projects in a column: the value you give it will determine if it counts all projects (`:all`), projects which are not dimmed (`:active`), or only marked projected (`:marked`).
 * **project_limit**: If you're display project counts and you have more projects than this number, the project count will show up highlighted red. Useful if you're trying to keep down your total number of active projects!
+* **colour**: If specified, all projects in this column will be coloured appropriately. Use it to keep your completed column greyed out, or your high-priority column bright red.
 
 The following column properties take blocks of ruby code. You can alter these inside the column block in the following manner:
 
@@ -139,11 +147,37 @@ By default, each group is given an arbitrary colour. Sometimes you might want to
 
 ```ruby
 Omniboard::Column.config do
-	colour_group(50){ |i| i == 0 }
+  group_by{ |p| p.container || "" }
+
+	colour_group(50){ |identifier| identifier.respond_to?(:name) && identifier.name == "Home Projects" }
+end
+```
+
+The `colour_group` method takes two arguments: first, a numerical value which represents the *hue* you want the group to be, and a block which takes the group identifier and returns `true` or `false`. In the above example, we're using the containing folder as the group identifier. If the containing folder's name is "Home Projects", we set the group's colour to `50`.
+
+#### A note on groups and identifiers
+
+You may find that upon creating a new column, with a new grouping block, you get an error that looks something like this:
+
+```ruby
+.omniboard/columns/config.rb:16:in block (2 levels) in <top (required)>': undefined method 'ancestry' for (1/1):Rational (NoMethodError)
+from /usr/local/lib/ruby/gems/2.4.0/gems/omniboard-1.2.1/lib/omniboard/column.rb:163:in 'sort'
+from /usr/local/lib/ruby/gems/2.4.0/gems/omniboard-1.2.1/lib/omniboard/column.rb:163:in 'groups'
+...
+```
+
+This is probably due to differing group identifiers. For example, the "Due Soon" column above uses integers as group identifiers (`1`, `2`, etc.), while your default columns use `Rubyfocus::Folder`s:
+
+```ruby
+Omniboard::Column.config do
+	group_by{ |p| p.container || "" }
+	...
 end
 ```
 
-The `colour_group` method takes two arguments: first, a numerical value which represents the *hue* you want the group to be, and a block which is evaluated by passing the group's identifier and receiving `true` or `false`. So in this example, if the identifier is equal to 0, the group's colour is set to 50.
+Since the default group is a `Rubyfocus::Folder`, the default sorting and group naming methods assume they're being passed one (or more) `Rubyfocus::Folder`. If they get passed an integer (or a string, or a boolean, or anything else), they'll throw an error.
+
+The moral of the story: if you're making a new column, with a new `group_by` method, you probably need to provide a `sort_groups` and `group_name` method as well.
 
 ### Global configuration
 

data/bin/omniboard

@@ -3,7 +3,7 @@
 require "omniboard"
 
 # Command line options
-require "trollop"
+require "optimist"
 
 opts = Trollop::options do
 	opt :configure, "Location of configuration files. (Default: #{File.join(ENV["HOME"], ".omniboard")})", type: String
@@ -11,7 +11,6 @@ opts = Trollop::options do
 	opt :reset, "Wipe cache and start again from the source."
 end
 
-
 # Set configuration location
 Omniboard::config_location = opts[:configure] if opts[:configure]
 

data/lib/omniboard/column.rb

@@ -52,6 +52,9 @@ class Omniboard::Column
 	# How many projects to show per line? Defaults to 1.
 	property :columns
 
+	# Column-wide colour setting. Overrides group colours
+	property :colour
+
 	# Intializer. Provide name and block for instance evaluation (optional)
 	def initialize(name, &blck)
 		# Set defaults

data/lib/omniboard/columns/active.rb

@@ -1,6 +1,6 @@
 Omniboard::Column.new "Active" do
 	order 1
-	conditions{ |p| p.active? }
+	conditions{ |p| p.active? && !p.deferred? }
 
 	width 2
 	columns 4

data/lib/omniboard/columns/config.rb

@@ -3,9 +3,38 @@ Omniboard::Column.config do
 	# Group projects by their containing folders
 	group_by{ |p| p.container || "" }
 
-	# Sort by rank, with top level projects at the top
-	sort_groups{ |c| c.nil? ? 0 : c.rank }
+	# This somewhat-complex code sorts projects by their order within OmniFocus
+  # Want to help? Find a more elegant way to write this :P
+  sort_groups do |a,b|
+    if a == ""
+      -1
+    elsif b == ""
+      1
+    else
+      # Compare from outside in
+      a_ancestry = [a] + a.ancestry
+      b_ancestry = [b] + b.ancestry
+      
+      a_cursor = a_ancestry.size - 1
+      b_cursor = b_ancestry.size - 1
+
+      sort_value = 0
+      until a_cursor < 0 || b_cursor < 0 || sort_value != 0
+        sort_value = (a_ancestry[a_cursor].rank <=> b_ancestry[b_cursor].rank)
+        if sort_value == 0
+          a_cursor -= 1
+          b_cursor -= 1
+        end
+      end
+
+      if sort_value != 0
+        sort_value
+      else
+        a_ancestry.size <=> b_ancestry.size
+       end
+    end
+  end
 
 	# Name based on ancestry
-	group_name{ |c| c.nil? ? "Top level" : c.ancestry.map(&:name).reverse.join("→")}
+	group_name{ |c| (c == "") ? "Top level" : ([c] + c.ancestry.map(&:name)).reverse.join("→") }
 end

data/lib/omniboard/omniboard.rb

@@ -65,7 +65,7 @@ module Omniboard
 		# Fetch all columns!
 		def columns
 			@columns ||= begin
-				Dir[File.join(columns_location, "*")].each{ |f| require(f) } if File.exists?(columns_location)
+				Dir[File.join(columns_location, "*.rb")].each{ |f| require(f) } if File.exists?(columns_location)
 				Omniboard::Column.columns
 			end
 		end

data/lib/omniboard/project_wrapper.rb

@@ -27,7 +27,13 @@ class Omniboard::ProjectWrapper
 	#---------------------------------------
 	# Colour methods
 	def colour
-		(@group || Omniboard::Group).colour
+		if @column && @column.colour
+			@column.colour
+		elsif @group
+			@group.colour
+		else
+			Omniboard::Group.colour
+		end
 	end
 
 	def light_colour
@@ -108,7 +114,7 @@ class Omniboard::ProjectWrapper
 	end
 
 	def to_s
-		self.project.to_s
+		self.project.to_s || ""
 	end
 
 	private

data/lib/omniboard/renderer.rb

@@ -13,7 +13,6 @@ class Omniboard::Renderer
 	end
 
 
-
 	def to_s
 		preamble + @columns.map{ |c| render_column(c) }.join("\n") + postamble
 	end

data/lib/omniboard/templates/column.erb

@@ -18,8 +18,10 @@
 			</div>
 		<% end %>
 	<% else %>
-		<% column.projects.each do |p| %>
-			<%= render_project(p) %>
-		<% end %>
+		<div class="project-group">
+			<% column.projects.each do |p| %>
+				<%= render_project(p) %>
+			<% end %>
+		</div>
 	<% end %>
 </div>

data/lib/omniboard/templates/project.erb

@@ -1,4 +1,4 @@
-<div class="<%= project.css_classes.join(" ") %>" data-name="<%=project.name.sanitize%>" data-id="<%=project.id%>" data-note="<%=project.formatted_note.html_escape%>" data-colour="<%=project.colour%>" data-light-colour="<%=project.light_colour%>" data-tasks="<%=project.task_list.html_escape%>" data-deferred="<%=project.deferred_date%>" data-due="<%=project.due_date%>">
+<div class="<%= project.css_classes.join(" ") %>" data-name="<%=(project.name||"").sanitize%>" data-id="<%=project.id%>" data-note="<%=project.formatted_note.html_escape%>" data-colour="<%=project.colour%>" data-light-colour="<%=project.light_colour%>" data-tasks="<%=project.task_list.html_escape%>" data-deferred="<%=project.deferred_date%>" data-due="<%=project.due_date%>">
 	<h4><%=project.name%></h4>
 	<div class="tasks"><%=project.num_tasks%> task<%=project.num_tasks == 1 ? "" : "s"%> remaining</div>
 	<% if project.all_tasks_deferred? %>

data/omniboard.gemspec

@@ -5,11 +5,11 @@ Gem::Specification.new do |s|
   s.version = File.read("version.txt")
   s.license = "MIT"
   
-  s.summary = "Gem summary here."
-  s.description = "Gem description here."
+  s.summary = "Display Omnifocus libraries as kanban boards, with ruby."
+  s.description = "A pure-ruby library (and binary) to read and parse Omnifocus task lists as kanban boards."
   
   s.author = "Jan-Yves Ruzicka"
-  s.email = "janyves.ruzicka@gmail.com"
+  s.email = "jan@1klb.com"
   s.homepage = "https://github.com/jyruzicka/omniboard"
   
   s.files = File.read("Manifest").split("\n").select{ |l| !l.start_with?("#") && l != ""}
@@ -18,6 +18,6 @@ Gem::Specification.new do |s|
   s.executables << "omniboard"
   s.extra_rdoc_files = ["README.md"]
 
-  s.add_runtime_dependency "rubyfocus", "~> 0.5.5"
-  s.add_runtime_dependency "trollop", "~> 2.1"
+  s.add_runtime_dependency "rubyfocus", "~> 0.5", ">= 0.5.13"
+  s.add_runtime_dependency "optimist", "~> 3.0"
 end

data/version.txt

@@ -1 +1 @@
-1.1.1
+1.2.4

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniboard
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.4
 platform: ruby
 authors:
 - Jan-Yves Ruzicka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-08 00:00:00.000000000 Z
+date: 2019-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyfocus
@@ -16,37 +16,44 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.13
 - !ruby/object:Gem::Dependency
-  name: trollop
+  name: optimist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
-description: Gem description here.
-email: janyves.ruzicka@gmail.com
+        version: '3.0'
+description: A pure-ruby library (and binary) to read and parse Omnifocus task lists
+  as kanban boards.
+email: jan@1klb.com
 executables:
 - omniboard
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- HISTORY.md
+- CHANGELOG.md
 - README.md
 - Rakefile
 - bin/omniboard
@@ -92,9 +99,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Gem summary here.
+summary: Display Omnifocus libraries as kanban boards, with ruby.
 test_files: []
-has_rdoc: 

data/HISTORY.md

@@ -1,71 +0,0 @@
-# 1.1.1 // 2016-09-09
-
-Fixed an issue with core column classes. Plus some handy debugging stuff!
-
-* [New] `Omniboard::Column.reset_columns` allows you to wipe the global register of columns. Useful for unit testing.
-* [New] `Omniboard::Column.reset_config` now takes the option `:all` to wipe all configuration fields.
-* [Fix] The `config.rb` template file will now let you have projects that are not contained within folders.
-
-# 1.1.0 // 2016-08-29
-
-Add custom CSS to your omniboard.
-
-* [New] You can now add custom CSS to your board. Any CSS in the file `custom.css` (inside your config file) will be included in the output HTML file. See the readme for more information.
-
-# 1.0.1 // 2016-08-01
-
-* [Fix] Fixing CDATA tags within javascript - allows me to parse as XHTML while keeping JS all good.
-* [Fix] Improved display of column header numbers.
-
-# 1.0.0 // 2016-07-08
-
-Hopefully integrating all the little changes, bugfixes, and modifications that I've wanted to do for a while.
-
-* [New] `Omniboard::document=` is available if you just want to set Omniboard's document variable by yourself without all that hassle of loading from file.
-* [New] If your document has no fetcher, it's always considered to be at head.
-* [New] Substantial changes to how groups work. You may now return any object from a `group_by` method, and use that object to sort your groups before displaying names. See the Readme for more information on how to use the updated groups.
-* [New] You can now custom colour your groups! See the Readme for more information.
-* [New] The column's `icon` methods may now return an array of `[icon, alt]`, for supplying popup information on icons.
-* [New] You can add a "refresh" link to the top of the page using the `refresh_link` property inside `config`.
-* [New] Setting `hide_dimmed` on a column will automatically hide dimmed projects on page load
-* [New] Set project counts using the `display_project_counts` property on columns. Can be set to `all`, `active`, or `marked`.
-
-# 0.4.0 // 2016-06-27
-
-Updates galore! Well, some updates, anyway. While there are some larger underlying problems with the codebase, I've just been focussing on the notes of each project.
-
-* [New] Project notes will now show basic styling (italics, bold, underline; better paragraphs).
-* [New] Added some shiny CSS for the project details - notes and remaining tasks lists should be a bit sexier
-* [New] Projects now show due and deferral dates (when appropriate) in the project overlay
-
-# 0.3.3 // 2016-05-23
-
-Wow, it's been some time, hasn't it? Let's add updates to this.
-
-* [New] Omniboard works out when your document is out of date, or even when it's become detached from the head of your omnifocus database, and lets you know.
-* [Fix] `Group` now has a default `light_colour` method - no more errors if you don't group your projects!
-
-
-# 0.3.1 // 2016-02-13
-
-* [Fix] Remove console.log() debugging in js functions
-* [Fix] Previous change to hide/show code resulted in a non-functioning info overlay. Now fixed.
-
-# 0.3.0 // 2016-02-12
-
-* [New] You can now set a block property to `nil` to avoid running any block (including any defaults).
-
-# 0.2.1 // 2016-02-09
-
-* [Fix] Added `trollop` to list of runtime dependencies
-
-# 0.2.0 // 2016-02-08
-
-A number of updates around the board
-
-* [New] Project groups will hide themselves if every child project has been hidden.
-* [New] Added `Column#filter_button`, which allows you to add a button filtering out dimmed tasks.
-
-# 0.1.0 // 2016-02-04
-
-Hello, world!