bridgetown_reveal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4db9ee64b15c37e4dc8f04edd27a15a432f24e0ea9d7d5620b4a7902be512425
+  data.tar.gz: 89c435e9b3c9a5ba48bd283086d48cc5e601d9fc1a06309c672d2cfb9d37f32a
+SHA512:
+  metadata.gz: 9d3d35cb0f556f179a348f50da9f32c1ad6f1346f6cd04027c19ffca66a7ca598379b7782e3f3836a54438ef3414dfdef680f23413dbc65e1dac403149eee648
+  data.tar.gz: b18d1fd23a0ac29f9cf9451853816397aab0eef4e37b1727c614957caa3e8a3957948324c1bc3385cb74fcd3e4411891f6ec2a3b73e065303eaa7b4600cc60fe

data/.github/workflows/tests.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - "*"
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: [2.7.7, 3.0.5, 3.1.3, 3.2.0]
+        bridgetown_version: [1.2.0]
+    continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
+    # Has to be top level to cache properly
+    env:
+      BUNDLE_JOBS: 3
+      BUNDLE_PATH: "vendor/bundle"
+      BRIDGETOWN_VERSION: ${{ matrix.bridgetown_version }}
+    steps:
+      - uses: actions/checkout@master
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true
+      - name: Test with Rake
+        run: script/cibuild

data/.gitignore

@@ -0,0 +1,41 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/checksums/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+Gemfile.lock
+.bundle
+.ruby-version
+
+# Node
+node_modules
+.npm
+.node_repl_history
+
+# Yarn
+yarn-error.log
+yarn-debug.log*
+.pnp/
+.pnp.js
+
+# Yarn Integrity file
+.yarn-integrity
+
+test/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack
+
+.env

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+
+  Exclude:
+    - .gitignore
+    - .rubocop.yml
+    - "*.gemspec"
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+    - Rakefile
+    - bridgetown.automation.rb
+
+    - script/**/*
+    - test/fixtures/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2023-05-XX
+
+- First version

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+
+group :test do
+  gem "debug"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2023-present Jeremy Hinegardner
+
+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,123 @@
+# Bridgetown reveal.js Plugin
+
+[Bridgetown](https://www.bridgetownrb.com) is a ruby powered static site
+generation. [Reveal.js](https://revealjs.com) is an open source HTML
+presentation framework.
+
+This plugin wires the two together so that you can use bridgetown to host a
+reveal.js presentation as a section of your site.
+
+## Installation
+
+### Using an Automation
+
+The preferred method to install this plugin is to run the automation. There
+are files to add / update to your site that uses this plugin and it is most
+easily done through the automation.
+
+```shell
+bin/bridgetown apply https://github.com/copiousfreetime/bridgetown_reveal
+```
+
+### Manual Installation
+
+Run this command to add this plugin to your site's Gemfile.
+
+```shell
+bundle add bridgetown_reveal
+```
+
+And then run the automation locally:
+
+```shell
+./bin/bridgetown apply $(bundle show bridgetown_reveal)/bridgetown.automation.rb
+```
+
+If you prefer NOT to run the automation, then look at the the automation file
+and apply the updates manually:
+
+<https://github.com/copiousfreetime/bridgetown_reveal/blob/main/bridgetown.automation.rb>
+
+The steps are:
+
+1. Add the initializer to your configuraiton in `config/initializers.rb`
+    ```ruby
+    init :bridgetown_reveal
+    ```
+2. Add `reveal.js` to your yarn package: `yarn add reveal.js`
+3. Install the [javascript for bootstrapping reveal.js](https://github.com/copiousfreetime/bridgetown_reveal/blob/faec16917b99ae9646c771b7fb23c2c73a75b5db/bridgetown.automation.rb#L9-L49) and [import it](https://github.com/copiousfreetime/bridgetown_reveal/blob/faec16917b99ae9646c771b7fb23c2c73a75b5db/bridgetown.automation.rb#L56)
+4. Update the `bridgetown.config.yml` to [add the `slides`](https://github.com/copiousfreetime/bridgetown_reveal/blob/faec16917b99ae9646c771b7fb23c2c73a75b5db/bridgetown.automation.rb#L63-L67) collection.
+5. Install a [sample presentation](https://github.com/copiousfreetime/bridgetown_reveal/blob/faec16917b99ae9646c771b7fb23c2c73a75b5db/bridgetown.automation.rb#L71-L109)
+
+## Usage
+
+The plugin will add a new layout type of [`bridgetown_reveal/deck`](./layouts/bridgetown_reveal/deck.erb) and an
+associated component of [`::BridgetownReveal::Deck`](./components/bridgetown_reveal/deck.rb).
+
+Integrating a reveal.js presentation into your site involves 3 items:
+
+- Setting a collection for the slides in the top level `bridgetown.config.yml`.
+- Create the single presentation page.
+- Creating all the slide content.
+
+For example, if to make a new presentation at output location `/slidey` you
+would do the following:
+
+Add the `slidey` collection to the `bridgetown.config.yml` file:
+
+```yaml
+collections:
+    slidey:
+      sort_by: order
+      name: Slidey
+```
+
+Create the page for the presentation at `src/slidey.erb`
+
+```erb
+---
+layout: bridgetown_reveal/deck
+---
+
+<%= render ::BridgetownReveal::Deck.new(site: site, collection: 'slidey') %>
+```
+
+Put all the slidey content pages themselves in `src/_slidey/`. The pages will all be
+combinded together and sorted based upon the `order` value in the frontmatter.
+
+**`src/_slidey/intro.html`**
+```html
+---
+order: 1
+---
+<section>
+  <h1>The first slide of the Intro</h1>
+</section>
+
+<section>
+  <h1>The 2nd slide of the Intro</h1>
+</section>
+```
+
+**`src/_slidey/outro.html`**
+```html
+---
+order: 100
+---
+<section>
+  <h1>The penultimate slide of the talk.</h1>
+</section>
+
+<section>
+  <h1>Thank you, and goodnight</h1>
+</section>
+```
+
+All of the content is [reveal.js](https://revealjs.com) `<section>` content. The
+top level wrapper for reveal.js is inside the `bridgetown_reveal/deck` layout.
+
+## Testing
+
+* Run `bundle exec rake test` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and Minitest together.
+

data/Rakefile

@@ -0,0 +1,21 @@
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.warning = false
+  t.test_globs = "test/**/test_*.rb"
+end
+
+task :release_check do
+  unless `git branch` =~ /^\* main/
+    abort "You must be on the main branch to release!"
+  end
+  unless `git status` =~ /^nothing to commit/m
+    abort "Nope, sorry, you have unfinished business"
+  end
+end
+
+task :release => :release_check
+task :default => :test

data/bridgetown.automation.rb

@@ -0,0 +1,109 @@
+add_gem("bridgetown_reveal")
+
+add_yarn_for_gem("bridgetown_reveal")
+
+add_initializer :bridgetown_reveal
+
+create_file "frontend/javascript/bridgetown_reveal.js" do
+  <<~JS
+  import "reveal.js/dist/reset.css"
+  import "reveal.js/dist/reveal.css"
+
+  /*
+   * Customize the theme by changing this line. The list of available themes:
+   *
+   *    https://revealjs.com/themes/
+   *
+   */
+  import "reveal.js/dist/theme/solarized.css"
+
+  /*
+   * code highlighting is done via highlightjs and monokai.css is included
+   * within reveal.js. `zenburn` is alos included, any others will need to be
+   * manually downloaded from https://github.com/highlightjs/highlight.js/tree/main/src/styles
+   * and add it to the styles directory
+   */
+  import "reveal.js/plugin/highlight/monokai.css"
+
+
+  import Reveal from "reveal.js"
+  import RevealNotes from "reveal.js/plugin/notes/notes.esm.js"
+  import RevealMarkdown from "reveal.js/plugin/markdown/markdown.esm.js"
+  import RevealHighlight from "reveal.js/plugin/highlight/highlight.esm.js"
+
+  /*
+   * The full configuration options for reveal.js are  documented at:
+   *
+   *  https://revealjs.com/config/
+   *
+   */
+  Reveal.initialize({
+    controls: false,
+    progress: true,
+    slideNumber: true,
+    hash: true,
+
+    plugins: [ RevealMarkdown, RevealHighlight, RevealNotes ]
+  });
+
+  console.info("Reveal is loaded!")
+  JS
+
+end
+
+javascript_import do
+  <<~JS
+    import "./bridgetown_reveal.js"
+  JS
+end
+
+append_to_file "bridgetown.config.yml" do
+  <<~YAML
+
+  # If you already have a collections section, then merge this with it
+  collections:
+    slides:
+      sort_by: order
+      name: Deck
+  YAML
+end
+
+create_file "src/presentation.erb" do
+  <<~ERB
+  ---
+  layout: bridgetown_reveal/deck
+  ---
+
+  <%= render ::BridgetownReveal::Deck.new(site: site, collection: 'slides') %>
+  ERB
+end
+
+create_file "src/_slides/intro.html" do
+  <<~HTML
+  ---
+  order: 0
+  ---
+  <section>
+    <h1>The first slide of the Intro</h1>
+  </section>
+
+  <section>
+    <h1>The 2nd slide of the Intro</h1>
+  </section>
+  HTML
+end
+
+create_file "src/_slides/closing.html" do
+  <<~HTML
+  ---
+  order: 100
+  ---
+  <section>
+    <h1>The penultimate slide of the talk.</h1>
+  </section>
+
+  <section>
+    <h1>Thank you, and goodnight</h1>
+  </section>
+  HTML
+end

data/bridgetown_reveal.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown_reveal/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown_reveal"
+  spec.version       = BridgetownReveal::VERSION
+  spec.author        = "Jeremy Hinegardner"
+  spec.email         = "jeremy@copiousfreetime.org"
+  spec.summary       = "Support adding reveal.js presentations to a Bridgetown site."
+  spec.homepage      = "https://github.com/copiousfreetime/bridgetown_reveal"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^test/!)
+  spec.require_paths = ["lib"]
+  spec.metadata      = {
+    "bug_tracker_uri" => "https://github.com/copiousfreetime/bridgetown_reveal/issues",
+    "changelog_uri" => "https://github.com/copiousfreetime/bridgetown_reveal/blob/master/CHANGELOG.md",
+    "homepage_uri" => "https://github.com/copiousfreetime/bridgetown_reveal",
+    "source_code_uri" => "https://github.com/copiousfreetime/bridgetown_reveal",
+    "yarn-add" => "reveal.js@#{BridgetownReveal::REVEAL_JS_VERSION}"
+  }
+
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_dependency "bridgetown", ">= 1.2.0", "< 2.0"
+
+  spec.add_development_dependency "bundler",            ">= 2.1"
+  spec.add_development_dependency "rake",               "~> 13.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.3"
+  spec.add_development_dependency "minitest",           "~> 5.18"
+  spec.add_development_dependency "minitest-profile",   "~> 0.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.6"
+end
+

data/components/bridgetown_reveal/deck.erb

@@ -0,0 +1,10 @@
+<div class="reveal">
+  <div class="slides">
+    <% slides.each do |slide| %>
+      <% slide.transform! %>
+
+      <%= slide.content %>
+
+    <% end %>
+  </div>
+</div>

data/components/bridgetown_reveal/deck.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module BridgetownReveal
+  class Deck < Bridgetown::Component
+    def initialize(site:, collection: "slides")
+      super()
+      @site, @collection = site, collection
+      @resources = @site.collections[@collection].resources
+    end
+
+    def slides
+      filtered_resources = @resources.select { |r| r.data.order }
+      ordered_slides = filtered_resources.sort_by { |r| r.data.order }
+      orders = Set.new
+      ordered_slides.each do |slide|
+        if orders.include?(slide.data.order)
+          ::Bridgetown.logger.warn("Site:",
+                                   "Duplicate slide #{slide.data.order} appears in #{slide}")
+        else
+          orders << slide.data.order
+        end
+      end
+
+      ordered_slides
+    end
+  end
+end

data/layouts/bridgetown_reveal/deck.erb

@@ -0,0 +1,15 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title><%= strip_html(strip_newlines(site.metadata.title)) %></title>
+    <link rel="stylesheet" href="<%= webpack_path :css %>" />
+    <script src="<%= webpack_path :js %>" defer></script>
+    <%= live_reload_dev_js %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/lib/bridgetown_reveal/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module BridgetownReveal
+  VERSION = "0.1.0"
+  REVEAL_JS_VERSION = "4.5.0"
+end

data/lib/bridgetown_reveal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+
+# @param config [Bridgetown::Configuration::ConfigurationDSL]
+Bridgetown.initializer :bridgetown_reveal do |config|
+  # Add code here which will run when a site includes
+  # `init :bridgetown_reveal`
+  # in its configuration
+
+  # Add default configuration data:
+  config.bridgetown_reveal ||= {}
+
+  # You can optionally supply a source manifest:
+  config.source_manifest(
+    origin: BridgetownReveal,
+    components: File.expand_path("../components", __dir__),
+    layouts: File.expand_path("../layouts", __dir__)
+  )
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown_reveal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Hinegardner
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.18'
+- !ruby/object:Gem::Dependency
+  name: minitest-profile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description:
+email: jeremy@copiousfreetime.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown.automation.rb
+- bridgetown_reveal.gemspec
+- components/bridgetown_reveal/deck.erb
+- components/bridgetown_reveal/deck.rb
+- layouts/bridgetown_reveal/deck.erb
+- lib/bridgetown_reveal.rb
+- lib/bridgetown_reveal/version.rb
+homepage: https://github.com/copiousfreetime/bridgetown_reveal
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/copiousfreetime/bridgetown_reveal/issues
+  changelog_uri: https://github.com/copiousfreetime/bridgetown_reveal/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/copiousfreetime/bridgetown_reveal
+  source_code_uri: https://github.com/copiousfreetime/bridgetown_reveal
+  yarn-add: reveal.js@4.5.0
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Support adding reveal.js presentations to a Bridgetown site.
+test_files: []