broken 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a5c05dfd27676a7ec939f35d91111bf5c83f963770d90458ed14934ef2c052f
+  data.tar.gz: db35fe7a20c2528e1ac6fc8c894d5064a3ad4597047524b034a5f353cab74aba
+SHA512:
+  metadata.gz: 06bae52c7afb967efb6df80c24d8ad36df8732355ac4cb4c50cf5731b119d9af9bb4315f04531cd8e45ab7eea810f1eda9757afba7c5d8ab48bad2d961ead9a8
+  data.tar.gz: 9220bd2630a6a1250dfc186bde926f2c2f602fed6a1be15de7ccc74f01dc8cf5b0bdafdcc6115e550b157f765a48730f123cb1cdfd54531c62d0ec89e4c517c4

data/bin/broken

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

data/lib/broken.rb

@@ -0,0 +1,184 @@
+require 'pastel'
+require 'config'
+
+module Broken
+  @@pastel = Pastel.new
+  @@config = Config.new
+  @@is_prying = false
+
+  def broken(message, status = :info, type = nil, context = nil)
+    if @@config.enabled
+      return if Broken.filter_status? status
+      return if Broken.filter_type? type
+
+      indent = Broken.render(message, status, type, context)
+
+      Broken.step(indent)
+      yield if block_given?
+
+      Broken.delay()
+    end
+  end
+  alias 🔥 broken
+
+  def self.render(message, status, type, context)
+    output = "🔥"
+
+    # Time.
+    time = Broken.format(Time.now().strftime("%k:%M"), color: :cyan)
+    output << " #{time}"
+
+    # Status.
+    config = @@config.statuses[status]
+    output << Broken.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
+        output << Broken.format(" #{config[:icon]} #{type.to_s}", config)
+      else
+        output << Broken.format(" #{type.to_s}", config)
+      end
+    end
+
+    # Context.
+    output << Broken.format(" #{context}", styles: [:bold, :dim])
+
+    # Line break.
+    while message.start_with?('^')
+      message.delete_prefix!('^').strip!
+      unless @@config.status || @@config.type
+        output = "\n" + output
+      end
+    end
+
+    # Indent.
+    indent = ''
+    while message.start_with?('>')
+      message.delete_prefix!('>').strip!
+      unless @@config.status || @@config.type
+        indent = indent + '  '
+        output = '  ' + output
+      end
+    end
+
+    # Highlight numbers and methods.
+    words = []
+    message.split(/(#\d+|\w+\(\))/).each do |word|
+      if word.start_with?('#') || word.end_with?(')')
+        words << @@pastel.yellow(word)
+      else
+        words << word
+      end
+    end
+
+    puts output << " " + words.join()
+
+    return indent
+  end
+
+  def self.step(indent)
+    if @@config.step
+      puts "#{indent}🔥 Press ENTER to step or P to Pry:"
+      input = gets.chomp
+      binding while input == nil
+      if input.downcase == "p"
+        puts @@pastel.dim("Enter X to exit Pry or !!! to exit program.")
+        @@is_prying = true
+      end
+    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
+        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 flags on command line.
+    @@config.cli_configure()
+  end
+
+end

data/lib/config.rb

@@ -0,0 +1,132 @@
+require 'set'
+
+module Broken
+
+  ##############################################################################
+  # Default config that can be overridden from the command line or application.
+  #
+  # @usage:
+  #   Broken.configure do |config|
+  #     config.<property> = <value>
+  #   end
+  #
+  # @precedence:
+  #   3. Defaults - initialize()
+  #   2. Application - Broken.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, 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
+
+      # Broken is disabled by default, then enabled via the `broken` command.
+      # Or it can be permanently enabled, without the use of the `broken` command.
+      @enabled = false
+
+      ##
+      # FLAGS.
+      #
+      # Flag defaults when not supplied via command line.
+      ##
+
+      # 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 broken() by.
+      @delay = 0
+
+      ##
+      # PRIVATE.
+      ##
+
+      # Boolean on whether or not to step through each broken() breakpoint.
+      # Setting to true here wont enable Pry, best to enable via command line.
+      @step = false
+
+      cli_configure()
+    end
+
+    # Override config from command line.
+    def cli_configure()
+
+      # Enable broken via the command line.
+      @enabled = true if ENV['BROKEN_ENABLED'] && ENV['BROKEN_ENABLED'].to_i >= (Time.now.to_i() - 1)
+      return unless @enabled
+
+      # Convert flag string to hash.
+      flags = {}
+      if ENV['BROKEN_FLAGS'] && !ENV['BROKEN_FLAGS'].empty?
+        ENV['BROKEN_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

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: broken
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maedi Prichard
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-30 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 commands with 'broken'.
+email: maediprichard@gmail.com
+executables:
+- broken
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/broken
+- lib/broken.rb
+- lib/config.rb
+homepage: https://reflekt.dev/broken
+licenses:
+- MPL-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: "Shine a light on terminal commands. \U0001F525"
+test_files: []