jekyll_eval_filter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be8155d7e7318ab2b296502685ffe77ee49324e2c3c496eeef0d281b9a85ed9c
+  data.tar.gz: d0e60177381189d15979296ac1e3790009a83afc77dad12da0657ad65045914e
+SHA512:
+  metadata.gz: 38fc2366d7130c3cab747b3eb5a1ee762162bdd0868cbd1148a8584659e9e1a118fbb10b8670b1bbae37ca960492d59679a8f99bc70d020ad86c83e36a964321
+  data.tar.gz: bd657a032d11e7ab6cd35e549164413603465e84abbad002a96b1a6037f9483cac583500cde85da6f6c90f5c81f33c10fb0bcff62ad0d40bfb4d5317a626d0ef

data/.rubocop.yml

@@ -0,0 +1,71 @@
+require:
+  # - rubocop-jekyll
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - binstub/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+  NewCops: enable
+  TargetRubyVersion: 3.1.3
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/BlockLength:
+  Exclude:
+    - jekyll_eval_filter.gemspec
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+RSpec/FilePath:
+  IgnoreMethods: true
+  SpecSuffixOnly: true
+
+RSpec/ExampleLength:
+  Max: 30
+
+RSpec/MultipleExpectations:
+  Max: 15

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  * Initial release.

data/README.md

@@ -0,0 +1,100 @@
+`jekyll_eval_filter`
+[![Gem Version](https://badge.fury.io/rb/jekyll_eval_filter.svg)](https://badge.fury.io/rb/jekyll_eval_filter)
+===========
+
+`jekyll_eval_filter` evaluates given Ruby expression passed to it and returns the response.
+
+
+## CAUTION
+This filter can evaluation *any Ruby expression*.
+No limitations are imposed.
+
+If you use this filter, only allow trusted and verified people to edit the source of your Jekyll website.
+
+With great power comes great responsibility.
+
+
+## Usage
+
+```
+{{ '1+2' | eval }}  # returns 3
+
+{{ 'sudo rm -rf /' | eval }}  # potentially destroys your system
+# On a clear disk you can seek forever
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll_eval_filter'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+
+## Additional Information
+More information is available on
+[Mike Slinn’s website](https://www.mslinn.com/jekyll/10400-jekyll-plugin-template-collection.html).
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+
+### Build and Install Locally
+To build and install this gem onto your local machine, run:
+
+```shell
+$ bundle exec rake install
+jekyll_eval_filter 1.0.0 built to pkg/jekyll_eval_filter-0.1.0.gem.
+jekyll_eval_filter (1.0.0) installed.
+```
+
+Examine the newly built gem:
+```
+$ gem info jekyll_eval_filter
+
+*** LOCAL GEMS ***
+
+jekyll_eval_filter (1.0.0)
+    Author: Mike Slinn
+    Homepage:
+    https://github.com/mslinn/jekyll_eval_filter
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    Generates Jekyll logger with colored output.
+```
+
+
+### Build and Push to RubyGems
+To release a new version,
+  1. Update the version number in `version.rb`.
+  2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
+  3. Run the following:
+     ```shell
+     $ bundle exec rake release
+     ```
+     The above creates a git tag for the version, commits the created tag,
+     and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
+
+
+## Contributing
+
+1. Fork the project
+2. Create a descriptively named feature branch
+3. Add your feature
+4. Submit a pull request
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,40 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc 'Bump patch version'
+task :patch do
+  system 'gem bump --tag'
+end
+
+desc 'Bump minor version'
+task :minor do
+  system 'gem bump --version minor --tag'
+end
+
+desc 'Bump major version'
+task :major do
+  system 'gem bump --version major --tag'
+end
+
+task publish: [:build] do
+  $VERBOSE = nil
+  load 'jekyll_eval_filter/version.rb'
+  system "gem push pkg/jekyll_eval_filter-#{JekyllEvalFilter::VERSION}.gem"
+end
+
+desc 'Bump patch version, create git tag, build the gem and release to geminabox (default)'
+task release_patch: %i[test patch publish]
+
+desc 'Bump minor version, create git tag, build the gem and release to geminabox'
+task release_minor: %i[test minor publish]
+
+desc 'Bump major version, create git tag, build the gem and release to geminabox'
+task release_major: %i[test major publish]
+
+task default: :test

data/jekyll_eval_filter.gemspec

@@ -0,0 +1,35 @@
+require_relative 'lib/jekyll_eval_filter/version'
+
+Gem::Specification.new do |spec|
+  host = 'https://github.com/mslinn/jekyll_eval_filter'
+
+  spec.authors               = ['Mike Slinn']
+  spec.description           = <<~END_DESC
+    Evaluates input. Caution! Input can be any Ruby expression.
+  END_DESC
+  spec.email                 = ['mslinn@mslinn.com']
+  spec.files                 = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.homepage              = 'https://github.com/mslinn/jekyll_eval_filter'
+  spec.license               = 'MIT'
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{host}/issues",
+    'changelog_uri'     => "#{host}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => host,
+  }
+  spec.name                 = 'jekyll_eval_filter'
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.summary               = 'Evaluates input. Caution! Input can be any Ruby expression.'
+  spec.version               = JekyllEvalFilter::VERSION
+
+  spec.add_dependency 'geminabox', '>= 2.2.1'
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'jekyll_plugin_support', '>= 0.7.0'
+end

data/lib/evaluate.rb

@@ -0,0 +1,26 @@
+require 'jekyll_plugin_logger'
+
+# Sample Jekyll filter.
+module JekyllEvalFilter
+  class << self
+    attr_accessor :logger
+  end
+  self.logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+
+  # This Jekyll filter evaluates the input string and returns the result.
+  # Use it as a calculator or one-line Ruby program evaluator.
+  #
+  # @param input_string [String].
+  # @return [String] input string and the evaluation result.
+  # @example Use like this:
+  #   {{ 'TODO: show typical input' | eval }} => "TODO: show output"
+  def evaluate(input_string)
+    input_string.strip!
+    JekyllEvalFilter.logger.debug { "input_string=#{input_string}" }
+    Kernel.eval input_string.strip
+  end
+
+  PluginMetaLogger.instance.logger.info { 'Loaded evaluate Liquid filter.' }
+end
+
+Liquid::Template.register_filter JekyllEvalFilter

data/lib/jekyll_eval_filter/version.rb

@@ -0,0 +1,3 @@
+module JekyllEvalFilter
+  VERSION = '0.1.0'.freeze unless defined? VERSION
+end

data/lib/jekyll_eval_filter.rb

@@ -0,0 +1,10 @@
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'jekyll_plugin_support'
+
+require_relative 'jekyll_eval_filter/version'
+
+# Require all Ruby files in 'lib/', except this file
+Dir[File.join(__dir__, '*.rb')].each do |file|
+  require file unless file.end_with?('/jekyll_eval_filter.rb')
+end

data/spec/jekyll_eval_filter_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../lib/jekyll_eval_filter'
+
+RSpec.describe JekyllEvalFilter::JekyllEvalFilter do
+  let(:logger) do
+    PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+  end
+
+  let(:parse_context) { TestParseContext.new }
+
+  it 'has a test' do
+    expect(true).to be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,79 @@
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'liquid'
+require 'fileutils'
+require 'yaml'
+require_relative '../lib/<%= @gem_name %>'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  # config.order = 'random'
+  config.run_all_when_everything_filtered = true
+
+  # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
+  config.example_status_persistence_file_path = '../spec/status_persistence.txt'
+
+  config.filter_run_when_matching focus: true
+end
+
+Registers = Struct.new(:page, :site)
+
+# Mock for Collections
+class Collections
+  def values
+    []
+  end
+end
+
+# Mock for Site
+class SiteMock
+  attr_reader :config
+
+  def initialize
+    @config = YAML.safe_load(File.read('../demo/_config.yml'))
+    @config['env'] = { 'JEKYLL_ENV' => 'development' }
+  end
+
+  def collections
+    Collections.new
+  end
+end
+
+class TestLiquidContext < Liquid::Context
+  def initialize
+    super
+
+    page = {
+      'content'     => 'blah blah',
+      'description' => 'Jekyll plugin support demo',
+      'dir'         => '/',
+      'excerpt'     => nil,
+      'layout'      => 'default',
+      'name'        => 'index.html',
+      'path'        => 'index.html',
+      'title'       => 'Welcome',
+      'url'         => '/',
+    }
+
+    @content = 'Interior of the tag'
+    @registers = Registers.new(
+      page,
+      SiteMock.new
+    )
+  end
+end
+
+# Mock for Liquid::ParseContent
+class TestParseContext < Liquid::ParseContext
+  attr_reader :line_number, :registers
+
+  def initialize
+    super
+    @line_number = 123
+
+    @registers = Registers.new(
+      { 'path' => 'path/to/page.html' },
+      SiteMock.new
+    )
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_eval_filter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: geminabox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: jekyll_plugin_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: 'Evaluates input. Caution! Input can be any Ruby expression.
+
+  '
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- jekyll_eval_filter.gemspec
+- lib/evaluate.rb
+- lib/jekyll_eval_filter.rb
+- lib/jekyll_eval_filter/version.rb
+- spec/jekyll_eval_filter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mslinn/jekyll_eval_filter
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_eval_filter/issues
+  changelog_uri: https://github.com/mslinn/jekyll_eval_filter/CHANGELOG.md
+  homepage_uri: https://github.com/mslinn/jekyll_eval_filter
+  source_code_uri: https://github.com/mslinn/jekyll_eval_filter
+post_install_message: |2+
+
+  Thanks for installing jekyll_eval_filter!
+
+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.3
+signing_key:
+specification_version: 4
+summary: Evaluates input. Caution! Input can be any Ruby expression.
+test_files: []
+...