chorewheel 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDBhZjI3YmVlMzRhZjNhNDcyZDliYzkxNTViNTU0OTQwM2U0YzE3NQ==
+  data.tar.gz: !binary |-
+    MmNiMTkxZmFlN2Q5M2EyNjg3NWVhODJhZTUyMTE1NjBiMTBhNjJhNw==
+SHA512:
+  metadata.gz: !binary |-
+    NGQ0YWM0NzA4ZTFmNzc3YjNhOTEwM2Q0NzI2YmY1MDMzZWUyMmQxZTJlYjRi
+    MDJkZjQyYTQ3NWNjZmZmYzRkYWE1NTIwMTc3OTMzYzQyNWIyMzk3ZDdjOGQ5
+    ZTVjYTQwZTg3MDhlMjU2YTBiZjdmMDk2MDhiNjczNTQ4ZDhkODc=
+  data.tar.gz: !binary |-
+    MDhiN2E5ZDY2YTQ5NzA5ODM5ZWM5MjE5NmU0NTA2ZjViNGE2YzUxZmY3NWVh
+    OTQ1M2Q2ZmM0NjQxOGM0MmMzY2I4YzFlMDA0NjkyNzAxNzc0ODRiOWQ1YmIw
+    YmQ4ZDA4ZTA0MWEzYzM2Y2RhMWFiNWQ0MDQwM2Q4MDcwOTUzY2M=

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "contracts", "~> 0.11.0"
+
+group :test do
+  gem "rspec"
+  gem "rubocop", "~> 0.29.1", :platform => [:ruby_20, :ruby_21, :ruby_22]
+end
+
+group :development do
+  gem "rake"
+end

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Aditya Bhargava
+
+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,5 @@
+# chorewheel
+
+![travis-ci](https://travis-ci.org/egonSchiele/chorewheel.svg)
+
+Simple chore scheduler in Ruby.

data/Rakefile

@@ -0,0 +1,5 @@
+task :default => [:spec]
+
+# you can do `rake rubocop` as well
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)

data/TODO.markdown

@@ -0,0 +1 @@
+- extra chore i.e. person X needs to make up an extra day of chores

data/chorewheel.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name        = "chorewheel"
+  s.version     = "0.0.1"
+  s.summary     = "Simple chore scheduler in Ruby."
+  s.description = "Make a chore wheel, with options for specifying multiple people, vacation days, etc."
+  s.author      = "Aditya Bhargava"
+  s.email       = "bluemangroupie@gmail.com"
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = "http://github.com/egonSchiele/chorewheel"
+  s.add_dependency("contracts", "~> 0.11")
+end

data/lib/chorewheel.rb

@@ -0,0 +1,168 @@
+# A chore schedule takes place over a timespan.
+# In intervals.
+# And it is done by some people.
+
+require "util"
+require "contracts"
+require "timespan"
+require "interval"
+include Contracts
+
+class ChoreWheel
+  GenericString = Or[String, Symbol]
+  attr_accessor :workers_per_shift, :people, :timespan, :interval
+  def initialize people, timespan, interval, opts = {}
+    unless people.is_a?(Array)
+      people = [people]
+    end
+    @people = people
+    @timespan = timespan
+    @interval = interval
+    @workers_per_shift = opts[:workers_per_shift] || 1
+    create
+  end
+
+  Contract Hash
+  def chunks
+    @chunks ||= make_chunks @timespan, @interval
+    @chunks
+  end
+
+  def chunks= c
+    @chunks = c
+  end
+
+  def map &blk
+    arr = []
+    chunks.values.map do |val|
+      arr << blk.call[val]
+    end
+    arr
+  end
+
+  Contract ArrayOf[String]
+  def shifts
+    chunks.keys
+  end
+
+  Contract ArrayOf[ArrayOf[GenericString]]
+  def workers
+    chunks.values
+  end
+
+  Contract ArrayOf[[String, ArrayOf[GenericString]]]
+  def to_a
+    chunks.to_a
+  end
+
+  def each &blk
+    chunks.values.each do |val|
+      blk.call(val)
+    end
+    self
+  end
+
+  def set_each &blk
+    chunks.each do |key, val|
+      chunks[key] = blk.call key
+    end
+    self
+  end
+
+  def count &blk
+    counter = 0
+    chunks.each do |key, val|
+      result = blk.call key, val
+      counter += 1 if result
+    end
+    counter
+  end
+
+  Contract Timespan::WEEK, Interval::WEEKDAY => Hash
+  def make_chunks timespan, interval
+    make_hash weekdays
+  end
+
+  Contract Timespan::WEEK, Interval::DAY => Hash
+  def make_chunks timespan, interval
+    make_hash days
+  end
+
+  Contract Timespan::WEEK, Interval::SPECIFIC_DAYS => Hash
+  def make_chunks timespan, interval
+    hash = {}
+    interval.days.each do |day|
+      hash[day] = nil
+    end
+    hash
+  end
+
+  Contract Timespan::MONTH, Interval::DAY => Hash
+  def make_chunks timespan, interval
+    hash = {}
+    start = timespan.start_date
+    (start...start.next_month).each do |date|
+      hash[date.to_s] = nil
+    end
+    hash
+  end
+
+  Contract Timespan::MONTH, Interval::WEEKDAY => Hash
+  def make_chunks timespan, interval
+    hash = make_chunks(timespan, Interval::DAY)
+    # delete sundays and saturdays
+    hash.delete_if do |key, _|
+      [0, 6].include?(Date.parse(key).wday)
+    end
+  end
+
+  Contract Timespan::MONTH, Interval::SPECIFIC_DAYS => Hash
+  def make_chunks timespan, interval
+    hash = make_chunks(timespan, Interval::DAY)
+    hash.delete_if do |key, _|
+      !interval.days.include?(Date.parse(key).strftime("%A").downcase)
+    end
+  end
+
+  Contract Any, Any => Any
+  def make_chunks timespan, interval
+    fail "don't know how to make timespan with timespan type #{timespan} and interval type #{interval}"
+  end
+
+  def create
+    i = 0
+    _people = people.dup.shuffle
+    set_each do
+      workers = []
+      workers_per_shift.times do
+        if i >= _people.size
+          i = 0
+          _people.shuffle!
+        end
+        workers << _people[i]
+        i += 1
+      end
+      workers
+    end
+  end
+
+  def to_hash
+    {
+      "people" => people,
+      "timespan" => timespan,
+      "interval" => interval,
+      "workers_per_shift" => workers_per_shift,
+      "chunks" => chunks
+    }
+  end
+
+  def self.from_hash hash
+    cw = ChoreWheel.new(hash["people"], hash["timespan"], hash["interval"], {:workers_per_shift => hash["workers_per_shift"]})
+    cw.chunks = hash["chunks"]
+    cw
+  end
+
+  def ==(other)
+    to_hash == other.to_hash
+  end
+end

data/lib/interval.rb

@@ -0,0 +1,22 @@
+require "contracts"
+include Contracts
+
+class Interval
+  DAY = :day
+  WEEKDAY = :weekday
+  WEEK = :week
+  MONTH = :month
+  YEAR = :year
+
+  class SPECIFIC_DAYS
+    attr_accessor :days
+
+    Contract ArrayOf[String] => Any
+    def initialize days
+      @days = days
+    end
+    def inspect
+      days.inspect
+    end
+  end
+end

data/lib/person.rb

@@ -0,0 +1,5 @@
+class Person
+  def initialize name
+    @name = name
+  end
+end

data/lib/timespan.rb

@@ -0,0 +1,21 @@
+# Essentially an ordered hash.
+# Ruby 1.9 hashes are all ordered.
+require "util"
+require "interval"
+require "contracts"
+require "date"
+include Contracts
+
+class Timespan
+  WEEK = :week
+  YEAR = :year
+
+  class MONTH
+    attr_accessor :start_date
+
+    Contract Date => Any
+    def initialize start_date
+      @start_date = start_date
+    end
+  end
+end

data/lib/util.rb

@@ -0,0 +1,26 @@
+def weekdays
+  ["monday", "tuesday", "wednesday", "thursday", "friday"]
+end
+
+def days
+  ["sunday"] + weekdays + ["saturday"]
+end
+
+def make_hash keys
+  hash = {}
+  keys.each do |key|
+    hash[key] = nil
+  end
+  hash
+end
+
+# infinitely keep yielding
+# elements of the array, starting
+# from the beginning when you are at the end
+def cycle arr
+  while true
+    arr.each do |elem|
+      yield elem
+    end
+  end
+end

data/spec/chorewheel_spec.rb

@@ -0,0 +1,145 @@
+require "date"
+
+RSpec.describe "ChoreWheel" do
+  describe "chunks" do
+    it "should make chunks for week/day" do
+      t = ChoreWheel.new(:adit, Timespan::WEEK, Interval::DAY)
+      expect(t.shifts).to eq(days)
+    end
+
+    it "should make chunks for week/weekday" do
+      t = ChoreWheel.new(:adit, Timespan::WEEK, Interval::WEEKDAY)
+      expect(t.shifts).to eq(weekdays)
+    end
+
+    it "should make chunks for week/specific_days" do
+      t = ChoreWheel.new(:adit, Timespan::WEEK, Interval::SPECIFIC_DAYS.new(["tuesday", "thursday", "friday"]))
+      expect(t.shifts).to eq(["tuesday", "thursday", "friday"])
+    end
+
+    describe "chunks for months" do
+      before :each do
+        @month = Timespan::MONTH.new(Date.strptime("2015-09-01", "%Y-%m-%d"))
+      end
+
+      it "should make chunks for month/days" do
+        t = ChoreWheel.new(:adit, @month, Interval::DAY)
+        expect(t.shifts).to eq(["2015-09-01", "2015-09-02", "2015-09-03", "2015-09-04", "2015-09-05", "2015-09-06", "2015-09-07", "2015-09-08", "2015-09-09", "2015-09-10", "2015-09-11", "2015-09-12", "2015-09-13", "2015-09-14", "2015-09-15", "2015-09-16", "2015-09-17", "2015-09-18", "2015-09-19", "2015-09-20", "2015-09-21", "2015-09-22", "2015-09-23", "2015-09-24", "2015-09-25", "2015-09-26", "2015-09-27", "2015-09-28", "2015-09-29", "2015-09-30"])
+      end
+
+      it "should make chunks for month/weekdays" do
+        t = ChoreWheel.new(:adit, @month, Interval::WEEKDAY)
+        expect(t.shifts).to eq(["2015-09-01", "2015-09-02", "2015-09-03", "2015-09-04", "2015-09-07", "2015-09-08", "2015-09-09", "2015-09-10", "2015-09-11", "2015-09-14", "2015-09-15", "2015-09-16", "2015-09-17", "2015-09-18", "2015-09-21", "2015-09-22", "2015-09-23", "2015-09-24", "2015-09-25", "2015-09-28", "2015-09-29", "2015-09-30"])
+      end
+
+      it "should make chunks for month/specific days" do
+        t = ChoreWheel.new(:adit, @month, Interval::SPECIFIC_DAYS.new(["tuesday", "thursday", "friday"]))
+        expect(t.shifts).to eq(["2015-09-01", "2015-09-03", "2015-09-04", "2015-09-08", "2015-09-10", "2015-09-11", "2015-09-15", "2015-09-17", "2015-09-18", "2015-09-22", "2015-09-24", "2015-09-25", "2015-09-29"])
+      end
+    end
+  end
+
+  describe "interface" do
+    before :each do
+      @t = ChoreWheel.new(:adit, Timespan::WEEK, Interval::WEEKDAY)
+    end
+
+    it "to_a" do
+      expect(@t.to_a).to eq([["monday", [:adit]], ["tuesday", [:adit]], ["wednesday", [:adit]], ["thursday", [:adit]], ["friday", [:adit]]])
+    end
+
+    it "shifts" do
+      expect(@t.shifts).to eq(weekdays)
+    end
+
+    it "workers" do
+      expect(@t.workers).to eq([[:adit], [:adit], [:adit], [:adit], [:adit]])
+    end
+  end
+
+  describe "create" do
+    people = [
+      [:adit],
+      [:adit, :maggie]
+    ]
+
+    specific_days = Interval::SPECIFIC_DAYS.new(["tuesday", "thursday", "friday"])
+
+    create_args = [
+      [Timespan::WEEK, Interval::DAY],
+      [Timespan::WEEK, Interval::WEEKDAY],
+      [Timespan::WEEK, specific_days]
+    ]
+
+    expected_shifts = {
+      [Timespan::WEEK, Interval::DAY] => ["sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"],
+      [Timespan::WEEK, Interval::WEEKDAY] => ["monday", "tuesday", "wednesday", "thursday", "friday"],
+      [Timespan::WEEK, specific_days] => ["tuesday", "thursday", "friday"]
+    }
+
+    people.each do |persons|
+      create_args.each do |args|
+        it "should create timespan for #{args} and #{persons}" do
+          cw = ChoreWheel.new(persons, *args)
+          expect(cw.shifts).to eq(expected_shifts[args])
+
+          check_even_distribution(cw)
+        end
+      end
+    end
+  end
+
+  describe "workers_per_shift" do
+    before :each do
+      @cw = ChoreWheel.new([:adit, :maggie], Timespan::WEEK, Interval::WEEKDAY, {:workers_per_shift => 2})
+    end
+    it "should assign 2 workers per shift" do
+      @cw.workers.each do |arr|
+        expect(arr.size).to eq(2)
+      end
+    end
+
+    it "should assign the shifts evenly" do
+      check_even_distribution(@cw)
+    end
+  end
+
+  describe "hash" do
+    it "should convert to json correctly" do
+      cw = ChoreWheel.new([:adit, :maggie], Timespan::WEEK, Interval::DAY, {:workers_per_shift => 2})
+      chunks = cw.chunks
+
+      expected = {
+        "people" => [:adit, :maggie],
+        "timespan" => Timespan::WEEK,
+        "interval" => Interval::DAY,
+        "workers_per_shift" => 2,
+        "chunks" => chunks
+      }
+
+      expect(cw.to_hash).to eq(expected)
+    end
+
+    it "should convert from json correctly" do
+      cw = ChoreWheel.new([:adit, :maggie], Timespan::WEEK, Interval::DAY, {:workers_per_shift => 2})
+      chunks = cw.chunks
+
+      hash = cw.to_hash
+
+      cw2 = ChoreWheel.from_hash hash
+
+      expect(cw2.people).to eq([:adit, :maggie])
+      expect(cw2.timespan).to eq(Timespan::WEEK)
+      expect(cw2.interval).to eq(Interval::DAY)
+      expect(cw2.workers_per_shift).to eq(2)
+      expect(cw2.chunks).to eq(chunks)
+    end
+
+    it "should convert back and forth correctly" do
+      cw = ChoreWheel.new([:adit, :maggie], Timespan::WEEK, Interval::DAY, {:workers_per_shift => 2})
+      hash = cw.to_hash
+      cw2 = ChoreWheel.from_hash hash
+      expect(cw).to eq(cw2)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,122 @@
+require "timespan"
+require "interval"
+require "chorewheel"
+require File.expand_path(File.join(__FILE__, "../support"))
+require File.expand_path(File.join(__FILE__, "../fixtures/fixtures"))
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.pattern = "*.rb"
+
+  # Only load tests who's syntax is valid in the current Ruby
+  [1.9, 2.0, 2.1].each do |ver|
+    config.pattern << ",ruby_version_specific/*#{ver}.rb" if ruby_version >= ver
+  end
+
+  # 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
+
+  # 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
+
+  # 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
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  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
+  # Unable to use it now
+  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
+
+  # Callbacks
+  config.after :each do
+    ::Contract.restore_failure_callback
+  end
+end
+
+def check_even_distribution cw
+  # get the number of shifts for each person
+  shifts = cw.people.map do |name|
+    cw.count do |shift, workers|
+      workers.include?(name)
+    end
+  end
+
+  # each person should have not more than 1 away from the avg number of shifts
+  avg = shifts.inject(:+) / shifts.size.to_f
+
+  cw.people.zip(shifts).each do |name, shift|
+    if (shift - avg).abs > 1
+      raise "Person #{name} is doing #{shift} shifts, but the average is #{avg}."
+    end
+  end
+end

data/spec/support.rb

@@ -0,0 +1,3 @@
+def ruby_version
+  RUBY_VERSION.match(/\d+\.\d+/)[0].to_f
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: chorewheel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Aditya Bhargava
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contracts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Make a chore wheel, with options for specifying multiple people, vacation
+  days, etc.
+email: bluemangroupie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
+- CHANGELOG.markdown
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.markdown
+- chorewheel.gemspec
+- lib/chorewheel.rb
+- lib/interval.rb
+- lib/person.rb
+- lib/timespan.rb
+- lib/util.rb
+- spec/chorewheel_spec.rb
+- spec/fixtures/fixtures.rb
+- spec/spec_helper.rb
+- spec/support.rb
+homepage: http://github.com/egonSchiele/chorewheel
+licenses: []
+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.8
+signing_key: 
+specification_version: 4
+summary: Simple chore scheduler in Ruby.
+test_files: []