doto 0.0.1.pre.alpha.1

data/lib/doto/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 Doto
+  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 = 32
+      MIN_DESCRIPTION_LENGTH = 2
+      MAX_DESCRIPTION_LENGTH = 64
+
+      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/doto/presenters/base_presenter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'delegate'
+require_relative '../models/color_theme'
+require_relative '../support/color_themable'
+
+module Doto
+  module Presenters
+    class BasePresenter < SimpleDelegator
+      include Support::ColorThemable
+
+      attr_reader :color_theme
+
+      def initialize(object, options: {})
+        super(object)
+
+        @options = options || {}
+        theme_name = options.fetch(:theme_name, Models::Configuration.new.theme_name)
+        @color_theme = Models::ColorTheme.find(theme_name: theme_name)
+      end
+
+      private
+
+      attr_reader :options
+
+      def formatted_index(index:)
+        apply_theme("#{format('%02s', index + 1)}. ",
+          theme_color: color_theme.index)
+      end
+    end
+  end
+end

data/lib/doto/presenters/base_presenter_ex.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Doto
+  module Presenters
+    class BasePresenterEx
+      def initialize(options: {})
+        @options = options&.dup || {}
+      end
+
+      private
+
+      attr_accessor :options
+    end
+  end
+end

data/lib/doto/presenters/color_theme_presenter.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative 'base_presenter'
+
+module Doto
+  module Presenters
+    class ColorThemePresenter < BasePresenter
+      attr_reader :color_theme
+
+      def initialize(color_theme, options: {})
+        super
+
+        @color_theme = color_theme
+      end
+
+      def header
+        header = I18n.t('presenters.color_theme_presenter.headers.color_themes')
+        apply_theme(header, theme_color: color_theme.subheader)
+      end
+
+      def footer
+        header = I18n.t('presenters.color_theme_presenter.headers.current_theme')
+        apply_theme(header, theme_color: color_theme.footer)
+      end
+
+      def detail
+        "#{apply_theme(theme_name_formatted, theme_color: color_theme.body)} - " \
+          "#{apply_theme(description, theme_color: color_theme.body)}"
+      end
+
+      def detail_with_index(index:)
+        "#{formatted_index(index: index)} #{detail}"
+      end
+
+      private
+
+      def theme_name_formatted
+        return theme_name unless default_color_theme?
+
+        "*#{theme_name}"
+      end
+
+      def default_color_theme?
+        theme_name == default_color_theme.theme_name
+      end
+
+      def default_color_theme
+        @default_color_theme ||= Models::ColorTheme.current_or_default
+      end
+    end
+  end
+end

data/lib/doto/presenters/color_theme_show_presenter.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative 'base_presenter'
+
+module Doto
+  module Presenters
+    class ColorThemeShowPresenter < BasePresenter
+      def initialize(color_theme, options: {})
+        super(color_theme, options: options.merge(theme_name: color_theme.theme_name))
+      end
+
+      def detail
+        headers = [I18n.t('presenters.color_theme_show_presenter.headers.number'),
+                   I18n.t('presenters.color_theme_show_presenter.headers.color'),
+                   I18n.t('presenters.color_theme_show_presenter.headers.values')]
+        puts_detail(*headers, header: true)
+
+        Models::ColorTheme::DEFAULT_THEME_COLORS.keys.each_with_index do |color_key, index|
+          index = formatted_index(index: index)
+          color_hash = color_theme.public_send(color_key)
+          puts_detail(index, color_key, color_hash)
+        end
+      end
+
+      def detail_with_index(index:)
+        "#{formatted_index(index: index)} #{detail}"
+      end
+
+      def footer
+        header = I18n.t('presenters.color_theme_show_presenter.headers.footer_example')
+        apply_theme(header, theme_color: color_theme.footer)
+      end
+
+      def header
+        header = I18n.t('presenters.color_theme_show_presenter.headers.viewing_color_theme',
+          theme_name: color_theme.theme_name)
+        apply_theme(header, theme_color: color_theme.subheader)
+      end
+
+      private
+
+      def puts_detail(index, color_key, color_hash, header: false)
+        if header
+          puts "#{apply_theme(index.to_s.ljust(4), theme_color: color_theme.index.bold!)} " \
+               "#{apply_theme(color_key.to_s.ljust(15), theme_color: color_theme.index.bold!)} " \
+               "#{apply_theme(color_hash.to_s.ljust(10), theme_color: color_theme.index.bold!)}"
+        else
+          puts "#{apply_theme(index.to_s.ljust(4), theme_color: color_theme.index)} " \
+               "#{apply_theme(color_key.to_s.ljust(15), theme_color: color_hash)} " \
+               "#{apply_theme(color_hash.to_s.ljust(10), theme_color: color_theme.body)}"
+        end
+      end
+    end
+  end
+end

data/lib/doto/presenters/configuration_presenter.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative '../env'
+require_relative '../support/color_themable'
+require_relative 'base_presenter'
+
+module Doto
+  module Presenters
+    class ConfigurationPresenter < BasePresenter
+      attr_reader :config
+
+      def initialize(config, options: {})
+        super
+
+        @config = config
+      end
+
+      def configuration_header
+        header = I18n.t('presenters.configuration_presenter.headers.file_contents', config_path: config_path)
+        apply_theme(header, theme_color: color_theme.header)
+      end
+
+      def configuration_details
+        to_h.each_with_index.filter_map do |config_entry, index|
+          formatted_config_entry_with_index(config_entry, index: index, theme_color: color_theme.body)
+        end
+      end
+
+      private
+
+      def config_path
+        @config_path ||= if Doto.env.screen_shot_mode?
+          "/Users/#{Doto.env.screen_shot_username}/.doto"
+        else
+          config.file_path
+        end
+      end
+
+      def formatted_config_entry_with_index(config_entry, index:, theme_color:)
+        "#{formatted_index(index: index)} #{formatted_config_entry(config_entry: config_entry,
+          theme_color: theme_color)}"
+      end
+
+      def formatted_config_entry(config_entry:, theme_color:)
+        config_entry = "#{config_entry[0]}: '#{config_entry[1]}'"
+        apply_theme(config_entry, theme_color: theme_color)
+      end
+    end
+  end
+end

data/lib/doto/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 Doto
+  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/doto/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 Doto
+  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/doto/presenters/entry_group/list/messages.rb

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

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

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