satanic_pages 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 987d127931d6e1d4de5d33ca3f32152548398400f15b98f44b7cc2d4ce0c8a1e
-  data.tar.gz: 8ed37d65b7f3d28fc15a2cb3ac5c8a70622c9e6e477776e89e5bc034e3b9f6b3
+  metadata.gz: d7f12bb06b37c9fb4c72dd76b00d111ab35f58dde16ff29f41e0350d8804d63b
+  data.tar.gz: 73ef5b7324c50858573da13826bcda8d78b25bb67095a155a080b78cfdd95cec
 SHA512:
-  metadata.gz: 32a1ba9449540998e948cafeb851c7147116f2283803c47e9c2af158b99a4fad2c9be5a3c9e64fde362eac3ef4ecec45774e4acb49a52f55d72f0b3e194dec8b
-  data.tar.gz: 696de60cfd8b96e8988260f1c53892d6f2b38054348eb17e898cc64fae83ea3888d5ac8bbebc0b87973a00e6ebfc7e16b990658ddaa2963fc28058109f094d8b
+  metadata.gz: 3cb2f5dbba04939875fa95820be43e2b77a83533f6c40c1829be5830626589383be67f9eaccfe2e84c9c7e6a34826537ede83623913c43baa49ca9481d3b0fb8
+  data.tar.gz: bdc640c0ca7eb05ad61d2add08038cdf34ac03a236683bbc8a278008c710e4be0895aede818cd4adfab02820ec51c19f02e9d09c9e3b6316c123f63c1bf5066e

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,7 +32,7 @@ In `app/views/layouts/pages.html.erb`:
 
 ```ruby
 <%= render_layout "application" do %>
-  <h1><%= current_page.title %></h1>
+  <h1><%= data.title %></h1>
   <article>
     <%= yield %>
   </article>
@@ -44,7 +44,7 @@ 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

@@ -3,7 +3,7 @@ module SatanicPages
     extend ActiveSupport::Concern
 
     included do
-      helper_method :current_page
+      helper_method :data
     end
 
     class_methods do
@@ -17,37 +17,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/layout_helper.rb

@@ -0,0 +1,9 @@
+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

@@ -15,7 +15,7 @@ module SatanicPages
 
       data = OpenStruct.new(frontmatter)
 
-      render(inline: content, handler: :erb, locals: {current_page: data})
+      render(inline: content, handler: :erb, locals: {data:})
         # Remove template comments
         .gsub(/<!-- (BEGIN|END) (.*) -->/, "")
         # Force HTML tags to be inline

data/lib/satanic_pages/page.rb

@@ -16,8 +16,6 @@ module SatanicPages
 
     attr_reader :slug, :path, :full_path, :content, :data
 
-    delegate_missing_to :data
-
     private
 
     def parse!

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,12 @@
+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,3 @@
 module SatanicPages
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/satanic_pages.rb

@@ -1,8 +1,13 @@
+require "markdown-rails"
+
 require "satanic_pages/version"
-require "satanic_pages/engine"
+require "satanic_pages/railtie"
 
 require "satanic_pages/page"
 require "satanic_pages/page_list"
 
+require "satanic_pages/controller"
+require "satanic_pages/layout_helper"
+
 module SatanicPages
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: satanic_pages
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Mikkel Malmberg
@@ -37,6 +37,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
+- !ruby/object:Gem::Dependency
+  name: markdown-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
 description: An embeddable static pages engine for Rails apps and the devil
 email:
 - mikkel@brnbw.com
@@ -47,13 +61,13 @@ 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/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,26 +0,0 @@
-module SatanicPages
-  class Engine < ::Rails::Engine
-    initializer("satanic_pages.view_helpers") do
-      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