schedule_atts 0.0.2

data/.gitignore

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    schedule_atts (0.0.1)
+      activesupport
+      ice_cube (>= 0.6.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.4.2)
+    activesupport (3.0.3)
+    archive-tar-minitar (0.5.2)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    columnize (0.3.2)
+    diff-lcs (1.1.2)
+    facets (2.9.0)
+    ice_cube (0.6.4)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  autotest
+  facets
+  ice_cube (>= 0.6.4)
+  rspec (>= 2.3)
+  ruby-debug19
+  schedule_atts!

data/README.markdown

@@ -0,0 +1,67 @@
+# 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.
+
+## 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,3 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+

data/lib/schedule_atts.rb

@@ -0,0 +1,108 @@
+require 'ice_cube'
+require 'active_support'
+require 'active_support/time_with_zone'
+require 'ostruct'
+
+module ScheduleAtts
+  # Your code goes here...
+  DAY_NAMES = Date::DAYNAMES.map(&:downcase).map(&:to_sym)
+  def schedule
+    @schedule ||= begin
+      if schedule_yaml.blank?
+        IceCube::Schedule.new(Date.today.to_time).tap{|sched| sched.add_recurrence_rule(IceCube::Rule.daily) }
+      else
+        IceCube::Schedule.from_yaml(schedule_yaml)
+      end
+    end
+  end
+
+  def schedule_attributes=(options)
+    options = options.dup
+    options[:interval] = options[:interval].to_i
+    options[:start_date] &&= ScheduleAttributes.parse_in_timezone(options[:start_date])
+    options[:date]       &&= ScheduleAttributes.parse_in_timezone(options[:date])
+    options[:until_date] &&= ScheduleAttributes.parse_in_timezone(options[:until_date])
+
+    if options[:repeat].to_i == 0
+      @schedule = IceCube::Schedule.new(options[:date])
+      @schedule.add_recurrence_date(options[:date])
+    else
+      @schedule = IceCube::Schedule.new(options[:start_date])
+
+      rule = case options[:interval_unit]
+        when 'day'
+          IceCube::Rule.daily options[:interval]
+        when 'week'
+          IceCube::Rule.weekly(options[:interval]).day( *IceCube::DAYS.keys.select{|day| options[day].to_i == 1 } )
+      end
+
+      rule.until(options[:until_date]) if options[:ends] == 'eventually'
+
+      @schedule.add_recurrence_rule(rule)
+    end
+
+    self.schedule_yaml = @schedule.to_yaml
+  end
+
+  def schedule_attributes
+    atts = {}
+
+    if rule = schedule.rrules.first
+      atts[:repeat]     = 1
+      atts[:start_date] = schedule.start_date.to_date
+      atts[:date]       = Date.today # 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'
+        rule_hash[:validations][:day].each do |day_idx|
+          atts[ DAY_NAMES[day_idx] ] = 1
+        end
+      end
+
+      if rule.until_date
+        atts[:until_date] = rule.until_date.to_date
+        atts[:ends] = 'eventually'
+      else
+        atts[:ends] = 'never'
+      end
+    else
+      atts[:repeat]     = 0
+      atts[:date]       = schedule.start_date.to_date
+      atts[:start_date] = Date.today # for populating the other part of the form
+    end
+
+    OpenStruct.new(atts)
+  end
+
+  # TODO: test this
+  def self.parse_in_timezone(str)
+    if Time.respond_to? :zone
+      Time.zone.parse(str)
+    else
+      Time.parse(str)
+    end
+  end
+end
+
+# TODO: we shouldn't need this
+ScheduleAttributes = ScheduleAtts
+
+#TODO: this should be merged into ice_cube, or at least, make a pull request or something.
+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_atts/version.rb

@@ -0,0 +1,3 @@
+module ScheduleAtts
+  VERSION = "0.0.2"
+end

data/schedule_atts.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "schedule_atts/version"
+
+Gem::Specification.new do |s|
+  s.name        = "schedule_atts"
+  s.version     = ScheduleAtts::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Gunner Technology"]
+  s.email       = ["developers@gunnertech.com"]
+  s.homepage    = "http://gunnertech.com"
+  s.summary     = %q{Provides form attributes setting a recurring schedule.}
+  s.description = %q{Provides form attributes setting a recurring schedule.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'ice_cube', '>= 0.6.4'
+  s.add_dependency 'activesupport'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: schedule_atts
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Gunner Technology
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ice_cube
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.6.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: Provides form attributes setting a recurring schedule.
+email: 
+- developers@gunnertech.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.markdown
+- Rakefile
+- lib/schedule_atts.rb
+- lib/schedule_atts/version.rb
+- schedule_atts.gemspec
+has_rdoc: true
+homepage: http://gunnertech.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.0
+signing_key: 
+specification_version: 3
+summary: Provides form attributes setting a recurring schedule.
+test_files: []
+