plansheet 0.23.1 → 0.25.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de86fd5b55207da728e3ed67e500a687576c6f10ce3bb9ad09df7cec56a6e7b1
-  data.tar.gz: 785db3bae6f43dadb9ac2bdc95b05c6fc9cc7933e199a41d6316807c3899410a
+  metadata.gz: 1d6783f3c90e7d781de642be7c98e2a8469e48d8576405a5554cf92282632f2e
+  data.tar.gz: 39de90d2ad1d6c371c1626b56ffba32d79e293b9adaa0c01bb3d8113cc16225d
 SHA512:
-  metadata.gz: e1082bae42f951c3c880247c0dbe34f24c4cfcbb3de58e8a0a804fa670d7616e077f60854db7e788cbb1b4234f17089524fd6779bf9308d3be1a32a0a2a9f7db
-  data.tar.gz: 138a351986a9c11c6e6814bb2279e42dd39c35476b2e254b41a74aea4770b7d8017fcb4ac8f34ced403e3788fd6821d4ac453fdf8e6e4fe4331a068e80680059
+  metadata.gz: d30350f829b3db7e0b6d1163d55b835c55bef408c1c34ffc16a209837b9f4f1573b2d51d46fe294c4e48eeb1018a11a04701b100edce353c68c39becff5c9cca
+  data.tar.gz: fac00b40c31909b7d785e8938f49f877f02872875d72246bc8413dd84d34b857a0a3840605d0e22ac60a288091a6d28629eb915bb3ece4b2930c5e1ea8fbf841

data/.rubocop.yml

@@ -11,6 +11,9 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
+Style/GuardClause:
+  Enabled: false
+
 Layout/LineLength:
   Max: 120
 

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    plansheet (0.23.1)
+    plansheet (0.25.1)
       dc-kwalify (~> 1.0)
+      diffy (= 3.4.2)
       rgl (= 0.5.8)
 
 GEM
@@ -11,6 +12,7 @@ GEM
     ast (2.4.2)
     coderay (1.1.3)
     dc-kwalify (1.0.0)
+    diffy (3.4.2)
     ffi (1.15.5)
     formatador (1.1.0)
     generator (0.0.1)

data/exe/plansheet

@@ -25,6 +25,10 @@ parser.on(
   "--stats",
   "Various stats (WIP)"
 )
+parser.on(
+  "--time-roi",
+  "Show projects with a time return-on-investment"
+)
 parser.on(
   "--calendar",
   "List of projects ordered by due date"
@@ -54,6 +58,13 @@ elsif options[:stats]
 elsif options[:sort]
   # Pool sorts projects, this now just matches old behaviour
   pool.write_projects
+elsif options[:"time-roi"]
+  project_arr = pool.projects.select { |x| x.time_roi_payoff != 0 && !x.dropped_or_done? }.sort
+  project_arr.each do |proj|
+    puts proj
+    puts "time ROI payoff: #{proj.time_roi_payoff}"
+    puts "\n"
+  end
 elsif options[:calendar]
   # TODO: add a project filter method
   project_arr = pool.projects

data/lib/plansheet/pool.rb

@@ -10,12 +10,14 @@ module Plansheet
 
     DEFAULT_COMPARISON_ORDER = %w[
       completeness
+      completed_on
       dependency
       priority
       defer
       due
       time_roi
       status
+      name
     ].freeze
 
     def initialize(config, debug: false)
@@ -89,8 +91,7 @@ module Plansheet
       # to keep a list of project files to delete
       project_namespaces.each do |ns|
         pyf = ProjectYAMLFile.new "#{@projects_dir}/#{ns}.yml"
-        pyf.projects = projects_in_namespace(ns)
-        pyf.write
+        pyf.compare_and_write projects_in_namespace(ns)
       end
     end
 

data/lib/plansheet/project/yaml.rb

@@ -189,12 +189,29 @@ module Plansheet
       @projects.sort!
     end
 
-    def write
-      File.write @path, yaml_dump
+    def compare_and_write(projects)
+      updated_projects_string = yaml_dump(projects)
+
+      # Compare the existing file to the newly generated one - we only want a
+      # write if something has changed
+      return if updated_projects_string == yaml_dump(load_file)
+
+      puts "#{@path} has changed, writing"
+      require "diffy"
+      puts Diffy::Diff.new(yaml_dump(load_file), updated_projects_string).to_s(:color)
+      File.write @path, updated_projects_string
     end
 
-    def yaml_dump
-      YAML.dump(@projects.map { |x| x.to_h.delete_if { |k, _| k == "namespace" } })
+    def yaml_dump(projects)
+      # binding.irb if projects.nil?
+      YAML.dump(projects.map do |x|
+        x.to_h.delete_if do |k, v|
+          # Remove low-value default noise from projects
+          k == "namespace" ||
+           (k == "priority" && v == "low") ||
+           (k == "status" && v == "idea")
+        end
+      end)
     end
   end
 end

data/lib/plansheet/project.rb

@@ -138,13 +138,21 @@ module Plansheet
         # Convert the field to minutes
         @time_estimate_minutes = Plansheet.parse_time_duration(@time_estimate)
       end
-      if @time_estimate_minutes # rubocop:disable Style/GuardClause
+      if @time_estimate_minutes
         # Rewrite time_estimate field
         @time_estimate = Plansheet.build_time_duration(@time_estimate_minutes)
 
         yms = yearly_minutes_saved
         @time_roi_payoff = yms.to_f / @time_estimate_minutes if yms
       end
+
+      if done?
+        @completed_on ||= Date.today unless recurring?
+        remove_instance_variable("@status") if @status
+        remove_instance_variable("@time_estimate") if @time_estimate
+        remove_instance_variable("@time_estimate_minutes") if @time_estimate
+        remove_instance_variable("@time_roi_payoff") if @time_roi_payoff
+      end
     end
 
     def yearly_minutes_saved
@@ -182,6 +190,20 @@ module Plansheet
       PROJECT_STATUS_PRIORITY[status] <=> PROJECT_STATUS_PRIORITY[other.status]
     end
 
+    # This seems silly at first glance, but it's to keep projects from flipping
+    # around on each sort when they are equal in all other respects
+    def compare_name(other)
+      @name <=> other.name
+    end
+
+    def compare_completed_on(other)
+      retval = 0
+      retval += 1 if @completed_on
+      retval -= 1 if other.completed_on
+      retval = (other.completed_on <=> @completed_on) if retval.zero?
+      retval
+    end
+
     def compare_due(other)
       # -1 is receiving object being older
 
@@ -273,11 +295,6 @@ module Plansheet
       task_based_status
     end
 
-    def process_recurring
-      # TODO: Tasks will be moved from done->tasks if recurring project is
-      # starting again
-    end
-
     # Due date either explicit or recurring
     def due
       return @due if @due
@@ -331,6 +348,10 @@ module Plansheet
       status == "dropped" || status == "done"
     end
 
+    def done?
+      status == "done"
+    end
+
     def self.task_time_estimate(str)
       Plansheet.parse_time_duration(Regexp.last_match(1)) if str.match(TIME_EST_REGEX)
     end
@@ -340,8 +361,6 @@ module Plansheet
       ALL_PROPERTIES.each do |prop|
         h[prop] = instance_variable_get("@#{prop}") if instance_variable_defined?("@#{prop}")
       end
-      h.delete "priority" if h.key?("priority") && h["priority"] == "low"
-      h.delete "status" if h.key?("status") && h["status"] == "idea"
       h
     end
   end

data/lib/plansheet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Plansheet
-  VERSION = "0.23.1"
+  VERSION = "0.25.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.25.1
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-08 00:00:00.000000000 Z
+date: 2022-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: rgl
   requirement: !ruby/object:Gem::Requirement