jekyll_quote 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 410dc88a139c0b1b0769b3896a644e6276f20a45ced9864a01d7f8f540a8e567
-  data.tar.gz: 79f5d5b5963ad4f062d3fe8bd772698749025388f72f2672133fba63b83fadbd
+  metadata.gz: a2cf31841215c9cee3ccc8ba48b6dc30ae02b4dc5153c3d9e5f45f1708dee814
+  data.tar.gz: ff907b1974e4c509aa9d0cf56a6b7fb9738c9d936cb350daa61d44cfcdd98a98
 SHA512:
-  metadata.gz: 4f3ede950a0fbfefcf9c2731948cd1a3a6b58935ad9cab8b47824a8bfeb4e97d58350c00a61ff52c2bf4ef0f4c2d8df456872015e572a02a94e59f8fbd5f2993
-  data.tar.gz: e8449f5ea4015b67cd5726b18fb8675ec3fa21901cf6fcb661de1c4bd1c2acc0d092ce06ef13360a21bc49e264b14a54e53a8f3e5a86ad9a1e2c9167727281e0
+  metadata.gz: 12ec759cf139fe8a89aaf89aca329c75657f120982e0b266b63291b746c79801b7f74f156904b3d1060d6554514aff72fb4addb74a60255025438287847d0430
+  data.tar.gz: cc6c73e9a901f50db47867b3fc50a3bf6ce580f8e3ea71db438a081c4e298d905e448f49ff6f92289b6cdd9d7d29dd907ee9af6619adad4a18a832b9380833b3

data/.rubocop.yml

@@ -8,17 +8,19 @@ require:
 AllCops:
   Exclude:
     - demo/_site/**/*
-    - exe/**/*
+    - binstub/**/*
     - vendor/**/*
     - Gemfile*
     - Rakefile
     - jekyll_quote.gemspec
   NewCops: enable
-  TargetRubyVersion: 2.6
 
 Gemspec/DeprecatedAttributeAssignment:
   Enabled: false
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Gemspec/RequireMFA:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,14 +1,35 @@
+# Change Log
+
+## 0.4.2 / 2024-04-27
+
+* Depends upon jekyll_plugin_support v0.8.5
+
+
+## 0.4.1 / 2023-06-09
+
+* Added `style` and `class` options.
+
+
 ## 0.4.0 / 2023-04-05
-  * Added [`attribution` support](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution).
+
+* Added [`attribution` support](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution).
+
 
 ## 0.3.1 / 2023-03-15
-  * Added CSS class: `clearfix`
+
+* Added CSS class: `clearfix`
+
 
 ## 0.3.0 / 2023-01-14
-  * Added CSS classes: `quoteAttribution` and `quoteText`
+
+* Added CSS classes: `quoteAttribution` and `quoteText`
+
 
 ## 0.2.0 / 2023-01-14
-  * Added options: `break`, `by`, and `noprep`
+
+* Added options: `break`, `by`, and `noprep`
+
 
 ## 0.1.0 / 2023-01-12
-  * Initial version
+
+* Initial version

data/README.md

@@ -1,6 +1,4 @@
-`jekyll_quote`
-[![Gem Version](https://badge.fury.io/rb/jekyll_quote.svg)](https://badge.fury.io/rb/jekyll_quote)
-===========
+# `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.
 
@@ -8,35 +6,89 @@ See [demo/index.html](demo/index.html) for examples.
 
 
 ## Installation
-Add the following line to your Jekyll project's Gemfile, within the `jekyll_plugins` group:
 
-```ruby
-group :jekyll_plugins do
-  gem 'jekyll_quote'
-end
+1. Add the following line to your Jekyll project's Gemfile, within the `jekyll_plugins` group:
+
+   ```ruby
+   group :jekyll_plugins do
+     gem 'jekyll_quote'
+   end
+   ```
+
+2. Install the `jekyll_quote` Ruby gem and mark it as a dependency of your project by typing:
+
+   ```shell
+   $ bundle
+   ```
+
+3. Copy the CSS classes from `demo/assets/css/jekyll_quote.css` to your Jekyll project's CSS file.
+
+
+## Syntax
+
+```html
+{% quote OPTIONS %}
+  Content of quote goes here.
+{% endquote %}
 ```
 
-And then execute:
+The default preposition is 'From'.
+
+OPTIONS are:
+
+* `break` – Put the citation on a separate line. Ignored if `cite` was not specified.
+* `by` – Preface the citation with the preposition 'By'. Ignored if `cite` was not specified.
+* `cite` – Citation text
+* `class` – Apply additional CSS classes
+* `noprep` – Do not preface the citation with a preposition. Ignored if `cite` was not specified.
+* `style` – Apply additional CSS styling
+* `url` – URL for the citation. Ignored if `cite` was not specified.
 
-    $ bundle install
+
+## Usage Example
+
+```html
+{% quote cite="Blaise Pascal, in Lettres provinciales"
+   url="https://en.wikipedia.org/wiki/Lettres_provinciales"
+%}
+  I have only made this letter longer because
+  I have not had the time to make it shorter.
+{% endquote %}
+```
 
 
 ## Attribution
+
 See [`jekyll_plugin_support` for `attribution`](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution)
 
 
+## Demo
+
+A demo / test website is provided in the `demo` directory.
+It can be used to debug the plugin or to run freely.
+Please examine the HTML files in the demo to see how the plugin works.
+
+To run the demo freely from the command line, type:
+
+```shell
+$ demo/_bin/debug -r
+```
+
 ## 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.
@@ -44,6 +96,7 @@ jekyll_quote (0.1.0) installed.
 ```
 
 Examine the newly built gem:
+
 ```shell
 $ gem info jekyll_quote
 
@@ -59,29 +112,41 @@ jekyll_quote (0.1.0)
     Generates Jekyll logger with colored output.
 ```
 
-### Demo
+
+### Running the Demo
+
 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).
 

data/jekyll_quote.gemspec

@@ -3,11 +3,10 @@ require_relative 'lib/jekyll_quote/version'
 Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   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/jekyll/3000-jekyll-plugins.html#jekyll_quote'
+  spec.homepage = 'https://www.mslinn.com/jekyll_plugins/jekyll_quote.html'
   spec.license = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
@@ -29,5 +28,5 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.version = JekyllQuoteVersion::VERSION
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
-  spec.add_dependency 'jekyll_plugin_support', '~> 0.6.0'
+  spec.add_dependency 'jekyll_plugin_support', '>= 0.8.5'
 end

data/lib/jekyll_quote/version.rb

@@ -1,3 +1,3 @@
 module JekyllQuoteVersion
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.4.2'.freeze
 end

data/lib/jekyll_quote.rb

@@ -1,5 +1,5 @@
 require 'jekyll_plugin_support'
-require 'jekyll_plugin_helper'
+require 'helper/jekyll_plugin_helper'
 require_relative 'jekyll_quote/version'
 
 # @author Copyright 2022 Michael Slinn
@@ -27,25 +27,32 @@ module Jekyll
       @break  = @helper.parameter_specified? 'break' # enforced by CSS if a list ends the body
       @by     = @helper.parameter_specified? 'by'
       @cite   = @helper.parameter_specified? 'cite'
+      @class  = @helper.parameter_specified? 'class'
       @noprep = @helper.parameter_specified? 'noprep'
+      @style  = @helper.parameter_specified? 'style'
       @url    = @helper.parameter_specified? 'url'
-
       preposition = 'From'
       preposition = 'By' if @by
       preposition = '' if @noprep
       if @cite
-        quote_attribution = if @url && !@url.empty?
-                              "<a href='#{@url}' rel='nofollow' target='_blank'>#{@cite}</a>"
-                            else
-                              "#{@cite}\n"
-                            end
+        cite_markup = if @url && !@url.empty?
+                        "<a href='#{@url}' rel='nofollow' target='_blank'>#{@cite}</a>"
+                      else
+                        "#{@cite}\n"
+                      end
         tag = @break ? 'div' : 'span'
-        quote_attribution = "<#{tag} class='quoteAttribution'> &nbsp;&ndash; #{preposition} #{quote_attribution}</#{tag}>\n"
-        text = "<div class='quoteText clearfix'>#{text}</div>" if @break
+        @cite_markup = "<#{tag} class='quoteAttribution'> &nbsp;&ndash; #{preposition} #{cite_markup}</#{tag}>\n"
       end
+      @text = @break ? "<div class='quoteText clearfix'>#{text}</div>" : text
+      output
+    end
+
+    def output
+      klass = "#{@class} " if @class
+      styling = " style='#{@style}'" if @style
       <<~END_HERE
-        <div class='quote'>
-          #{text}#{quote_attribution}
+        <div class='#{klass}quote'#{styling}>
+          #{@text}#{@cite_markup}
           #{@helper.attribute if @helper.attribution}
         </div>
       END_HERE

data/spec/jekyll_quote_spec.rb

@@ -38,7 +38,7 @@ 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
+  RSpec.describe Jekyll::Quote do
     let(:logger) do
       PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
     end
@@ -55,7 +55,7 @@ class MyTest
 
     it 'has no cite or url' do
       helper.reinitialize('Quote has no cite or url.')
-      quote = Jekyll::Quote.send(
+      quote = described_class.send(
         :new,
         'quote',
         helper.markup.dup,
@@ -71,7 +71,7 @@ class MyTest
 
     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(
+      quote = described_class.send(
         :new,
         'quote',
         helper.markup.dup,
@@ -89,7 +89,7 @@ class MyTest
 
     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(
+      quote = described_class.send(
         :new,
         'quote',
         helper.markup.dup,
@@ -104,8 +104,8 @@ class MyTest
     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(
+      helper.reinitialize "cite='This is a citation' url='https://blah.com' The quote has a url and a cite.".+
+      quote = described_class.send(
         :new,
         'quote',
         helper.markup.dup,

data/spec/spec_helper.rb

@@ -2,9 +2,8 @@ require 'jekyll'
 require_relative '../lib/jekyll_quote'
 
 RSpec.configure do |config|
-  config.filter_run :focus
+  config.filter_run_when_matching focus: true
   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'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_quote
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2023-04-13 00:00:00.000000000 Z
+date: 2024-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -28,16 +28,16 @@ dependencies:
   name: jekyll_plugin_support
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.8.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.8.5
 description:
 email:
 - mslinn@mslinn.com
@@ -55,15 +55,14 @@ files:
 - lib/jekyll_quote/version.rb
 - spec/jekyll_quote_spec.rb
 - spec/spec_helper.rb
-- spec/status_persistence.txt
-homepage: https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#jekyll_quote
+homepage: https://www.mslinn.com/jekyll_plugins/jekyll_quote.html
 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/jekyll/3000-jekyll-plugins.html#jekyll_quote
+  homepage_uri: https://www.mslinn.com/jekyll_plugins/jekyll_quote.html
   source_code_uri: https://github.com/mslinn/jekyll_quote
 post_install_message: |2+
 
@@ -90,5 +89,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
 ...

data/spec/status_persistence.txt

@@ -1,6 +0,0 @@
-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 |