bridgetown_writebook 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c25aa1ad6696109457b735df53aed475b1c7c2b3797c26d13c35b106ae900b6
+  data.tar.gz: 3f7d2626aa3e8b136d3e08ceac6da90953165840a0a5a4e14bf809a817a6eb74
+SHA512:
+  metadata.gz: 9bad682e488ee4de5377045ab507bf59d0e636ab707bc4321550a32140e7feaeecf68ccbc5fa248acbd0cfec6800f0dbe3a5f1c3cfe302c54b3474049febfefd
+  data.tar.gz: bcb3a49ad89e9c122d1aa6d681df9c18b3c4687c70489d931f2b52e2308d6bd4b8bc93fcada0b148161a0eb0b1ac5a7aa24cad81047b28b4fdf798a23ca3f655

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,40 @@
+/vendor
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.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,14 @@
+# 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] - YYYY-MM-DD
+
+- First version

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2020-present
+
+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,67 @@
+# Sample plugin for Bridgetown
+
+_NOTE: This isn't a real plugin! Copy this sample code and use it to create your own Ruby gem! [Help guide here…](https://www.bridgetownrb.com/docs/plugins)_ 😃
+
+_You can run_ `bridgetown plugins new` _to easily set up a customized version of this starter repo._
+
+A Bridgetown plugin to [fill in the blank]…
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+bundle add my_awesome_plugin
+```
+
+Then add the initializer to your configuration in `config/initializers.rb`:
+
+```ruby
+init :my_awesome_plugin
+```
+
+Or if there's a `bridgetown.automation.rb` automation script, you can run that instead for guided setup:
+
+```shell
+bin/bridgetown apply https://github.com/username/my_awesome_plugin
+```
+
+## Usage
+
+The plugin will…
+
+### Optional configuration options
+
+The plugin will automatically use any of the following metadata variables if they are present in your site's `_data/site_metadata.yml` file.
+
+…
+
+## Testing
+
+* Run `bundle exec rake test` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and Minitest together.
+
+## Contributing
+
+1. Fork it (https://github.com/username/my-awesome-plugin/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request
+
+----
+
+## Releasing (you can delete this section in your own plugin repo)
+
+To release a new version of the plugin, simply bump up the version number in both `version.rb` and
+`package.json`, and then run `script/release`. This will require you to have a registered account
+with both the [RubyGems.org](https://rubygems.org) and [NPM](https://www.npmjs.com) registries.
+You can optionally remove the `package.json` and `frontend` folder if you don't need to package frontend
+assets for Webpack.
+
+If you run into any problems or need further guidance, please check out our [Bridgetown community resources](https://www.bridgetownrb.com/docs/community)
+where friendly folks are standing by to help you build and release your plugin or theme.
+
+**NOTE:** make sure you add the `bridgetown-plugin` [topic](https://github.com/topics/bridgetown-plugin) to your
+plugin's GitHub repo so the plugin or theme will show up on [Bridgetown's official Plugin Directory](https://www.bridgetownrb.com/plugins)! (There may be a day or so delay before you see it appear.)

data/Rakefile

@@ -0,0 +1,11 @@
+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"]
+  t.warning = false
+end
+
+task :default => :test

data/bridgetown.automation.rb

@@ -0,0 +1,57 @@
+# If your plugin requires a lot of steps to get set up, consider writing an automation to help guide users.
+# You could set up and configure all sorts of things, for example:
+#
+# add_gem("my_plugin")
+#
+# add_yarn_for_gem("my_plugin")
+#
+# add_initializer :"my_plugin" do
+#   <<~RUBY
+#     do
+#       some_config_key 12345
+#     end
+#   RUBY
+# end
+#
+# create_builder "my_nifty_builder.rb" do
+#   <<~RUBY
+#     class MyNeatBuilder < SiteBuilder
+#       def build
+#         puts MyPlugin.hello
+#       end
+#     end
+#   RUBY
+# end
+#
+# javascript_import do
+#   <<~JS
+#     import { MyPlugin } from "my_plugin"
+#   JS
+# end
+#
+# javascript_import 'import "my_plugin/frontend/styles/index.css"'
+#
+# create_file "src/_data/plugin_data.yml" do
+#   <<~YAML
+#     data:
+#       goes: here
+#   YAML
+# end
+#
+# color = ask("What's your favorite color?")
+#
+# append_to_file "bridgetown.config.yml" do
+#   <<~YAML
+#
+#     my_plugin:
+#       favorite_color: #{color}
+#   YAML
+# end
+#
+# Read the Automations documentation: https://www.bridgetownrb.com/docs/automations
+
+append_to_file "config/boot.rb" do
+  <<~RUBY
+
+  RUBY
+end

data/bridgetown_writebook.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown_writebook/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown_writebook"
+  spec.version       = BridgetownWritebook::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.summary       = "Sample code for creating new Bridgetown plugins"
+  spec.homepage      = "https://github.com/username/bridgetown_writebook"
+  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"]
+  # Uncomment this if you wish to supply a companion NPM package:
+  # spec.metadata      = { "yarn-add" => "bridgetown_writebook@#{BridgetownWritebook::VERSION}" }
+
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.add_dependency "bridgetown", ">= 1.2.0", "< 2.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 13.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.3"
+end

data/components/bridgetown_writebook/layout_help.liquid

@@ -0,0 +1 @@
+<p>Just use <code>layout: bridgetown_writebook/layout</code> in your page's front matter.</p>

data/components/bridgetown_writebook/plugin_component.rb

@@ -0,0 +1,17 @@
+# rubocop:disable all
+module BridgetownWritebook
+  class PluginComponent < Bridgetown::Component
+    def initialize(hi:)
+      @hi = hi
+    end
+
+    # You can remove this and add an ERB, Serbea, etc. template file…or you can
+    # use something like Phlex if you're feeling adventurous!
+    def template
+      <<~HTML
+        Well hello there #{hi}!
+      HTML
+    end
+  end
+end
+# rubocop:enable all

data/content/bridgetown_writebook/example_page.md

@@ -0,0 +1,8 @@
+---
+layout: default
+title: Example Page
+---
+
+If all goes well, this page will be accessible as [`{{ resource.data.relative_url }}`]({{ resource.data.relative_url }}), and you will see a photo of a train:
+
+![Train on Rails]({{ "/bridgetown_writebook/train-on-rails.jpeg" | relative_url }})

data/layouts/bridgetown_writebook/layout.html

@@ -0,0 +1,9 @@
+---
+layout: default
+---
+
+<p>You can include this layout in your site! 🥳</p>
+
+{% render "bridgetown_writebook/layout_help" %}
+
+{{ content }}

data/lib/bridgetown_writebook/builder.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module BridgetownWritebook
+  class Builder < Bridgetown::Builder
+    def build
+      liquid_tag "bridgetown_writebook" do
+        "This plugin works!"
+      end
+    end
+  end
+end

data/lib/bridgetown_writebook/version.rb

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

data/lib/bridgetown_writebook.rb

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

data/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "bridgetown_writebook",
+  "version": "0.1.0",
+  "main": "frontend/javascript/index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/username/bridgetown_writebook.git"
+  },
+  "author": "Bridgetown Maintainers <maintainers@bridgetownrb.com>",
+  "homepage": "https://www.bridgetownrb.com",
+  "license": "MIT",
+  "private": false,
+  "files": [
+    "frontend"
+  ]
+}

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown_writebook
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-08-26 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: '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: '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'
+description:
+email: maintainers@bridgetownrb.com
+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_writebook.gemspec
+- components/bridgetown_writebook/layout_help.liquid
+- components/bridgetown_writebook/plugin_component.rb
+- content/bridgetown_writebook/example_page.md
+- content/bridgetown_writebook/train-on-rails.jpeg
+- layouts/bridgetown_writebook/layout.html
+- lib/bridgetown_writebook.rb
+- lib/bridgetown_writebook/builder.rb
+- lib/bridgetown_writebook/version.rb
+- package.json
+homepage: https://github.com/username/bridgetown_writebook
+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.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.13
+signing_key:
+specification_version: 4
+summary: Sample code for creating new Bridgetown plugins
+test_files: []