dsu 2.4.4 → 3.0.0.alpha.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c10a6ea372abaf638d307992a6b264c77e00401bb010ed6c9088d0ac5c692bb6
-  data.tar.gz: 45d0e54077c23c4ceaa73c8fbeaf763a185b9a391f3dbc2c3ab601c3c529bfe8
+  metadata.gz: 2588c231eb86067d69a619e6d0abb2d4bf2bcaef6c5b98fe7d6a33f34ff49241
+  data.tar.gz: 5cf24d7762067a3d57aa9219ac0e176e5520c5a18a71e0af0b9dad31f670d040
 SHA512:
-  metadata.gz: 7d4692b7a049fc2bb18933664fbfabef1b5b30824edef65a899b4a545ef602735b6bb7f84696daa60eeec3189abefadce16b1d9efe1c7876ff0988136ec74b16
-  data.tar.gz: 98d7187717424c4c9ff401a5757a1c11b75cccaaec082692f67854033849a229521d221a3cd6118dcf950bf19611b78f963d70ac0cd92b962b6365aaf479411b
+  metadata.gz: edf0a827764efa759ec4194badd79fcf9b2734ec9fa4d6d96f90ddcce12b29d9c33e436c1ea7914249f609eae354640c8693ce0d0c5e14a9d8d1d5329126575f
+  data.tar.gz: 19f9864924cfa053385e72da1ff7dda211a6dac1c8f14798bbbc10e39e420581a35e760fae11124fd45913d317cc5a2f3f74334a4c23856fb5e35d289d5e6aaa

data/.rubocop.yml

@@ -190,3 +190,15 @@ Style/StringMethods:
 # Checks for use of parentheses around ternary conditions.
 Style/TernaryParentheses:
   EnforcedStyle: require_parentheses_when_complex
+
+RSpec/NotToNot:
+  EnforcedStyle: to_not
+  SupportedStyles:
+    - to_not
+    - not_to
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 6

data/CHANGELOG.md

@@ -2,6 +2,48 @@
 
 All notable changes to this project will be documented in this file.
 
+## [3.0.0] - 2024-??-??
+
+### Enhancements
+[x] Added `dsu project` command to manage DSU projects. See `dsu help project` or the [dsu wiki](https://github.com/gangelo/dsu/wiki) for more information.
+[x] The `dsu add` command how allows you to add entries using mnemonics and relative date mnemonics (RDMs) in addition to absolute dates. For example, `dsu add -d -7 "My entry"` will add an entry one week in the past from the current day. See `dsu help add` for more information.
+
+### Changes
+[x] Update ruby gems.
+[x] Change `dsu export` file name for exports. When exporting all DSU entry groups for a project, the file name will be:
+
+"dsu-export-<transformed project name>-<timestamp>-all-entry-groups-<from date>-thru-<to date>.csv"
+
+When exporting DSU entry groups for a project between two given dates, the file name will be:
+
+"dsu-export-<transformed project name>-<timestamp>-entry-groups-<from date>-thru-<to date>.csv"
+
+- Where <transformed project name> = is the project name transformed to a format appropriate to be part of a file name.
+- Where <timestamp> = is the current timestamp in the format: YYYYMMDDHHMMSS
+- Where <from date> = is the from date in the format: YYYY-MM-DD
+- Where <to date> = is the to date in the format: YYYY-MM-DD
+
+When exporting all DSU entry groups for a project, the <from date> and <to date> will represent the earliest and most recent entry group dates for the project, respectfully. For example:
+
+```
+# Where current date is 2024-01-29, and the earliest entry group date is 2023-08-11 and the most recent entry group date is 2024-01-27.
+$ dsu x a
+```
+
+dsu-export-default-20240129130013-all-entry-groups-2023-08-11-thru-2024-01-27.csv
+
+When exporting DSU entry groups between a to and from date for a project, the <from date> and <to date> will represent the from and to dates entered by the user on the command line, respectfully. For example:
+
+```
+# Where current date is 2024-01-29, and the from date entered on the command line is2023-08-11 and the from date entered on the command line is 2024-01-27.
+dsu x dd -f n -t -257
+```
+
+dsu-export-default-20240129125946-entry-groups-2023-05-17-thru-2024-01-29.csv
+
+### Bug Fixes
+
+
 ## [2.4.4] - 2024-01-28
 ### Changes
 [x] Update ruby gems.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dsu (2.4.4)
+    dsu (3.0.0.alpha.0)
       activemodel (>= 7.0.8, < 8.0)
       activesupport (>= 7.0.8, < 8.0)
       colorize (>= 1.1, < 2.0)

data/README.md

@@ -1,8 +1,8 @@
 # `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=11)](https://badge.fury.io/gh/gangelo%2Fdsu)
-[![Gem Version](https://badge.fury.io/rb/dsu.svg?refresh=11)](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)

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'