check_list 1.0.0

data/lib/check_list.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'optimist'
+require_relative 'menu'
+require_relative 'list'
+require_relative 'view'
+require_relative 'config'
+require_relative 'handle_file'
+require_relative 'exceptions'
+require_relative 'helpers'
+require_relative 'update'
+
+# Check-list application
+module CheckList
+  # The start method for check-list
+  class Start
+    attr_reader :opts
+
+    def initialize
+      @opts = set_options
+      @filepath = CheckList::HandleFile.new
+      handler
+    end
+
+    # rubocop: disable Layout/HeredocIndentation
+    # rubocop: disable Naming/HeredocDelimiterNaming
+    def set_options
+      Optimist.options do
+        version "check-list #{CheckList::Config.version} (c) 2022 Kyle Swaffield"
+        banner <<~EOS
+            Check-List
+
+        Usage:
+        check-list [options] <list name> | <reference name>
+        where [options] are:
+        EOS
+        opt :list, 'checklist name', :type => :string # flag --list, default false
+        opt :ref, 'Reference', :type => :string # flag --ref, default false
+        opt :view, 'View browser list'
+        opt :update, 'Update list'
+      end
+    end
+    # rubocop: enable Layout/HeredocIndentation
+    # rubocop: enable Naming/HeredocDelimiterNaming
+
+    def handler
+      if @opts[:update_given]
+        update
+      elsif @opts[:view_given]
+        view
+      else
+        CheckList::Menu.new(@filepath, @opts)
+      end
+    rescue CheckList::Exceptions::InvalidOptionError
+      CheckList::Helpers.log 'Invalid list option selection'
+    end
+
+    def update
+      @update = CheckList::Update.new(@opts, @filepath)
+      return update_ref if @opts[:list_given] && @opts[:ref_given]
+
+      update_list
+    end
+
+    def update_ref
+      @update.show_list('', nil)
+    end
+
+    def update_list
+      @update.show_lists(nil)
+    end
+
+    def view
+      return view_ref if @opts[:list_given] && @opts[:ref_given]
+
+      view_list
+    end
+
+    def view_ref
+      puts 'view ref'
+    end
+
+    def view_list
+      CheckList::View.new
+    end
+  end
+end

data/lib/checklist.json

@@ -0,0 +1,137 @@
+{
+  "lists":[
+    {
+      "name":"Deveploment",
+      "description":"A longer description of the list",
+      "tasks": [
+        {
+          "name":"read requirements",
+          "description":"A longer description of the task",
+          "subTasks": [
+            {
+              "name":"Are they reasonable?",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"Can they be met?",
+              "description":"A longer description of the sub-task"
+            }
+          ]
+        },
+        {
+          "name":"Prep Environment",
+          "description":"A longer description of the task",
+          "subTasks": [
+            {
+              "name":"Do you have all the credentials?",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"Can you run the current version end-to-end?",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"Does the debugger work?",
+              "description":"A longer description of the sub-task"
+            }
+          ]
+        },
+        {
+          "name":"Start Development",
+          "description":"A longer description of the task",
+          "subTasks": [
+            {
+              "name":"Write Code",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"Write Specs",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"Update documentation",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"Prepare code for testing",
+              "description":"A longer description of the sub-task"
+            }
+          ]
+        },
+        {
+          "name":"Run Specs",
+          "description":"A longer description of the task",
+          "subTasks": [
+            {
+              "name":"Does linting pass?",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"Do specs pass?",
+              "description":"A longer description of the sub-task"
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "name":"Code Review",
+      "tasks": [
+        {
+          "name":"Read Alice in wonder land",
+          "description":"A longer description of the task",
+          "subTasks": [
+            {
+              "name":"is there a red queen?",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"Where is the cat?",
+              "description":"A longer description of the sub-task"
+            }
+          ]
+        },
+        {
+          "name":"Cards",
+          "description":"A longer description of the task",
+          "subTasks": [
+            {
+              "name":"Red Cards?",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"Red queen?",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"done?",
+              "description":"A longer description of the sub-task"
+            }
+          ]
+        },
+        {
+          "name":"Start Review",
+          "description":"A longer description of the task",
+          "subTasks": [
+            {
+              "name":"Write Code",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"Write Specs",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"Update documentation",
+              "description":"A longer description of the sub-task"
+            },
+            {
+              "name":"Prepare code for testing",
+              "description":"A longer description of the sub-task"
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

data/lib/config.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module CheckList
+  # Check-list version number
+  class Config
+    def self.version
+      '1.0.0'
+    end
+
+    def self.default_url
+      'https://raw.githubusercontent.com/swaff-y/check-list/main/lib/checklist.json'
+    end
+
+    def self.env
+      'CHECK_LIST'
+    end
+
+    def self.coverage
+      95
+    end
+
+    def self.time_now
+      t = Time.now
+      year = t.year
+      month = t.month.to_s.rjust(2, '0')
+      day = t.day.to_s.rjust(2, '0')
+      hr = t.hour.to_s.rjust(2, '0')
+      min = t.min.to_s.rjust(2, '0')
+      "#{year}-#{month}-#{day} #{hr}:#{min}"
+    end
+
+    def self.path
+      ret_path = nil
+      $LOAD_PATH.each do |path|
+        if path.match(/check_list-/)
+          ret_path = path
+          break
+        end
+      end
+      ret_path
+    end
+  end
+end

data/lib/display_results.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module CheckList
+  # Display the results of a completed checklist
+  class DisplayResults
+    def initialize(results)
+      @path = nil
+      @results = results
+      display_results
+    end
+
+    private
+
+    def make_mark(status)
+      case status
+      when 'y'
+        "#{make_color(status)}(/)#{CheckList::Helpers.white}"
+      when 'n'
+        "#{make_color(status)}(x)#{CheckList::Helpers.white}"
+      when 'na'
+        "#{make_color(status)}(*)#{CheckList::Helpers.white}"
+      end
+    end
+
+    def make_color(status)
+      case status
+      when 'y'
+        CheckList::Helpers.green
+      when 'n'
+        CheckList::Helpers.red
+      when 'na'
+        CheckList::Helpers.yellow
+      end
+    end
+
+    def display_results
+      CheckList::Helpers.clear
+      CheckList::Helpers.log "*#{@results[:name]}* Checklist: #{@results[:ref]}"
+      CheckList::Helpers.log ''
+      @results[:tasks].each_with_index do |task, index|
+        CheckList::Helpers.log "  #{make_color(task[:status])}#{index + 1}.#{CheckList::Helpers.white} #{task[:name]} #{make_mark(task[:status])} _#{task[:time]}_"
+        @results[:tasks][index][:subTasks].each_with_index do |sub_task, idx|
+          CheckList::Helpers.log "    #{make_color(sub_task[:status])}#{idx + 1}.#{CheckList::Helpers.white} #{sub_task[:name]}#{CheckList::Helpers.white} #{make_mark(sub_task[:status])} _#{sub_task[:time]}_"
+        end
+      end
+      CheckList::Helpers.log ''
+      CheckList::Helpers.log "To view results in your browser use 'check-list --view'"
+    end
+  end
+end

data/lib/exceptions.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+
+module CheckList
+  module Exceptions
+    # Checklist errors
+    class InvalidListError < StandardError
+    end
+
+    # options errors
+    class InvalidOptionError < StandardError
+    end
+
+    # options errors
+    class NotAHash < StandardError
+    end
+
+    # Coverage errors
+    class CoverageError < StandardError
+      def initialize
+        super
+        CheckList::Helpers.log "#{CheckList::Helpers.red}Insufficient Coverage#{CheckList::Helpers.white}"
+      end
+    end
+  end
+end

data/lib/handle_file.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+require_relative 'config'
+require 'net/http'
+
+module CheckList
+  # Displays the keyword/method provided
+  class HandleFile
+    def initialize
+      @default_file = nil
+      fetch_default_file
+    end
+
+    def fetch_default_file
+      uri = URI.parse(CheckList::Config.default_url)
+      @default_file = Net::HTTP.get_response(uri)
+    rescue StandardError
+      @default_file = nil
+    end
+
+    def fetch_json(env_key)
+      url = './checklist/data.json'
+      url = ENV.fetch(env_key) if CheckList::Config.env == env_key
+      JSON.parse(File.read(url))
+    rescue StandardError => e
+      if env_key == CheckList::Config.env && !@default_file.nil?
+        JSON.parse(@default_file.body)
+      else
+        CheckList::Helpers.log "Invalid file: #{e}"
+        CheckList::Helpers.leave
+      end
+    end
+  end
+end

data/lib/helpers.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module CheckList
+  # Class to build the selection menu
+  class Helpers
+    def self.good_bye
+      clear
+      log 'Good Bye'
+      leave
+    end
+
+    def self.check_status(status)
+      case status.downcase
+      when 'y'
+        "#{green}Complete#{white}"
+      when 'n'
+        "#{red}Not Complete#{white}"
+      when 'na'
+        "#{yellow}Not Applicable#{white}"
+      end
+    end
+
+    def self.clear
+      system 'clear'
+    end
+
+    def self.log(str)
+      puts str
+    end
+
+    def self.ret_value
+      $stdin.gets.chomp
+    end
+
+    def self.leave
+      exit
+    end
+
+    def self.system_cmd(cmd)
+      `#{cmd}`
+    end
+
+    def self.write_json_file(data_hash)
+      File.write('./checklist/data.json', JSON.pretty_generate(data_hash))
+    end
+
+    def self.bg_red
+      "\x1b[41m"
+    end
+
+    def self.bg_green
+      "\x1b[42m"
+    end
+
+    def self.bg_yellow
+      "\x1b[43m"
+    end
+
+    def self.bg_white
+      "\x1b[47m"
+    end
+
+    def self.red
+      "\x1b[31m"
+    end
+
+    def self.green
+      "\x1b[32m"
+    end
+
+    def self.yellow
+      "\x1b[33m"
+    end
+
+    def self.white
+      "\x1b[37m"
+    end
+  end
+end

data/lib/list.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative 'config'
+require_relative 'helpers'
+require_relative 'handle_file'
+
+module CheckList
+    # Class to build the selection menu
+    class List
+        def initialize(filepath)
+            CheckList::Helpers.clear
+            @json = filepath.fetch_json
+            show_list
+        end
+
+        def show_list
+            CheckList::Helpers.log 'list'
+        end
+    end
+end

data/lib/menu.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative 'config'
+require_relative 'helpers'
+require_relative 'handle_file'
+require_relative 'exceptions'
+require_relative 'results'
+require_relative 'validations'
+
+module CheckList
+    # Class to build the selection menu
+    class Menu
+        attr_reader :results
+
+        def initialize(filepath, opts)
+            @opts = opts
+            @list = nil
+            @task_idx = nil
+            @sub_task_idx = nil
+            @results = CheckList::Results.new(@opts)
+            @json = filepath.fetch_json(CheckList::Config.env)
+            show_menu
+        end
+
+        def show_menu
+            list_array = @json['lists']
+            CheckList::Helpers.log 'Checklists'
+
+            list_array.each_with_index do |list, index|
+                CheckList::Helpers.log "#{index + 1}. #{list['name']}"
+            end
+            value = CheckList::Validations.validate(CheckList::Helpers.ret_value, list_array)
+            return CheckList::Helpers.good_bye if !value || value.zero?
+
+            @list = get_list(value) unless value.nil?
+            return show_tasks unless @list.nil?
+
+            rec_show_menu
+        end
+
+        def rec_show_menu
+            show_menu
+        end
+
+        def show_tasks
+            @task_idx = 0 if @task_idx.nil?
+
+            return @results.process_results if @task_idx == @list['tasks'].length
+
+            show_sub_tasks
+        end
+
+        def show_sub_tasks
+            # This gaurd clause is neccecary to protect an incorrect value being entered.
+            # This causes an extra recrsive call to show_sub_tasks
+            return if @task_idx == @list['tasks'].length
+
+            CheckList::Helpers.clear
+            CheckList::Helpers.log "#{@task_idx + 1}. #{@list['tasks'][@task_idx]['name']}"
+
+            @sub_task_idx = 0 if @sub_task_idx.nil?
+            task = @list['tasks'][@task_idx]
+            sub_tasks = @list['tasks'][@task_idx]['subTasks']
+
+            CheckList::Helpers.log "  #{@sub_task_idx + 1}. #{sub_tasks[@sub_task_idx]['name']} #{y}/#{n}/#{na}"
+
+            @sub_task_idx += 1
+            value = CheckList::Validations.validate_response(CheckList::Helpers.ret_value)
+            return CheckList::Helpers.good_bye if value == 'q'
+
+            # rubocop:disable Style/NumericPredicate:
+            if value == 0
+                @sub_task_idx -= 1
+                return rec_show_sub_tasks
+            end
+            # rubocop:enable Style/NumericPredicate:
+
+            @results.process_value(@list, value, task, sub_tasks[@sub_task_idx - 1])
+            return rec_show_sub_tasks if @sub_task_idx < sub_tasks.length
+
+            @sub_task_idx = 0
+            @task_idx += 1
+            show_tasks
+        end
+
+        def y
+            "#{CheckList::Helpers.green}y#{CheckList::Helpers.white}"
+        end
+
+        def n
+            "#{CheckList::Helpers.red}n#{CheckList::Helpers.white}"
+        end
+
+        def na
+            "#{CheckList::Helpers.yellow}na#{CheckList::Helpers.white}"
+        end
+
+        def rec_show_sub_tasks
+            show_sub_tasks
+        end
+
+        def get_list(value)
+            @json['lists'][value - 1]
+        end
+    end
+end