jekyll_quote 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65b7377a2c75d3e1418bcab4842b7e804b1d2757a3c1447c419314833117582d
+  data.tar.gz: a3598bdd5c4edc526f408ae33dc8db6d179c9ed9e9a5839da65b6cd6fc574de8
+SHA512:
+  metadata.gz: d2204156fb0b7f2c1cd8a23c771364d22ccd3d5c3bbb649ad376dc8585fa5515c683a304a53c35f89b49217472586aacbea7d6696ccc4f603621b810bd2664b8
+  data.tar.gz: 1d6e5b223ffa416bd83610fbc6cdf1ee4af53e7d8e788b3a859dc2638c4935db1b7a640229904b9c494dcd804679e287d4279c45d0acbd46a616867db4ddc285

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - exe/**/*
+      - Gemfile*
+      - Rakefile
+      - '*.gemspec'
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/MethodLength:
+  Max: 30
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 10

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0 / 2023-01-12
+  * Initial version

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mike Slinn
+
+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,106 @@
+`jekyll_quote`
+[![Gem Version](https://badge.fury.io/rb/jekyll_quote.svg)](https://badge.fury.io/rb/jekyll_quote)
+===========
+
+`jekyll_quote` is a Jekyll plugin that displays formatted quotes.
+
+See [demo/index.html](demo/index.html) for examples.
+
+
+## Installation
+
+Add this line to your Jekyll project's Gemfile, within the `jekyll_plugins` group:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_quote'
+end
+```
+
+Also add it to `_config.yml`:
+```yaml
+plugins:
+  - jekyll_quote
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_quote
+
+
+## Additional Information
+More information is available on
+[Mike Slinn’s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.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.
+
+
+To build and install this gem onto your local machine, run:
+```shell
+$ bundle exec rake install
+jekyll_quote 0.1.0 built to pkg/jekyll_quote-0.1.0.gem.
+jekyll_quote (0.1.0) installed.
+```
+
+Examine the newly built gem:
+```shell
+$ gem info jekyll_quote
+
+*** LOCAL GEMS ***
+
+jekyll_quote (0.1.0)
+    Author: Mike Slinn
+    Homepage:
+    https://github.com/mslinn/jekyll_quote
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    Generates Jekyll logger with colored output.
+```
+
+### Testing
+Examine the output by running:
+```shell
+$ demo/_bin/debug -r
+```
+... and pointing your web browser to http://localhost:4444/
+
+### Unit Tests
+Either run `rspec` from Visual Studio Code's *Run and Debug* environment
+(<kbd>Ctrl</kbd>-<kbd>shift</kbd>-<kbd>D</kbd>) and view the *Debug Console* output,
+or run it from the command line:
+```shell
+$ rspec
+```
+
+### 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,7 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/jekyll_quote.gemspec

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'lib/jekyll_quote/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  github = 'https://github.com/mslinn/jekyll_quote'
+
+  spec.bindir = 'exe'
+  spec.authors = ['Mike Slinn']
+  spec.email = ['mslinn@mslinn.com']
+  spec.files = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.homepage = 'https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#quote'
+  spec.license = 'MIT'
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{github}/issues",
+    'changelog_uri'     => "#{github}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => github,
+  }
+  spec.name = 'jekyll_quote'
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  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 = 'Provides a Jekyll filter that creates formatted quotes.'
+  spec.test_files = spec.files.grep %r{^(test|spec|features)/}
+  spec.version = JekyllQuoteVersion::VERSION
+
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+
+  spec.add_development_dependency 'debase'
+  spec.add_development_dependency 'jekyll_plugin_support'
+  spec.add_development_dependency 'rspec-match_ignoring_whitespace'
+  spec.add_development_dependency 'rubocop'
+  # spec.add_development_dependency 'rubocop-jekyll'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'ruby-debug-ide'
+end
+# rubocop:enable Metrics/BlockLength

data/lib/jekyll_quote/version.rb

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

data/lib/jekyll_quote.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'jekyll_plugin_support'
+require 'jekyll_plugin_support_helper'
+require_relative 'jekyll_quote/version'
+
+# @author Copyright 2022 Michael Slinn
+# @license SPDX-License-Identifier: Apache-2.0
+
+module QuoteModule
+  PLUGIN_NAME = 'quote'
+end
+
+module Jekyll
+  # Usage: {% quote [break] [by] [cite='Joe Blow'] [noprep] [url='https://blabla.com'] %}Bla bla.{% endquote %}
+  # Output looks like:
+  # <div class='quote'>
+  #   Bla bla.
+  #   <br><br> <span style='font-style:normal;'>&nbsp;&ndash; From Source cite.</span>
+  # </div>
+  class Quote < JekyllSupport::JekyllBlock
+    attr_accessor :cite, :url
+
+    def render_impl(text)
+      @break  = @helper.parameter_specified? 'break' # enforced by CSS if a list ends the body
+      @by     = @helper.parameter_specified? 'by'
+      @cite   = @helper.parameter_specified? 'cite'
+      @noprep = @helper.parameter_specified? 'noprep'
+      @url    = @helper.parameter_specified? 'url'
+
+      preposition = 'From'
+      preposition = 'By' if @by
+      preposition = '' if @noprep
+      if @cite
+        attribution = if @url && !@url.empty?
+                        "<a href='#{@url}' rel='nofollow' target='_blank'>#{@cite}</a>"
+                      else
+                        "#{@cite}\n"
+                      end
+        tag = @break ? 'div' : 'span'
+        attribution = "<#{tag} style='font-style:normal;'> &nbsp;&ndash; #{preposition} #{attribution}</#{tag}>\n"
+        text = "<div>#{text}</div>" if @break
+      end
+      <<~END_HERE
+        <div class='quote'>
+          #{text}#{attribution}
+        </div>
+      END_HERE
+    end
+  end
+end
+
+PluginMetaLogger.instance.info { "Loaded #{QuoteModule::PLUGIN_NAME} v0.1.0 plugin." }
+Liquid::Template.register_tag(QuoteModule::PLUGIN_NAME, Jekyll::Quote)

data/spec/jekyll_quote_spec.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'rspec/match_ignoring_whitespace'
+require_relative '../lib/jekyll_quote'
+
+Registers = Struct.new(:page, :site)
+
+# Mock for Collections
+class Collections
+  def values
+    []
+  end
+end
+
+# Mock for Site
+class SiteMock
+  attr_reader :config
+
+  def collections
+    Collections.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' => 'https://feeds.soundcloud.com/users/soundcloud:users:7143896/sounds.rss' },
+      SiteMock.new
+    )
+  end
+end
+
+# These tests all fail because I have not figured out how to provide a Jekyll block body to a test
+class MyTest
+  RSpec.describe Jekyll::Quote do # rubocop:disable Metrics/BlockLength
+    let(:logger) do
+      PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+    end
+
+    let(:parse_context) { TestParseContext.new }
+
+    let(:helper) do
+      JekyllPluginHelper.new(
+        'quote',
+        'This is a quote.',
+        logger
+      )
+    end
+
+    it 'has no cite or url' do
+      helper.reinitialize('Quote has no cite or url.')
+      quote = Jekyll::Quote.send(
+        :new,
+        'quote',
+        helper.markup.dup,
+        parse_context
+      )
+      result = quote.send(:render_impl, helper.markup)
+      expect(result).to match_ignoring_whitespace <<-END_RESULT
+        <div class='quote'>
+          Quote has no cite or url.
+        </div>
+      END_RESULT
+    end
+
+    it 'has a cite but no url' do
+      helper.reinitialize("cite='This is a citation' The quote has a cite but no url.")
+      quote = Jekyll::Quote.send(
+        :new,
+        'quote',
+        helper.markup.dup,
+        parse_context
+      )
+      result = quote.send(:render_impl, helper.markup)
+      expect(result).to match_ignoring_whitespace <<-END_RESULT
+        <div class='quote'>
+          This is the quoted text.
+          <br><br>
+          <span style='font-style:normal;'> &nbsp;&ndash; From This is a citation </span>
+        </div>
+      END_RESULT
+    end
+
+    it 'has a url but no cite' do
+      helper.reinitialize("url='https://blah.com' The quote has a url but no cite.")
+      quote = Jekyll::Quote.send(
+        :new,
+        'quote',
+        helper.markup.dup,
+        parse_context
+      )
+      result = quote.send(:render_impl, helper.markup)
+      expect(result).to match_ignoring_whitespace <<-END_RESULT
+        <div class='quote'>
+        The quote has a url but no cite.
+        </div>
+      END_RESULT
+    end
+
+    it 'has a cite and a url' do
+      helper.reinitialize "cite='This is a citation' url='https://blah.com' The quote has a url and a cite.".dup
+      quote = Jekyll::Quote.send(
+        :new,
+        'quote',
+        helper.markup.dup,
+        parse_context
+      )
+      result = quote.send(:render_impl, helper.markup)
+      expect(result).to match_ignoring_whitespace <<-END_RESULT
+        <div class='quote'>
+        The quote has a url but no cite.
+          <br><br>
+          <span style='font-style:normal;'> &nbsp;&ndash; From
+            <a href='https://blah.com' rel='nofollow' target='_blank'>This is a citation.</a>
+          </span>
+        </div>
+      END_RESULT
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require_relative '../lib/jekyll_quote'
+
+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'
+end

data/spec/status_persistence.txt

@@ -0,0 +1,6 @@
+example_id                       | status | run_time        |
+-------------------------------- | ------ | --------------- |
+./spec/jekyll_quote_spec.rb[1:1] | failed | 0.01849 seconds |
+./spec/jekyll_quote_spec.rb[1:2] | failed | 0.00035 seconds |
+./spec/jekyll_quote_spec.rb[1:3] | failed | 0.00018 seconds |
+./spec/jekyll_quote_spec.rb[1:4] | failed | 0.00009 seconds |

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_quote
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-12 00:00:00.000000000 Z
+dependencies:
+- !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: debase
+  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: jekyll_plugin_support
+  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-match_ignoring_whitespace
+  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: rubocop
+  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: rubocop-rake
+  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: rubocop-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: ruby-debug-ide
+  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:
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_quote.gemspec
+- lib/jekyll_quote.rb
+- lib/jekyll_quote/version.rb
+- spec/jekyll_quote_spec.rb
+- spec/spec_helper.rb
+- spec/status_persistence.txt
+homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#quote
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_quote/issues
+  changelog_uri: https://github.com/mslinn/jekyll_quote/CHANGELOG.md
+  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#quote
+  source_code_uri: https://github.com/mslinn/jekyll_quote
+post_install_message: |2+
+
+  Thanks for installing jekyll_quote!
+
+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: Provides a Jekyll filter that creates formatted quotes.
+test_files:
+- spec/jekyll_quote_spec.rb
+- spec/spec_helper.rb
+- spec/status_persistence.txt
+...