rcalc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cb69e198b3962c319a9c650f89801e90546052ae251cb3c210da79c60ba0057
-  data.tar.gz: 9ab7f2bde1836cdd5bb9be3721639d38bcc545d87193835b96290849c31e24f5
+  metadata.gz: 0f0e64f85b5dd6a9127f9cc0b0ac727d3a8e25ea6349b2a9783b9cc3028eb8c4
+  data.tar.gz: 5307ef4f657bf83041efd1ede8445ff4a0cacc2378afb323113b9205702d1a39
 SHA512:
-  metadata.gz: 953935bc9a637ebcc8a9c01e060e8368c5687b43d9afd3c4a3d2fa7f5e144298f8678d7104b3d9b90b0de9dc21e420e3151a0c1839d1099189a76d5f2d3eb3f3
-  data.tar.gz: c07ed1ba3efd59fc3c63bb509cff8cd43daedf156066ce6c1460a0c28b2501c5b2c83437b4e1c794f4e6f1770c60fd76c044070fb8746d72fe107ad6e762eb06
+  metadata.gz: f268e9d5a5115ebb324033e195880497631cc4a818d104a79fddd0fea81b06e3118d5265c0dbb4934b41dcc564e02510bcd025cfac83ea571a0d737869577f03
+  data.tar.gz: e1963ec1a0d6a7101da77a4579424a7142ef5694cb36d34c613ab197b145719b0c93c07b275beb823b550b23a50c2c952d73d8bada1038d70fe9a9714c51c57b

data/lib/rcalc/terminal.rb

@@ -1,11 +1,11 @@
-# frozen_string_literal: true
-
 module Rcalc
+  ##
+  # This class contains utilities related to terminal. Its initializer does not take any arguments.
+  #
   class Terminal
-    def initialize
-      @continuous_listen = false
-    end
-
+    ##
+    # Performs a blocking console query. Used by other functions in this class
+    #
     def blocking_console_query(query, listen_until)
       # send query and block wait for response
       res = ''
@@ -26,11 +26,28 @@ module Rcalc
       res
     end
 
+    ##
+    # Gets the cursor position in the terminal. Returns two variables, x and y. Takes no arguments.
+    #
+    # @return [Integer, Integer] x and y, or column, row in that order.
+    #
+    # @example
+    #   t = Rcalc::Terminal.new
+    #   x, y = t.pos
+    #
     def pos
       m = blocking_console_query('6n', 'R').match(/(?<row>\d+);(?<column>\d+)/)
       [Integer(m[:column]), Integer(m[:row])]
     end
 
+    ##
+    # Gets the size of the terminal in characters. Returns two variables, width and height. Takes no arguments.
+    #
+    # @return [Integer, Integer] width and height, or columns, rows in that order.
+    # @example
+    #   t = Rcalc::Terminal.new
+    #   w, h = t.size
+    #
     def size
       # get current position
       x, y = pos
@@ -47,10 +64,16 @@ module Rcalc
       [tx, ty]
     end
 
+    ##
+    # Function to get the CSI sequence. Used by other functions in the class
+    #
     def esc
       "\e["
     end
 
+    ##
+    # Function to print the CSI sequence followed by some command. Used by other functions in the class
+    #
     def e!(command)
       print "#{esc}#{command}"
     end
@@ -71,10 +94,24 @@ module Rcalc
       end
     end
 
+    ##
+    # Sets the current text color to a number
+    #
+    # @example set text color to red
+    #   t = Rcalc::Terminal.new
+    #   t.color!(Rcalc::TERMINAL_COLORS[:red])
+    #
     def color!(id)
       e! "38;5;#{id}m"
     end
 
+    ##
+    # Sets the current background color to a number
+    #
+    # @example set background color to red
+    #   t = Rcalc::Terminal.new
+    #   t.bgcolor!(Rcalc::TERMINAL_COLORS[:red])
+    #
     def bgcolor!(id)
       e! "48;5;#{id}m"
     end
@@ -89,10 +126,35 @@ module Rcalc
       end
     end
 
+    ##
+    # Sets the current text color to a RGB value
+    #
+    # @example set text color to red
+    #   t = Rcalc::Terminal.new
+    #   t.rgb!(255,0,0)
+    #
     def rgb!(r, g, b)
       e! "38;2;#{r};#{g};#{b}m"
     end
 
+    ##
+    # Sets the current background color to a RGB value
+    #
+    # @example set background color to red
+    #   t = Rcalc::Terminal.new
+    #   t.bgrgb!(255,0,0)
+    #
+    def bgrgb!(r, g, b)
+      e! "48;2;#{r};#{g};#{b}m"
+    end
+
+    ##
+    # Sets cursor position
+    #
+    # @example set cursor to 10,10
+    #   t = Rcalc::Terminal.new
+    #   t.goto!(10, 10)
+    #
     def goto!(x, y)
       e! "#{y};#{x}f"
     end
@@ -130,6 +192,15 @@ module Rcalc
       res
     end
 
+    ##
+    # Listen for keypresses on the terminal
+    #
+    # @example
+    #   t = Rcalc::Terminal.new
+    #   t.listen! do |key|
+    #     print key
+    #   end
+    #
     def listen!(&block)
       $stdin.raw do |stdin|
         collect = ''

data/lib/rcalc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rcalc
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/rcalc.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://github.com/davidsiaw/rcalc'
   spec.metadata['changelog_uri'] = 'https://github.com/davidsiaw/rcalc'
+  spec.metadata['documentation_uri'] = 'https://rcalc.davidsiaw.net/'
   spec.metadata['rubygems_mfa_required'] = 'true'
 
   spec.files         = Dir['{exe,data,lib}/**/*'] + %w[Gemfile rcalc.gemspec]
@@ -31,4 +32,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'rubocop-rake'
   spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'webrick'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rcalc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - David Siaw
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Terminal tools for interactive calculations
 email:
 - 874280+davidsiaw@users.noreply.github.com
@@ -105,6 +133,7 @@ metadata:
   homepage_uri: https://github.com/davidsiaw/rcalc
   source_code_uri: https://github.com/davidsiaw/rcalc
   changelog_uri: https://github.com/davidsiaw/rcalc
+  documentation_uri: https://rcalc.davidsiaw.net/
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []