frontmatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b817bbc36796c281dfd5a562485af0bb45697f3acc7a0e6249877a7ba54e9dfe
+  data.tar.gz: 598e0e890161b35709e0b008aa336bbf70f4179fbb870d884e97d5cbb1a820c2
+SHA512:
+  metadata.gz: c84eebe8e7bcc99be51ab952ea65ec6a68f43c75f762cd3fb13e702e6e903d67f15af0d70cf5f248b57acd9d77645fbbc99487528ff824e3bbaaaafd3dab6fd1
+  data.tar.gz: 04b496c4eb4319bb7d2e21c500312af903ee0d6f87b83347a581251c221ddb9380db5d44ffece3c8788d355d4542521bb3f07500ea5288312c4520052d374b01

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Caleb Hearth
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,118 @@
+# Frontmatter
+
+Frontmatter provides a Rails template handler for views ending in .yaml or .yml
+which contain "frontmatter" that is valid YAML contained between two sets of
+`---`, such as:
+
+    ---
+    author: Caleb Hearth
+    website: https://calebhearth.com
+    likes:
+    - Dogs
+    - Frontmatter
+    - Rails
+    dislikes:
+    - Beets
+    ---
+
+This frontmatter is parsed and made available as getter methods in a model you
+define per "collection" of views. This collection might be "posts" or "talks"
+and conceptually it can be considered similarly to an ActiveRecord::Base
+subclass, but with the view file as the data source rather than a database.
+
+## Usage
+
+A simple use case would be to import blog posts into Rails from a Jekyll site.
+The code to do that might look like the below. Note that the semantics are very
+familiar to anyone who's used Rails applications for similar purposes.
+
+### app/models/post.rb
+
+```ruby
+class Post < ActionPost::Base
+end
+```
+
+`ActionPost::Base` provides class-level "all" and "find(slug)" methods which
+list all pages and finds the first page matching the slug. It also extracts all
+frontmatter and provides it as getter methods such as `post.title`.
+
+### app/controllers/posts_controller.rb
+
+A controller is required, but there is no need to define the default actions.
+Default index and show actions are provided that list all posts (all files in
+app/views/posts with a .yaml or .yml extension) and finds posts based on their
+"slug" which is the filename without any extensions.
+
+```ruby
+class PostsController < Frontmatter::BaseController
+end
+```
+
+The ActionPost::Base subclass is inferred to be the singular of the  Controller's
+class name without "Controller", so `PostsController` would render `Post`
+objects and look for views in `app/views/posts`. The class-level `renders_page`
+method overrides this:
+
+```
+class PostsController < Frontmatter::BaseController
+  renders_page :blog_post # BlogPost objects / app/views/blog_posts views.
+end
+```
+
+### config/routes.rb
+
+```ruby
+resources :posts, only: %i(index show)
+```
+
+### app/views/posts/my-first-post.md.yaml
+
+This original Jekyll file would be called `_posts/2020-05-30-my-first-post.md`
+and would not have a date field in the frontmatter. That would need to be
+migrated manually or scripted. Date extraction from filename is not a feature of
+Frontmatter.
+
+```markdown
+
+---
+title: My First Post
+date: 2020-05-30
+---
+
+Look at all the things I'm not doing!
+```
+
+### app/views/posts/show.html.erb
+
+```erb
+<h1><%= @page.title %></h1>
+<aside><%= time_tag @post.date %></aside>
+<%= page_content @page %>
+```
+
+### app/views/posts/index.html.erb
+
+```erb
+<h1>My Posts</h1>
+<ul><% @posts.each do |post| %>
+  <li><%= link_to @post.title, post_path(@post) %></li>
+<% end %></ul>
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'frontmatter'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install frontmatter
+```

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Frontmatter'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/frontmatter_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/frontmatter .css

data/app/assets/stylesheets/frontmatter/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/frontmatter/pages_controller.rb

@@ -0,0 +1,36 @@
+module Frontmatter
+  class PagesController < ::ApplicationController
+    cattr_reader :page_class
+    helper Frontmatter::ApplicationHelper
+
+    def self.renders_page(page)
+      @@page_class = page
+    end
+
+    def self.page_class
+      @@page_class ||= begin
+       page_class = name.sub(/Controller\z/, '')
+       page_class.singularize.constantize
+       rescue NameError
+         raise #Frontmatter::MissingPageClass.new(page: page_class)
+       end
+    end
+
+    def initialize(*args)
+      super
+      append_view_path("app/views/#{self.class.page_class.view_key}")
+    end
+
+    def index
+      @pages = page_class.all
+    end
+
+    def show
+      @page = page_class.find(params[:id])
+      if @page.nil?
+        raise ActionController::RoutingError.new("Not Found")
+      end
+      render
+    end
+  end
+end

data/app/helpers/frontmatter/application_helper.rb

@@ -0,0 +1,7 @@
+module Frontmatter
+  module ApplicationHelper
+    def page_content(page)
+      controller.render_to_string("#{page.class.view_key}/#{page.slug}", layout: false)
+    end
+  end
+end

data/app/jobs/frontmatter/application_job.rb

@@ -0,0 +1,4 @@
+module Frontmatter
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/frontmatter/application_mailer.rb

@@ -0,0 +1,6 @@
+module Frontmatter
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/frontmatter/application_record.rb

@@ -0,0 +1,5 @@
+module Frontmatter
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/frontmatter/page.rb

@@ -0,0 +1,45 @@
+module Frontmatter
+  class Page
+    extend ActiveModel::Naming
+    attr_reader :slug
+
+    def self.all
+      Dir[pages_directory]
+        .reject { %w(index show).include? File.basename(_1.split('.')[0]) }
+        .map { |f| new(f) }
+    end
+
+    def self.find(slug)
+      all.find { _1.slug == slug }
+    end
+
+    def self.pages_directory
+      Rails.root.join("app", "views", view_key, '*.yaml').freeze
+    end
+
+    def initialize(filename)
+      @slug = File.basename(filename.split('.')[0])
+      @frontmatter = YAML.load(File.read(filename)).with_indifferent_access
+    end
+
+    # TODO: Define attribute methods to speed this up
+    def method_missing(m, *args, &block)
+      if value = @frontmatter[m]
+        return value
+      end
+      super
+    end
+
+    def respond_to_missing(m)
+      @frontmatter.key(m)
+    end
+
+    def to_param
+      slug
+    end
+
+    def self.view_key
+      model_name.route_key
+    end
+  end
+end

data/app/views/layouts/frontmatter/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Frontmatter</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag "frontmatter/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Frontmatter::Engine.routes.draw do
+end

data/lib/frontmatter.rb

@@ -0,0 +1,5 @@
+require "frontmatter/engine"
+require "frontmatter/template_handler"
+
+module Frontmatter
+end

data/lib/frontmatter/engine.rb

@@ -0,0 +1,15 @@
+module Frontmatter
+  class Engine < ::Rails::Engine
+    isolate_namespace Frontmatter
+    initializer "frontmatter.load" do
+      ActiveSupport.on_load :action_view do
+        ActionView::Template.register_template_handler(
+          # Accept all existing handlers with additional .yaml or .yml extension
+          *ActionView::Template.template_handler_extensions.flat_map { %W(#{_1}.yaml #{_1}.yml) },
+          :yml, :yaml,
+          Frontmatter::TemplateHandler
+        )
+      end
+    end
+  end
+end

data/lib/frontmatter/template_handler.rb

@@ -0,0 +1,34 @@
+module Frontmatter
+  class TemplateHandler
+    def self.call(template, source)
+      new(template, source).call
+    end
+
+    def initialize(template, source)
+      @template = template
+      @source = source
+    end
+
+    def call
+      handler_for_template.call(@template, source_without_yaml)
+    end
+
+    def handler_for_template
+      ApplicationController.new.view_paths.paths.first
+        .extract_handler_and_format_and_variant(path_without_yaml)
+        .first
+    end
+
+    def source_without_yaml
+      @source.lines[last_line+1...].join
+    end
+
+    def path_without_yaml
+      @template.short_identifier.sub(/.ya?ml\z/, '')
+    end
+
+    def last_line
+      YAML.parse(@source).root.end_line
+    end
+  end
+end

data/lib/frontmatter/version.rb

@@ -0,0 +1,3 @@
+module Frontmatter
+  VERSION = '0.1.0'
+end

data/lib/tasks/frontmatter_tasks.rake

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

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: frontmatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Caleb Hearth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- caleb@calebhearth.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/config/frontmatter_manifest.js
+- app/assets/stylesheets/frontmatter/application.css
+- app/controllers/frontmatter/pages_controller.rb
+- app/helpers/frontmatter/application_helper.rb
+- app/jobs/frontmatter/application_job.rb
+- app/mailers/frontmatter/application_mailer.rb
+- app/models/frontmatter/application_record.rb
+- app/models/frontmatter/page.rb
+- app/views/layouts/frontmatter/application.html.erb
+- config/environment.rb
+- config/routes.rb
+- lib/frontmatter.rb
+- lib/frontmatter/engine.rb
+- lib/frontmatter/template_handler.rb
+- lib/frontmatter/version.rb
+- lib/tasks/frontmatter_tasks.rake
+homepage: https://calebhearth.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Semi-static pages with data in Rails.
+test_files: []