omniboard 1.1.1

data/lib/omniboard/columns/active.rb

@@ -0,0 +1,17 @@
+Omniboard::Column.new "Active" do
+	order 1
+	conditions{ |p| p.active? }
+
+	width 2
+	columns 4
+
+	display :full
+
+	icon do |p|
+		if p.incomplete_tasks.size == 0
+			"svg:hanging"
+		elsif p.actionable_tasks.all?{ |t| t.context && t.context.name == "Waiting for..." }
+			"svg:waiting-on"
+		end
+	end
+end

data/lib/omniboard/columns/backburner.rb

@@ -0,0 +1,5 @@
+Omniboard::Column.new "Backburner" do
+	order 0
+	conditions{ |p| p.on_hold? || p.deferred? }
+	display :compact
+end

data/lib/omniboard/columns/completed.rb

@@ -0,0 +1,5 @@
+Omniboard::Column.new "Completed" do
+	order 2
+	conditions{ |p| p.completed? }
+	display :compact
+end

data/lib/omniboard/columns/config.rb

@@ -0,0 +1,11 @@
+# Place global config variables here. See the README for config variables
+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 }
+
+	# Name based on ancestry
+	group_name{ |c| c.nil? ? "Top level" : c.ancestry.map(&:name).reverse.join("→")}
+end

data/lib/omniboard/core_ext.rb

@@ -0,0 +1,22 @@
+class String
+  HTML_ESCAPE_CHARS = {
+    "&" => "&",
+    ">" => ">",
+    "<" => "&lt;",
+    '"' => "&quot;",
+    "'" => "&#39;"
+  }
+
+  def html_escape
+    HTML_ESCAPE_CHARS.reduce(self){ |str, (replace_this, with_this)| str.gsub(replace_this, with_this) }
+  end
+
+  # TODO Fix up all of these
+	def sanitize
+		self.gsub('"','\"').gsub("<","&lt;").gsub(">", "&gt;")
+	end
+
+	def sanitize_quotes
+		self.gsub('"','&#34;')
+	end
+end

data/lib/omniboard/group.rb

@@ -0,0 +1,104 @@
+# This class represents a "group" of Projects.
+class Omniboard::Group
+	include Comparable
+
+	# The identifier for this group. Can be a string, object, whatever you like.
+	attr_accessor :identifier
+
+	# Deprecated methods
+	def name
+		$stderr.puts "Group#name is deprecated. Use Group#identifier instead."
+		@identifier
+	end
+
+	def name= n
+		$stderr.puts "Group#name= is deprecated. Use Group#identifier= instead."
+		@identifier = n
+	end
+
+	# The colour representation of a group
+	attr_accessor :colour
+
+	# Array of all groups in the board
+	@groups = []
+	
+	class << self
+		# Global values for group colour brightness and saturation
+		attr_accessor :brightness, :saturation
+
+		# All groups in the board
+		attr_accessor :groups
+
+		# Find a group by identifier
+		def [] identifier
+			@groups.find{ |g| g.identifier == identifier } || new(identifier)
+		end
+
+		# Add a new group to the groups array. Also resets all colour assignments for the group.
+		# Note: usually called from initializer.
+		def add(g)
+			@groups.each(&:reset_colour)
+			@groups << g
+		end
+
+		# If we don't have any groups on our board, this is our default
+		# colour for ungrouped projects
+		def default_colour
+			Omniboard::Colour.new(0).standard
+		end
+		alias_method :colour, :default_colour
+
+		# If we don't have any groups on our board, this is our default
+		# light colour for ungrouped projects
+		def light_colour
+			Omniboard::Colour.new(0).light
+		end
+	end
+
+	def initialize(identifier)
+		raise(ArgumentError, "nil identifier not allowed") if identifier.nil?
+	  @identifier = identifier
+	  Omniboard::Group.add(self)
+	end
+
+	def colour
+		colour_obj.standard
+	end
+
+	def light_colour
+		colour_obj.light
+	end
+
+	def reset_colour
+		@colour_obj = nil
+	end
+
+	def assigned_colour
+		Omniboard::Column::colour_for_group(self.identifier)
+	end
+
+	def has_assigned_colour?
+		assigned_colour != nil
+	end
+
+	def to_s
+		@identifier
+	end
+
+	def <=> o
+		self.identifier <=> o.identifier
+	end
+
+	private
+	def colour_obj
+		@colour_obj ||= begin
+			my_hue = if has_assigned_colour?
+				assigned_colour
+			else
+				unassigned_groups = Omniboard::Group.groups.select{ |g| !g.has_assigned_colour? }
+				360.0 / unassigned_groups.size * unassigned_groups.index(self)
+			end
+			Omniboard::Colour.new(my_hue)
+		end
+	end	
+end

data/lib/omniboard/omniboard.rb

@@ -0,0 +1,149 @@
+module Omniboard
+	@configuration = {}
+
+	class << self
+		# Retrieve a configuration variable
+		def configuration(key)
+			@configuration[key]
+		end
+
+		# Set configuration variables from a dictionary
+		def configuration=(hsh)
+			@configuration = @configuration.merge(hsh)
+		end
+
+		# Set individual configuration variable
+		def configure(key,val)
+			@configuration[key] = val
+		end
+
+		#---------------------------------------
+		# Config location methods
+
+		# Set location where we'll store the configuration files
+		def config_location= loc
+			self.configure(:config_location, loc)
+		end
+
+		# Retrieve configuration_location
+		def config_location
+			@configuration[:config_location] || default_config_location
+		end
+
+		# Database usually exists here
+		def default_config_location
+			@default_config_location ||= File.join(ENV["HOME"], ".omniboard")
+		end
+
+		# Does the config folder exist?
+		def config_exists?
+			File.exists?(config_location)
+		end
+
+		# Populate with base classes
+		def populate
+
+			# 1. Make the columns folder
+			FileUtils::mkdir_p columns_location
+
+			# 2. Drop base columns + config into columns folder
+			Dir[File.join(__dir__, "columns/*.rb")].each{ |f| FileUtils::cp f, columns_location }
+
+			# 3. Add blank "custom.css" file
+			custom_css = File.join(config_location, "custom.css")
+			File.open(custom_css,"w"){ |io| io.puts "/* Custom CSS goes here */" }
+		end
+
+		#---------------------------------------
+		# Column-centric methods
+
+		# This is where we store columns
+		def columns_location
+			File.join(config_location, "columns")
+		end
+
+		# Fetch all columns!
+		def columns
+			@columns ||= begin
+				Dir[File.join(columns_location, "*")].each{ |f| require(f) } if File.exists?(columns_location)
+				Omniboard::Column.columns
+			end
+		end
+
+		#---------------------------------------
+		# Project-centric methods
+
+		def projects
+			@document.projects
+		end
+
+		#---------------------------------------
+		# Document-centric methods
+
+		# This is where our serialised document is located
+		def document_location
+			File.join(config_location, "db.yaml")
+		end
+
+		# Do we already have a serialised document?
+		def document_exists?
+			File.exists?(document_location)
+		end
+
+		# Load document from file
+		def load_document
+			@document = YAML::load_file(document_location)
+		end
+
+		# Save document to file
+		def save_document
+			FileUtils::mkdir_p config_location unless File.exists?(config_location)
+			File.open(document_location, "w"){ |io| io.puts YAML.dump(@document) }
+		end
+
+		# Update from an existing rubyfocus document
+		def update_document
+			@document.update
+		end
+
+		# Create a new document. For now, local documents are the only sort supported
+		def create_document
+			@document = Rubyfocus::Document.new(Rubyfocus::LocalFetcher.new)
+		end
+
+		# Arbitrarily assign a document object. Normally used only in debugging
+		attr_writer :document
+
+		#---------------------------------------
+		# Methods for reaching head
+		def document_at_head?
+			raise(RuntimeError, "Called Omniboard.document_at_head? before document loaded") if @document.nil?
+			return (
+				@document.fetcher.nil?  || # Always at head if we have no fetcher
+				@document.fetcher.head == @document.patch_id
+			)
+		end
+
+		def document_can_reach_head?
+			raise(RuntimeError, "Called Omniboard.document_can_reach_head? before document loaded") if @document.nil?
+			return @document.fetcher.can_reach_head_from?(@document.patch_id)
+		end
+
+		def current_id; @document.patch_id; end
+		def head_id; @document.fetcher.head; end
+
+		#---------------------------------------
+		# Config-related methods
+
+		# Fetches any custom CSS stored in `custom.css` inside the config folder
+		def custom_css
+			custom_css_path = File.join(config_location, "custom.css")
+			if File.exists?(custom_css_path)
+				File.read(custom_css_path)
+			else
+				nil
+			end
+		end
+	
+	end
+end

data/lib/omniboard/project_wrapper.rb

@@ -0,0 +1,119 @@
+class Omniboard::ProjectWrapper
+	attr_accessor :project
+	attr_accessor :column
+	attr_accessor :group
+
+	# Is this project marked to show up specially?
+	attr_accessor :marked
+	alias_method :marked?, :marked
+
+	# Is this project dimmed (i.e. shown "faded out")
+	attr_accessor :dimmed
+	alias_method :dimmed?, :dimmed
+
+	# Should this project display an icon in the kanban? If so, what's the filename of the icon?
+	attr_accessor :icon
+
+	# If this project displayed an icon, we can supply an alternate text
+	attr_accessor :icon_alt
+
+	# Create a new project wrapper, wrapping project
+	def initialize(project, column: nil)
+	  @project = project
+	  @column = column
+	  @marked = false
+	end
+
+	#---------------------------------------
+	# Colour methods
+	def colour
+		(@group || Omniboard::Group).colour
+	end
+
+	def light_colour
+		(@group || Omniboard::Group).light_colour
+	end
+
+	#---------------------------------------
+	# Number of tasks
+	def num_tasks
+		@num_tasks ||= project.incomplete_tasks.count
+	end
+
+	#---------------------------------------
+	# Runs on method missing. Allows project to step in and take
+	# the method if it can.
+	def method_missing(sym, *args, &blck)
+		if @project.respond_to?(sym)
+			@project.send(sym, *args, &blck)
+		else
+			raise NoMethodError, "undefined method #{sym} for #{self.inspect}"
+		end
+	end
+
+	#---------------------------------------
+	# Turn this project's tasks into a list
+	def task_list
+		tasks_to_list(@project.tasks)
+	end
+
+	# Format this project's note field to create nice html
+	def formatted_note
+		@formatted_note ||= Omniboard::StyledText.parse(self.note || "").to_html
+	end
+
+	def deferred_date
+		if self.start
+			self.start.strftime("%d %B %Y")
+		else
+			""
+		end
+	end
+
+	def due_date
+		if self.due
+			self.due.strftime("%d %B %Y")
+		else
+			""
+		end
+	end
+
+	# A list of CSS classes to apply to this project
+	def css_classes
+		classes = ["project", column.display]
+		classes << "marked" if marked?
+		classes << "dimmed" if dimmed?
+		classes << "hidden" if dimmed? && column && column.property(:hide_dimmed)
+		classes
+	end
+
+	# Are all the available tasks in this project deferred?
+	def all_tasks_deferred?
+		next_tasks.size > 0 && actionable_tasks.size == 0
+	end
+
+	# How many days until one of our tasks becomes available?
+	def days_until_action
+		earliest_start = next_tasks.map(&:start).sort.first
+		if earliest_start.nil?
+			0
+		else
+			earliest_start = earliest_start.to_date
+			if earliest_start < Date.today
+				0
+			else
+				(earliest_start - Date.today).to_i
+			end
+		end
+	end
+
+	def to_s
+		self.project.to_s
+	end
+
+	private
+	def tasks_to_list(arr)
+		arr = arr.sort_by(&:rank)
+		"<ul>" + arr.map { |task| %|<li class="#{task.completed? ? "complete" : "incomplete"}">#{task.name}| + (task.has_subtasks? ? tasks_to_list(task.tasks) : "") + "</li>" }.join("") + "</ul>"
+	end
+end

data/lib/omniboard/property.rb

@@ -0,0 +1,53 @@
+module Omniboard::Property
+	module PropertyClassMethods
+		def property p, allowed_values: nil, munge: nil
+			define_method(p) do |*args|
+				ivar = "@#{p}"
+				if args.empty?
+					instance_variable_get(ivar)
+				elsif args.size == 1
+					# Set values!
+					new_value = args.first
+					if allowed_values && !new_value.nil? && !allowed_values.include?(new_value)
+						raise(ArgumentError, "attempted to set property #{p} to forbidden value #{new_value.inspect}")
+					else
+						if new_value # Only run munge for non-nil values
+							case munge
+							when Symbol
+								new_value = new_value.send(munge)
+							when Proc
+								new_value = munge[new_value]
+							when nil
+							else
+								raise ArgumentError, "Property munge must be a symbol or a block - you supplied a #{munge.class}."
+							end
+						end
+						instance_variable_set(ivar, new_value)
+					end
+				else
+					raise ArgumentError, "wrong number of arguments (#{args.size} for 0,1)"
+				end
+			end
+		end
+
+		# Block properties can also take non-block arguments
+		def block_property p
+			define_method(p) do |*args, &blck|
+				ivar = "@#{p}"
+				if blck
+					instance_variable_set(ivar, blck)
+				elsif args.size == 1
+					instance_variable_set(ivar, args.first)
+				elsif args.empty?
+					instance_variable_get(ivar)
+				else
+					raise ArgumentError, "wrong number of arguments (#{args.size} for 0,1)"
+				end
+			end
+		end
+	end
+	
+	def self.included mod
+		mod.extend PropertyClassMethods
+	end
+end