spec_ref_lib 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f418cdf81a97989c727ee583dcd52140db5c6e59385815816ed8ca4d4bb4660
+  data.tar.gz: 3dfff828d545d99a51abb1c03bb9998fcfd83472227a1a7dcf58e46b12c22540
+SHA512:
+  metadata.gz: 5afdafeb988cff721101bbedb4194f10fa4e27cc64e7a0b5f406bf5a573887773614a0c758fe6353636af4499200fa4bbb8bb74a794af4f2c19548e9641b0c5d
+  data.tar.gz: 51b91f92681baab7c5128aeb4432cbe35a4aaf47a9e1d4afd7d74076bab2b04edd94a7a1426b1e10eff831c286587dafa6e54b609b096a606cd801752122f609

data/bin/spec-ref-lib

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'spec_ref_lib'
+
+SpecRefLib::Start.new

data/lib/config.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module SpecRefLib
+  # Specr version number
+  class Config
+    def self.version
+      '1.0.0'
+    end
+
+    def self.default_url
+      'https://raw.githubusercontent.com/swaff-y/spec-ref-lib/main/lib/specr.json'
+    end
+
+    def self.env
+      'SPEC_REF_LIB'
+    end
+  end
+end

data/lib/handle_file.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+require_relative 'config'
+require 'net/http'
+
+module SpecRefLib
+  # Displays the keyword/method provided
+  class HandleFile
+    def initialize
+      @default_file = nil
+      fetch_default_file
+    end
+
+    def fetch_default_file
+      uri = URI.parse(SpecRefLib::Config.default_url)
+      @default_file = Net::HTTP.get_response(uri)
+    rescue StandardError
+      @default_file = nil
+    end
+
+    def fetch_json
+      JSON.parse(File.read(ENV.fetch(SpecRefLib::Config.env)))
+    rescue StandardError
+      if @default_file.nil?
+        SpecRefLib::Helpers.log 'Invalid file'
+        SpecRefLib::Helpers.leave
+      else
+        JSON.parse(@default_file.body)
+      end
+    end
+  end
+end

data/lib/helpers.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SpecRefLib
+  # Class to build the selection menu
+  class Helpers
+    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
+  end
+end

data/lib/menu.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative 'config'
+require_relative 'helpers'
+require_relative 'handle_file'
+
+module SpecRefLib
+    # Class to build the selection menu
+    class Menu
+        attr_reader :status
+
+        def initialize(filepath)
+            SpecRefLib::Helpers.clear
+            @json = filepath.fetch_json
+            show_menu
+        end
+
+        def show_menu
+            SpecRefLib::Helpers.log "Spec-ref-lib version #{SpecRefLib::Config.version}"
+            SpecRefLib::Helpers.log ''
+
+            @json['categories'].each_with_index do |category, index|
+                SpecRefLib::Helpers.log "\t#{index + 1}. #{category['name']}"
+            end
+
+            get_input('list_selector', @json)
+        end
+
+        def show_sub_menu(menu, name)
+            SpecRefLib::Helpers.log name
+            SpecRefLib::Helpers.log ''
+
+            menu.each_with_index do |category, index|
+                SpecRefLib::Helpers.log "\t#{index + 1}. #{category['name']}"
+            end
+
+            get_input('sub_list_selector', menu)
+        end
+
+        def show_example(example)
+            SpecRefLib::Helpers.log example
+            get_input('end_list_selector', nil)
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def get_input(type, category)
+            case type
+            when 'list_selector'
+                value = list_validator(SpecRefLib::Helpers.ret_value, category['categories'], type, category)
+                menu = category['categories'][value - 1]
+                sub_name = menu['name']
+                sub_menu = menu['categories']
+                SpecRefLib::Helpers.clear
+                show_sub_menu(sub_menu, sub_name)
+            when 'sub_list_selector'
+                value = list_validator(SpecRefLib::Helpers.ret_value, category, type, category)
+                menu = category[value - 1]
+                sub_example = menu['example']
+                SpecRefLib::Helpers.clear
+                show_example(sub_example)
+            when 'end_list_selector'
+                list_validator(SpecRefLib::Helpers.ret_value, nil, type, category)
+                SpecRefLib::Helpers.clear
+                show_menu
+            end
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        # rubocop:disable Metrics/MethodLength
+        def list_validator(value, array, type, category)
+            if value == 'q'
+                SpecRefLib::Helpers.clear
+                SpecRefLib::Helpers.log 'Good Bye'
+                return SpecRefLib::Helpers.leave
+            end
+
+            # rubocop:disable Style/SoleNestedConditional
+            if array && value.to_i < array.length + 1
+                return value.to_i unless value.to_i.zero?
+            end
+            # rubocop:enable Style/SoleNestedConditional
+
+            return false unless array
+
+            SpecRefLib::Helpers.log 'Wrong value'
+            get_input(type, category)
+        end
+        # rubocop:enable Metrics/MethodLength
+    end
+end

data/lib/method.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+require_relative 'handle_file'
+
+module SpecRefLib
+  # Displays the keyword/method provided
+  class Method
+    def initialize(filepath, method)
+      @found = false
+      SpecRefLib::Helpers.clear
+      @keyword_array = []
+      @json = filepath.fetch_json
+      show_method(method)
+    end
+
+    def show_method(method)
+      @json['categories'].each do |category|
+        category['categories'].each do |cat|
+          next unless cat['keywords'].include? method
+
+          SpecRefLib::Helpers.log cat['example']
+          SpecRefLib::Helpers.log ''
+          @found = true
+        end
+      end
+      SpecRefLib::Helpers.log 'No keywords found' unless @found
+      handle_input(SpecRefLib::Helpers.ret_value)
+    end
+
+    def handle_input(value)
+      SpecRefLib::Helpers.clear
+
+      if value == 'q'
+        SpecRefLib::Helpers.log 'Good Bye'
+        return SpecRefLib::Helpers.leave
+      end
+
+      SpecRefLib::Start.new
+    end
+  end
+end

data/lib/spec_ref_lib.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'optimist'
+require_relative 'menu'
+require_relative 'method'
+require_relative 'config'
+require_relative 'handle_file'
+
+module SpecRefLib
+  # The start method for spec-ref-lib
+  class Start
+    attr_reader :opts
+
+    def initialize
+      @opts = set_options
+      @filepath = SpecRefLib::HandleFile.new
+      handler
+    end
+
+    # rubocop: disable Layout/HeredocIndentation
+    # rubocop: disable Naming/HeredocDelimiterNaming
+    def set_options
+      Optimist.options do
+        version "spec-ref-lib #{SpecRefLib::Config.version} (c) 2022 Kyle Swaffield"
+        banner <<~EOS
+            Rspec library
+
+        Usage:
+        spec-ref-lib [options] <method name | file path>
+        where [options] are:
+        EOS
+        opt :method, 'rspec keyword or method name', :type => :string # flag --method, default false
+      end
+    end
+    # rubocop: enable Layout/HeredocIndentation
+    # rubocop: enable Naming/HeredocDelimiterNaming
+
+    def handler
+      return SpecRefLib::Menu.new(@filepath) if @opts[:method].nil?
+
+      SpecRefLib::Method.new(@filepath, @opts[:method])
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: spec_ref_lib
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kyle Swaffield
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-11-16 00:00:00.000000000 Z
+dependencies: []
+description: A rspec library
+email: kyle@swaff.iu.au
+executables:
+- spec-ref-lib
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/spec-ref-lib
+- lib/config.rb
+- lib/handle_file.rb
+- lib/helpers.rb
+- lib/menu.rb
+- lib/method.rb
+- lib/spec_ref_lib.rb
+homepage: https://rubygems.org/gems/spec_ref_lib
+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: ''
+test_files: []