cryptum 0.0.397 → 0.0.398

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c05b91169e59df115a671e125bdb0c714af8f2fbc7ac6a9ba5717c9706c23df
-  data.tar.gz: 8337e24f8b608010adda85562aabca09ed06701203a0b2b8d3fd2b8b2ccbd0c7
+  metadata.gz: bf83992e0e95b37febd02252408c8737787b96c391c29c8ba884a576e78930d3
+  data.tar.gz: 919eb5b669e93ce91ccded4adc5dfd73e8821be72b73c66b2bfe8f846034cd28
 SHA512:
-  metadata.gz: 1728544e34746de6cbccd11ef5640556364c6333ef8c8bc0618abf21b95f23562e15a45096bd8591c6831a4a2ba085d60c3ef13daad3122054b762ac4b8337b1
-  data.tar.gz: c50b2669722d80f03c7f509ab08fdcabca6dbf10f9caa8cd213f3304be4c880f5e4c455c8770a2269b50723483d5cc06c03320080a01e3fa077239401c811600
+  metadata.gz: 2b6c1423945dd56b5dd1138be8d59ab41fa2296d936d5811537c86ac92f694c1c63d3683fe09ca630e2d0bb67b3bf48cad2d39b425f811c310a9a4fd3496b542
+  data.tar.gz: 60f3a01446ed7a1cc973f1c99776af09c61b18b026fbf5c30b357af2e3359737a0e2acdb024266b0105a143cd6ead9235e6eeadd23674113ee34904ac4f1f3ff

data/.rubocop.yml

@@ -1,35 +1,27 @@
 AllCops: 
   UseCache: false
   NewCops: enable
-Layout:
-  Max: 3000
 Layout/LineLength:
-  Max: 256
+  Max: 250
 Lint/UselessRescue:
   Enabled: false
 Metrics/AbcSize:
-  Max: 512
+  Max: 393
 Metrics/BlockLength:
-  Max: 256
+  Max: 138
 Metrics/BlockNesting:
-  Max: 4
+  Max: 3
 Metrics/ClassLength:
-  Max: 512
-Metrics/CyclomaticComplexity:
   Max: 128
+Metrics/CyclomaticComplexity:
+  Max: 75
 Metrics/MethodLength:
-  Max: 512
+  Max: 397
 Metrics/ModuleLength:
-  Max: 1024
+  Max: 407
 Metrics/PerceivedComplexity:
-  Max: 128
-Style/HashEachMethods:
-  Enabled: true
+  Max: 75
 Style/HashSyntax:
   EnforcedShorthandSyntax: never
-Style/HashTransformKeys:
-  Enabled: true
-Style/HashTransformValues:
-  Enabled: true
 
 inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,22 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2023-04-03 22:26:52 UTC using RuboCop version 1.49.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
-# SupportedStyles: assign_to_condition, assign_inside_condition
-Style/ConditionalAssignment:
-  Exclude:
-    - 'lib/cryptum/event/pane.rb'
-    - 'lib/cryptum/log.rb'
-    - 'lib/cryptum/ui/order/execute_details.rb'
-
-# Offense count: 28
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Enabled: false

data/lib/cryptum/api/orders.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to interact withbtje Coinbase REST API
+  # Cryptum::API Namespace
   module API
+    # This Module is used to interact with the Order APIs
     module Orders
       public_class_method def self.submit_limit(opts = {})
         option_choice = opts[:option_choice]

data/lib/cryptum/event/bot_conf.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Reload the Bot Conf When the "r" Key is Pressed
+  # Cryptum::Event Namespace
   module Event
+    # This Module is used to Reload the Bot Conf When the "r" Key is Pressed
     module BotConf
       # Supported Method Parameters::
       # Cryptum::Event::BotConf.reload(

data/lib/cryptum/event/buy.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Submit a Limit Order
-  # to Buy Crypto Currency
-
+  # Cryptum::Event Namespace
   module Event
+    # This Module is used to Submit Limit Buy Orders
     module Buy
       # Supported Method Parameters::
       # Cryptum::Event::Buy.crypto(

data/lib/cryptum/event/cancel.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Reload the Bot Conf When the "C" Key is Pressed
+  # Cryptum::Event Namespace
   module Event
+    # This Module is used to Cancel Open Orders When the "C" Key is Pressed
     module Cancel
       # Supported Method Parameters::
       # Cryptum::Event::Cancel.open_orders(

data/lib/cryptum/event/exit.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Exit Cryptum Gracefully When the "x" Key is Pressed
+  # Cryptum::Event Namespace
   module Event
+    # This Module is used to Exit Cryptum Gracefully When the "x" Key is Pressed
     module Exit
       # Supported Method Parameters::
       # Cryptum::Event::Exit.gracefully(

data/lib/cryptum/event/gtfo.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Get the F* Out (GTFO) when the "G" Key is Pressed
+  # Cryptum::Event Namespace
   module Event
+    # This Modules is used to Get the F* Out (GTFO) when the "G" Key is Pressed
     module GTFO
       # Supported Method Parameters::
       # Cryptum::Event::GTFO.now(

data/lib/cryptum/event/history.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Track Event History
+  # Cryptum::Event Namespace
   module Event
-    # Keep Last Event History When Terminal Resize Occuers
+    # Class to Keep Track of Event History
     class History
       attr_accessor :bullish_trend,
                     :event,

data/lib/cryptum/event/key_press.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Detect if any Keys were Pressed on the Keyboard
+  # Cryptum::Event Namespace
   module Event
+    # This Module is used to Detect when Keys are Pressed on the Keyboard
     module KeyPress
       # Supported Method Parameters::
       # Cryptum::Event::KeyPress.detect(

data/lib/cryptum/event/order_book.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Write the Order Book from Memory
-  # to File When the "w" Key is Pressed
+  # Cryptum::Event Namespace
   module Event
+    # This Module is used to Write the Order Book from Memory
+    # to File When the "w" Key is Pressed
     module OrderBook
       # Supported Method Parameters::
       # Cryptum::Event::OrderBook.write(

data/lib/cryptum/event/pane.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Switch through Order Plan / Order History
-  # Window Panes when the TAB Key is Pressed.
+  # Cryptum::Event Namespace
   module Event
+    # This Module is used to Switch through Order Plan / Order History
+    # Window Panes when the TAB Key is Pressed.
     module Pane
       # Supported Method Parameters::
       # Cryptum::Event::Pane.switch(
@@ -36,18 +37,12 @@ module Cryptum
 
         if event_history.order_plan_win_active
           unless event_history.red_pill
-            if event_history.order_plan_details_win_active
-              event_history.order_plan_details_win_active = false
-            else
-              event_history.order_plan_details_win_active = true
-            end
+            event_history.order_plan_details_win_active = true
+            event_history.order_plan_details_win_active = false if event_history.order_plan_details_win_active
           end
         elsif event_history.order_execute_win_active
-          if event_history.order_execute_details_win_active
-            event_history.order_execute_details_win_active = false
-          else
-            event_history.order_execute_details_win_active = true
-          end
+          event_history.order_execute_details_win_active = true
+          event_history.order_execute_details_win_active = false if event_history.order_execute_details_win_active
         end
       rescue Interrupt, StandardError => e
         Cryptum::Log.append(level: :error, msg: e, which_self: self, event_history: event_history)

data/lib/cryptum/event/parse.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to parse Coinbase Pro Web Socket Events in the HTTP Response
+  # Cryptum::Event Namespace
   module Event
+    # This Module is used to parse message received by the Web Socket
     module Parse
       # Supported Method Parameters::
       # Cryptum::Event::Parse.websocket_msg(

data/lib/cryptum/event/scroll.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Scroll through Order Plan
-  # Order Plan and Order History Window Panes
-  # to File When the "w" Key is Pressed
+  # Cryptum::Event Namespace
   module Event
+    # This Module is used to Scroll through
+    # Order Plan and Order History Window Panes
     module Scroll
       # Supported Method Parameters::
       # Cryptum::Event::Scroll.up(

data/lib/cryptum/event/sell.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Submit a Limit Order
-  # to Sell Crypto Currency
-
+  # Crytpum::Event Namespace
   module Event
+    # This Module is used to Submit Limit Sell Orders
     module Sell
       # Supported Method Parameters::
       # Cryptum::Event::Sell.crypto(

data/lib/cryptum/order_book/generate.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This module is used to define the Order Book Data Structure
+  # Cryptum::OrderBook Namespace
   module OrderBook
+    # Load in Existing Order Book from File or Generate a New Order Book
     module Generate
       # Supported Method Parameters::
       # Cryptum::OrderBook::Generate.new(

data/lib/cryptum/order_book/indicator.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to calculate Exponential Moving Average
-  # Price of a Symbol over time.
-
+  # Cryptum::OrderBook Namespace
   module OrderBook
+    # This class is used to track market indicators to drive decision making.
     class Indicator
       attr_accessor :market_trend,
                     :profit_margin,

data/lib/cryptum/order_book/market_trend.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to indicate if the order trend
-
+  # Cryptum::OrderBook Namespace
   module OrderBook
+    # This Module is used for Market Trend Analysis
     module MarketTrend
       # Supported Method Parameters::
       # Cryptum::OrderBook::OrderTrend.status(

data/lib/cryptum/order_book/profit_margin.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to indicate if the
-  # Projected Profit Margin is greater than
-  # the Target Profit Margin Outlined in the
-  # Respective Bot Conf
-
+  # Cryptum::OrderBook Namespace
   module OrderBook
+    # This module is used to indicate if the
+    # Projected Profit Margin is greater than
+    # the Target Profit Margin Outlined in the
+    # Respective Bot Conf
     module ProfitMargin
       # Supported Method Parameters::
       # Cryptum::OrderBook::ProfitMargin.status(

data/lib/cryptum/portfolio/balance.rb

@@ -3,6 +3,7 @@
 module Cryptum
   # This plugin is used to instantiate a Cryptum logger with a custom message format
   module Portfolio
+    # Track Portfolio Balances
     module Balance
       # Supported Method Parameters::
       # Cryptum::Event::Update.summary(

data/lib/cryptum/ui/command.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module Cryptum
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
-    # This plugin is used to Refresh the Cryptum Command Section UI
+    # Update the Cryptum Command Section UI
     module Command
       # Supported Method Parameters::
       # Cryptum::UI::Command.refresh(

data/lib/cryptum/ui/exit.rb

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
 
 module Cryptum
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
-    # This Class is Used to Detect Key Press Events
+    # Gracefully Exit the UI and Attempt to Save event_history to Order Book Session File.
     module Exit
+      # Supported Method Parameters::
+      # Cryptum::UI::Exit.gracefully(
+      #   event_history: 'optional - Pass in the event_history if available to save to order book'
+      # )
       public_class_method def self.gracefully(opts = {})
         event_history = opts[:event_history]
 

data/lib/cryptum/ui/key_press_event.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Cryptum
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
     # This Class is Used to Detect Key Press Events
     class KeyPressEvent

data/lib/cryptum/ui/market_trend.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Refresh the Cryptum console UI
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
+    # Update the Cryptum MarketTrend Section UI
     module MarketTrend
       # Supported Method Parameters::
       # Cryptum::UI::Candle.refresh(
       #   order_book: 'required - Order Book Data Structure',
       #   event: 'required - Event from Coinbase Web Socket'
       # )
-
       public_class_method def self.refresh(opts = {})
         market_trend_win = opts[:market_trend_win]
         event_history = opts[:event_history]

data/lib/cryptum/ui/matrix.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Refresh the Cryptum console UI
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
     # This plugin is used as a visual representation of being in a, "Red Pill" state
     module Matrix

data/lib/cryptum/ui/order/execute.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Refresh the Cryptum console UI
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
+    # Cryptum::UI::Order Namespace
     module Order
+      # Update the Execute Section of the UI (When Active)
       module Execute
         # Supported Method Parameters::
         # Cryptum::UI::Order::Execute.refresh(

data/lib/cryptum/ui/order/execute_details.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 module Cryptum
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
-    # This plugin is used to Display Order Execute Details
-    # selected from the Order Execute Window Pane.
+    # Cryptum::UI::Order Namespace
     module Order
+      # Update the ExecuteDetails Section of the UI (When Active)
       module ExecuteDetails
         # Supported Method Parameters::
         # Cryptum::UI::Order::ExecuteDetails.refresh(
@@ -17,16 +19,16 @@ module Cryptum
           order_meta_data = event_history.order_execute_selected_data
 
           order_color = order_meta_data[:color].to_sym
-          case order_color
-          when :cyan, :red
-            order_id = order_meta_data[:buy_order_id]
-          when :green, :magenta, :yellow
-            order_id = order_meta_data[:sell_order_id]
-          when :white
-            order_id = 'Expired'
-          else
-            order_id = 'N/A'
-          end
+          order_id = case order_color
+                     when :cyan, :red
+                       order_meta_data[:buy_order_id]
+                     when :green, :magenta, :yellow
+                       order_meta_data[:sell_order_id]
+                     when :white
+                       'Expired'
+                     else
+                       'N/A'
+                     end
 
           order_id_details = "- ID: #{order_id}"
 
@@ -77,15 +79,15 @@ module Cryptum
             order_status_ln = "- Status: #{order_status}"
           end
 
-          if created_at && (!expire_time || !done_at)
-            order_hist_created_finished_ln = "- Creation Date: #{created_at} | Finished Date: N/A"
-          elsif created_at && expire_time && !done_at
-            order_hist_created_finished_ln = "- Creation Date: #{created_at} | Expiring Date: #{expire_time}"
-          elsif created_at && done_at
-            order_hist_created_finished_ln = "- Creation Date: #{created_at} | Finished Date: #{done_at}"
-          else
-            order_hist_created_finished_ln = '- Creation Date: N/A | Finished Date: N/A'
-          end
+          order_hist_created_finished_ln = if created_at && (!expire_time || !done_at)
+                                             "- Creation Date: #{created_at} | Finished Date: N/A"
+                                           elsif created_at && expire_time && !done_at
+                                             "- Creation Date: #{created_at} | Expiring Date: #{expire_time}"
+                                           elsif created_at && done_at
+                                             "- Creation Date: #{created_at} | Finished Date: #{done_at}"
+                                           else
+                                             '- Creation Date: N/A | Finished Date: N/A'
+                                           end
 
           invest_out = Cryptum.beautify_large_number(
             value: order_meta_data[:invest]

data/lib/cryptum/ui/order/plan.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Refresh the Cryptum console UI
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
+    # Cryptum::UI::Order Namespace
     module Order
+      # Update the Plan Section of the UI (When Active)
       module Plan
         # Supported Method Parameters::
         # Cryptum::UI::Order::Plan.refresh(

data/lib/cryptum/ui/order/plan_details.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 module Cryptum
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
-    # This plugin is used to Display Order Plan Details
-    # selected from the Order Plan Window Pane.
+    # Cryptum::UI::Order Namespace
     module Order
+      # Update the PlanDetails Section of the UI (When Active)
       module PlanDetails
         # Supported Method Parameters::
         # Cryptum::UI::Order::PlanDetails.refresh(

data/lib/cryptum/ui/order/timer.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 module Cryptum
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
-    # This plugin is used to Refresh the Cryptum Status Section UI
+    # Cryptum::UI::Order Namespace
     module Order
+      # Update the Timer Section of the UI
       module Timer
         # Supported Method Parameters::
         # Cryptum::UI::Timer.refresh(

data/lib/cryptum/ui/order.rb

@@ -4,6 +4,7 @@ module Cryptum
   # Cryptum::UI Module used for Presenting the
   # Cryptum Curses Interface
   module UI
+    # Include Modules Related to Order
     module Order
       require 'cryptum/ui/order/execute'
       require 'cryptum/ui/order/execute_details'

data/lib/cryptum/ui/portfolio.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Refresh the Cryptum console UI
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
+    # Update the Portfolio Section of the UI
     module Portfolio
       # Supported Method Parameters::
       # Cryptum::UI::Candle.refresh(

data/lib/cryptum/ui/signal_engine.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Refresh the Cryptum console UI
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
+    # Update the SignalEngine Section of the UI
     module SignalEngine
       # Supported Method Parameters::
       # Cryptum::UI::Candle.refresh(

data/lib/cryptum/ui/terminal_window.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Cryptum
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
     # This Class is Used by Cryptum::Event to
     # Detect when the Terminal Window is Resized

data/lib/cryptum/ui/ticker.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 module Cryptum
-  # This plugin is used to Refresh the Cryptum console UI
+  # Cryptum::UI Module used for Presenting the
+  # Cryptum Curses Interface
   module UI
+    # Update the Ticker section of the UI
     module Ticker
       public_class_method def self.refresh(opts = {})
         start_time = opts[:start_time]

data/lib/cryptum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Cryptum
-  VERSION = '0.0.397'
+  VERSION = '0.0.398'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cryptum
 version: !ruby/object:Gem::Version
-  version: 0.0.397
+  version: 0.0.398
 platform: ruby
 authors:
 - 0day Inc.