satanic_pages 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f33a12b44515dc388c1cf2f447c90d52439100f89d21b2c2657b4de2ec99d34
-  data.tar.gz: 3868dd61e1dd7b994870cfa03c593f5a35c365fdcf91cd4b8264a7f9f5f962c7
+  metadata.gz: 27039023737b744f359ee8ecff3085761338d9a7418220cf37657fe84572402e
+  data.tar.gz: 285411e1a9e1360bf16231ec4077940e15981848485efe1d1540863497d38282
 SHA512:
-  metadata.gz: 5eca5f6ab90383fd669e518fb2575d39af1faa4eb6b4f4369c6afd46a772f1bfb9f3bb0215df0d99ce5c49155f57bb6b9142d453667a7dd29880d477dee21ae1
-  data.tar.gz: 9bac938b82e0aec3f5cb1443bad6c8cc97318973d49f5bfb0f797a5dfdf21ffb7610c8473df2d2f8958ca4e7ef4e3fedcfa8e31f08003ff96de4464d42bd4937
+  metadata.gz: 240fc63f3d3ef88e0e6fab247ba49ebf742acc4f7bc4df6ec7d735973bc898fadd039c480d18b269de0e3e7f25776e79e6f88ddf407cbaf78ed798beadf7875e
+  data.tar.gz: 5c9a82247c92fb5ff4bff9ee5916debd5f9487c02afc365b4439d1955c42903da295d2253efef2b38e0a850e120d2602f8f2b3428ed083cb05baf400a4eca8f5

data/README.md

@@ -1,28 +1,65 @@
-# SatanicPages
-Short description and motivation.
+<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.
+
+As simple as, …  
+**`app/views/pages/exorcism_tips.html.md`:**
+
+```markdown
+---
+title: 3 tips for the PERFECT exorcism
+author: Beelzebub
+tags:
+- listicles
+- devil worship
+- activity ideas
+---
+By <%= current_page.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 %>:
+
+## Devilishly good lemonade recipe
+
+…
+```
 
 ## Usage
-How to use my plugin.
 
-## Installation
-Add this line to your application's Gemfile:
+In `app/views/layouts/pages.html.erb`:
 
 ```ruby
-gem "satanic_pages"
+<%= render_layout "application" do %>
+  <h1><%= current_page.title %></h1>
+  <article>
+    <%= yield %>
+  </article>
+<% end %>
 ```
 
-And then execute:
-```bash
-$ bundle
+## Installation
+Add this line to your application's Gemfile:
+
+```sh
+$ bundle add satanic_pages
+$ bundle add markdown-rails # optional, but probably
 ```
 
-Or install it yourself as:
-```bash
-$ gem install satanic_pages
+Add the _Concern_ to a regular controller:
+
+```ruby
+class PagesController < ApplicationController
+  include SatanicPages::Controller
+end
 ```
 
-## Contributing
-Contribution directions go here.
+And set up a wildcard route:
+
+```ruby
+get("*page", to: "pages#show", as: :page, constraints: PagesController.constraint)
+```
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+[MIT](https://opensource.org/licenses/MIT)

data/app/controllers/concerns/satanic_pages/controller.rb

@@ -0,0 +1,50 @@
+module SatanicPages
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :current_page
+    end
+
+    class_methods do
+      def constraint
+        -> (req) { pages.match?(req.path) }
+      end
+
+      def pages
+        @pages ||= PageList.new(controller_name)
+      end
+    end
+
+    def show
+      @test = "wut"
+      render_static_page
+    end
+
+    private
+
+    def slug_param
+      params.require(:page)
+    end
+
+    def pages
+      self.class.pages
+    end
+
+    def current_page
+      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"
+    end
+
+    def render_static_page
+      render(current_page.slug)
+    end
+  end
+end

data/app/helpers/satanic_pages/layout_helper.rb

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

data/lib/satanic_pages/markdown_template_handler.rb

@@ -0,0 +1,29 @@
+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)
+
+      render(inline: content, handler: :erb, locals: {current_page: data})
+        # Remove template comments
+        .gsub(/<!-- (BEGIN|END) (.*) -->/, "")
+        # Force HTML tags to be inline
+        .gsub(/<[^>]*?>/) { |tag| tag.gsub(/\n\s*/, " ") }
+    end
+  end
+end
+
+MarkdownRails.handle(:md) do
+  SatanicPages::MarkdownTemplateHandler.new
+end

data/lib/satanic_pages/page.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module SatanicPages
+  class Page
+    def initialize(full_path)
+      @full_path = full_path
+      @slug = nil
+      @content = nil
+      @data = nil
+      parse!
+    end
+
+    attr_reader :slug, :full_path, :content, :data
+
+    delegate_missing_to :data
+
+    private
+
+    def parse!
+      @slug = File
+        .basename(full_path)
+        .gsub(/(\.\w+)+$/, "")
+
+      @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}")
+          @data = OpenStruct.new
+          $&
+        end
+      end
+    end
+  end
+end

data/lib/satanic_pages/page_list.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SatanicPages
+  class PageList
+    class PageNotFound < StandardError
+    end
+
+    def initialize(ctrl)
+      @base_path = Rails.root.join("app/views/", ctrl)
+
+      @pages = Dir[base_path + "**/*.html*"]
+        .reject { |path| path.match?(/(^_|\/_)/) }
+        .each_with_object({}) do |full_path, hash|
+          page = Page.new(full_path)
+          hash[page.slug] = page
+        end
+    end
+
+    attr_reader :base_path, :pages
+
+    def find(slug)
+      @pages.fetch(slug)
+    rescue KeyError
+      raise PageNotFound, "No page `#{slug}' found at #{base_path}"
+    end
+
+    def match?(path)
+      path = path.gsub(/^\//, "")
+      pages.keys.include?(path)
+    end
+  end
+end

data/lib/satanic_pages/version.rb

@@ -1,3 +1,3 @@
 module SatanicPages
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/satanic_pages.rb

@@ -1,6 +1,8 @@
 require "satanic_pages/version"
 require "satanic_pages/engine"
 
+require "satanic_pages/page"
+require "satanic_pages/page_list"
+
 module SatanicPages
-  # Your code goes here...
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: satanic_pages
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Mikkel Malmberg
@@ -9,6 +9,20 @@ 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
@@ -33,11 +47,14 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- config/routes.rb
+- 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/markdown_template_handler.rb
+- lib/satanic_pages/page.rb
+- lib/satanic_pages/page_list.rb
 - lib/satanic_pages/version.rb
-- lib/tasks/satanic_pages_tasks.rake
 homepage: https://github.com/mikker/satanic_pages
 licenses:
 - MIT

data/config/routes.rb

@@ -1,2 +0,0 @@
-Rails.application.routes.draw do
-end

data/lib/tasks/satanic_pages_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :satanic_pages do
-#   # Task goes here
-# end