slimdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11ecd53f76f3f7e0f02682fdf0650331db9fbfd6
+  data.tar.gz: 9fd4b4d8546c45a16882d83721ed445f16aedef9
+SHA512:
+  metadata.gz: e0defd1b01855570217e8bbc630f41a547c7c1436a22c8343ece1538bc50894efc13461424d03e725a7b457fc59485f5e540ff46abddb7ac7e6d365b06eb908f
+  data.tar.gz: 6fe35a719ca17a0a741a91ca9ba511e1bdc81e9d255ab537699e923cf668873777e00aa4aa8b93b00af333b455daaae2eb85d4480a258789dad7da0be1afe699

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,10 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.1.5
+  - 2.2.2
+  - jruby
+before_install:
+  - gem update --system
+  - gem --version
+  - gem update bundler

data/.yardocops

@@ -0,0 +1 @@
+--no-private --protected lib/**/*.rb - Readme.md LICENSE.txt

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-slimdown.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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 American Public Media
+
+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,92 @@
+# Slimdown
+
+Slimdown is a simple gem to allow you to easily add static pages to your app
+via a folder full of Markdown files.
+
+Justin Heideman conceived and built the original version in PHP.
+
+[![Build Status](https://travis-ci.org/APMG/ruby-slimdown.svg?branch=master)](https://travis-ci.org/APMG/ruby-slimdown)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'slimdown'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install slimdown
+
+## Usage
+
+To add to your app, create a controller with one action, such as `show`. In that
+action, add code to pull in the action:
+
+    class SlimdownController < ApplicationController
+      def show
+        @page = Slimdown::Page.find(params[:slug])
+      end
+    end
+
+Then add a view for the show action.
+
+    <%= @page.body.to_html.html_safe %>
+
+    <h2>Sibling Pages</h2>
+    <ul>
+      <% @page.siblings.each do |sibling| %>
+        <li><%= link_to sibling.title, "/#{sibling.path}" %></li>
+      <% end %>
+    </ul>
+
+    <h2>Child Pages</h2>
+    <ul>
+      <% @page.children.each do |child| %>
+        <li><%= link_to child.title, "/#{child.path}" %></li>
+      <% end %>
+    </ul>
+
+Add a route to direct all unhandled requests to your controller. Make sure that
+it is at the end of your routes.rb so it doesn't superseed other routes.
+
+    get '/*slug', to: 'slimdown#show'
+
+Finally, add an initializer in `config/initializers/slimdown.rb` to set the path
+to your pages.
+
+    Slimdown.config do |c|
+      c.location = Rails.root.join('lib/pages')
+    end
+
+
+## General notes
+
+The use case for us is that we have a distinct repo containing the markdown (and
+some other files) which is editable by producers. This is autodeployed to a
+location on our servers which is accessible from our Rails app.
+
+The actual pages live in `[location]/pages`. It is assumed that you will have
+other files in there as well. In our use case, we have `/files` as well, which
+is aliased as an asset store of sorts. We also have `/_deploy` with Capistrano
+deployment code.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/apmg/ruby-slimdown/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task default: :spec
+RSpec::Core::RakeTask.new

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ruby/slimdown"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/slimdown/config.rb

@@ -0,0 +1,15 @@
+module Slimdown
+  # Internal class for managing global configuration.
+  #
+  # Only used by singleton Slimdown module.
+  class Config
+
+    # Get the path to the markdown pages.
+    attr_accessor :location
+
+    def initialize
+      # Set defaults.
+      @location = 'pages/'
+    end
+  end
+end

data/lib/slimdown/exception.rb

@@ -0,0 +1,5 @@
+module Slimdown
+  # Exception class for Slimdown errors.
+  class Exception < StandardError
+  end
+end

data/lib/slimdown/folder.rb

@@ -0,0 +1,32 @@
+module Slimdown
+  # Internal class for retrieving information about a folder.
+  class Folder
+    def initialize(absolute_path)
+      @absolute_path = absolute_path
+    end
+
+    # Returns a list of markdown files in the folder.
+    #
+    # @return [Array<String>] List of paths.
+    def markdown_files
+      return [] unless Dir.exists? @absolute_path
+
+      dir = Dir.new @absolute_path
+      files = dir.entries.grep(/\.md\z/i)
+    end
+
+    # Returns a list of page objects in the folder.
+    #
+    # @return [Array<Slimdown::Page>] List of pages.
+    def pages
+      pages = []
+
+      markdown_files.each do |file|
+        path = "#{@absolute_path}/#{file}"
+        pages << Slimdown::Page.new(path)
+      end
+
+      pages
+    end
+  end
+end

data/lib/slimdown/page.rb

@@ -0,0 +1,91 @@
+module Slimdown
+  # The model representing a page
+  class Page
+
+    # The subdirectory of the slimdown folder containing the markdown documents
+    PAGES_PATH_NAME = 'pages'
+
+    # The title from the document headers
+    attr_reader :title
+    # The template from the document headers
+    attr_reader :template
+
+    # Get new page object
+    #
+    # @param [String] absolute_path The absolute path to this document,
+    #   including extension.
+    def initialize(absolute_path)
+      # Open the markdown file.
+      @absolute_path = absolute_path
+
+      @parsed_page = Slimdown::PageParser.new @absolute_path
+
+      load_headers
+    end
+
+    # Get page object by relative path.
+    #
+    # Example:
+    #    Slimdown::Page.find('about/contact')
+    #
+    # @param [String] path relative path to page. Doesn't include extension.
+    # @return [Slimdown::Page] the page corresponding to this path.
+    def self.find(path)
+      # Finds the relative page.
+      config = Slimdown.config
+      loc = config.location
+
+      self.new("#{loc}/#{PAGES_PATH_NAME}/#{path}.md")
+    end
+
+    # Get the parsed body
+    #
+    # @return [Kramdown::Document] the parsed Markdown body.
+    def body
+      @parsed_page.body
+    end
+
+    # The sibling pages to this document.
+    #
+    # @return [Array<Slimdown::Page>] a list of sibling pages.
+    def siblings
+      # List other markdown files in the same folder.
+
+      # Sibling folder.
+      folder = File.dirname @absolute_path
+
+      Slimdown::Folder.new(folder).pages
+    end
+
+    # The children of this document.
+    #
+    # @return [Array<Slimdown::Page>] a list of child pages.
+    def children
+      # Check to see whether dir exists.
+      folder = @absolute_path
+      folder.slice! '.md'
+
+      Slimdown::Folder.new(folder).pages
+    end
+
+    # The relative path for this document.
+    #
+    # @return [String] the relative path, e.g. 'about/contact'
+    def path
+      loc = Slimdown.config.location
+      relative = @absolute_path
+      relative.slice! "#{loc}/#{PAGES_PATH_NAME}/"
+      relative.slice! '.md'
+
+      relative
+    end
+
+  private
+
+    def load_headers
+      headers = @parsed_page.headers
+      @title = headers['title']
+      @template = headers['template']
+    end
+  end
+end

data/lib/slimdown/page_parser.rb

@@ -0,0 +1,62 @@
+require 'yaml'
+require 'kramdown'
+
+module Slimdown
+  # Internal class to manage parsing the markdown document.
+  class PageParser
+    # @param [String] path The absolute path to the markdown document.
+    def initialize(path)
+      @path = path
+
+      parse_file
+    end
+
+    # A hash of the headers in the document
+    #
+    # Example:
+    #     {
+    #       "title" => "Test title",
+    #       "template" => "test_template",
+    #     }
+    #
+    # @return [Hash] document headers
+    def headers
+      YAML.load @header_text
+    end
+
+    # The parsed markdown document body.
+    #
+    # @return [Kramdown::Document] a markdown document object.
+    def body
+      Kramdown::Document.new(@body_text)
+    end
+
+  private
+
+    def parse_file
+      # Simple state machine.
+      part = nil
+
+      @header_text = ''
+      @body_text = ''
+
+      File.open(@path, 'r') do |f|
+        f.each_line do |line|
+          if line.strip == '---' && !part
+            part = :header
+          elsif line.strip == '---' && part == :header
+            part = :body
+          elsif part == :header
+            @header_text += "#{line}\n"
+          elsif part == :body
+            @body_text += "#{line}\n"
+          end
+        end
+      end
+
+    rescue Errno::ENOENT
+      raise Slimdown::Exception, 'Page not found'
+    end
+
+  end
+end

data/lib/slimdown/version.rb

@@ -0,0 +1,4 @@
+module Slimdown
+  # The slimdown version
+  VERSION = '0.1.0'
+end

data/lib/slimdown.rb

@@ -0,0 +1,32 @@
+require "slimdown/version"
+require "slimdown/exception"
+require "slimdown/page_parser"
+require "slimdown/folder"
+require "slimdown/page"
+require "slimdown/config"
+
+# The main Slimdown namespace.
+module Slimdown
+
+  # Sets and retrieves global configuration.
+  #
+  # If called with a block, the config object will be passed to the block and
+  # allow settings to be modified. This could be done in a Rails initializer:
+  #
+  #    Slimdown.config do |config|
+  #      config.location = Rails.root.join 'pages'
+  #    end
+  #
+  # The settings object is always returned.
+  #
+  # @param [Proc] block to call with config object.
+  # @return [Slimdown::Config] object with configuration params.
+  def self.config(&block)
+    @config ||= Slimdown::Config.new
+
+    # Allow configuration via a block.
+    block.call(@config) if block
+
+    @config
+  end
+end

data/ruby-slimdown.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slimdown/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slimdown"
+  spec.version       = Slimdown::VERSION
+  spec.authors       = ["William Johnston"]
+  spec.email         = ["wjohnston@mpr.org"]
+
+  spec.summary       = %q{A system for using static Markdown for pages.}
+  spec.description   = %q{A system for using Markdown from a folder and turning it into web pages.}
+  spec.homepage      = "https://github.com/APMG/ruby-slimdown"
+  spec.license       = "MIT"
+
+  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_runtime_dependency 'kramdown', '~> 1.7'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "guard", "~> 2.12"
+  spec.add_development_dependency "guard-rspec", "~> 4.5"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "yard", "~> 0.8"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: slimdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- William Johnston
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kramdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: A system for using Markdown from a folder and turning it into web pages.
+email:
+- wjohnston@mpr.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardocops"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/slimdown.rb
+- lib/slimdown/config.rb
+- lib/slimdown/exception.rb
+- lib/slimdown/folder.rb
+- lib/slimdown/page.rb
+- lib/slimdown/page_parser.rb
+- lib/slimdown/version.rb
+- ruby-slimdown.gemspec
+homepage: https://github.com/APMG/ruby-slimdown
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A system for using static Markdown for pages.
+test_files: []
+has_rdoc: