mascot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19f9e7b959947630495440f3a2c7c728dcb02af7
+  data.tar.gz: 88f1c9212234555876648f7f77952d6cd3b47fbc
+SHA512:
+  metadata.gz: 04c0b817aad5d980a610c88f3e772486d195c4a75ad8b4c16c2326d4159c32f3fe37584f5cb9b990dfefa944cdb54abf84269608985ccf1f9014d8d6518c433a
+  data.tar.gz: 3bb29074fdd9c5df6a7bed480b9c748bcce654a5ff8d4a115b6cbe21ef9889ac0ab9f692da952ffa9a8ca63f4074362798f1be8aca2c06c8b5bd6f2b62e9cd95

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mascot.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.("routing/#{m[1]}_routing"),
+      rspec.spec.("controllers/#{m[1]}_controller"),
+      rspec.spec.("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -0,0 +1,146 @@
+# Mascot
+
+Mascot is a file-backed website content manager that can be embedded in popular web frameworks like Rails, run stand-alone, or be compiled into static sites.
+
+[![Build Status](https://travis-ci.org/bradgessler/mascot.svg?branch=master)](https://travis-ci.org/bradgessler/mascot)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mascot'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mascot
+
+## Usage
+
+Given a haml file like:
+
+```haml
+---
+title: Name
+meta:
+  keywords: One
+---
+
+!!!
+%html
+  %head
+    %title=current_page.data["title"]
+  %body
+    %h1 Hi
+    %p This is just some content
+    %h2 There
+```
+
+Mascot can parse out the frontmatter and body to render inside your framework of choice, like Rails:
+
+```ruby
+class MascotController < ApplicationController
+  # TODO: Isolate this integration into a rails engine. Copy
+  # the way HighVoltage provides routes and scopes everything.
+  def show
+    sitemap = Rails.application.config.sitemap
+
+    resource = sitemap.find_by_request_path(request.path)
+    if resource
+      # TODO: Implement a whitelisted, chained handler for
+      # the template type with ActionView::Template::Handlers.extensions
+      template_type = resource.file_path.extname.delete(".")
+      @_locals = resource.locals.merge(sitemap: sitemap)
+      layout = resource.data.fetch("layout", "high_voltage")
+      render inline: resource.body, type: template_type, layout: layout, locals: @_locals
+    else
+      render status: :not_found, text: "#{request.path} Not Found"
+    end
+  end
+end
+```
+
+so when you call `current_page.data` from your templates, you get something like this:
+
+```irb
+> current_page.data
+=> {"title"=>"Name", "meta"=>{"keywords"=>"One"}, "toc"=>["Hi", "There"]}
+> current_page.data.dig("meta", "keywords")
+=> "One"
+```
+
+Mascot is designed to be embedded in rails and other Ruby web frameworks.
+
+# Features
+
+Mascot implements a subset of the best features from the [Middleman](http://www.middlemanapp.com/) static site generator including the Sitemap and Frontmatter.
+
+## Frontmatter
+
+Frontmatter is a way to attach metadata to content pages. Its a powerful way to enable a team of writers and engineers work together on content. The engineers focus on reading values from frontmatter while the writers can change values.
+
+```haml
+---
+title: This is a swell doc
+meta:
+  keywords: this, is, a, test
+background_color: #0f0
+---
+
+%html
+  %head
+    %meta(name="keywords" value="#{current_page.data.dig("meta", "keywords")}")
+  %body(style="background: #{current_page.data["background_color"]};")
+    %h1=current_page.data["title"]
+    %p And here's the rest of the content!
+```
+
+## Sitemap
+
+The Sitemap accepts a directory path
+
+```irb
+> sitemap = Mascot::Sitemap.new(file_path: "spec/pages")
+=> #<Mascot::Sitemap:0x007fcd24103710 @file_path=#<Pathname:spec/pages>, @request_path=#<Pathname:/>>
+```
+
+Then you can request a resource by request path:
+
+```irb
+> resource = sitemap.find_by_request_path("/test")
+=> #<Mascot::Resource:0x007fcd2488a128 @request_path="/test", @content_type="text/html", @file_path=#<Pathname:spec/pages/test.html.haml>, @frontmatter=#<Mascot::Frontmatter:0x007fcd24889e80 @data="title: Name\nmeta:\n  keywords: One", @body="\n!!!\n%html\n  %head\n    %title=current_page.data[\"title\"]\n  %body\n    %h1 Hi\n    %p This is just some content\n    %h2 There\n">>
+```
+
+And access the frontmatter data (if available) and body of the template.
+
+```irb
+> resource.data
+=> {"title"=>"Name", "meta"=>{"keywords"=>"One"}}
+> resource.body
+=> "\n!!!\n%html\n  %head\n    %title=current_page.data[\"title\"]\n  %body\n    %h1 Hi\n    %p This is just some content\n    %h2 There\n"
+```
+
+### Resource globbing
+
+The Sitemap API is a powerful way to query content via resource globbing. For example, if you have a folder full of files but you only want all `.html` files within the `docs` directory, you'd do something like:
+
+```haml
+%ol
+  -sitemap.resources("docs/*.html*").each do |page|
+    %li=link_to page.data["title"], page.request_path
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bradgessler/mascot.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mascot"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config.ru

@@ -0,0 +1,3 @@
+require "mascot"
+
+run Mascot::Server.glob("spec/pages/*")

data/lib/mascot/version.rb

@@ -0,0 +1,3 @@
+module Mascot
+  VERSION = "0.1.0"
+end

data/lib/mascot.rb

@@ -0,0 +1,136 @@
+require "mascot/version"
+
+module Mascot
+  require "yaml"
+
+  # Parses metadata from the header of the page.
+  class Frontmatter
+    DELIMITER = "---".freeze
+    PATTERN = /\A(#{DELIMITER}\n(.+)\n#{DELIMITER}\n)?(.+)\Z/m
+
+    attr_reader :body
+
+    def initialize(content)
+      _, @data, @body = content.match(PATTERN).captures
+    end
+
+    def data
+      @data ? YAML.load(@data) : {}
+    end
+
+    private
+    def parse
+      @content
+    end
+  end
+
+  # Represents a page in a web server context.
+  class Resource
+    # TODO: I don't like the Binding, locals, and frontmatter
+    # being in the Resource. That should be moved to a page
+    # object and be delegated to that. Or perhaps the page body?
+    # I'm moving forward with this now though to keep the objects simpler.
+    # We'll see how it evolves.
+    Binding = Struct.new(:data)
+
+    CONTENT_TYPE = "text/html".freeze
+
+    attr_reader :request_path, :file_path, :content_type
+
+    extend Forwardable
+    def_delegators :@frontmatter, :data, :body
+
+    def initialize(request_path: , file_path: , content_type: CONTENT_TYPE)
+      @request_path = request_path
+      @content_type = content_type
+      @file_path = Pathname.new file_path
+      @frontmatter = Frontmatter.new File.read @file_path
+    end
+
+    # Locals that should be merged into or given to the rendering context.
+    def locals
+      { current_page: Binding.new(data) }
+    end
+  end
+
+  # A collection of pages from a directory.
+  class Sitemap
+    # Default file pattern to pick up in sitemap
+    DEFAULT_GLOB = "**/*.*".freeze
+    # Default root path for sitemap.
+    DEFAULT_ROOT_DIR = Pathname.new(".").freeze
+    # Default root request path
+    DEFAULT_ROOT_REQUEST_PATH = Pathname.new("/").freeze
+
+    def initialize(file_path: DEFAULT_ROOT_DIR, request_path: DEFAULT_ROOT_REQUEST_PATH)
+      @file_path = Pathname.new(file_path)
+      @request_path = Pathname.new(request_path)
+    end
+
+    # Lazy stream of resources.
+    def resources(glob = DEFAULT_GLOB)
+      Dir[@file_path.join(glob)].lazy.map do |path|
+        Resource.new request_path: request_path(path), file_path: path
+      end
+    end
+
+    # Find the page with a path.
+    def find_by_request_path(request_path)
+      resources.find { |r| r.request_path == request_path }
+    end
+
+    private
+    # Given a @file_path of `/hi`, this method changes `/hi/there/friend.html.erb`
+    # to an absolute `/there/friend` format by removing the file extensions
+    def request_path(path)
+      # Relative path of resource to the file_path of this project.
+      relative_path = Pathname.new(path).relative_path_from(@file_path)
+      # Removes the .fooz.baz
+      @request_path.join(relative_path).to_s.sub(/\..*/, '')
+    end
+  end
+
+  require "tilt"
+
+  class TiltRenderer
+    def initialize(resource)
+      @resource = resource
+    end
+
+    def render
+      template = engine.new { |t| @resource.body }
+      template.render(Object.new, @resource.locals)
+    end
+
+    private
+    def engine
+      Tilt[@resource.file_path]
+    end
+  end
+
+  # Mount inside of a config.ru file to run this as a server.
+  class Server
+    ROOT_PATH = Pathname.new("/")
+
+    def initialize(sitemap, relative_to: "/")
+      @relative_to = Pathname.new(relative_to)
+      @sitemap = sitemap
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+      if resource = @sitemap.find_by_request_path(normalize_path(req.path))
+        [ 200, {"Content-Type" => resource.content_type}, [TiltRenderer.new(resource).render] ]
+      else
+        [ 404, {"Content-Type" => "text/plain"}, ["Not Found"]]
+      end
+    end
+
+    private
+    # If we mount this middleware in a path other than root, we need to configure it
+    # so that it correctly maps the request path to the content path.
+    def normalize_path(request_path)
+      ROOT_PATH.join(Pathname.new(request_path).relative_path_from(@relative_to)).to_s
+    end
+  end
+end

data/mascot.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mascot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mascot"
+  spec.version       = Mascot::VERSION
+  spec.authors       = ["Brad Gessler"]
+  spec.email         = ["bradgessler@gmail.com"]
+
+  spec.summary       = %q{An experiment in data driven static website generation.}
+  spec.homepage      = "https://github.com/bradgessler/mascot"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "haml", "~> 4.0"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "actionpack", "~> 4.2"
+
+  spec.add_dependency "tilt"
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: mascot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brad Gessler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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: rack-test
+  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: rack
+  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: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  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'
+description: 
+email:
+- bradgessler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config.ru
+- lib/mascot.rb
+- lib/mascot/version.rb
+- mascot.gemspec
+homepage: https://github.com/bradgessler/mascot
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: An experiment in data driven static website generation.
+test_files: []
+has_rdoc: