be_taskable 0.5.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+
+gem 'rails', '~> 3.0'
+gem 'state_machine', '~> 1.1'
+
+group :development do
+	gem 'sqlite3'
+	gem 'rspec-rails'
+	gem 'rspec-steps'
+	gem 'guard'
+	gem 'guard-rspec'
+	gem 'bundler', '~> 1.2'
+	gem 'jeweler', '~> 1.8.4'
+	gem 'database_cleaner'
+end

data/Gemfile.lock

@@ -0,0 +1,178 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.14)
+      actionpack (= 3.2.14)
+      mail (~> 2.5.4)
+    actionpack (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activerecord (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.3.5)
+    arel (3.0.2)
+    builder (3.0.4)
+    coderay (1.0.9)
+    database_cleaner (1.1.1)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    ffi (1.9.0)
+    formatador (0.2.4)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    guard (1.8.2)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (3.0.2)
+      guard (>= 1.8)
+      rspec (~> 2.13)
+    hashie (2.0.5)
+    highline (1.6.19)
+    hike (1.2.3)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    jeweler (1.8.7)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    journey (1.0.4)
+    json (1.8.0)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    listen (1.3.0)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25)
+    multi_json (1.7.9)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    polyglot (0.3.3)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.14)
+      actionmailer (= 3.2.14)
+      actionpack (= 3.2.14)
+      activerecord (= 3.2.14)
+      activeresource (= 3.2.14)
+      activesupport (= 3.2.14)
+      bundler (~> 1.0)
+      railties (= 3.2.14)
+    railties (3.2.14)
+      actionpack (= 3.2.14)
+      activesupport (= 3.2.14)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.1)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    rspec-rails (2.13.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-steps (0.1.0)
+      rspec (>= 2.6, < 2.14.0)
+    slop (3.4.6)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.8)
+    state_machine (1.2.0)
+    thor (0.18.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.2)
+  database_cleaner
+  guard
+  guard-rspec
+  jeweler (~> 1.8.4)
+  rails (~> 3.0)
+  rspec-rails
+  rspec-steps
+  sqlite3
+  state_machine (~> 1.1)

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec' do
+	watch(%r{^spec/.+_spec\.rb})
+	watch(%r{^lib/(.+)\.rb})     { |m| "spec/#{m[1]}_spec.rb" }
+	watch('spec/spec_helper.rb') { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Sebastian
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+	gem.name = "be_taskable"
+	gem.homepage = "http://github.com/sporto/be_taskable"
+	gem.license = "MIT"
+	gem.summary = %Q{Mini framework for creating and maintaining user tasks}
+	gem.description = %Q{BeTaskable is a small framework for creating and maintaining tasks / chores / assignments. Meaning something that someone has to do.}
+	gem.email = "sebasporto@gmail.com"
+	gem.authors = ["Sebastian Porto"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+	version = File.exist?('VERSION') ? File.read('VERSION') : ""
+	
+	rdoc.rdoc_dir = 'rdoc'
+	rdoc.title = "be_taskable #{version}"
+	rdoc.rdoc_files.include('README*')
+	rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/be_taskable.gemspec

@@ -0,0 +1,100 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "be_taskable"
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sebastian Porto"]
+  s.date = "2013-09-02"
+  s.description = "BeTaskable is a small framework for creating and maintaining tasks / chores / assignments. Meaning something that someone has to do."
+  s.email = "sebasporto@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "Guardfile",
+    "LICENSE.txt",
+    "Rakefile",
+    "VERSION",
+    "be_taskable.gemspec",
+    "docs/task_refresh_activity_diagram.delineato",
+    "docs/taskable_complete_flow.delineato",
+    "lib/be_taskable.rb",
+    "lib/be_taskable/task.rb",
+    "lib/be_taskable/task_assignment.rb",
+    "lib/be_taskable/task_resolver.rb",
+    "lib/be_taskable/task_runner.rb",
+    "lib/be_taskable/taskable.rb",
+    "lib/be_taskable/tasker.rb",
+    "lib/generators/be_taskable/migration_generator.rb",
+    "lib/generators/be_taskable/resolver_generator.rb",
+    "lib/generators/be_taskable/templates/active_record/migration.rb",
+    "lib/generators/be_taskable/templates/resolver.rb.tpl",
+    "readme.md",
+    "spec/be_taskable/integration/end_to_end_spec.rb",
+    "spec/be_taskable/integration/irrelevance_spec.rb",
+    "spec/be_taskable/unit/be_taskable_spec.rb",
+    "spec/be_taskable/unit/task_assignment_spec.rb",
+    "spec/be_taskable/unit/task_runner_spec.rb",
+    "spec/be_taskable/unit/task_spec.rb",
+    "spec/be_taskable/unit/taskable_spec.rb",
+    "spec/be_taskable/unit/tasker_spec.rb",
+    "spec/database.yml",
+    "spec/models.rb",
+    "spec/schema.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/sporto/be_taskable"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "Mini framework for creating and maintaining user tasks"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<state_machine>, ["~> 1.1"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_development_dependency(%q<rspec-steps>, [">= 0"])
+      s.add_development_dependency(%q<guard>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, ["~> 3.0"])
+      s.add_dependency(%q<state_machine>, ["~> 1.1"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_dependency(%q<rspec-steps>, [">= 0"])
+      s.add_dependency(%q<guard>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.2"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<database_cleaner>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, ["~> 3.0"])
+    s.add_dependency(%q<state_machine>, ["~> 1.1"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<rspec-rails>, [">= 0"])
+    s.add_dependency(%q<rspec-steps>, [">= 0"])
+    s.add_dependency(%q<guard>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.2"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<database_cleaner>, [">= 0"])
+  end
+end
+

data/lib/be_taskable/task.rb

@@ -0,0 +1,173 @@
+module BeTaskable
+	class Task < ActiveRecord::Base
+		
+		has_many :assignments, class_name: '::BeTaskable::TaskAssignment', dependent: :destroy
+		belongs_to :taskable, polymorphic: true
+
+		scope :completed, where('completed_at IS NOT NULL')
+		scope :uncompleted, where(completed_at: nil)
+		scope :expired, where('expired_at IS NOT NULL')
+		scope :unexpired, where(expired_at: nil)
+		# scope :overdue, ->() { where('complete_by IS NOT NULL AND completed_at = NULL AND completed_at < ?', DateTime.now) }
+
+		validates :taskable_type, presence: true
+		validates :taskable_id, presence: true
+		validates :action, presence: true #, uniqueness: { scope: [:taskable_type, :taskable_id] }
+
+		def self.current
+			self.uncompleted.unexpired
+		end
+
+		state_machine :state, initial: :open do
+			event :complete do
+				transition :open => :completed
+			end
+			event :expire do
+				transition :open => :expired
+			end
+			event :make_irrelevant do
+				transition :open => :irrelevant
+			end
+			event :make_relevant do
+				transition :irrelevant => :open
+			end
+			after_transition :open => :completed, :do => :_on_completion
+			after_transition :open => :expired, :do => :_on_expiration
+		end
+
+		#-------------------------------------------------------------------------
+		# Actions
+		#-------------------------------------------------------------------------
+
+		# refresh
+		# Check that the current assignments are still relevant
+		# Create new assignments as needed or deletes them
+		# needs to run for irrelevant
+		def refresh
+			return if completed?
+			_runner.refresh
+		end
+
+		# tally
+		# Check all the completed assignments and decides wherever to complete the task
+		# @return nil if completed
+		def tally
+			return if completed?
+			complete if consensus?
+		end
+
+		# calls refresh and then tally
+		# needs to run for irrelevant
+		def audit
+			return if completed?
+			refresh
+			tally
+		end
+
+		# completes the assignment for the given assignee
+		# @param {Object} assignee
+		# @return false if no assignment found
+		def complete_by(assignee)
+			assignment = assignment_for(assignee)
+			return false unless assignment
+			assignment.complete
+		end
+
+		# consensus?
+		# @return Boolean
+		def consensus?
+			resolver.consensus?(self)
+		end
+
+		#-------------------------------------------------------------------------
+		# Accessors
+		#-------------------------------------------------------------------------
+
+		# @return {Array} List of current assignees for this task
+		def assignees
+			assignments.map(&:assignee)
+		end
+
+		# @return {String} Gets the label from the resolver for this task
+		def label!
+			resolver.label_for_task(self)
+		end
+
+		def assignment_for(assignee)
+			assignments.where(assignee_id: assignee.id).last
+		end
+
+		def enacted_assignments
+			assignments.enacted
+		end
+
+		# resolver
+		# @return A resolver instance
+		def resolver
+			if taskable
+				taskable.task_resolver_for_action(action)
+			else
+				# puts self.id
+				# puts self.taskable_id
+				# puts self.taskable_type
+				# puts self.taskable
+				raise "Cannot find taskable" 
+			end
+		end
+
+		#-------------------------------------------------------------------------
+		# Hooks
+		#-------------------------------------------------------------------------
+
+		def on_creation
+			resolver.on_creation(self)
+		end
+
+		# hook: called from an assignment when completed
+		def on_assignment_completed(assignment)
+			tally
+		end
+
+		#-------------------------------------------------------------------------
+		# Consensus helpers
+		#-------------------------------------------------------------------------
+
+		def all_assignments_done?
+			assignments.all?{ |a| a.completed? }
+		end
+
+		def any_assignment_done?
+			assignments.any?{ |a| a.completed? }
+		end
+
+		def majority_of_assignments_done?
+			done = assignments.find_all{ |a| a.completed? }
+			done.size > (assignments.size.to_f / 2)
+		end
+
+		#-------------------------------------------------------------------------
+		# Pseudo private
+		#-------------------------------------------------------------------------
+
+		def _runner
+			@runner ||= BeTaskable::TaskRunner.new(self)
+		end
+
+		# called when the task is marked as complete by the state machine
+		def _on_completion
+			self.update_attribute(:completed_at, DateTime.now)
+			assignments.update_all(completed_at: DateTime.now)
+			resolver.on_completion(self)
+		end
+
+		# expires the task and all the assignments
+		def _on_expiration
+			self.update_attribute(:expired_at, DateTime.now)
+			assignments.each do |assignment|
+				assignment.expire
+			end
+			resolver.on_expiration(self)
+		end
+
+	end
+end

data/lib/be_taskable/task_assignment.rb

@@ -0,0 +1,60 @@
+module BeTaskable
+	class TaskAssignment < ActiveRecord::Base
+		belongs_to :task, class_name: '::BeTaskable::Task'
+		belongs_to :assignee, polymorphic: true
+
+		scope :completed, where('completed_at IS NOT NULL')
+		scope :uncompleted, where(completed_at: nil)
+		scope :expired, where('expired_at IS NOT NULL')
+		scope :unexpired, where(expired_at: nil)
+		scope :unconfirmed, where(confirmed: [nil, false])
+		scope :visible, ->{ where('visible_at IS NULL OR visible_at < ?', DateTime.now.to_formatted_s(:db)) }
+		scope :overdue, ->{ where('complete_by < ? AND completed_at IS NULL', DateTime.now.to_formatted_s(:db)) }
+		scope :not_overdue, ->{ where('complete_by IS NULL OR complete_by > ?', DateTime.now.to_formatted_s(:db)) }
+		scope :enacted, where(enacted: true)
+
+		def self.current
+			self.uncompleted.unexpired.not_overdue.visible
+		end
+
+		# @return {Boolean}
+		def completed?
+			!!completed_at
+		end
+
+		# @return {Boolean}
+		def visible?
+			self.class.visible.exists?(self)
+		end
+
+		# completes the assignment by the assignee
+		# it triggers a hook in task (on_assignment_complete)
+		def complete
+			return false if completed?
+			self.update_attribute(:completed_at, DateTime.now)
+			self.update_attribute(:enacted, true)
+			task.on_assignment_completed(self)
+			true
+		end
+
+		# Gets the label from the resolver
+		def label!
+			resolver.label_for_assignment(self)
+		end
+
+		# Gets the url from the resolver
+		def url!
+			resolver.url_for_assignment(self)
+		end
+
+		# @return {Object} A resolver instance
+		def resolver
+			task.resolver
+		end
+
+		def taskable
+			task.taskable
+		end
+
+	end
+end

data/lib/be_taskable/task_resolver.rb

@@ -0,0 +1,47 @@
+module BeTaskable
+	class TaskResolver
+
+		def consensus?(task)
+			raise NotImplementedError
+		end
+
+		def is_task_relevant?(task)
+			true
+		end
+
+		def assignees_for_task(task)
+			[] #raise NotImplementedError
+		end
+
+		def due_date_for_assignment(assignment)
+			nil
+		end
+
+		def visible_date_for_assignment(assignment)
+			nil
+		end
+
+		def label_for_task(task)
+			""
+		end
+
+		def label_for_assignment(assignment)
+			""
+		end
+
+		def url_for_assignment(assignment)
+			""
+		end
+
+		# hooks
+		def on_creation(task)
+		end
+
+		def on_completion(task)
+		end
+
+		def on_expiration(task)
+		end
+
+	end
+end