jekyll_time_since 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 49deda1c8fd804d1f221b26b8b2770a136681c4fdd0d295e5d33207e2f649184
+  data.tar.gz: f63928489b58a6e4add3eb192f76b89e26699808ec3bcb0786563fb90fa24a96
+SHA512:
+  metadata.gz: e3b7381753f3c08e6c0b031de19612e5c0d000ccc4223f3a34dff7fe4e469ad42ffc1f28a7121f8daf8f28252a2a4dd1758142e2ae80a7be45b4a0876fc253b1
+  data.tar.gz: e33a448a3d7c99e6508e16443073b237c03a207951cc8374b72e7cd8973a7190b77076a3eeeb79bbee665c00884d7285c28c9fa77ae35f15daea348e8ad9d15f

data/.rubocop.yml

@@ -0,0 +1,20 @@
+require: rubocop-jekyll
+inherit_gem:
+ rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+      - '*.gemspec' # This does nothing. Why?
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 150
+
+# Gemspec/RequireMFA:
+#   Enabled: false
+
+Jekyll/NoPutsAllowed:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0 / 2022-04-05
+  * Initial version published

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 COPYRIGHT_OWNER
+
+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,140 @@
+`jekyll_time_since`
+[![Gem Version](https://badge.fury.io/rb/jekyll_time_since.svg)](https://badge.fury.io/rb/jekyll_time_since)
+===========
+
+`jekyll_time_since` is a Jekyll plugin that provides new Liquid tags called
+`years_since`, `months_since`, `days_since`, `hours_since`, `minutes_since` and `seconds_since`.
+The plugin is packaged as a Ruby gem.
+
+
+## Additional Information
+More information is available on Mike Slinn's web site about
+[Jekyll plugins](https://www.mslinn.com/blog/index.html#Jekyll).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_time_since'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_time_since
+
+
+## Usage
+
+These tags all work in a similar manner; they accept one parameter,
+which is either a date string (`YYYY-MM-dd`) or an
+[ISO 8601-1:2019](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) datetime string (`YYYY-MM-ddThh:mm`).
+Just a year can be specified, which implies Jan 1 at midnight.
+
+The date and time strings can be surrounded with quotes, double quotes, or not.
+Time zone can be omitted, or specified as GMT, Z, or +/- HHMM.
+
+```
+{% "1959" | years_since  %} {% '1959' | years_since %}
+{% "1959-02-03" | years_since %} {% '1959-02-03' | years_since %}
+{% "1959-02-03T01:02" | years_since %} {% '1959-02-03T01:02' | years_since %}
+{% "1959-02-03T01:02:00Z" | years_since %} {% "1959-02-03T01:02:00-0400" | years_since %}
+
+{% "1959" | months_since %} {% months_since '1959' %}
+{% "1959-02-03" months_since %} {% '1959-02-03' | months_since %}
+{% "1959-02-03T01:02" | months_since %} {% '1959-02-03T01:02' | months_since %}
+{% "1959-02-03T01:02:00Z" | months_since %} {% "1959-02-03T01:02:00-0400" | months_since %}
+
+{% "1959" | weeks_since %} {% '1959' | weeks_since %}
+{% "1959-02-03" | weeks_since %} {% '1959-02-03' | weeks_since %}
+{% "1959-02-03T01:02" | weeks_since %} {% '1959-02-03T01:02' | weeks_since %}
+{% "1959-02-03T01:02:00Z" | weeks_since %} {% "1959-02-03T01:02:00-0400" | weeks_since %}
+
+{% "1959" | days_since %} {% '1959' | days_since %}
+{% "1959-02-03" | days_since %} {% '1959-02-03' | days_since %}
+{% "1959-02-03T01:02" | days_since %} {% '1959-02-03T01:02' | days_since %}
+{% "1959-02-03T01:02:00Z" | days_since %} {% "1959-02-03T01:02:00-0400" | days_since %}
+
+{% "1959" | hours_since%} {% '1959' | hours_since %}
+{% "1959-02-03" | hours_since %} {% '1959-02-03' | hours_since %}
+{% "1959-02-03T01:02" | hours_since %} {% '1959-02-03T01:02' | hours_since %}
+{% "1959-02-03T01:02:00Z" | hours_since %} {% "1959-02-03T01:02:00-0400" | hours_since %}
+
+{% "1959" | minutes_since %} {% '1959' | minutes_since %}
+{% "1959-02-03" | minutes_since %} {% '1959-02-03' | minutes_since %}
+{% "1959-02-03T01:02" | minutes_since %} {% '1959-02-03T01:02' | minutes_since %}
+{% "1959-02-03T01:02:00Z" | minutes_since %} {% "1959-02-03T01:02:00-0400" | minutes_since %}
+
+{% "1959" | seconds_since %} {% '1959' | seconds_since %}
+{% "1959-02-03" | seconds_since %} {% '1959-02-03' | seconds_since %}
+{% "1959-02-03T01:02" | seconds_since %} {% '1959-02-03T01:02' | seconds_since %}
+{% seconds_since "1959-02-03T01:02:00" %} {% seconds_since '1959-02-03T01:02:00' %}
+```
+
+
+## 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.
+
+
+### Build and Install Locally
+To build and install this gem onto your local machine, run:
+```shell
+$ rake install:local
+```
+
+The following also does the same thing:
+```shell
+$ bundle exec rake install
+jekyll_time_since 0.1.0 built to pkg/jekyll_time_since-0.1.0.gem.
+jekyll_time_since (0.1.0) installed.
+```
+
+Examine the newly built gem:
+```shell
+$ gem info jekyll_time_since
+
+*** LOCAL GEMS ***
+
+jekyll_time_since (0.1.0)
+    Author: Michael Slinn
+    Homepage: https://github.com/mslinn/jekyll_time_since
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    A Jekyll plugin that provides new Liquid tags called years_since, months_since, days_since, hours_since, minutes_since and seconds_since.
+```
+
+
+### 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_time_since.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll_time_since/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  github = "https://github.com/mslinn/jekyll_time_since"
+
+  spec.authors = ["Michael Slinn"]
+  spec.bindir = "exe"
+  spec.description = <<~END_OF_DESC
+  jekyll_time_since is a Jekyll plugin that provides new Liquid tags called years_since, months_since, days_since, hours_since, minutes_since and seconds_since.
+  END_OF_DESC
+  spec.email = ["email@email.com"]
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir[".rubocop.yml", "LICENSE.*", "Rakefile", "{lib,spec}/**/*", "*.gemspec", "*.md"]
+
+  spec.homepage = "https://www.mslinn.com/blog/2020/12/30/jekyll-plugin-template-collection.html"
+  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_time_since"
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = "jekyll_time_since is a Jekyll plugin that provides new Liquid tags called years_since, months_since, days_since, hours_since, minutes_since and seconds_since."
+  spec.version = JekyllTimeSinceVersion::VERSION
+
+  spec.add_dependency "jekyll", ">= 3.5.0"
+  spec.add_dependency "jekyll_plugin_logger"
+  spec.add_dependency "key-value-parser"
+  spec.add_dependency "git"
+  spec.add_dependency "os"
+  spec.add_dependency "shellwords"
+  spec.add_dependency "tty-prompt"
+
+  spec.add_development_dependency "debase"
+  # 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_time_since/version.rb

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

data/lib/jekyll_time_since.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "jekyll_plugin_logger"
+require "time"
+require_relative "jekyll_time_since/version"
+
+module JekyllTimeSinceName
+  PLUGIN_NAME = "block_tag_template"
+end
+
+# These tags all work in a similar manner; they accept one parameter,
+# which is either a date string (`YYYY-MM-dd`) or an
+# [ISO 8601-1:2019](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) datetime string (`YYYY-MM-ddThh:mm`).
+# Just a year can be specified, which implies Jan 1 at midnight.
+# You can specify a time zone
+# For more information, see https://ruby-doc.org/stdlib-2.7.2/libdoc/time/rdoc/Time.html
+#
+# The date and time strings can be surrounded with quotes, double quotes, or not.
+# The following examples compute elapsed time since "the day the music died" (1959-02-03).
+# See https://en.wikipedia.org/wiki/The_Day_the_Music_Died
+#
+# @example years_since
+#   Computes years since the date specified
+#   {% "1959" | years_since  %} {% '1959' | years_since %}
+#   {% "1959-02-03" | years_since %} {% '1959-02-03' | years_since %}
+#   {% "1959-02-03T01:02:00" | years_since %} {% '1959-02-03T01:02:00' | years_since %}
+#   {% "1959-02-03T01:02:00Z" | years_since %} {% "1959-02-03T01:02:00-0400" | years_since %}
+#
+# @example months_since
+#   Computes months since the date specified
+#   {% "1959" | months_since %} {% months_since '1959' %}
+#   {% "1959-02-03" months_since %} {% '1959-02-03' | months_since %}
+#   {% "1959-02-03T01:02" | months_since %} {% '1959-02-03T01:02' | months_since %}
+#   {% "1959-02-03T01:02:00Z" | months_since %} {% "1959-02-03T01:02:00-0400" | months_since %}
+#
+# @example weeks_since
+#   Computes weeks since the date specified
+#   {% "1959" | weeks_since %} {% '1959' | weeks_since %}
+#   {% "1959-02-03" | weeks_since %} {% '1959-02-03' | weeks_since %}
+#   {% "1959-02-03T01:02:00" | weeks_since %} {% '1959-02-03T01:02:00' | weeks_since %}
+#   {% "1959-02-03T01:02:00Z" | weeks_since %} {% "1959-02-03T01:02:00-0400" | weeks_since %}
+#
+# @example days_since
+#   Computes days since the date specified
+#   {% "1959" | days_since %} {% '1959' | days_since %}
+#   {% "1959-02-03" | days_since %} {% '1959-02-03' | days_since %}
+#   {% "1959-02-03T01:02" | days_since %} {% '1959-02-03T01:02' | days_since %}
+#   {% "1959-02-03T01:02:00Z" | days_since %} {% "1959-02-03T01:02:00-0400" | days_since %}
+#
+# @example hours_since
+#   Computes hours since the date and time specified
+#   {% "1959" | hours_since%} {% '1959' | hours_since %}
+#   {% "1959-02-03" | hours_since %} {% '1959-02-03' | hours_since %}
+#   {% "1959-02-03T01:02" | hours_since %} {% '1959-02-03T01:02' | hours_since %}
+#   {% "1959-02-03T01:02:00Z" | hours_since %} {% "1959-02-03T01:02:00-0400" | hours_since %}
+#
+# @example minutes_since
+#   Computes minutes since the date and time specified
+#   {% "1959" | minutes_since %} {% '1959' | minutes_since %}
+#   {% "1959-02-03" | minutes_since %} {% '1959-02-03' | minutes_since %}
+#   {% "1959-02-03T01:02" | minutes_since %} {% '1959-02-03T01:02' | minutes_since %}
+#   {% "1959-02-03T01:02:00Z" | minutes_since %} {% "1959-02-03T01:02:00-0400" | minutes_since %}
+#
+# @example seconds_since
+#   Computes seconds since the date and time specified
+#   {% "1959" | seconds_since %} {% '1959' | seconds_since %}
+#   {% "1959-02-03" | seconds_since %} {% '1959-02-03' | seconds_since %}
+#   {% "1959-02-03T01:02" | seconds_since %} {% '1959-02-03T01:02' | seconds_since %}
+#   {% seconds_since "1959-02-03T01:02:00" %} {% seconds_since '1959-02-03T01:02:00' %}
+
+module TimeSince
+  @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+
+  # Filters a string containing a year, date or ISO_8601 datetime.
+  # @return [integer] the number of years since the input.
+  def years_since(string)
+    now = DateTime.now
+    string += "-01-01" unless string.include?("-")
+    date = Time.parse(string)
+    years = now.year - date.year
+    years -= 1 if date.month > now.month || (date.month >= now.month && date.day > now.day)
+    years
+  end
+
+  def months_since(string)
+    string += "-01-01" unless string.include?("-")
+    date1 = Date.parse(string)
+
+    date2 = Time.new.to_date
+    ((date2 - date1).to_f / 365 * 12).round
+  end
+
+  def days_since(string)
+    hours_since(string) / 24
+  end
+
+  def hours_since(string)
+    minutes_since(string) / 60
+  end
+
+  def minutes_since(string)
+    seconds_since(string) / 60
+  end
+
+  def seconds_since(string)
+    (Time.new - Time.parse(string)).to_i
+  end
+end
+
+PluginMetaLogger.instance.info { "Loaded #{JekyllTimeSinceName::PLUGIN_NAME} v#{JekyllTimeSinceVersion::VERSION} plugin." }
+Liquid::Template.register_tag(JekyllTimeSinceName::PLUGIN_NAME, Jekyll::TimeSince)

data/spec/jekyll_time_since_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "../lib/jekyll_time_since"
+
+RSpec.describe(TimeSince) do
+  it "Computes years" do
+    #
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "fileutils"
+require "key_value_parser"
+require "shellwords"
+
+require_relative "../lib/jekyll_time_since"
+
+Jekyll.logger.log_level = :info
+
+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

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_time_since
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Slinn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-04-06 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: jekyll_plugin_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: key-value-parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shellwords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: 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: 'jekyll_time_since is a Jekyll plugin that provides new Liquid tags called
+  years_since, months_since, days_since, hours_since, minutes_since and seconds_since.
+
+'
+email:
+- email@email.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_time_since.gemspec
+- lib/jekyll_time_since.rb
+- lib/jekyll_time_since/version.rb
+- spec/jekyll_time_since_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.mslinn.com/blog/2020/12/30/jekyll-plugin-template-collection.html
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_time_since/issues
+  changelog_uri: https://github.com/mslinn/jekyll_time_since/CHANGELOG.md
+  homepage_uri: https://www.mslinn.com/blog/2020/12/30/jekyll-plugin-template-collection.html
+  source_code_uri: https://github.com/mslinn/jekyll_time_since
+post_install_message: 
+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.1.4
+signing_key: 
+specification_version: 4
+summary: jekyll_time_since is a Jekyll plugin that provides new Liquid tags called
+  years_since, months_since, days_since, hours_since, minutes_since and seconds_since.
+test_files: []