jekyll-sheafy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d4d015eba5703cb9cc20923e78d52aa6e34581793348d3283e2652f375947d4
+  data.tar.gz: 87eb2cde0952ff0887a711d6c00d93101f3b67072953946cdcdbfaa196f8a58a
+SHA512:
+  metadata.gz: e193c3aefb25940bb7d905bca9cb6090a9b2c64614f589eeaf7366299768ef79895dff96966c52f18abe3fb281f2404e207f89582eb05da173a30207d0ca0795
+  data.tar.gz: 3f8a4517fd4c1e5dcc7fbb3a6cbe4c56e3b9512607756ca66f2f7d951a63185d4152266ec6c274eb69c11e935dd5a5e7aefac5e0d73c4b8ec6b0be9ddf9d044c

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# 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] - 2022-01-28
+
+### Added
+
+- Structure to represent directed graphs.
+- Topological checks for rooted forests.
+
+[unreleased]: https://github.com/paolobrasolin/jekyll-sheafy/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/paolobrasolin/jekyll-sheafy/releases/tag/0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Paolo Brasolin
+
+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,42 @@
+# jekyll-sheafy
+
+[![CI tests status badge][build-shield]][build-url]
+[![Latest release badge][rubygems-shield]][rubygems-url]
+[![License badge][license-shield]][license-url]
+[![Maintainability badge][cc-maintainability-shield]][cc-maintainability-url]
+[![Test coverage badge][cc-coverage-shield]][cc-coverage-url]
+
+[build-shield]: https://img.shields.io/github/workflow/status/paolobrasolin/jekyll-sheafy/CI/main?label=tests&logo=github
+[build-url]: https://github.com/paolobrasolin/jekyll-sheafy/actions/workflows/main.yml "CI tests status"
+[rubygems-shield]: https://img.shields.io/gem/v/jekyll-sheafy?logo=ruby
+[rubygems-url]: https://rubygems.org/gems/jekyll-sheafy "Latest release"
+[license-shield]: https://img.shields.io/github/license/paolobrasolin/jekyll-sheafy
+[license-url]: https://github.com/paolobrasolin/jekyll-sheafy/blob/main/LICENSE "License"
+[cc-maintainability-shield]: https://img.shields.io/codeclimate/maintainability/paolobrasolin/jekyll-sheafy?logo=codeclimate
+[cc-maintainability-url]: https://codeclimate.com/github/paolobrasolin/jekyll-sheafy "Maintainability"
+[cc-coverage-shield]: https://img.shields.io/codeclimate/coverage/paolobrasolin/jekyll-sheafy?logo=codeclimate&label=test%20coverage
+[cc-coverage-url]: https://codeclimate.com/github/paolobrasolin/jekyll-sheafy/coverage "Test coverage"
+
+`jekyll-sheafy` is a [Jekyll][jekyll-url] plugin inspired by [Gerby][gerby-url] which allows you to setup websites similar to [the Stacks project][stacks-url] and [Kerodon][kerodon-url].
+
+## Getting started
+
+TODO
+
+## Usage
+
+TODO
+
+## Roadmap
+
+TODO
+
+## Acknowledgements
+
+- Thanks to [@jonsterling](https://github.com/jonsterling) for [having the idea][math-url] and letting me collaborate and spin it off.
+
+[jekyll-url]: https://jekyllrb.com/
+[math-url]: https://github.com/jonsterling/math
+[gerby-url]: https://gerby-project.github.io/
+[stacks-url]: https://stacks.math.columbia.edu/
+[kerodon-url]: https://kerodon.net/

data/lib/jekyll/sheafy/directed_graph.rb

@@ -0,0 +1,87 @@
+require "tsort"
+
+module Jekyll
+  module Sheafy
+    class DirectedGraph < Hash
+      class PayloadError < StandardError
+        attr_reader :payload
+
+        def initialize(payload)
+          @payload = payload
+          super
+        end
+      end
+
+      class MissingKeysError < PayloadError; end
+      class InvalidValuesError < PayloadError; end
+      class MultipleEdgesError < PayloadError; end
+      class LoopsError < PayloadError; end
+      class CyclesError < PayloadError; end
+      class IndegreeError < PayloadError; end
+
+      def ensure_rooted_forest!
+        ensure_valid!
+        ensure_simple!
+        ensure_acyclic!
+        ensure_transposed_pseudoforest!
+      end
+
+      def ensure_valid!
+        invalid_values = values.reject { |v| v.is_a? Array }
+        raise InvalidValuesError.new(invalid_values) if invalid_values.any?
+        missing_keys = values.flat_map { |v| v - keys }.uniq
+        raise MissingKeysError.new(missing_keys) if missing_keys.any?
+      end
+
+      def ensure_simple!
+        multiple_edges =
+          transform_values { |cs| cs.tally.filter { |_, v| v > 1 }.keys }.
+            reject { |_, cs| cs.empty? }
+        raise MultipleEdgesError.new(multiple_edges) if multiple_edges.any?
+        loops = filter { |k, v| v.include?(k) }.keys.map { |k| [k, [k]] }.to_h
+        raise LoopsError.new(loops) if loops.any?
+      end
+
+      def ensure_acyclic!
+        cycles = TSort.strongly_connected_components(method(:tsort_each_node), method(:tsort_each_child)).reject(&:one?)
+        raise CyclesError.new(cycles) if cycles.any?
+      end
+
+      def ensure_transposed_pseudoforest!
+        # Note that
+        #   "transposed graph is a pseudoforest"
+        # = "transposed graph has outdegrees <= 1"
+        # = "graph has indegrees <= 1"
+        t_graph = self.class.transpose(self)
+        t_edges_from_high_outdeg = t_graph.filter { |_, ns| ns.size > 1 }
+        return if t_edges_from_high_outdeg.empty?
+        edges_to_high_indeg = self.class.transpose(t_edges_from_high_outdeg)
+        raise IndegreeError.new(edges_to_high_indeg)
+      end
+
+      def topologically_sorted
+        # TODO: cache tsort calculation
+        ensure_acyclic!
+        TSort.tsort(method(:tsort_each_node), method(:tsort_each_child))
+      end
+
+      def self.transpose(adjacency_list)
+        Hash.new { |h, k| h[k] = [] }.tap do |transposed_adjacency_list|
+          adjacency_list.each_pair do |parent, children|
+            children.each { |child| transposed_adjacency_list[child] << parent }
+          end
+        end
+      end
+
+      private
+
+      def tsort_each_node(&block)
+        each_key(&block)
+      end
+
+      def tsort_each_child(node, &block)
+        fetch(node).each(&block)
+      end
+    end
+  end
+end

data/lib/jekyll/sheafy/version.rb

@@ -0,0 +1,5 @@
+module Jekyll
+  module Sheafy
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll/sheafy.rb

@@ -0,0 +1 @@
+require "jekyll/sheafy/version"

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-sheafy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paolo Brasolin
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 11.1.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rufo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+description: This Jekyll plugin is heavily inspired by Gerby, the tool used to build
+  the Stacks Project and Kerodon. It allows you to build math textbooks as static
+  websites which require no complex infrastructure to run.
+email:
+- paolo.brasolin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/jekyll/sheafy.rb
+- lib/jekyll/sheafy/directed_graph.rb
+- lib/jekyll/sheafy/version.rb
+homepage: https://github.com/paolobrasolin/jekyll-sheafy
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/paolobrasolin/jekyll-sheafy/issues
+  changelog_uri: https://github.com/paolobrasolin/jekyll-sheafy/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/paolobrasolin/jekyll-sheafy#readme
+  homepage_uri: https://github.com/paolobrasolin/jekyll-sheafy
+  source_code_uri: https://github.com/paolobrasolin/jekyll-sheafy
+post_install_message:
+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.1.4
+signing_key:
+specification_version: 4
+summary: Brew your own Stacks Project with Jekyll!
+test_files: []