lit-cli 0.0.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01f4a1f5271c4c2d83ba1cd6ac53afcfbd2deadc16f5c7d392b8e9fb867f63f4
-  data.tar.gz: 0ee8ab728e6b47438f32e61172e849c7920bc6e528f8b827ab225061791161a9
+  metadata.gz: 0ed5d7713a6943b0043bf26568c069dc4c0a647a8581dc48d7a88c05abb3b5de
+  data.tar.gz: 53c911d1424038fa5bb836dfc68f739514d53a62b91ed813dc506078d4c5742d
 SHA512:
-  metadata.gz: f013c03c7cf113875c0813695a3b14ad7cf46e3678a0568bd959f193689173a76801e7e1337548e7187f12a4ede4283fd4eea5d2a25a21a0e43820220a1605a3
-  data.tar.gz: fb071c6372d2c90950729f688991bc0f53492f63aed17593f1dc27c1383ac27f0fc368ed6b68975413b38c1ba08a1cad4ef51bf581309f8ba774a20991847541
+  metadata.gz: e75aab70ca6f9aac9258b68f289ca7efdaf24d8328030a7195c91e24ecd7828eaf32d42d7cee87acc6b1d188d2ef692969cc402055b1a98ed71bc5a0edf4632e
+  data.tar.gz: 0f88b27bcb0308d93b8e7ba223a91a11125faf4c29fdb600e3ff77a18a1526c1be51f5dc4c60e276f5b2a0aca2e91577a92e8f4ef85b6e6c233d80cab8c0a2c3

data/bin/lit

@@ -8,9 +8,22 @@
 #   lit rails server
 ################################################################################
 
-# Enable Lit API.
 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.
-command = ARGV.join " "
 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,87 @@
+require 'pry'
+require 'pastel'
+require 'config'
+require 'lit_pry'
+
+module LitCLI
+  @@pastel = Pastel.new
+  @@config = Config.new
+  @@is_prying = false
+
+  def lit(message, type = :info)
+    if @@config.enabled
+      return if LitCLI.filter? type
+      LitCLI.render(type)
+      LitCLI.step()
+      LitCLI.delay()
+    end
+  end
+  alias 🔥 lit
+
+  def self.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 self.step()
+    if @@config.step
+      puts "🔥 Press ENTER to step or P to Pry:"
+      input = gets.chomp
+      binding while input == nil
+      @@is_prying = true if input.downcase == "p"
+    end
+  end
+
+  def self.filter? type
+    unless @@config.type.nil? || @@config.type.include?(type)
+      return true
+    end
+
+    false
+  end
+
+  def self.delay()
+    if @@config.delay > 0
+      sleep(@@config.delay)
+    end
+  end
+
+  def self.is_prying?
+    @@config.step && @@is_prying
+  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

data/lib/lit_pry.rb

@@ -0,0 +1,68 @@
+# Only override kernel methods when Lit's @step flag is true.
+if ENV['LIT_FLAGS'] && ENV['LIT_FLAGS'].include?('step')
+  module Kernel
+
+    def require_relative relative_path
+      filename = relative_path
+
+      # Get directory of the file that called this file.
+      absolute_path = caller_locations.first.absolute_path.split('/')
+      absolute_path.pop
+
+      # When relative path is current directory.
+      if relative_path.start_with?('./')
+        filename = relative_path.delete_prefix! './'
+      end
+
+      # When relative path is parent directory.
+      while relative_path.start_with?('../')
+        relative_path.delete_prefix! '../'
+        absolute_path.pop
+      end
+
+      # Append default extension.
+      unless filename.end_with? '.rb'
+        filename << '.rb'
+      end
+
+      filepath = File.join(absolute_path.join('/'), relative_path)
+
+      # Add pry binding beneath each lit message.
+      new_lines = ''
+      File.foreach(filepath) do |line|
+        new_lines << line
+        if line.strip.start_with? 'lit "'
+          new_lines << "binding.pry if LitCLI.is_prying?\n"
+          new_lines << "@@is_prying = false\n"
+        end
+      end
+
+      eval(new_lines)
+    end
+
+    # TODO: Investigate RubyGems `require` before overriding.
+    # def require path
+    #   absolute_path = File.join(Dir.pwd, path)
+    #   #p "requiring #{absolute_path}"
+    #   #p __dir__
+    #   #p File.dirname(File.realpath(__FILE__))
+    #   #p File.realpath(__FILE__)
+    #
+    #   # Split client-side and server-side code.
+    #   new_lines = []
+    #   binding_line = "binding.pry if LitCLI.is_prying?"
+    #
+    #   # Add pry binding beneath each lit message.
+    #   p path
+    #   File.foreach(path) do |line|
+    #     new_lines << line
+    #     if line.strip.start_with? 'lit "'
+    #       new_lines << binding_line
+    #     end
+    #   end
+    #
+    #   eval(new_lines.join)
+    # end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lit-cli
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Maedi Prichard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pastel
@@ -24,7 +24,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Show more detailed logs by starting commands with 'lit'.
+- !ruby/object:Gem::Dependency
+  name: pry
+  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 commands with 'lit'.
 email: maediprichard@gmail.com
 executables:
 - lit
@@ -32,6 +46,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/lit
+- lib/config.rb
+- lib/lit_cli.rb
+- lib/lit_pry.rb
 homepage: https://reflekt.dev/lit
 licenses:
 - MPL-2.0