jekyll_video 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3103fb3d5dfc593bce47d14e6da474862304dcb113e2405403304abffd44435
+  data.tar.gz: 75dcf2187bde6290299a36fb3f4c0ffe473d93a983ad1d519daea86299dfa648
+SHA512:
+  metadata.gz: e0fe2a040f1d70d32080b16ccd6c9bd5cbbabe3de26b7ab179030141e8691c4e725f3cad4d94ff7dd1dab287a0f0914d4af29712233d16bd6ba31f6e0150026a
+  data.tar.gz: 73ef9f4d303c8087967930a0fc6cd767c31f441993c90aedb38d93daad555c2f2644ac87b9045bafb80a5685abd055d000ab375969478a24d7bdc54d3f607d9a

data/.rubocop.yml

@@ -0,0 +1,70 @@
+require:
+  # - rubocop-jekyll
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - binstub/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
+  NewCops: enable
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/BlockLength:
+  Exclude:
+    - jekyll_video.gemspec
+  Max: 30
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - Rakefile
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma
+
+RSpec/FilePath:
+  IgnoreMethods: true
+  SpecSuffixOnly: true
+
+RSpec/ExampleLength:
+  Max: 30
+
+RSpec/MultipleExpectations:
+  Max: 15

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0
+
+* Initial release.

data/README.md

@@ -0,0 +1,94 @@
+# `Jekyll_video` [![Gem Version](https://badge.fury.io/rb/jekyll_video.svg)](https://badge.fury.io/rb/jekyll_video)
+
+Embeds a video HTML tag into a Jekyll web page.
+
+
+## Installation
+
+Add the following to your Jekyll website's `Gemfile`:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_video'
+end
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Add the following CSS:
+
+```css
+.rounded {
+  border: 1px solid;
+  border-radius: 7px;
+}
+
+.shadow {
+  border: thin gray solid;
+  box-shadow: 5px 5px 6px #999;
+}
+```
+
+## Usage
+
+See the `demo/` directory for an example.
+
+
+## Development
+
+After checking out this git repository, install dependencies by typing:
+
+```shell
+$ bin/setup
+```
+
+You should do the above before running Visual Studio Code.
+
+
+### Run the Tests
+
+```shell
+$ bundle exec rake test
+```
+
+
+### Interactive Session
+
+The following will allow you to experiment:
+
+```shell
+$ bin/console
+```
+
+
+### Local Installation
+
+To install this gem onto your local machine, type:
+
+```shell
+$ bundle exec rake install
+```
+
+
+### To Release A New Version
+
+To create a git tag for the new version, push git commits and tags,
+and push the new version of the gem to https://rubygems.org, type:
+
+```shell
+$ bundle exec rake release
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome at https://github.com/mslinn/jekyll_video.
+
+
+## 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,40 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc 'Bump patch version'
+task :patch do
+  system 'gem bump --tag'
+end
+
+desc 'Bump minor version'
+task :minor do
+  system 'gem bump --version minor --tag'
+end
+
+desc 'Bump major version'
+task :major do
+  system 'gem bump --version major --tag'
+end
+
+task publish: [:build] do
+  $VERBOSE = nil
+  load 'jekyll_video/version.rb'
+  system "gem push pkg/jekyll_video-#{JekyllVideo::VERSION}.gem"
+end
+
+desc 'Bump patch version, create git tag, build the gem and release to geminabox (default)'
+task release_patch: %i[test patch publish]
+
+desc 'Bump minor version, create git tag, build the gem and release to geminabox'
+task release_minor: %i[test minor publish]
+
+desc 'Bump major version, create git tag, build the gem and release to geminabox'
+task release_major: %i[test major publish]
+
+task default: :test

data/jekyll_video.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/jekyll_video/version'
+
+Gem::Specification.new do |spec|
+  host = 'https://github.com/mslinn/jekyll_video'
+
+  spec.authors               = ['Mike Slinn']
+  spec.description           = <<~END_DESC
+    Embed an HTML video into a web page.
+  END_DESC
+  spec.email                 = ['mslinn@mslinn.com']
+  spec.files                 = Dir['.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md']
+  spec.homepage              = 'https://github.com/mslinn/jekyll_video'
+  spec.license               = 'MIT'
+  spec.metadata = {
+    'allowed_push_host' => 'https://rubygems.org',
+    'bug_tracker_uri'   => "#{host}/issues",
+    'changelog_uri'     => "#{host}/CHANGELOG.md",
+    'homepage_uri'      => spec.homepage,
+    'source_code_uri'   => host,
+  }
+  spec.name                 = 'jekyll_video'
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.summary               = 'Embed an HTML video into a web page.'
+  spec.version               = JekyllVideo::VERSION
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'jekyll_plugin_support', '>= 0.7.0'
+end

data/lib/jekyll_video/version.rb

@@ -0,0 +1,3 @@
+module JekyllVideo
+  VERSION = '0.1.0'.freeze unless defined? VERSION
+end

data/lib/jekyll_video.rb

@@ -0,0 +1,12 @@
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'jekyll_plugin_support'
+
+require_relative 'jekyll_video/version'
+
+# Require all Ruby files in 'lib/', except this file
+Dir[File.join(__dir__, '*.rb')].each do |file|
+  require file unless file.end_with?('/jekyll_video.rb')
+end
+
+# Write the code for your gem here

data/lib/video.rb

@@ -0,0 +1,39 @@
+require 'jekyll_plugin_support'
+require_relative 'jekyll_video/version'
+
+# This Jekyll tag plugin is a minimal example.
+#
+# See https://www.mslinn.com/jekyll/10200-jekyll-plugin-background.html
+# See https://www.mslinn.com/jekyll/10400-jekyll-plugin-template-collection.html
+#
+# @example Embed a video
+#   {% video 'https://asdf.com/myvideo.mp4' %}
+#
+# The Jekyll log level defaults to :info, which means all the Jekyll.logger statements below will not generate output.
+# You can control the log level when you start Jekyll.
+# To set the log level to :debug, write an entry into _config.yml, like this:
+# plugin_loggers:
+#   Video: debug
+module JekyllVideo
+  # This class implements the Jekyll video functionality
+  class Video < JekyllSupport::JekyllTag
+    PLUGIN_NAME = 'video'.freeze
+    VERSION = JekyllVideo::VERSION
+
+    # @return [void]
+    def render_impl
+      classes   = @helper.parameter_specified?('classes') || 'shadow rounded'
+      src       = @helper.parameter_specified?('src')     || @argument_string
+      style     = @helper.parameter_specified?('style')   || ''
+      width     = @helper.parameter_specified?('width')   || '100%'
+
+      <<~END_OUTPUT
+        <video class="jekyll_video #{classes}" controls width="#{width}" style="#{style}">
+          <source src="#{src}">
+        </video>
+      END_OUTPUT
+    end
+
+    JekyllPluginHelper.register(self, PLUGIN_NAME)
+  end
+end

data/spec/jekyll_video_spec.rb

@@ -0,0 +1,13 @@
+require_relative '../lib/jekyll_video'
+
+RSpec.describe JekyllVideo::JekyllVideo do
+  let(:logger) do
+    PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+  end
+
+  let(:parse_context) { TestParseContext.new }
+
+  it 'has a test' do
+    expect(true).to be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,79 @@
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require 'liquid'
+require 'fileutils'
+require 'yaml'
+require_relative '../lib/<%= @gem_name %>'
+
+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'
+
+  config.filter_run_when_matching focus: true
+end
+
+Registers = Struct.new(:page, :site)
+
+# Mock for Collections
+class Collections
+  def values
+    []
+  end
+end
+
+# Mock for Site
+class SiteMock
+  attr_reader :config
+
+  def initialize
+    @config = YAML.safe_load_file(File.read('../demo/_config.yml'))
+    @config['env'] = { 'JEKYLL_ENV' => 'development' }
+  end
+
+  def collections
+    Collections.new
+  end
+end
+
+class TestLiquidContext < Liquid::Context
+  def initialize
+    super
+
+    page = {
+      'content'     => 'blah blah',
+      'description' => 'Jekyll plugin support demo',
+      'dir'         => '/',
+      'excerpt'     => nil,
+      'layout'      => 'default',
+      'name'        => 'index.html',
+      'path'        => 'index.html',
+      'title'       => 'Welcome',
+      'url'         => '/',
+    }
+
+    @content = 'Interior of the tag'
+    @registers = Registers.new(
+      page,
+      SiteMock.new
+    )
+  end
+end
+
+# Mock for Liquid::ParseContent
+class TestParseContext < Liquid::ParseContext
+  attr_reader :line_number, :registers
+
+  def initialize
+    super
+    @line_number = 123
+
+    @registers = Registers.new(
+      { 'path' => 'path/to/page.html' },
+      SiteMock.new
+    )
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_video
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-08 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_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: 'Embed an HTML video into a web page.
+
+  '
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- jekyll_video.gemspec
+- lib/jekyll_video.rb
+- lib/jekyll_video/version.rb
+- lib/video.rb
+- spec/jekyll_video_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mslinn/jekyll_video
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_video/issues
+  changelog_uri: https://github.com/mslinn/jekyll_video/CHANGELOG.md
+  homepage_uri: https://github.com/mslinn/jekyll_video
+  source_code_uri: https://github.com/mslinn/jekyll_video
+post_install_message: |2+
+
+  Thanks for installing jekyll_video!
+
+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.3.3
+signing_key:
+specification_version: 4
+summary: Embed an HTML video into a web page.
+test_files: []
+...