check_list 1.0.0

data/lib/results.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'fileutils'
+require_relative 'config'
+require_relative 'helpers'
+require_relative 'handle_file'
+require_relative 'exceptions'
+require_relative 'results_publisher'
+require_relative 'display_results'
+
+module CheckList
+  # Class to build the selection menu
+  class Results
+    attr_reader :results
+
+    def initialize(opts)
+      @ref = nil
+      @opts = opts
+      @results_array = []
+      @results = {}
+      process_opts
+    end
+
+    def process_opts
+        return @ref = @opts[:ref] unless @opts[:ref].nil?
+
+        @ref = 'main'
+        begin
+            branch = CheckList::Helpers.system_cmd("git status | grep 'On branch'")
+            @ref = branch.chomp.gsub(/On branch /, '')
+        rescue StandardError
+            CheckList::Helpers.log 'Error with branch, using default'
+        end
+        @ref
+    end
+
+    def process_value(list, value, task, sub_task)
+        result = {
+          'list': list['name'],
+          'task': task['name'],
+          'subTask': sub_task['name'],
+          'value': value,
+          'timestamp': CheckList::Config.time_now
+        }
+        @results_array.push result
+    end
+
+    def process_results
+      CheckList::Helpers.clear
+
+      begin
+          create_results_list
+          create_tasks
+          add_sub_tasks
+          update_tasks
+          CheckList::ResultsPublisher.new(@results)
+          CheckList::DisplayResults.new(@results)
+      rescue CheckList::Exceptions::InvalidListError => e
+          CheckList::Helpers.log "Invalid List: #{e}"
+          CheckList::Helpers.leave
+      rescue StandardError => e
+          CheckList::Helpers.log "Error: #{e}"
+          CheckList::Helpers.leave
+      end
+    end
+
+    private
+
+    def update_tasks
+        @results[:tasks].each_with_index do |result, index|
+            status = 'n'
+            result[:subTasks].each do |sub_task|
+                if sub_task[:status] == 'n'
+                    status = 'n'
+                    break
+                else
+                    status = 'y'
+                end
+            end
+            @results[:tasks][index][:status] = status
+            @results[:tasks][index][:user] = ENV.fetch('USER')
+            @results[:tasks][index][:time] = CheckList::Config.time_now
+        end
+    end
+
+    def add_sub_tasks
+        @results_array.each do |result|
+            task = @results[:tasks].index do |e|
+                e[:name] == result[:task]
+            end
+
+            res_hash = { name: result[:subTask], status: result[:value], time: result[:timestamp], user: ENV.fetch('USER') }
+            @results[:tasks][task][:subTasks].push res_hash
+        end
+    end
+
+    def create_tasks
+        @results[:tasks] = []
+        @results_array.each do |result|
+            res = { name: result[:task], status: 'n', time: '', subTasks: [] }
+            raise CheckList::Exceptions::InvalidListError, 'The list does not have a name' if @results[:name].nil?
+
+            if @results[:tasks].empty?
+                @results[:tasks].push res
+            elsif @results[:tasks].include? name: result[:task], status: 'n', time: '', subTasks: []
+                next
+            else
+                @results[:tasks].push res
+            end
+        end
+    end
+
+    def create_results_list
+        @results[:name] = nil
+        @results[:ref] = @ref
+        @results_array.each do |result|
+            if @results[:name].nil?
+                @results[:name] = result[:list]
+            elsif @results[:name] != result[:list]
+                raise CheckList::Exceptions::InvalidListError, 'The list can only contain one list title'
+            end
+        end
+    end
+  end
+end

data/lib/results_publisher.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'fileutils'
+require_relative 'config'
+
+module CheckList
+  # Publish the results of a completed checklist
+  class ResultsPublisher
+    def initialize(results)
+      @path = nil
+      @results = results
+      @checklist = CheckList::Helpers.system_cmd('ls | grep checklist')
+      publish_results
+    end
+
+    private
+
+    def publish_results
+      return create_checklist_folder if @checklist == ''
+
+      # TODO: Go through all results. If changed then replace.
+      file = File.read('./checklist/data.json')
+      data_hash = JSON.parse(file)
+
+      data_hash['results'] = data_hash['results'].reject do |res|
+          res['name'] == @results[:name] && res['ref'] == @results[:ref]
+      end
+
+      data_hash['results'].push @results
+      CheckList::Helpers.write_json_file(data_hash)
+      data_hash
+    end
+
+    def move_build_to_checklist
+      @path = CheckList::Config.path
+
+      return if @path.nil?
+
+      CheckList::Helpers.system_cmd "cp -r #{@path}/build/ ./checklist/"
+    end
+
+    def create_checklist_folder
+      data_hash = { 'results' => [] }
+      FileUtils.mkdir_p('checklist')
+      move_build_to_checklist
+
+      data_hash['results'].push @results
+      CheckList::Helpers.write_json_file(data_hash)
+      data_hash
+    end
+  end
+end

data/lib/symbolize.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative 'exceptions'
+
+# creates a symbolized hash
+class Sym
+  attr_reader :hash
+
+  def initialize(hash)
+    @hash = hash
+    @hash = process_hash(@hash)
+  end
+
+  def process_hash(hash)
+    raise CheckList::Exceptions::NotAHash, 'Please pass a valid hash' unless hash.is_a? Hash
+
+    hash.transform_keys!(&:to_sym)
+    keys = hash.keys
+    new_hash = {}
+
+    keys.each do |key|
+      new_hash[key] = hash[key]
+      new_hash[key] = process_hash(hash[key]) if hash[key].is_a? Hash
+      new_hash[key] = process_array(hash[key]) if hash[key].is_a? Array
+    end
+    new_hash
+  end
+
+  def process_array(array)
+    new_array = []
+
+    array.each do |item|
+      new_array.push item unless item.is_a?(Array) || item.is_a?(Hash)
+      new_array.push process_array(item) if item.is_a? Array
+      new_array.push process_hash(item) if item.is_a? Hash
+    end
+    new_array
+  end
+end

data/lib/update.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+require_relative 'config'
+require_relative 'display_results'
+require_relative 'symbolize'
+
+module CheckList
+  # Class to handle updates
+  class Update
+    HELP = CheckList::Helpers
+
+    def initialize(opts, filepath)
+      @opts = opts
+      @json = filepath.fetch_json('CHECKLIST')
+    end
+
+    def show_lists(type)
+      HELP.clear if type.is_a? String
+      HELP.log 'Edit Cancelled' if type.is_a? String
+      HELP.log 'Lists'
+      HELP.log ''
+
+      @json['results'].each_with_index do |list, index|
+        HELP.log "#{index + 1}. #{list['name']} (#{list['ref']})"
+      end
+
+      value = validate_ret_value(HELP.ret_value, @json['results'])
+
+      return show_list(value, nil) unless value.zero?
+
+      HELP.clear
+      show_lists(type)
+    end
+
+    def check_for_q(value)
+      return HELP.good_bye if value.downcase == 'q'
+
+      value
+    end
+
+    def validate_ret_value(value, arr)
+      val = arr.length
+      return value.to_i if !value.to_i.zero? && value.to_i <= val
+
+      return check_for_q(value) if value == 'q'
+
+      0
+    rescue StandardError
+      HELP.log 'Incorrect value'
+      0
+    end
+
+    def show_list(value, type)
+      HELP.clear
+      HELP.log 'Invalid selection' if type.is_a? String
+
+      name = @json['results'][value - 1]['name']
+      ref = @json['results'][value - 1]['ref']
+      @list = @json['results'][value - 1]
+      HELP.log "List: #{name} (#{ref})"
+      @json['results'][value - 1]['tasks'].each_with_index do |task, index|
+        HELP.log "#{index + 1}. #{task['name']} (status: #{HELP.check_status(task['status'])})"
+        task['subTasks'].each_with_index do |sub_task, idx|
+          HELP.log "  #{idx + 1}. #{sub_task['name']} (status: #{HELP.check_status(sub_task['status'])})"
+        end
+      end
+      edit(value)
+    rescue StandardError => e
+      HELP.log "Error: #{e}"
+      HELP.leave
+    end
+
+    def edit(orig_value)
+      value = check_for_q(HELP.ret_value)
+
+      val_arr = nil
+      val_arr = value.split(',', -1) if value.match(/^[-,0-9]+$/)
+      arr_length = val_arr.length unless val_arr.nil?
+
+      case arr_length
+      when 1
+        return show_list(orig_value, 'yes') if val_arr[0].to_i.zero?
+
+        return show_sub_tasks(val_arr[0].to_i, orig_value)
+      when 2
+        return show_list(orig_value, 'yes') if val_arr[0].to_i.zero? || val_arr[1].to_i.zero?
+
+        return edit_sub_task(val_arr[0].to_i, val_arr[1].to_i, orig_value)
+      end
+      show_list(orig_value, 'yes')
+    end
+
+    def show_sub_tasks(task_idx, orig_value)
+      HELP.clear
+      task = @list['tasks'][task_idx - 1]
+      HELP.log task['name']
+      task['subTasks'].each_with_index do |tsk, idx|
+        HELP.log "  #{idx + 1}. #{tsk['name']} (status: #{HELP.check_status(tsk['status'])})"
+      end
+      sub_task_idx = check_for_q(HELP.ret_value)
+      return show_list(orig_value, 'yes') if sub_task_idx.to_i.zero?
+
+      edit_sub_task(task_idx, sub_task_idx.to_i, orig_value)
+    rescue StandardError
+      show_list(orig_value, 'yes')
+    end
+
+    def edit_sub_task(task_idx, sub_task_idx, orig_value)
+      HELP.clear
+      task = @list['tasks'][task_idx - 1]
+      sub_task = task['subTasks'][sub_task_idx - 1]
+
+      HELP.log "#{sub_task['name']} (status: #{HELP.check_status(sub_task['status'])})"
+      HELP.log "Change: (#{HELP.green}yes#{HELP.white}/#{HELP.red}no#{HELP.white})"
+
+      value = check_for_q(HELP.ret_value)
+      yes = "#{HELP.green}y#{HELP.white}"
+      no = "#{HELP.red}n#{HELP.white}"
+      na = "#{HELP.yellow}na#{HELP.white}"
+      HELP.log "Status: (#{yes}/#{no}/#{na})" if verify_edit(value)
+      value = check_for_q(HELP.ret_value)
+      update_results(value, orig_value, task_idx, sub_task_idx)
+    rescue StandardError
+      show_list(orig_value, 'yes')
+    end
+
+    def update_results(value, orig_value, task_idx, sub_task_idx)
+      list = @json['results'][orig_value - 1]
+      task = list['tasks'][task_idx - 1]
+      subtask = task['subTasks'][sub_task_idx - 1]
+      subtasks = task['subTasks']
+      subtask['status'] = value
+      subtask['time'] = CheckList::Config.time_now
+
+      task['status'] = 'y'
+      task['time'] = CheckList::Config.time_now
+      subtasks.each do |tsk|
+        if tsk['status'] == 'n'
+          task['status'] = 'n'
+          break
+        end
+      end
+
+      HELP.write_json_file(@json)
+      list = Sym.new(list).hash
+      CheckList::DisplayResults.new(list)
+    end
+
+    def verify_edit(value)
+      return show_lists('yes') unless value.downcase == 'yes'
+
+      true
+    end
+  end
+end

data/lib/validations.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CheckList
+  # Checklist Validations
+  class Validations
+    def self.validate(value, array)
+      return 0 if value == 'q'
+
+      return value.to_i if array && value.to_i < array.length + 1 && !value.to_i.zero?
+
+      return false unless array
+
+      nil
+    end
+
+    def self.validate_response(value)
+        case value
+        when 'y'
+            value
+        when 'n'
+            value
+        when 'na'
+            value
+        when 'q'
+            value
+        else
+            0
+        end
+    end
+  end
+end

data/lib/view.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+require_relative 'config'
+
+module CheckList
+  # Class to build the selection menu
+  class View
+    def initialize
+      open_browser_view
+    end
+
+    private
+
+    def open_browser_view
+      CheckList::Helpers.system_cmd('open ./checklist/index.html')
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: check_list
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kyle Swaffield
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-21 00:00:00.000000000 Z
+dependencies: []
+description: A cli checklist
+email: kyle@swaff.iu.au
+executables:
+- check-list
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- bin/check-list
+- lib/build/asset-manifest.json
+- lib/build/cross.ico
+- lib/build/data.json
+- lib/build/favicon.ico
+- lib/build/index.html
+- lib/build/list.ico
+- lib/build/manifest.json
+- lib/build/robots.txt
+- lib/build/static/css/main.f784b531.css
+- lib/build/static/css/main.f784b531.css.map
+- lib/build/static/js/787.46b4d4fc.chunk.js
+- lib/build/static/js/787.46b4d4fc.chunk.js.map
+- lib/build/static/js/main.8c659df8.js
+- lib/build/static/js/main.8c659df8.js.LICENSE.txt
+- lib/build/static/js/main.8c659df8.js.map
+- lib/build/static/js/main.8f3bcf6c.js
+- lib/build/static/js/main.8f3bcf6c.js.LICENSE.txt
+- lib/build/static/js/main.8f3bcf6c.js.map
+- lib/build/static/js/main.ba318bd4.js
+- lib/build/static/js/main.ba318bd4.js.LICENSE.txt
+- lib/build/static/js/main.ba318bd4.js.map
+- lib/build/static/js/main.cc14af32.js
+- lib/build/static/js/main.cc14af32.js.LICENSE.txt
+- lib/build/static/js/main.cc14af32.js.map
+- lib/build/tick.ico
+- lib/check_list.rb
+- lib/checklist.json
+- lib/config.rb
+- lib/display_results.rb
+- lib/exceptions.rb
+- lib/handle_file.rb
+- lib/helpers.rb
+- lib/list.rb
+- lib/menu.rb
+- lib/results.rb
+- lib/results_publisher.rb
+- lib/symbolize.rb
+- lib/update.rb
+- lib/validations.rb
+- lib/view.rb
+homepage: https://rubygems.org/gems/check_list
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.17
+signing_key:
+specification_version: 4
+summary: A
+test_files: []