jekyll_quote 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cbfed4188300ddb73dc023ece7c80e583d1fd9ed0f75e48304d64196441f7c5
-  data.tar.gz: e907bb7aa7569a6bb54e96f581b7380391ae70949bf33f58fb5934b844fc3d39
+  metadata.gz: 410dc88a139c0b1b0769b3896a644e6276f20a45ced9864a01d7f8f540a8e567
+  data.tar.gz: 79f5d5b5963ad4f062d3fe8bd772698749025388f72f2672133fba63b83fadbd
 SHA512:
-  metadata.gz: 25679145652ff7d0aab9278339ae235c6b4dcaaf50efc887999dfd3c9f58f9fa9043705a87e604a9bb38d6f1f56e19a47ad7dd180bdaa48275c64a7b78472b27
-  data.tar.gz: 25870ef2184b6faa36355909288b7e1ae1c7fb0a5df71860f494f6b32d025b70477c5ea1808283f313ab6f03b8e0bdef0476c28d54904eb61afe7d79dc4bbdc9
+  metadata.gz: 4f3ede950a0fbfefcf9c2731948cd1a3a6b58935ad9cab8b47824a8bfeb4e97d58350c00a61ff52c2bf4ef0f4c2d8df456872015e572a02a94e59f8fbd5f2993
+  data.tar.gz: e8449f5ea4015b67cd5726b18fb8675ec3fa21901cf6fcb661de1c4bd1c2acc0d092ce06ef13360a21bc49e264b14a54e53a8f3e5a86ad9a1e2c9167727281e0

data/.rubocop.yml

@@ -1,27 +1,103 @@
+require:
+  # - rubocop-jekyll
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
   Exclude:
-      - vendor/**/*
-      - exe/**/*
-      - Gemfile*
-      - Rakefile
-      - '*.gemspec'
+    - demo/_site/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+    - Rakefile
+    - jekyll_quote.gemspec
   NewCops: enable
   TargetRubyVersion: 2.6
 
-Layout/HashAlignment:
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
   Enabled: false
 
+Layout/InitialIndentation:
+  Exclude:
+    - README.md
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
 Layout/LineLength:
   Max: 150
 
-Metrics/MethodLength:
-  Max: 30
-
 Layout/MultilineMethodCallIndentation:
   Enabled: false
 
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - jekyll_quote.gemspec
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/BlockLength:
+  Exclude:
+    - jekyll_quote.gemspec
+    - spec/**/*
+
+Metrics/ClassLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/MethodLength:
+  Max: 30
+
 Metrics/CyclomaticComplexity:
   Max: 10
 
 Metrics/PerceivedComplexity:
   Max: 10
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Max: 15
+
+Style/CommandLiteral:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringConcatenation:
+  Exclude:
+    - spec/**/*
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -1,8 +1,14 @@
-## 0.1.0 / 2023-01-12
-  * Initial version
+## 0.4.0 / 2023-04-05
+  * Added [`attribution` support](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution).
 
-## 0.2.0 / 2023-01-14
-  * Added options: `break`, `by`, and `noprep`
+## 0.3.1 / 2023-03-15
+  * Added CSS class: `clearfix`
 
 ## 0.3.0 / 2023-01-14
   * Added CSS classes: `quoteAttribution` and `quoteText`
+
+## 0.2.0 / 2023-01-14
+  * Added options: `break`, `by`, and `noprep`
+
+## 0.1.0 / 2023-01-12
+  * Initial version

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,19 +16,13 @@ group :jekyll_plugins do
 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
+## Attribution
+See [`jekyll_plugin_support` for `attribution`](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution)
 
 
 ## Additional Information
@@ -66,7 +59,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/Rakefile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/jekyll_quote.gemspec

@@ -1,16 +1,13 @@
-# frozen_string_literal: true
-
 require_relative 'lib/jekyll_quote/version'
 
-# rubocop:disable Metrics/BlockLength
-Gem::Specification.new do |spec|
+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/blog/2020/10/03/jekyll-plugins.html#quote'
+  spec.homepage = 'https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#jekyll_quote'
   spec.license = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
@@ -32,14 +29,5 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_dependency 'jekyll_plugin_support', '~> 0.6.0'
 end
-# rubocop:enable Metrics/BlockLength

data/lib/jekyll_quote/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module JekyllQuoteVersion
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'.freeze
 end

data/lib/jekyll_quote.rb

@@ -1,14 +1,12 @@
-# frozen_string_literal: true
-
 require 'jekyll_plugin_support'
-require 'jekyll_plugin_support_helper'
+require 'jekyll_plugin_helper'
 require_relative 'jekyll_quote/version'
 
 # @author Copyright 2022 Michael Slinn
 # @license SPDX-License-Identifier: Apache-2.0
 
 module QuoteModule
-  PLUGIN_NAME = 'quote'
+  PLUGIN_NAME = 'quote'.freeze
 end
 
 module Jekyll
@@ -21,7 +19,11 @@ module Jekyll
   class Quote < JekyllSupport::JekyllBlock
     attr_accessor :cite, :url
 
+    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'
@@ -32,23 +34,23 @@ module Jekyll
       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
+        quote_attribution = 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'>#{text}</div>" if @break
+        quote_attribution = "<#{tag} class='quoteAttribution'> &nbsp;&ndash; #{preposition} #{quote_attribution}</#{tag}>\n"
+        text = "<div class='quoteText clearfix'>#{text}</div>" if @break
       end
       <<~END_HERE
         <div class='quote'>
-          #{text}#{attribution}
+          #{text}#{quote_attribution}
+          #{@helper.attribute if @helper.attribution}
         </div>
       END_HERE
     end
+
+    JekyllPluginHelper.register(self, QuoteModule::PLUGIN_NAME)
   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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'jekyll'
 require 'jekyll_plugin_logger'
 require 'rspec/match_ignoring_whitespace'

data/spec/spec_helper.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'jekyll'
 require_relative '../lib/jekyll_quote'
 

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.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,104 +24,20 @@ dependencies:
     - - ">="
       - !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
+        version: 0.6.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
 description:
 email:
 - mslinn@mslinn.com
@@ -139,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/3000-jekyll-plugins.html#jekyll_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
+  homepage_uri: https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#jekyll_quote
   source_code_uri: https://github.com/mslinn/jekyll_quote
 post_install_message: |2+
 
@@ -173,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
 ...