dsu 0.1.0.alpha.1

data/lib/dsu/validators/entries_validator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative '../models/entry'
+require_relative '../support/field_errors'
+
+# https://guides.rubyonrails.org/active_record_validations.html#validates-with
+module Dsu
+  module Validators
+    class EntriesValidator < ActiveModel::Validator
+      include Dsu::Support::FieldErrors
+
+      def validate(record)
+        raise 'options[:fields] is not defined.' unless options.key? :fields
+        raise 'options[:fields] is not an Array.' unless options[:fields].is_a? Array
+        raise 'options[:fields] elements are not Symbols.' unless options[:fields].all? { |field| field.is_a? Symbol }
+
+        options[:fields].each do |field|
+          entries = record.send(field)
+
+          unless entries.is_a?(Array)
+            record.errors.add(field, 'is the wrong object type. ' \
+                  "\"Array\" was expected, but \"#{entries.class}\" was received.")
+            next
+          end
+
+          validate_entry_types field, entries, record
+          validate_unique_entry_uuids field, entries, record
+        end
+      end
+
+      private
+
+      def validate_entry_types(field, entries, record)
+        entries.each do |entry|
+          next if entry.is_a? Dsu::Models::Entry
+
+          record.errors.add(field, 'entry Array element is the wrong object type. ' \
+                                "\"Entry\" was expected, but \"#{entry.class}\" was received.",
+            type: Dsu::Support::FieldErrors::FIELD_TYPE_ERROR)
+
+          next
+        end
+      end
+
+      def validate_unique_entry_uuids(field, entries, record)
+        return unless entries.is_a? Array
+
+        entry_objects = entries.select { |entry| entry.is_a?(Dsu::Models::Entry) }
+
+        entry_objects.map(&:uuid).tap do |uuids|
+          return if uuids.uniq.length == uuids.length
+        end
+
+        entry_objects.map(&:uuid).tap do |uuids|
+          non_unique_uuids = uuids.select{ |element| uuids.count(element) > 1 }.uniq
+          if non_unique_uuids.any?
+            record.errors.add(field, "contains duplicate UUIDs: #{non_unique_uuids.join(', ')}.",
+              type: Dsu::Support::FieldErrors::FIELD_DUPLICATE_ERROR)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dsu/validators/time_validator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# https://guides.rubyonrails.org/active_record_validations.html#validates-with
+module Dsu
+  module Validators
+    class TimeValidator < ActiveModel::Validator
+      def validate(record)
+        raise 'options[:fields] is not defined.' unless options.key? :fields
+        raise 'options[:fields] is not an Array.' unless options[:fields].is_a? Array
+        raise 'options[:fields] elements are not Symbols.' unless options[:fields].all?(Symbol)
+
+        options[:fields].each do |field|
+          time = record.send(field)
+
+          if time.nil?
+            record.errors.add(field, :blank)
+            next
+          end
+
+          unless time.is_a?(Time)
+            record.errors.add(field, 'is the wrong object type. ' \
+                                     "\"Time\" was expected, but \"#{time.class}\" was received.")
+            next
+          end
+
+          if time.utc?
+            record.errors.add(field, 'is not in localtime format.')
+            next
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dsu/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Dsu
+  VERSION = '0.1.0.alpha.1'
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+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
+  module Views
+    module EntryGroup
+      class Show
+        include Support::Colorable
+        include Support::Say
+        include Support::TimeFormatable
+
+        def initialize(entry_group:, options: {})
+          raise ArgumentError, 'entry_group is nil' if entry_group.nil?
+          raise ArgumentError, 'entry_group is the wrong object type' unless entry_group.is_a?(Models::EntryGroup)
+          raise ArgumentError, 'options is nil' if options.nil?
+          raise ArgumentError, 'options is the wrong object type' unless options.is_a?(Hash)
+
+          @entry_group = entry_group
+          @options = options || {}
+        end
+
+        def call
+          # Just in case the entry group is invalid, we'll
+          # validate it before displaying it.
+          entry_group.validate!
+          display_entry_group!
+        rescue ActiveModel::ValidationError
+          puts "Error(s) encountered: #{entry_group.errors.full_messages}"
+          raise
+        end
+        alias display call
+
+        private
+
+        attr_reader :entry_group, :options
+
+        def display_entry_group!
+          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}"
+            description = colorize_string(string: entry.description, mode: :bold)
+            say "#{prefix} #{description}"
+            next unless entry.long_description?
+
+            long_description = colorize_string(string: entry.long_description, mode: :bold)
+            say "#{''.ljust(prefix.length)} #{long_description}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dsu.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'time'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/numeric/time'
+
+# # Require relative all files under dsu/services folder (recursively)
+# Dir.glob("#{__dir__}/dsu/services/**/*.rb").each do |file|
+#   require file
+# end
+
+# # Require relative all files under dsu/support folder (recursively)
+# Dir.glob("#{__dir__}/dsu/support/**/*.rb").each do |file|
+#   require file
+# end
+
+# Dir.glob("#{__dir__}/dsu/validators/**/*.rb").each do |file|
+#   require file
+# end
+
+# [
+#   "#{__dir__}/dsu/services/**/*.rb"
+#   "#{__dir__}/dsu/support/**/*.rb",
+#   "#{__dir__}/dsu/validators/**/*.rb"
+# ]
+
+Dir.glob("#{__dir__}/dsu/**/*.rb").each do |file|
+  require file
+end
+
+require_relative 'dsu/cli'
+require_relative 'dsu/version'
+
+# The main namespace for this dsu gem.
+module Dsu
+  # Your code goes here...
+end

data/sig/dsu.rbs

@@ -0,0 +1,4 @@
+module Dsu
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: dsu
+version: !ruby/object:Gem::Version
+  version: 0.1.0.alpha.1
+platform: ruby
+authors:
+- Gene M. Angelo, Jr.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: deco_lite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: thor_nested_subcommand
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |2
+      dsu is little gem that helps manage your Agile DSU (Daily Stand Up) participation. How? by providing a simple command line interface (CLI) which allows you to create, read, update, and delete (CRUD) noteworthy activities that you performed during your day. During your DSU, you can then easily recall and share these these activities with your team. Activities are grouped by day and can be viewed in simple text format from the command line. When viewing a particular day, dsu will automatically display the previous day's activities as well. This is useful for remembering what you did yesterday, so you can share your "Today" and "Yesterday" activities with your team during your DSU.
+
+      NOTE: This gem is currently in development (alpha release) and does not provide the ability to UPDATE or DELETE activities. These features will be added in future releases.
+
+      IN ADDITION TO THIS: dsu's current behavior when viewing a particular day is to display the previous day's activities. This behavior is not necessarily ideal when sharing activities for a DSU that occurs on a Monday. This is because Monday's DSU typically includes sharing what you did on last FRIDAY (not necessarily "Yesterday"), as well as what you plan on doing "Today". This behavior will be changed in a future release as well, to display the previous Friday's activities (as well as Saturday and Sunday) if "Today" happens to be Monday.
+email:
+- public.gma@gmail.com
+executables:
+- dsu
+extensions: []
+extra_rdoc_files: []
+files:
+- ".reek.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/dsu
+- lib/dsu.rb
+- lib/dsu/cli.rb
+- lib/dsu/command_services/add_entry_service.rb
+- lib/dsu/models/entry.rb
+- lib/dsu/models/entry_group.rb
+- lib/dsu/services/configuration_loader_service.rb
+- lib/dsu/services/entry_group_deleter_service.rb
+- lib/dsu/services/entry_group_hydrator_service.rb
+- 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/subcommands/config.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/entry_group_fileable.rb
+- lib/dsu/support/entry_group_loadable.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/validators/entries_validator.rb
+- lib/dsu/validators/time_validator.rb
+- lib/dsu/version.rb
+- lib/dsu/views/entry_group/show.rb
+- sig/dsu.rbs
+homepage: https://github.com/gangelo/dsu
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gangelo/dsu
+  source_code_uri: https://github.com/gangelo/dsu
+  changelog_uri: https://github.com/gangelo/dsu/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.22
+signing_key:
+specification_version: 4
+summary: dsu (Agile Daily Stand Up/DSU) mini-manager.
+test_files: []