dsu 2.4.1 → 2.4.3

data/lib/dsu/cli.rb

@@ -3,6 +3,7 @@
 require 'fileutils'
 require 'time'
 require_relative 'base_cli'
+require_relative 'presenters/entry_group/list/date_presenter'
 require_relative 'subcommands/browse'
 require_relative 'subcommands/config'
 require_relative 'subcommands/delete'
@@ -11,6 +12,7 @@ require_relative 'subcommands/export'
 require_relative 'subcommands/import'
 require_relative 'subcommands/list'
 require_relative 'subcommands/theme'
+require_relative 'views/entry_group/list'
 
 module Dsu
   # The `dsu` command.
@@ -46,7 +48,9 @@ module Dsu
       end
       entry = Models::Entry.new(description: description)
       CommandServices::AddEntryService.new(entry: entry, time: time).call
-      view_entry_group(time: time)
+      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
     end
 
     desc I18n.t('commands.browse.desc'), I18n.t('commands.browse.usage')

data/lib/dsu/crud/json_file.rb

@@ -2,7 +2,6 @@
 
 require 'active_model'
 require 'json'
-require_relative 'raw_json_file'
 
 module Dsu
   module Crud
@@ -23,12 +22,12 @@ module Dsu
         self.class.delete!(file_path: file_path)
       end
 
-      def exist?
-        self.class.exist?(file_path: file_path)
+      def file_exist?
+        self.class.file_exist?(file_path: file_path)
       end
 
       def persisted?
-        exist?
+        file_exist?
       end
 
       # Override this method to reload data from the file
@@ -67,16 +66,20 @@ module Dsu
       alias save! write!
 
       class << self
-        def exist?(file_path:)
-          RawJsonFile.exist?(file_path: file_path)
+        def file_exist?(file_path:)
+          File.exist?(file_path)
         end
 
         def delete(file_path:)
-          RawJsonFile.delete(file_path: file_path)
+          return false unless file_exist?(file_path: file_path)
+
+          File.delete(file_path)
+
+          true
         end
 
         def delete!(file_path:)
-          RawJsonFile.delete!(file_path: file_path)
+          raise file_does_not_exist_message(file_path: file_path) unless delete(file_path: file_path)
         end
 
         def parse(json)
@@ -86,54 +89,65 @@ module Dsu
         end
 
         def read(file_path:)
-          hash = parse(RawJsonFile.read(file_path: file_path))
+          json = File.read(file_path) if file_exist?(file_path: file_path)
+          hash = parse(json)
           return yield hash if hash && block_given?
 
           hash
         end
 
         def read!(file_path:)
-          hash = parse(RawJsonFile.read!(file_path: file_path))
+          raise file_does_not_exist_message(file_path: file_path) unless file_exist?(file_path: file_path)
+
+          hash = read(file_path: file_path)
           return yield hash if hash && block_given?
 
           hash
         end
 
         def write(file_data:, file_path:)
-          Crud::RawJsonFile.write(file_data: file_data, file_path: file_path)
+          raise ArgumentError, 'file_data is nil' if file_data.nil?
+          raise ArgumentError, "file_data is the wrong object type:\"#{file_data}\"" unless file_data.is_a?(Hash)
+
+          file_data = JSON.pretty_generate(file_data)
+          File.write(file_path, file_data)
         end
 
         def write!(file_data:, file_path:)
           write(file_data: file_data, file_path: file_path)
         end
+
+        def file_does_not_exist_message(file_path:)
+          "File \"#{file_path}\" does not exist"
+        end
       end
 
       private
 
+      attr_writer :file_path, :version
+
       def read
-        hash = self.class.parse(RawJsonFile.read(file_path: file_path))
+        hash = self.class.read(file_path: file_path)
         return yield hash if block_given?
 
         hash
       end
 
       def read!
-        hash = self.class.parse(RawJsonFile.read!(file_path: file_path))
+        hash = self.class.read!(file_path: file_path)
         return yield hash if hash && block_given?
 
         hash
       end
 
       def read_version
-        return 0 unless exist?
+        return 0 unless file_exist?
 
         hash = read
         return 0 if hash.nil?
 
         hash.fetch(:version, 0).to_i
       end
-
-      attr_writer :file_path, :version
     end
   end
 end

data/lib/dsu/env.rb

@@ -2,7 +2,7 @@
 
 module Dsu
   class << self
-    def env
+    def env # rubocop:disable Metrics/MethodLength
       @env ||= Struct.new(:env) do
         def test?
           env.fetch('DSU_ENV', nil) == 'test'
@@ -19,6 +19,25 @@ module Dsu
         def production?
           env.fetch('DSU_ENV', 'production') == 'production'
         end
+
+        def screen_shot_mode?
+          development? && (env.fetch('SCREEN_SHOT_USERNAME', '').present? ||
+            env.fetch('SCREEN_SHOT_HOSTNAME', '').present?)
+        end
+
+        def screen_shot_prompt
+          username = screen_shot_username
+          hostname = screen_shot_hostname
+          "#{username}@#{hostname}:~ $"
+        end
+
+        def screen_shot_username
+          env.fetch('SCREEN_SHOT_USERNAME', 'username')
+        end
+
+        def screen_shot_hostname
+          env.fetch('SCREEN_SHOT_HOSTNAME', 'hostname')
+        end
       end.new(ENV)
     end
   end

data/lib/dsu/models/color_theme.rb

@@ -160,7 +160,7 @@ module Dsu
         end
 
         def exist?(theme_name:)
-          superclass.exist?(file_path: themes_path_for(theme_name: theme_name))
+          superclass.file_exist?(file_path: themes_path_for(theme_name: theme_name))
         end
 
         def find(theme_name:)

data/lib/dsu/models/configuration.rb

@@ -63,6 +63,8 @@ module Dsu
 
       attr_reader :options
 
+      alias exist? file_exist?
+
       def initialize(options: {})
         super(config_path)
 

data/lib/dsu/models/entry_group.rb

@@ -150,7 +150,7 @@ module Dsu
         end
 
         def exist?(time:)
-          superclass.exist?(file_path: entries_path_for(time: time))
+          superclass.file_exist?(file_path: entries_path_for(time: time))
         end
 
         def entry_group_times(between: nil)

data/lib/dsu/models/migration_version.rb

@@ -13,6 +13,8 @@ module Dsu
 
       attr_reader :options
 
+      alias exist? file_exist?
+
       def initialize(version: nil, options: {})
         super(migration_version_path)
 

data/lib/dsu/presenters/base_presenter_ex.rb

@@ -10,7 +10,7 @@ module Dsu
       include Support::ColorThemable
 
       def initialize(options: {})
-        @options = options || {}
+        @options = options&.dup || {}
         @color_theme = Models::ColorTheme.find(theme_name: theme_name)
       end
 

data/lib/dsu/presenters/configuration_presenter.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative '../env'
 require_relative '../support/color_themable'
 require_relative 'base_presenter'
 
@@ -28,7 +29,11 @@ module Dsu
       private
 
       def config_path
-        @config_path ||= config.file_path
+        @config_path ||= if Dsu.env.screen_shot_mode?
+          "/Users/#{Dsu.env.screen_shot_username}/.dsu"
+        else
+          config.file_path
+        end
       end
 
       def formatted_config_entry_with_index(config_entry, index:, theme_color:)

data/lib/dsu/presenters/entry_group/list/date_presenter.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative '../../../models/configuration'
+require_relative '../../../models/entry_group'
+require_relative '../../../views/entry_group/shared/no_entries_to_display'
+require_relative '../../base_presenter_ex'
+require_relative 'messages'
+require_relative 'nothing_to_list'
+
+module Dsu
+  module Presenters
+    module EntryGroup
+      module List
+        class DatePresenter < BasePresenterEx
+          include Messages
+          include NothingToList
+
+          def initialize(times:, options: {})
+            raise ArgumentError, 'times must be an Array' unless times.is_a?(Array)
+            raise ArgumentError, 'options must be a Hash' unless options.is_a?(Hash)
+
+            super(options: options)
+
+            @times = times
+          end
+
+          def render
+            return if nothing_to_list?
+
+            entry_groups.each do |entry_group|
+              Views::EntryGroup::Show.new(entry_group: entry_group).render
+              puts
+            end
+          end
+
+          def display_nothing_to_list_message
+            # This presenter will ALWAYS have something to list (display) since the first
+            # and last (if different) entry groups will always be displayed.
+            raise 'display_nothing_to_list_message called when there are entries to display'
+          end
+
+          private
+
+          attr_reader :times
+
+          def entry_groups
+            @entry_groups ||= begin
+              options = configuration.to_h.merge(self.options).with_indifferent_access
+
+              times.filter_map do |time|
+                view_options = options.dup
+                # Always show the first and last entry groups.
+                view_options[:include_all] = true if times_min_max.include?(time)
+
+                next unless show_entry_group?(time: time, options: view_options)
+
+                Models::EntryGroup.find_or_initialize(time: time)
+              end
+            end
+          end
+
+          def times_min_max
+            @times_min_max ||= times.minmax
+          end
+
+          def configuration
+            @configuration ||= Models::Configuration.new
+          end
+
+          def show_entry_group?(time:, options:)
+            Models::EntryGroup.exist?(time: time) || options[:include_all]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dsu/presenters/entry_group/list/dates_presenter.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative '../../../models/entry_group'
+require_relative '../../../views/entry_group/shared/no_entries_to_display'
+require_relative '../../base_presenter_ex'
+require_relative 'messages'
+require_relative 'nothing_to_list'
+
+module Dsu
+  module Presenters
+    module EntryGroup
+      module List
+        class DatesPresenter < BasePresenterEx
+          include Messages
+          include NothingToList
+
+          def initialize(times:, options: {})
+            raise ArgumentError, 'times must be an Array' unless times.is_a?(Array)
+            raise ArgumentError, 'options must be a Hash' unless options.is_a?(Hash)
+
+            super(options: options)
+
+            @times = times
+          end
+
+          def render
+            return if nothing_to_list?
+
+            entry_groups.each do |entry_group|
+              Views::EntryGroup::Show.new(entry_group: entry_group).render
+              puts
+            end
+          end
+
+          def display_nothing_to_list_message
+            raise 'display_nothing_to_list_message called when there are entries to display' unless nothing_to_list?
+
+            Views::EntryGroup::Shared::NoEntriesToDisplay.new(times: times, options: options).render
+          end
+
+          private
+
+          attr_reader :times
+
+          def entry_groups
+            @entry_groups ||= times.filter_map do |time|
+              next unless show_entry_group?(time: time, options: options)
+
+              Models::EntryGroup.find_or_initialize(time: time)
+            end
+          end
+
+          def show_entry_group?(time:, options:)
+            Models::EntryGroup.exist?(time: time) || options[:include_all]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dsu/presenters/entry_group/list/messages.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Presenters
+    module EntryGroup
+      module List
+        module Messages
+          def display_nothing_to_list_message
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dsu/presenters/entry_group/list/nothing_to_list.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Presenters
+    module EntryGroup
+      module List
+        module NothingToList
+          def nothing_to_list?
+            entry_groups.none?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dsu/services/entry_group/editor_service.rb

@@ -65,7 +65,7 @@ module Dsu
               process_entry_group!(entry_group_with_edits)
             else
               message_array = I18n.t('services.editor_service.errors.temp_file_error',
-                editor: configuration.editor,
+                editor: ENV.fetch('EDITOR', configuration.editor),
                 status: $CHILD_STATUS).split("\n")
               puts apply_theme(message_array, theme_color: color_theme.error)
             end

data/lib/dsu/subcommands/list.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require_relative '../presenters/entry_group/list/date_presenter'
+require_relative '../presenters/entry_group/list/dates_presenter'
 require_relative '../services/entry_group/counter_service'
 require_relative '../support/command_options/dsu_times'
 require_relative '../support/command_options/time_mnemonic'
 require_relative '../support/time_formatable'
-require_relative '../views/entry_group/shared/no_entries_to_display'
+require_relative '../views/entry_group/list'
 require_relative '../views/shared/error'
 require_relative 'base_subcommand'
 
@@ -25,7 +27,8 @@ module Dsu
       def today
         time = Time.now
         times = sorted_dsu_times_for(times: [time.yesterday, time])
-        view_list_for(times: times, options: options)
+        presenter = Presenters::EntryGroup::List::DatePresenter.new(times: times, options: options)
+        Views::EntryGroup::List.new(presenter: presenter).render
       end
 
       desc I18n.t('subcommands.list.tomorrow.desc'), I18n.t('subcommands.list.tomorrow.usage')
@@ -33,7 +36,8 @@ module Dsu
       def tomorrow
         time = Time.now
         times = sorted_dsu_times_for(times: [time, time.tomorrow])
-        view_list_for(times: times, options: options)
+        presenter = Presenters::EntryGroup::List::DatePresenter.new(times: times, options: options)
+        Views::EntryGroup::List.new(presenter: presenter).render
       end
 
       desc I18n.t('subcommands.list.yesterday.desc'), I18n.t('subcommands.list.yesterday.usage')
@@ -41,7 +45,8 @@ module Dsu
       def yesterday
         time = Time.now
         times = sorted_dsu_times_for(times: [time.yesterday, time.yesterday.yesterday])
-        view_list_for(times: times, options: options)
+        presenter = Presenters::EntryGroup::List::DatePresenter.new(times: times, options: options)
+        Views::EntryGroup::List.new(presenter: presenter).render
       end
 
       desc I18n.t('subcommands.list.date.desc'), I18n.t('subcommands.list.date.usage')
@@ -55,7 +60,8 @@ module Dsu
           Time.parse(date_or_mnemonic)
         end
         times = sorted_dsu_times_for(times: [time, time.yesterday])
-        view_list_for(times: times, options: options)
+        presenter = Presenters::EntryGroup::List::DatePresenter.new(times: times, options: options)
+        Views::EntryGroup::List.new(presenter: presenter).render
       rescue ArgumentError => e
         Views::Shared::Error.new(messages: e.message).render
       end
@@ -79,11 +85,8 @@ module Dsu
         # NOTE: special sort here, unlike the other commands where rules for
         # displaying DSU entries are applied; this is more of a list command.
         times = times_sort(times: times, entries_display_order: options[:entries_display_order])
-        view_entry_groups(times: times, options: options) do
-          if Services::EntryGroup::CounterService.new(times: times).call.zero?
-            Views::EntryGroup::Shared::NoEntriesToDisplay.new(times: times, options: options).render
-          end
-        end
+        presenter = Presenters::EntryGroup::List::DatesPresenter.new(times: times, options: options)
+        Views::EntryGroup::List.new(presenter: presenter).render
       rescue ArgumentError => e
         Views::Shared::Error.new(messages: e.message).render
       end

data/lib/dsu/support/command_hookable.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative '../env'
 require_relative '../models/color_theme'
 require_relative '../services/stderr_redirector_service'
 require_relative '../views/shared/error'
@@ -26,6 +27,10 @@ module Dsu
         end
 
         def display_dsu_header
+          if Dsu.env.screen_shot_mode?
+            puts apply_theme('Running screen shot mode!', theme_color: color_theme.warning)
+            puts "#{Dsu.env.screen_shot_prompt} dsu #{ARGV.join(' ')}"
+          end
         end
 
         def display_dsu_footer

data/lib/dsu/support/entry_group_browsable.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require_relative '../models/configuration'
+require_relative '../presenters/entry_group/list/dates_presenter'
 require_relative '../services/entry_group/browse_service'
 require_relative '../services/entry_group/counter_service'
+require_relative '../views/entry_group/list'
 
 module Dsu
   module Support
@@ -23,7 +25,8 @@ module Dsu
           header = browse_header_for(time: time, options: options)
           Views::Shared::Info.new(messages: header).render
           puts
-          view_entry_groups(times: times, options: options)
+          presenter = Presenters::EntryGroup::List::DatesPresenter.new(times: times, options: options)
+          Views::EntryGroup::List.new(presenter: presenter).render
           self.class.display_dsu_footer
         end
         output_with_pager output: output, options: options

data/lib/dsu/version.rb

@@ -2,5 +2,5 @@
 
 module Dsu
   VERSION_REGEX = /\A\d+\.\d+\.\d+(\.(alpha|rc)\.\d+)?\z/
-  VERSION = '2.4.1'
+  VERSION = '2.4.3'
 end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Dsu
+  module Views
+    module EntryGroup
+      class List
+        def initialize(presenter:)
+          @presenter = presenter
+        end
+
+        def render
+          return presenter.display_nothing_to_list_message if presenter.nothing_to_list?
+
+          presenter.render
+        end
+
+        private
+
+        attr_reader :presenter
+      end
+    end
+  end
+end

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

@@ -36,7 +36,11 @@ module Dsu
           puts presenter.formatted_time
 
           entry_group.validate!
-          puts presenter.no_entries_available and return if entry_group.entries.empty?
+          if entry_group.entries.empty?
+            puts presenter.no_entries_available
+
+            return
+          end
 
           entry_group.entries.each_with_index do |entry, index|
             entry_presenter = entry.presenter

data/lib/locales/en/services.yml

@@ -4,7 +4,7 @@ en:
       errors:
         temp_file_error: |
           Failed to open temporary file in editor '%{editor}'; the system error returned was: '%{status}'.
-          Either set the EDITOR environment variable or set the dsu editor configuration option (`$ dsu config info`).
-          Run `$ dsu help config` for more information.
+          Check your EDITOR environment variable and the dsu editor configuration option (run `dsu config info`).
+          Run `dsu help config` for more information.
       messages:
         editing: "Editing entry group %{formatted_time}..."