dsu 2.4.3 → 3.0.0.alpha.0

data/README.md

@@ -1,13 +1,13 @@
 # `dsu`
 
 [![Ruby](https://github.com/gangelo/dsu/actions/workflows/ruby.yml/badge.svg)](https://github.com/gangelo/dsu/actions/workflows/ruby.yml)
-[![GitHub version](http://badge.fury.io/gh/gangelo%2Fdsu.svg?refresh=9)](https://badge.fury.io/gh/gangelo%2Fdsu)
-[![Gem Version](https://badge.fury.io/rb/dsu.svg?refresh=9)](https://badge.fury.io/rb/dsu)
+[![GitHub version](http://badge.fury.io/gh/gangelo%2Fdsu.svg?refresh=12)](https://badge.fury.io/gh/gangelo%2Fdsu)
+[![Gem Version](https://badge.fury.io/rb/dsu.svg?refresh=12)](https://badge.fury.io/rb/dsu)
 [![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/dsu/)
 [![Report Issues](https://img.shields.io/badge/report-issues-red.svg)](https://github.com/gangelo/dsu/issues)
 [![License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](#license)
 
-`dsu` is a [ruby gem](https://rubygems.org/gems/dsu) that enables anyone practicing [Agile methodology](https://www.agilealliance.org/agile101/) to record, keep track of and manage their [daily standup (DSU)](https://www.agilealliance.org/glossary/daily-meeting/) activities.
+`dsu` is a [ruby gem](https://rubygems.org/gems/dsu) that enables anyone practicing the [Agile methodology](https://www.agilealliance.org/agile101/) to record, keep track of and manage their [daily standup (DSU)](https://www.agilealliance.org/glossary/daily-meeting/) activities.
 
 - `dsu` uses _no_ network connections whatsoever.
 - `dsu` stores all of its data _locally_, in .json files.
@@ -22,12 +22,11 @@ gem install dsu
 ```
 
 # Documentation
-[https://github.com/gangelo/dsu/wiki](https://github.com/gangelo/dsu/wiki)
+The [dsu wiki](https://github.com/gangelo/dsu/wiki) is currently the gold standard for `dsu` documentation.
 
 # Examples
-The [dsu wiki](https://github.com/gangelo/dsu/wiki) is repleat with practical examples on how to use `dsu`.
-
-It you're interested in how _I personally_ use `dsu` every day, I blog about it [here](https://genemangelojr.blogspot.com/2024/01/the-dsu-ruby-gem-workflow-how-to-use-it.html).
+* The [dsu wiki](https://github.com/gangelo/dsu/wiki) is repleat with practical examples on how to use `dsu`.
+* Visit the [How I use dsu daily as an Agile developer](https://github.com/gangelo/dsu/wiki/How-I-use-dsu-daily-as-an-Agile-developer) wiki for examples of how _I_ use `dsu` on a daily basis.
 
 # Supported ruby versions
 `dsu` _should_ work with any ruby version `['>= 3.0.1', '< 4.0']`; however, `dsu` is currently tested against the following ruby versions:
@@ -36,4 +35,4 @@ It you're interested in how _I personally_ use `dsu` every day, I blog about it
 - 3.1.4
 - 3.2.2
 
-Copyright (c) 2023-2024 Erik Gene Angelo. See [LICENSE](https://github.com/gangelo/dsu/blob/main/LICENSE.txt) for details.
+Copyright (c) 2023-2024 Gene Angelo. See [LICENSE](https://github.com/gangelo/dsu/blob/main/LICENSE.txt) for details.

data/Rakefile

@@ -10,3 +10,9 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 task default: %i[spec rubocop]
+
+desc 'Generate a migration timestamp'
+task :timestamp do
+  puts 'The below migration timestamp should be placed in the "lib/dsu/migration/version.rb" file.'
+  puts Time.now.strftime('%Y%m%d%H%M%S')
+end

data/current_project.bak

@@ -0,0 +1,4 @@
+{
+  "version": 20240210161248,
+  "project_name": "default"
+}

data/lib/dsu/cli.rb

@@ -11,12 +11,18 @@ require_relative 'subcommands/edit'
 require_relative 'subcommands/export'
 require_relative 'subcommands/import'
 require_relative 'subcommands/list'
+require_relative 'subcommands/project'
 require_relative 'subcommands/theme'
+require_relative 'support/command_options/time_mnemonic'
+require_relative 'support/time_formatable'
 require_relative 'views/entry_group/list'
 
 module Dsu
   # The `dsu` command.
   class CLI < BaseCLI
+    include Support::CommandOptions::TimeMnemonic
+    include Support::TimeFormatable
+
     map I18n.t('commands.add.key_mappings') => :add
     map I18n.t('commands.browse.key_mappings') => :browse
     map I18n.t('commands.config.key_mappings') => :config
@@ -27,30 +33,39 @@ module Dsu
     map I18n.t('commands.import.key_mappings') => :import
     map I18n.t('commands.info.key_mappings') => :info
     map I18n.t('commands.list.key_mappings') => :list
+    map I18n.t('commands.project.key_mappings') => :project
     map I18n.t('commands.theme.key_mappings') => :theme
     map I18n.t('commands.version.key_mappings') => :version
 
     desc I18n.t('commands.add.desc'), I18n.t('commands.add.usage')
-    long_desc I18n.t('commands.add.long_desc', date_option_description: date_option_description)
+    long_desc I18n.t('commands.add.long_desc',
+      date_option_description: date_option_description, mnemonic_option_description: mnemonic_option_description)
     option I18n.t('options.date.name'), aliases: I18n.t('options.date.aliases'), type: :string
     option I18n.t('options.tomorrow.name'), aliases: I18n.t('options.tomorrow.aliases'), type: :boolean
     option I18n.t('options.yesterday.name'), aliases: I18n.t('options.yesterday.aliases'), type: :boolean
     option I18n.t('options.today.name'), aliases: I18n.t('options.today.aliases'), type: :boolean, default: true
     def add(description)
-      time = if options[I18n.t('options.date.name')].present?
-        Time.parse(options[I18n.t('options.date.name')])
+      date_or_mnemonic = if options[I18n.t('options.date.name')].present?
+        options[I18n.t('options.date.name')]
       elsif options[I18n.t('options.tomorrow.name')].present?
-        Time.now.tomorrow
+        I18n.t('options.tomorrow.name')
       elsif options[I18n.t('options.yesterday.name')].present?
-        Time.now.yesterday
+        I18n.t('options.yesterday.name')
       elsif options[I18n.t('options.today.name')].present?
-        Time.now
+        I18n.t('options.today.name')
+      end
+      time = if time_mnemonic?(date_or_mnemonic)
+        time_from_mnemonic(command_option: date_or_mnemonic)
+      else
+        Time.parse(date_or_mnemonic)
       end
       entry = Models::Entry.new(description: description)
       CommandServices::AddEntryService.new(entry: entry, time: time).call
       presenter = Presenters::EntryGroup::List::DatePresenter.new(times: [time], options: options)
       # TODO: Refactor View::EntryGroup::Show to accept a presenter and use it here
       Views::EntryGroup::List.new(presenter: presenter).render
+    rescue ArgumentError => e
+      Views::Shared::Error.new(messages: e.message).render
     end
 
     desc I18n.t('commands.browse.desc'), I18n.t('commands.browse.usage')
@@ -59,6 +74,9 @@ module Dsu
     desc I18n.t('commands.list.desc'), I18n.t('commands.list.usage')
     subcommand :list, Subcommands::List
 
+    desc I18n.t('commands.project.desc'), I18n.t('commands.project.usage')
+    subcommand :project, Subcommands::Project
+
     desc I18n.t('commands.config.desc'), I18n.t('commands.config.usage')
     subcommand :config, Subcommands::Config
 

data/lib/dsu/crud/json_file.rb

@@ -114,6 +114,9 @@ module Dsu
         end
 
         def write!(file_data:, file_path:)
+          # TODO: Should we be raising an error if the file does not exist?
+          # raise file_does_not_exist_message(file_path: file_path) unless file_exist?(file_path: file_path)
+
           write(file_data: file_data, file_path: file_path)
         end
 

data/lib/dsu/migration/version.rb

@@ -2,6 +2,6 @@
 
 module Dsu
   module Migration
-    VERSION = 20230613121411 # rubocop:disable Style/NumericLiterals
+    VERSION = 20240210161248 # rubocop:disable Style/NumericLiterals
   end
 end

data/lib/dsu/models/color_theme.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'json'
 require_relative '../crud/json_file'
 require_relative '../migration/version'
 require_relative '../support/color_themable'
@@ -76,7 +75,7 @@ module Dsu
         @theme_name = theme_name
         @options = options || {}
 
-        super(self.class.send(:themes_path_for, theme_name: @theme_name))
+        super(self.class.send(:themes_path, theme_name: @theme_name))
 
         theme_hash ||= DEFAULT_THEME.merge(description: "#{@theme_name.capitalize} theme")
 
@@ -112,6 +111,8 @@ module Dsu
       end
 
       class << self
+        delegate :themes_folder, :themes_path, to: Support::Fileable
+
         def all
           Dir.glob("#{themes_folder}/*").map do |file_path|
             theme_name = File.basename(file_path, '.*')
@@ -141,11 +142,11 @@ module Dsu
         end
 
         def delete(theme_name:)
-          superclass.delete(file_path: themes_path_for(theme_name: theme_name))
+          superclass.delete(file_path: themes_path(theme_name: theme_name))
         end
 
         def delete!(theme_name:)
-          superclass.delete!(file_path: themes_path_for(theme_name: theme_name))
+          superclass.delete!(file_path: themes_path(theme_name: theme_name))
         end
 
         def ensure_color_theme_color_defaults_for(theme_hash: DEFAULT_THEME)
@@ -160,11 +161,11 @@ module Dsu
         end
 
         def exist?(theme_name:)
-          superclass.file_exist?(file_path: themes_path_for(theme_name: theme_name))
+          superclass.file_exist?(file_path: themes_path(theme_name: theme_name))
         end
 
         def find(theme_name:)
-          theme_hash = read!(file_path: themes_path_for(theme_name: theme_name))
+          theme_hash = read!(file_path: themes_path(theme_name: theme_name))
           Services::ColorTheme::HydratorService.new(theme_name: theme_name, theme_hash: theme_hash).call
         end
 
@@ -180,55 +181,11 @@ module Dsu
           new(theme_name: theme_name)
         end
 
-        # TODO: Unused?
-        # def build_color_theme(theme_name:, base_color:, description:)
-        #   theme_hash = Models::ColorTheme.send(:replace, color_theme: default,
-        #     replace_color: :cyan, with_color: base_color).tap do |hash|
-        #     hash[:description] = description
-        #   end
-        #   new(theme_name: theme_name, theme_hash: theme_hash)
-        # end
-
         private
 
         def default_theme_color_keys
           DEFAULT_THEME_COLORS.keys
         end
-
-        def replace(color_theme:, replace_color:, with_color:)
-          colors_theme_hash = color_theme.to_theme_colors_h.tap do |hash|
-            hash.each_key do |key|
-              hash[key] = replace_color(theme_color: hash[key],
-                replace_color: replace_color, with_color: with_color)
-            end
-          end
-          DEFAULT_THEME.merge(colors_theme_hash)
-        end
-
-        def replace_color(theme_color:, replace_color:, with_color:)
-          %i[color background].each do |color_type|
-            color = theme_color[color_type].to_s.sub(replace_color.to_s, with_color.to_s)
-            theme_color[color_type] = color.sub('light_light_', 'light_').to_sym
-          end
-          theme_color
-        end
-
-        # If the color theme is deleted (deleted_theme_name) and the current
-        # theme_name in the configuration is the same as the deleted theme,
-        # we need to reset the configuration theme to the default theme.
-        def reset_default_configuration_color_theme_if!(deleted_theme_name:)
-          config = configuration
-          return if config.theme_name == self::DEFAULT_THEME_NAME
-          return unless config.theme_name == deleted_theme_name
-          return unless config.exist?
-
-          config.theme_name = self::DEFAULT_THEME_NAME
-          config.write!
-        end
-
-        def themes_path_for(theme_name:)
-          Support::Fileable.themes_path(theme_name: theme_name)
-        end
       end
 
       def to_h
@@ -239,14 +196,6 @@ module Dsu
         end
       end
 
-      def to_theme_colors_h
-        {}.tap do |hash|
-          DEFAULT_THEME_COLORS.each_key do |key|
-            hash[key] = public_send(key)
-          end
-        end
-      end
-
       def ==(other)
         return false unless other.is_a?(self.class)
         return false unless other.theme_name == theme_name

data/lib/dsu/models/configuration.rb

@@ -42,7 +42,9 @@ module Dsu
         # The currently selected color theme. Should be equal to
         # Models::ColorTheme::DEFAULT_THEME_NAME or the name of a custom
         # theme (with the same file name) that resides in the themes_folder.
-        theme_name: 'default'
+        theme_name: 'default',
+        # The default project to use.
+        default_project: 'default'
       }.freeze
 
       validates_with Validators::VersionValidator
@@ -53,13 +55,16 @@ module Dsu
       validates :include_all, inclusion: { in: [true, false], message: 'must be true or false' }
       validates :theme_name, presence: true
       validate :validate_theme_file
+      validates :default_project, presence: true
+      validate :validate_default_project
 
       attr_accessor :version,
         :editor,
         :entries_display_order,
         :carry_over_entries_to_today,
         :include_all,
-        :theme_name
+        :theme_name,
+        :default_project
 
       attr_reader :options
 
@@ -114,7 +119,8 @@ module Dsu
           entries_display_order: entries_display_order,
           carry_over_entries_to_today: carry_over_entries_to_today,
           include_all: include_all,
-          theme_name: theme_name
+          theme_name: theme_name,
+          default_project: default_project
         }
       end
 
@@ -150,6 +156,7 @@ module Dsu
           DEFAULT_CONFIGURATION[:carry_over_entries_to_today])
         @include_all = config_hash.fetch(:include_all, DEFAULT_CONFIGURATION[:include_all])
         @theme_name = config_hash.fetch(:theme_name, DEFAULT_CONFIGURATION[:theme_name])
+        @default_project = config_hash.fetch(:default_project, DEFAULT_CONFIGURATION[:default_project])
       end
 
       def validate_theme_file
@@ -159,6 +166,14 @@ module Dsu
         i18n_key = 'configuration.errors.theme_file_missing'
         errors.add(:base, I18n.t(i18n_key, theme_path: theme_path))
       end
+
+      def validate_default_project
+        default_project_folder = File.join(projects_folder, default_project.presence || '{{blank}}')
+        return if Dir.exist?(default_project_folder)
+
+        i18n_key = 'configuration.errors.project_path_missing'
+        errors.add(:base, I18n.t(i18n_key, project_folder: default_project_folder))
+      end
     end
   end
 end

data/lib/dsu/models/entry_group.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_model'
 require_relative '../crud/json_file'
 require_relative '../migration/version'
 require_relative '../services/entry_group/editor_service'
@@ -177,12 +176,6 @@ module Dsu
           Services::EntryGroup::HydratorService.new(entry_group_hash: entry_group_hash).call
         end
 
-        def find_or_create(time:)
-          find_or_initialize(time: time).tap do |entry_group|
-            entry_group.write! unless entry_group.exist?
-          end
-        end
-
         def find_or_initialize(time:)
           file_path = entries_path_for(time: time)
           read(file_path: file_path) do |entry_group_hash|

data/lib/dsu/models/migration_version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'active_model'
 require_relative '../crud/json_file'
 require_relative '../services/migration_version/hydrator_service'
 require_relative '../validators/version_validator'

data/lib/dsu/models/project.rb

@@ -0,0 +1,295 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+require_relative '../crud/json_file'
+require_relative '../migration/version'
+require_relative '../models/configuration'
+require_relative '../services/project/hydrator_service'
+require_relative '../services/project/rename_service'
+require_relative '../support/descriptable'
+require_relative '../support/fileable'
+require_relative '../support/project_file_system'
+require_relative '../validators/description_validator'
+require_relative '../validators/project_name_validator'
+require_relative '../validators/version_validator'
+
+module Dsu
+  module Models
+    # This class represents a project. A project is a collection of entry groups.
+    class Project
+      include ActiveModel::Model
+      include Support::Descriptable
+      include Support::Fileable
+      include Support::ProjectFileSystem
+
+      VERSION = Migration::VERSION
+      MIN_PROJECT_NAME_LENGTH = 2
+      MAX_PROJECT_NAME_LENGTH = 24
+      MIN_DESCRIPTION_LENGTH = 2
+      MAX_DESCRIPTION_LENGTH = 32
+
+      attr_reader :project_name, :current_project_file, :description, :version, :options
+
+      validates_with Validators::DescriptionValidator
+      validates_with Validators::ProjectNameValidator
+      validates_with Validators::VersionValidator
+
+      def initialize(project_name:, description: nil, version: nil, options: {})
+        raise ArgumentError, 'project_name is blank' if project_name.blank?
+        raise ArgumentError, 'version is the wrong object type' unless version.is_a?(Integer) || version.nil?
+
+        self.project_name = project_name
+        self.description = description
+        self.version = version || VERSION
+        self.options = options || {}
+      end
+
+      # Override == and hash so that we can compare Entry Group objects.
+      def ==(other)
+        other.is_a?(Project) &&
+          project_name == other.project_name &&
+          description == other.description &&
+          version == other.version
+      end
+      alias eql? ==
+
+      def can_delete?
+        self.class.can_delete?(project_name: project_name)
+      end
+
+      def create
+        self.class.create(project_name: project_name, description: description)
+      end
+      alias save create
+
+      def create!
+        self.class.create!(project_name: project_name, description: description)
+      end
+      alias save! create!
+
+      def current_project?
+        self.class.current_project?(project_name: project_name)
+      end
+
+      def default!
+        return if default_project?
+
+        self.class.default!(project: self)
+      end
+
+      def default_project?
+        self.class.default_project?(project_name: project_name)
+      end
+
+      def delete
+        self.class.delete(project_name: project_name)
+      end
+
+      def delete!
+        self.class.delete!(project_name: project_name)
+      end
+
+      def hash
+        [project_name, description, version].map(&:hash).hash
+      end
+
+      def project_file
+        self.class.project_file(project_name: project_name)
+      end
+
+      def project_folder
+        self.class.project_folder(project_name: project_name)
+      end
+
+      def rename!(new_project_name:, new_project_description: nil)
+        self.class.rename!(project_name: project_name,
+          new_project_name: new_project_name, new_project_description: new_project_description, options: options)
+      end
+
+      def to_h
+        {
+          version: version,
+          project_name: project_name,
+          description: description
+        }
+      end
+
+      # def update
+      #   self.class.update(project_name: project_name, description: description, version: version, options: options)
+      # end
+
+      # def update!
+      #   self.class.update!(project_name: project_name, description: description, version: version, options: options)
+      # end
+
+      def use!
+        return if current_project?
+
+        self.class.use!(project: self)
+      end
+
+      class << self
+        delegate :project_file_for, :project_folder_for, to: Support::Fileable
+
+        def all
+          project_metadata.map do |metadata|
+            find(project_name: metadata[:project_name])
+          end
+        end
+
+        def can_delete?(project_name:)
+          exist?(project_name: project_name) &&
+            # Cannot delete the last project.
+            count > 1 &&
+            # Do not allow the project to be deleted if it
+            # is currently the default project.
+            # The user needs to change to another default
+            # project before they can delete this project.
+            !default_project?(project_name: project_name)
+        end
+
+        def count
+          project_metadata.count
+        end
+
+        def create(project_name:, description: nil, options: {})
+          Models::Project.new(project_name: project_name, description: description, options: options).tap do |project|
+            project.validate!
+            initialize_project(project_name: project_name)
+            Crud::JsonFile.write!(file_data: project.to_h,
+              file_path: project_file_for(project_name: project_name))
+          end
+        end
+        alias update create
+
+        def create!(project_name:, description: nil, options: {})
+          if exist?(project_name: project_name)
+            raise I18n.t('models.project.errors.already_exists', project_name: project_name)
+          end
+
+          create(project_name: project_name, description: description, options: options)
+        end
+        alias update! create!
+
+        def current_project
+          find(project_name: current_project_name)
+        end
+
+        def current_project?(project_name:)
+          current_project_name == project_name
+        end
+
+        def default!(project:)
+          project.validate!
+
+          Models::Configuration.new.tap do |configuration|
+            configuration.default_project = project.project_name
+            configuration.save!
+          end
+        end
+
+        def default_project
+          find(project_name: default_project_name)
+        end
+
+        def default_project?(project_name:)
+          project_name == default_project_name
+        end
+
+        def delete(project_name:)
+          return false unless can_delete?(project_name: project_name)
+
+          project_folder = project_folder_for(project_name: project_name)
+          FileUtils.rm_rf(project_folder)
+
+          true
+        end
+
+        def delete!(project_name:)
+          unless exist?(project_name: project_name)
+            raise I18n.t('models.project.errors.does_not_exist', project_name: project_name)
+          end
+
+          raise I18n.t('models.project.errors.delete_only_project', project_name: project_name) unless count > 1
+
+          if default_project?(project_name: project_name)
+            raise I18n.t('models.project.errors.delete_default_project', project_name: project_name)
+          end
+
+          delete(project_name: project_name)
+        end
+
+        def find(project_name:)
+          unless project_folder_exist?(project_name: project_name)
+            raise I18n.t('models.project.errors.does_not_exist', project_name: project_name)
+          end
+
+          project_file = project_file_for(project_name: project_name)
+
+          unless project_file_exist?(project_name: project_name)
+            raise I18n.t('models.project.errors.project_file_not_exist', project_file: project_file)
+          end
+
+          project_hash = Crud::JsonFile.read!(file_path: project_file)
+          Services::Project::HydratorService.new(project_hash: project_hash).call
+        end
+
+        # project_number is 1 based.
+        def find_by_number(project_number:)
+          project = project_metadata.find do |metadata|
+            metadata[:project_number] == project_number.to_i
+          end
+          return unless project
+
+          find(project_name: project[:project_name])
+        end
+
+        # def find_or_create(project_name:)
+        #   find_or_initialize(project_name: project_name).tap do |project|
+        #     project.save! unless project.persisted?
+        #   end
+        # end
+
+        def find_or_initialize(project_name:)
+          return Models::Project.new(project_name: project_name) unless project_file_exist?(project_name: project_name)
+
+          project_file = project_file_for(project_name: project_name)
+          project_hash = Crud::JsonFile.read!(file_path: project_file)
+          Services::Project::HydratorService.new(project_hash: project_hash).call
+        end
+
+        def rename!(project_name:, new_project_name:, new_project_description: nil, options: {})
+          Services::Project::RenameService.new(from_project_name: project_name,
+            to_project_name: new_project_name, to_project_description: new_project_description, options: options).call
+        end
+
+        def use!(project:)
+          project.validate!
+
+          current_project_hash = { version: project.version, project_name: project.project_name }
+          Crud::JsonFile.write!(file_data: current_project_hash, file_path: current_project_file)
+        end
+      end
+
+      private
+
+      attr_writer :current_project_file, :options, :version
+
+      def description=(value)
+        @description = if value.blank?
+          "#{project_name} project"
+        else
+          value
+        end
+      end
+
+      def project_name=(value)
+        @project_name = begin
+          @current_project_file = project_folder_for(project_name: value)
+          value
+        end
+      end
+    end
+  end
+end

data/lib/dsu/presenters/base_presenter_ex.rb

@@ -1,26 +1,15 @@
 # frozen_string_literal: true
 
-require 'delegate'
-require_relative '../models/color_theme'
-require_relative '../support/color_themable'
-
 module Dsu
   module Presenters
     class BasePresenterEx
-      include Support::ColorThemable
-
       def initialize(options: {})
         @options = options&.dup || {}
-        @color_theme = Models::ColorTheme.find(theme_name: theme_name)
       end
 
       private
 
-      attr_reader :color_theme, :options
-
-      def theme_name
-        @theme_name ||= options.fetch(:theme_name, Models::Configuration.new.theme_name)
-      end
+      attr_accessor :options
     end
   end
 end