bridgetown-notable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0379d2ac8d8a87960f01fe34d75f20c4d35874818925abe86a734d20a3efa96e'
+  data.tar.gz: ba49a85179b0465c2cb083644d6c92966a4036cd5de6b3d08b0daf9b967c6687
+SHA512:
+  metadata.gz: 73843321577332b6f85c7a3b9ea861a0c59a81e2b8e6f5575ba25899dbf7a47c9fc20fc31c2eb2ea4ae84eafdfa1a195b55249d1403f68b1730e60ec543ec228
+  data.tar.gz: 525c000c77255ddac827ea5f377789bf7944587608944c029077b5efa29e74eaf73f88eae4402236cb22111b74789ebfbc4334fb8f788aeffa23c1228c4908e0

data/.gitignore

@@ -0,0 +1,38 @@
+/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
+
+spec/dest
+.bridgetown-metadata
+.bridgetown-cache
+.bridgetown-webpack

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,22 @@
+require: rubocop-bridgetown
+
+inherit_gem:
+  rubocop-bridgetown: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Include:
+    - lib/**/*.rb
+
+  Exclude:
+    - .gitignore
+    - .rspec
+    - .rubocop.yml
+
+    - Gemfile.lock
+    - CHANGELOG.md
+    - LICENSE.txt
+    - README.md
+
+    - script/**/*
+    - vendor/**/*

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# master
+
+# 0.1.0 / 2020-05-01
+
+* First version
+* Supports hosting a Notable data directory in `src/`, such that `src/notes` holds note entries, and `src/attachments` holds attachments.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]

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,71 @@
+# Notable for Bridgetown
+
+A Bridgetown plugin to host notes and attachments from [Notable](https://notable.app/), a markdown-based editor.
+
+## Installation
+
+Run this command to add this plugin to your site's Gemfile:
+
+```shell
+$ bundle add bridgetown-notable -g bridgetown_plugins
+```
+
+## Usage
+
+Currently supports hosting a single Notable data directory at `src/`, such that `src/notes` holds note entries, and `src/attachments` holds attachments.
+
+Requires a bit of setup in bridgetown.config.yml:
+
+```yaml
+defaults:
+  - scope:
+      path: notes/
+    values:
+      notable: true
+      layout: notable
+```
+
+By setting `notable: true` on pages, this plugin will:
+
+- format `[[wikilinks]]` between Notable pages, with `<a class="wikilink"` to hook in styles if desired
+- update markdown links/images from `@attachment` to a path Bridgetown can find
+- track backlinks in `page.backlinks` if that's your thing
+
+You can specify any layout you want, it's provided a `page` object like any other.
+
+<!-- 
+### 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.
+
+… None yet -->
+
+## Testing
+
+* Run `bundle exec rspec` to run the test suite
+* Or run `script/cibuild` to validate with Rubocop and test with rspec together.
+
+## Contributing
+
+1. Fork it (https://github.com/jamie/bridgetown-notable/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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bridgetown-notable.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-notable/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-notable"
+  spec.version       = BridgetownNotable::VERSION
+  spec.author        = "Jamie Macey"
+  spec.email         = "jamie.git@tracefunc.com"
+  spec.summary       = "Plugin to host a Notable data directory"
+  spec.homepage      = "https://github.com/jamie/bridgetown-notable"
+  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!^spec/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.add_dependency "bridgetown", ">= 0.15", "< 2.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-bridgetown", "~> 0.2"
+end

data/lib/bridgetown-notable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+require "bridgetown-notable/builder"
+
+Bridgetown::PluginManager.new_source_manifest(
+  origin: BridgetownNotable,
+  components: File.expand_path("../components", __dir__),
+  content: File.expand_path("../content", __dir__),
+  layouts: File.expand_path("../layouts", __dir__)
+)

data/lib/bridgetown-notable/builder.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module BridgetownNotable
+  class Builder < Bridgetown::Builder
+    LINK_PATTERN = %r!\[\[([^\]]+)\]\]!.freeze
+
+    def build
+      generator :attachments
+      generator :backlinks
+      generator :wikilinks
+    end
+
+    def attachments
+      notable_pages.each do |page|
+        page.content.gsub!("(@attachment/", "(/attachments/")
+      end
+    end
+
+    def backlinks
+      notable_pages.each do |page|
+        pagename = page.data[:title]
+        backlinks = site.pages.select { |pg| pg.content =~ %r!\[\[#{pagename}\]\]!i }
+        page.data[:backlinks] = backlinks if backlinks.any?
+      end
+    end
+
+    def wikilinks
+      notable_pages.each do |page|
+        page.content.gsub!(LINK_PATTERN) do |match_string|
+          title = match_string.match(LINK_PATTERN)[1]
+          link = site.pages.detect { |pg| pg.data[:title] == title }
+          if link
+            %(<a href="#{link.url}" class="wikilink">#{link.data[:title]}</a>)
+          else
+            title
+          end
+        end
+      end
+    end
+
+    private
+
+    def notable_pages
+      site.pages.select { |page| notable?(page) }
+    end
+
+    def notable?(page)
+      page.data[:notable]
+    end
+  end
+end
+
+BridgetownNotable::Builder.register

data/lib/bridgetown-notable/version.rb

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

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-notable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Macey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.15'
+    - - "<"
+      - !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: nokogiri
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email: jamie.git@tracefunc.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bridgetown-notable.gemspec
+- content/template/.keep
+- lib/bridgetown-notable.rb
+- lib/bridgetown-notable/builder.rb
+- lib/bridgetown-notable/version.rb
+homepage: https://github.com/jamie/bridgetown-notable
+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.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Plugin to host a Notable data directory
+test_files: []