liquid_error_handler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c2f877a4f4bb8dda9fa31a02e6379255a62cbdf0abd94cdfb9d56ac52024c96
+  data.tar.gz: d6245aa709c100c2942ee6967ee3fb2f6e57a5d04433a1bbd24449a858dd2053
+SHA512:
+  metadata.gz: 0af81abdc2d35a7d4012b4784457b3d3ddac044cbb4f69bca9d009e46b33c51d1d70228ec9b4a35aa07d16fcf4550b609bdb2efa378082176a8a7e2fae952e5b
+  data.tar.gz: 24eefd0375962acc527add6faff82456ddfa6d677b2b878c68423a47a70c7537b4014f3fe11c096f236028b015a88a150376b539b41be23c8c1de1ea0ed81403

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+  -  'bin/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+  - 'spec/**/*_spec.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'devpack', '~> 0.3.3'
+gem 'rspec', '~> 3.10'
+gem 'rspec-file_fixtures', '~> 0.1.4'
+gem 'rubocop', '~> 1.23'
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 2.6'
+gem 'strong_versions', '~> 0.4.5'

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    liquid_error_handler (0.1.0)
+      liquid (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    devpack (0.3.3)
+    diff-lcs (1.4.4)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    liquid (5.1.0)
+    paint (2.2.1)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-file_fixtures (0.1.4)
+      rspec (~> 3.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    strong_versions (0.4.5)
+      i18n (>= 0.5)
+      paint (~> 2.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  devpack (~> 0.3.3)
+  liquid_error_handler!
+  rake (~> 13.0)
+  rspec (~> 3.10)
+  rspec-file_fixtures (~> 0.1.4)
+  rubocop (~> 1.23)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.6)
+  strong_versions (~> 0.4.5)
+
+BUNDLED WITH
+   2.2.33

data/Makefile

@@ -0,0 +1,4 @@
+.PHONY test:
+	bundle exec rspec
+	bundle exec rubocop
+	bundle exec strong_versions

data/README.md

@@ -0,0 +1,53 @@
+# LiquidErrorHandler
+
+Configure error handling hooks for the [Liquid](https://shopify.github.io/liquid/) templating language for [Ruby](https://www.ruby-lang.org/en/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'liquid_error_handler', '~> 0.1.0'
+```
+
+## Usage
+
+Register an error handler, for example in a _Rails_ initializer. Error handlers should be callable and will receive the error as an argument.
+
+```ruby
+# config/initializers/liquid_error_handler.rb
+
+LiquidErrorHandler.register_handler do |error|
+  Rails.logger.error("Liquid Error: #{error} #{error.backtrace}")
+end
+```
+
+Use with libraries like [Airbrake](https://github.com/airbrake/airbrake) to send all _Liquid_ errors to your error aggregation platform:
+
+```ruby
+# config/initializers/liquid_error_handler.rb
+
+LiquidErrorHandler.register_handler do |error|
+  Airbrake.notify(error) unless Rails.env.development? || Rails.env.test?
+end
+```
+
+### Disabling
+
+_LiquidErrorHandler_ can be disabled by setting the environment variable `LIQUID_ERROR_HANDLER_DISABLE` to any value:
+
+```console
+LIQUID_ERROR_HANDLER_DISABLE=1 rails server
+```
+
+### Resetting
+
+All error handlers can be removed by calling `LiquidErrorHandler.reset`:
+
+```ruby
+LiquidErrorHandler.reset
+```
+
+## License
+
+[MIT License](LICENSE)

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,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "liquid_error_handler"
+
+# 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_error_handler/context.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module LiquidErrorHandler
+  # Prepended to Liquid context to handle any errors that take place during render.
+  module Context
+    def handle_error(error, *_args)
+      return super if LiquidErrorHandler.disabled?
+
+      LiquidErrorHandler.hooks.each { |hook| hook.call(error.cause.nil? ? error : error.cause) }
+      super
+    end
+  end
+end

data/lib/liquid_error_handler/version.rb

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

data/lib/liquid_error_handler.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'liquid'
+
+require_relative 'liquid_error_handler/version'
+require_relative 'liquid_error_handler/context'
+
+# Configures Liquid error handlers.
+module LiquidErrorHandler
+  class Error < StandardError; end
+
+  @hooks = []
+
+  def self.reset
+    @hooks = []
+  end
+
+  def self.register_handler(&block)
+    @hooks << block
+  end
+
+  def self.disabled?
+    ENV.key?('LIQUID_ERROR_HANDLER_DISABLE')
+  end
+
+  class << self
+    attr_reader :hooks
+  end
+end
+
+Liquid::Context.prepend LiquidErrorHandler::Context unless LiquidErrorHandler.disabled?

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: liquid_error_handler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bob Farrell
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Configure error handling hooks for Liquid.
+email:
+- git@bob.frl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/liquid_error_handler.rb
+- lib/liquid_error_handler/context.rb
+- lib/liquid_error_handler/version.rb
+homepage: https://github.com/bobf/liquid_error_handler
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.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: Error handling for Liquid templating language.
+test_files: []