jekyll-raise_liquid_error 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4a0b5c851ccefee26fa8c39fc0b609786fff793fe5543cf5491fee2d3b5ef9c9
+  data.tar.gz: 10c508a24d7544736c4a4d6f458a890cfa906724107ea180864f70de42b0fd0b
+SHA512:
+  metadata.gz: 94991749148df1be6d2a6e4a9f192ccfc62b452dde863bfeb729433b74a238f7d317edeed2a59e33fc86211280d30d32bca1317d02a882b4a9620996c4966aa2
+  data.tar.gz: 698ab203d4977bb2db8d1243471eee035b3bf7147b3a0dcc54eecbd28755ec58d6c380e8d1fe40e0e6b8fe7e084713b270ff846dfc18265c2ca7e5cff34b2e44

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Simon Greuter
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+> Simple liquid filter to raise build-time errors from liquid code
+
+## Installation
+
+This plugin is available as a [RubyGem][ruby-gem].
+
+Add this line to your application's `Gemfile`:
+
+```
+gem 'jekyll-raise_liquid_error'
+```
+
+And then execute the `bundle` command to install the gem.
+
+Alternatively, you can also manually install the gem using the following command:
+
+```
+$ gem install jekyll-raise_liquid_error
+```
+
+After the plugin has been installed successfully, add the following lines to your `_config.yml` in order to tell Jekyll to use the plugin:
+
+```
+gems:
+- jekyll-raise_liquid_error
+```
+
+## Getting Started
+
+In your markup, use the `raise_error` liquid filter anywhere the compiler should never land at build time:
+
+```
+{{ 'Error Message: something is wrong with your site' | raise_error }}
+```
+
+This will make your build fail with the error message you defined along with the location of the markup file involved.
+
+## Example usage
+
+```
+{%- if your_var != nil -%}
+{{'Variable your_var expected to be nil, but was: ' | append: your_var | raise_error }}"
+{%- endif -%}
+```
+
+This will fail your build (if external plugins are allowed, e.g. locally) and give you some hint what went wrong.
+
+# Contribute
+
+If you know anything more about ruby and can improve this snippet (e.g. adding working tests), please fork this repository and issue a pull request.
+
+
+# Copyright
+
+I just packaged this snippet from 
+
+https://stackoverflow.com/questions/43901429/raise-exceptions-during-a-jekyll-build-if-specified-yaml-fields-are-missing
+
+to get a valid Gem. All kudos to mdlincoln.
+
+License: MIT
+
+[ruby-gem]: https://rubygems.org/gems/jekyll-raise_liquid_error

data/lib/jekyll/raise_liquid_error/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module RaiseLiquidError
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll/raise_liquid_error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "raise_liquid_error/version"
+
+module Jekyll
+  module RaiseLiquidError
+    module RaiseLiquidErrorFilter
+
+      def raise_error(msg)
+        source_file = @context.registers[:page]['path']
+        err_msg = "In #{source_file}: #{msg}"
+        raise err_msg
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::RaiseLiquidError::RaiseLiquidErrorFilter)

data/lib/jekyll-raise-liquid-error.rb

@@ -0,0 +1,7 @@
+module Jekyll
+  module RaiseLiquidError
+    autoload :VERSION, 'jekyll/raise_liquid_error/version.rb'
+  end
+end
+
+require 'jekyll/raise_liquid_error.rb'

data/spec/jekyll/raise_liquid_error_filter_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe(Jekyll::RaiseLiquidError::RaiseLiquidErrorFilter) do
+
+  let(:output) do
+    render_liquid(content, {'error_message' => error_message})
+  end
+
+  #  TODO: make tests work
+  #  somehow I need to be able to inject context.registers, but don't
+  #  know enough about ruby to do that atm
+  
+#  context "Raising an unconditional error" do
+#    msg = "This code should never be reached!"
+#
+#    let(:error_message) { msg }
+#    let(:content) { "{{ '#{error_message}' | raise_error }}" }
+#
+#    it "produces the correct error message" do
+#      expect { output }
+#        .to(raise_error do |error|
+#          expect(error).to be_a(Exception)
+#          expect(error.message).to eq msg
+#        end)
+#    end
+#  end
+end

data/spec/jekyll/raise_liquid_error_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe Jekyll::RaiseLiquidError do
+  it "has a version number" do
+    expect(Jekyll::RaiseLiquidError::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'liquid'
+require "jekyll/raise_liquid_error"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+
+  def render_liquid(content, variables)
+    template = Liquid::Template.parse(content)
+    template.render(variables)
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-raise_liquid_error
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Greuter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-09-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Liquid filter to raise an error during Jekyll build
+email:
+- 6537188+greuters@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/jekyll-raise-liquid-error.rb
+- lib/jekyll/raise_liquid_error.rb
+- lib/jekyll/raise_liquid_error/version.rb
+- spec/jekyll/raise_liquid_error_filter_spec.rb
+- spec/jekyll/raise_liquid_error_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/greuters/jekyll-raise_liquid_error
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/greuters/jekyll-raise_liquid_error
+  source_code_uri: https://github.com/greuters/jekyll-raise_liquid_error
+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.3.5
+signing_key: 
+specification_version: 4
+summary: This plugin provides a simple liquid filter which raises an error at build
+  time.
+test_files:
+- spec/jekyll/raise_liquid_error_filter_spec.rb
+- spec/jekyll/raise_liquid_error_spec.rb
+- spec/spec_helper.rb