liquid_debug 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 57811020ce04cde0d01a92b390e07da1cc07570fd4a4f00dfc1a6f1ad06ac190
+  data.tar.gz: '029fca25a639048845e1234365cc593859e995d9c4e36c5a6dbbfaff70e0bdfb'
+SHA512:
+  metadata.gz: b32f623950ab79e8b62b53796afe7853b80ea0b1d4693b0ec34bd08837370d83adb7dbd6344daeaf91b8ba739d934f5c85105dfbc6908d4e6b7d6938eba311f4
+  data.tar.gz: ee5b851bf75baf69141e2819b3e9a4555e83146e9336e4b1f9605cf716996a5303727c19b6ab4af675ccfb0d4f30a340d210ed669261b03cf9c0dd037cfd20ae

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.swp
+*.swo
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in liquid_debug.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    liquid_debug (0.0.1)
+      paint (= 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    paint (2.1.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.68.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    ruby-progressbar (1.10.0)
+    strong_versions (0.3.2)
+      i18n (>= 0.5.0)
+      paint (~> 2.0)
+    unicode-display_width (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  liquid_debug!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.68.1)
+  strong_versions (~> 0.3.2)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,28 @@
+# LiquidDebug
+
+## Overview
+
+_LiquidDebug_ provides a stack trace of executed [_Liquid_](https://shopify.github.io/liquid/) code when an error occurs, supplementing the [typically vague] default error format provided by _Liquid_.
+
+It is _not_ suitable for a production environment as it makes no effort to account for performance or memory leak issues and so should only be used in a development environment when debugging specific issues.
+
+## Installation
+
+Add the following to your `Gemfile`:
+
+```
+gem 'liquid_debug', '~> 0.0.1'
+```
+
+## Usage
+
+Include the _LiquidDebug_ extension (e.g. in an initializer or in `config/application.rb`):
+
+```
+# config/initializers/liquid_debug.rb
+require 'liquid/debug' if Rails.env.development?
+```
+
+You should now see something like this in your server output when a _Liquid_ error occurs:
+
+![example](images/screenshot.png)

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "liquid_debug"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/liquid/debug.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'liquid_debug'
+
+module LiquidDebug
+  module TagTracker
+    def render(*_args)
+      LiquidDebug.track(@tag_name, @markup)
+      super
+    end
+  end
+
+  module ContextErrorHandler
+    def handle_error(error, *args)
+      LiquidDebug::ErrorHandler.new(error, LiquidDebug.stack).print
+      LiquidDebug.reset
+      super
+    end
+  end
+end
+
+require 'liquid'
+
+unless ENV.key?('LIQUID_DEBUG_DISABLE')
+  Liquid::Context.prepend LiquidDebug::ContextErrorHandler
+  Liquid::Tag.descendants.each { |tag| tag.prepend(LiquidDebug::TagTracker) }
+end

data/lib/liquid_debug/error_handler.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module LiquidDebug
+  class ErrorHandler
+    def initialize(error, stack)
+      @error = error
+      @stack = stack
+    end
+
+    def print(limit = 10)
+      report(limit)
+    end
+
+    private
+
+    # rubocop:disable Metrics/AbcSize
+    def report(limit)
+      backtrace = trace(limit)
+      return nil if backtrace.empty?
+
+      puts("\n" + red(@error.to_s))
+      puts(message(limit, backtrace))
+      if backtrace.size > 1
+        backtrace[0...-1].each { |frame| puts("   #{frame}") }
+      end
+
+      puts(open_highlight + backtrace[-1] + close_highlight)
+      puts("\n")
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def trace(limit)
+      @stack.last(limit).map { |frame| format(frame) }.compact
+    end
+
+    def format(frame)
+      return nil if frame[:tag_name].nil? && frame[:markup].nil?
+
+      tag = frame[:tag_name]
+      "#{open_tag} #{tag_name(tag)} #{markup(frame[:markup])}#{close_tag}"
+    end
+
+    def open_tag
+      Paint['{%', :cyan]
+    end
+
+    def close_tag
+      Paint['%}', :cyan]
+    end
+
+    def open_highlight
+      Paint['=> ', :red, :bright]
+    end
+
+    def close_highlight
+      Paint[' <=', :red, :bright]
+    end
+
+    def tag_name(name)
+      Paint[name, :yellow]
+    end
+
+    def markup(text)
+      Paint[text, :cyan, :bright]
+    end
+
+    def message(_limit, _backtrace)
+      Paint['Backtrace:', :white] + "\n\n"
+    end
+
+    def red(text)
+      Paint[text, :red]
+    end
+  end
+end

data/lib/liquid_debug/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LiquidDebug
+  VERSION = '0.0.1'
+end

data/lib/liquid_debug.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'liquid_debug/version'
+require 'liquid_debug/error_handler'
+
+module LiquidDebug
+  class Error < StandardError; end
+
+  def self.track(tag_name, markup)
+    stack.push(tag_name: tag_name, markup: markup)
+  end
+
+  def self.reset
+    stack.clear
+  end
+
+  def self.stack
+    @stack ||= []
+  end
+end

data/liquid_debug.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'liquid_debug/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'liquid_debug'
+  spec.version       = LiquidDebug::VERSION
+  spec.authors       = ['Bob Farrell']
+  spec.email         = ['robertanthonyfarrell@gmail.com']
+
+  spec.summary       = "Debug Shopify's Liquid templating language"
+  spec.description   = 'Extends Liquid for enhanced debugging'
+  spec.homepage      = 'https://github.com/bobf/liquid_debug'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'paint', '2.1'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.68.1'
+  spec.add_development_dependency 'strong_versions', '~> 0.3.2'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: liquid_debug
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bob Farrell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.68.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.68.1
+- !ruby/object:Gem::Dependency
+  name: strong_versions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+description: Extends Liquid for enhanced debugging
+email:
+- robertanthonyfarrell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- images/screenshot.png
+- lib/liquid/debug.rb
+- lib/liquid_debug.rb
+- lib/liquid_debug/error_handler.rb
+- lib/liquid_debug/version.rb
+- liquid_debug.gemspec
+homepage: https://github.com/bobf/liquid_debug
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Debug Shopify's Liquid templating language
+test_files: []