repeatable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2f40e8650290808378222b5008cbb78fdbea93aa
+  data.tar.gz: 185957b9333e449b91b843ea84517cf09019f33a
+SHA512:
+  metadata.gz: e296b0cd1a654e675e09026b7c6672f72a5737819f3e35d8d784b5e5977f7f177747d96aff2f54291e177e3914ef02d7778f2a1d9cb37cc23100bfd414645381
+  data.tar.gz: aef5189d0560f22de05c6c7518457f5628f2c2132f4cb96e38467597c1e8929e15aa0a91e8681bdc17d50e4995fd96a8383d19a8e472ca34e6c33345f3ad8d3b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.2.0
+addons:
+  code_climate:
+    repo_token:
+      secure: fyZ7Ycc23fzfh8bBiqPUhlJGcIcnanZWqVc4nsKDJeE1G5ScW01+ot1g4miDWxo7w80gKRKP/PfoYf6lOQ1B5yJJCV0Z5fjoTW3y+EKksMuGNCFaWh8R73MIPlVtfOazGyI2t3l4zDWoik906wHHNQJFveMZawvZGrVMWF6YxKg=

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in repeatable.gemspec
+gemspec
+
+gem 'pry'
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Mo Lawson
+
+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/README.md

@@ -0,0 +1,87 @@
+# Repeatable
+
+[![Build Status](https://img.shields.io/travis/molawson/repeatable.svg)](https://travis-ci.org/molawson/repeatable)
+[![Code Climate](https://img.shields.io/codeclimate/github/molawson/repeatable.svg)](https://codeclimate.com/github/molawson/repeatable)
+[![Code Climate Coverage](https://img.shields.io/codeclimate/coverage/github/molawson/repeatable.svg)](https://codeclimate.com/github/molawson/repeatable)
+
+Ruby implementation of Martin Fowler's [Recurring Events for Calendars](http://martinfowler.com/apsupp/recurring.pdf) paper.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'repeatable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install repeatable
+
+## Usage
+
+Describe a schedule with a Hash:
+
+```ruby
+args = {
+  intersection: [                                     # All included conditions must be met
+    weekday_in_month: { weekday: 1, count: 2 }        # The second Monday of every month
+    range_in_year: { start_month: 10, end_month: 12 } # October through December
+  ]
+}
+
+schedule = Repeatable::Schedule.new(args)
+```
+
+Ask your schedule one of three questions:
+
+```ruby
+schedule.next_occurrence
+  # => Date of next occurrence
+
+schedule.occurrences(Date.new(2015, 1, 1), Date.new(2016, 6, 30))
+  # => Dates of all occurrences between Jan 1, 2015 and June 30, 2016
+
+schedule.include?(Date.new(2015, 10, 10))
+  # => Whether the schedule has an event on the date given (true/false)
+```
+
+Available time expressions:
+
+```ruby
+# Sets
+union: []         # Any conditions can be met
+intersection: []  # All conditions must be met
+
+# Dates
+weekday: { weekday: 0 }
+  # Every Sunday
+weekday_in_month: { weekday: 1, count: 3 }
+  # The 3rd Monday of every month
+day_in_month: { day: 13 }
+  # The 13th of every month
+range_in_year: { start_month: 10 }
+  # Any day in October
+range_in_year: { start_month: 10, end_month: 12 }
+  # All days from October through December
+range_in_year: { start_month: 10, end_month: 12, start_day: 1, end_day: 20 }
+  # All days from October 1 through December 20
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/molawson/repeatable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'repeatable'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/repeatable/conversions.rb

@@ -0,0 +1,16 @@
+module Repeatable
+  module Conversions
+    module_function
+
+    def Date(arg)
+      case arg
+      when Date, Time
+        arg.to_date
+      else
+        Date.parse(arg)
+      end
+    rescue ArgumentError
+      raise TypeError, "Cannot convert #{arg.inspect} to Date"
+    end
+  end
+end

data/lib/repeatable/expression/base.rb

@@ -0,0 +1,16 @@
+module Repeatable
+  module Expression
+    class Base
+      def self.===(other)
+        other.ancestors.include?(self)
+      end
+
+      def include?(_date)
+        fail(
+          NotImplementedError,
+          "Don't use Expression::Base directly. Subclasses should implement `#include?`"
+        )
+      end
+    end
+  end
+end

data/lib/repeatable/expression/day_in_month.rb

@@ -0,0 +1,17 @@
+module Repeatable
+  module Expression
+    class DayInMonth < Base
+      def initialize(day:)
+        @day = day
+      end
+
+      def include?(date)
+        date.day == day
+      end
+
+      private
+
+      attr_reader :day
+    end
+  end
+end

data/lib/repeatable/expression/intersection.rb

@@ -0,0 +1,9 @@
+module Repeatable
+  module Expression
+    class Intersection < Set
+      def include?(date)
+        elements.all? { |e| e.include?(date) }
+      end
+    end
+  end
+end

data/lib/repeatable/expression/range_in_year.rb

@@ -0,0 +1,32 @@
+module Repeatable
+  module Expression
+    class RangeInYear < Base
+      def initialize(start_month:, end_month: start_month, start_day: 0, end_day: 0)
+        @start_month = start_month
+        @end_month = end_month
+        @start_day = start_day
+        @end_day = end_day
+      end
+
+      def include?(date)
+        months_include?(date) || start_month_include?(date) || end_month_include?(date)
+      end
+
+      private
+
+      attr_reader :start_month, :end_month, :start_day, :end_day
+
+      def months_include?(date)
+        date.month > start_month && date.month < end_month
+      end
+
+      def start_month_include?(date)
+        date.month == start_month && (start_day == 0 || date.day >= start_day)
+      end
+
+      def end_month_include?(date)
+        date.month == end_month && (end_day == 0 || date.day <= end_day)
+      end
+    end
+  end
+end

data/lib/repeatable/expression/set.rb

@@ -0,0 +1,18 @@
+module Repeatable
+  module Expression
+    class Set < Base
+      def initialize(*elements)
+        @elements = elements.flatten
+      end
+
+      def <<(element)
+        elements << element
+        self
+      end
+
+      private
+
+      attr_reader :elements
+    end
+  end
+end

data/lib/repeatable/expression/union.rb

@@ -0,0 +1,9 @@
+module Repeatable
+  module Expression
+    class Union < Set
+      def include?(date)
+        elements.any? { |e| e.include?(date) }
+      end
+    end
+  end
+end

data/lib/repeatable/expression/weekday.rb

@@ -0,0 +1,17 @@
+module Repeatable
+  module Expression
+    class Weekday < Base
+      def initialize(weekday:)
+        @weekday = weekday
+      end
+
+      def include?(date)
+        date.wday == weekday
+      end
+
+      private
+
+      attr_reader :weekday
+    end
+  end
+end

data/lib/repeatable/expression/weekday_in_month.rb

@@ -0,0 +1,30 @@
+module Repeatable
+  module Expression
+    class WeekdayInMonth < Base
+      def initialize(weekday:, count:)
+        @weekday = weekday
+        @count = count
+      end
+
+      def include?(date)
+        day_matches?(date) && week_matches?(date)
+      end
+
+      private
+
+      attr_reader :weekday, :count
+
+      def day_matches?(date)
+        date.wday == weekday
+      end
+
+      def week_matches?(date)
+        week_in_month(date.day) == count
+      end
+
+      def week_in_month(day)
+        ((day - 1) / 7) + 1
+      end
+    end
+  end
+end

data/lib/repeatable/expression.rb

@@ -0,0 +1,4 @@
+module Repeatable
+  module Expression
+  end
+end

data/lib/repeatable/schedule.rb

@@ -0,0 +1,53 @@
+require 'active_support/core_ext/string/inflections'
+
+module Repeatable
+  class Schedule
+    def initialize(args)
+      @expression = build_expression(args)
+    end
+
+    def occurrences(start_date, end_date)
+      start_date = Date(start_date)
+      end_date = Date(end_date)
+      (start_date..end_date).select { |date| include?(date) }
+    end
+
+    def next_occurrence(start_date = Date.today)
+      date = Date(start_date)
+      until include?(date)
+        date = date.next_day
+      end
+      date
+    end
+
+    def include?(date = Date.today)
+      date = Date(date)
+      expression.include?(date)
+    end
+
+    private
+
+    attr_reader :expression
+
+    def build_expression(hash)
+      if hash.length != 1
+        fail "Invalid expression: '#{hash}' should have single key and value"
+      else
+        expression_for(*hash.first)
+      end
+    end
+
+    def expression_for(key, value)
+      klass = "repeatable/expression/#{key}".classify.safe_constantize
+      case klass
+      when nil
+        fail "Unknown mapping: Can't map key '#{key.inspect}' to an expression class"
+      when Repeatable::Expression::Set
+        args = value.map { |hash| build_expression(hash) }
+        klass.new(*args)
+      else
+        klass.new(value)
+      end
+    end
+  end
+end

data/lib/repeatable/version.rb

@@ -0,0 +1,3 @@
+module Repeatable
+  VERSION = '0.1.0'
+end

data/lib/repeatable.rb

@@ -0,0 +1,23 @@
+require 'date'
+
+require 'repeatable/version'
+
+require 'repeatable/conversions'
+include Repeatable::Conversions
+
+module Repeatable
+end
+
+require 'repeatable/expression'
+require 'repeatable/expression/base'
+
+require 'repeatable/expression/weekday'
+require 'repeatable/expression/weekday_in_month'
+require 'repeatable/expression/day_in_month'
+require 'repeatable/expression/range_in_year'
+
+require 'repeatable/expression/set'
+require 'repeatable/expression/union'
+require 'repeatable/expression/intersection'
+
+require 'repeatable/schedule'

data/repeatable.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'repeatable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'repeatable'
+  spec.version       = Repeatable::VERSION
+  spec.authors       = ['Mo Lawson']
+  spec.email         = ['mo@molawson.com']
+
+  spec.summary       = 'Describe recurring event schedules and calculate their occurrences'
+  spec.description   = "Ruby implementation of Martin Fowler's 'Recurring Events for Calendars' paper."
+  spec.homepage      = 'https://github.com/molawson/repeatable'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: repeatable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mo Lawson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Ruby implementation of Martin Fowler's 'Recurring Events for Calendars'
+  paper.
+email:
+- mo@molawson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/repeatable.rb
+- lib/repeatable/conversions.rb
+- lib/repeatable/expression.rb
+- lib/repeatable/expression/base.rb
+- lib/repeatable/expression/day_in_month.rb
+- lib/repeatable/expression/intersection.rb
+- lib/repeatable/expression/range_in_year.rb
+- lib/repeatable/expression/set.rb
+- lib/repeatable/expression/union.rb
+- lib/repeatable/expression/weekday.rb
+- lib/repeatable/expression/weekday_in_month.rb
+- lib/repeatable/schedule.rb
+- lib/repeatable/version.rb
+- repeatable.gemspec
+homepage: https://github.com/molawson/repeatable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Describe recurring event schedules and calculate their occurrences
+test_files: []