lit-cli 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a459079c92763142e2a67ca0edfadecfc1ed5e0755ad5c89bba8f6806c923541
-  data.tar.gz: 6cbaca173d279eb5d60b361cf03a075f760045913d2c8f756913db37a1b2b9fc
+  metadata.gz: 839f03037b67dd56c7b7d4c38ba26138082594823cc32dbc7217c78363d34088
+  data.tar.gz: 3ab13437fcb2e6884ccd9465d85c72c0f3f7623b2e4076cd21ea22ba369a160b
 SHA512:
-  metadata.gz: eef119aa4d3711abddea64974001c946135eba964d06886c8b2a49344b90868aef87079b1c4b293a6af2df8b1f83997ab80596655272c7e581a5d5a59b88d3ac
-  data.tar.gz: 2a8a974813a2c013b16f8830a3bd3670d5bbbf1a03d881bd69587b7ae8f4692681f248e2971aeec45581c35439a1f9b6d95f96472a7989ed19cbaa313e2a103c
+  metadata.gz: 97d737397a07cfd123166f9c233757e0db4606072c75f22235c85d421474bc05bf94ef2ec8e216420b3c1cca9aecd1615c9ad20ade4b76ee6dde3770d36ba89f
+  data.tar.gz: 7e832c959dd947b99609f2e0ff8e30bb45a8f117b13a617a4671bb4236ee6a1a455f595b8eb35d9d682bc06abe9411e336b2f82553e328cd574215481b565770

data/bin/lit

@@ -8,13 +8,11 @@
 #   lit rails server
 ################################################################################
 
-# Enable Lit API.
 ENV['LIT_ENABLED'] = 'true'
 
+# Get flags from arguments.
 args = []
 flags = []
-
-# Get flags from arguments.
 ARGV.each do |arg|
   if arg.start_with? '@'
     flags << arg.delete_prefix('@')

data/lib/config.rb

@@ -1,10 +1,38 @@
+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 :statuses
     attr_accessor :types
+    # Flags.
+    attr_accessor :step
+    attr_accessor :status
+    attr_accessor :type
+    attr_accessor :delay
 
     def initialize()
-      @types = {
+
+      @statuses = {
         :info => { icon: "ℹ", color: :blue },
         :pass => { icon: "✔", color: :green },
         :warn => { icon: "⚠", color: :yellow },
@@ -12,6 +40,84 @@ module LitCLI
         :error => { icon: "!", color: :red },
         :debug => { icon: "?", color: :purple },
       }
+
+      @types = nil
+
+      # 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.
+      ##
+
+      # Boolean on whether or not to step through each lit() breakpoint.
+      @step = false
+
+      # Array of statuses to filter by, for example: [:warn, :error, :fail]
+      @status = nil
+
+      # Array of types to filter by, for example: [:cat, :dog, :tree]
+      @type = nil
+
+      # 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
+      @status = Array(flags[:status]).map(&:to_sym) if valid? flags, :status
+      @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

data/lib/lit_cli.rb

@@ -1,46 +1,152 @@
+require 'pry'
 require 'pastel'
 require 'config'
+require 'lit_pry'
 
 module LitCLI
-
   @@pastel = Pastel.new
-  @@config = Config.new()
+  @@config = Config.new
+  @@is_prying = false
+
+  def lit(message, status = :info, type = nil, context = nil)
+    if @@config.enabled
+      return if LitCLI.filter_status? status
+      return if LitCLI.filter_type? type
+      LitCLI.render(message, status, type, context)
+      LitCLI.step()
+      LitCLI.delay()
+    end
+  end
+  alias 🔥 lit
 
-  def lit(message, type = :info)
-    if ENV['LIT_ENABLED'] == 'true'
-      type_config = @@config.types[type]
+  def self.render(message, status, type, context)
+    text = "🔥"
 
-      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])
+    # Time.
+    time = LitCLI.format(Time.now().strftime("%k:%M"), color: :cyan)
+    text << " #{time}"
 
-      message = "🔥 #{time_text} #{type_text_color} #{message}"
-      puts message
+    # Status.
+    config = @@config.statuses[status]
+    text << LitCLI.format(" #{config[:icon]} #{status.to_s}", config)
+
+    # Type.
+    if !@@config.types.nil? && @@config.types.has_key?(type)
+      config = @@config.types[type]
+      if config.has_key? :icon
+        text << LitCLI.format(" #{config[:icon]} #{type.to_s}", config)
+      else
+        text << LitCLI.format(" #{type.to_s}", config)
+      end
     end
+
+    # Context.
+    text << LitCLI.format(" #{context}", styles: [:bold, :dim])
+
+    # Message.
+    text << " #{message}"
+
+    puts text
+  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_status? status
+    unless @@config.status.nil? || @@config.status.include?(status)
+      return true
+    end
+
+    false
   end
-  alias 🔥 lit
 
-  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
-
-  def self.configure
+  def self.filter_type? 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.format(text, config)
+
+    if config.has_key? :styles
+      # Change characters first.
+      config[:styles].each do |style|
+        case style
+        when :upcase
+          text = text.upcase
+        when :downcase
+          text = text.downcase
+        when :capitalize
+          text = text.capitalize
+        end
+      end
+      # Then apply styling.
+      config[:styles].each do |style|
+        case style
+        when :clear
+          text = @@pastel.clear(text)
+        when :bold
+          text = @@pastel.bold(text)
+        when :dim
+          text = @@pastel.dim(text)
+        when :italic
+          text = @@pastel.italic(text)
+        when :underline
+          text = @@pastel.underline(text)
+        when :inverse
+          text = @@pastel.inverse(text)
+        when :hidden
+          text = @@pastel.hidden(text)
+        when :strike, :strikethrough
+          text = @@pastel.strikethrough(text)
+        end
+      end
+    end
+
+    if config.has_key? :color
+      case config[:color]
+      when :blue
+        text = @@pastel.bright_blue(text)
+      when :green
+        text = @@pastel.green(text)
+      when :yellow
+        text = @@pastel.yellow(text)
+      when :red
+        text = @@pastel.red(text)
+      when :purple, :magenta
+        text = @@pastel.magenta(text)
+      when :cyan
+        text = @@pastel.cyan(text)
+      end
+    end
+
+    text
+  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,70 @@
+# 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.
+    # SEE: https://github.com/ruby/ruby/blob/v2_6_3/lib/rubygems/core_ext/kernel_require.rb
+    #
+    # 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.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Maedi Prichard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-03 00:00:00.000000000 Z
+date: 2021-02-08 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
@@ -34,6 +48,7 @@ files:
 - bin/lit
 - lib/config.rb
 - lib/lit_cli.rb
+- lib/lit_pry.rb
 homepage: https://reflekt.dev/lit
 licenses:
 - MPL-2.0