jenner 0.0.3

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test/fixtures/source/public

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jay Strybis
+
+MIT License
+
+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,110 @@
+# Jenner
+
+Jenner is a static site generator, named after another Doctor.
+
+![Jenner](http://images.wikia.com/walkingdead/images/archive/3/38/20120814183308!Dr_Edwin_Jenner_TV,_1.jpg)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jenner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jenner
+
+## Usage
+
+TODO: add a `jenner new` command to create site skeleton
+
+1. `mkdir my_jenner_site`
+2. `cd my_jenner_site`
+3. `mkdir _site`
+4. `mkdir _templates`
+5. Create a template in `_templates` (e.g. page.html)
+6. Start creating items (pages) in `_site`
+7. `jenner build`
+
+Your generated site will be in `./public`.
+
+### Items
+
+Here's an example (example.html):
+
+    ---
+    title:    'Example Page'
+    date:     2014-01-23 17:02:00 -6
+    template: 'page'
+    ---
+
+    <p>This is an example page.</p>
+
+This item will be rendered using the `page` template. The `page`
+template can use the following data:
+
+    {{item.title}} => "Example Page"
+    {{item.data}}  => 2014-01-23 17:02:00 -6
+    {{item.template_name}} => "page"
+    {{item.body}}  => "<p>This is an example page.</p>
+
+You can define additional pieces of data in the item header like this:
+
+    ---
+    title:    'Example Page'
+    date:     2014-01-23 17:02:00 -6
+    template: 'page'
+    foo:      'bar'
+    answer:   42
+    ---
+
+This item has a couple additional pieces of data:
+
+    {{item.data.foo}}    => "bar"
+    {{item.data.answer}} => 42
+
+You can also create markdown items with the file extension `.markdown`.
+These will be go through the Liquid templating engine first, and then
+they will be processed as Markdown.
+
+    ---
+    title:    'Example Markdown Page'
+    date:     2014-01-23 17:02:00 -6
+    template: 'page'
+    ---
+
+    # This is an example page
+
+
+### Templates
+
+Templates are just HTML files that use Liquid markup. Every item you
+create is rendered with a template that you specify in the item's
+header.
+
+Every item provides the following data at minimum:
+
+    {{item.title}}
+    {{item.date}}
+    {{item.template_name}}
+    {{item.body}}
+
+Additional pieces of data are available within `{{item.data}}` if they
+are defined in the item's YAML header.
+
+You can include other templates with the `{% include %}` tag.
+
+    {% include 'some_other_template' %}
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = true
+end
+
+task default: :test

data/bin/jenner

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+STDOUT.sync = true
+
+require 'bundler/setup'
+require 'jenner'
+require 'mercenary'
+
+Mercenary.program(:jenner) do |p|
+  p.version Jenner::VERSION
+  p.description 'Jenner is an opinionated static site generator'
+
+  p.command(:build) do |c|
+    c.syntax "jenner build"
+    c.description "Builds your Jenner site"
+
+    c.action do |args, options|
+      Jenner.build(args, options)
+    end
+  end
+end

data/jenner.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jenner/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "jenner"
+  gem.version       = Jenner::VERSION
+  gem.authors       = ["Jay Strybis"]
+  gem.email         = ["jay.strybis@gmail.com"]
+  gem.description   = %q{Jenner is an opinionated static site generator}
+  gem.summary       = %q{Jenner is an opinionated static site generator}
+  gem.homepage      = "http://github.com/unreal/jenner"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = ["jenner"]
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "liquid", "~> 2.6.1"
+  gem.add_dependency "maruku", "~> 0.7.1"
+  gem.add_dependency "mercenary", "~> 0.2.1"
+  gem.add_dependency "sass", "~> 3.2.13"
+  gem.add_development_dependency "test-unit", "~> 2.5.5"
+end

data/lib/jenner/item.rb

@@ -0,0 +1,65 @@
+module Jenner
+  class Item
+    attr_reader :body, :title, :date, :template_name, :data
+    def initialize(filename, site)
+      @filename = filename
+      @site     = site
+
+      @body = File.read(File.join(@site.root,'_site',@filename), encoding: "US-ASCII")
+
+      if @body =~ /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
+        @body   = $'
+        @header = YAML.load($1)
+      end
+
+      @title         = @header.delete("title")
+      @date          = @header.delete("date")
+      @template_name = @header.delete("template")
+      @tags          = @header.delete("tags")
+      @data          = @header
+    end
+
+    def url
+      "/#{@filename}"
+    end
+
+    def template
+      Jenner::Template.from_file(File.join(@site.root,'_templates',"#{@template_name}.html"), @site)
+    end
+
+    def to_liquid
+      {
+        'title'         => @title,
+        'date'          => @date,
+        'template_name' => @template_name,
+        'tags'          => @tags,
+        'data'          => @data,
+        'url'           => url
+      }
+    end
+
+    def markdown(s)
+      return s unless @filename.split('.').last == "markdown"
+
+      Maruku.new(s).to_html
+    end
+
+    def body
+      markdown(Liquid::Template.parse(@body).render('self' => self))
+    end
+
+    def render
+      template.render(
+        'item' => self.to_liquid.merge('body' => body)
+      )
+    end
+
+    def public_path
+      File.join(@site.root,'public',@filename)
+    end
+
+    def generate!
+      File.write(public_path,render)
+    end
+  end
+end

data/lib/jenner/site.rb

@@ -0,0 +1,68 @@
+module Jenner
+  class Site
+    attr_reader :root
+    def initialize(root)
+      @root = root
+
+      Liquid::Template.file_system = Jenner::TemplateFileSystem.new(File.join(@root,'_templates'))
+    end
+
+    def site_path
+      File.join(@root,"_site")
+    end
+
+    def files
+      Dir.glob(File.join(site_path,"[^_]*.{html,markdown}")) +
+        Dir.glob(File.join(site_path,"**","[^_]*.{html,markdown}"))
+    end
+
+    def relative_path(item)
+      (item.split("/") - site_path.split("/")).join("/")
+    end
+
+    def items
+      files.inject([]) { |a,i|
+        a << Jenner::Item.new(relative_path(i), self)
+      }
+    end
+
+    def public_dir
+      File.join(@root, "public")
+    end
+
+    def site_dir
+      File.join(@root, "_site")
+    end
+
+    def site_dirs
+      site_dir.split("/")
+    end
+
+    def relative_path_to_public(item)
+      (item.split("/") - site_dirs).join("/")
+    end
+
+    def generate!
+      FileUtils.rm_rf(public_dir)
+      FileUtils.mkdir(public_dir)
+
+      base_dirs = File.join(site_dir).split("/")
+      Dir.glob(File.join(@root,"_site","**","*")).each do |item|
+        if File.directory?(item)
+          FileUtils.mkdir_p(File.join(public_dir,relative_path_to_public(item)))
+        else
+          next if [".html",".markdown"].include? File.extname(item)
+          if File.extname(item) == ".scss"
+            engine = Sass::Engine.new(File.read(item), :syntax => :scss)
+            item = item.sub(".scss",".css")
+            File.write(File.join(public_dir,relative_path_to_public(item)),engine.render)
+          else
+            destination = File.join(public_dir,relative_path_to_public(item))
+            FileUtils.cp item, destination
+          end
+        end
+      end
+      items.map(&:generate!)
+    end
+  end
+end

data/lib/jenner/template.rb

@@ -0,0 +1,17 @@
+module Jenner
+  class Template
+    attr_reader :body
+    def initialize(body, site)
+      @body = body
+      @site = site
+    end
+
+    def render(context)
+      Liquid::Template.parse(@body).render(context)
+    end
+
+    def self.from_file(file_path, site)
+      new(File.read(file_path, encoding: 'US-ASCII'), site)
+    end
+  end
+end

data/lib/jenner/template_file_system.rb

@@ -0,0 +1,30 @@
+module Jenner
+  class TemplateFileSystem
+    attr_reader :root
+    def initialize(root)
+      @root = root
+      @pattern =  "%s.html"
+    end
+
+    def read_template_file(template_path, context)
+      full_path = full_path(template_path)
+      raise FileSystemError, "No such template '#{template_path}'" unless File.exists?(full_path)
+
+      File.read(full_path)
+    end
+
+    def full_path(template_path)
+      raise FileSystemError, "Illegal template name '#{template_path}'" unless template_path =~ /^[^.\/][a-zA-Z0-9_\/]+$/
+
+      full_path = if template_path.include?('/')
+        File.join(root, File.dirname(template_path), @pattern % File.basename(template_path))
+      else
+        File.join(root, @pattern % template_path)
+      end
+
+      raise FileSystemError, "Illegal template path '#{File.expand_path(full_path)}'" unless File.expand_path(full_path) =~ /^#{File.expand_path(root)}/
+
+      full_path
+    end
+  end
+end

data/lib/jenner/version.rb

@@ -0,0 +1,3 @@
+module Jenner
+  VERSION = "0.0.3"
+end

data/lib/jenner.rb

@@ -0,0 +1,18 @@
+require "bundler/setup"
+require "liquid"
+require "maruku"
+require "sass"
+
+require "jenner/item"
+require "jenner/site"
+require "jenner/template"
+require "jenner/template_file_system"
+require "jenner/version"
+
+module Jenner
+  def self.build(args, options={})
+    @site = Site.new(File.expand_path('.'))
+    puts "Building a site at #{@site.root}"
+    @site.generate!
+  end
+end

data/test/fixtures/source/_site/markdown_test.markdown

@@ -0,0 +1,8 @@
+---
+title:    'markdown test'
+date:     2014-01-23 17:02:00 -6
+template: 'wrapper'
+---
+
+# {{self.title}}
+item content

data/test/fixtures/source/_site/subdirectory/subfile.html

@@ -0,0 +1,7 @@
+---
+title:    'subfile'
+date:     2014-01-23 17:02:00 -6
+template: 'simple'
+---
+
+subfile

data/test/fixtures/source/_site/test.html

@@ -0,0 +1,11 @@
+---
+title:    'test'
+date:     2014-01-23 17:02:00 -6
+template: 'wrapper'
+tags:     [one, two, three]
+foo:      'bar'
+---
+
+{{self.title}}
+{{self.data.foo}}
+item content

data/test/fixtures/source/_site/test.scss

@@ -0,0 +1,5 @@
+$favorite-color: blue;
+
+body {
+  background-color: $favorite-color;
+}

data/test/fixtures/source/_templates/simple.html

@@ -0,0 +1 @@
+item: {{item.title}}

data/test/fixtures/source/_templates/test.html

@@ -0,0 +1 @@
+hi, {{name}}

data/test/fixtures/source/_templates/wrapper.html

@@ -0,0 +1,6 @@
+top
+{{item.title}}
+{{item.date}}
+{{item.template_name}}
+{{item.body}}
+bottom

data/test/helper.rb

@@ -0,0 +1,25 @@
+require 'bundler/setup'
+require 'test-unit'
+require 'jenner'
+
+module Test
+  module Unit
+    class TestCase
+      def setup
+        @site = Jenner::Site.new(File.join(File.dirname(__FILE__),'fixtures','source'))
+      end
+
+      def template_file(file_name)
+        File.join(File.dirname(__FILE__),'fixtures','source','_templates',file_name)
+      end
+
+      def site_file(path)
+        File.join(File.dirname(__FILE__),'fixtures','source', path)
+      end
+
+      def teardown
+        FileUtils.rm_rf(File.join(File.dirname(__FILE__),'fixtures','source','public'))
+      end
+    end
+  end
+end

data/test/jenner/test_item.rb

@@ -0,0 +1,63 @@
+require 'helper'
+
+class TestItem < Test::Unit::TestCase
+  def test_initialize
+    item = Jenner::Item.new('test.html',@site)
+    assert_equal "test", item.title
+    assert_equal Time.new(2014,1,23,17,2,0,"-06:00"), item.date
+    assert_equal "wrapper", item.template_name
+    assert_equal({ "foo" => "bar" }, item.data)
+  end
+
+  def test_template_is_a_jenner_template
+    item = Jenner::Item.new('test.html',@site)
+    assert_equal Jenner::Template, item.template.class
+  end
+
+  def test_render
+    item = Jenner::Item.new('test.html',@site)
+    assert_equal "top\ntest\n2014-01-23 17:02:00 -0600\nwrapper\ntest\nbar\nitem content\n\nbottom\n", item.render
+  end
+
+  def test_public_path
+    item = Jenner::Item.new('test.html',@site)
+    assert_equal site_file('public/test.html'), item.public_path
+  end
+
+  def test_generate!
+    item = Jenner::Item.new('test.html',@site)
+    # make the public dir for the item, since @site normally does it
+    FileUtils.mkdir(File.join(@site.root,'public'))
+    item.generate!
+    assert File.exists?(File.join(@site.root,'public','test.html'))
+    assert_equal item.render, File.read(File.join(@site.root,'public','test.html'), encoding: "US-ASCII")
+  end
+
+  def test_markdown_template
+    item = Jenner::Item.new('markdown_test.markdown', @site)
+    assert_equal "top\nmarkdown test\n2014-01-23 17:02:00 -0600\nwrapper\n\n<h1 id=\"markdown_test\">markdown test</h1>\n\n<p>item content</p>\n\nbottom\n", item.render
+  end
+
+  def test_public_path_on_subdir_item
+    item = Jenner::Item.new("subdirectory/subfile.html",@site)
+    assert_equal site_file("public/subdirectory/subfile.html"), item.public_path
+  end
+
+  def test_generate_on_subdir_item
+    item = Jenner::Item.new("subdirectory/subfile.html",@site)
+    FileUtils.mkdir_p(File.join(@site.root,'public','subdirectory'))
+    item.generate!
+    assert File.exists?(File.join(@site.root,'public','subdirectory','subfile.html'))
+    assert_equal "item: subfile\n", File.read(File.join(@site.root,'public','subdirectory','subfile.html'))
+  end
+
+  def test_url
+    item = Jenner::Item.new('test.html',@site)
+    assert_equal "/test.html", item.url
+  end
+
+  def test_url_on_subdir_item
+    item = Jenner::Item.new('subdirectory/subfile.html',@site)
+    assert_equal "/subdirectory/subfile.html", item.url
+  end
+end

data/test/jenner/test_site.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+class TestSite < Test::Unit::TestCase
+  def test_array_of_items
+    assert_equal Array, @site.items.class
+    assert @site.items.size > 0
+  end
+
+  def test_generate!
+    @site.generate!
+    assert File.exists?(site_file('public/test.html'))
+  end
+
+  def test_generate_creates_subdirectories
+    @site.generate!
+    assert Dir.exists?(File.join(@site.root,'public','subdirectory'))
+  end
+
+  def test_copies_files_in_subdirectories
+    @site.generate!
+    assert File.exists?(File.join(@site.root,'public','subdirectory','test.png'))
+  end
+
+  def test_creates_items_in_subdirectories
+    @site.generate!
+    assert File.exists?(File.join(@site.root,'public','subdirectory','subfile.html'))
+  end
+
+  def test_underscored_items_dont_get_copied
+    @site.generate!
+    assert !File.exists?(site_file('public/_hidden.html'))
+  end
+
+  def test_generates_sass
+    @site.generate!
+    assert File.exists?(site_file("public/test.css"))
+    assert_equal "body {\n  background-color: blue; }\n", File.read(site_file("public/test.css"), encoding: "US-ASCII")
+  end
+end

data/test/jenner/test_template.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+class TestTemplate < Test::Unit::TestCase
+  def test_initialize_with_a_string
+    template = Jenner::Template.new("test", @site)
+    assert_equal "test", template.body
+  end
+
+  def test_render_with_a_hash_context_returns_a_rendered_liquid_template
+    template = Jenner::Template.new("hi, {{name}}", @site)
+    assert_equal "hi, jay", template.render('name' => 'jay')
+  end
+
+  def test_initialize_from_file
+    template = Jenner::Template.from_file(template_file('test.html'), @site)
+    assert_equal "hi, {{name}}\n", template.body
+  end
+
+  def test_include
+    template = Jenner::Template.new("{% include 'test' %}", @site)
+    assert_equal "hi, jay\n", template.render('name' => 'jay')
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: jenner
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Jay Strybis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: maruku
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: mercenary
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.5
+description: Jenner is an opinionated static site generator
+email:
+- jay.strybis@gmail.com
+executables:
+- jenner
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/jenner
+- jenner.gemspec
+- lib/jenner.rb
+- lib/jenner/item.rb
+- lib/jenner/site.rb
+- lib/jenner/template.rb
+- lib/jenner/template_file_system.rb
+- lib/jenner/version.rb
+- test/fixtures/source/_site/_hidden.html
+- test/fixtures/source/_site/markdown_test.markdown
+- test/fixtures/source/_site/subdirectory/subfile.html
+- test/fixtures/source/_site/subdirectory/test.png
+- test/fixtures/source/_site/test.html
+- test/fixtures/source/_site/test.scss
+- test/fixtures/source/_templates/simple.html
+- test/fixtures/source/_templates/test.html
+- test/fixtures/source/_templates/wrapper.html
+- test/helper.rb
+- test/jenner/test_item.rb
+- test/jenner/test_site.rb
+- test/jenner/test_template.rb
+homepage: http://github.com/unreal/jenner
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Jenner is an opinionated static site generator
+test_files:
+- test/fixtures/source/_site/_hidden.html
+- test/fixtures/source/_site/markdown_test.markdown
+- test/fixtures/source/_site/subdirectory/subfile.html
+- test/fixtures/source/_site/subdirectory/test.png
+- test/fixtures/source/_site/test.html
+- test/fixtures/source/_site/test.scss
+- test/fixtures/source/_templates/simple.html
+- test/fixtures/source/_templates/test.html
+- test/fixtures/source/_templates/wrapper.html
+- test/helper.rb
+- test/jenner/test_item.rb
+- test/jenner/test_site.rb
+- test/jenner/test_template.rb
+has_rdoc: