decant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14dd6a76377d655591855a2f8346fecdb9e771baa8645637fa6a6a0029ad2e36
+  data.tar.gz: 0f546e42c17ae806f44a7ea1ef1164f2de7d5aca03fef4a365e2566f7a46204e
+SHA512:
+  metadata.gz: 108a666e9621a0ff56cdebe935a9eb8e2bd62e932005ec324431d314ac1e573972b314836f37cf4c1b5de9c1b8542027f46e018cd3bedbaf7ba4514cdeb461df
+  data.tar.gz: 289c4a5fa4a02cd47487e2da069d85b1f8b4f7a878fa940f62d45eaf25c4d9a6d14090d43323d0412c0ba5d8c6fbbe17a78587c1a2765434241f43252143ac2e

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## Version 0.1.0 - 2024-08-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Ben Pickles
+
+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,64 @@
+# Decant
+
+[![Ruby](https://github.com/benpickles/decant/actions/workflows/main.yml/badge.svg)](https://github.com/benpickles/decant/actions/workflows/main.yml)
+
+A frontmatter-aware wrapper around a directory of static content.
+
+## Installation
+
+Add Decant to your application's Gemfile and run `bundle install`.
+
+```ruby
+gem 'decant'
+```
+
+## Usage
+
+Define a Decant class pointing to a directory of files and add your own methods.
+
+```ruby
+Page = Decant.define(dir: '_pages', ext: 'md') do
+  # Declare frontmatter convenience readers.
+  frontmatter :title
+
+  # Add custom methods - it's a standard Ruby class.
+  def html
+    # Decant doesn't know about Markdown etc so you should bring your own.
+    Kramdown::Document.new(content).to_html
+  end
+end
+```
+
+Given a file `_pages/about.md` with the following contents:
+
+```markdown
+---
+title: About
+stuff: nonsense
+---
+# About
+
+More words.
+```
+
+You can fetch a `Page` instance by `.find`ing it by its extension-less path within the directory.
+
+```ruby
+about = Page.find('about')
+about.content     # => "About\n\nMore words.\n"
+about.frontmatter # => {:title=>"About", :stuff=>"nonsense"}
+about.html        # => "<h1 id=\"about\">About</h1>\n\n<p>More words.</p>\n"
+about.title       # => "About"
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/benpickles/decant. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/benpickles/decant/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Decant project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/benpickles/decant/blob/main/CODE_OF_CONDUCT.md).

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/lib/decant/collection.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'pathname'
+
+module Decant
+  class Collection
+    attr_reader :dir, :ext
+
+    def initialize(dir:, ext: nil)
+      self.dir = dir
+      self.ext = ext
+    end
+
+    def dir=(value)
+      @dir = Pathname.new(value)
+    end
+
+    def entries
+      glob("**/*#{ext}")
+    end
+
+    def ext=(value)
+      if value
+        @ext = value.start_with?('.') ? value : ".#{value}"
+      else
+        @ext = value
+      end
+    end
+
+    def find(path)
+      pattern = "#{path}#{ext}"
+      glob(pattern).first
+    end
+
+    def glob(pattern)
+      dir.glob(pattern).select { |path| path.file? }
+    end
+  end
+end

data/lib/decant/content_methods.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require_relative 'errors'
+
+module Decant
+  module ContentMethods
+    attr_reader :collection
+
+    def all
+      collection.entries.map { |path| new(path) }
+    end
+
+    def find(pattern)
+      path = collection.find(pattern)
+      raise FileNotFound, %(Couldn't find "#{pattern}" in "#{collection.dir}") unless path
+      new(path)
+    end
+
+    def frontmatter(*attrs)
+      attrs.each do |name|
+        define_method name do
+          frontmatter&.[](name.to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/decant/errors.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module Decant
+  Error = Class.new(StandardError)
+  FileNotFound = Class.new(Error)
+end

data/lib/decant/file.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+require_relative 'frontmatter'
+
+module Decant
+  class File
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def content
+      frontmatter_content[1]
+    end
+
+    def frontmatter
+      frontmatter_content[0]
+    end
+
+    def frontmatter?(key = nil)
+      return false if frontmatter.nil?
+      key ? frontmatter.key?(key) : true
+    end
+
+    def read
+      path.read
+    end
+
+    private
+      def frontmatter_content
+        @frontmatter_content ||= Frontmatter.load(read)
+      end
+  end
+end

data/lib/decant/frontmatter.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require 'strscan'
+require 'yaml'
+
+module Decant
+  module Frontmatter
+    def self.load(input)
+      return [nil, input] unless input.start_with?("---\n")
+
+      scanner = StringScanner.new(input)
+      scanner.skip("---\n")
+      scanner.skip_until(/^---$\n?/)
+      yaml = scanner.pre_match
+
+      return [nil, input] unless yaml
+
+      [
+        YAML.safe_load(yaml, symbolize_names: true) || {},
+        scanner.post_match
+      ]
+    end
+  end
+end

data/lib/decant/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Decant
+  VERSION = '0.1.0'
+end

data/lib/decant.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require_relative 'decant/collection'
+require_relative 'decant/content_methods'
+require_relative 'decant/file'
+require_relative 'decant/version'
+
+module Decant
+  def self.define(dir:, ext: nil, &block)
+    Class.new(File) do
+      extend ContentMethods
+      @collection = Collection.new(dir: dir, ext: ext)
+      class_eval(&block) if block_given?
+    end
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: decant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben Pickles
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-11 00:00:00.000000000 Z
+dependencies: []
+description: A frontmatter-aware wrapper around a directory of static content
+email:
+- spideryoung@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/decant.rb
+- lib/decant/collection.rb
+- lib/decant/content_methods.rb
+- lib/decant/errors.rb
+- lib/decant/file.rb
+- lib/decant/frontmatter.rb
+- lib/decant/version.rb
+homepage: https://github.com/benpickles/decant
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/benpickles/decant
+  source_code_uri: https://github.com/benpickles/decant
+  changelog_uri: https://github.com/benpickles/decant/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+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.17
+signing_key:
+specification_version: 4
+summary: A frontmatter-aware wrapper around a directory of static content
+test_files: []