kalendor 0.0.1

data/spec/interval_spec.rb

@@ -0,0 +1,48 @@
+require 'kalendor'
+require 'kalendor/instance/interval'
+
+RSpec.describe Kalendor::Interval do
+  let(:interval) {
+    Kalendor.build { interval "2016-06-01", "2016-06-30" }
+  }
+
+  it "generates nothing when entirely before" do
+    f = date("2000-01-01")
+    u = date("2000-12-31")
+    expect(interval.get_dates(f, u).to_a).to eq []
+  end
+
+  it "generates some dates when overlapping before" do
+    f = date("2000-01-01")
+    u = date("2016-06-08")
+    expected = (1..8).map { |d| date("2016-06-0#{d}") }
+    expect(interval.get_dates(f, u).to_a).to eq expected
+  end
+
+  it "generates some dates when overlapping inside" do
+    f = date("2016-06-11")
+    u = date("2016-06-21")
+    expected = (11..21).map { |d| date("2016-06-#{d}") }
+    expect(interval.get_dates(f, u).to_a).to eq expected
+  end
+
+  it "generates all dates when overlapping outside" do
+    f = date("2016-01-01")
+    u = date("2016-12-31")
+    expected = (1..30).map { |d| date("2016-06-#{d}") }
+    expect(interval.get_dates(f, u).to_a).to eq expected
+  end
+
+  it "generates some dates when overlapping after" do
+    f = date("2016-06-21")
+    u = date("2016-12-31")
+    expected = (21..30).map { |d| date("2016-06-#{d}") }
+    expect(interval.get_dates(f, u).to_a).to eq expected
+  end
+
+  it "generates no dates when entirely after" do
+    f = date("2016-07-01")
+    u = date("2016-12-31")
+    expect(interval.get_dates(f, u).to_a).to eq []
+  end
+end

data/spec/month_spec.rb

@@ -0,0 +1,57 @@
+require 'kalendor'
+require 'kalendor/instance/intersect'
+require 'kalendor/instance/month'
+require 'kalendor/instance/weekday'
+
+RSpec.describe Kalendor::Month do
+  let(:november) { Kalendor.build { month 11 } }
+
+  it "generates nothing when entirely before" do
+    f = date("2000-01-01")
+    u = date("2000-10-31")
+    expect(november.get_dates(f, u).to_a).to eq []
+  end
+
+  it "generates some dates when overlapping before" do
+    f = date("2016-10-01")
+    u = date("2016-11-10")
+    expected = (1..10).map { |d| date("2016-11-#{d}") }
+    expect(november.get_dates(f, u).to_a).to eq expected
+  end
+
+  it "generates some dates when overlapping inside" do
+    f = date("2016-11-13")
+    u = date("2016-11-18")
+    expected = (13..18).map { |d| date("2016-11-#{d}") }
+    expect(november.get_dates(f, u).to_a).to eq expected
+  end
+
+  it "generates all dates when overlapping outside" do
+    f = date("2016-10-01")
+    u = date("2016-12-31")
+    expected = (1..30).map { |d| date("2016-11-#{d}") }
+    expect(november.get_dates(f, u).to_a).to eq expected
+  end
+
+  it "generates some dates when overlapping after" do
+    f = date("2016-11-21")
+    u = date("2016-12-31")
+    expected = (21..30).map { |d| date("2016-11-#{d}") }
+    expect(november.get_dates(f, u).to_a).to eq expected
+  end
+
+  it "generates no dates when entirely after" do
+    f = date("2016-12-01")
+    u = date("2017-10-31")
+    expect(november.get_dates(f, u).to_a).to eq []
+  end
+
+  it "finds the last monday of november each year" do
+    last_mon_nov = Kalendor.build { intersect month(11), weekday(1, -1) }
+    f  = date("2000-01-01")
+    u  = date("2020-12-31")
+    yd = (2000..2020).to_a.zip [27,26,25,24,29,28,27,26,24,30,29,28,26,25,24,30,28,27,26,25,30]
+    expected = yd.map { |y,d| date("#{y}-11-#{d}") }
+    expect(last_mon_nov.get_dates(f, u).to_a).to eq expected
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+require 'kalendor'
+
+
+module KalendorSpecHelper
+  def date str ; Date.parse(str) ; end
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.include KalendorSpecHelper
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  begin
+    # These two settings work together to allow you to limit a spec run
+    # to individual examples or groups you care about by tagging them with
+    # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+    # get run.
+    config.filter_run :focus
+    config.run_all_when_everything_filtered = true
+
+    # Allows RSpec to persist some state between runs in order to support
+    # the `--only-failures` and `--next-failure` CLI options. We recommend
+    # you configure your source control system to ignore this file.
+    config.example_status_persistence_file_path = "spec/examples.txt"
+
+    # Limits the available syntax to the non-monkey patched syntax that is
+    # recommended. For more details, see:
+    #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+    #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+    config.disable_monkey_patching!
+
+    # This setting enables warnings. It's recommended, but in some cases may
+    # be too noisy due to issues in dependencies.
+    config.warnings = true
+
+    # Many RSpec users commonly either run the entire suite or an individual
+    # file, and it's useful to allow more verbose output when running an
+    # individual spec file.
+    if config.files_to_run.one?
+      # Use the documentation formatter for detailed output,
+      # unless a formatter has already been configured
+      # (e.g. via a command-line flag).
+      config.default_formatter = 'doc'
+    end
+
+    # Print the 10 slowest examples and example groups at the
+    # end of the spec run, to help surface which specs are running
+    # particularly slow.
+    config.profile_examples = 10
+
+    # Run specs in random order to surface order dependencies. If you find an
+    # order dependency and want to debug it, you can fix the order by providing
+    # the seed, which is printed after each run.
+    #     --seed 1234
+    config.order = :random
+
+    # Seed global randomization in this process using the `--seed` CLI option.
+    # Setting this allows you to use `--seed` to deterministically reproduce
+    # test failures related to randomization by passing the same `--seed` value
+    # as the one that triggered the failure.
+    Kernel.srand config.seed
+  end
+end

data/spec/subtract_spec.rb

@@ -0,0 +1,26 @@
+require 'kalendor'
+require 'kalendor/instance/intersect'
+require 'kalendor/instance/interval'
+require 'kalendor/instance/annual'
+require 'kalendor/instance/subtract'
+require 'kalendor/instance/union'
+require 'kalendor/instance/weekday'
+
+RSpec.describe Kalendor::Subtract do
+  it "produces every weekend in summer 2016" do
+    summer_workdays = Kalendor.build {
+      subtract(interval("2016-06-01", "2016-08-31"),
+               union(union(weekday(6),
+                           weekday(0)),
+                     annual(14, 7),
+                     interval("2016-08-12", "2016-08-28")))
+    }
+
+    workdays_in_jun_2016    = [1,2,3,6,7,8,9,10,13,14,15,16,17,20,21,22,23,24,27,28,29,30].map { |d| date("2016-06-#{d}") }
+    workdays_in_jul_2016    = [1,4,5,6,7,8,11,12,13,15,18,19,20,21,22,25,26,27,28,29     ].map { |d| date("2016-07-#{d}") } # skip 14th
+    workdays_in_aug_2016    = [1,2,3,4,5,8,9,10,11,29,30,31                              ].map { |d| date("2016-08-#{d}") } # skip 12-28
+    workdays_in_summer_2016 = workdays_in_jun_2016 + workdays_in_jul_2016 + workdays_in_aug_2016
+
+    expect(summer_workdays.get_dates(date("1999-01-01"), date("2020-12-31")).to_a).to eq workdays_in_summer_2016
+  end
+end

data/spec/union_spec.rb

@@ -0,0 +1,27 @@
+require 'kalendor'
+require 'kalendor/instance/annual'
+require 'kalendor/instance/union'
+require 'kalendor/instance/weekday'
+
+RSpec.describe Kalendor::Union do
+  it "produces every weekend in oct - dec 2016" do
+    weekends = Kalendor.build { union weekday(6), weekday(7) }
+
+    weekends_in_oct_2016 = [1,2,8,9,15,16,22,23,29,30].map { |d| date("2016-10-#{d}") }
+    weekends_in_nov_2016 = [5,6,12,13,19,20,26,27    ].map { |d| date("2016-11-#{d}") }
+    weekends_in_dec_2016 = [3,4,10,11,17,18,24,25,31 ].map { |d| date("2016-12-#{d}") }
+    weekends_in_end_2016 = weekends_in_oct_2016 + weekends_in_nov_2016 + weekends_in_dec_2016
+
+    expect(weekends.get_dates date("2016-10-01"), date("2016-12-31")).to eq weekends_in_end_2016
+  end
+
+  it "produces birthdays and 5th wednesdays" do
+    mix = Kalendor.build { union weekday(3, 5), annual(12,3), annual(21,6), annual(8,6) }
+
+    w5 = %w{ 2015-04-29 2015-07-29 2015-09-30 2015-12-30 2016-03-30 2016-06-29 2016-08-31 2016-11-30  }
+    bd = %w{ 2015-03-12 2015-06-08 2015-06-21 2016-03-12 2016-06-08 2016-06-21 }
+    expected = (w5 + bd).map { |d| date d }.sort
+
+    expect(mix.get_dates date("2015-01-01"), date("2016-12-31")).to eq expected
+  end
+end

data/spec/weekday_spec.rb

@@ -0,0 +1,27 @@
+require 'kalendor'
+require 'kalendor/instance/weekday'
+
+RSpec.describe Kalendor::Weekday do
+  it "produces every tuesday in september 2016" do
+    weekly = Kalendor.build { weekday(2) }
+    tuesdays_in_sep_2016 = [6,13,20,27].map { |d| date("2016-09-#{d}") }
+    expect(weekly.get_dates date("2016-09-01"), date("2016-09-30")).to eq tuesdays_in_sep_2016
+  end
+  it "produces every monday in october 2016" do
+    weekly = Kalendor.build { weekday(1) }
+    mondays_in_oct_2016 = [3,10,17,24,31].map { |d| date("2016-10-#{d}") }
+    expect(weekly.get_dates date("2016-10-01"), date("2016-10-31")).to eq mondays_in_oct_2016
+  end
+  it "produces the second wednesday in every month of 2016" do
+    weekly = Kalendor.build { weekday(3, 2) }
+    second_weds_in_2016 = %w{ 01-13 02-10 03-09 04-13 05-11 06-08 07-13 08-10 09-14 10-12 11-09 12-14 }
+    second_weds_in_2016 = second_weds_in_2016.map { |d| date("2016-#{d}") }
+    expect(weekly.get_dates date("2016-01-01"), date("2016-12-31")).to eq second_weds_in_2016
+  end
+  it "produces the 3rd-last thursday in every month of 2015" do
+    weekly = Kalendor.build { weekday(4, -3) }
+    l3_thu_2015 = %w{ 01-15 02-12 03-12 04-16 05-14 06-11 07-16 08-13 09-10 10-15 11-12 12-17 }
+    l3_thu_2015 = l3_thu_2015.map { |d| date("2015-#{d}") }
+    expect(weekly.get_dates date("2015-01-01"), date("2015-12-31")).to eq l3_thu_2015
+  end
+end

data/todo.txt

@@ -0,0 +1,98 @@
+Generators:
+
+A generator is an object that generates a sequence of dates between a given start and end date.
+
+Examples of generators:
+
+"Monday"                                            # every monday
+">2004-03-12<"                                      # the 12th of march, 2004
+"2004-03-12< <2005-03-11"                           # every day from the 12th of march, 2004 until the 11th of march, 2005
+"Monday 2004-01-01< <2004-12-31"                    # every monday from the 1st of january, 2004 until the 31st of december, 2004
+"UNION Saturday Sunday"                             # weekends
+"2004-01-01< <2004-12-31 (NOT (UNION (Saturday) (Sunday)))" # every non-weekend day in 2004
+"Tuesday/2"                                         # second tuesday of every month
+"Tuesday/-1"                                        # last tuesday of every month
+"14 July"                                           # 14th of July every year
+
+
+Generator::Base
+  name
+  type
+  first_day
+  last_day
+  days_of_week    # array of String mon,tue,wed,thu,fri,sat,sun
+  weeks_of_month  # array of Integer -5,-4,-3,-2,-1,0,1,2,3,4,5 (0 = every week)
+  repeat_number   # nonzero positive integer
+  repeat_kind     # one of day|week|month|year
+
+  has_many schedule_combinations (Union, Intersection and Not types only)
+
+  def generate(from_date, until_date) ...
+
+module Generator::DateRange < Generator::Base
+  # attrs first_day, last_day, repeat_interval_number, repeat_interval_size
+  # def list_of_dates(from, until) -> return every Date matching constraints from first_day to last_day within from..until
+
+module Generator::Weekday < Generator::Base
+  # attrs day_of_week, nth_of_month
+  # day_of_week is in range 0..6
+  # nth_of_month is in range -5..4 (-5 = 5th last ... -1 = last, 0 = every, 1 = 1st ... 3 = 3rd, 4 = 4th, 5 = 5th)
+  # def list_of_dates(from, until) -> return every Date matching constraints from first_day to last_day within from..until
+
+module Generator::Birthday < Generator::Base
+  # attr date (year is ignored)
+
+module Generator::Union < Generator::Base
+  # attr list of generators
+
+module Generator::Intersection < Generator::Base
+  # attr list of generators
+
+module Generator::Not < Generator::Base
+  # attr generator
+
+
+ScheduleComposition
+  owner
+  schedule
+
+module Generator::NamedSchedule < Generator::Base
+  name
+  generator
+
+
+
+Course
+  course_start_date
+  course_finish_date
+  restrict_calendar_id
+  exclude_calendar_id
+
+
+Group
+  def schedule
+    s.exclude(academic_year, s.union(wednesdays, weekends, holidays))
+  end
+end
+
+# not directly required for course_series for now (required indirectly via restrict or exclude)
+    days         : ( ) mon ( ) tue ( ) wed ( ) thu ( ) fri ( ) sat ( ) sun
+    of month     : (x) every week ( ) 1st week of month ( ) 2nd week of month ( ) 3rd week of month ( ) last week of month
+    repeat every : _N_ _________v [days|weeks|months|years]
+
+NamedSchedule
+  [add a repeating date] [add a specific date] [add a weekday]
+  - build weekday generator
+    effect       : ( ) include ( ) restrict ( ) exclude
+    days         : ( ) mon ( ) tue ( ) wed ( ) thu ( ) fri ( ) sat ( ) sun
+    of month     : (x) every week ( ) 1st week of month ( ) 2nd week of month ( ) 3rd week of month ( ) last week of month
+  - build repeating generator
+    effect       : ( ) include ( ) restrict ( ) exclude
+    date         : ______________
+    repeat every : _N_ _________v [days|weeks|months|years]
+  - build specific generator
+    effect       : ( ) include ( ) restrict ( ) exclude
+    date         : ______________
+
+
+.

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: kalendor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Conan Dalton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aduki
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: rspec_numbering_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Utility classes for generating sets of dates
+email:
+- conan@conandalton.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- kalendor.gemspec
+- lib/kalendor.rb
+- lib/kalendor/annual.rb
+- lib/kalendor/date_helper.rb
+- lib/kalendor/date_list.rb
+- lib/kalendor/factory.rb
+- lib/kalendor/instance.rb
+- lib/kalendor/instance/annual.rb
+- lib/kalendor/instance/composite.rb
+- lib/kalendor/instance/date_list.rb
+- lib/kalendor/instance/intersect.rb
+- lib/kalendor/instance/interval.rb
+- lib/kalendor/instance/month.rb
+- lib/kalendor/instance/store.rb
+- lib/kalendor/instance/subtract.rb
+- lib/kalendor/instance/union.rb
+- lib/kalendor/instance/weekday.rb
+- lib/kalendor/intersect.rb
+- lib/kalendor/interval.rb
+- lib/kalendor/month.rb
+- lib/kalendor/named.rb
+- lib/kalendor/subtract.rb
+- lib/kalendor/union.rb
+- lib/kalendor/version.rb
+- lib/kalendor/weekday.rb
+- spec/annual_spec.rb
+- spec/date_list_spec.rb
+- spec/date_spec.rb
+- spec/examples.txt
+- spec/intersect_spec.rb
+- spec/interval_spec.rb
+- spec/month_spec.rb
+- spec/spec_helper.rb
+- spec/subtract_spec.rb
+- spec/union_spec.rb
+- spec/weekday_spec.rb
+- todo.txt
+homepage: http://github.com/conanite/kalendor
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Utility classes for generating sets of dates
+test_files:
+- spec/annual_spec.rb
+- spec/date_list_spec.rb
+- spec/date_spec.rb
+- spec/examples.txt
+- spec/intersect_spec.rb
+- spec/interval_spec.rb
+- spec/month_spec.rb
+- spec/spec_helper.rb
+- spec/subtract_spec.rb
+- spec/union_spec.rb
+- spec/weekday_spec.rb