time_distribution 0.0.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c080fc58f25088d05f155ce39623ac9c2e3fe478
+  data.tar.gz: 7725aa3312d2d3150d2c81cfc41f39887f512125
+SHA512:
+  metadata.gz: 2dca2300f821cc40577f766f0a6d857ac4aad9c1a5e645896fd2ff2f9f4a8ce9fcbe46d8101dc86acbe797f79096fa69e8f168f9e439b824e66126d7a04e6ac9
+  data.tar.gz: 020146a4fbe9ed8008d39baecc586d54b49f22a0160b0a0ee0ac10d22a1388c2f242257e9468a673a5dac65c30b3c3212e80876003c0f912e0771c851f564ef1

data/Rakefile

@@ -1 +1,12 @@
+#!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "lib" << 'spec/support'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = false
+  t.warning = false # pry-rescue has a lot of warnings
+end

data/lib/time_distribution/smart_duration.rb

@@ -2,21 +2,24 @@ require 'chronic'
 require 'chronic_duration'
 require 'ruby-duration'
 
-require_relative 'time'
+require 'time_distribution/time'
 
-module SmartDuration
-  def self.parse(time_period)
-    # If the time period has is something like 1:00pm to 1:30pm or 1-2, interpret it as a range
-    time_of_day_pattern = '\d+:?\d*[ap]?m?'
-    
-    Duration.new(
-      if time_period.to_s.downcase.match(
-        /(#{time_of_day_pattern})\s*(to|-)\s*(#{time_of_day_pattern})/
+using TimeDistribution::TimeRefinement
+module TimeDistribution
+  module SmartDuration
+    def self.parse(time_period)
+      # If the time period has is something like 1:00pm to 1:30pm or 1-2, interpret it as a range
+      time_of_day_pattern = '\d+:?\d*[ap]?m?'
+
+      Duration.new(
+        if time_period.to_s.downcase.match(
+          /(#{time_of_day_pattern})\s*(to|-)\s*(#{time_of_day_pattern})/
+        )
+          Chronic.parse($1).count_forward_to(Chronic.parse($3))
+        else
+          ChronicDuration.parse(time_period)
+        end
       )
-        Chronic.parse($1).count_forward_to(Chronic.parse($3))
-      else
-        ChronicDuration.parse(time_period)
-      end
-    )
+    end
   end
 end

data/lib/time_distribution/task.rb

@@ -1,21 +1,16 @@
-require 'chronic_duration'
+require 'time_distribution/smart_duration'
 
-require_relative 'smart_duration'
+module TimeDistribution
+  class Task
+    attr_reader :subject, :time_taken, :desc
 
-class Task
-  attr_reader :subject, :time_taken, :desc
-
-  # @param [#to_s] subject The subject on which the task was completed. E.g. A course or project.
-  # @param [#to_s] time_taken The amount of time taken on the task (Compatible with +ChronicDuration+ parsing, or a range of times that conform to +Chronic+ parsing).
-  # @param [#to_s] desc The task's description.
-  def initialize(subject, time_taken, desc)
-    @subject = subject
-    @time_taken = SmartDuration.parse(time_taken)
-    @desc = desc
-  end
-
-  def to_s
-    # @todo Format time properly
-    "#{ChronicDuration.parse(@time_taken.total)} spent on #{@subject}: #{@desc}"
+    # @param [#to_s] subject The subject on which the task was completed. E.g. A course or project.
+    # @param [#to_s] time_taken The amount of time taken on the task (Compatible with +ChronicDuration+ parsing, or a range of times that conform to +Chronic+ parsing).
+    # @param [#to_s] desc The task's description.
+    def initialize(subject, time_taken, desc)
+      @subject = subject
+      @time_taken = SmartDuration.parse(time_taken)
+      @desc = desc
+    end
   end
 end

data/lib/time_distribution/time.rb

@@ -1,11 +1,15 @@
 require 'chronic'
 
-class Time
-  def count_forward_to(time)
-    if self > time
-      (Chronic.parse('11:59:59pm') - self) + (time - Chronic.parse('12:00:00am')) + 1
-    else 
-      time - self
+module TimeDistribution
+  module TimeRefinement
+    refine Time do
+      def count_forward_to(time)
+        if self > time
+          (Chronic.parse('11:59:59pm') - self) + (time - Chronic.parse('12:00:00am')) + 1
+        else
+          time - self
+        end
+      end
     end
   end
-end
+end

data/lib/time_distribution/version.rb

@@ -1,3 +1,3 @@
 module TimeDistribution
-  VERSION = "0.0.1"
+  VERSION = "1.0.0"
 end

data/lib/time_distribution/work_day.rb

@@ -1,29 +1,31 @@
 require 'chronic'
 require 'ruby-duration'
 
-class WorkDay
-  attr_reader :date, :tasks
+module TimeDistribution
+  class WorkDay
+    attr_reader :date, :tasks
 
-  # @param [#to_s] date Date of this work day in +Chronic+ compatible format.
-  # @param [Array<Task>] tasks List of tasks done in this work day. Defaults to an empty list.
-  def initialize(date, tasks=[])
-    @date = Chronic.parse(date)
-    @tasks = tasks
-  end
+    # @param [#to_s] date Date of this work day in +Chronic+ compatible format.
+    # @param [Array<Task>] tasks List of tasks done in this work day. Defaults to an empty list.
+    def initialize(date, tasks=[])
+      @date = Chronic.parse(date)
+      @tasks = tasks
+    end
 
-  # @param [Task] task Adds +task+ to the list of tasks completed on this work day.
-  def add_task!(task)
-    @tasks << task
+    # @param [Task] task Adds +task+ to the list of tasks completed on this work day.
+    def add_task!(task)
+      @tasks << task
 
-    self
-  end
+      self
+    end
 
-  def time_worked
-    times = {}
-    @tasks.inject({}) do |times, t|
-      times[t.subject] = Duration.new(0) unless times[t.subject]
-      times[t.subject] += t.time_taken
-      times
+    def time_worked
+      times = {}
+      @tasks.inject({}) do |times, t|
+        times[t.subject] = Duration.new(0) unless times[t.subject]
+        times[t.subject] += t.time_taken
+        times
+      end
     end
   end
 end

data/lib/time_distribution.rb

@@ -1,9 +1,10 @@
-require_relative "time_distribution/version"
+require "time_distribution/version"
 
-require_relative 'time_distribution/time'
+require 'time_distribution/time'
+
+require 'time_distribution/smart_duration'
+require 'time_distribution/task'
+require 'time_distribution/work_day'
 
 module TimeDistribution
-  require_relative 'time_distribution/smart_duration'
-  require_relative 'time_distribution/task'
-  require_relative 'time_distribution/work_day'
 end

data/spec/smart_duration_spec.rb

@@ -0,0 +1,20 @@
+require_relative 'support/spec_helper'
+
+require 'time_distribution/smart_duration'
+
+include TimeDistribution
+describe SmartDuration do
+  describe '::parse' do
+    describe 'can interpret a range of times' do
+      it 'written with "to"' do
+        SmartDuration.parse('10am to 11:30am').total.must_equal 1.5.hours
+      end
+      it 'written with "-"' do
+        SmartDuration.parse('10am-11:11am').total.must_equal 1.hours + 11.minutes
+      end
+    end
+    it 'can interpret an explicit range' do
+      SmartDuration.parse('1 hour 30 minutes').total.must_equal 1.5.hours
+    end
+  end
+end

data/spec/support/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'minitest/spec'
+require 'minitest/pride'
+require 'minitest/mock'
+
+require 'turn'
+Turn.config do |c|
+  # use one of output formats:
+  # :outline  - turn's original case/test outline mode [default]
+  # :progress - indicates progress with progress bar
+  # :dotted   - test/unit's traditional dot-progress mode
+  # :pretty   - new pretty reporter
+  # :marshal  - dump output as YAML (normal run mode only)
+  # :cue      - interactive testing
+  c.format  = :dotted
+  # use humanized test names (works only with :outline format)
+  c.natural = true
+end
+
+require 'awesome_print'
+module Minitest::Assertions
+  def mu_pp(obj)
+    obj.awesome_inspect
+  end
+end
+
+require 'pry-rescue/minitest'
+
+require 'ruby-duration'

data/spec/task_spec.rb

@@ -0,0 +1,22 @@
+require_relative 'support/spec_helper'
+
+require 'time_distribution/task'
+require 'time_distribution/smart_duration'
+
+include TimeDistribution
+
+describe Task do
+  describe '#new' do
+    it 'works for three arguments' do
+      x_subject = 'subject'
+      x_time_taken = '10 min'
+      x_description = 'interesting description'
+
+      patient = Task.new(x_subject, x_time_taken, x_description)
+
+      patient.subject.must_equal x_subject
+      patient.time_taken.must_equal SmartDuration.parse(x_time_taken)
+      patient.desc.must_equal x_description
+    end
+  end
+end

data/spec/time_spec.rb

@@ -0,0 +1,23 @@
+require_relative 'support/spec_helper'
+require 'time_distribution/time'
+require 'chronic'
+
+include TimeDistribution
+using TimeRefinement
+
+describe Time do
+  describe '#count_forward_to' do
+    it 'counts duration properly when both times are in AM' do
+      Chronic.parse('10am').count_forward_to(Chronic.parse('11:30am')).must_equal 1.5.hours
+    end
+    it 'counts duration properly when both times are in PM' do
+      Chronic.parse('10pm').count_forward_to(Chronic.parse('11:30pm')).must_equal 1.5.hours
+    end
+    it 'counts duration properly when it crosses from AM to PM' do
+      Chronic.parse('11am').count_forward_to(Chronic.parse('12:30pm')).must_equal 1.5.hours
+    end
+    it 'counts duration properly when it crosses from PM to AM' do
+      Chronic.parse('11pm').count_forward_to(Chronic.parse('12:30am')).must_equal 1.5.hours
+    end
+  end
+end

data/spec/work_day_spec.rb

@@ -0,0 +1,37 @@
+require_relative 'support/spec_helper'
+
+require 'time_distribution/work_day'
+
+include TimeDistribution
+describe WorkDay do
+  before do
+    t1 = MiniTest::Mock.new
+    t2 = MiniTest::Mock.new
+    @x_date = 'May 7, 2013'
+    @x_tasks = [t1, t2]
+    @patient = WorkDay.new @x_date, @x_tasks
+
+    @patient.date.must_equal Chronic.parse(@x_date)
+    @patient.tasks.must_equal @x_tasks
+  end
+  describe '#add_task!' do
+    it 'works' do
+      t3 = MiniTest::Mock.new
+      @patient.add_task!(t3).must_equal @patient
+      @patient.tasks.must_equal (@x_tasks << t3)
+    end
+  end
+  describe 'time_worked' do
+    it 'works' do
+      time_taken_for_each_task = 23
+      x_subject = 'my subject'
+      @x_tasks.each do |mock_task|
+        mock_task.expect(:subject, x_subject)
+        mock_task.expect(:subject, x_subject)
+        mock_task.expect(:subject, x_subject)
+        mock_task.expect(:time_taken, time_taken_for_each_task)
+      end
+      @patient.time_worked.must_equal ({x_subject => Duration.new(@x_tasks.length * time_taken_for_each_task)})
+    end
+  end
+end

data/time_distribution.gemspec

@@ -18,9 +18,14 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "chronic"
-  gem.add_dependency "chronic_duration"
-  gem.add_dependency "ruby-duration"
-  
-  gem.add_development_dependency "rake"
+  gem.add_dependency "chronic", '~> 0.9'
+  gem.add_dependency "chronic_duration", '~> 0.10'
+  gem.add_dependency "ruby-duration", '~> 3.0'
+
+  gem.add_development_dependency "rake", '~> 10.0'
+  gem.add_development_dependency "turn", '~> 0.9'
+  gem.add_development_dependency "awesome_print", '~> 1.1'
+  gem.add_development_dependency "minitest", '~> 4.7'
+  gem.add_development_dependency "pry-rescue", '~> 1.1'
+  gem.add_development_dependency "simplecov", '~> 0.7'
 end

metadata

@@ -1,80 +1,141 @@
 --- !ruby/object:Gem::Specification
 name: time_distribution
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Dustin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2013-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: chronic_duration
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: ruby-duration
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: Gem for creating time distribution management systems
 email:
 - morrill@ualberta.ca
@@ -93,31 +154,39 @@ files:
 - lib/time_distribution/time.rb
 - lib/time_distribution/version.rb
 - lib/time_distribution/work_day.rb
+- spec/smart_duration_spec.rb
+- spec/support/spec_helper.rb
+- spec/task_spec.rb
+- spec/time_spec.rb
+- spec/work_day_spec.rb
 - time_distribution.gemspec
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0.rc.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Gem for creating time distribution management systems
-test_files: []
-has_rdoc: 
+test_files:
+- spec/smart_duration_spec.rb
+- spec/support/spec_helper.rb
+- spec/task_spec.rb
+- spec/time_spec.rb
+- spec/work_day_spec.rb