jekyll-uj-powertools 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e90145bcdbad261602234c4de838d92f316eeb59f96c89cba223d655014a51fc
+  data.tar.gz: 73a8176daa5ad5e4706349949e31ef6fe7fabd69547d731a6652f43cfb5ce56c
+SHA512:
+  metadata.gz: d6d53038e009eb6f1a3fcd0172a093c2f4e4fca9d203b598dba5a4242fac20f7afe22456813a22f7894b7c0be85822a1ac3e9ec0371a4e66c38520b8c16ad1d5
+  data.tar.gz: c1d437bb20f57ba35823a2209139de711687113303d61810363bbbbc3697a6c98c5531cc1300375235f344e54ccb51fe85d07f3f7f98b8edbf0af0e12ecfe5b4

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-uj-powertools.gemspec
+gemspec
+
+if ENV["JEKYLL_VERSION"]
+  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 ITW Creative Works
+
+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,87 @@
+<p align="center">
+  <a href="https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg">
+    <img src="https://cdn.itwcreativeworks.com/assets/itw-creative-works/images/logo/itw-creative-works-brandmark-black-x.svg" width="100px">
+  </a>
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/gem/v/jekyll-uj-powertools">
+  <br>
+  <!-- <img src="https://img.shields.io/librariesio/release/npm/jekyll-uj-powertools.svg"> -->
+  <img src="https://img.shields.io/github/repo-size/itw-creative-works/jekyll-uj-powertools">
+  <img src="https://img.shields.io/codeclimate/maintainability-percentage/itw-creative-works/jekyll-uj-powertools.svg">
+  <img src="https://img.shields.io/gem/dt/jekyll-uj-powertools">
+  <!-- <img src="https://img.shields.io/node/v/jekyll-uj-powertools.svg"> -->
+  <img src="https://img.shields.io/website/https/itwcreativeworks.com.svg">
+  <img src="https://img.shields.io/github/license/itw-creative-works/jekyll-uj-powertools.svg">
+  <img src="https://img.shields.io/github/contributors/itw-creative-works/jekyll-uj-powertools.svg">
+  <img src="https://img.shields.io/github/last-commit/itw-creative-works/jekyll-uj-powertools.svg">
+  <br>
+  <br>
+  <a href="https://itwcreativeworks.com">Site</a> | <a href="https://www.npmjs.com/package/jekyll-uj-powertools">NPM Module</a> | <a href="https://github.com/itw-creative-works/jekyll-uj-powertools">GitHub Repo</a>
+  <br>
+  <br>
+  Meet <strong>jekyll-uj-powertools</strong>, your new best friend for developing with <a href="https://github.com/itw-creative-works/ultimate-jekyll">Ultimate jekyll</a>
+</p>
+
+## Features
+* Powerful utility for Jekyll sites
+* `remove_ads` filter to remove ads from a string
+* `json_escape` filter to escape JSON characters
+
+# Jekyll::uj-powertools
+Meet `jekyll-uj-powertools`, the powerful set of utilities for Jekyll users.
+
+It includes functions to remove ads from strings and escape JSON characters, making your Jekyll site cleaner and more efficient.
+
+## Installation
+Install the gem and add to the application's Gemfile by executing:
+```shell
+bundle add jekyll-uj-powertools
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+```shell
+gem install jekyll-uj-powertools
+```
+
+## Usage
+Now you can use the `remove_ads` and `json_escape` filters in your Jekyll site:
+
+### `remove_ads` Filter
+Remove ads from a string, such as a blog post or article.
+
+```liquid
+{{ post.content | remove_ads }}
+```
+
+### `json_escape` Filter
+Escape JSON characters in a string making it safe to use in a JSON object.
+
+```liquid
+{{ post.content | json_escape }}
+```
+
+These examples show how you can use the features of `jekyll-uj-powertools` in your Jekyll site.
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Building and pushing
+Run the tests
+```shell
+bundle install
+bundle exec rspec
+```
+
+Publish the Gem
+```shell
+gem build jekyll-uj-powertools.gemspec
+
+gem push jekyll-uj-powertools-1.0.0.gem
+```
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/itw-creative-works/jekyll-uj-powertools.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/jekyll-uj-powertools.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-uj-powertools/version'
+
+Gem::Specification.new do |spec|
+  # Gem info
+  spec.name = "jekyll-uj-powertools"
+  spec.version = Jekyll::UJPowertools::VERSION
+
+  # Author info
+  spec.authors = ["ITW Creative Works"]
+  spec.email = ["hello@itwcreativeworks.com"]
+
+  # Gem details
+  spec.summary = "A powerful set of utilities for Jekyll"
+  spec.description = "jekyll-uj-powertools provides a powerful set of utilities for Jekyll, including functions to remove ads from strings and escape JSON characters."
+  spec.homepage = "https://github.com/itw-creative-works/jekyll-uj-powertools"
+  spec.license = "MIT"
+
+  # Files
+  spec.files = Dir["CODE_OF_CONDUCT.md", "README*.md", "LICENSE", "Rakefile", "*.gemspec", "Gemfile", "lib/**/*", "spec/**/*"]
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  # Gem requires Jekyll to work
+  spec.add_runtime_dependency "jekyll", ">= 3.0", "< 5.0"
+
+  # Development requires more
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  # Ruby version
+  spec.required_ruby_version = ">= 2.0.0"
+end

data/lib/jekyll-uj-powertools/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module UJPowertools
+    VERSION = "1.0.0"
+  end # module UJPowertools
+end # module Jekyll

data/lib/jekyll-uj-powertools.rb

@@ -0,0 +1,15 @@
+require "jekyll"
+
+module Jekyll
+  module UJPowertools
+    def remove_ads(input)
+      input.gsub(/<[^>]*class="uj-vert-unit"[^>]*>.*?<\/[^>]*>/m, '')
+    end
+
+    def json_escape(value)
+      value.gsub('\\', '\\\\').gsub('"', '\"')
+    end
+  end
+end
+
+Liquid::Template.register_filter(Jekyll::UJPowertools)

data/spec/jekyll-uj-powertools_spec.rb

@@ -0,0 +1,30 @@
+require 'jekyll-uj-powertools'
+
+RSpec.describe Jekyll::UJPowertools do
+  # Dummy class to include the filter methods
+  class DummyClass
+    include Jekyll::UJPowertools
+  end
+
+  let(:dummy) { DummyClass.new }
+
+  # describe '.remove_ads' do
+  #   it 'removes ads from the string' do
+  #     expect(dummy.remove_ads('This is an ad! Buy now!')).to eq('This is an !')
+  #   end
+
+  #   it 'returns the original string if no ads are present' do
+  #     expect(dummy.remove_ads('No ads here')).to eq('No ads here')
+  #   end
+  # end
+
+  describe '.json_escape' do
+    it 'escapes double quotes in JSON string' do
+      expect(dummy.json_escape('this is a "quote"')).to eq('this is a \"quote\"')
+    end
+
+    it 'escapes backslashes in JSON string' do
+      expect(dummy.json_escape('this is a nothing')).to eq('this is a nothing')
+    end
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-uj-powertools
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ITW Creative Works
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-05-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.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: 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'
+description: jekyll-uj-powertools provides a powerful set of utilities for Jekyll,
+  including functions to remove ads from strings and escape JSON characters.
+email:
+- hello@itwcreativeworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-uj-powertools.gemspec
+- lib/jekyll-uj-powertools.rb
+- lib/jekyll-uj-powertools/version.rb
+- spec/jekyll-uj-powertools_spec.rb
+homepage: https://github.com/itw-creative-works/jekyll-uj-powertools
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A powerful set of utilities for Jekyll
+test_files:
+- spec/jekyll-uj-powertools_spec.rb