rotation 0.0.1

data/.gitignore

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

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Marcelo Silveira. http://www.mhfs.com.br
+
+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,56 @@
+Rotation
+========
+
+Rotation is a simple command line utility to help you rotate any kind of
+stuff over time. It was originally created to help control code review
+rotation among the members of a team.
+
+Currently it only rotates by any given number of weeks. More units
+planned for the future.
+
+Installation
+------------
+
+Install the gem:
+
+    gem install rotation
+
+Usage
+-----
+
+Create your first rotation topic:
+
+    rotation init topic_name
+
+This will create a `~/.rotation` file. It's a yaml file that will look
+like:
+
+    topic_name:
+      start_date: 2011-09-12
+      duration: 1
+      first: Huey
+      candidates:
+      - Huey
+      - Dewey
+      - Louie
+
+Tweak the file for your needs. Notice that you can create as many topics
+as you want.
+
+See who's in charge by typing:
+
+    rotation responsible topic_name
+
+If you want to check the responsible of each of your topics type:
+
+    rotation responsibles
+
+Author and License
+------------------
+
+Marcelo Silveira :: marcelo@mhfs.com.br :: @mhfsilveira
+
+Released under the MIT License. See the [LICENSE][license] file for further
+details.
+
+[license]: https://github.com/mhfs/rotation/blob/master/MIT-LICENSE

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/rotation

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "rotation"
+
+Rotation::CLI.start

data/lib/rotation.rb

@@ -0,0 +1,9 @@
+require "date"
+require "yaml"
+
+module Rotation
+  autoload :Version,       "rotation/version"
+  autoload :Configuration, "rotation/configuration"
+  autoload :Topic,         "rotation/topic"
+  autoload :CLI,           "rotation/cli"
+end

data/lib/rotation/cli.rb

@@ -0,0 +1,37 @@
+require "thor"
+
+module Rotation
+  class CLI < Thor
+    CONFIG_PATH = File.expand_path("~/.rotation")
+
+    desc "init TOPIC", "Init a new dummy topic config in your ~/.rotation file."
+    def init(topic_name)
+      config = File.exists?(CONFIG_PATH) ? YAML.load_file(CONFIG_PATH) : {}
+      config[topic_name] = { "duration" => 1, "start_date" => Date.today, "first" => "Huey", "candidates" => ["Huey", "Dewey", "Louie"] }
+      File.open(CONFIG_PATH, "w") do |out|
+        YAML.dump(config, out)
+      end
+    end
+
+    desc "responsibles", "Gives the responsibles for all your configured topics"
+    def responsibles
+      load_settings
+      Configuration.config_store.each do |name, topic|
+        say_status(name, topic.responsible)
+      end
+    end
+
+    desc "responsible TOPIC", "Tells you who is in charge for a given topic."
+    def responsible(topic_name)
+      load_settings
+      topic = Configuration.fetch(topic_name)
+      say_status(topic_name, topic.responsible)
+    end
+
+    protected
+
+    def load_settings
+      Configuration.load(CONFIG_PATH)
+    end
+  end
+end

data/lib/rotation/configuration.rb

@@ -0,0 +1,18 @@
+module Rotation
+  module Configuration
+    extend self
+
+    def load(config_path = "~/.rotation")
+      configs = YAML.load_file(config_path)
+      configs.each { |topic_name, params| config_store[topic_name] = Topic.new(topic_name, params) }
+    end
+
+    def config_store
+      @config ||= {}
+    end
+
+    def fetch(topic_name)
+      config_store[topic_name]
+    end
+  end
+end

data/lib/rotation/topic.rb

@@ -0,0 +1,31 @@
+module Rotation
+  class Topic
+    attr_accessor :name, :duration, :start_date, :first, :candidates
+
+    def initialize(topic_name, params)
+      @name       = topic_name
+      @duration   = params["duration"]
+      @start_date = params["start_date"]
+      @first      = params["first"]
+      @candidates = params["candidates"]
+    end
+
+    def responsible(date = Date.today)
+      candidates[responsible_index(date)]
+    end
+
+    def responsible_index(date)
+      unit_delta = week_delta(start_date, date)
+      (cycle(unit_delta) + candidates.index(first)) % candidates.size
+    end
+
+    def cycle(unit_delta)
+      (unit_delta / duration.to_f).floor
+    end
+
+    def week_delta(d1, d2)
+      year_difference = (d2.year - d1.year) * 52
+      year_difference + (d2 - d2.wday).yday / 7 - (d1 -d1.wday).yday / 7
+    end
+  end
+end

data/lib/rotation/version.rb

@@ -0,0 +1,3 @@
+module Rotation
+  VERSION = "0.0.1"
+end

data/rotation.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rotation/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rotation"
+  s.version     = Rotation::VERSION
+  s.authors     = ["Marcelo Silveira"]
+  s.email       = ["marcelo@mhfs.com.br"]
+  s.homepage    = "https://github.com/mhfs/rotation/"
+  s.summary     = %q{Command line utility to help you control rotation of stuff over time}
+  s.description = %q{Rotation is a quick utility to help you rotate any kind of stuff over time. I created it to control code review rotation among the team members.}
+
+  s.rubyforge_project = "rotation"
+
+  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_development_dependency "rake"
+  s.add_development_dependency "contest"
+  s.add_development_dependency "redgreen"
+
+  s.add_runtime_dependency "thor"
+end

data/test/configuration_test.rb

@@ -0,0 +1,20 @@
+require "test_helper"
+
+class ConfigurationTest < Test::Unit::TestCase
+  setup do
+    Rotation::Configuration.load("./test/fixtures/sample_config.yml")
+  end
+
+  test "load settings from file" do
+    assert Rotation::Configuration.fetch("cool_topic").is_a?(Rotation::Topic)
+  end
+
+  test "correctly feed topics" do
+    topic = Rotation::Configuration.fetch("cool_topic")
+    assert_equal "cool_topic", topic.name
+    assert_equal 2, topic.duration
+    assert_equal Date.new(2011, 9, 13), topic.start_date
+    assert_equal "one", topic.first
+    assert_equal ["one", "two", "three"], topic.candidates
+  end
+end

data/test/fixtures/sample_config.yml

@@ -0,0 +1,5 @@
+cool_topic:
+  duration: 2
+  start_date: 2011-09-13
+  first: one
+  candidates: [one, two, three]

data/test/rotation_test.rb

@@ -0,0 +1,4 @@
+require "test_helper"
+
+class RotationTest < Test::Unit::TestCase
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require "test/unit"
+require "contest"
+require "redgreen"
+
+require "rotation"

data/test/topic_test.rb

@@ -0,0 +1,84 @@
+require "test_helper"
+
+class TopicTest < Test::Unit::TestCase
+  setup do
+    @topic = Rotation::Topic.new("test_topic", {
+      "duration"   => 2,
+      "start_date" => Date.new(2011, 9, 5),
+      "first"      => "one",
+      "candidates" => ["one", "two", "three"]
+    })
+  end
+
+  context "#week_delta" do
+    test "is 0 for same week" do
+      assert_equal 0, @topic.week_delta(@topic.start_date, Date.new(2011, 9, 10))
+    end
+
+    test "is 1 for next week" do
+      assert_equal 1, @topic.week_delta(@topic.start_date, Date.new(2011, 9, 11))
+    end
+
+    test "is -1 for previous week" do
+      assert_equal -1, @topic.week_delta(@topic.start_date, Date.new(2011, 9, 3))
+    end
+
+    test "is not negative for lower dates in following years" do
+      assert_equal 17, @topic.week_delta(@topic.start_date, Date.new(2012, 1, 3))
+    end
+
+    test "is negative for higher dates in previous years" do
+      assert_equal -36, @topic.week_delta(@topic.start_date, Date.new(2010, 12, 31))
+    end
+  end
+
+  context "#cycle" do
+    test "is 0 for up to duration value" do
+      assert_equal 0, @topic.cycle(0)
+      assert_equal 0, @topic.cycle(1)
+    end
+
+    test "is 1 for up to twice the duration value" do
+      assert_equal 1, @topic.cycle(2)
+      assert_equal 1, @topic.cycle(3)
+    end
+
+    test "is 2 for up to three time the duration value" do
+      assert_equal 2, @topic.cycle(4)
+      assert_equal 2, @topic.cycle(5)
+    end
+  end
+
+  context "#responsible_index and #responsible" do
+    test "is 0 in the first cycle" do
+      date = Date.new(2011, 9, 10)
+      assert_equal 0,     @topic.responsible_index(date)
+      assert_equal "one", @topic.responsible(date)
+    end
+
+    test "is 1 for second cycle" do
+      date = Date.new(2011, 9, 18)
+      assert_equal 1,     @topic.responsible_index(date)
+      assert_equal "two", @topic.responsible(date)
+    end
+
+    test "is 2 for third cycle" do
+      date = Date.new(2011, 10, 8)
+      assert_equal 2,       @topic.responsible_index(date)
+      assert_equal "three", @topic.responsible(date)
+    end
+
+    test "is 0 again for fourth cycle" do
+      date = Date.new(2011, 10, 22)
+      assert_equal 0,     @topic.responsible_index(date)
+      assert_equal "one", @topic.responsible(date)
+    end
+
+    test "is 2 for first cycle if first candidate says so" do
+      @topic.first = "three"
+      date = Date.new(2011, 9, 10)
+      assert_equal 2,       @topic.responsible_index(date)
+      assert_equal "three", @topic.responsible(date)
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: rotation
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Marcelo Silveira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-12 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: contest
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: redgreen
+  prerelease: false
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: thor
+  prerelease: false
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  requirement: *id004
+description: Rotation is a quick utility to help you rotate any kind of stuff over time. I created it to control code review rotation among the team members.
+email: 
+- marcelo@mhfs.com.br
+executables: 
+- rotation
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/rotation
+- lib/rotation.rb
+- lib/rotation/cli.rb
+- lib/rotation/configuration.rb
+- lib/rotation/topic.rb
+- lib/rotation/version.rb
+- rotation.gemspec
+- test/configuration_test.rb
+- test/fixtures/sample_config.yml
+- test/rotation_test.rb
+- test/test_helper.rb
+- test/topic_test.rb
+has_rdoc: true
+homepage: https://github.com/mhfs/rotation/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rotation
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Command line utility to help you control rotation of stuff over time
+test_files: 
+- test/configuration_test.rb
+- test/fixtures/sample_config.yml
+- test/rotation_test.rb
+- test/test_helper.rb
+- test/topic_test.rb