xteam_schedule 0.0.4 → 0.1.0

data/README.md

@@ -4,6 +4,8 @@ xTeam Schedule is a gem that provides full control over schedules for use with [
 
 It is capable of reading and writing schedules, whilst providing access to all of its components through the [ActiveRecord](http://api.rubyonrails.org/classes/ActiveRecord/Base.html) interface, which every Ruby on Rails developer will be familiar with. This is absolutely, **the best solution** for managing agile teams.
 
+You can find a blog post explaining some of the thinking behind its implementation [here](https://www.unboxedconsulting.com/blog/gemnastics-with-activerecord).
+
 <img src="http://www.adnx.com/i/uploads/xTeam1.jpg" width="820" alt="xTeam Schedule" />
 
 ### Features:
@@ -303,13 +305,41 @@ wednesday.update_attribute(:break_begin, nil)
 **Defaults:**
 The default weekly working schedule is identical to the same as the one set up above (except wednesday lunch). i.e. 9am-5pm Mon-Fri, with lunch from 12pm-1pm.
 
+## Holidays
+
+Holidays can either belong to a resource, or the entire schedule. Holidays on the schedule are shared by all resources. This is useful for bank holidays. You can leave off the end date for one day holidays.
+
+```ruby
+schedule.holidays.create!(:begin_date => Date.new(2012, 12, 25), :name => 'Christmas Day')
+
+resource_group = schedule.resource_groups.create(:name => 'foo')
+resource = resource_group.resources.create!(:name => 'bar')
+resource.holidays.create!(
+  :begin_date => Date.new(2012, 07, 01),
+  :end_date => Date.new(2012, 07, 10),
+  :name => 'Visiting California'
+)
+```
+
+**Required attributes:**
+begin_date
+
+**Example queries:**
+
+```ruby
+holiday_names = schedule.resources.map(&:holidays).flatten.map(&:name)
+resources_without_holidays = schedule.resources.select { |r| r.holidays.empty? }
+finished_holidays = schedule.resources.map(&:holidays).flatten.select { |h|
+  (h.end_date || h.begin_date) < Date.today
+}
+```
+
 ## Under Development
 
 This gem is far from complete. The following is a list of features that are under development:
 
 * Resource images
 * Sort by
-* Holidays
 * Absences
 * Remote access
 * To assign

data/lib/xteam_schedule/facilitation/base.rb

@@ -1,15 +1,15 @@
 class XTeamSchedule::Base < ActiveRecord::Base
   self.abstract_class = true
   establish_connection(:adapter => 'sqlite3', :database => ':memory:')
-  
+
   def self.build_schema
     XTeamSchedule::Schema.define do
-      
+
       create_table :schedules, :force => true do |table|
         table.column :begin_date, :date, :default => 10.years.ago.to_date
         table.column :end_date, :date, :default => 10.years.from_now.to_date
       end
-      
+
       create_table :interfaces, :force => true do |table|
         table.column :schedule_id, :integer
         table.column :display_assignments_name, :boolean, :default => true
@@ -21,11 +21,11 @@ class XTeamSchedule::Base < ActiveRecord::Base
         table.column :display_absences, :boolean, :default => true
         table.column :time_granularity, :integer, :default => XTeamSchedule::Interface::TIME_GRANULARITIES[:month]
       end
-      
+
       create_table :weekly_working_schedules, :force => true do |table|
         table.column :schedule_id, :integer
       end
-      
+
       create_table :working_days, :force => true do |table|
         table.column :weekly_working_schedule_id, :integer
         table.column :name, :string
@@ -34,13 +34,13 @@ class XTeamSchedule::Base < ActiveRecord::Base
         table.column :break_begin, :string
         table.column :break_end, :string
       end
-      
+
       create_table :resource_groups, :force => true do |table|
         table.column :schedule_id, :integer
         table.column :expanded_in_library, :boolean, :default => true
         table.column :name, :string
       end
-      
+
       create_table :resources, :force => true do |table|
         table.column :resource_group_id, :integer
         table.column :displayed_in_planning, :boolean, :default => true
@@ -50,19 +50,19 @@ class XTeamSchedule::Base < ActiveRecord::Base
         table.column :name, :string
         table.column :phone, :string
       end
-      
+
       create_table :assignment_groups, :force => true do |table|
         table.column :schedule_id, :integer
         table.column :expanded_in_library, :boolean, :default => true
         table.column :name, :string
       end
-      
+
       create_table :assignments, :force => true do |table|
         table.column :assignment_group_id, :integer
         table.column :name, :string
         table.column :colour, :string
       end
-      
+
       create_table :working_times, :force => true do |table|
         table.column :resource_id, :integer
         table.column :assignment_id, :integer
@@ -70,6 +70,14 @@ class XTeamSchedule::Base < ActiveRecord::Base
         table.column :duration, :integer
         table.column :notes, :string
       end
+
+      create_table :holidays, :force => true do |table|
+        table.column :schedule_id, :integer
+        table.column :resource_id, :integer
+        table.column :begin_date, :date
+        table.column :end_date, :date
+        table.column :name, :string
+      end
     end
   end
 end

data/lib/xteam_schedule/facilitation/composer.rb

@@ -1,17 +1,17 @@
 class XTeamSchedule::Composer
-  
+
   attr_accessor :schedule, :hash
-  
+
   def self.compose(schedule)
     new(schedule).compose
   end
-  
+
   def initialize(schedule)
     schedule.save!
     self.schedule = schedule
     self.hash = {}
   end
-  
+
   def compose
     compose_resource_groups!
     compose_resources!
@@ -20,12 +20,13 @@ class XTeamSchedule::Composer
     compose_working_times!
     compose_interface!
     compose_weekly_working_schedule!
+    compose_holidays!
     compose_schedule!
     hash
   end
-  
+
 private
-  
+
   def compose_resource_groups!
     hash['resource groups'] ||= []
     resource_groups = schedule.resource_groups
@@ -36,15 +37,16 @@ private
       }
     end
   end
-  
+
   def compose_resources!
     hash['resources'] ||= []
     resources = schedule.resource_groups.map(&:resources).flatten
     resources.each do |r|
+      image = Base64.decode64(r.image) if r.image
       hash['resources'] << {
         'displayedInPlanning' => r.displayed_in_planning,
         'email' => r.email,
-        'image' => (StringIO.new(r.image) if r.image),
+        'image' => (StringIO.new(image) if image),
         'mobile' => r.mobile,
         'name' => r.name,
         'phone' => r.phone,
@@ -52,7 +54,7 @@ private
       }
     end
   end
-  
+
   def compose_assignment_groups!
     hash['task categories'] ||= []
     assignment_groups = schedule.assignment_groups
@@ -63,7 +65,7 @@ private
       }
     end
   end
-  
+
   def compose_assignments!
     hash['tasks'] ||= []
     assignments = schedule.assignment_groups.map(&:assignments).flatten
@@ -76,7 +78,7 @@ private
       }
     end
   end
-  
+
   def compose_working_times!
     hash['objectsForResources'] ||= {}
     resources = schedule.resource_groups.map(&:resources).flatten
@@ -95,7 +97,7 @@ private
       end
     end
   end
-  
+
   def compose_interface!
     interface = schedule.interface
     hash['display task names'] = interface.display_assignments_name
@@ -107,15 +109,15 @@ private
     hash['display absence cells'] = interface.display_absences
     hash['interface status'] = { 'latest time navigation mode' => interface.time_granularity }
   end
-  
+
   def compose_weekly_working_schedule!
     weekly_working_schedule = schedule.weekly_working_schedule
     working_days = weekly_working_schedule.working_days
-    
+
     hash['settings'] ||= {}
     hash['settings']['days off'] ||= []
     hash['settings']['working schedule'] ||= {}
-    
+
     working_days.each do |day|
       day_name = day.name.downcase
       hash['settings']['working schedule'][day_name] =
@@ -126,7 +128,7 @@ private
       else
         { 'worked' => 'no' }
       end
-      
+
       hash['settings']['working schedule']["pause_#{day_name}"] =
       if day.day_begin.present? and day.break_begin.present?
         { 'worked' => 'yes',
@@ -138,16 +140,58 @@ private
       end
     end
   end
-  
+
+  def compose_holidays!
+    compose_schedule_holidays!
+    compose_resource_holidays!
+  end
+
+  def compose_schedule_holidays!
+    holidays = schedule.holidays
+
+    hash['settings'] ||= {}
+    hash['settings']['days off'] ||= []
+
+    holidays.each do |h|
+      h.end_date ||= h.begin_date
+      hash['settings']['days off'] << {
+        'begin date' => compose_date(h.begin_date),
+        'end date' => compose_date(h.end_date),
+        'name' => h.name
+      }
+    end
+  end
+
+  def compose_resource_holidays!
+    resources = schedule.resource_groups.map(&:resources).flatten
+    resources.each do |r|
+      next unless r.holidays
+      index = hash['resources'].find_index { |h| h['name'] == r.name }
+      next unless index
+
+      hash['resources'][index]['settings'] ||= {}
+      hash['resources'][index]['settings']['days off'] ||= []
+      hash['resources'][index]['settings']['use custom days off'] = 1
+      r.holidays.each do |h|
+        h.end_date ||= h.begin_date
+        hash['resources'][index]['settings']['days off'] << {
+          'begin date' => compose_date(h.begin_date),
+          'end date' => compose_date(h.end_date),
+          'name' => h.name
+        }
+      end
+    end
+  end
+
   def compose_schedule!
     hash['begin date'] = compose_date(schedule.begin_date)
     hash['end date'] = compose_date(schedule.end_date)
   end
-  
+
   def compose_colour(colour_hash)
     { 'alpha' => 1 }.merge([:red, :green, :blue].inject({}) { |h, c| h[c.to_s] = colour_hash[c]; h })
   end
-  
+
   def compose_date(date)
     return unless date.present?
     components = []
@@ -156,11 +200,11 @@ private
     components << date.year
     components.join('/')
   end
-  
+
   def compose_time(time_string)
     return unless time_string.present?
     hours, minutes = time_string.split(':').map(&:to_i)
-    
+
     hours * 60 + minutes
   end
 end

data/lib/xteam_schedule/facilitation/parser.rb

@@ -1,16 +1,16 @@
 class XTeamSchedule::Parser
-  
+
   attr_accessor :hash, :schedule
-  
+
   def self.parse(hash)
     new(hash).parse
   end
-  
+
   def initialize(hash)
     self.hash = hash
     self.schedule = XTeamSchedule::Schedule.create!
   end
-  
+
   def parse
     parse_resource_groups!
     parse_resources!
@@ -19,27 +19,29 @@ class XTeamSchedule::Parser
     parse_working_times!
     parse_interface!
     parse_weekly_working_schedule!
+    parse_holidays!
     parse_schedule!
     schedule
   end
-  
+
 private
-  
+
   def parse_resource_groups!
+    return unless hash['resource groups'].present?
     hash['resource groups'].each do |rg|
       schedule.resource_groups.create!(
         :name => rg['name'],
         :expanded_in_library => rg['expanded in library']
       )
     end
-  rescue
   end
-  
+
   def parse_resources!
+    return unless hash['resources'].present?
     hash['resources'].each do |r|
       resource_group = schedule.resource_groups.find_by_name(r['group'])
       if resource_group
-        image = r['image'].class == StringIO ? r['image'].read : ''
+        image = r['image'].class == StringIO ? Base64.encode64(r['image'].read) : ''
         resource_group.resources.create!(
           :displayed_in_planning => r['displayedInPlanning'],
           :email => r['email'],
@@ -50,20 +52,20 @@ private
         )
       end
     end
-  rescue
   end
-  
+
   def parse_assignment_groups!
+    return unless hash['task categories'].present?
     hash['task categories'].each do |ag|
       schedule.assignment_groups.create!(
         :name => ag['name'],
         :expanded_in_library => ag['expanded in library']
       )
     end
-  rescue
   end
-  
+
   def parse_assignments!
+    return unless hash['tasks'].present?
     hash['tasks'].each do |a|
       assignment_group = schedule.assignment_groups.find_by_name(a['category'])
       if assignment_group
@@ -73,13 +75,12 @@ private
         )
       end
     end
-  rescue
   end
-  
+
   def parse_working_times!
+    return unless hash['objectsForResources'].present?
     resources = schedule.resource_groups.map(&:resources).flatten
     assignments = schedule.assignment_groups.map(&:assignments).flatten
-    hash['objectsForResources'] ||= {}
     hash['objectsForResources'].each do |r_name, wt_array|
       resource = resources.detect { |r| r.name == r_name }
       next unless resource
@@ -95,10 +96,10 @@ private
       end
     end
   end
-  
+
   def parse_interface!
-    interface_status = hash['interface status']
-    time_granularity = interface_status['latest time navigation mode'] if interface_status.present?
+    return unless hash['interface status'].present?
+    time_granularity = hash['interface status']['latest time navigation mode']
     schedule.interface.update_attributes!(
       :display_assignments_name => hash['display task names'],
       :display_resources_name => hash['display resource names'],
@@ -110,31 +111,31 @@ private
       :time_granularity => time_granularity
     )
   end
-  
+
   def parse_weekly_working_schedule!
     settings = hash['settings']
     return unless settings.present?
     working_schedule = settings['working schedule']
     return unless working_schedule.present?
-    
+
     weekly_working_schedule = schedule.weekly_working_schedule
     working_days = weekly_working_schedule.working_days
-    
+
     working_days.destroy_all
     XTeamSchedule::WorkingDay::WORKING_DAY_NAMES.each do |name|
       day = working_schedule[name.downcase]
       pause = working_schedule["pause_#{name.downcase}"]
-      
+
       if day.present?
         day_begin = parse_time(day['begin']) if day['worked'] == 'yes'
         day_end = parse_time(day['end']) if day_begin
       end
-      
+
       if pause.present?
         break_begin = parse_time(pause['begin']) if pause['worked'] == 'yes'
         break_end = parse_time(pause['end']) if break_begin
       end
-      
+
       working_days << XTeamSchedule::WorkingDay.create!(
         :name => name,
         :day_begin => day_begin, :day_end => day_end,
@@ -142,29 +143,74 @@ private
       )
     end
   end
-  
+
+  def parse_holidays!
+    parse_schedule_holidays!
+    parse_resource_holidays!
+  end
+
+  def parse_schedule_holidays!
+    settings = hash['settings']
+    return unless settings.present?
+    holidays = settings['days off']
+    return unless holidays.present?
+
+    holidays.each do |h|
+      end_date = h['end date']
+      end_date = nil if h['begin date'] == h['end date']
+      schedule.holidays.create!(
+        :begin_date => parse_date(h['begin date']),
+        :end_date => parse_date(end_date),
+        :name => h['name']
+      )
+    end
+  end
+
+  def parse_resource_holidays!
+    resources = schedule.resource_groups.map(&:resources).flatten
+    hash['resources'] ||= []
+    hash['resources'].each do |resource|
+      settings = resource['settings']
+      next unless settings.present?
+      holidays = settings['days off']
+      next unless holidays.present?
+      resource = resources.detect { |r| r.name == resource['name'] }
+      next unless resource.present?
+
+      holidays.each do |h|
+        end_date = h['end date']
+        end_date = nil if h['begin date'] == h['end date']
+        resource.holidays.create!(
+          :begin_date => parse_date(h['begin date']),
+          :end_date => parse_date(end_date),
+          :name => h['name']
+        )
+      end
+    end
+  end
+
   def parse_schedule!
     schedule.update_attributes!(
       :begin_date => parse_date(hash['begin date']),
       :end_date => parse_date(hash['end date'])
     )
   end
-  
+
   def parse_colour(colour_data)
     [:red, :green, :blue].inject({}) { |h, c| h[c] = colour_data[c.to_s]; h }
   end
-  
+
   def parse_date(date_string)
     return unless date_string.present?
     month, day, year = date_string.split('/').map(&:to_i)
     Date.new(year, month, day)
   end
-  
+
   def parse_time(seconds)
     return unless seconds.present?
     hours = seconds / 60
     minutes = seconds % 60
-    
+
     hours = "%02d" % hours
     minutes = "%02d" % minutes
     [hours, minutes].join(':')

data/lib/xteam_schedule/models/holiday.rb

@@ -0,0 +1,16 @@
+class XTeamSchedule::Holiday < XTeamSchedule::Base
+  belongs_to :schedule
+  belongs_to :resource
+
+  validates_presence_of :begin_date
+  validate :can_not_belong_to_both_schedule_and_resource
+
+private
+
+  def can_not_belong_to_both_schedule_and_resource
+    if [schedule, resource].all?
+      errors.add(:base, 'Can not belong to both a schedule and a resource')
+    end
+  end
+
+end

data/lib/xteam_schedule/models/resource.rb

@@ -1,22 +1,23 @@
 class XTeamSchedule::Resource < XTeamSchedule::Base
   belongs_to :resource_group
   has_many :working_times, :dependent => :destroy
+  has_many :holidays, :dependent => :destroy
   delegate :schedule, :to => :resource_group
-  
+
   validates_presence_of :name
   validate :uniqueness_of_name_scoped_to_schedule
-  
+
 private
-  
+
   def uniqueness_of_name_scoped_to_schedule
     return unless new_record?
     resource_group = self.resource_group or return
     schedule = resource_group.schedule or return
     resources = schedule.resources or return
-  
+
     if resources.find_by_name(name).present?
       errors.add(:name, 'must be unique within the schedule')
     end
   end
-  
+
 end

data/lib/xteam_schedule/models/schedule.rb

@@ -4,10 +4,11 @@ class XTeamSchedule::Schedule < XTeamSchedule::Base
   has_many :assignment_groups, :dependent => :destroy
   has_many :assignments, :through => :assignment_groups
   has_many :working_days, :through => :weekly_working_schedule
-  
+  has_many :holidays, :dependent => :destroy
+
   has_one :interface
   has_one :weekly_working_schedule
-  
+
   ActiveSupport::Deprecation.silence do
     after_initialize :set_default_interface
     after_initialize :set_default_weekly_working_schedule
@@ -16,26 +17,20 @@ class XTeamSchedule::Schedule < XTeamSchedule::Base
       set_default_weekly_working_schedule
     end
   end
-  
+
   def working_times
-    ids = XTeamSchedule::WorkingTime.find_by_sql([
-    "select distinct * from working_times as wt
-     join resources r on wt.resource_id = r.id
-     join resource_groups rg on r.resource_group_id = rg.id
-     where rg.schedule_id = ?", id
-    ]).map(&:id)
-    
+    ids = resources.map(&:working_times).flatten.map(&:id)
     XTeamSchedule::WorkingTime.scoped(:conditions => { :id => ids })
   end
-  
+
 private
-  
+
   def set_default_interface
     self.interface ||= XTeamSchedule::Interface.new
   end
-  
+
   def set_default_weekly_working_schedule
     self.weekly_working_schedule ||= XTeamSchedule::WeeklyWorkingSchedule.new
   end
-  
+
 end

data/lib/xteam_schedule.rb

@@ -19,5 +19,6 @@ require 'xteam_schedule/models/schedule'
 require 'xteam_schedule/models/weekly_working_schedule'
 require 'xteam_schedule/models/working_day'
 require 'xteam_schedule/models/working_time'
+require 'xteam_schedule/models/holiday'
 
 XTeamSchedule::Base.build_schema

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: xteam_schedule
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 4
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - Christopher Patuzzo
@@ -110,6 +110,7 @@ files:
 - lib/xteam_schedule/facilitation/schema.rb
 - lib/xteam_schedule/models/assignment.rb
 - lib/xteam_schedule/models/assignment_group.rb
+- lib/xteam_schedule/models/holiday.rb
 - lib/xteam_schedule/models/interface.rb
 - lib/xteam_schedule/models/resource.rb
 - lib/xteam_schedule/models/resource_group.rb