plansheet 0.12.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1c4e7e5e45d00a1218ac7346c60ba9182c7b73ac2761958c24ea8c8dcf15d9d
-  data.tar.gz: 50cc492240c458e5bc13539f03203007b8922dcd2e00e5108d6f929c81419f2e
+  metadata.gz: f121593269dc11059fe547d8b72d58c2ad1a6685ae4826ac39daaff8b33f7c9a
+  data.tar.gz: 4020dab046e837f02b64cfc975408240d472b04a26bc6f40e7e552d915d77336
 SHA512:
-  metadata.gz: 2fe3310c09dfe7d4e79172a476f3bcfc0a3ef6261757a4070a6f49d9857673524663ee97622db603acae911201d5f1acc9cdb65d7c30547ea0e3f4610dc5e0bf
-  data.tar.gz: 58aee2a5ab4f95c114461a8ef614823b5c4e22e0961c792623d0720b033a40c1abbdf1d23887b7b5a38b4823138994116d3eb6b42f2675263d0825d567fee173
+  metadata.gz: ae82c5c2df93d55e520262754cc1c6e8b1b80a9a2fe230c09d00bd7ed4a38790c71b0dfcde5ac178e38112a26284219f21a8d99e48212601bbbcfae98607c0d1
+  data.tar.gz: 6ca757244abd515dcd86bbedb5a31590a53fbc8720e35167549bfe326c1f96673acef49b0dd1044a0e92f43253ef1442d126872859cebfa0f1185bb06612da59

data/.rubocop.yml

@@ -1,5 +1,3 @@
-inherit_from: .rubocop_todo.yml
-
 AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable
@@ -15,3 +13,9 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    plansheet (0.12.0)
+    plansheet (0.15.0)
       dc-kwalify (~> 1.0)
 
 GEM

data/exe/plansheet

@@ -25,18 +25,17 @@ options = {}
 parser.parse!(into: options)
 
 config = Plansheet.load_config
+pool = Plansheet::Pool.new({ projects_dir: config["projects_dir"] })
 
 if options[:sheet] || options.empty?
-  project_arr = Plansheet.load_projects_dir config["projects_dir"]
-
   Dir.mkdir config["output_dir"] unless Dir.exist? config["output_dir"]
-
-  Plansheet::Sheet.new("#{config["output_dir"]}/projects.md", project_arr)
+  Plansheet::Sheet.new("#{config["output_dir"]}/projects.md", pool.projects)
 elsif options[:sort]
-  Plansheet.resort_projects_in_dir config["projects_dir"]
+  # Pool sorts projects, this now just matches old behaviour
+  pool.write_projects
 elsif options[:cli]
-  project_arr = Plansheet.load_projects_dir config["projects_dir"]
-  project_arr.sort!
+  # TODO: add a project filter method
+  project_arr = pool.projects
   project_arr.delete_if { |x| x.status == "dropped" || x.status == "done" }
   project_arr.select! { |x| x.location == options[:location_filter] } if options[:location_filter]
   project_arr.each do |proj|

data/lib/plansheet/pool.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Plansheet
+  # The "pool" is the aggregated collection of projects, calendar events, etc.
+  class Pool
+    attr_accessor :projects
+
+    def initialize(config)
+      @projects_dir = config[:projects_dir]
+      # @completed_projects_dir = config(:completed_projects_dir)
+
+      load_projects_dir(@projects_dir)
+      # TODO: Slurp all files
+      sort_projects
+    end
+
+    def sort_projects
+      @projects.sort!
+    end
+
+    def project_namespaces
+      @projects.collect(&:namespace).uniq.sort
+    end
+
+    def projects_in_namespace(namespace)
+      @projects.select { |x| x.namespace == namespace }
+    end
+
+    def write_projects
+      # TODO: This leaves potential for duplicate projects where empty files
+      # are involved once completed project directories are a thing - will need
+      # to keep a list of project files to delete
+      project_namespaces.each do |ns|
+        # TODO: move this to ProjectYAMLFile
+        #
+        f = "#{@projects_dir}/#{ns}.yml"
+        pyf = ProjectYAMLFile.new f
+        pyf.projects = projects_in_namespace(ns)
+        pyf.write
+      end
+    end
+
+    def load_projects_dir(dir)
+      project_arr = []
+      projects = Dir.glob("*yml", base: dir)
+      projects.each do |l|
+        project_arr << ProjectYAMLFile.new(File.join(dir, l)).load_file
+      end
+
+      @projects = project_arr.flatten!
+    end
+  end
+end

data/lib/plansheet/project/stringify.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Plansheet
+  class Project
+    def to_s
+      str = String.new
+      str << "# "
+      str << "#{@namespace} - " if @namespace
+      str << "#{@name}\n"
+      STRING_PROPERTIES.each do |o|
+        str << stringify_string_property(o)
+      end
+      DATE_PROPERTIES.each do |o|
+        str << stringify_string_property(o)
+      end
+      ARRAY_PROPERTIES.each do |o|
+        str << stringify_array_property(o)
+      end
+      str
+    end
+
+    def stringify_string_property(prop)
+      if instance_variable_defined? "@#{prop}"
+        "#{prop}: #{instance_variable_get("@#{prop}")}\n"
+      else
+        ""
+      end
+    end
+
+    def stringify_date_property(prop)
+      if instance_variable_defined? "@#{prop}"
+        "#{prop}: #{instance_variable_get("@#{prop}")}\n"
+      else
+        ""
+      end
+    end
+
+    def stringify_array_property(prop)
+      str = String.new
+      if instance_variable_defined? "@#{prop}"
+        str << "#{prop}:\n"
+        instance_variable_get("@#{prop}").each do |t|
+          str << "- #{t}\n"
+        end
+      end
+      str
+    end
+  end
+end

data/lib/plansheet/project/yaml.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "date"
+require "pathname"
+
+module Plansheet
+  # Once there's some stability in plansheet and dc-kwalify, will pre-load this
+  # to save the later YAML.load
+  PROJECT_YAML_SCHEMA = <<~YAML
+    desc: dc-tasks project schema
+    type: seq
+    sequence:
+      - type: map
+        mapping:
+          "project":
+            desc: Project name
+            type: str
+          "namespace":
+            desc: Project name
+            type: str
+          "priority":
+            desc: Project priority
+            type: str
+            enum:
+              - high
+              - medium
+              - low
+          "status":
+            desc: The current status of the project
+            type: str
+            enum:
+              - wip # project is a work-in-progress
+              - ready # project has tasks, ready to go
+              - waiting # project in waiting on some external person/event
+              - blocked # project is blocked by another project, but otherwise ready/wip
+              - planning # project in planning phase (set manually)
+              - idea # project is little more than an idea
+              - dropped # project has been explicitly dropped, but
+                        # want to keep around for reference, etc
+              - done # project is finished, but want to keep around
+                     # for reference, etc.
+          "location":
+            desc: Location
+            type: str
+          "notes":
+            desc: Free-form notes string
+            type: str
+          "time_estimate":
+            desc: The estimated amount of time before a project is completed
+            type: str
+          "frequency":
+            desc: The amount of time before a recurring project moves to ready status again from when it was last done (WIP)
+            type: str
+            pattern: /\\d+[dwDW]/
+          "lead_time":
+            desc: The amount of time before a recurring project is "due" moved to ready where the project (sort of a deferral mechanism) (WIP)
+            type: str
+            pattern: /\\d+[dwDW]/
+          "due":
+            desc: Due date of the task
+            type: date
+          "defer":
+            desc: Defer task until this day
+            type: date
+          "completed_on":
+            desc: When the (non-recurring) project was completed
+            type: date
+          "created_on":
+            desc: When the project was created
+            type: date
+          "starts_on":
+            desc: For ICS (WIP)
+            type: date
+          "last_reviewed":
+            desc: When the project was last reviewed (WIP)
+            type: date
+          "last_done":
+            desc: When the recurring project was last completed (WIP)
+            type: date
+          "dependencies":
+            desc: The names of projects that need to be completed before this project can be started/completed
+            type: seq
+            sequence:
+              - type: str
+          "externals":
+            desc: List of external commitments, ie who else cares about project completion?
+            type: seq
+            sequence:
+              - type: str
+          "urls":
+            desc: List of URLs that may be pertinent
+            type: seq
+            sequence:
+              - type: str
+          "tasks":
+            desc: List of tasks to do
+            type: seq
+            sequence:
+              - type: str
+          "done":
+            desc: List of tasks which have been completed
+            type: seq
+            sequence:
+              - type: str
+          "tags":
+            desc: List of tags (WIP)
+            type: seq
+            sequence:
+              - type: str
+  YAML
+  PROJECT_SCHEMA = YAML.safe_load(PROJECT_YAML_SCHEMA)
+
+  class ProjectYAMLFile
+    attr_accessor :projects
+
+    def initialize(path)
+      @path = path
+      # TODO: this won't GC, inline validation instead?
+    end
+
+    def load_file
+      # Handle pre-Ruby 3.1 psych versions (this is brittle)
+      @raw = if Psych::VERSION.split(".")[0].to_i >= 4
+               YAML.load_file(@path, permitted_classes: [Date])
+             else
+               YAML.load_file(@path)
+             end
+
+      validate_schema
+      @raw ||= []
+      @projects = @raw.map do |proj|
+        proj["namespace"] = namespace
+        Project.new proj
+      end
+      @projects
+    end
+
+    def namespace
+      # TODO: yikes
+      ::Pathname.new(@path).basename.to_s.gsub(/\.yml$/, "")
+    end
+
+    def validate_schema
+      validator = Kwalify::Validator.new(Plansheet::PROJECT_SCHEMA)
+      errors = validator.validate(@raw)
+      # Check YAML validity
+      return unless errors && !errors.empty?
+
+      $stderr.write "Schema errors in #{@path}:\n"
+      errors.each { |err| puts "- [#{err.path}] #{err.message}" }
+      abort
+    end
+
+    def sort!
+      @projects.sort!
+    end
+
+    def write
+      File.write @path, yaml_dump
+    end
+
+    def yaml_dump
+      YAML.dump(@projects.map { |x| x.to_h.except("namespace") })
+    end
+  end
+end

data/lib/plansheet/project.rb

@@ -2,6 +2,8 @@
 
 require "yaml"
 require "date"
+require_relative "project/yaml"
+require_relative "project/stringify"
 
 module Plansheet
   PROJECT_STATUS_PRIORITY = {
@@ -21,107 +23,6 @@ module Plansheet
     "low" => 3
   }.freeze
 
-  # Once there's some stability in plansheet and dc-kwalify, will pre-load this
-  # to save the later YAML.load
-  PROJECT_YAML_SCHEMA = <<~YAML
-    desc: dc-tasks project schema
-    type: seq
-    sequence:
-      - type: map
-        mapping:
-          "project":
-            desc: Project name
-            type: str
-            required: yes
-          "priority":
-            desc: Project priority
-            type: str
-            enum:
-              - high
-              - medium
-              - low
-          "status":
-            desc: The current status of the project
-            type: str
-            enum:
-              - wip # project is a work-in-progress
-              - ready # project has tasks, ready to go
-              - waiting # project in waiting on some external person/event
-              - blocked # project is blocked by another project, but otherwise ready/wip
-              - planning # project in planning phase (set manually)
-              - idea # project is little more than an idea
-              - dropped # project has been explicitly dropped, but
-                        # want to keep around for reference, etc
-              - done # project is finished, but want to keep around
-                     # for reference, etc.
-          "location":
-            desc: Location
-            type: str
-          "notes":
-            desc: Free-form notes string
-            type: str
-          "time_estimate":
-            desc: The estimated amount of time before a project is completed
-            type: str
-          "frequency":
-            desc: The amount of time before a recurring project moves to ready status again from when it was last done (WIP)
-            type: str
-            pattern: /\\d+[dwDW]/
-          "lead_time":
-            desc: The amount of time before a recurring project is "due" moved to ready where the project (sort of a deferral mechanism) (WIP)
-            type: str
-            pattern: /\\d+[dwDW]/
-          "due":
-            desc: Due date of the task
-            type: date
-          "defer":
-            desc: Defer task until this day
-            type: date
-          "created_on":
-            desc: When the project was created
-            type: date
-          "starts_on":
-            desc: For ICS (WIP)
-            type: date
-          "last_reviewed":
-            desc: When the project was last reviewed (WIP)
-            type: date
-          "last_done":
-            desc: When the recurring project was last completed (WIP)
-            type: date
-          "dependencies":
-            desc: The names of projects that need to be completed before this project can be started/completed
-            type: seq
-            sequence:
-              - type: str
-          "externals":
-            desc: List of external commitments, ie who else cares about project completion?
-            type: seq
-            sequence:
-              - type: str
-          "urls":
-            desc: List of URLs that may be pertinent
-            type: seq
-            sequence:
-              - type: str
-          "tasks":
-            desc: List of tasks to do
-            type: seq
-            sequence:
-              - type: str
-          "done":
-            desc: List of tasks which have been completed
-            type: seq
-            sequence:
-              - type: str
-          "tags":
-            desc: List of tags (WIP)
-            type: seq
-            sequence:
-              - type: str
-  YAML
-  PROJECT_SCHEMA = YAML.safe_load(PROJECT_YAML_SCHEMA)
-
   def self.parse_date_duration(str)
     return Regexp.last_match(1).to_i if str.strip.match(/(\d+)[dD]/)
     return (Regexp.last_match(1).to_i * 7) if str.strip.match(/(\d+)[wW]/)
@@ -147,16 +48,19 @@ module Plansheet
       status
     ].map { |x| "compare_#{x}".to_sym }.freeze
     # NOTE: The order of these affects presentation!
+    # namespace is derived from file name
     STRING_PROPERTIES = %w[priority status location notes time_estimate frequency lead_time].freeze
-    DATE_PROPERTIES = %w[due defer created_on starts_on last_done last_reviewed].freeze
+    DATE_PROPERTIES = %w[due defer completed_on created_on starts_on last_done last_reviewed].freeze
     ARRAY_PROPERTIES = %w[dependencies externals urls tasks done tags].freeze
 
     ALL_PROPERTIES = STRING_PROPERTIES + DATE_PROPERTIES + ARRAY_PROPERTIES
 
     attr_reader :name, *ALL_PROPERTIES
+    attr_accessor :namespace
 
     def initialize(options)
       @name = options["project"]
+      @namespace = options["namespace"]
 
       ALL_PROPERTIES.each do |o|
         instance_variable_set("@#{o}", options[o]) if options[o]
@@ -240,8 +144,8 @@ module Plansheet
     def status
       return @status if @status
       return recurring_status if recurring?
-      return task_based_status if (@tasks || @done)
-      # TODO: return done if done count is positive...
+      return task_based_status if @tasks || @done
+      return "done" if @completed_on && @tasks.nil?
 
       "idea"
     end
@@ -260,18 +164,19 @@ module Plansheet
 
     def recurring_status
       # add frequency to last_done
-      unless @last_done
-        # This recurring project is being done for the first time
-        task_based_status
-      else
+      if @last_done
         # This project has been done once before
         subsequent_recurring_status
+      else
+        # This recurring project is being done for the first time
+        task_based_status
       end
     end
 
     def subsequent_recurring_status
       return "done" if @lead_time && defer > Date.today
       return "done" if due > Date.today
+
       task_based_status
     end
 
@@ -284,6 +189,7 @@ module Plansheet
     def due
       return @due if @due
       return recurring_due_date if recurring?
+
       nil
     end
 
@@ -298,6 +204,7 @@ module Plansheet
     def defer
       return @defer if @defer
       return lead_time_deferral if @lead_time && due
+
       nil
     end
 
@@ -314,50 +221,8 @@ module Plansheet
       status == "dropped" || status == "done"
     end
 
-    def to_s
-      str = String.new
-      str << "# #{@name}\n"
-      STRING_PROPERTIES.each do |o|
-        str << stringify_string_property(o)
-      end
-      DATE_PROPERTIES.each do |o|
-        str << stringify_string_property(o)
-      end
-      ARRAY_PROPERTIES.each do |o|
-        str << stringify_array_property(o)
-      end
-      str
-    end
-
-    def stringify_string_property(prop)
-      if instance_variable_defined? "@#{prop}"
-        "#{prop}: #{instance_variable_get("@#{prop}")}\n"
-      else
-        ""
-      end
-    end
-
-    def stringify_date_property(prop)
-      if instance_variable_defined? "@#{prop}"
-        "#{prop}: #{instance_variable_get("@#{prop}")}\n"
-      else
-        ""
-      end
-    end
-
-    def stringify_array_property(prop)
-      str = String.new
-      if instance_variable_defined? "@#{prop}"
-        str << "#{prop}:\n"
-        instance_variable_get("@#{prop}").each do |t|
-          str << "- #{t}\n"
-        end
-      end
-      str
-    end
-
     def to_h
-      h = { "project" => @name }
+      h = { "project" => @name, "namespace" => @namespace }
       ALL_PROPERTIES.each do |prop|
         h[prop] = instance_variable_get("@#{prop}") if instance_variable_defined?("@#{prop}")
       end
@@ -366,42 +231,4 @@ module Plansheet
       h
     end
   end
-
-  class ProjectYAMLFile
-    attr_reader :projects
-
-    def initialize(path)
-      @path = path
-      # TODO: this won't GC, inline validation instead?
-
-      # Handle pre-Ruby 3.1 psych versions (this is brittle)
-      @raw = if Psych::VERSION.split(".")[0].to_i >= 4
-               YAML.load_file(path, permitted_classes: [Date])
-             else
-               YAML.load_file(path)
-             end
-
-      validate_schema
-      @projects = @raw.map { |proj| Project.new proj }
-    end
-
-    def validate_schema
-      validator = Kwalify::Validator.new(Plansheet::PROJECT_SCHEMA)
-      errors = validator.validate(@raw)
-      # Check YAML validity
-      return unless errors && !errors.empty?
-
-      $stderr.write "Schema errors in #{@path}:\n"
-      errors.each { |err| puts "- [#{err.path}] #{err.message}" }
-      abort
-    end
-
-    def sort!
-      @projects.sort!
-    end
-
-    def yaml_dump
-      YAML.dump(@projects.map(&:to_h))
-    end
-  end
 end

data/lib/plansheet/version.rb

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

data/lib/plansheet.rb

@@ -2,6 +2,7 @@
 
 require_relative "plansheet/version"
 require_relative "plansheet/project"
+require_relative "plansheet/pool"
 require_relative "plansheet/sheet"
 require "yaml"
 require "kwalify"
@@ -9,28 +10,10 @@ require "kwalify"
 module Plansheet
   class Error < StandardError; end
 
+  # TODO: config schema validation
   def self.load_config
     YAML.load_file "#{Dir.home}/.plansheet.yml"
   rescue StandardError
     abort "unable to load plansheet config file"
   end
-
-  def self.resort_projects_in_dir(dir)
-    project_files = Dir.glob("#{dir}/*yml")
-    project_files.each do |f|
-      pyf = ProjectYAMLFile.new(f)
-      pyf.sort!
-      File.write(f, pyf.yaml_dump)
-    end
-  end
-
-  def self.load_projects_dir(dir)
-    project_arr = []
-    projects = Dir.glob("*yml", base: dir)
-    projects.each do |l|
-      project_arr << ProjectYAMLFile.new(File.join(dir, l)).projects
-    end
-
-    project_arr.flatten!
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plansheet
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.15.0
 platform: ruby
 authors:
 - David Crosby
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-06 00:00:00.000000000 Z
+date: 2022-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dc-kwalify
@@ -33,7 +33,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -44,7 +43,10 @@ files:
 - examples/backpack.yml
 - exe/plansheet
 - lib/plansheet.rb
+- lib/plansheet/pool.rb
 - lib/plansheet/project.rb
+- lib/plansheet/project/stringify.rb
+- lib/plansheet/project/yaml.rb
 - lib/plansheet/sheet.rb
 - lib/plansheet/version.rb
 homepage: https://dafyddcrosby.com

data/.rubocop_todo.yml

@@ -1,35 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2022-06-04 17:25:54 UTC using RuboCop version 1.29.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-# Offense count: 2
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
-Metrics/MethodLength:
-  Enabled: false
-
-# Offense count: 1
-# Configuration parameters: IgnoredMethods.
-Metrics/PerceivedComplexity:
-  Enabled: false
-
-# Offense count: 2
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Exclude:
-    - 'test/**/*'
-    - 'lib/plansheet.rb'
-    - 'lib/plansheet/project.rb'