montrose 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba11d2966c5dc7197138ee39c5fdcfc1466196f1
+  data.tar.gz: 3a41d2be8cfd2a9b5a38f1ae06432be7b6345c30
+SHA512:
+  metadata.gz: cd28c825b715713b722c41ae2402235fe8c9aa1b251448c941864e360d6898d8456f97a8a5d8a254cbabc4cd1172dc9147075b3591142fd5a1c1ea6589adb15c
+  data.tar.gz: 612673faf64c6800d5c6915b57af335171557dd9e066569c4750d7926e975123c304f80e1968660b048c328dfeeb751a9afd08cef79ddea8f32247fd7b867448

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/profile.log
+/trace.txt

data/.rubocop.yml

@@ -0,0 +1,113 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+
+Lint/HandleExceptions:
+  Exclude:
+    - 'test/test_helper.rb'
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/ModuleLength:
+  Max: 300
+
+Metrics/MethodLength:
+  Max: 100
+
+Metrics/ParameterLists:
+  Max: 8
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Documentation:
+  Enabled: false # TODO: Enable again once we have more docs
+
+Lint/EndAlignment:
+  Enabled: false
+
+Lint/DefEndAlignment:
+  Enabled: false
+
+Lint/HandleExceptions:
+  Enabled: false
+
+Style/GlobalVars:
+  Exclude:
+  - spec/support/trace.rb
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/TrivialAccessors:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: true
+
+Style/MethodName:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/AccessModifierIndentation:
+  Enabled: true
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+
+Style/OneLineConditional:
+  Enabled: false
+
+Style/AndOr:
+  Enabled: false
+
+Style/Not:
+  Enabled: false
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: case
+  SupportedStyles:
+    - case
+    - end
+  IndentOneStep: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%w': "[]"
+    '%W': "[]"
+
+Style/AccessModifierIndentation:
+  EnforcedStyle: indent
+
+Style/SignalException:
+  Enabled: false
+
+Style/IndentationWidth:
+  Enabled: false
+
+Style/TrivialAccessors:
+  ExactNameMatch: true
+
+Style/RegexpLiteral:
+  EnforcedStyle: percent_r
+
+Style/DotPosition:
+  EnforcedStyle: trailing

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cure.gemspec
+gemspec
+
+group :development do
+  gem "pry-byebug", platforms: :ruby_22
+  gem "guard"
+  gem "guard-minitest"
+  gem "guard-rubocop"
+  gem "yard"
+  gem "coveralls"
+end

data/Guardfile

@@ -0,0 +1,34 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  # watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  # watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  # watch(%r{^test/test_helper\.rb$})      { "test" }
+
+  # with Minitest::Spec
+  watch(%r{^spec/(.*)_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})         { "spec/rfc_spec.rb" }
+  watch(%r{^spec/spec_helper\.rb$}) { "spec" }
+end
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ross Kaffenberger
+
+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,191 @@
+# Montrose
+
+[![Build Status](https://travis-ci.org/rossta/montrose.svg?branch=master)](https://travis-ci.org/rossta/montrose)
+[![Coverage Status](https://coveralls.io/repos/rossta/montrose/badge.svg?branch=master&service=github)](https://coveralls.io/github/rossta/montrose?branch=master)
+[![Code Climate](https://codeclimate.com/github/rossta/montrose/badges/gpa.svg)](https://codeclimate.com/github/rossta/montrose)
+[![Dependency Status](https://gemnasium.com/rossta/montrose.svg)](https://gemnasium.com/rossta/montrose)
+
+Recurring events in Ruby.
+
+This library is currently under development. Most of the functionality does not
+exist yet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "montrose"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install montrose
+
+## Usage
+
+```ruby
+require "montrose"
+
+# Minutely
+Montrose.minutely
+Montrose::Recurrence.new(every: :minute)
+
+Montrose.every(10.minutes)
+Montrose::Recurrence.new(every: 10.minutes)
+Montrose::Recurrence.new(every: :minute, interval: 10) # every 10 minutes
+
+Montrose.minutely(until: "9:00 PM")
+Montrose::Recurrence.new(every: :minute, until: "9:00 PM")
+
+# Daily
+Montrose.daily
+Montrose::Recurrence.new(every: :day)
+
+Montrose.every(9.days)
+Montrose::Recurrence.new(every: 9.days)
+Montrose::Recurrence.new(every: :day, interval: 9)
+
+Montrose.daily(at: "9:00 AM")
+Montrose.every(:day, at: "9:00 AM")
+Montrose::Recurrence.new(every: :day, at: "9:00 AM")
+
+Montrose.daily(total: 7)
+Montrose.every(:day, total: 7)
+Montrose::Recurrence.new(every: :day, total: 7)
+
+# Weekly
+Montrose.weekly
+Montrose.every(:week)
+Montrose::Recurrence.new(every: :week)
+
+# TODO: :on option not yet supported
+Montrose::Recurrence.new(every: :week, on: 5)
+Montrose::Recurrence.new(every: :week, on: :monday)
+Montrose::Recurrence.new(every: :week, on: [:monday, :wednesday, :friday])
+Montrose::Recurrence.new(every: :week, on: :friday, interval: 2)
+Montrose::Recurrence.new(every: :week, on: :friday, repeat: 4)
+Montrose::Recurrence.new(every: :week, on: :friday, at: "3:41 PM")
+Montrose::Recurrence.new(every: :week, on: [:monday, :wednesday, :friday], at: "12:00 PM")
+Montrose::Recurrence.weekly(on: :thursday)
+
+# Monthly by month day
+Montrose.monthly(mday: 1) # first of the month
+Montrose.every(:month, mday: 1)
+Montrose::Recurrence.new(every: :month, mday: 1)
+
+Montrose.monthly(mday: [2, 15]) # 2nd and 15th of the month
+Montrose.monthly(mday: -3) # third-to-last day of the month
+Montrose.monthly(mday: 10..15) # 10th through the 15th day of the month
+
+# TODO: :on option not yet supported
+Montrose::Recurrence.new(every: :month, on: 15)
+Montrose::Recurrence.new(every: :month, on: 31)
+Montrose::Recurrence.new(every: :month, on: 7, interval: 2)
+Montrose::Recurrence.new(every: :month, on: 7, interval: :monthly)
+Montrose::Recurrence.new(every: :month, on: 7, interval: :bimonthly)
+Montrose::Recurrence.new(every: :month, on: 7, repeat: 6)
+Montrose::Recurrence.monthly(on: 31)
+
+# Monthly by week day
+Montrose.monthly(day: :friday, interval: 2) # every Friday every other month
+Montrose.every(:month, day: :friday, interval: 2)
+Montrose::Recurrence.new(every: :month, day: :friday, interval: 2)
+
+Montrose.monthly(day: { friday: [1] }) # 1st Friday of the month
+Montrose.monthly(day: { Sunday: [1, =1] }) # first and last Sunday of the month
+
+Montrose.monthly(mday: 7..13, day: :saturday) # first Saturday that follow the
+first Sunday of the month
+
+# TODO: :on option not yet supported
+Montrose::Recurrence.new(every: :month, on: :first, weekday: :sunday)
+Montrose::Recurrence.new(every: :month, on: :third, weekday: :monday)
+Montrose::Recurrence.new(every: :month, on: :last,  weekday: :friday)
+Montrose::Recurrence.new(every: :month, on: :last,  weekday: :friday, interval: 2)
+Montrose::Recurrence.new(every: :month, on: :last,  weekday: :friday, interval: :quarterly)
+Montrose::Recurrence.new(every: :month, on: :last,  weekday: :friday, interval: :semesterly)
+Montrose::Recurrence.new(every: :month, on: :last,  weekday: :friday, repeat: 3)
+
+# Yearly
+Montrose.yearly
+Montrose.every(:year)
+Montrose::Recurrence.new(every: :year)
+
+Montrose.yearly(month: [:june, :july]) # yearly in June and July
+Montrose.yearly(month: 6..8, day: :thursday) # yearly in June, July, August on
+Thursday
+Montrose.yearly(yday: [1, 100]) # yearly on the 1st and 100th day of year
+Montrose.yearly(month: :november, day: :tuesday, mday: 2..8) # every four years,
+the first Tuesday after a Monday in November, i.e., Election Day
+
+# TODO: :on option not yet supported
+Montrose::Recurrence.new(every: :year, on: [7, 4]) # => [month, day]
+Montrose::Recurrence.new(every: :year, on: [10, 31], interval: 3)
+Montrose::Recurrence.new(every: :year, on: [:jan, 31])
+Montrose::Recurrence.new(every: :year, on: [:january, 31])
+Montrose::Recurrence.new(every: :year, on: [10, 31], repeat: 3)
+Montrose::Recurrence.yearly(on: [:january, 31])
+
+# TODO: Remove a date in the series on the given except date(s)
+# :except defaults to being unset
+Montrose::Recurrence.new(every: :day, except: "2017-01-31")
+Montrose::Recurrence.new(every: :day, except: [Date.today, "2017-01-31"])
+
+# Enumerating events
+r = Montrose::Recurrence.new(every: :month, mday: 31, until: "January 1, 2017")
+r.each { |time| puts time.to_s }
+
+# Merging rules and enumerating
+r.merge(starts: "2017-01-01").each { |time| puts time.to_s }
+r.merge(starts: "2017-01-01").each { |date| puts date.to_s }
+r.merge(until: "2017-01-10").each { |date| puts date.to_s }
+r.merge(through: "2017-01-10").each { |date| puts date.to_s }
+r.merge(starts: "2017-01-05", until: "2017-01-10").each {|date| puts date.to_s }
+
+# Using #events Enumerator
+r.events # => #<Enumerator: ...>
+r.events.take(10).each { |date| puts date.to_s }
+r.events.lazy.select { |time| time > 1.month.from_now }.take(3).each { |date| puts date.to_s }
+```
+
+## Goals
+
+`Montrose` intends to:
+
+* embrace Ruby idioms
+* support Ruby 2.1+
+* provide a simple-to-use interface
+* be reasonably performant
+* serialize to yaml, hash, and [ical](http://www.kanzaki.com/docs/ical/rrule.html#basic) formats
+* be suitable for integration with persistence libraries
+
+What `Montrose` isn't:
+
+* support all calendaring use cases under the sun
+
+## Related Projects
+
+Check out following related projects, all of which have provided inspiration for `Montrose`.
+
+* [recurrence](https://github.com/fnando/recurrence)
+* [ice_cube](https://github.com/seejohnrun/ice_cube)
+* [runt](https://github.com/mlipper/runt)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rake` to run the tests.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rossta/montrose. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+require "yard"
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ["README.md", "lib/**/*.rb"]
+end
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList["spec/**/*_spec.rb"]
+end
+
+task test: :spec
+
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/bin/_guard-core

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', '_guard-core')