time_distribution 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca61f02b3f75d9e133ad3d1b67f0772608d3b632
-  data.tar.gz: de0caf7ebe59a0f171d6e320cde5a6ec2e9fd823
+  metadata.gz: 9692efc1b44adc211fba77adeccdafa2430c81d2
+  data.tar.gz: e7978438e95415dfe89328420cbfdfbd6acb7331
 SHA512:
-  metadata.gz: ea6124b5235f268aa59db971b0562129d0a330f0e481af4f5fda3f1683ade077dc03ba8da9bb118c8fe0ed8457ecdbe27da9e62c1fd7d9102a8bb641c70d2297
-  data.tar.gz: 0c1a08594abed6da6335186e0279a806eb2b186c50b4ab2a926af4dcfb1b762ff808704d9cbc6216f0b22895052e823d7993bb4c3384b2a4c978e2355df418df
+  metadata.gz: 80f72a82d439b9f0a2e964d22caf2478a8a5d72d4886f57a0958a238ab01159a3055c76163083892e85a448d1a2a619f9bee3e3023ef6bc86bdcabdc26b5aa70
+  data.tar.gz: 4d88e5afb1142fa65d999b990cc8a53bf43519e48a46a767b1432cb0df4c6b68956c377ee441f56ccbe86aa4c0be62640e2d651f395d0f348652ec433135ad74

data/lib/time_distribution/task.rb

@@ -4,6 +4,14 @@ module TimeDistribution
   class Task
     attr_reader :subject, :time_taken, :desc
 
+    def self.from_map(map_data)
+      self.new(
+        map_data['subject'].to_sym,
+        map_data['duration'],
+        map_data['description']
+      )
+    end
+
     # @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.
@@ -13,6 +21,14 @@ module TimeDistribution
       @desc = desc
     end
 
+    def ==(other)
+      (
+        other.subject == @subject &&
+        other.time_taken == @time_taken &&
+        other.desc == @desc
+      )
+    end
+
     def to_s() "#{to_headline}: #{to_desc}" end
 
     def to_desc() @desc.strip end
@@ -43,4 +59,4 @@ module TimeDistribution
       )
     end
   end
-end
+end

data/lib/time_distribution/version.rb

@@ -1,3 +1,3 @@
 module TimeDistribution
-  VERSION = "2.1.3"
+  VERSION = "2.2.0"
 end

data/lib/time_distribution/work_day.rb

@@ -2,16 +2,35 @@ require 'chronic'
 require 'ruby-duration'
 
 require 'time_distribution/task_list'
+require 'time_distribution/task'
 
 module TimeDistribution
   class WorkDay
     attr_reader :date, :tasks
 
+    def self.from_map(map_data)
+      self.new(
+        map_data['date'],
+        *(map_data['tasks'].map { |t| Task.from_map t })
+      )
+    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 = TaskList.new(*tasks)
+      @tasks = if tasks.length == 1 && !tasks.first.is_a?(Task)
+        TaskList.new(*tasks)
+      else
+        TaskList.new(tasks)
+      end
+    end
+
+    def ==(other)
+      (
+        @date == other.date &&
+        @tasks == other.tasks
+      )
     end
 
     # @param [Task] task Adds +task+ to the list of tasks completed on this work day.
@@ -44,4 +63,4 @@ module TimeDistribution
       )
     end
   end
-end
+end

data/lib/time_distribution/work_day_collection.rb

@@ -12,6 +12,10 @@ module TimeDistribution
 
     MONTHS = [:january, :february, :march, :april, :may, :june, :july, :august, :september, :october, :november, :december]
 
+    def self.from_map(map_data)
+      self.new(*map_data.map { |t| WorkDay.from_map t })
+    end
+
     private
     def provide_methods_for_setting_work_days_in_months
       MONTHS.each do |m|

data/spec/task_spec.rb

@@ -1,4 +1,5 @@
 require_relative 'support/spec_helper'
+require 'yaml'
 
 require 'time_distribution/task'
 require 'time_distribution/smart_duration'
@@ -6,6 +7,28 @@ require 'time_distribution/smart_duration'
 include TimeDistribution
 
 describe Task do
+  let(:yml_string_data) do
+    <<-END
+subject: :time_distribution
+duration: 3:38pm to 4pm
+description: |
+  - Comment 1
+  - Comment 2
+END
+  end
+
+
+  describe '#from_map' do
+    it 'works' do
+      map_data = YAML.load(yml_string_data)
+      patient = Task.from_map(map_data)
+
+      patient.subject.must_equal map_data['subject']
+      patient.time_taken.must_equal SmartDuration.parse(map_data['duration'])
+      patient.desc.must_equal map_data['description']
+    end
+  end
+
   describe '#new' do
     it 'works for three arguments' do
       x_subject = 'subject'

data/spec/work_day_collection_spec.rb

@@ -1,9 +1,58 @@
 require_relative 'support/spec_helper'
 
 require 'time_distribution/work_day_collection'
+require 'time_distribution/work_day'
 
 include TimeDistribution
+
+
 describe WorkDayCollection do
+  let(:yml_string_data) do
+    <<-END
+-
+  date: April 21, 2016
+  tasks:
+    -
+      subject: :time_distribution
+      duration: 6:38pm to 7pm
+      description: |
+        - Comment 1
+        - Comment 2
+    -
+      subject: :aaaaaa
+      duration: 4:38am to 6pm
+      description: |
+        - Ahdkjlan akjdlnkfn
+-
+  date: April 20, 2016
+  tasks:
+    -
+      subject: :time_distribution
+      duration: 6:38pm to 7pm
+      description: |
+        - Comment 3
+        - Comment 4
+    -
+      subject: :bbbbb
+      duration: 4:38am to 6pm
+      description: |
+        - jkljkljlkj syowueiorue
+END
+  end
+
+
+  describe '#from_map' do
+    let(:patient) do
+      map_data = YAML.load(yml_string_data)
+      _patient = WorkDayCollection.from_map map_data
+      _patient.must_equal map_data.map { |t| WorkDay.from_map t }
+      _patient
+    end
+    it 'works' do
+      patient
+    end
+  end
+
   describe '#new' do
     it 'with days only' do
       patient = WorkDayCollection.new('d1', 'd2')
@@ -295,4 +344,4 @@ END
       }
     )
   end
-end
+end

data/spec/work_day_spec.rb

@@ -1,52 +1,89 @@
 require_relative 'support/spec_helper'
+require 'yaml'
 
 require 'time_distribution/work_day'
+require 'time_distribution/task'
 
 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
+  let(:yml_string_data) do
+    <<-END
+date: April 21, 2016
+tasks:
+  -
+    subject: :time_distribution
+    duration: 6:38pm to 7pm
+    description: |
+      - Comment 1
+      - Comment 2
+  -
+    subject: :aaaaaa
+    duration: 4:38am to 6pm
+    description: |
+      - Ahdkjlan akjdlnkfn
+END
+  end
+
+
+  describe '#from_map' do
+    let(:patient) do
+      map_data = YAML.load(yml_string_data)
+      _patient = WorkDay.from_map map_data
+      _patient.date.must_equal Chronic.parse(map_data['date'])
+      _patient.tasks.must_equal map_data['tasks'].map { |t| Task.from_map t }
+      _patient
+    end
+    it 'works' do
+      patient
+    end
+  end
+
+
+  let(:x_tasks) { [MiniTest::Mock.new, MiniTest::Mock.new] }
+  let(:x_date) { 'May 7, 2013' }
+  let(:patient) do
+    _patient = WorkDay.new x_date, *x_tasks
+    _patient.date.must_equal Chronic.parse(x_date)
+    _patient.tasks.must_equal x_tasks
+    _patient
   end
+
+
   describe 'to_hours' do
     it 'works without argument' do
-      @x_tasks[0].expect(:to_hours, 1.1)
-      @x_tasks[1].expect(:to_hours, 2.6)
-      @patient.to_hours.must_equal 1.1 + 2.6
+      x_tasks[0].expect(:to_hours, 1.1)
+      x_tasks[1].expect(:to_hours, 2.6)
+      patient.to_hours.must_equal 1.1 + 2.6
     end
     it 'works with arguments' do
-      @x_tasks[0].expect(:to_hours, 1.1)
-      @x_tasks[1].expect(:to_hours, 2.6)
-      @x_tasks[0].expect(:subject, :relevant_task)
-      @x_tasks[1].expect(:subject, :irrelevant_task)
-      @patient.to_hours(:relevant_task).must_equal 1.1
-
-      @x_tasks[0].expect(:to_hours, 1.1)
-      @x_tasks[1].expect(:to_hours, 2.6)
-      @x_tasks[0].expect(:subject, :relevant_task)
-      @x_tasks[1].expect(:subject, :irrelevant_task)
-      @patient.to_hours(:irrelevant_task).must_equal 2.6
-
-      @x_tasks[0].expect(:to_hours, 1.1)
-      @x_tasks[1].expect(:to_hours, 2.6)
-      @x_tasks[0].expect(:subject, :relevant_task)
-      @x_tasks[1].expect(:subject, :irrelevant_task)
-      @patient.to_hours(:relevant_task, :irrelevant_task).must_equal 1.1 + 2.6
+      x_tasks[0].expect(:to_hours, 1.1)
+      x_tasks[1].expect(:to_hours, 2.6)
+      x_tasks[0].expect(:subject, :relevant_task)
+      x_tasks[1].expect(:subject, :irrelevant_task)
+      patient.to_hours(:relevant_task).must_equal 1.1
+
+      x_tasks[0].expect(:to_hours, 1.1)
+      x_tasks[1].expect(:to_hours, 2.6)
+      x_tasks[0].expect(:subject, :relevant_task)
+      x_tasks[1].expect(:subject, :irrelevant_task)
+      patient.to_hours(:irrelevant_task).must_equal 2.6
+
+      x_tasks[0].expect(:to_hours, 1.1)
+      x_tasks[1].expect(:to_hours, 2.6)
+      x_tasks[0].expect(:subject, :relevant_task)
+      x_tasks[1].expect(:subject, :irrelevant_task)
+      patient.to_hours(:relevant_task, :irrelevant_task).must_equal 1.1 + 2.6
     end
   end
   describe 'to_md' do
     it 'works' do
-      @x_tasks[0].expect(:to_s, 'Task 1')
-      @x_tasks[1].expect(:to_s, 'Task 2')
-      @patient.to_md.must_equal (
+      x_tasks[0].expect(:to_s, 'Task 1')
+      x_tasks[1].expect(:to_s, 'Task 2')
+      patient.to_md.must_equal (
 <<-END
-#{@x_date}
+#{x_date}
 ============================
 - Task 1
 - Task 2
@@ -57,8 +94,8 @@ 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)
+      patient.add_task!(t3).must_equal patient
+      patient.tasks.must_equal (x_tasks << t3)
     end
   end
   describe 'time_worked' do
@@ -66,34 +103,34 @@ END
       it 'when all tasks have the same subject' do
         time_taken_for_each_task = 23
         x_subject = 'my subject'
-        @x_tasks.each do |mock_task|
+        x_tasks.each do |mock_task|
           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)) })
+        patient.time_worked.must_equal ({x_subject => (Duration.new(x_tasks.length * time_taken_for_each_task)) })
       end
       it 'when more than one subject is present' do
         time_taken_for_each_task = 23
         subject_1 = 'subject 1'
-        @x_tasks.each do |mock_task|
+        x_tasks.each do |mock_task|
           mock_task.expect(:subject, subject_1)
           mock_task.expect(:time_taken, time_taken_for_each_task)
         end
-        num_subject_1_tasks = @x_tasks.length
+        num_subject_1_tasks = x_tasks.length
         t3 = MiniTest::Mock.new
         subject_2 = 'subject 2'
         t3.expect(:subject, subject_2)
         t3.expect(:time_taken, time_taken_for_each_task)
-        @x_tasks << t3
+        x_tasks << t3
         t4 = MiniTest::Mock.new
         subject_3 = 'subject 3'
         t4.expect(:subject, subject_3)
         t4.expect(:time_taken, time_taken_for_each_task)
-        @x_tasks << t4
+        x_tasks << t4
 
-        @patient = WorkDay.new @x_date, @x_tasks
+        patient = WorkDay.new x_date, x_tasks
 
-        @patient.time_worked.must_equal (
+        patient.time_worked.must_equal (
           {
             subject_1 => Duration.new(num_subject_1_tasks * time_taken_for_each_task),
             subject_2 => Duration.new(time_taken_for_each_task),
@@ -105,24 +142,24 @@ END
     it 'returns a hash of duration sums when given a list of subjects' do
       time_taken_for_each_task = 23
       subject_1 = 'subject 1'
-      @x_tasks.each do |mock_task|
+      x_tasks.each do |mock_task|
         mock_task.expect(:subject, subject_1)
         mock_task.expect(:time_taken, time_taken_for_each_task)
       end
-      num_subject_1_tasks = @x_tasks.length
+      num_subject_1_tasks = x_tasks.length
       t3 = MiniTest::Mock.new
       subject_2 = 'subject 2'
       t3.expect(:subject, subject_2)
       t3.expect(:time_taken, time_taken_for_each_task)
-      @x_tasks << t3
+      x_tasks << t3
       t4 = MiniTest::Mock.new
       subject_3 = 'subject 3'
       t4.expect(:subject, subject_3)
-      @x_tasks << t4
+      x_tasks << t4
 
-      @patient = WorkDay.new @x_date, @x_tasks
+      patient = WorkDay.new x_date, x_tasks
 
-      @patient.time_worked(subject_1, subject_2).must_equal (
+      patient.time_worked(subject_1, subject_2).must_equal (
         {
           subject_1 => Duration.new(num_subject_1_tasks * time_taken_for_each_task),
           subject_2 => Duration.new(time_taken_for_each_task)
@@ -133,27 +170,27 @@ END
       it 'as a scalar' do
         time_taken_for_each_task = 23
         subject_1 = 'subject 1'
-        @x_tasks.each do |mock_task|
+        x_tasks.each do |mock_task|
           mock_task.expect(:subject, subject_1)
           mock_task.expect(:time_taken, time_taken_for_each_task)
         end
-        num_subject_1_tasks = @x_tasks.length
+        num_subject_1_tasks = x_tasks.length
         t3 = MiniTest::Mock.new
         subject_2 = 'subject 2'
         t3.expect(:subject, subject_2)
         t3.expect(:time_taken, time_taken_for_each_task)
-        @x_tasks << t3
+        x_tasks << t3
         t4 = MiniTest::Mock.new
         subject_3 = 'subject 3'
         t4.expect(:subject, subject_3)
-        @x_tasks << t4
+        x_tasks << t4
 
-        @patient = WorkDay.new @x_date, @x_tasks
+        patient = WorkDay.new x_date, x_tasks
 
-        @patient.time_worked(subject_1).must_equal (
+        patient.time_worked(subject_1).must_equal (
           {subject_1 => Duration.new(num_subject_1_tasks * time_taken_for_each_task)}
         )
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_distribution
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Dustin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Gem for creating time distribution management systems
@@ -180,4 +180,3 @@ test_files:
 - spec/time_spec.rb
 - spec/work_day_collection_spec.rb
 - spec/work_day_spec.rb
-has_rdoc: