schedule_attributes 0.3.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+.rvmrc

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'rake'
+
+# Specify your gem's dependencies in schedule_atts.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    schedule_attributes (0.3.0)
+      activesupport
+      ice_cube (>= 0.10.0)
+      tzinfo
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    i18n (0.6.1)
+    ice_cube (0.10.0)
+    method_source (0.8.1)
+    multi_json (1.7.3)
+    pry (0.9.12.1)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.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)
+    slop (3.4.4)
+    sqlite3 (1.3.7)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  pry
+  rake
+  rspec
+  schedule_attributes!
+  sqlite3

data/README.markdown

@@ -0,0 +1,69 @@
+# Schedule Attributes
+
+Schedule Attributes allows models (ORM agnostic) to accept recurring schedule form parameters and translate them into an [IceCube](https://github.com/seejohnrun/ice_cube/) `Schedule` object. Schedule Attributes adds `#schedule_attributes` and `#schedule_attributes=` methods that let your model automatically populate Rails forms and receive HTML form parameters. Additionally, it provides access to the `IceCube::Schedule` object itself.
+
+**Note**: This is a fork of [theunraveler/Schedule-Attributes](https://github.com/theunraveler/Schedule-Attributes), adding support for some extra rules.
+
+## Usage
+
+To use, include the `ScheduleAttributes` module in your model class.
+
+    class SomeModel
+      include ScheduleAttributes
+    end
+
+Your model must respond to `:schedule_yaml` and `:schedule_yaml=`, because ScheduleAttributes will serialize and deserialize the schedule in YAML using this column.  If you are using ActiveRecord, make a string column called `schedule_yaml`. If you're using Mongoid, make a string field like so: `field :schedule_yaml`.
+
+You model will gain the following methods:
+
+## `schedule_attributes=`
+
+Accepts form a parameter hash that represent a schedule, and creates an `IceCube::Schedule` object, and serializes it into your `schedule_yaml` field.
+
+E.x.
+
+    @event.schedule_attributes = params[:event][:schedule_attributes]
+
+### Parameters Accepted
+
+Because they are coming from a form, all parameters are expected to be in string format.
+
+##### `:repeat`
+
+Can be `0` or `1`. The parameter should respond to `:to_i`. `0` indicates that the event does not repeat. Anything else indicates that the event repeats.
+
+#### Parameters for non-repeating events
+
+The following parameters will only be used if the `repeat` parameter is `0`.
+
+##### `:date`
+
+The date that this (non-repeating) event is scheduled for. Should be parseable by `Time.parse`. This parameter is only used if `:repeat` is `0`.
+
+#### Parameters for repeating events
+
+The following parameters will only be used if the `repeat` parameter is `1`.
+
+##### `:start_date`
+
+The date at which the event starts repeating. Must be parseable by `Time.parse`.
+
+#### `:interval_unit`
+
+The interval unit by which the event repeats. Can be `"day"` or `"week"`. For example, if the even repeats every day, this would be `"day"`. If it repeats weekly, this would be `"week"`.
+
+#### `:interval`
+
+The interval by which the event repeats. Should be an integer (in string format). For example, if the event repeats every other day, this parameter should be `2`, and `:interval_unit` should be `"day"`. If it repeats every other week, it should be `2` and interval unit should be `"week"`.
+
+#### `:sunday`, `:monday`, `:tuesday`, `:wednesday`, `:thursday`, `:friday`, `:saturday`
+
+Indicates with a `0` or `1` whether the event repeats on this day. For example, if the event repeats every other week on Tues and Thursday, then the parameters would include these: `:interval => "2", :interval_unit => "week", :tuesday => "1", :thursday => "1"`. These parameters are only used if `:repeat` is `1` and `:interval_unit` is `"week"`.
+
+## `schedule_attributes`
+
+Provides an OStruct with methods that correspond to the attributes accepted by `#schedule_attributes=`. ActiveRecord can use this object to populate a form using [`FormHelper#fields_for`](http://apidock.com/rails/ActionView/Helpers/FormHelper/fields_for).
+
+##`schedule`
+
+Returns a the `IceCube::Schedule` object that is serialized to the model's `schedule_yaml` field. If there is none, it returns a schedule with `start_date` of the current date, recurring daily, ending never.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+

data/lib/schedule_attributes.rb

@@ -0,0 +1,18 @@
+require 'schedule_attributes/model'
+require 'schedule_attributes/railtie' if defined? Rails
+require 'schedule_attributes/form_builder' if defined? Formtastic
+
+if defined? Arel
+  module Arel::Visitors
+    class ToSql
+
+      # Allow schedule occurrences to be used directly as Time objects in
+      # ActiveRecord queries
+      #
+      def visit_IceCube_Occurrence(value)
+        quoted(value.to_time)
+      end
+
+    end
+  end
+end

data/lib/schedule_attributes/active_record.rb

@@ -0,0 +1,50 @@
+require 'schedule_attributes/core'
+require 'schedule_attributes/serializer'
+
+module ScheduleAttributes::ActiveRecord
+  extend ActiveSupport::Concern
+  include ScheduleAttributes::Core
+
+  module ClassMethods
+    attr_accessor :schedule_field
+    attr_accessor :default_schedule
+
+    def default_schedule
+      @default_schedule || ScheduleAttributes.default_schedule
+    end
+  end
+
+  module Sugar
+    def has_schedule_attributes(options={:column_name => :schedule})
+      options[:column_name] ||= ScheduleAttributes::DEFAULT_ATTRIBUTE_KEY
+      @schedule_field = options[:column_name]
+      @default_schedule = options[:default_schedule] if options.has_key?(:default_schedule)
+      serialize @schedule_field, ScheduleAttributes::Serializer
+      include ScheduleAttributes::ActiveRecord
+    end
+  end
+
+  private
+
+  def initialize(*args)
+    super
+    self[self.class.schedule_field] ||= default_schedule
+  end
+
+  def read_schedule_field
+    self[self.class.schedule_field] or default_schedule
+  end
+
+  def write_schedule_field(value)
+    self[self.class.schedule_field] = value
+  end
+
+  def default_schedule
+    self.class.default_schedule
+  end
+end
+
+# Injects the has_schedule_attributes method when loading without Rails
+if defined? ActiveRecord::Base
+  ActiveRecord::Base.send :extend, ScheduleAttributes::ActiveRecord::Sugar
+end

data/lib/schedule_attributes/configuration.rb

@@ -0,0 +1,22 @@
+module ScheduleAttributes
+
+  class Configuration
+
+    attr_accessor :time_format
+
+    def initialize
+      @time_format = '%H:%M'
+    end
+  end
+
+  class << self
+    def configure
+      @configuration ||= Configuration.new
+      if block_given?
+        yield @configuration
+      end
+      return @configuration
+    end
+    alias_method :configuration, :configure
+  end
+end

data/lib/schedule_attributes/core.rb

@@ -0,0 +1,144 @@
+require 'active_support/time'
+require 'active_support/concern'
+require 'active_support/time_with_zone'
+require 'ice_cube'
+require 'ostruct'
+require 'schedule_attributes/configuration'
+require 'schedule_attributes/extensions/ice_cube'
+require 'schedule_attributes/input'
+require 'schedule_attributes/rule_parser'
+
+module ScheduleAttributes
+  DEFAULT_ATTRIBUTE_KEY = :schedule
+  DAY_NAMES = Date::DAYNAMES.map(&:downcase).map(&:to_sym)
+
+  class << self
+    def default_schedule
+      IceCube::Schedule.new(TimeHelpers.today).tap do |s|
+        s.add_recurrence_rule(IceCube::Rule.daily)
+      end
+    end
+
+    def parse_rule(options)
+      RuleParser[options[:interval_unit]].parse(options)
+    end
+  end
+
+  module Core
+    extend ActiveSupport::Concern
+
+    def schedule_attributes=(options)
+      input = ScheduleAttributes::Input.new(options)
+      new_schedule = IceCube::Schedule.new(input.start_time || TimeHelpers.today)
+
+      if input.repeat?
+        parser = ScheduleAttributes::RuleParser[input.interval_unit || 'day'].new(input)
+        new_schedule.add_recurrence_rule(parser.rule)
+        parser.exceptions.each do |exrule|
+          new_schedule.add_exception_rule(exrule)
+        end
+      else
+        input.dates.each do |d|
+          new_schedule.add_recurrence_time(d)
+        end
+      end
+
+      new_schedule.duration = input.duration if input.duration
+
+      write_schedule_field(new_schedule)
+    end
+
+    # TODO: use a proper form input model, not OpenStruct
+    #
+    def schedule_attributes
+      atts = {}
+      time_format = ScheduleAttributes.configuration.time_format
+      schedule = read_schedule_field || ScheduleAttributes.default_schedule
+
+      if schedule.start_time.seconds_since_midnight == 0 && schedule.end_time.nil?
+        atts[:all_day] = true
+      else
+        atts[:start_time] = schedule.start_time.strftime(time_format)
+        atts[:end_time]   = (schedule.end_time).strftime(time_format) if schedule.end_time
+      end
+
+      if rule = schedule.rrules.first
+        atts[:repeat]     = 1
+        atts[:start_date] = schedule.start_time.to_date
+        atts[:date]       = Date.current # default for populating the other part of the form
+
+        rule_hash = rule.to_hash
+        atts[:interval] = rule_hash[:interval]
+
+        case rule
+        when IceCube::DailyRule
+          atts[:interval_unit] = 'day'
+        when IceCube::WeeklyRule
+          atts[:interval_unit] = 'week'
+
+          if rule_hash[:validations][:day]
+            rule_hash[:validations][:day].each do |day_idx|
+              atts[ ScheduleAttributes::DAY_NAMES[day_idx] ] = 1
+            end
+          end
+        when IceCube::MonthlyRule
+          atts[:interval_unit] = 'month'
+
+          day_of_week = rule_hash[:validations][:day_of_week]
+          day_of_month = rule_hash[:validations][:day_of_month]
+
+          if day_of_week
+            day_of_week = day_of_week.first.flatten
+            atts[:ordinal_week] = day_of_week.first
+            atts[:ordinal_unit] = 'week'
+          elsif day_of_month
+            atts[:ordinal_day]  = day_of_month.first
+            atts[:ordinal_unit] = 'day'
+          end
+        when IceCube::YearlyRule
+          atts[:interval_unit] = 'year'
+        end
+
+        if rule.until_time
+          atts[:end_date] = rule.until_time.to_date
+          atts[:ends] = 'eventually'
+        else
+          atts[:ends] = 'never'
+        end
+
+        if months = rule.validations_for(:month_of_year).map(&:month)
+          atts[:yearly_start_month] = months.first
+          atts[:yearly_end_month] = months.last
+
+          # get leading & trailing days from exception rules
+          schedule.exrules.each do |x|
+            x.validations_for(:month_of_year).map(&:month).each do |m|
+              days = x.validations_for(:day_of_month).map(&:day)
+
+              if m == atts[:yearly_start_month]
+                atts[:yearly_start_month_day] = days.last + 1 if days.first == 1
+              end
+
+              if m == atts[:yearly_end_month]
+                if days.last == 31
+                  atts[:yearly_end_month_day] = days.first - 1
+                  atts[:yearly_start_month_day] ||= 1
+                end
+              end
+            end
+          end
+
+        end
+      else
+        atts[:repeat]     = 0
+        atts[:interval]   = 1
+        atts[:date]       = schedule.rtimes.first.to_date
+        atts[:dates]      = schedule.rtimes.map(&:to_date)
+        atts[:start_date] = DateHelpers.today # default for populating the other part of the form
+      end
+
+      OpenStruct.new(atts.delete_if { |k,v| v.blank? })
+    end
+
+  end
+end

data/lib/schedule_attributes/extensions/ice_cube.rb

@@ -0,0 +1,11 @@
+class IceCube::Rule
+  def ==(other)
+    to_hash == other.to_hash
+  end
+end
+
+class IceCube::Schedule
+  def ==(other)
+    to_hash == other.to_hash
+  end
+end

data/lib/schedule_attributes/form_builder.rb

@@ -0,0 +1,42 @@
+class ScheduleAttributes::FormBuilder < Formtastic::FormBuilder
+
+  def weekdays
+    Hash[ I18n.t('date.day_names').zip(ScheduleAttributes::DAY_NAMES) ]
+  end
+
+  def ordinal_month_days
+    (1..31).map { |d| [d.ordinalize, d] }
+  end
+
+  def ordinal_month_weeks
+    Hash["first", 1, "second", 2, "third", 3, "fourth", 4, "last", -1]
+  end
+
+  def one_time_fields(options={}, &block)
+    hidden = object.repeat.to_i == 1
+    @template.content_tag :div, hiding_field_options("schedule_one_time_fields", hidden, options), &block
+  end
+
+  def repeat_fields(options={}, &block)
+    hidden = object.repeat.to_i != 1
+    @template.content_tag :div, hiding_field_options("schedule_repeat_fields", hidden, options), &block
+  end
+
+  def ordinal_fields(options={}, &block)
+    hidden = object.interval_unit == 'month' && object.by_day_of == 'week'
+    @template.content_tag :div, hiding_field_options("schedule_ordinal_fields", hidden, options), &block
+  end
+
+  def weekday_fields(options={}, &block)
+    hidden = false
+    @template.content_tag :div, hiding_field_options("schedule_weekday_fields", hidden, options), &block
+  end
+
+  def hiding_field_options(class_name, hidden=false, options={})
+    hidden_style = "display: none" if hidden
+    options.tap do |o|
+      o.merge!(style: [o[:style], hidden_style].compact.join('; '))
+      o.merge!(class: [o[:class], class_name].compact.join(' '))
+    end
+  end
+end