tufte 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 68122151e2336b4c014579ccf9ab2173b64b2645
+  data.tar.gz: 95981d41c07070572fb2d210f4d73ce7c7418277
+SHA512:
+  metadata.gz: db6e50473513677d7ebbbc9903187ac86780812d1857e0180d520b147b9887467e45f1ee72547ea2ec56b53e86723007853e7b795dd88f4fd02915a0bab6c4d9
+  data.tar.gz: e02d0c77adc0cbc63a81230f5c39e6c14428b3c5a41d2309097dc5a70d2ff189546dd701bd1c365c560f36011a44da324430dadc81708c9f98343f4301227598

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/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,67 @@
+Copyright (c) 2016 Maxwell Holder
+
+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.
+
+
+This project includes fonts from et-book
+(https://github.com/edwardtufte/et-book) which is distributed with the following
+license:
+
+Copyright (c) 2015 Dmitry Krasny, Bonnie Scranton, Edward Tufte.
+
+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.
+
+
+This project includes CSS from tufte-css
+(https://github.com/edwardtufte/tufte-css) which is distributed with the
+following license:
+
+Copyright (c) 2014 Dave Liepmann
+
+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,50 @@
+# tufte
+
+[![Build Status](https://travis-ci.org/mxhold/tufte.svg?branch=master)](https://travis-ci.org/mxhold/tufte)
+
+tufte is a minimal static site generator ideal for getting a blog running
+quickly with:
+
+  - [tufte-css](https://github.com/edwardtufte/tufte-css) for style
+  - [redcarpet](https://github.com/vmg/redcarpet) for Markdown rendering
+  - [rouge](https://github.com/jneen/rouge) for syntax highlighting
+
+See it in action at <https://maxwellholder.com>.
+
+## Getting started
+
+You'll need [Ruby](https://www.ruby-lang.org) and [Bundler](http://bundler.io/)
+installed first.
+
+Make a new directory for your blog and `cd` to it:
+
+    mkdir blog/
+    cd blog/
+
+Add a `Gemfile` for the current version of tufte (make sure to commit this along
+with your `Gemfile.lock` for reproducable builds).
+
+    echo 'source "https://rubygems.org"\n\ngem "tufte", "~> 1.0"' > Gemfile
+    bundle install
+
+Add binstubs so you don't have to prefix commands with `bundle exec`:
+
+    bundle binstubs tufte
+
+Initialize a new blog and create scaffold files in the current directory:
+
+    bin/tufte init
+
+Generate HTML pages from the templates:
+
+    bin/tufte build
+
+Run a local server to view your blog at <http://localhost:9292> (this is a
+simple wrapper around `rackup` so you can pass any options you normally use for
+[Rack](https://github.com/rack/rack) such as `-p 4000` to run on port 4000):
+
+    bin/tufte serve
+
+At this point you can edit the files in `templates/` and `posts/` to your
+liking, running `bin/tufte build` after each change until you are satisfied with
+your new blog.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  task default: :spec
+rescue LoadError
+end

data/TODO

@@ -0,0 +1,2 @@
+- Extract helpers to scaffolded file so users can add their own helpers
+- Add pages/ for general static pages

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tufte"
+
+# 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/exe/tufte

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "tufte"
+
+Tufte::CLI.run(ARGV.shift)

data/lib/tufte/binding.rb

@@ -0,0 +1,25 @@
+module Tufte
+  module Binding
+    def self.new(instance_variables:, mod:)
+      BindingFactory.new(
+        instance_variables: instance_variables,
+        mod: mod,
+      ).get_binding
+    end
+
+    class BindingFactory
+      def initialize(instance_variables:, mod:)
+        instance_variables.each do |name, value|
+          instance_variable_set(name, value)
+        end
+        mod.singleton_methods.each do |name|
+          define_singleton_method(name, &mod.singleton_method(name))
+        end
+      end
+
+      def get_binding
+        binding
+      end
+    end
+  end
+end

data/lib/tufte/cli.rb

@@ -0,0 +1,29 @@
+require "optparse"
+
+module Tufte
+  module CLI
+    def self.run(command)
+      case command
+      when "init"
+        Tufte.init
+      when "build"
+        Tufte.build
+      when "serve"
+        require "rack"
+        Rack::Server.start
+      when "version", "-v", "--version"
+        puts Tufte::VERSION
+      else
+        puts <<-USAGE
+Usage: tufte [command]
+Commands:
+  init             Scaffold a new blog in the current directory
+  build            Generate HTML pages based on the templates
+  serve            Start a development server to host your files locally
+  version          Print the current version
+  help             Print this message
+        USAGE
+      end
+    end
+  end
+end

data/lib/tufte/helpers.rb

@@ -0,0 +1,23 @@
+module Tufte
+  module Helpers
+    def self.sidenote(id, note)
+        <<-HTML.chomp
+<label for="#{id}" class="margin-toggle sidenote-number"></label>
+<input type="checkbox" id="#{id}" class="margin-toggle"/>
+<span class="sidenote">
+#{note}
+</span>
+        HTML
+    end
+
+    def self.marginnote(id, note)
+      <<-HTML.chomp
+<label for="#{id}" class="margin-toggle">&#8853;</label>
+<input type="checkbox" id="#{id}" class="margin-toggle"/>
+<span class="marginnote">
+#{note}
+</span>
+      HTML
+    end
+  end
+end

data/lib/tufte/markdown.rb

@@ -0,0 +1,24 @@
+require "redcarpet"
+require "rouge"
+require "rouge/plugins/redcarpet"
+
+module Tufte
+  class HTML < Redcarpet::Render::HTML
+    include Rouge::Plugins::Redcarpet
+
+    def self.renderer
+      @renderer ||= Redcarpet::Markdown.new(self, fenced_code_blocks: true)
+    end
+  end
+
+  class Markdown
+    def initialize(markdown, renderer: HTML.renderer)
+      @markdown = markdown
+      @renderer = renderer
+    end
+
+    def to_html
+      @renderer.render(@markdown)
+    end
+  end
+end

data/lib/tufte/post.rb

@@ -0,0 +1,42 @@
+require "yaml"
+
+module Tufte
+  class Post
+    attr_reader :title, :slug
+
+    def initialize(date:, title:, slug:, raw_body:)
+      @date = date
+      @slug = slug
+      @title = title
+      @raw_body = raw_body
+    end
+
+    def body
+      Markdown.new(@raw_body).to_html
+    end
+
+    def date
+      @date.strftime("%Y %b %-d")
+    end
+
+    def output_directory
+      File.join(@date.year.to_s, @date.month.to_s, @date.day.to_s, slug)
+    end
+
+    def output_filename
+      File.join(output_directory, "index.html")
+    end
+
+    def self.load(filename)
+      file_contents = File.read(filename)
+      metadata = YAML.load(file_contents)
+
+      new(
+        date: metadata.fetch("date"),
+        title: metadata.fetch("title"),
+        slug: File.basename(filename, ".yml"),
+        raw_body: file_contents.split("---\n", 3).last,
+      )
+    end
+  end
+end

data/lib/tufte/version.rb

@@ -0,0 +1,3 @@
+module Tufte
+  VERSION = "1.0.0"
+end

data/lib/tufte.rb

@@ -0,0 +1,45 @@
+require "tufte/version"
+require "tufte/binding"
+require "tufte/post"
+require "tufte/markdown"
+require "tufte/cli"
+require "tufte/helpers"
+require "fileutils"
+require "erb"
+
+module Tufte
+  def self.render(erb, instance_variables, helpers = Helpers)
+    binding = Binding.new(instance_variables: instance_variables, mod: helpers)
+    ERB.new(erb).result(binding)
+  end
+
+  def self.init
+    scaffold_path = File.expand_path(File.join("..", "scaffold"), __dir__)
+    FileUtils.cp_r(File.join(scaffold_path, "."), ".")
+  end
+
+  def self.build
+    layout_template = File.read("templates/layout.html.erb")
+    post_template = File.read("templates/post.html.erb")
+    index_template = File.read("templates/index.html.erb")
+
+    posts = Dir.glob("posts/*").map do |filename|
+      Post.load(filename)
+    end
+
+    posts.each do |post|
+      FileUtils.mkdir_p(post.output_directory)
+      File.open(post.output_filename, "w") do |file|
+        rendered_post = render(post_template, :@post => post)
+        file.write(render(layout_template, :@content => rendered_post))
+      end
+      puts "Generated #{post.output_filename}"
+    end
+
+    File.open("index.html", "w") do |file|
+      rendered_index = render(index_template, :@posts => posts)
+      file.write(render(layout_template, :@content => rendered_index))
+    end
+    puts "Generated index.html"
+  end
+end

data/scaffold/config.ru

@@ -0,0 +1,23 @@
+class DirectoryIndex
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    index_path = File.join(
+      ".",
+      Rack::Request.new(env).path.split('/'),
+      "index.html"
+    )
+
+    if File.exists?(index_path)
+      [200, {"Content-Type" => "text/html"}, [File.read(index_path)]]
+    else
+      @app.call(env)
+    end
+  end
+end
+
+use DirectoryIndex
+
+run Rack::Directory.new(".")