lit-cli 0.0.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fce9ba635ef45e726a5c06159effa8a01d5fdaa0a3c4f0343fdcd5abc72a75f7
-  data.tar.gz: 81de5c8ef9b211a7f8292395f643a65a062786c40cba4d58a7cfd6ffbf4674e9
+  metadata.gz: 0d016a1786059f76f691d0dd55ab4a8d2e408f4b2ee5bca3d8e42ea29012d379
+  data.tar.gz: 5f0756f25977560051e7b07b86ae795584e954fa14eeb4533f56505c60d9cdfd
 SHA512:
-  metadata.gz: 0b88c567d5454350df3129d8e2f49cea0a1f73c5b6431402f9efd88848baa11fa4b451a96ba048f33208b8656fa60b0eb7ea987f0ee4daf7a225347a0e7d2cb0
-  data.tar.gz: bf8e9a1a16d69c4107ef0ad61acb31341911c66b57edc7e3813d4f1209bfc759b47cad46874f9532efbde1a7e6227022ec127d817f3ca174c18b466d61f23f77
+  metadata.gz: b902f2d26e1b868be3026783a2f99e10a34ca1be0851cd73b5c16c2a4ef23fad146b5f9f51ddaca41975b249833c6f382cd47468f21ef6c2ecfa1638a9a2382e
+  data.tar.gz: 01c08ebe1937ed4d31240aed5bcda06c4d5f85b9d6c28c23ca21b939e547e6267fc7e6248d7f3d14972bd5e9b1ea27dc74df5c38fd3d39f2aaa0a09e5340fef2

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,124 @@
+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()
+
+      @statuses = {
+        :info => { icon: "ℹ", color: :blue },
+        :pass => { icon: "✔", color: :green },
+        :warn => { icon: "⚠", color: :yellow },
+        :fail => { icon: "⨯", color: :red },
+        :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
+end

data/lib/lit_cli.rb

@@ -0,0 +1,147 @@
+require 'pry'
+require 'pastel'
+require 'config'
+require 'lit_pry'
+
+module LitCLI
+  @@pastel = Pastel.new
+  @@config = Config.new
+  @@is_prying = false
+
+  def lit(message, status = :info, type = nil)
+    if @@config.enabled
+      return if LitCLI.filter_status? status
+      return if LitCLI.filter_type? type
+      LitCLI.render(message, status, type)
+      LitCLI.step()
+      LitCLI.delay()
+    end
+  end
+  alias 🔥 lit
+
+  def self.render(message, status, type)
+    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
+
+    # 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
+
+  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
+        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.0.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Maedi Prichard
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-01 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
@@ -32,7 +46,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/lit
-- lib/api.rb
+- lib/config.rb
+- lib/lit_cli.rb
+- lib/lit_pry.rb
 homepage: https://reflekt.dev/lit
 licenses:
 - MPL-2.0

data/lib/api.rb

@@ -1,36 +0,0 @@
-# TODO: Define environment variable in parent process, not just child process.
-# ENV['LIT_SUPPORTED'] = 'true'
-
-require 'pastel'
-
-module LitAPI
-
-  @@pastel = Pastel.new
-
-  def lit(message, status = :info)
-
-    if ENV['LIT_ENABLED'] == 'true'
-
-      time = Time.now().strftime("%k:%M")
-      status_style = status.to_s.upcase
-      status_icons = {
-        :info => "ℹ",
-        :pass => "✔",
-        :fail => "⨯"
-      }
-
-      message = "🔥 #{time}: #{message} (#{status_icons[status]} #{status_style})"
-
-      case status
-      when :info
-        puts @@pastel.bright_blue(message)
-      when :pass, :success
-        puts @@pastel.green(message)
-      when :fail
-        puts @@pastel.red(message)
-      end
-
-    end
-  end
-
-end