satanic_pages 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7f12bb06b37c9fb4c72dd76b00d111ab35f58dde16ff29f41e0350d8804d63b
-  data.tar.gz: 73ef5b7324c50858573da13826bcda8d78b25bb67095a155a080b78cfdd95cec
+  metadata.gz: 4c0ba138a00f4ba596ba407c0609e62f415cb0e89b570097fd87ae8f04040da1
+  data.tar.gz: 12bb35a382f16e9118d2ecc327844dfee1729ae88ca34f78852870168bb900b7
 SHA512:
-  metadata.gz: 3cb2f5dbba04939875fa95820be43e2b77a83533f6c40c1829be5830626589383be67f9eaccfe2e84c9c7e6a34826537ede83623913c43baa49ca9481d3b0fb8
-  data.tar.gz: bdc640c0ca7eb05ad61d2add08038cdf34ac03a236683bbc8a278008c710e4be0895aede818cd4adfab02820ec51c19f02e9d09c9e3b6316c123f63c1bf5066e
+  metadata.gz: 8bf85437c0980b47b39f2b8c13bfd6225e463520d94c80d7df45544cc5ac6cdf8f1aea921cbf88f5ebd139c48931a3d1477ab571f0e4c12e0472bf77a18b2679
+  data.tar.gz: 8d94f595ed06305b1e886ba1cb4085fe5e98b1b10369bdb219ed6fb66b5c8779d36fe4b70186d91286e0deee213f6f1bc4b3423665b4237a5c71060de2433587

data/README.md

@@ -39,6 +39,28 @@ In `app/views/layouts/pages.html.erb`:
 <% end %>
 ```
 
+Frontmatter is supplied as a struct like object.
+
+Given this frontmatter:
+
+```yaml
+---
+author: Beelzebub
+---
+```
+
+Use `!` and `?` method helpers for added strictness.
+
+```ruby
+data.author  # => "Beelzebub"
+data.author! # => "Beelzebub"
+data.author? # => true
+
+data.title   # => nil
+data.title!  # => raises SatanicPages::Frontmatter::MissingAttributeError
+data.title?  # => false
+```
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/lib/satanic_pages/controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SatanicPages
   module Controller
     extend ActiveSupport::Concern

data/lib/satanic_pages/frontmatter.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module SatanicPages
+  class Frontmatter
+    class MissingAttributeError < StandardError
+    end
+
+    def initialize(hash)
+      @hash = (hash&.with_indifferent_access || {}).freeze
+    end
+
+    def to_h
+      @hash
+    end
+
+    def method_missing(name, *args)
+      if name.to_s.end_with?("!")
+        attribute = name.to_s.chomp("!").to_sym
+
+        unless @hash[attribute]
+          raise MissingAttributeError, "Missing attribute: #{name.to_s.chomp("!")}"
+        end
+
+        @hash[attribute]
+
+      elsif name.to_s.end_with?("?")
+        @hash[name.to_s.chomp("?").to_sym].present?
+
+      else
+        @hash[name]
+      end
+    end
+
+    def self.parse(source)
+      frontmatter = nil
+
+      rest = source.gsub(/\A---\n(.*?)\n---\n/m) do
+        begin
+          frontmatter = YAML.safe_load($1)
+          ""
+        rescue => e
+          Rails.logger.error("Error parsing frontmatter: #{e.message}")
+          $&
+        end
+      end
+
+      [new(frontmatter), rest]
+    end
+  end
+end

data/lib/satanic_pages/layout_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SatanicPages
   module LayoutHelper
     # Thank you Sitepress for this lil' goodie

data/lib/satanic_pages/markdown_template_handler.rb

@@ -1,21 +1,11 @@
+# frozen_string_literal: true
+
 module SatanicPages
   class MarkdownTemplateHandler < MarkdownRails::Renderer::Rails
     def preprocess(source)
-      frontmatter = {}
-
-      content = source.gsub(/\A---\n(.*?)\n---\n/m) do
-        begin
-          frontmatter = YAML.safe_load($1)
-          ""
-        rescue => e
-          Rails.logger.error("Error parsing frontmatter: #{e.message}")
-          $&
-        end
-      end
-
-      data = OpenStruct.new(frontmatter)
+      frontmatter, rest = Frontmatter.parse(source)
 
-      render(inline: content, handler: :erb, locals: {data:})
+      render(inline: rest, handler: :erb, locals: {data: frontmatter})
         # Remove template comments
         .gsub(/<!-- (BEGIN|END) (.*) -->/, "")
         # Force HTML tags to be inline

data/lib/satanic_pages/page.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "ostruct"
-
 module SatanicPages
   class Page
     def initialize(full_path, base_path)
@@ -28,17 +26,7 @@ module SatanicPages
 
       @raw = File.read(full_path)
 
-      @content = @raw.gsub(/\A---\n(.*?)\n---\n/m) do
-        begin
-          @data = OpenStruct.new(YAML.safe_load($1))
-          nil
-        rescue => e
-          Rails.logger.error("Error parsing frontmatter: #{e.message}")
-          $&
-        end
-      end
-
-      @data ||= OpenStruct.new
+      @data, @content = Frontmatter.parse(@raw)
     end
   end
 end

data/lib/satanic_pages/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SatanicPages
   class Railtie < ::Rails::Railtie
     initializer("satanic_pages.view_helpers") do

data/lib/satanic_pages/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SatanicPages
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/satanic_pages.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 require "markdown-rails"
 
 require "satanic_pages/version"
 require "satanic_pages/railtie"
 
-require "satanic_pages/page"
-require "satanic_pages/page_list"
-
 require "satanic_pages/controller"
+require "satanic_pages/frontmatter"
 require "satanic_pages/layout_helper"
+require "satanic_pages/page"
+require "satanic_pages/page_list"
 
 module SatanicPages
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: satanic_pages
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mikkel Malmberg
@@ -9,20 +9,6 @@ bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: ostruct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -63,6 +49,7 @@ files:
 - Rakefile
 - lib/satanic_pages.rb
 - lib/satanic_pages/controller.rb
+- lib/satanic_pages/frontmatter.rb
 - lib/satanic_pages/layout_helper.rb
 - lib/satanic_pages/markdown_template_handler.rb
 - lib/satanic_pages/page.rb