dynamic_curses_input 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c428601614e3ac70ef3fcbf32e47f08c630e41fee379ac070042615d22247a2
-  data.tar.gz: 6cb43128ee6336bbf5f8b86aa870b9ac106c0a965f684c4e55c2f3cf3ee1679c
+  metadata.gz: 94be33a37c50fb5c028854b16e18ec655ee6a9b20c0caa0007f3939b2f4d73a8
+  data.tar.gz: a5f98c86a14da07791b4cc3c5950a08bb5635d5f55bbb7beef7ef873bd07d07e
 SHA512:
-  metadata.gz: 9cc2ecdbac0dd45a134b373e74f10dddfed6dd906cd61e53ea706886e47a2fe02323a4a8f95667e8a03863f5c1d74b3887cf95a346609db83880b659ca86769a
-  data.tar.gz: f6df58e040695ae079a1d231ccf85ce01b080e06644c398e31946f50b691c4e841bed51af4252392af855b173aba709ed49612b15b7c4a9716d14924d7c3fa0f
+  metadata.gz: 492b393474c5e309a2003cadba1049fd7bed476ba39f7c5e6592f78fcc89345000e5c70eb7e02c143d3c3362b7ffabcd5d8e3953627ec46f3771b33bdbc44d19
+  data.tar.gz: c9a3249fd853c5b22e457274c61f80da3c80391d0bdec16b05328196fc6db60c5d8a6657c7221af15aa6cbef2a2cdb916382e64a121f2086be4ee6d56fb565f8

data/CHANGELOG.md

@@ -4,8 +4,6 @@
 
 - Initial release
 
-## [Release]
-
 ## [1.1.0] - 2023-07-26
 
 - Features and Enhancements:
@@ -28,3 +26,13 @@
 - Other Changes:
 
     - Removed redundant and unused code snippets to improve code cleanliness and maintainability.
+
+## [1.2.0] - 2023-07-31
+
+- Features Added
+
+    - Added automatic handling for the up and down arrow keys to behave more like the user would expect.
+
+    - The Up arrow will bring the cursor to the beginning of the line by setting the cursor position to 0 after checking if the cursor is already there
+
+    - The Down arrow will bring the cursor to the end of the line by setting the cursor to the position equal to the length of the input line plus 1

data/Gemfile

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in dynamic_curses_input.gemspec
 gemspec
 
-gem 'rake'
+gem "rake"
 
-gem 'rubocop'
+gem "rubocop"
 
-gem 'curses'
+gem "curses"
 
-gem 'reline'
+gem "reline"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dynamic_curses_input (1.0.1.1)
+    dynamic_curses_input (1.1.0)
       curses
       reline
 
@@ -21,9 +21,9 @@ GEM
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.8.1)
-    reline (0.3.6)
+    reline (0.3.7)
       io-console (~> 0.5)
-    rexml (3.2.5)
+    rexml (3.2.6)
     rubocop (1.55.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)

data/README.md

@@ -1,8 +1,6 @@
-# DynamicCursesInput
+# Dynamic Curses Input
 
-DynamicCursesInput is a Ruby gem that provides a simple and intuitive way to handle user input in a Curses-based terminal user interface (TUI). It allows for dynamic input handling, including cursor movement and inline character addition and deletion.
-
-## Table of Contents
+Dynamic Curses Input is a Ruby gem that provides a simple and intuitive way to handle user input in a Curses-based terminal user interface (TUI). It allows for dynamic input handling, including cursor movement and inline character addition and deletion.
 
 - [Installation](#installation)
 - [Usage](#usage)
@@ -15,7 +13,7 @@ DynamicCursesInput is a Ruby gem that provides a simple and intuitive way to han
 
 ## Installation
 
-To install DynamicCursesInput, add the following line to your application's Gemfile:
+To install Dynamic Curses Input, add the following line to your application's Gemfile:
 
 ```ruby
 gem 'dynamic_curses_input'
@@ -35,7 +33,7 @@ $ gem install dynamic_curses_input
 
 ## Usage
 
-Here's a simple example of how to use DynamicCursesInput:
+Here's a simple example of how to use Dynamic Curses Input:
 
 ```ruby
 require "curses"
@@ -61,20 +59,15 @@ In this example, `DCI.catch_input(true)` will capture user input until the Enter
 
 ## Documentation
 
-Detailed documentation for each function is available in the [wiki](https://github.com/Pixelated-Studios/dynamic_curses_input/wiki).
+Detailed documentation for each function is available in the [wiki](https://git.pixelridgesoftworks.com/PixelRidge-Softworks/dynamic_curses_input/wiki).
 
 ## Dependencies
 
 DynamicCursesInput depends on the [Curses](https://github.com/ruby/curses) gem.
 
-## FAQs
-
-- **Q: How do I handle special keys like arrow keys?**
-  - A: Special keys like arrow keys are automatically handled by DynamicCursesInput.
-
 ## Troubleshooting
 
-If you encounter any issues while using DynamicCursesInput, please check the [issues](https://github.com/yourusername/dynamic_curses_input/issues) page. If your issue isn't listed, feel free to open a new issue.
+If you encounter any issues while using DynamicCursesInput, please check the [issues](https://git.pixelridgesoftworks.com/PixelRidge-Softworks/dynamic_curses_input/issues) page. If your issue isn't listed, feel free to open a new issue.
 
 ## Contribution Guidelines
 
@@ -86,6 +79,6 @@ DynamicCursesInput is available under the [MIT License](LICENSE.txt).
 
 ---
 
-### Note from the Developer: 
+### Note from the Developer:
 
 There is a function in this gem that is not finished yet, it's for making asking questions in a Curses TUI easier from within the gem. This method shouldn't be used yet.

data/Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

data/buildgem.sh

@@ -8,6 +8,7 @@ sleep 1
 echo "Cleaning up old files..."
 sleep 1
 gem cleanup dynamic_curses_input
+rm -f dynamic_curses_input-1.2.0.gem
 sleep 1
 echo "Building DCI..."
 sleep 1
@@ -16,7 +17,7 @@ echo "built!"
 sleep 1
 echo "Installing new version of DCI..."
 sleep 1
-gem install dynamic_curses_input-1.0.1.1.gem
+gem install dynamic_curses_input-1.2.0.gem
 echo "Installed!"
 echo "press any key to exit..."
-read -p ""
+read ""

data/dynamic_curses_input.gemspec

@@ -5,8 +5,8 @@ require_relative 'lib/dynamic_curses_input/version'
 Gem::Specification.new do |spec|
   spec.name = 'dynamic_curses_input'
   spec.version = DynamicCursesInput::VERSION
-  spec.authors = ['VetheonGames']
-  spec.email = ['vetheon@pixelatedstudios.net']
+  spec.authors = ['PixelRidge-Softworks']
+  spec.email = ['connorc@pixelridgesoftworks.com']
 
   spec.summary = 'A simple library for making Curses TUI input more dynamic and user-friendly'
   spec.description = "Dynamic Curses Input is a highly simple, yet powerful gem that allows simple implementation of
@@ -16,17 +16,22 @@ Gem::Specification.new do |spec|
                       that code, by providing simple to use methods that allow developers to capture user input, while
                       allowing the special keys to work as the average user would expect.
                       IE: When you press the left arrow key, the cursor moves to the left and allows you to delete a
-                      character you entered that isn't the last character you entered."
-  spec.homepage = 'https://github.com/Pixelated-Studios/dynamic_curses_input'
+                      character you entered that isn't the last character you entered.
+
+                      KNOWN BUG: X & Y coords for placing windows appear to be broken right now. Will fix with
+                      next update"
+  spec.homepage = 'https://git.pixelridgesoftworks.com/PixelRidge-Softworks/dynamic_curses_input'
   spec.license = 'MIT'
   spec.required_ruby_version = '3.2.2'
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/Pixelated-Studios/dynamic_curses_input'
-  spec.metadata['changelog_uri'] = 'https://github.com/Pixelated-Studios/dynamic_curses_input/blob/main/CHANGELOG.md'
+  spec.metadata['source_code_uri'] = 'https://git.pixelridgesoftworks.com/PixelRidge-Softworks/dynamic_curses_input'
+  spec.metadata['changelog_uri'] = 'https://git.pixelridgesoftworks.com/PixelRidge-Softworks/dynamic_curses_input/src/branch/main/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
-  spec.files = Dir.glob('{bin,lib,sig}/**/*') + Dir.glob('*').reject { |f| f.start_with?('spec', '.rspec', 'dynamic_curses_input.gemspec') }
+  spec.files = Dir.glob('{bin,lib,sig}/**/*') + Dir.glob('*').reject do |f|
+                                                  f.start_with?('spec', '.rspec', 'dynamic_curses_input.gemspec')
+                                                end
   spec.files << 'LICENSE.txt'
   spec.files << 'README.md'
   spec.files << 'dynamic_curses_input.gemspec'

data/lib/dynamic_curses_input/color_window.rb

@@ -9,7 +9,7 @@ module DynamicCursesInput
   # Class for creating a colored window
   class ColorWindow
     # Initialize instance variables and setup curses
-    def initialize(echo, x, y)
+    def initialize(echo, x, y) # rubocop:disable Metrics/MethodLength, Naming/MethodParameterName
       @echo = echo # Determines whether input should be echoed to the screen
       setup_curses_color # Setup curses
       @x = x
@@ -26,7 +26,7 @@ module DynamicCursesInput
     end
 
     # Method that adds colored text to the window
-    def add_color_window(color, text, x, y, input: nil, echo: true)
+    def add_color_window(color, text, x, y, input: nil, echo: true) # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists, Naming/MethodParameterName
       # Map color names to color pair numbers
       color_map = {
         'black' => 1,
@@ -70,7 +70,7 @@ module DynamicCursesInput
     end
 
     # Set cursor position manually on the X and Y axis
-    def set_position(y, x)
+    def set_position(y, x) # rubocop:disable Naming/MethodParameterName
       Curses.setpos(y, x)
     end
   end

data/lib/dynamic_curses_input/input_handler.rb

@@ -47,6 +47,8 @@ module DynamicCursesInput
       case chk
       when Curses::KEY_LEFT then handle_left_key # Move cursor left
       when Curses::KEY_RIGHT then handle_right_key # Move cursor right
+      when Curses::KEY_UP then handle_up_key
+      when Curses::KEY_DOWN then handle_down_key
       when Curses::KEY_BACKSPACE, 127 then handle_backspace_key # Delete character
       when 10, 13 then handle_enter_key # Break loop if enter key is pressed
       else handle_default_key(chk) # Add character to input string
@@ -63,6 +65,16 @@ module DynamicCursesInput
       @cursor_pos = CursorMover.right(@cursor_pos, @input.length)
     end
 
+    # Move cursor down
+    def handle_down_key
+      @cursor_pos = CursorMover.down(@cursor_pos, @input.length)
+    end
+
+    # Move cursor up
+    def handle_up_key
+      @cursor_pos = CursorMover.up(@cursor_pos, @input.length)
+    end
+
     # Delete character
     def handle_backspace_key
       @input, @cursor_pos = CharacterDeleter.delete(@input, @cursor_pos)
@@ -103,8 +115,18 @@ module DynamicCursesInput
       cursor_pos == length ? cursor_pos : cursor_pos + 1
     end
 
+    # Handle down arrow key
+    def self.down(_, length)
+      length # Move to the end of the line
+    end
+
+    # Handle up arrow key
+    def self.up(_, _length)
+      0 # Move to the beginning of the line (position 0)
+    end
+
     # Set cursor position
-    def self.set_position(y, x)
+    def self.set_position(y, x) # rubocop:disable Naming/MethodParameterName
       Curses.setpos(y, x)
     end
   end

data/lib/dynamic_curses_input/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DynamicCursesInput
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/lib/dynamic_curses_input.rb

@@ -15,12 +15,12 @@ module DynamicCursesInput
     InputHandler.catch_input(echo)
   end
 
-  def self.ask_question(color = 'white', question, x: 'center', input: true, echo: nil)
+  def self.ask_question(color = 'white', question, x: 'center', input: true, echo: nil) # rubocop:disable Naming/MethodParameterName
     Curses.clear
     ColorWindow.add_color_window(color, question, y:, x:, input:, echo:)
   end
 
-  def self.print_color_window(color, text, y_value: nil, x: 'center', input: nil, echo: true)
+  def self.print_color_window(color, text, y_value: nil, x: 'center', input: nil, echo: true) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/ParameterLists, Naming/MethodParameterName
     case x
     when 'center'
       terminal_size = `stty size`.split.map(&:to_i)
@@ -59,7 +59,7 @@ module DynamicCursesInput
   class << self
     private
 
-    def process_print_color_window_args(args)
+    def process_print_color_window_args(args) # rubocop:disable Metrics/MethodLength
       case args.size
       when 2
         ['white', args[0], args[1], 'center', nil, true]

data/tester.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'dynamic_curses_input'
+
+# Create and display a red window at the center of the screen
+DCI.print_color_window('red', 'test', y_value: 60, x: '40')
+
+# Create and display a magenta window at a specific position
+DCI.print_color_window('magenta', 'testy-test', y_value: 30, x: '20')
+
+# Initialize Curses
+Curses.init_screen
+Curses.cbreak
+Curses.noecho
+
+# Wait for the Enter key to be pressed
+Curses.stdscr.getch until Curses.stdscr.getch == 10
+
+# Clean up and close Curses
+Curses.close_screen

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_curses_input
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
-- VetheonGames
+- PixelRidge-Softworks
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-26 00:00:00.000000000 Z
+date: 2023-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curses
@@ -61,8 +61,11 @@ description: |-
                         allowing the special keys to work as the average user would expect.
                         IE: When you press the left arrow key, the cursor moves to the left and allows you to delete a
                         character you entered that isn't the last character you entered.
+
+                        KNOWN BUG: X & Y coords for placing windows appear to be broken right now. Will fix with
+                        next update
 email:
-- vetheon@pixelatedstudios.net
+- connorc@pixelridgesoftworks.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -83,13 +86,14 @@ files:
 - lib/dynamic_curses_input/input_handler.rb
 - lib/dynamic_curses_input/version.rb
 - sig/dynamic_curses_input.rbs
-homepage: https://github.com/Pixelated-Studios/dynamic_curses_input
+- tester.rb
+homepage: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/dynamic_curses_input
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/Pixelated-Studios/dynamic_curses_input
-  source_code_uri: https://github.com/Pixelated-Studios/dynamic_curses_input
-  changelog_uri: https://github.com/Pixelated-Studios/dynamic_curses_input/blob/main/CHANGELOG.md
+  homepage_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/dynamic_curses_input
+  source_code_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/dynamic_curses_input
+  changelog_uri: https://git.pixelridgesoftworks.com/PixelRidge-Softworks/dynamic_curses_input/src/branch/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths: