sitepress-rails 0.1.16

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6994698f567bafa62b4fc8ed645b43ca5061429
+  data.tar.gz: c8618d2cedbeadcda10293e08b8ee4c285f51da7
+SHA512:
+  metadata.gz: 33adf2a91c339f4c25d28ccff7c04275fc06a336c712c781101a754dde2ce2dd55b3ee6091601a999373e8911d67f790169296c41046b760ddfa0eed0185024e
+  data.tar.gz: 76da5e6f5ad5462326f94803faa1b4521286a591ae0dfb5a039e82c29bd824cea0a1b47aa3e0c6a48b1b5862172f4d9a9b0c2b8903df5c3aba7f153c9b0ed0a9

data/README.md

@@ -0,0 +1,34 @@
+# Sitepress
+
+Sitepress is a file-backed website content manager that can be embedded in popular web frameworks like Rails. Inspired by [Middleman](https://middlemanapp.com), Sitepress is stripped down with less dependencies to work better within Rails. That mean it ships with Frontmatter, the Site API, and a few templating features. [Learn more about Sitepress](https://github.com/bradgessler/sitepress).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sitepress-rails'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Then mount the engine into your `config/routes.rb` file:
+
+```ruby
+mount Sitepress::Engine => "/"
+```
+
+Then add pages to the `app/views/pages` directory:
+
+```bash
+$ echo "<h1>Hello</h1><p>It is <%= Time.now %> o'clock</p>" > app/views/pages/hello.html.erb
+```
+
+Point your browser to `http://127.0.0.1:3000/hello` and if all went well you should see the page you just created.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+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    = 'Sitepress'
+  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", __FILE__)
+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 << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/controllers/concerns/sitepress/site_pages.rb

@@ -0,0 +1,62 @@
+module Sitepress
+  # Serves up Sitepress site pages in a rails application. This is mixed into the
+  # Sitepress::SiteController, but may be included into other controllers for static
+  # page behavior.
+  module SitePages
+    extend ActiveSupport::Concern
+
+    included do
+      rescue_from Sitepress::PageNotFoundError, with: :page_not_found
+      helper_method :current_page, :site
+    end
+
+    def show
+      render inline: current_page.body,
+        type: current_page.asset.template_extensions.last,
+        layout: current_page.data.fetch("layout", controller_layout),
+        content_type: current_page.mime_type.to_s
+    end
+
+    protected
+    def current_page
+      @_current_page ||= find_resource
+    end
+
+    def site
+      Sitepress.site
+    end
+
+    def page_not_found(e)
+      raise ActionController::RoutingError, e.message
+    end
+
+    private
+
+    # Sitepress::PageNotFoundError is handled in the default Sitepress::SiteController
+    # with an execption that Rails can use to display a 404 error.
+    def get(path)
+      resource = Sitepress.site.resources.get(path)
+      if resource.nil?
+        # TODO: Display error in context of Reources class root.
+        raise Sitepress::PageNotFoundError, "No such page: #{path}"
+      else
+        resource
+      end
+    end
+
+    # Default finder of the resource for the current controller context.###
+    def find_resource
+      get params[:resource_path]
+    end
+
+    # Returns the current layout for the inline Sitepress renderer.
+    def controller_layout
+      layout = self.send(:_layout)
+      if layout.instance_of? String
+        layout
+      else
+        File.basename(layout.identifier).split('.').first
+      end
+    end
+  end
+end

data/app/controllers/sitepress/site_controller.rb

@@ -0,0 +1,7 @@
+module Sitepress
+  class SiteController < ::ApplicationController
+    # Extracted into a module because other controllers may need
+    # to be capable of serving Sitepress pages.
+    include Sitepress::SitePages
+  end
+end

data/app/helpers/sitepress/application_helper.rb

@@ -0,0 +1,4 @@
+module Sitepress
+  module ApplicationHelper
+  end
+end

data/config/routes.rb

@@ -0,0 +1,7 @@
+Sitepress.configuration.parent_engine.routes.draw do
+  if Sitepress.configuration.routes
+    constraints Sitepress::RouteConstraint.new do
+      get "*resource_path", controller: "sitepress/site", action: "show", as: :page, format: false
+    end
+  end
+end

data/lib/sitepress/engine.rb

@@ -0,0 +1,15 @@
+module Sitepress
+  class Engine < ::Rails::Engine
+    initializer "Add site root to view paths" do |app|
+      ActionController::Base.prepend_view_path Sitepress.site.root_path
+    end
+
+    initializer "Require concerns path" do |app|
+      concerns_path = "app/controllers/concerns"
+
+      unless app.paths.keys.include?(concerns_path)
+        app.paths.add(concerns_path)
+      end
+    end
+  end
+end

data/lib/sitepress/extensions/index_request_path.rb

@@ -0,0 +1,24 @@
+module Sitepress
+  module Extensions
+    # Removes files beginning with "_" from the resource collection.
+    class IndexRequestPath
+      # Name of the file that we'll want to change to a / path
+      FILE_NAME = "index.html".freeze
+
+      def initialize(file_name: FILE_NAME)
+        @file_name = file_name
+      end
+
+      def process_resources(node)
+        node.flatten.each do |r|
+          asset = r.asset
+          if asset.path.basename.to_s.start_with? @file_name
+            request_path = Pathname.new("/").join(r.request_path).dirname.cleanpath.to_s
+            node.formats.remove(r)
+            node.add(path: request_path, asset: asset)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sitepress/extensions/partials_remover.rb

@@ -0,0 +1,19 @@
+module Sitepress
+  module Extensions
+    # Removes files beginning with "_" from the resource collection.
+    class PartialsRemover
+      # Partial rails prefix.
+      PARTIAL_PREFIX = "_".freeze
+
+      def process_resources(node)
+        node.flatten.each do |r|
+          r.node.remove if self.class.partial? r.asset.path # Looks like a smiley face, doesn't it?
+        end
+      end
+
+      def self.partial?(path)
+        File.basename(path).starts_with? PARTIAL_PREFIX
+      end
+    end
+  end
+end

data/lib/sitepress/extensions/rails_request_paths.rb

@@ -0,0 +1,20 @@
+module Sitepress
+  module Extensions
+    # Removes the file extension from the file so that /hi/there/fun.html can be
+    # resolved via /hi/there/fun.
+    class RailsRequestPaths
+      def process_resources(node)
+        node.flatten.each do |r|
+          asset = r.asset
+          request_path = r.request_path
+          r.node.remove
+          node.add path: self.class.format_path(request_path), asset: asset
+        end
+      end
+
+      def self.format_path(request_path)
+        File.join(File.dirname(File.join("/", request_path)), File.basename(request_path, ".*"))
+      end
+    end
+  end
+end

data/lib/sitepress/rails.rb

@@ -0,0 +1,38 @@
+require "sitepress"
+
+module Sitepress
+  # Contains singletons for rails and some configuration data.
+  Configuration = Struct.new(:site, :routes, :parent_engine)
+
+  # Rescued by ActionController to display page not found error.
+  PageNotFoundError = Class.new(StandardError)
+
+  autoload :RailsConfiguration,       "sitepress/rails_configuration"
+  autoload :RouteConstraint,          "sitepress/route_constraint"
+  module Extensions
+    autoload :RailsRequestPaths,      "sitepress/extensions/rails_request_paths"
+    autoload :PartialsRemover,        "sitepress/extensions/partials_remover"
+    autoload :IndexRequestPath,       "sitepress/extensions/index_request_path"
+  end
+
+  # Make site available via Sitepress.site from Rails app.
+  def self.site
+    configuration.site
+  end
+
+  # Default configuration object for Sitepress Rails integration.
+  def self.configuration
+    @configuration ||= RailsConfiguration.new
+  end
+
+  def self.reset_configuration
+    @configuration = nil
+  end
+
+  def self.configure(&block)
+    block.call configuration
+  end
+end
+
+# This can't be autoloaded; otherwise Rails won't pick up the engine.
+require "sitepress/engine"

data/lib/sitepress/rails_configuration.rb

@@ -0,0 +1,34 @@
+require "forwardable"
+
+module Sitepress
+  # Configuration object for rails application.
+  class RailsConfiguration
+    # Store in ./app/pages by default.
+    DEFAULT_SITE_ROOT = "app/pages".freeze
+
+    attr_accessor :site, :parent_engine, :routes, :cache_resources
+
+    # Delegates configuration points into the Sitepress site.
+    extend Forwardable
+    def_delegators :site, :cache_resources, :cache_resources=, :cache_resources?
+
+    # Set defaults.
+    def initialize
+      self.routes = true
+      self.parent_engine = Rails.application
+      self.cache_resources = parent_engine.config.cache_classes
+    end
+
+    def site
+      @site ||= Site.new(root_path: default_root, cache_resources: @cache_resources).tap do |site|
+        site.resources_pipeline << Extensions::PartialsRemover.new
+        site.resources_pipeline << Extensions::RailsRequestPaths.new
+      end
+    end
+
+    private
+    def default_root
+      Rails.root.join(DEFAULT_SITE_ROOT)
+    end
+  end
+end

data/lib/sitepress/route_constraint.rb

@@ -0,0 +1,12 @@
+module Sitepress
+  # Route constraint for rails routes.rb file.
+  class RouteConstraint
+    def initialize(resources: Sitepress.site.resources)
+      @resources = resources
+    end
+
+    def matches?(request)
+      !!@resources.get(request.path)
+    end
+  end
+end

data/lib/sitepress-rails.rb

@@ -0,0 +1 @@
+require "sitepress/rails"

data/lib/tasks/sitepress_tasks.rake

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

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link sitepress-rails_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/spec/dummy/app/assets/stylesheets/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/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/baseline_controller.rb

@@ -0,0 +1,3 @@
+class BaselineController < ApplicationController
+  # Renders views/show.html.erb
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/spec/dummy/app/mailers/application_mailer.rb

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

data/spec/dummy/app/models/application_record.rb

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

data/spec/dummy/app/pages/_stupid.html

@@ -0,0 +1 @@
+Stupid partial

data/spec/dummy/app/pages/hi.html

@@ -0,0 +1,3 @@
+<h1>Hi!</h1>
+
+<p>I'm a sitepress page</p>

data/spec/dummy/app/pages/time.html.erb

@@ -0,0 +1,8 @@
+---
+layout: sitepress_test_layout
+title: Tick tock, tick tock
+---
+
+<h1><%= current_page.data["title"] %></h1>
+
+<p>Its <%= Time.now %> o'clock</p>

data/spec/dummy/app/views/baseline/show.html.erb

@@ -0,0 +1 @@
+<h1>Hi! I'm a basic page with a layout.</h1>

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <style>
+      /* Email styles need to be inline */
+    </style>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/app/views/layouts/mailer.text.erb

@@ -0,0 +1 @@
+<%= yield %>

data/spec/dummy/app/views/layouts/sitepress_test_layout.html.erb

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Test layout</title>
+    <%= csrf_meta_tags %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/bin/update

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../', __FILE__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,15 @@
+require_relative 'boot'
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "sitepress-rails"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/cable.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: async
+
+test:
+  adapter: async
+
+production:
+  adapter: redis
+  url: redis://localhost:6379/1

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!