liquid-pry 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d9747dc63c9436ee4bcf2cb85fc51b89fefeaf442708c30d0acb3910643bf13
+  data.tar.gz: b2a64764e8f320d52605b62f19d5a6db8cf4707762f5f7909660ac19b1c8110b
+SHA512:
+  metadata.gz: de236b237a9d9741760b0accdd08a740b58e5daff8aa9c8ac4386dc68965e73390e7e8a0fdee5365cb209f693e27315ad534c646972a3919d03fad9c947e0b53
+  data.tar.gz: 74762c11ac13274016cb0b168f4807d1bfb8e25bf9e452b97a42d19e8a4c76385c5f22ca96f52ff52b69a0a4ad166be9caa875147596861b0d7a60ccc4761474

data/.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+charset = utf-8
+end_of_line = lf
+
+[*.{adoc,md,rb}]
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in liquid-pry.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sebastian Skałacki
+
+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.adoc

@@ -0,0 +1,136 @@
+= Liquid::Pry
+
+:jekyll: https://jekyllrb.com/
+:jekyll_plugin_install: https://jekyllrb.com/docs/plugins/installation/
+:pry: https://pry.github.io/
+:ribose: https://www.ribose.com
+
+ifndef::env-github[]
+[quote, Pry home page]
+Pry is a runtime developer console with powerful introspection capabilities.
+endif::[]
+ifdef::env-github[]
+“Pry is a runtime developer console with powerful introspection capabilities.”
+-- Pry home page
+endif::[]
+
+Liquid::Pry brings {pry}[Pry] to Liquid templates and to Jekyll-powered sites.
+
+== Installation
+
+=== Without Jekyll
+
+Add following to the `Gemfile`:
+
+----
+gem "liquid-pry"
+----
+
+=== With Jekyll
+
+If you want to integrate Liquid::Pry with Jekyll, it's probably the easiest
+to add following to the `Gemfile`, so that Jekyll will automatically load and
+enable Liquid::Pry:
+
+----
+group :jekyll_plugins do
+  gem "liquid-pry"
+end
+----
+
+For other options, read {jekyll_plugin_install}[Jekyll documentation].
+
+== Usage
+
+This gem provides a Liquid filter and a Liquid tag.
+
+=== Filter
+
+The `pry` filter hooks Pry into filter chain in a Liquid template, helping user
+to debug Jekyll's front matter or any other data available in given template.
+For example following could be used to debug `page.title`:
+
+----
+You are on page {{ page.title | pry }}.
+----
+
+When Liquid renderer encounters `pry` filter, then Pry console is launched.
+A convenience local variable named `input` is defined, which contains filter
+input (value of `page.title` in above example), allowing site developer to
+inspect or alter that value.  Another local variable `context` provides access
+to rendering context.
+
+The filter returns its input, hence it does not affect rendered page.  Also, it
+can be placed anywhere in the filter chain, not necessarily at the end.
+For example, in a following example `pry` filter is placed before `upcase`,
+allowing user to inspect `page.title` value before the `upcase` filter is
+applied.
+
+----
+You are on page {{ page.title | pry | upcase }}.
+----
+
+However, if user modify the value of `input` variable, then modified version is
+returned.  This may be used for experimenting.
+
+The `pry` filter is typically more useful than the `pry` tag, especially for
+novice users.
+
+=== Tag
+
+The `pry` tag interrupts Liquid rendering, allowing user to inspect or modify
+the rendering context.  For example:
+
+----
+{% pry %}
+----
+
+When Liquid renderer encounters `pry` tag, then Pry console is launched
+and rendering context is available via `context` local variable.
+
+==== Using with `once` option
+
+If `pry` tag is supplied with `once` option, then Pry console is launched only
+for the first time that tag is encountered on given page.  In following example:
+
+----
+{% for product in collection.products %}
+  {% pry once %}
+  {{ product.title }}
+{% endfor %}
+----
+
+Pry will be launched only once, no matter if `collection.products` contains one
+item or a hundred.
+
+Still, in following example Pry will be launched twice, because `pry` tag is
+placed that many times in the template:
+
+----
+{% pry once %}
+{% pry once %}
+----
+
+=== Using Pry console
+
+See {pry}[Pry documentation].
+
+== Credits
+
+This gem is developed, maintained and funded by {ribose}[Ribose Inc.]
+
+== License
+
+The gem is available as open source under the terms of the
+https://opensource.org/licenses/MIT[MIT License].
+
+== See also
+
+This gem is tiny but quite comprehensive.  However, there are some other ones
+you may want to try:
+
+- https://github.com/gemfarmer/jekyll-debug[jekyll-debug]
+- https://github.com/zhongxiang117/jekyll-liquid-debug[jekyll-liquid-debug]
+  (a very different approach)
+- https://github.com/octopress/debugger[octopress-debugger]
+  (seems unmaintained as of Jan 2021)

data/Rakefile

@@ -0,0 +1,6 @@
+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 "jekyll/pry"
+
+# 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-pry.rb

@@ -0,0 +1,4 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
+require_relative "liquid/pry"

data/lib/liquid/pry.rb

@@ -0,0 +1,15 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
+require_relative "pry/version"
+
+require "liquid"
+require "pry"
+
+require_relative "pry/filter"
+require_relative "pry/tag"
+
+module Liquid
+  module Pry
+  end
+end

data/lib/liquid/pry/filter.rb

@@ -0,0 +1,27 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
+module Liquid
+  module Pry
+    # +pry+ filter hooks Pry into filter chain in a Liquid template.  User can
+    # inspect or modify filter input and rendering context via convenient
+    # +input+ and +context+ local variables.
+    #
+    # The filter returns its input, hence it can be placed anywhere in the
+    # filter chain, not necessarily at the end.  If user alters the +input+
+    # variable, then modified version is returned.
+    #
+    # @example
+    #   Today is {{ site.time | pry | date_to_string }}
+    module Filter
+      # @param input filter input
+      def pry(input)
+        context = @context
+        binding.pry
+        input
+      end
+    end
+  end
+end
+
+Liquid::Template.register_filter(Liquid::Pry::Filter)

data/lib/liquid/pry/tag.rb

@@ -0,0 +1,47 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
+module Liquid
+  module Pry
+    # Interrupts rendering, allowing user to inspect or modify the context.
+    #
+    # @example
+    #   {% pry %}
+    class Tag < Liquid::Tag
+      attr_reader :once
+      attr_reader :visited
+
+      def initialize(tag_name, text, tokens)
+        super
+        @visited = false
+        parse_args(text)
+      end
+
+      def parse_args(args_str)
+        case args_str.strip
+        when ""
+          return
+        when "once"
+          set_once
+        else
+          raise(
+            ArgumentError,
+            "Arguments passed to pry tag could not be recognized: #{args_str}",
+          )
+        end
+      end
+
+      def set_once
+        @once = true
+      end
+
+      def render(context)
+        binding.pry unless once && visited
+        @visited = true
+        ""
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag("pry", Liquid::Pry::Tag)

data/lib/liquid/pry/version.rb

@@ -0,0 +1,8 @@
+# (c) Copyright 2020 Ribose Inc.
+#
+
+module Liquid
+  module Pry
+    VERSION = "1.0.0"
+  end
+end

data/liquid-pry.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/liquid/pry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "liquid-pry"
+  spec.version       = Liquid::Pry::VERSION
+  spec.authors       = ["Ribose Inc."]
+  spec.email         = ["open.source@ribose.com"]
+
+  spec.summary       = "Brings Pry to Liquid templates."
+  spec.homepage      = "https://github.com/geolexica/liquid-pry"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  all_files_in_git = Dir.chdir(__dir__) { `git ls-files -z`.split("\x0") }
+
+  spec.files         = all_files_in_git.reject { |f| f.match(%r{^(test|spec|features|.github)/}) }
+  spec.executables   = all_files_in_git.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "exe"
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("liquid")
+  spec.add_runtime_dependency("pry")
+
+  spec.add_development_dependency("rspec", "~> 3.9")
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: liquid-pry
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-05 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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: 
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.adoc
+- Rakefile
+- bin/console
+- bin/setup
+- lib/liquid-pry.rb
+- lib/liquid/pry.rb
+- lib/liquid/pry/filter.rb
+- lib/liquid/pry/tag.rb
+- lib/liquid/pry/version.rb
+- liquid-pry.gemspec
+homepage: https://github.com/geolexica/liquid-pry
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Brings Pry to Liquid templates.
+test_files: []