lit-cli 0.2.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 642edf5650f6fbfd2b92ed421ee1b7a205c6fbe7fa14a4e9c24fe06d07d443c8
-  data.tar.gz: 9b090b0c6a37d47d2257eb5e1723df8ea5793e18d9eddb224a06817e111501ad
+  metadata.gz: 39a417c815a30ecdf0e99aaa9aa47d22b4def3f2d891f6da1911414a7187a86b
+  data.tar.gz: 5bb7af898274544027202aedb33d9428401044867ad0693ae6314b1c361c9418
 SHA512:
-  metadata.gz: 122442d065db2aaf73e01d4629940a57e12b5ae88bdd2bf57bcdaddaab2548950b9ee522ca1080ad5577bb9ab7e3db5aea61db0d7ca319f1c3a1415225bf76af
-  data.tar.gz: 3c438491edf8cd0b0c7854321486f37c0a443ccac2ed6d1de32776b1aa05822152030d73fed0a315e832ebea4d688a82484fa1ce6c3aaef5d26ddc7782e258d7
+  metadata.gz: 1b45c6ae31e1db4cf3ac3fd338e8a11df273618cd8aa8b7d870d3764c9ae86b472b5823504fec11956c33fcc7fe0ca044db544e6c872f167a9db7bbfeaf881b5
+  data.tar.gz: 47a8560f08cbd269877dcd1a6bd14b718a684b190991b80b439602fe766b15f84bc1c44826aafed8416277e2fb425f66d35d447f32676cacdc8d9ef4fa31a8a0

data/lib/config.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module LitCLI
 
   ##############################################################################
@@ -16,23 +18,31 @@ module LitCLI
 
   class Config
 
+    # Track errors and only show them once.
+    @@errors = Set.new
+
     attr_accessor :enabled
+    attr_accessor :statuses
     attr_accessor :types
-    attr_accessor :type
+    # Flags.
     attr_accessor :step
+    attr_accessor :status
+    attr_accessor :type
     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 },
+      @statuses = {
+        :info => { icon: "ℹ", color: :blue, styles: [:upcase] },
+        :pass => { icon: "✔", color: :green, styles: [:upcase] },
+        :warn => { icon: "⚠", color: :yellow, styles: [:upcase] },
+        :fail => { icon: "⨯", color: :red, styles: [:upcase] },
+        :error => { icon: "!", color: :red, styles: [:upcase] },
+        :debug => { icon: "?", color: :purple, styles: [:upcase] },
       }
 
+      @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
@@ -43,12 +53,15 @@ module LitCLI
       # 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
 
+      # 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
 
@@ -83,16 +96,28 @@ module LitCLI
         end
       end
 
-      @type = flags[:type] if flags.has_key? :type
       @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
 
-      if flags.has_key? :delay
-        unless flags[:delay].nil?
-          @delay = flags[:delay].to_f
-        else
-          puts "🔥 ERROR: Invalid argument."
+    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,67 +1,144 @@
+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)
+  def lit(message, status = :info, type = nil, context = nil)
     if @@config.enabled
-      filter(type)
-      render(type)
-      step()
-      delay()
+      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 render(type)
-    type_config = @@config.types[type]
+  def self.render(message, status, type, context)
+    text = "🔥"
+
+    # Time.
+    time = LitCLI.format(Time.now().strftime("%k:%M"), color: :cyan)
+    text << " #{time}"
+
+    # 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
 
-    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])
+    # Context.
+    text << LitCLI.format(" #{context}", styles: [:bold, :dim])
 
-    message = "🔥 #{time_text} #{type_text_color} #{message}"
+    # Message.
+    text << " #{message}"
 
-    puts message
+    puts text
   end
 
-  def filter(type)
-    if @@config.type
-
+  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 step()
-    if @@config.step
+  def self.filter_status? status
+    unless @@config.status.nil? || @@config.status.include?(status)
+      return true
+    end
+
+    false
+  end
 
+  def self.filter_type? type
+    unless @@config.type.nil? || @@config.type.include?(type)
+      return true
     end
+
+    false
   end
 
-  def delay()
+  def self.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
+  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.
@@ -72,8 +149,4 @@ module LitCLI
     @@config.cli_configure()
   end
 
-  def self.error(message)
-    puts "🔥 ERROR: #{message}"
-  end
-
 end

data/lib/lit_pry.rb

@@ -0,0 +1,96 @@
+# Only override kernel methods when Lit's @step flag is true.
+if ENV['LIT_FLAGS'] && ENV['LIT_FLAGS'].include?('step')
+  require 'set'
+
+  # TODO: Investigate RubyGems `require` before overriding.
+  # SEE: https://github.com/ruby/ruby/blob/v2_6_3/lib/rubygems/core_ext/kernel_require.rb
+
+  module Kernel
+
+    @@lit_processed_paths = Set.new
+
+    def require_relative relative_path, current_directory = nil
+      return false if relative_path.nil?
+
+      # Handle absolute path.
+      if relative_path.start_with?('/') && File.exist?(relative_path)
+        absolute_path = relative_path.split('/')
+        file_name = absolute_path.pop
+      # Handle relative path.
+      else
+        # Get directory of the file that called this file.
+        if current_directory.nil?
+          absolute_path = caller_locations.first.absolute_path.split('/')
+          absolute_path.pop
+        else
+          absolute_path = current_directory.split('/')
+        end
+
+        # When path is current directory.
+        if relative_path.start_with?('./')
+          relative_path.delete_prefix! './'
+        end
+
+        # When path is parent directory.
+        while relative_path.start_with?('../')
+          relative_path.delete_prefix! '../'
+          absolute_path.pop
+        end
+
+        # When path contains child directories.
+        if relative_path.split('/').count > 1
+          # Add child directories to absolute path and remove from relative path.
+          child_path = relative_path.split('/')
+          relative_path = child_path.pop
+          child_path.each do |dir|
+            absolute_path << dir
+          end
+        end
+
+        file_name = relative_path
+      end
+
+      # Append default extension.
+      unless file_name.end_with? '.rb'
+        file_name << '.rb'
+      end
+
+      file_path = File.join(absolute_path.join('/'), file_name)
+
+      unless @@lit_processed_paths.include? file_path
+        @@lit_processed_paths.add file_path
+
+        new_lines = ''
+        File.foreach(file_path) do |line|
+
+          # Pass current directory into the next file's requires.
+          if line.strip.start_with? 'require_relative '
+            line = line.strip + ", '#{absolute_path.join('/')}'\n"
+            new_lines << line
+          else
+            new_lines << line
+          end
+
+          # Add pry binding beneath each lit message.
+          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, get_binding(__dir__ = absolute_path), file_path)
+        return true
+      # Path has already been required.
+      else
+        return false
+      end
+    end
+
+    def get_binding(__dir__)
+      # Don't go to this binding when Pry session activated.
+      # The variables have already been evaluated by eval(). NEEDS CONFIRMATION.
+      # Setting file_path in eval() negates this fix but will keep just in case.
+      return binding unless LitCLI.is_prying?
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lit-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Maedi Prichard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-06 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