gradesfirst 0.6.0 → 0.6.1

data/Gemfile

@@ -7,3 +7,4 @@ gem 'webmock', '~> 1.16.0'
 gem 'pry'
 gem 'pry-debugger'
 gem 'http_magic', '~> 0.1'
+gem 'dotenv'

data/Gemfile.lock

@@ -12,6 +12,9 @@ GEM
       debugger-ruby_core_source (~> 1.2.4)
     debugger-linecache (1.2.0)
     debugger-ruby_core_source (1.2.4)
+    dotenv (0.11.1)
+      dotenv-deployment (~> 0.0.2)
+    dotenv-deployment (0.0.2)
     http_magic (0.1.1)
     method_source (0.8.2)
     minitest (4.7.5)
@@ -34,6 +37,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  dotenv
   http_magic (~> 0.1)
   minitest (~> 4.7.0)
   pry

data/gradesfirst.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
   s.name = "gradesfirst"
-  s.version = "0.6.0"
+  s.version = "0.6.1"
   s.summary = "GradesFirst command line utility for developers."
   s.description = "This utility will help manage the various tasks developers need to do on their workstation such as database updates."
   s.license = "MIT"
@@ -24,5 +24,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency('thor', '~> 0.18.1')
   s.add_dependency('http_magic', '~> 0.1.2')
+  s.add_dependency('dotenv', '~> 0.11.1')
   s.add_development_dependency('minitest', '~> 4.7.0')
 end

data/lib/gradesfirst/cli.rb

@@ -21,6 +21,7 @@ module GradesFirst
     end
 
     desc 'codetalk', GradesFirst::CodeTalkCommand.description
+    long_desc GradesFirst::CodeTalkCommand.long_description
     def codetalk
       execute GradesFirst::CodeTalkCommand
     end
@@ -32,6 +33,7 @@ module GradesFirst
     end
 
     desc 'pair', GradesFirst::PairCommand.description
+    long_desc GradesFirst::PairCommand.long_description
     def pair
       execute GradesFirst::PairCommand
     end

data/lib/gradesfirst/code_talk_command.rb

@@ -8,6 +8,36 @@ module GradesFirst
       'Show the next dates for code talks.'
     end
 
+    # Description of the "gf codetalk" command that will be used in the
+    # commandline help to provide a complete description.
+    def self.long_description
+      <<-LONG_DESCRIPTION
+      Code talk dates are calculated based on a zero day date and the list
+      of people who can give code talks.  The dates are based on a simple
+      rotation.
+
+      In order for this command to work correctly, the environment variables
+      GF_DAY_ZERO and GF_CODE_TALKERS need to be properly defined.  These can
+      be actual environment variables, a .env file, or .env.master file.  The
+      .env file can be in the current directory or the home directory.  The
+      .env.master file must be in the current directory.  The precedence order
+      is environment variables, .env in the current directory, .env in the
+      home directory, and .env.master in the current directory.  It is
+      recommended that .env.master be committed to source control and the
+      other options used to override .env.master.
+
+      GF_DAY_ZERO is a date in a valid Ruby date string format.
+
+      GF_CODE_TALKERS is a pipe (|) delimited list of names.
+
+      Examples:
+
+      GF_DAY_ZERO="2014-3-10 00:00:00"
+
+      GF_CODE_TALKERS="Anthony Crumley|Tom Miller|Andrew Sellers"
+      LONG_DESCRIPTION
+    end
+
     # Performs the gf codetalk command with show the code talk assignments
     # for the next round of talks.
     def execute
@@ -31,16 +61,7 @@ module GradesFirst
     end
 
     def code_talkers
-      [
-        "Anthony Crumley",
-        "Tom Miller",
-        "Andrew Sellers",
-        "Matt Turney",
-        "Zac Williams",
-        "Ben Holley",
-        "Chris Collins",
-        "Evan Travers"
-      ].sort
+      config.code_talkers.sort
     end
 
     def next_code_talkers

data/lib/gradesfirst/command.rb

@@ -2,12 +2,12 @@ require 'gradesfirst'
 
 module GradesFirst
 
-  # Base class for all command objects.
+  # Base class for all command objects
   class Command
 
     private
 
-    # Retrieves the current git branch.
+    # Retrieves the current git branch
     def current_branch
       `git rev-parse --abbrev-ref HEAD`
     end
@@ -17,7 +17,7 @@ module GradesFirst
       PivotalTracker.stories[story_id].get
     end
 
-    # Extracts a PivotalTracker story id from a branch if one is present.
+    # Extracts a PivotalTracker story id from a branch if one is present
     def story_id(branch = current_branch)
       if branch =~ /[0-9]+$/
         branch.match(/[0-9]+$/)[0]
@@ -26,10 +26,14 @@ module GradesFirst
       end
     end
 
-    # Currently hard coded to return the beginning of a GradesFirst sprint but
-    # could be put in a configuration file in the future.
+    # Configuration for the current project
+    def config
+      @configuration ||= GradesFirst::Config.new
+    end
+
+    # The beginning date of a sprint
     def day_zero
-      Time.parse("2014-3-10 00:00:00")
+      config.day_zero
     end
   end
 end

data/lib/gradesfirst/config.rb

@@ -0,0 +1,33 @@
+require 'dotenv'
+
+module GradesFirst
+  class Config
+    def initialize
+      Dotenv.load(*GradesFirst::Config.load_paths)
+    end
+
+    def self.load_paths
+      @@load_paths ||= [".env", "~/.env", ".env.master"]
+    end
+
+    def self.load_paths=(paths)
+      @@load_paths = paths
+    end
+
+    def code_talkers
+      ENV["GF_CODE_TALKERS"].to_s.split("|")
+    end
+
+    def day_zero
+      if ENV["GF_DAY_ZERO"].nil?
+        Time.now
+      else
+        Time.parse(ENV["GF_DAY_ZERO"])
+      end
+    end
+
+    def developers
+      ENV["GF_DEVELOPERS"].to_s.split("|")
+    end
+  end
+end

data/lib/gradesfirst/pair_command.rb

@@ -11,6 +11,36 @@ module GradesFirst
       'Show the current developer pairings.'
     end
 
+    # Description of the "gf pair" Thor commeand that will be used in the
+    # commandline help to provide a complete description.
+    def self.long_description
+      <<-LONG_DESCRIPTION
+      Developer pairings are calculated based on a zero day date and the list
+      people who are developers.  The actual pairings are made by a round robin
+      tournament algorithm.
+
+      In order for this command to work correctly, the environment variables
+      GF_DAY_ZERO and GF_DEVELOPERS need to be properly defined.  These can
+      be actual environment variables, a .env file, or .env.master file.  The
+      .env file can be in the current directory or the home directory.  The
+      .env.master file must be in the current directory.  The precedence order
+      is environment variables, .env in the current directory, .env in the
+      home directory, and .env.master in the current directory.  It is
+      recommended that .env.master be committed to source control and the
+      other options used to override .env.master.
+
+      GF_DAY_ZERO is a date in a valid Ruby date string format.
+
+      GF_DEVELOPERS is a pipe (|) delimited list of names.
+
+      Examples:
+
+      GF_DAY_ZERO="2014-3-10 00:00:00"
+
+      GF_DEVELOPERS="Anthony Crumley|Tom Miller|Andrew Sellers"
+      LONG_DESCRIPTION
+    end
+
     # Performs the gf pair Thor command which determines the current
     # developer pairings.
     def execute
@@ -31,14 +61,7 @@ module GradesFirst
     def developers
       return @developers unless @developers.nil?
 
-      @developers = [
-        "Anthony Crumley",
-        "Tom Miller",
-        "Andrew Sellers",
-        "Matt Turney",
-        "Zac Williams",
-        "Ben Holley"
-      ].sort
+      @developers = config.developers.sort
       @developers << nil if @developers.length.odd?
 
       @developers

data/test/code_talk_command_test.rb

@@ -15,7 +15,11 @@ describe GradesFirst::CodeTalkCommand do
   end
 
   specify '#execute schedules code talks correctly' do
-    @command.stub :code_talkers, @code_talkers do
+    config = OpenStruct.new(
+      code_talkers: @code_talkers,
+      day_zero: Time.parse("2014-3-10 00:00:00")
+    )
+    @command.stub :config, config do
       @command.stub :today, Date.parse("2014-3-25") do
         @command.execute
         assert_equal(

data/test/command_test.rb

@@ -9,4 +9,12 @@ describe GradesFirst::Command do
   specify '#story_id returns nil if not story id' do
     assert_nil GradesFirst::Command.new.send(:story_id, 'abc')
   end
+
+  specify '#day_zero is the beginning of our first sprint' do
+    assert_equal(
+      Time.parse("2014-3-10 00:00:00"),
+      GradesFirst::Command.new.send(:day_zero),
+      'Day zero should be March 10, 2014'
+    )
+  end
 end

data/test/config_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+require 'gradesfirst/config'
+
+describe GradesFirst::Config do
+  specify '#code_talkers is the list of code talkers' do
+    code_talkers = [
+      "Anthony Crumley",
+      "Tom Miller",
+      "Andrew Sellers",
+      "Matt Turney",
+      "Zac Williams",
+      "Ben Holley",
+      "Chris Collins",
+      "Evan Travers"
+    ]
+    assert_equal(
+      code_talkers,
+      GradesFirst::Config.new.code_talkers,
+      'Configuration should return a code talker list.'
+    )
+  end
+
+  specify '#day_zero is the beginning of our first sprint' do
+    assert_equal(
+      Time.parse("2014-3-10 00:00:00"),
+      GradesFirst::Config.new.day_zero,
+      'Day zero should be March 10, 2014'
+    )
+  end
+
+  specify '#developers is the list of developers' do
+    developers = [
+      "Anthony Crumley",
+      "Tom Miller",
+      "Andrew Sellers",
+      "Matt Turney",
+      "Zac Williams",
+      "Ben Holley"
+    ]
+    assert_equal(
+      developers,
+      GradesFirst::Config.new.developers,
+      'Configuration should return a developer list.'
+    )
+  end
+end

data/test/fixtures/.env

@@ -0,0 +1,3 @@
+GF_DAY_ZERO="2014-3-10 00:00:00"
+GF_CODE_TALKERS="Anthony Crumley|Tom Miller|Andrew Sellers|Matt Turney|Zac Williams|Ben Holley|Chris Collins|Evan Travers"
+GF_DEVELOPERS="Anthony Crumley|Tom Miller|Andrew Sellers|Matt Turney|Zac Williams|Ben Holley"

data/test/fixtures/code_talk.txt

@@ -1,6 +1,6 @@
-03/25/2014 Tue - Minnie Mouse
-03/27/2014 Thu - Ironman
-04/01/2014 Tue - Mickey Mouse
-04/03/2014 Thu - Cat Woman
-04/08/2014 Tue - Wonder Woman
-04/10/2014 Thu - Superman
+03/25/2014 Tue - Superman
+03/27/2014 Thu - Wonder Woman
+04/01/2014 Tue - Cat Woman
+04/03/2014 Thu - Ironman
+04/08/2014 Tue - Mickey Mouse
+04/10/2014 Thu - Minnie Mouse

data/test/fixtures/pair.txt

@@ -1,3 +1,3 @@
-Mickey Mouse and Ironman
-Minnie Mouse and Wonder Woman
-Superman and Cat Woman
+Cat Woman and Wonder Woman
+Superman and Mickey Mouse
+Minnie Mouse and Ironman

data/test/pair_command_test.rb

@@ -15,7 +15,11 @@ describe GradesFirst::PairCommand do
   end
 
   specify '#execute pairs developers correctly' do
-    @command.stub :developers, @developers do
+    config = OpenStruct.new(
+      developers: @developers,
+      day_zero: Time.parse("2014-3-10 00:00:00")
+    )
+    @command.stub :config, config do
       @command.stub :now, Time.parse("2014-3-25 00:00:00") do
         @command.execute
       end

data/test/test_helper.rb

@@ -14,6 +14,7 @@ class MiniTest::Unit::TestCase
 
   def setup
     pivotal_tracker_setup
+    GradesFirst::Config.load_paths = ["test/fixtures/.env"]
   end
 
   # Retreive the contents of fixture files to be used in tests.  It is easier

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gradesfirst
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -43,6 +43,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +98,7 @@ files:
 - lib/gradesfirst/code_talk_command.rb
 - lib/gradesfirst/command.rb
 - lib/gradesfirst/commit_message_command.rb
+- lib/gradesfirst/config.rb
 - lib/gradesfirst/pair_command.rb
 - lib/gradesfirst/task_add_command.rb
 - lib/gradesfirst/task_cli.rb
@@ -96,6 +113,8 @@ files:
 - test/code_talk_command_test.rb
 - test/command_test.rb
 - test/commit_message_command_test.rb
+- test/config_test.rb
+- test/fixtures/.env
 - test/fixtures/code_talk.txt
 - test/fixtures/commit_message.txt
 - test/fixtures/gf_branch.txt
@@ -141,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.23.2
 signing_key: 
 specification_version: 3
 summary: GradesFirst command line utility for developers.