jekyll_quote 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: afc4a37f219d4ecfd2f919358ec53917d0264722ce1160aecf78613317aad1a7
-  data.tar.gz: 140b6715538149403c372cc505b7613e9270c39c04989a6cef854759d9a9edf2
+  metadata.gz: 48d683c6d402cbef996297da7355523a5708c131fc77acd797558861e83dba61
+  data.tar.gz: 4f0ce53ce3c39b2161d294b311ec6ea9f740a588dcc943fce0a188fecf5e82a9
 SHA512:
-  metadata.gz: f1052d61f7381c8019d1546379186fc657b082fec78518a366ee52d0a2652bec938100460ca087a66cd795caaa1caa30f3c8383bfa8a131c8af391c869fccaf6
-  data.tar.gz: d37915827d86536e05a0277cb157c76b67ca4fd7e6501778f6efd57620a308eff071efa08d9fb384c6421ebab248ec31d536d038168f99366ba3457bf2c54b66
+  metadata.gz: 915baf97a1e221eededdaf5cbcc6c37b60f404250b58c33915c6d2f3a01f527c1566fceabb547c2ee349b9b447e9f3fade4766ae047d5afb294958c4f671df2a
+  data.tar.gz: 45ddb8790cc6f9c85598e13e041036a8cbdaf14621f6fade55cea544d24db83c6d98b39f56484951d418798840995a80bab351420b965da1ffa3073c642d1ec8

data/.rubocop.yml

@@ -28,8 +28,7 @@ Layout/InitialIndentation:
 
 Layout/HashAlignment:
   EnforcedColonStyle: table
-  Exclude:
-    - jekyll_quote.gemspec
+  EnforcedHashRocketStyle: table
 
 Layout/LineLength:
   Max: 150
@@ -41,6 +40,9 @@ Lint/RedundantCopDisableDirective:
   Exclude:
     - jekyll_quote.gemspec
 
+Metrics/AbcSize:
+  Max: 25
+
 Metrics/BlockLength:
   Exclude:
     - jekyll_quote.gemspec

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 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).
+
 ## 0.3.1 / 2023-03-15
   * Added CSS class: `clearfix`
 

data/README.md

@@ -8,8 +8,7 @@ See [demo/index.html](demo/index.html) for examples.
 
 
 ## Installation
-
-Add this line to your Jekyll project's Gemfile, within the `jekyll_plugins` group:
+Add the following line to your Jekyll project's Gemfile, within the `jekyll_plugins` group:
 
 ```ruby
 group :jekyll_plugins do
@@ -17,20 +16,54 @@ group :jekyll_plugins do
 end
 ```
 
-Also add it to `_config.yml`:
-```yaml
-plugins:
-  - jekyll_quote
+And then execute:
+
+    $ bundle
+
+
+## Syntax
+```
+{% 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
 
-Or install it yourself as:
+## Usage Example
+```
+{% 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)
 
-    $ gem install jekyll_quote
 
+## 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:
+```
+$ demo/_bin/debug -r
+```
 
 ## Additional Information
 More information is available on
@@ -66,7 +99,7 @@ jekyll_quote (0.1.0)
     Generates Jekyll logger with colored output.
 ```
 
-### Testing
+### Demo
 Examine the output by running:
 ```shell
 $ demo/_bin/debug -r

data/jekyll_quote.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   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.homepage = 'https://www.mslinn.com/jekyll_plugins/jekyll_quote.html'
   spec.license = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
@@ -29,5 +29,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.5.1'
+  spec.add_dependency 'jekyll_plugin_support', '>= 0.7.0'
 end

data/lib/jekyll_quote/version.rb

@@ -1,3 +1,3 @@
 module JekyllQuoteVersion
-  VERSION = '0.3.1'.freeze
+  VERSION = '0.4.1'.freeze
 end

data/lib/jekyll_quote.rb

@@ -1,5 +1,5 @@
 require 'jekyll_plugin_support'
-require 'jekyll_plugin_support_helper'
+require 'jekyll_plugin_helper'
 require_relative 'jekyll_quote/version'
 
 # @author Copyright 2022 Michael Slinn
@@ -22,28 +22,38 @@ module Jekyll
     include JekyllQuoteVersion
 
     def render_impl(text)
+      @helper.gem_file __FILE__ # This enables plugin attribution
+
       @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
-        attribution = if @url && !@url.empty?
+        cite_markup = if @url && !@url.empty?
                         "<a href='#{@url}' rel='nofollow' target='_blank'>#{@cite}</a>"
                       else
                         "#{@cite}\n"
                       end
         tag = @break ? 'div' : 'span'
-        attribution = "<#{tag} class='quoteAttribution'> &nbsp;&ndash; #{preposition} #{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}#{attribution}
+        <div class='#{klass}quote'#{styling}>
+          #{@text}#{@cite_markup}
+          #{@helper.attribute if @helper.attribution}
         </div>
       END_HERE
     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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_quote
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-06-19 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.5.1
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.7.0
 description:
 email:
 - mslinn@mslinn.com
@@ -55,14 +55,15 @@ files:
 - lib/jekyll_quote/version.rb
 - spec/jekyll_quote_spec.rb
 - spec/spec_helper.rb
-homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#quote
+- spec/status_persistence.txt
+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/blog/2020/10/03/jekyll-plugins.html#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+
 
@@ -89,4 +90,5 @@ summary: Provides a Jekyll filter that creates formatted quotes.
 test_files:
 - spec/jekyll_quote_spec.rb
 - spec/spec_helper.rb
+- spec/status_persistence.txt
 ...