jekyll_begin_end 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 777a1dfd0a686d88f77246edf2b1239393012bbd90891b98f5b5efdaf28d36bc
+  data.tar.gz: 89f839d3a222a55f9d821204fcecc7a4dc1e42c9db029ca0bddb5d03dec0788e
+SHA512:
+  metadata.gz: 65c59361becd2b4436d7aab8c8c006be52d1588c27e2a388436cf6b941d33e6c1dd81eeb8b83732f682b00188d57ff308fe6b045c7ed060ce5563ed1009803ef
+  data.tar.gz: b09eb2adb187174af0824dfc71d79fe786322c0a2f7a80568624041d8ea9a8566198ee003b2e7da4d2ee67732413c7026802a64609a6b696f916bf7fc29407d5

data/.rubocop.yml

@@ -0,0 +1,34 @@
+require: rubocop-jekyll
+inherit_gem:
+  rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 150
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 1.0.0 / 2022-03-14
+  * Made into a Ruby gem and published on RubyGems.org as [jekyll_begin_end](https://rubygems.org/gems/jekyll_begin_end).
+  * `bin/attach` script added for debugging
+  * Rubocop standards added
+  * Proper versioning and CHANGELOG.md added
+
+## 0.1.0 / 2020-12-29
+  * Initial version published

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mike Slinn
+
+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,195 @@
+`jekyll_begin_end`
+[![Gem Version](https://badge.fury.io/rb/jekyll_begin_end.svg)](https://badge.fury.io/rb/jekyll_begin_end)
+===========
+
+Defines the following Jekyll filters:
+
+ * `begins_with` — returns `true` if a string starts with a given substring.
+ * `does_not_begin_with` — returns `false` if a string starts with a given substring.
+ * `ends_with` — returns `true` if a string end with a given substring.
+ * `does_not_end_with` — returns `false` if a string end with a given substring.
+ * `append_suffix_if_does_not_start_with` — appends a suffix to the string if the string does not start with a substring.
+
+## Syntax
+
+:warning: Important: the name of each of these filters 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 "{{ lines | begins_with 'blah' | xml_escape }}" 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)`
+
+### `begins_with`
+First example:
+```
+{% assign url = "https:/asdf.com" %}
+{% assign isAbsolute = url | begins_with: 'http' %}
+```
+
+Second example:
+```
+{% assign url = "https:/asdf.com" %}
+{% if url | begins_with: 'http' %}
+  <p>Absolute</p>
+{% else %}
+  <p>Relative</p>
+{% endif %}
+```
+
+### `does_not_begin_with`
+First example:
+```
+{% assign url = "https:/asdf.com" %}
+{% assign isRelative = url | does_not_begin_with: 'http' %}
+```
+
+Second example
+```
+{% assign url = "https:/asdf.com" %}
+{% if url | does_not_begin_with: 'http' %}
+  <p>Relative</p>
+{% else %}
+  <p>Absolute</p>
+{% endif %}
+```
+
+### `ends_with`
+First example:
+```
+{% assign url = "https:/asdf.com" %}
+{% assign isDotCom = url | ends_with: '.com' %}
+```
+
+Second example:
+```
+{% assign url = "https:/asdf.com" %}
+{% if url | ends_with: '.com' %}
+  <p>.com found</p>
+{% else %}
+  <p>Not a .com</p>
+{% endif %}
+```
+
+### `does_not_end_with`
+First example:
+```
+{% assign url = "https:/asdf.com" %}
+{% assign isNotDotCom = url | does_not_end_with: '.com' %}
+```
+
+Second example:
+```
+{% assign url = "https:/asdf.com" %}
+{% if url | does_not_end_with: '.com' %}
+  <p>Not a .com</p>
+{% else %}
+  <p>.com found</p>
+{% endif %}
+```
+
+
+### `append_suffix_if_does_not_start_with`
+This filter was created to make asset reloading work better.
+
+Given a portion of `_layouts/default.html` that looks like this:
+```
+{% assign csses = page.css | default: layout.css %}
+{% assign nowMillis = site.time | date: '%s' %}
+{% assign suffix = '?v=' | append: nowMillis %}
+{% for css in csses %}
+  <link rel="stylesheet" href="{{ css | append_suffix_if_does_not_start_with: 'http', suffix }}" type="text/css">
+{% endfor %}
+```
+And given `index.html` with front matter that looks like this:
+```
+---
+css: [
+  https://cdnjs.cloudflare.com/ajax/libs/jquery-modal/0.9.1/jquery.modal.min.css,
+  /order/order.css
+]
+---
+```
+
+The following is generated. Note that the suffix s?v=1612879301 in only applied to the relative URL for `order.css`.
+```
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/jquery-modal/0.9.1/jquery.modal.min.css" type="text/css">
+<link rel="stylesheet" href="/order/order.css?v=1612879301" type="text/css">
+```
+
+
+### Additional Information
+More information is available on my web site about [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_begin_end'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_begin_end
+
+
+## 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
+```
+
+Examine the newly built gem:
+```shell
+$ gem info jekyll_begin_end
+
+*** LOCAL GEMS ***
+
+jekyll_begin_end (1.0.0)
+    Author: Mike Slinn
+    Homepage:
+    https://github.com/mslinn/jekyll_begin_end
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    Generates Jekyll logger with colored output.
+```
+
+
+### 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_begin_end.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll_begin_end/version"
+
+Gem::Specification.new do |spec|
+  github = "https://github.com/mslinn/jekyll_begin_end"
+
+  spec.authors = ["Mike Slinn"]
+  spec.bindir = "exe"
+  spec.description = <<~END_DESC
+    This Jekyll plugin defines the following Jekyll filters that return portions of a string:
+    begins_with — returns true if a string starts with a given substring.
+    does_not_begin_with — returns false if a string starts with a given substring.
+    ends_with — returns true if a string end with a given substring.
+    does_not_end_with — returns false if a string end with a given substring.
+    append_suffix_if_does_not_start_with — appends a suffix to the string if the string does not start with a substring.
+  END_DESC
+  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#begin_end"
+  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_begin_end"
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = "This Jekyll plugin provides 5 filters that return portions of a string: begins_with, " \
+                 "does_not_begin_with, ends_with, does_not_end_with and append_suffix_if_does_not_start_with."
+  spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.version = JekyllFromToUntil::VERSION
+
+  spec.add_dependency "jekyll", ">= 3.5.0"
+  spec.add_dependency "jekyll_plugin_logger"
+
+  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

data/lib/jekyll_begin_end/version.rb

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

data/lib/jekyll_begin_end.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "jekyll_plugin_logger"
+require_relative "jekyll_begin_end/version"
+
+# Jekyll filters for working with strings.
+
+module StringFilter
+  @logger = PluginMetaLogger.instance.new_logger(self)
+
+  def does_not_begin_with(text, query)
+    !text.start_with? query
+  end
+
+  def begins_with(text, query)
+    @logger.debug { "text=#{text} query=#{query} result: #{text.start_with? query}" }
+    text.start_with? query
+  end
+
+  def does_not_end_with(text, query)
+    !text.end_with? query
+  end
+
+  def ends_with(text, query)
+    text.end_with? query
+  end
+
+  def append_suffix_if_does_not_start_with(text, query, suffix)
+    text.start_with? query ? text : "#{text}#{suffix}"
+  end
+end
+
+PluginMetaLogger.instance.info { "Loaded jekyll_begin_end v#{JekyllFromToUntil::VERSION} plugin." }
+Liquid::Template.register_filter(Jekyll::StringFilter)

data/spec/jekyll_begin_end.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'liquid'
+require 'fileutils'
+require "jekyll_plugin_logger"
+require_relative '../lib/jekyll_begin_end'
+
+RSpec.describe(JekyllFromToUntil) do
+  include JekyllFromToUntil
+
+  _logger = PluginMetaLogger.new_logger(self)
+
+  let(:lines) do
+    <<~END_OF_LINES
+      line 1
+      line 2
+      line 3
+      line 4
+      line 5
+    END_OF_LINES
+  end
+
+  let(:gitignore) do
+    <<~END_OF_LINES
+      .bsp/
+      project/
+      target/
+      *.gz
+      *.sublime*
+      *.swp
+      *.out
+      *.Identifier
+      *.log
+      .idea*
+      *.iml
+      *.tmp
+      *~
+      ~*
+      .DS_Store
+      .idea
+      .jekyll-cache/
+      .jekyll-metadata
+      .makeAwsBucketAndDistribution.log
+      .sass-cache/
+      .yardoc/
+      __pycache__/
+      __MACOSX
+      _build/
+      _package/
+      _site/
+      bin/*.class
+      doc/
+      jekyll/doc/
+      node_modules/
+      Notepad++/
+      out/
+      package/
+      instances.json
+      rescue_ubuntu2010
+      rescue_ubuntu2010.b64
+      landingPageShortName.md
+      test.html
+      RUNNING_PID
+      mslinn_jekyll_plugins.zip
+      cloud9.tar
+      cloud9.zip
+      mslinn_aws.tar
+    END_OF_LINES
+  end
+
+  it 'verifies from' do
+    expect(from(lines, '3')).to eq("line 3\nline 4\nline 5\n")
+    expect(from(gitignore, 'PID')).to eq("RUNNING_PID\nmslinn_jekyll_plugins.zip\ncloud9.tar\ncloud9.zip\nmslinn_aws.tar\n")
+  end
+
+  it 'verifies to' do
+    expect(to(lines, '3')).to eq("line 1\nline 2\nline 3\n")
+    expect(to(gitignore, 'idea')).to eq(".bsp/\nproject/\ntarget/\n*.gz\n*.sublime*\n*.swp\n*.out\n*.Identifier\n*.log\n.idea*\n")
+  end
+
+  it 'verifies until' do
+    # until is a Ruby keyword
+    expect(method(:until).call(lines, '3')).to eq("line 1\nline 2\n")
+    expect(method(:until).call(gitignore, 'idea')).to eq(".bsp/\nproject/\ntarget/\n*.gz\n*.sublime*\n*.swp\n*.out\n*.Identifier\n*.log\n")
+  end
+
+  it 'verifies from regex' do
+    expect(from(gitignore, '^(cloud|sun)')).to eq("cloud9.tar\ncloud9.zip\nmslinn_aws.tar\n")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'liquid'
+require 'fileutils'
+require_relative '../lib/jekyll_begin_end'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_begin_end
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-25 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: 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: |
+  This Jekyll plugin defines the following Jekyll filters that return portions of a string:
+  begins_with — returns true if a string starts with a given substring.
+  does_not_begin_with — returns false if a string starts with a given substring.
+  ends_with — returns true if a string end with a given substring.
+  does_not_end_with — returns false if a string end with a given substring.
+  append_suffix_if_does_not_start_with — appends a suffix to the string if the string does not start with a substring.
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_begin_end.gemspec
+- lib/jekyll_begin_end.rb
+- lib/jekyll_begin_end/version.rb
+- spec/jekyll_begin_end.rb
+- spec/spec_helper.rb
+homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#begin_end
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_begin_end/issues
+  changelog_uri: https://github.com/mslinn/jekyll_begin_end/CHANGELOG.md
+  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#begin_end
+  source_code_uri: https://github.com/mslinn/jekyll_begin_end
+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: 'This Jekyll plugin provides 5 filters that return portions of a string:
+  begins_with, does_not_begin_with, ends_with, does_not_end_with and append_suffix_if_does_not_start_with.'
+test_files:
+- spec/jekyll_begin_end.rb
+- spec/spec_helper.rb