jekyll_nth 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49d85c0259d029eef93fbefb103fd935ced149811c4c6b548b479e7d1e036fc6
-  data.tar.gz: 31377d3dca4d996e2d2ff6234c9696e2e9b6933439791dfd2e8d5bcd8dba6065
+  metadata.gz: 52bf7aefeec224b1fff7ed106464938f18518e1133e72eea98f26deedc51c7b7
+  data.tar.gz: 8249f5e86dd728269c1448b4a8a87377e39794a66578a9914f485e9716dfa471
 SHA512:
-  metadata.gz: 31e884aca763df03483c90d6c3bc79f89cb2f4cb14fae568bf7f17d257a01963d0dd59697a695e3652d444263502e2fa18d25c766c9008bab6f57a96fee6ed4e
-  data.tar.gz: '0115284e7827391b8863d064046162d1282fb7d3d49dce3b04f18095df99bb6ad07e148dabf1224d08aaabbb851ac1b58de8d238397208b21ff64413a77625bb'
+  metadata.gz: f41efdd5a3817c1cc5d656345089a7d2b450ba6b3c96640a253cb0ef60e2d156c4b9ab003f578b5588b17c1c191cc9f5706538e18d1e6ae1b3cd3f1002303ece
+  data.tar.gz: 02a41c070c868660d761df13d9b1c69f5de0ed653770e4af988e005dd56b80a0e4eb647a31ffe27177789c50b879f9b862f86bb8cad5c6f16d2d9bae317fe6ac

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.1.0 / 2022-04-27
+  * Added tail method
+
 ## 1.0.0 / 2022-03-16
   * Published as a gem
 

data/README.md

@@ -2,15 +2,26 @@
 [![Gem Version](https://badge.fury.io/rb/jekyll_nth.svg)](https://badge.fury.io/rb/jekyll_nth)
 ===========
 
-`jekyll_nth` is a Jekyll filter plugin that returns item n of array, origin 1.
+`jekyll_nth` provides two Jekyll filter plugin that manipulate arrays.
+
+  * `nth` returns item `n` of the array, origin 0.
+  * `tail` returns the remainder of the array after the first element.
 
 ## Usage
 
 ```
-{{ [1, 2, 3, 4, 5] | nth: 2 }}  # returns 2
+{{ [1, 2, 3, 4, 5] | nth: 2 }}  # returns 3
+{{ [1, 2, 3, 4, 5] | nth: -1 }} # returns 5
+{{ [1, 2, 3, 4, 5] | nth: 99 }} # throws exception
 ```
 :warning: Important: the name of the filter must be followed by a colon (:). If you fail to do that an error will be generated and the Jekyll site building process will halt. The error message looks something like this: `Liquid Warning: Liquid syntax error (line 285): Expected end_of_string but found string in "{{ [1, 2, 3, 4, 5] | nth: '2' }}" in /some_directory/some_files.html Liquid Exception: Liquid error (line 285): wrong number of arguments (given 1, expected 2) in /some_directory/some_file.html Error: Liquid error (line 285): wrong number of arguments (given 1, expected 2)`
 
+```
+{{ [1, 2, 3, 4, 5] | tail }}  # returns [2, 3, 4, 5]
+{{ [1] | tail }}              # returns []
+{{ [] | tail }}               # throws exception
+```
+
 
 ## Installation
 

data/jekyll_nth.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.6.0"
   spec.summary = "Provides a Jekyll filter that enables access to the nth items of an array."
   spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
-  spec.version = JekyllNth::VERSION
+  spec.version = JekyllNthVersion::VERSION
 
   spec.add_dependency "jekyll", ">= 3.5.0"
   spec.add_dependency "jekyll_plugin_logger"

data/lib/jekyll_nth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-module JekyllNth
-  VERSION = "1.0.0"
+module JekyllNthVersion
+  VERSION = "1.1.0"
 end

data/lib/jekyll_nth.rb

@@ -8,15 +8,21 @@ module JekyllPluginNthName
   PLUGIN_NAME = "jekyll_nth"
 end
 
-module Jekyll
+module ArrayManipulation
   # @return nth item of an array, origin 1
   def nth(array, index)
-    abort "nth error: array was empty." if array.nil?
-    abort "nth error: array has only #{array.length} items, but item #{index} was requested." if array.length < index.abs
+    abort "jekyll_nth error: array passed to nth was empty." if array.nil? || array.empty?
+    abort "jekyll_nth error: array passed to nth has only #{array.length} items, but item #{index} was requested." if array.length < index.abs
 
     array[index]
   end
+
+  def tail(array)
+    abort "jekyll_nth error: array passed to tail was empty." if array.nil? || array.empty?
+
+    array[1..]
+  end
 end
 
-PluginMetaLogger.instance.info { "Loaded #{JekyllPluginNthName::PLUGIN_NAME} v#{JekyllNth::VERSION} plugin." }
-Liquid::Template.register_filter(Jekyll)
+PluginMetaLogger.instance.info { "Loaded #{JekyllPluginNthName::PLUGIN_NAME} v#{JekyllNthVersion::VERSION} plugin." }
+Liquid::Template.register_filter(ArrayManipulation)

data/spec/jekyll_nth_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "../lib/jekyll_nth"
+
+RSpec.describe(ArrayManipulation) do
+  include ArrayManipulation
+
+  let(:config) { instance_double("Configuration") }
+  let(:context) do
+    context_ = instance_double("Liquid::Context")
+    context_.config = config
+    context_
+  end
+
+  it "returns the usual Ruby value" do
+    array = [1, 2, 3, 4, 5]
+    expect(nth(array, -1)).to eq(5)
+    expect(nth(array, 0)).to eq(1)
+    expect(nth(array, 2)).to eq(3)
+    expect(nth(array, 99)).to raise_exception
+    expect(nth([], 1)).to raise_exception
+  end
+
+  it "returns normal tail" do
+    expect(tail([1, 2, 3, 4, 5])).to eq([2, 3, 4, 5])
+    expect(tail([1])).to eq([])
+    expect(tail([])).to raise_exception
+  end
+end

data/spec/spec_helper.rb

@@ -4,7 +4,10 @@ require "jekyll"
 require_relative "../lib/jekyll_nth"
 
 RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_nth
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mike Slinn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-25 00:00:00.000000000 Z
+date: 2022-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -84,7 +84,7 @@ files:
 - jekyll_nth.gemspec
 - lib/jekyll_nth.rb
 - lib/jekyll_nth/version.rb
-- spec/jekyll_nth.rb
+- spec/jekyll_nth_spec.rb
 - spec/spec_helper.rb
 homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#nth
 licenses:
@@ -118,5 +118,5 @@ signing_key:
 specification_version: 4
 summary: Provides a Jekyll filter that enables access to the nth items of an array.
 test_files:
-- spec/jekyll_nth.rb
+- spec/jekyll_nth_spec.rb
 - spec/spec_helper.rb

data/spec/jekyll_nth.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require "jekyll"
-require_relative "../lib/jekyll_nth"
-
-RSpec.describe(Jekyll) do
-  include Jekyll
-
-  let(:config) { instance_double("Configuration") }
-  let(:context) {
-    context_ = instance_double("Liquid::Context")
-    context_.config = config
-    context_
-  }
-
-  it "is created properly" do
-    run_tag = RunTag.new("run", "echo asdf")
-    output = run_tag.render(context)
-    expect(output).to eq("asdf")
-  end
-end