lit-cli 0.0.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9db5febc2b273d72a49fe3567a45eb9f6045fa1d4907677862eba0ce7157ba60
-  data.tar.gz: 7eed4b5591f6c9d5f689ccda2912c93bdb7c02b66bfda3546cbf7c03945b6713
+  metadata.gz: 7da20adf8c48a70324edea2bbd6fd0ecce700d5963062517dbc3a966aab086be
+  data.tar.gz: f44d5c8433cfa2a640ea2d8785c742070d15ef5078fa131187c6a21c65bedec5
 SHA512:
-  metadata.gz: 2db0ac7511c6adc7f5d9917c2f2c8aedf081b0d6f841c822abb14641e203ee671959719337ee0ced509d6c7175e5bd700ea10ee03f5265db710c89a8c9fdc17d
-  data.tar.gz: c5be990e305ad1c4dbefe5e25976607109ce0f7ad62c860a021191da3e535b4be875994c734f77c435751dfbd5dab362606f61c9df40a590bf8265e10f5c4f7d
+  metadata.gz: b7cb6cf1c1095c166b91ad7b926b30fbb11635b31b2c54aeff776901f20c0ecfae54ebd2d03e88dc9b26a659c462692919cdd113989953e4f89367fa34cde7a0
+  data.tar.gz: 7b9938c6416e365a966e91bd659a7448a6ff31fd40ded6427e586ea5277c4d08f575e2f484ee888e4b008bd13f4b814d6f398b1d96bfd4240aaba296cf36b458

data/bin/lit

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+
+################################################################################
+# Usage:
+#   lit <command>
+#
+# Example:
+#   lit rails server
+################################################################################
+
+ENV['LIT_ENABLED'] = 'true'
+
+# Get flags from arguments.
+args = []
+flags = []
+ARGV.each do |arg|
+  if arg.start_with? '@'
+    flags << arg.delete_prefix('@')
+  else
+    args << arg
+  end
+end
+ENV['LIT_FLAGS'] = flags.join " "
+
+# Get user input.
+command = args.join " "
+
+# Action original command.
+system command

data/lib/config.rb

@@ -0,0 +1,115 @@
+require 'set'
+
+module LitCLI
+
+  ##############################################################################
+  # Default config that can be overridden from the command line or application.
+  #
+  # @usage:
+  #   LitCLI.configure do |config|
+  #     config.<property> = <value>
+  #   end
+  #
+  # @precedence:
+  #   3. Defaults - initialize()
+  #   2. Application - LitCLI.configure()
+  #   1. Command line flags - cli_configure()
+  ##############################################################################
+
+  class Config
+
+    # Track errors and only show them once.
+    @@errors = Set.new
+
+    attr_accessor :enabled
+    attr_accessor :types
+    attr_accessor :type
+    attr_accessor :step
+    attr_accessor :delay
+
+    def initialize()
+
+      @types = {
+        :info => { icon: "ℹ", color: :blue },
+        :pass => { icon: "✔", color: :green },
+        :warn => { icon: "⚠", color: :yellow },
+        :fail => { icon: "⨯", color: :red },
+        :error => { icon: "!", color: :red },
+        :debug => { icon: "?", color: :purple },
+      }
+
+      # Lit is disabled by default, then enabled via the `lit` command.
+      # Or it can be permanently enabled, without the use of the `lit` command.
+      @enabled = false
+
+      ##
+      # FLAGS.
+      #
+      # Flag defaults when not supplied via command line.
+      ##
+
+      # Array of types to filter by, for example... [:warn, :error, :fail]
+      @type = nil
+
+      # Boolean on whether or not to step through each lit() breakpoint.
+      @step = false
+
+      # Integer or float representing amount of seconds to delay each lit() by.
+      @delay = 0
+
+      cli_configure()
+    end
+
+    # Override config from command line.
+    def cli_configure()
+      @enabled = true if ENV['LIT_ENABLED'] == 'true'
+
+      # Convert flag string to hash.
+      flags = {}
+      if ENV['LIT_FLAGS'] && !ENV['LIT_FLAGS'].empty?
+        ENV['LIT_FLAGS'].split().each do |flag|
+          values = flag.split('=')
+
+          key = values.shift.to_sym
+
+          # No arguments.
+          if values.empty?
+            flags[key] = nil
+          else
+            args = values.pop.split(',')
+            # Single argument.
+            if args.count == 1
+              flags[key] = args.first
+            # Multiple arguments.
+            else
+              flags[key] = args
+            end
+          end
+        end
+      end
+
+      @step = true if flags.has_key? :step
+      @type = Array(flags[:type]).map(&:to_sym) if valid? flags, :type
+      @delay = flags[:delay].to_f if valid? flags, :delay
+    end
+
+    def valid? flags, flag
+      # Has flag even been entered on the command line?
+      unless flags.has_key? flag
+        return false
+      end
+
+      if flags[flag].nil?
+        error = "🔥 ERROR: Invalid argument for @#{flag}."
+        unless @@errors.include? error
+          @@errors.add error
+          puts error
+        end
+        return false
+      end
+
+      true
+    end
+
+  end
+end

data/lib/lit_cli.rb

@@ -0,0 +1,79 @@
+require 'pastel'
+require 'config'
+
+module LitCLI
+  @@pastel = Pastel.new
+  @@config = Config.new
+
+  def lit(message, type = :info)
+    if @@config.enabled
+      return if filter? type
+      render(type)
+      step()
+      delay()
+    end
+  end
+  alias 🔥 lit
+
+  def render(type)
+    type_config = @@config.types[type]
+
+    time_text = LitCLI.colorize(Time.now().strftime("%k:%M"), :cyan)
+    type_text = type_config[:icon] + " " + type.to_s
+    type_text_color = LitCLI.colorize(type_text, type_config[:color])
+
+    message = "🔥 #{time_text} #{type_text_color} #{message}"
+
+    puts message
+  end
+
+  def step()
+    if @@config.step
+      puts "🔥 PRESS ENTER:"
+      input = gets.chomp
+      binding while input == nil
+    end
+  end
+
+  def filter? type
+    unless @@config.type.nil? || @@config.type.include?(type)
+      return true
+    end
+
+    false
+  end
+
+  def delay()
+    if @@config.delay > 0
+      sleep(@@config.delay)
+    end
+  end
+
+  def self.colorize(text, color)
+    case color
+    when :blue
+      return @@pastel.bright_blue(text)
+    when :green
+      return @@pastel.green(text)
+    when :yellow
+      return @@pastel.yellow(text)
+    when :red
+      return @@pastel.red(text)
+    when :purple, :magenta
+      return @@pastel.magenta(text)
+    when :cyan
+      return @@pastel.cyan(text)
+    else
+      return text
+    end
+  end
+
+  # Override config from application.
+  def self.configure()
+    yield(@@config)
+
+    # Override config from command line.
+    @@config.cli_configure()
+  end
+
+end

metadata

@@ -1,22 +1,39 @@
 --- !ruby/object:Gem::Specification
 name: lit-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Maedi Prichard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-30 00:00:00.000000000 Z
-dependencies: []
-description: Show log messages in the terminal by starting commands with 'lit'.
+date: 2021-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Console logs that are only visible after prefixing a process with `lit`
 email: maediprichard@gmail.com
-executables: []
+executables:
+- lit
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/cli.rb
+- bin/lit
+- lib/config.rb
+- lib/lit_cli.rb
 homepage: https://reflekt.dev/lit
 licenses:
 - MPL-2.0

data/lib/cli.rb

@@ -1,14 +0,0 @@
-################################################################################
-# Usage:
-#   lit <command>
-#
-# Example:
-#   lit bundle exec rails server
-################################################################################
-
-# Enable Lit API.
-ENV['LIT_ENABLED'] = 'true'
-
-# Action original command.
-command = ARGV.join " "
-system command