dsu 3.0.0.alpha.12 → 3.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74b0eee10983a1ccd33981f635c7bc267dd8db84cfe8496c39fa5386c57096d2
-  data.tar.gz: f65368dfbb2de3512a73f766f82958de92255e4a72b3e5f58389d0db2ccd86ad
+  metadata.gz: a4e9cb8f6a8eb3af6363f9d7fc277e72082db6964dcdecd07a40b5c499ebc438
+  data.tar.gz: b85536f382ed639c5cecd06a16d148c378ca742f5156be1ad18cc16f4a5116dc
 SHA512:
-  metadata.gz: 9c91fa9f3916538d244ffca9456ea089a258fb0701f182d6e40e0fad5c51deec986ac0835e611a3b042cf8c0dc84b27b0a7175a388a9ed38ee34bc34de0a865d
-  data.tar.gz: 940939975bb206402a13f5c4b1dd8a9f0308fe787fada7e0d59e70a6769eeb960755fd3d4aba7aa480b45cdf9a4c837dfda5382b284c7e5bbb4631d98d4f01ef
+  metadata.gz: a91851e7a145ba77b00959e8207a9334f4f7ea798dab4374ea339a61168c3363118b31ebaa6ad919358f957c0947ffece2ac445eb3f3cf512af4a23826910a5d
+  data.tar.gz: 5cf55b4b71387efee97919933553c050f4ac5ddf7746f800e63ebb8f8e2d09808778cc949d2725bc1f6ce80eae2bf991aa211ed845ed5c601c675d3be3a51e8d

data/.rubocop.yml

@@ -1,6 +1,8 @@
 require:
   - rubocop-performance
   - rubocop-rspec
+  - rubocop-factory_bot
+  - rubocop-rake
 
 AllCops:
   TargetRubyVersion: 3.0.1

data/CHANGELOG.md

@@ -10,6 +10,7 @@ All notable changes to this project will be documented in this file.
 
 ### Changes
 [x] Update ruby gems.
+[x] `dsu import` now has the --override true|false (default: false) OPTION. If true, the import process will ignore the project name found in the import file and import the entries into the current project. If false, the import process will use the project name found in the import file.
 [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"
@@ -42,6 +43,7 @@ dsu x dd -f n -t -257
 dsu-export-default-20240129125946-entry-groups-2023-05-17-thru-2024-01-29.csv
 
 ### Bug Fixes
+[x] Fix bug that did not gracefully handle invalid DATEs for the `dsu add --date DATE` command.
 
 
 ## [2.4.4] - 2024-01-28

data/Gemfile

@@ -6,14 +6,14 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'dotenv', '~> 2.8', '>= 2.8.1'
+gem 'factory_bot', '~> 6.3'
+gem 'ffaker', '~> 2.21'
+gem 'pry-byebug', '~> 3.9'
 gem 'rake', '~> 13.0'
+gem 'reek', '~> 6.1', '>= 6.1.1'
 gem 'rspec', '~> 3.0'
 gem 'rubocop', '~> 1.50', '>= 1.50.2'
 gem 'rubocop-performance', '~> 1.19'
+gem 'rubocop-rake', '~> 0.6.0'
 gem 'rubocop-rspec', '~> 2.23'
-
-gem 'factory_bot', '~> 6.3'
-gem 'ffaker', '~> 2.21'
-gem 'pry-byebug', '~> 3.9'
-gem 'reek', '~> 6.1', '>= 6.1.1'
 gem 'simplecov', '~> 0.22.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dsu (3.0.0.alpha.4)
+    dsu (3.0.0.rc.1)
       activemodel (>= 7.0.8, < 8.0)
       activesupport (>= 7.0.8, < 8.0)
       colorize (>= 1.1, < 2.0)
@@ -32,7 +32,7 @@ GEM
     colorize (1.1.0)
     concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
-    diff-lcs (1.5.0)
+    diff-lcs (1.5.1)
     docile (1.4.0)
     dotenv (2.8.1)
     drb (2.2.0)
@@ -64,7 +64,7 @@ GEM
       dry-inflector (~> 1.0)
       dry-logic (~> 1.4)
       zeitwerk (~> 2.6)
-    factory_bot (6.4.5)
+    factory_bot (6.4.6)
       activesupport (>= 5.0.0)
     ffaker (2.23.0)
     i18n (1.14.1)
@@ -72,7 +72,7 @@ GEM
     json (2.7.1)
     language_server-protocol (3.17.0.3)
     method_source (1.0.0)
-    minitest (5.21.2)
+    minitest (5.22.2)
     mutex_m (0.2.0)
     os (1.1.4)
     parallel (1.24.0)
@@ -95,19 +95,19 @@ GEM
       rexml (~> 3.1)
     regexp_parser (2.9.0)
     rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
     rubocop (1.60.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
@@ -128,6 +128,8 @@ GEM
     rubocop-performance (1.20.2)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.30.0, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     rubocop-rspec (2.26.1)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
@@ -145,7 +147,7 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
-    zeitwerk (2.6.12)
+    zeitwerk (2.6.13)
 
 PLATFORMS
   x86_64-darwin-19
@@ -163,6 +165,7 @@ DEPENDENCIES
   rspec (~> 3.0)
   rubocop (~> 1.50, >= 1.50.2)
   rubocop-performance (~> 1.19)
+  rubocop-rake (~> 0.6.0)
   rubocop-rspec (~> 2.23)
   simplecov (~> 0.22.0)
 

data/lib/dsu/cli.rb

@@ -40,7 +40,8 @@ module Dsu
     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, mnemonic_option_description: mnemonic_option_description)
-    option I18n.t('options.date.name'), aliases: I18n.t('options.date.aliases'), type: :string
+    option I18n.t('options.date_or_mnemonic.name'), aliases: I18n.t('options.date_or_mnemonic.aliases'),
+      type: :string, banner: I18n.t('options.date_or_mnemonic.banner')
     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

data/lib/dsu/crud/json_file.rb

@@ -2,6 +2,7 @@
 
 require 'active_model'
 require 'json'
+require_relative '../migration/version'
 
 module Dsu
   module Crud
@@ -14,6 +15,10 @@ module Dsu
         @file_path = file_path
       end
 
+      def update_version!
+        @version = Migration::VERSION
+      end
+
       def delete
         self.class.delete(file_path: file_path)
       end

data/lib/dsu/migration/base_service.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require_relative '../models/migration_version'
+require_relative '../support/fileable'
+require_relative 'version'
+
+module Dsu
+  module Migration
+    class BaseService
+      include Support::Fileable
+
+      def initialize(options: {})
+        @options = options || {}
+      end
+
+      class << self
+        def migrates_to_latest_migration_version?
+          to_migration_version == Migration::VERSION
+        end
+
+        # The migration version that this migration is upgrading from.
+        def from_migration_version
+          raise NotImplementedError, 'You must implement the #from_migration_version method in your subclass'
+        end
+
+        # The migration version that this migration is upgrading to.
+        def to_migration_version
+          raise NotImplementedError, 'You must implement the #to_migration_version method in your subclass'
+        end
+      end
+
+      def migrate_if!
+        return unless run_migration?
+
+        puts "Running migrations #{from_migration_version} -> #{to_migration_version}..."
+        puts "\tpretend?: #{pretend?}" if pretend?
+
+        run_migration!
+        update_migration_version!
+
+        puts "\tMigration #{from_migration_version} -> #{to_migration_version} complete."
+      end
+
+      private
+
+      attr_accessor :options
+
+      # You must implement your own migration logic in your subclass and call this method.
+      def run_migration!
+        create_backup
+      end
+
+      def pretend?
+        options.fetch(:pretend, true)
+      end
+
+      def run_migration?
+        migration_version == from_migration_version
+      end
+
+      # The migration version that this migration is upgrading from.
+      def from_migration_version
+        self.class.from_migration_version
+      end
+
+      # The migration version that this migration is upgrading to.
+      def to_migration_version
+        self.class.to_migration_version
+      end
+
+      # The migration version before running this migration.
+      def migration_version
+        # Typically we should not be using models in any of the migration services
+        # because if these change, the migrations will break. However, using
+        # the MigrationVersion model is an exception because it is a very simple
+        # model and is unlikely to change.
+        Models::MigrationVersion.new.version
+      end
+
+      def create_backup
+        puts "Creating backup #{backup_folder}..."
+
+        return puts "\tSkipping: backup already exists." if backup_exist?
+
+        FileUtils.cp_r(dsu_folder, backup_folder)
+        FileUtils.cp(config_path, backup_folder)
+      end
+
+      def backup_exist?
+        Dir.exist?(backup_folder)
+      end
+
+      def backup_folder
+        @backup_folder ||= backup_folder_for(migration_version: from_migration_version)
+      end
+
+      def update_migration_version!
+        puts 'Updating migration version...'
+
+        return if pretend? || migration_version == to_migration_version
+
+        Models::MigrationVersion.new(version: to_migration_version).save!
+      end
+
+      def seed_data_folder
+        seed_data_dsu_folder_for(migration_version: to_migration_version)
+      end
+
+      def seed_data_configuration
+        seed_data_dsu_configuration_for(migration_version: to_migration_version)
+      end
+
+      def raise_backup_folder_does_not_exist_error_if!
+        raise "Backup folder #{backup_folder} does not exist, cannot continue" unless backup_exist?
+      end
+    end
+  end
+end

data/lib/dsu/migration/migrator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../env'
+require_relative 'version'
+
+module Dsu
+  module Migration
+    class Migrator
+      class << self
+        def migrate_if!(migration_services: [])
+          return if migration_services.any? do |migration_service|
+            migration_service.migrate_if!
+            migration_service.class.migrates_to_latest_migration_version?
+          end
+
+          raise I18n.t('migrations.error.missing_current_migration_service', migration_version: Migration::VERSION)
+        rescue StandardError => e
+          puts I18n.t('migrations.error.failed', message: e.message)
+          exit 1 unless Dsu.env.test?
+        end
+      end
+    end
+  end
+end

data/lib/dsu/migration/raw_helpers/color_theme_hash.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Migration
+    module RawHelpers
+      module ColorThemeHash
+        def to_h
+          read.merge(version: version)
+        end
+      end
+    end
+  end
+end

data/lib/dsu/migration/raw_helpers/configuration_hash.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Migration
+    module RawHelpers
+      module ConfigurationHash
+        attr_accessor :default_project
+
+        def to_h
+          read.merge(version: version, default_project: default_project)
+        end
+      end
+    end
+  end
+end

data/lib/dsu/migration/raw_helpers/entry_group_hash.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Migration
+    module RawHelpers
+      module EntryGroupHash
+        def to_h
+          read.merge(version: version)
+        end
+      end
+    end
+  end
+end

data/lib/dsu/migration/raw_json_file.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../crud/json_file'
+
+module Dsu
+  module Migration
+    class RawJsonFile < Crud::JsonFile
+      public :read, :read!, :version=
+
+      def to_h
+        read.merge(version: version)
+      end
+    end
+  end
+end

data/lib/dsu/migration/raw_json_files.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'pathname'
+
+require_relative 'raw_json_file'
+
+module Dsu
+  module Migration
+    class RawJsonFiles
+      attr_reader :folder
+
+      def initialize(folder)
+        @folder = folder
+      end
+
+      def each_file(regex: //)
+        return unless folder_exist?
+
+        Pathname.new(folder).children.each do |child|
+          next unless child.file? && child.to_s.match?(regex)
+
+          yield RawJsonFile.new(child)
+        end
+      end
+
+      def folder_exist?
+        self.class.folder_exist?(folder: folder)
+      end
+
+      class << self
+        def folder_exist?(folder:)
+          Dir.exist?(folder)
+        end
+      end
+
+      private
+
+      attr_writer :folder
+
+      def safe_cp_r(source, destination)
+        Pathname.new(source).find do |source_path|
+          next if source_path.directory?
+
+          relative_path = source_path.relative_path_from(Pathname.new(source))
+          target_path = Pathname.new(destination).join(relative_path)
+
+          next if target_path.exist?
+
+          FileUtils.mkdir_p(target_path.dirname)
+          FileUtils.cp(source_path, target_path)
+        end
+      end
+    end
+  end
+end

data/lib/dsu/migration/v20230613121411/service.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative '../base_service'
+require_relative '../raw_helpers/entry_group_hash'
+require_relative '../version'
+
+module Dsu
+  module Migration
+    module V20230613121411
+      class Service < BaseService
+        class << self
+          def from_migration_version
+            0
+          end
+
+          def to_migration_version
+            20230613121411 # rubocop:disable Style/NumericLiterals
+          end
+        end
+
+        private
+
+        def run_migration!
+          super
+
+          raise_backup_folder_does_not_exist_error_if!
+
+          delete_old_config_file
+          delete_old_themes_folder
+
+          copy_new_dsu_folders
+          copy_new_dsu_configuration
+          migrate_entry_groups
+        end
+
+        def config_file_from
+          File.join(root_folder, '.dsu')
+        end
+
+        def dsu_folder_from
+          File.join(root_folder, 'dsu')
+        end
+
+        def entries_folder_from
+          File.join(dsu_folder_from, 'entries')
+        end
+
+        def themes_folder_from
+          File.join(dsu_folder_from, 'themes')
+        end
+
+        def copy_new_dsu_folders
+          puts 'Copying new dsu folders...'
+
+          FileUtils.cp_r(File.join(seed_data_folder, '.'), File.join(root_folder, 'dsu')) unless pretend?
+        end
+
+        def copy_new_dsu_configuration
+          puts 'Copying new dsu configuration...'
+
+          FileUtils.cp(seed_data_configuration, config_folder) unless pretend?
+        end
+
+        def migrate_entry_groups
+          puts 'Migrating entry groups...'
+
+          return if pretend?
+
+          puts "\tUpdating entry group version..."
+
+          RawJsonFiles.new(entries_folder_from).each_file(regex: /\d{4}-\d{2}-\d{2}.json/) do |raw_entry_group|
+            raw_entry_group.extend(RawHelpers::EntryGroupHash)
+            raw_entry_group.version = to_migration_version
+            raw_entry_group.save!
+          end
+        end
+
+        def delete_old_config_file
+          puts 'Deleting old configuration file...'
+
+          return if pretend?
+
+          File.delete(config_file_from) if File.file?(config_file_from)
+        end
+
+        def delete_old_themes_folder
+          puts 'Deleting old themes folder...'
+
+          FileUtils.rm_rf(themes_folder_from) unless pretend?
+        end
+      end
+    end
+  end
+end

data/lib/dsu/migration/v20240210161248/service.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+require_relative '../base_service'
+require_relative '../raw_helpers/color_theme_hash'
+require_relative '../raw_helpers/configuration_hash'
+require_relative '../raw_helpers/entry_group_hash'
+require_relative '../raw_json_file'
+require_relative '../version'
+
+module Dsu
+  module Migration
+    module V20240210161248
+      class Service < BaseService
+        class << self
+          def from_migration_version
+            20230613121411 # rubocop:disable Style/NumericLiterals
+          end
+
+          def to_migration_version
+            20240210161248 # rubocop:disable Style/NumericLiterals
+          end
+        end
+
+        private
+
+        def run_migration!
+          super
+
+          raise_backup_folder_does_not_exist_error_if!
+
+          add_new_color_themes
+          create_default_project
+          create_current_project_file
+          update_configuration
+          update_entry_groups
+          update_color_themes
+          delete_old_entry_folder
+
+          puts 'Migration completed successfully.'
+        end
+
+        def dsu_folder_from
+          File.join(root_folder, 'dsu')
+        end
+
+        def entries_folder_from
+          File.join(dsu_folder_from, 'entries')
+        end
+
+        def themes_folder_from
+          File.join(dsu_folder_from, 'themes')
+        end
+
+        def add_new_color_themes
+          puts 'Copying new color themes...'
+
+          FileUtils.mkdir_p(themes_folder_from) unless pretend?
+
+          %w[light.json christmas.json].each do |theme_file|
+            destination_theme_file_path = File.join(themes_folder_from, theme_file)
+            # Don't skip these theme files because they were deployed in the previous
+            # dsu version with bugs. We need to overwrite them with this new version.
+            # next if File.exist?(destination_theme_file_path)
+
+            source_theme_file_path = File.join(seed_data_folder, 'themes', theme_file)
+            FileUtils.cp(source_theme_file_path, destination_theme_file_path) unless pretend?
+          end
+        end
+
+        def create_default_project
+          puts "Creating default project \"#{default_project_name}\"..."
+
+          return if pretend?
+
+          FileUtils.cp_r(File.join(seed_data_folder, 'projects', '.'),
+            File.join(dsu_folder, 'projects'))
+        end
+
+        def create_current_project_file
+          puts 'Creating current project file...'
+
+          return if pretend?
+
+          # NOTE: dsu_folder won't change and is safe to use here.
+          FileUtils.cp(File.join(seed_data_folder, 'current_project.json'), dsu_folder)
+        end
+
+        def update_configuration
+          puts 'Updating configuration...'
+
+          return if pretend?
+
+          # NOTE: config_path won't change and is safe to use here.
+          RawJsonFile.new(config_path).tap do |configuration_file|
+            configuration_file.extend(RawHelpers::ConfigurationHash)
+            configuration_file.version = to_migration_version
+            configuration_file.default_project = default_project_name
+          end.save!
+        end
+
+        def update_entry_groups
+          puts 'Updating entry groups...'
+
+          return if pretend?
+
+          puts "\tCopying entries to default project \"#{default_project_name}\"..."
+
+          entries_folder_to = File.join(dsu_folder, 'projects', default_project_name, 'entries')
+          FileUtils.cp_r(File.join(entries_folder_from, '.'), entries_folder_to)
+
+          puts "\tUpdating entry group version..."
+
+          RawJsonFiles.new(entries_folder_to).each_file(regex: /\d{4}-\d{2}-\d{2}.json/) do |raw_entry_group|
+            raw_entry_group.extend(RawHelpers::EntryGroupHash)
+            raw_entry_group.version = to_migration_version
+            raw_entry_group.save!
+          end
+        end
+
+        def update_color_themes
+          puts 'Updating color themes...'
+
+          FileUtils.cp_r(File.join(backup_folder, 'themes', '.'), themes_folder) unless pretend?
+
+          puts "\tUpdating color theme version..."
+
+          themes_folder_to = File.join(dsu_folder, 'themes')
+
+          RawJsonFiles.new(themes_folder_to).each_file(regex: /.+.json/) do |raw_entry_group|
+            raw_entry_group.extend(RawHelpers::ColorThemeHash)
+            raw_entry_group.version = to_migration_version
+            raw_entry_group.save! unless pretend?
+          end
+        end
+
+        def delete_old_entry_folder
+          puts 'Cleaning up old entries...'
+
+          FileUtils.rm_rf(File.join(entries_folder_from)) unless pretend?
+        end
+
+        def default_project_name
+          'default'
+        end
+      end
+    end
+  end
+end