dsu 0.1.0.alpha.5 → 1.0.0

data/lib/dsu/views/edited_entries/shared/errors.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative '../../shared/messages'
+
+module Dsu
+  module Views
+    module EditedEntries
+      module Shared
+        class Errors
+          def initialize(edited_entries:, options: {})
+            raise ArgumentError, 'edited_entries is nil' if edited_entries.nil?
+            raise ArgumentError, 'edited_entries is the wrong object type' unless edited_entries.is_a?(Array)
+            unless edited_entries.all?(Models::EditedEntry)
+              raise ArgumentError, 'edited_entries elements are the wrong object type'
+            end
+            raise ArgumentError, 'options is nil' if options.nil?
+            raise ArgumentError, 'options is the wrong object type' unless options.is_a?(Hash)
+
+            @edited_entries = edited_entries
+            @options = options || {}
+            @header = options[:header] || 'The following ERRORS were encountered; these changes were not saved:'
+          end
+
+          def render
+            return if edited_entries.empty?
+            return if edited_entries.all?(&:valid?)
+
+            messages = edited_entries.map { |edited_entry| edited_entry.errors.full_messages }.flatten
+            Views::Shared::Messages.new(messages: messages, message_type: :error, options: { header: header }).render
+          end
+
+          private
+
+          attr_reader :edited_entries, :header, :options
+        end
+      end
+    end
+  end
+end

data/lib/dsu/views/entry_group/edit.rb

@@ -3,8 +3,6 @@
 require 'time'
 require 'active_support/core_ext/numeric/time'
 require_relative '../../models/entry_group'
-require_relative '../../support/colorable'
-require_relative '../../support/say'
 require_relative '../../support/time_formatable'
 
 module Dsu
@@ -25,46 +23,43 @@ module Dsu
           @options = options || {}
         end
 
-        def call
-          # Just in case the entry group is invalid, we'll
-          # validate it before displaying it.
-          entry_group.validate!
-          render_entry_group!
-        rescue ActiveModel::ValidationError
-          puts "Error(s) encountered: #{entry_group.errors.full_messages}"
-          raise
+        def render
+          puts render_as_string
         end
-        alias render call
-
-        private
 
-        attr_reader :entry_group, :options
+        def render_as_string
+          # Just in case the entry group is invalid, we'll validate it before displaying it.
+          entry_group.validate!
 
-        def render_entry_group!
-          say "# Editing DSU Entries for #{formatted_time(time: entry_group.time)}"
           # TODO: Display entry group entries from the previous DSU date so they can be
           # easily copied over; or, add them to the current entry group entries below as
-          # a "# [+|a|add] <entry group from previous DSU entry description>" (e.g. commented
-          # out) by default?
-          say ''
-          say '# [SHA/COMMAND] [DESCRIPTION]'
+          # a "# [+|a|add] <entry group from previous DSU entry description>"
+          # (e.g. commented out) by default?
+
+          <<~EDIT_VIEW
+            # Editing DSU Entries for #{formatted_time(time: entry_group.time)}
+            # [ENTRY DESCRIPTION]
 
-          entry_group.entries.each do |entry|
-            say "#{entry.uuid} #{entry.description.strip}"
-          end
+            #{entry_group_entry_lines.each(&:strip).join("\n")}
+
+            # INSTRUCTIONS:
+            #    ADD a DSU entry: type an ENTRY DESCRIPTION on a new line.
+            #   EDIT a DSU entry: change the existing ENTRY DESCRIPTION.
+            # DELETE a DSU entry: delete the ENTRY DESCRIPTION.
+            #  NOTE: deleting all of the ENTRY DESCRIPTIONs will delete the entry group file;
+            #        this is preferable if this is what you want to do :)
+            # REORDER a DSU entry: reorder the ENTRY DESCRIPTIONs in order preference.
+            #
+            # *** When you are done, save and close your editor ***
+          EDIT_VIEW
+        end
+
+        private
+
+        attr_reader :entry_group, :options
 
-          say ''
-          say '# INSTRUCTIONS:'
-          say '# ADD a DSU entry: use one of the following commands: [+|a|add] ' \
-              'followed by the description.'
-          say '# EDIT a DSU entry: change the description.'
-          say '# DELETE a DSU entry: delete the entry or replace the sha with one ' \
-              'of the following commands: [-|d|delete].'
-          say '# NOTE: deleting all the entries will delete the entry group file; '
-          say '#       this is preferable if this is what you want to do :)'
-          say '# REORDER a DSU entry: reorder the DSU entries in order preference.'
-          say '#'
-          say '# *** When you are done, save and close your editor ***'
+        def entry_group_entry_lines
+          entry_group.entries.map(&:description)
         end
       end
     end

data/lib/dsu/views/entry_group/show.rb

@@ -26,7 +26,7 @@ module Dsu
         end
 
         def call
-          render_entry_group!
+          render!
         end
         alias render call
 
@@ -34,18 +34,24 @@ module Dsu
 
         attr_reader :entry_group, :options
 
-        def render_entry_group!
+        def render!
           say formatted_time(time: entry_group.time), HIGHLIGHT
           say('(no entries available for this day)') and return if entry_group.entries.empty?
 
           entry_group.entries.each_with_index do |entry, index|
-            prefix = "#{format('%03s', index + 1)}. #{entry.uuid}"
+            prefix = "#{format('%03s', index + 1)}. "
             description = colorize_string(string: entry.description, mode: :bold)
             entry_info = "#{prefix} #{description}"
-            entry_info = "#{entry_info} (validation failed)" unless entry.valid?
+            unless entry.valid?
+              entry_info = "#{entry_info} (validation failed: #{entry_errors(entry_group_deleter_service)})"
+            end
             say entry_info
           end
         end
+
+        def entry_errors(entry)
+          entry.errors.full_messages.join(', ')
+        end
       end
     end
   end

data/lib/dsu/views/shared/messages.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require_relative '../../support/colorable'
+require_relative '../../support/say'
+
+module Dsu
+  module Views
+    module Shared
+      class Messages
+        include Support::Colorable
+        include Support::Say
+
+        MESSAGE_TYPES = %i[error info success warning].freeze
+
+        def initialize(messages:, message_type:, options: {})
+          messages = [messages] unless messages.is_a?(Array)
+
+          validate_arguments!(messages, message_type, options)
+
+          @messages = messages.select(&:present?)
+          @message_type = message_type
+          # We've inluded Support::Colorable, so simply upcase the message_type
+          # and convert it to a symbol; this will equate to the color we want.
+          @message_color = self.class.const_get(message_type.to_s.upcase)
+          @options = options || {}
+          @header = options[:header]
+        end
+
+        def render
+          return if messages.empty?
+
+          say header, message_color if header.present?
+
+          messages.each_with_index do |message, index|
+            say "#{index + 1}. #{message}", message_color
+          end
+        end
+
+        private
+
+        attr_reader :messages, :message_color, :message_type, :header, :options
+
+        def validate_arguments!(messages, message_type, options)
+          raise ArgumentError, 'messages is nil' if messages.nil?
+          raise ArgumentError, 'messages is the wrong object type' unless messages.is_a?(Array)
+          raise ArgumentError, 'messages elements are the wrong object type' unless messages.all?(String)
+          raise ArgumentError, 'message_type is nil' if message_type.nil?
+          raise ArgumentError, 'message_type is the wrong object type' unless message_type.is_a?(Symbol)
+          raise ArgumentError, 'message_type is not a valid message type' unless MESSAGE_TYPES.include?(message_type)
+          raise ArgumentError, 'options is nil' if options.nil?
+          raise ArgumentError, 'options is the wrong object type' unless options.is_a?(Hash)
+        end
+      end
+    end
+  end
+end

data/lib/dsu.rb

@@ -5,6 +5,10 @@ require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/numeric/time'
 
+Dir.glob("#{__dir__}/lib/core/**/*.rb").each do |file|
+  require file
+end
+
 Dir.glob("#{__dir__}/dsu/**/*.rb").each do |file|
   require file
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dsu
 version: !ruby/object:Gem::Version
-  version: 0.1.0.alpha.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Gene M. Angelo, Jr.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-12 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -158,6 +158,7 @@ files:
 - lib/dsu/services/entry_group_reader_service.rb
 - lib/dsu/services/entry_group_writer_service.rb
 - lib/dsu/services/entry_hydrator_service.rb
+- lib/dsu/services/stdout_redirector_service.rb
 - lib/dsu/services/temp_file_reader_service.rb
 - lib/dsu/services/temp_file_writer_service.rb
 - lib/dsu/subcommands/config.rb
@@ -165,9 +166,6 @@ files:
 - lib/dsu/subcommands/list.rb
 - lib/dsu/support/ask.rb
 - lib/dsu/support/colorable.rb
-- lib/dsu/support/commander/command.rb
-- lib/dsu/support/commander/command_help.rb
-- lib/dsu/support/commander/subcommand.rb
 - lib/dsu/support/configuration.rb
 - lib/dsu/support/descriptable.rb
 - lib/dsu/support/entry_group_fileable.rb
@@ -175,15 +173,17 @@ files:
 - lib/dsu/support/entry_group_viewable.rb
 - lib/dsu/support/field_errors.rb
 - lib/dsu/support/folder_locations.rb
-- lib/dsu/support/interactive/cli.rb
 - lib/dsu/support/say.rb
 - lib/dsu/support/time_formatable.rb
 - lib/dsu/support/times_sortable.rb
+- lib/dsu/validators/description_validator.rb
 - lib/dsu/validators/entries_validator.rb
 - lib/dsu/validators/time_validator.rb
 - lib/dsu/version.rb
+- lib/dsu/views/edited_entries/shared/errors.rb
 - lib/dsu/views/entry_group/edit.rb
 - lib/dsu/views/entry_group/show.rb
+- lib/dsu/views/shared/messages.rb
 - sig/dsu.rbs
 homepage: https://github.com/gangelo/dsu
 licenses:
@@ -204,9 +204,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.0.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.22
 signing_key:

data/lib/dsu/support/commander/command.rb

@@ -1,130 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'command_help'
-require_relative 'subcommand'
-
-module Dsu
-  module Support
-    module Commander
-      # https://www.toptal.com/ruby/ruby-dsl-metaprogramming-guide
-      module Command
-        class << self
-          def included(base)
-            base.extend ClassMethods
-            base.engine.command_namespace to_command_namespace_symbol base.name
-            base.engine.command_prompt base.engine.command_namespace
-            binding.pry
-            base.singleton_class.delegate :command_namespace, :command_namespaces, :commands,
-              :command_add, :command_subcommand_add, :command_prompt, :command_parent,
-              :help, to: :engine
-          end
-
-          private
-
-          def to_command_namespace_symbol(namespace, join_token: '_')
-            namespace.delete(':').split(/(?=[A-Z])/).join(join_token).downcase
-          end
-        end
-
-        module ClassMethods
-          def command_subcommand_create(command_parent:)
-            new.tap do |subcommand|
-              subcommand.extend Subcommand
-              subcommand.command_parent command_parent
-            end
-          end
-
-          def engine
-            @engine ||= Engine.new(owning_command: self)
-          end
-
-          class Engine
-            include CommandHelp
-
-            attr_reader :owning_command
-
-            def initialize(owning_command:)
-              @owning_command = owning_command
-            end
-
-            def command_add(command:, desc:, long_desc: nil, options: {}, commands: [])
-              self.commands[command_namespace] ||= {}
-              self.commands[command_namespace][command] = {
-                desc: desc,
-                long_desc: long_desc,
-                options: options,
-                commands: commands,
-                help: command_help_for(command: command, desc: desc,
-                  long_desc: long_desc, options: options, commands: commands)
-              }
-            end
-
-            def command_subcommand_add(subcommand, command_parent: nil)
-              command_parent ||= @owning_command
-              subcommand = subcommand.command_subcommand_create command_parent: command_parent
-              commands[command_namespace] ||= {}
-              binding.pry
-              subcommand.command_namespaces.each_with_index do |namespace, index|
-                next if index.zero?
-
-                target = commands.dig(*subcommand.command_namespaces[1..index])
-                target ||= commands.dig(*subcommand.command_namespaces[0..index - 1])
-                target[namespace] ||= {}
-              end
-              commands.dig(*subcommand.command_namespaces[0..])[subcommand.command_namespaces.last] = subcommand
-
-              # subcommand.commands.each do |command_namespace, command|
-              #   command.each do |subcommand_command, data|
-              #     commands[self.command_namespace][command_namespace] ||= {}
-              #     commands[self.command_namespace][command_namespace][subcommand_command] = {
-              #       desc: data[:desc],
-              #       long_desc: data[:long_desc],
-              #       options: data[:options],
-              #       commands: data[:commands],
-              #       help: command_help_for(command: subcommand_command, namespaces: subcommand.command_namespaces, desc: data[:desc],
-              #         long_desc: data[:long_desc], options: data[:options], commands: data[:commands])
-              #     }
-              #   end
-              # end
-            end
-
-            def command_namespaces(namespaces = [])
-              command_parent&.command_namespaces(namespaces)
-
-              namespaces << command_namespace
-              namespaces
-            end
-
-            def command_namespace(namespace = nil)
-              return @command_namespace || name if namespace.nil?
-
-              @command_namespace = namespace
-            end
-
-            def command_prompt(value = nil)
-              return @command_prompt || name if value.nil?
-
-              @command_prompt = value
-            end
-
-            def command_parent(parent = nil)
-              return @command_parent if parent.nil?
-
-              @command_parent = parent
-            end
-
-            def commands
-              @commands ||= {}
-            end
-
-            def help
-              commands.each do |_command, command_data|
-                puts "#{command_namespaces.join(' ')} #{command_data[:help]}"
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/dsu/support/commander/command_help.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-module Dsu
-  module Support
-    module Commander
-      module CommandHelp
-        private
-
-        # rubocop:disable Lint/UnusedMethodArgument
-        def command_help_for(command:, desc:, namespaces: nil, long_desc: nil, options: {}, commands: [])
-          namespaces ||= command_namespaces
-          help =
-            <<~HELP
-              #{namespaces&.join(' ')} #{command}#{' [OPTIONS]' if options&.any?} - #{desc}
-              #{'OPTIONS:' if options&.any?}
-              #{options_help_for options}
-              #{'OPTION ALIASES:' if any_option_aliases_for?(options)}
-              #{options_aliases_help_for options}
-              #{'---' unless long_desc.blank?}
-              #{long_desc}
-            HELP
-          help.gsub(/\n{2,}/, "\n")
-        end
-        # rubocop:enable Lint/UnusedMethodArgument
-
-        def options_help_for(options)
-          return [] if options.blank?
-
-          options.map do |option, data|
-            type = option_to_a(data[:type])&.join(' | ')
-            type = :boolean if type.blank?
-            "#{option} <#{type}>, default: #{data[:default]}"
-          end.join("\n")
-        end
-
-        def options_aliases_help_for(options)
-          return unless any_option_aliases_for?(options)
-
-          options.filter_map do |option, data|
-            aliases = option_to_a(data[:aliases])&.join(' | ')
-            <<~HELP
-              #{option} aliases: [#{aliases}]
-            HELP
-          end.join("\n")
-        end
-
-        def any_option_aliases_for?(options)
-          return false if options.blank?
-
-          options.keys.any? { |key| options.dig(key, :aliases).any? }
-        end
-
-        def option_to_a(option)
-          return [] if option.blank?
-          return option if option.is_a? Array
-
-          [option]
-        end
-      end
-    end
-  end
-end

data/lib/dsu/support/commander/subcommand.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module Dsu
-  module Support
-    module Commander
-      # Subcommands should extend this module once they are instantiated
-      # so that the Subcommand instance has access to all necessary
-      # class methods for this subcommand to work.
-      module Subcommand
-        class << self
-          def extended(mod)
-            mod.singleton_class.delegate :command_namespace, :commands,
-              :command_add, :command_subcommand_add, :command_prompt, :help, to: mod.class
-          end
-        end
-
-        # Subcommand-specific instance methods.
-        #
-        # Define Subcommand-specific method equivalents of the Command class
-        # methods needed to make this Subcommand instance unique.
-
-        # def command_namespace(namespace = nil)
-        #   return @command_namespace || name if namespace.nil?
-
-        #   @command_namespace = namespace
-        # end
-
-        # Subcommands can be used by any Command, so the :command_parent needs
-        # to be unique to this Subcommand instance.
-        def command_parent(parent = nil)
-          return @command_prompt if parent.nil?
-
-          @command_prompt = parent
-        end
-
-        def command_namespaces(namespaces = [])
-          command_parent&.command_namespaces(namespaces)
-
-          namespaces << command_namespace
-          namespaces
-        end
-      end
-    end
-  end
-end

data/lib/dsu/support/interactive/cli.rb

@@ -1,161 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../ask'
-require_relative '../colorable'
-require_relative '../say'
-
-module Dsu
-  module Interactive
-    class Cli
-      include Support::Colorable
-      include Support::Ask
-      include Support::Say
-
-      BACK_COMMANDS = %w[b].freeze
-      EXIT_COMMANDS = %w[x].freeze
-      HELP_COMMANDS = %w[?].freeze
-      PROMPT_TOKEN = '>'
-
-      attr_reader :name, :parent, :prompt
-
-      def initialize(name:, parent: nil, **options)
-        @name = name
-        @parent = parent
-        @prompt = options[:prompt]
-      end
-
-      # Starts our interactive loop.
-      def start
-        help
-        process_commands
-      end
-
-      def process(command:)
-        if command.cancelled?
-          nil
-        elsif help?(command.command)
-          help
-        elsif back_or_exit?(command.command)
-          parent&.help
-        else
-          unrecognized_command command.command
-        end
-      end
-
-      # Dispays the full help; header and body.
-      def help
-        help_header
-        help_body
-      end
-
-      private
-
-      # This is our interaction loop. Commands that are NOT help or
-      # back or exit commands are yielded to the subclass to execute. Help
-      # commands simply display help; back (or exit) commands transfer control
-      # back to the parent cli (if parent? is true) or exits the current
-      # cli (if parent? is false) respectfully.
-      def process_commands
-        loop do
-          command = wrap_command(ask)
-          process(command: command)
-          next if command.cancelled?
-          break if back_or_exit?(command.command)
-        end
-        say 'Done.', ABORTED unless parent?
-      end
-
-      def wrap_command(command)
-        Struct.new(:command, :args, :cancelled, keyword_init: true) do
-          def cancelled?
-            cancelled
-          end
-
-          def cancelled!
-            self[:cancelled] = true
-          end
-        end.new(
-          command: command.split[0],
-          args: command.split[1..],
-          cancelled: false
-        )
-      end
-
-      # This is the full prompt that needs to be displayed that includes
-      # all parent prompts, right down to the current prompt.
-      def full_prompt
-        prompts = full_prompt_build prompts: []
-        prompt_token = "#{PROMPT_TOKEN} "
-        "#{prompts.join prompt_token}#{prompt_token}"
-      end
-
-      def parent?
-        !parent.nil?
-      end
-
-      def back?(command)
-        back_commands.include? command
-      end
-
-      def back_commands
-        @back_commands ||= BACK_COMMANDS
-      end
-
-      def exit?(command)
-        exit_commands.include? command
-      end
-
-      def exit_commands
-        @exit_commands ||= EXIT_COMMANDS
-      end
-
-      def back_or_exit?(command)
-        (back_commands + exit_commands).include? command
-      end
-
-      def help?(command)
-        help_commands.include? command
-      end
-
-      # Returns what are considered to be commands associated with
-      # displaying help.
-      def help_commands
-        @help_commands ||=  HELP_COMMANDS
-      end
-
-      # Displays the help header; override this if you want to customize
-      # your own help header in your subclass.
-      def help_header
-        say "#{name} Help", HIGHLIGHT
-        say '---', HIGHLIGHT
-      end
-
-      # Override this in your subclass and call super AFTER you've
-      # displayed your subclass' help body.
-      def help_body
-        say "[#{HELP_COMMANDS.join(' | ')}] Display help", HIGHLIGHT
-        say "[#{BACK_COMMANDS.join(' | ')}] Go back", HIGHLIGHT if parent?
-        say "[#{EXIT_COMMANDS.join(' | ')}] Exit", HIGHLIGHT unless parent?
-      end
-
-      # This simply outputs our prompt and accepts user input.
-      def ask
-        super full_prompt
-      end
-
-      def unrecognized_command(command)
-        say "Unrecognized command (\"#{command}\"). Try again.", ERROR
-      end
-
-      # Builds the full prompt to be used which amounts to:
-      # <parent cli prompt> PROMPT_TOKEN <child cli 1 prompt>
-      # PROMPT_TOKEN <child 2 cli prompt> ...
-      def full_prompt_build(prompts:)
-        parent.send(:full_prompt_build, prompts: prompts) if parent?
-
-        prompts << prompt
-        prompts.flatten
-      end
-    end
-  end
-end