satanic_pages 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e26a94d425f4b9aa926dd89feea4090734e63e94e62f792fb4d13db1eb6b6ea8
-  data.tar.gz: aa60e1b98f09c40cfcf8be3d4e334624849b36ca2c201d41b5e3776d5af4f4b4
+  metadata.gz: 4c0ba138a00f4ba596ba407c0609e62f415cb0e89b570097fd87ae8f04040da1
+  data.tar.gz: 12bb35a382f16e9118d2ecc327844dfee1729ae88ca34f78852870168bb900b7
 SHA512:
-  metadata.gz: 3b2fb33c968a61afb5067c1fea752548ea873c4392d23bca8e965cabf6c9de9ea40ac4e672eb2e0a951cd6f132f40fb6c9627ef35401f6ee0929f0831cbf371d
-  data.tar.gz: 3a02d1ca797597f20a8825e8242052047a9eb33e89ac434eced2dfbbac7f920f155825c7e06d491af7fffc8ef9b42871a098cba049b3b26b4cac8d1966a8e744
+  metadata.gz: 8bf85437c0980b47b39f2b8c13bfd6225e463520d94c80d7df45544cc5ac6cdf8f1aea921cbf88f5ebd139c48931a3d1477ab571f0e4c12e0472bf77a18b2679
+  data.tar.gz: 8d94f595ed06305b1e886ba1cb4085fe5e98b1b10369bdb219ed6fb66b5c8779d36fe4b70186d91286e0deee213f6f1bc4b3423665b4237a5c71060de2433587

data/README.md

@@ -1,6 +1,6 @@
 <center><img src="https://s3.brnbw.com/Artboard-GDaMBcpYEJ.png" alt="Satanic Pages" width=762 /></center>
 
-Static pages with YAML frontmatter, embedded in your Rails app.
+Static Markdown pages with YAML frontmatter and inline Erb, embedded in your Rails app.
 
 As simple as, …  
 **`app/views/pages/exorcism_tips.html.md`:**
@@ -14,12 +14,12 @@ tags:
 - devil worship
 - activity ideas
 ---
-By <%= current_page.author %>.
+By <%= data.author %>.
 
 Through trial and error, I've found that the perfect exorcism
 starts with a refreshing drink.
 
-Tagged <%= render "tag_list", tags: current_page.tags %>:
+Tagged <%= render "tag_list", tags: data.tags %>:
 
 ## Devilishly good lemonade recipe
 
@@ -32,19 +32,41 @@ In `app/views/layouts/pages.html.erb`:
 
 ```ruby
 <%= render_layout "application" do %>
-  <h1><%= current_page.title %></h1>
+  <h1><%= data.title %></h1>
   <article>
     <%= yield %>
   </article>
 <% 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:
 
 ```sh
 $ bundle add satanic_pages
-$ bundle add markdown-rails # optional, but probably
+$ bundle install
 ```
 
 Add the _Concern_ to a regular controller:

data/{app/controllers/concerns → lib}/satanic_pages/controller.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module SatanicPages
   module Controller
     extend ActiveSupport::Concern
 
     included do
-      helper_method :current_page
+      helper_method :data
     end
 
     class_methods do
@@ -17,37 +19,28 @@ module SatanicPages
     end
 
     def show
-      @test = "wut"
       render_static_page
     end
 
     private
 
-    def slug_param
-      params.require(:page)
-    end
-
-    def pages
-      self.class.pages
+    def render_static_page
+      # For nested pages, we need to render the template directly using its full path
+      # Construct the template path based on the controller's view path and the page path
+      template_path = "#{controller_path}/#{current_page.path}"
+      render(template: template_path)
     end
 
     def current_page
-      pages.find(slug_param)
+      @page ||= self.class.pages.find(slug_param)
     end
 
-    # Bit of a hack here. As Rails resolves the layout pretty late, there's no
-    # public way of looking it up at this point.
-    # We do however control the rendering, probably, so the only thing we check
-    # for is if the controller class has called self.layout.
-    def page_layout
-      self.class._layout || "application"
+    def slug_param
+      params.require(:page)
     end
 
-    def render_static_page
-      # For nested pages, we need to render the template directly using its full path
-      # Construct the template path based on the controller's view path and the page path
-      template_path = "#{controller_path}/#{current_page.path}"
-      render(template: template_path)
+    def data
+      current_page&.data
     end
   end
 end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SatanicPages
+  module LayoutHelper
+    # Thank you Sitepress for this lil' goodie
+    # https://github.com/sitepress/sitepress/blob/738aae7eaef61b494ad90786bc9f796374088ee1/sitepress-server/rails/app/helpers/application_helper.rb#L18
+    def render_layout(layout, **kwargs, &block)
+      render(html: capture(&block), layout: "layouts/#{layout}", **kwargs)
+    end
+  end
+end

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: {current_page: 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)
@@ -16,8 +14,6 @@ module SatanicPages
 
     attr_reader :slug, :path, :full_path, :content, :data
 
-    delegate_missing_to :data
-
     private
 
     def parse!
@@ -30,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/page_list.rb

@@ -5,8 +5,8 @@ module SatanicPages
     class PageNotFound < StandardError
     end
 
-    def initialize(ctrl)
-      @base_path = Rails.root.join("app/views/", ctrl)
+    def initialize(controller_name)
+      @base_path = Rails.root.join("app/views/", controller_name)
 
       @pages = Dir[base_path + "**/*.html*"]
         .reject { |path| path.match?(/(^_|\/_)/) }
@@ -18,12 +18,18 @@ module SatanicPages
 
     attr_reader :base_path, :pages
 
-    def find(path)
+    def find!(path)
       @pages.fetch(path)
     rescue KeyError
       raise PageNotFound, "No page `#{path}' found at #{base_path}"
     end
 
+    def find(path)
+      find!(path)
+    rescue PageNotFound
+      nil
+    end
+
     def match?(req_path)
       path = req_path.gsub(/^\//, "")
       pages.keys.include?(path)

data/lib/satanic_pages/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SatanicPages
+  class Railtie < ::Rails::Railtie
+    initializer("satanic_pages.view_helpers") do
+      ActiveSupport.on_load(:action_view) { include SatanicPages::LayoutHelper }
+    end
+
+    initializer("satanic_pages.register_markdown") do
+      require "satanic_pages/markdown_template_handler"
+
+    end
+  end
+end

data/lib/satanic_pages/version.rb

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

data/lib/satanic_pages.rb

@@ -1,6 +1,13 @@
+# frozen_string_literal: true
+
+require "markdown-rails"
+
 require "satanic_pages/version"
-require "satanic_pages/engine"
+require "satanic_pages/railtie"
 
+require "satanic_pages/controller"
+require "satanic_pages/frontmatter"
+require "satanic_pages/layout_helper"
 require "satanic_pages/page"
 require "satanic_pages/page_list"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: satanic_pages
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Mikkel Malmberg
@@ -10,33 +10,33 @@ cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ostruct
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '7'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: markdown-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '2'
 description: An embeddable static pages engine for Rails apps and the devil
 email:
 - mikkel@brnbw.com
@@ -47,13 +47,14 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/controllers/concerns/satanic_pages/controller.rb
-- app/helpers/satanic_pages/layout_helper.rb
 - lib/satanic_pages.rb
-- lib/satanic_pages/engine.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
 - lib/satanic_pages/page_list.rb
+- lib/satanic_pages/railtie.rb
 - lib/satanic_pages/version.rb
 homepage: https://github.com/mikker/satanic_pages
 licenses:

data/app/helpers/satanic_pages/layout_helper.rb

@@ -1,7 +0,0 @@
-module SatanicPages::LayoutHelper
-  # Thank you Sitepress for this lil' goodie
-  # https://github.com/sitepress/sitepress/blob/738aae7eaef61b494ad90786bc9f796374088ee1/sitepress-server/rails/app/helpers/application_helper.rb#L18
-  def render_layout(layout, **kwargs, &block)
-    render(html: capture(&block), layout: "layouts/#{layout}", **kwargs)
-  end
-end

data/lib/satanic_pages/engine.rb

@@ -1,27 +0,0 @@
-module SatanicPages
-  class Engine < ::Rails::Engine
-    initializer("satanic_pages.view_helpers") do
-      require_relative "../../app/helpers/satanic_pages/layout_helper"
-      ActiveSupport.on_load(:action_view) { include SatanicPages::LayoutHelper }
-    end
-
-    initializer("satanic_pages.register_markdown") do
-      if has_markdown_rails?
-        require "satanic_pages/markdown_template_handler"
-
-      end
-    end
-
-    private
-
-    def has_markdown_rails?
-      return true if defined?(MarkdownRails)
-
-      require "markdown-rails"
-
-      true
-    rescue LoadError
-      false
-    end
-  end
-end