decant 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff0fe21b57ea4db012b2cedce3a14b6e8b34186a85071525949431524f0cdc4b
-  data.tar.gz: a6953eace2994504c734d002f8357aacb1b0563a6a31513684826888c7aefe59
+  metadata.gz: 90e12a57f5b2470e597cf6070cedd064bd26bb1680fa9e14a337a9ec8c712888
+  data.tar.gz: 9ebce2f4febbfa2449cf671ab75781463df89b37e63359320014710dd613baae
 SHA512:
-  metadata.gz: 66aee785137091d9a134161e3b45cd60b85e7e8d1d4f5a9a7601d4b389b83a1f408d0b08bd15460a101379c00137d568ee6070a699b28571dfaab6aea1a8ec40
-  data.tar.gz: fc536bc67d8a596add87ebb75ded2cd81bbbda22f93e0ae7b1b9e6de01fc46c5b565b83415a119bf4edf37552e36efc98ca91550784cfb91e54e0781e03decd7
+  metadata.gz: df551129f9cbf4222331f01cad5ddf4651fa631ad5a6d7b2fa2dc4f83f7f908e12d4c958278bf96a3e59d4e6cd019d788d6cc4b4fec7dfeb38fd439eb1cd724f
+  data.tar.gz: 351ffd284c342a388f324019d09c97bb19d8761b0f90457cb49aa4d855e54c1c2f5c54960303e4d30b82eb75876a3a2f25828e281df57f58954d7136528ebc77

data/CHANGELOG.md

@@ -1,8 +1,12 @@
 # CHANGELOG
 
+## Version 0.3.0 - 2024-11-19
+
+- Add `Content#relative_path` which returns a file's relative path within its collection.
+
 ## Version 0.2.0 - 2024-10-13
 
-- Add support for a content instance knowing its own `#slug` - its relative path within its collection:
+- Add support for a content instance knowing its own `#slug` - its extension-less relative path within its collection:
 
   ```ruby
   Page = Decant.define(dir: 'content', ext: 'md')

data/README.md

@@ -2,7 +2,7 @@
 
 [![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.
+A dependency-free frontmatter-aware framework-agnostic wrapper around a directory of static content.
 
 ## Installation
 

data/lib/decant/collection.rb

@@ -44,13 +44,22 @@ module Decant
       dir.glob("#{pattern}#{ext}").select { |path| path.file? }
     end
 
+    # The relative path of +path+ within {#dir}.
+    #
+    # @param path [Pathname]
+    #
+    # @return [String]
+    def relative_path_for(path)
+      path.relative_path_from(dir).to_s
+    end
+
     # The extension-less relative path of +path+ within {#dir}.
     #
     # @param path [Pathname]
     #
     # @return [String]
     def slug_for(path)
-      relative_path = path.relative_path_from(dir).to_s
+      relative_path = relative_path_for(path)
 
       # The collection has no configured extension, files are identified by
       # their full (relative) path so there's no extension to remove.

data/lib/decant/content.rb

@@ -49,6 +49,20 @@ module Decant
       end
     end
 
+    # The relative path of the file within its collection.
+    #
+    # @example
+    #   Page = Decant.define(dir: 'content', ext: 'md')
+    #
+    #   page = Page.find('features/slugs')
+    #   page.path.expand_path # => "/Users/dave/my-website/content/features/slugs.md"
+    #   page.relative_path    # => "features/slugs.md"
+    #
+    # @return [String]
+    def relative_path
+      self.class.collection.relative_path_for(path)
+    end
+
     # The extension-less relative path of the file within its collection.
     #
     # @example

data/lib/decant/version.rb

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

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: decant
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Pickles
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-13 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies: []
-description: A frontmatter-aware wrapper around a directory of static content
+description: A dependency-free frontmatter-aware framework-agnostic wrapper around
+  a directory of static content
 email:
 - spideryoung@gmail.com
 executables: []
@@ -57,5 +58,6 @@ requirements: []
 rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
-summary: A frontmatter-aware wrapper around a directory of static content
+summary: A dependency-free frontmatter-aware framework-agnostic wrapper around a directory
+  of static content
 test_files: []