RubyGems - stic - Versions diffs - 0.1.0 - Mend

stic 0.1.0

Files changed (640) hide show

data/README.md ADDED

@@ -0,0 +1,64 @@
+# [![Stic](https://raw.githubusercontent.com/jgraichen/stic/master/stic.png)](https://github.com/jgraichen/stic#readme)
+[![Build Status](http://img.shields.io/travis/jgraichen/stic.svg?style=flat)](https://travis-ci.org/jgraichen/stic)
+[![Code Climate](http://img.shields.io/codeclimate/github/jgraichen/stic.svg?style=flat)](https://codeclimate.com/github/jgraichen/stic)
+Opinionated extensible static site generator.
+## Description
+Still an opinionated extensible static site generator.
+## Installation
+    $ gem install stic
+## Usage
+TODO: ToDo
+## Example
+```
+$ cd example/
+$ bundle install
+$ bundle binstubs stic
+$ bin/stic
+```
+## Contributing
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add specs for you new feature
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request
+## ToDos
+* Post-Processors
+** Syntax highlighting for code blocks
+** oembed?
+* Checksum-based metadata.json to compile only changed things
+* Blog related generators
+* Sprockets for pimped assets
+## License
+```
+Copyright (C) 2013-2014 Jan Graichen
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see [http://www.gnu.org/licenses/].
+```

data/bin/stic ADDED

@@ -0,0 +1,8 @@
+#!/bin/env ruby
+STDOUT.sync = true
+require 'rubygems'
+require 'stic'
+require 'stic/cli'
+Stic::CLI.run(ARGV)

data/doc/file.README.html ADDED

@@ -0,0 +1,125 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<title>
+  File: README
+    &mdash; Documentation by YARD 0.8.7.4
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!file.README.html";
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">File: README</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><div id='filecontents'><h1>Stic</h1>
+<p>Opinionated extensible static site generator.</p>
+<h2>Description</h2>
+<p>Still an opinionated extensible static site generator.</p>
+<h2>Installation</h2>
+<pre class="code ruby"><code class="ruby">$ gem install stic
+</code></pre>
+<h2>Usage</h2>
+<p>TODO: ToDo</p>
+<h2>Example</h2>
+<pre class="code ruby"><code class="ruby">$ cd example/
+$ bundle install
+$ bundle binstubs stic
+$ bin/stic
+</code></pre>
+<h2>Contributing</h2>
+<ol>
+<li>Fork it</li>
+<li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
+<li>Add specs for you new feature</li>
+<li>Commit your changes (<code>git commit -am &#39;Add some feature&#39;</code>)</li>
+<li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
+<li>Create new Pull Request</li>
+</ol>
+<h2>License</h2>
+<p>Copyright (C) 2013-2014 Jan Graichen</p>
+<p>This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.</p>
+<p>This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.</p>
+<p>You should have received a copy of the GNU Affero General Public License
+along with this program. If not, see [<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>].</p>
+</div></div>
+    <div id="footer">
+  Generated on Sat Apr 19 13:08:12 2014 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.4 (ruby-2.1.1).
+</div>
+  </body>
+</html>

data/lib/stic.rb ADDED

@@ -0,0 +1,44 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'tilt'
+require 'rubypath'
+require 'yaml'
+require 'mime/types'
+require 'stic/version'
+module Stic
+  # Utilities
+  require 'stic/utils'
+  require 'stic/errors'
+  # Logic modules
+  require 'stic/layoutable'
+  require 'stic/readable'
+  require 'stic/renderable'
+  require 'stic/metadata'
+  require 'stic/site_base'
+  # Core classes
+  require 'stic/blob'
+  require 'stic/config'
+  require 'stic/file'
+  require 'stic/generator'
+  require 'stic/layout'
+  require 'stic/page'
+  require 'stic/renderer'
+  require 'stic/site'
+  module Generators
+    require 'stic/generators/static'
+    require 'stic/generators/page'
+  end
+  module Metadata
+    require 'stic/metadata/parser'
+    require 'stic/metadata/yaml'
+    require 'stic/metadata/html_yaml'
+    require 'stic/metadata/comment_yaml'
+    require 'stic/metadata/block_comment_yaml'
+  end
+end

data/lib/stic/blob.rb ADDED

@@ -0,0 +1,106 @@
+module Stic
+  #
+  # = Stic::Blob
+  # A {Blob} represents a single output file. It does not
+  # assume any specific source or processing.
+  #
+  # Blob provides the basic functionality {Site} expects
+  # for managing and writing blobs. Blob should not be used
+  # directly but sub-classed to provide an actual
+  # implementation of at least {#url_template} and {#render}.
+  #
+  # See {File} for a simple blob implementation serving a
+  # static file or {Page} for a more future rich example
+  # including rendering.
+  #
+  class Blob
+    include SiteBase
+    # @!group Accessors
+    # Return a the relative URL the blob should have in generated site. The URL
+    # is based on the URL template where placeholders are replaced with values
+    # from {#data}.
+    #
+    # Example: Given the URL template `/blog/:year/:slug.html` and a blob data
+    # hash of `{:year => 2014, :slug => 'a-blog-post'}` the resulting relative
+    # URL would be '/blog/2014/a-blog-post.html'. Only `A-z0-9_` are allowed as
+    # a placeholder.
+    #
+    # @return [Path] URL relative to site root but as an absolute path.
+    #
+    def relative_url
+      parts = url_template.each_component(empty: true).map do |fn|
+        fn =~ /^:([A-z0-9_]+)$/ ? data[$1] : fn
+      end
+      Path '/', parts
+    end
+    # Return the site relative target path.
+    #
+    # The relative target path must be based on the URL.
+    #
+    # The default implementation joins the relative URL with `index.html` if
+    # the relative URL does not have any file extension. Otherwise the
+    # relative URL will be returned.
+    #
+    # @return [Path] Target file path relative to site target path.
+    #
+    def relative_target_path
+      if relative_url.extensions.empty?
+        relative_url.join('index.html')
+      else
+        relative_url
+      end
+    end
+    # Return full target path.
+    #
+    # The target path is based on the site target dir and the relative target
+    # path. You should not override this method. Instead provide a custom
+    # relative target path or URL.
+    #
+    # @return [Pathname] Fill blob file path.
+    #
+    def target_path
+      site.target.join relative_target_path.as_relative
+    end
+    # Return the target file MIME type.
+    #
+    # The MIME type is determined using the {#relative_target_path} but can be
+    # overridden by subclasses.
+    #
+    # The MIME type is used for post-processing.
+    #
+    # @return [MIME::Type] MIME type.
+    #
+    def mime_type
+      types = MIME::Types.of relative_target_path.to_s
+      types.first
+    end
+    # @!group Actions
+    # Write rendered blob to file.
+    #
+    # Path from {#target_path} will be used as the file path.
+    #
+    # You should not override this method. Instead provide a custom {#render}
+    # method to customize written result.
+    #
+    def write
+      unless ::File.directory?((dir = ::File.dirname(target_path)))
+        FileUtils.mkdir_p dir
+      end
+      ::File.open target_path, 'w' do |file|
+        file.write render
+      end
+    end
+    def to_s
+      "#<#{self.class.name}:#{object_id} #{relative_target_path}>"
+    end
+  end
+end

data/lib/stic/cli.rb ADDED

@@ -0,0 +1,61 @@
+require 'opt'
+module Stic
+  #
+  module CLI
+    class << self
+      def parser
+        @opt ||= ::Opt.new.tap do |opt|
+          opt.option '--help, -h'
+          opt.option '--version, -v'
+        end
+      end
+      def run(argv)
+        result = parser.parse(argv)
+        if result.version
+          $stdout.puts "stic v#{Stic::VERSION}"
+          exit 0
+        elsif result.help
+          help
+          exit 0
+        else
+          result.command.shift.run(result)
+        end
+      end
+      def help
+        $stdout.puts <<-EOF.gsub(/^ {10}/, '')
+          NAME
+                stic - The static site generator. v#{Stic::VERSION}
+          SYNOPSIS
+                stic [command] [options]
+          DESCRIPTION
+                stic is a static site generation tool used to generate a set
+                of styled and linked HTML pages from different sources
+                like markdown.
+          GLOBAL OPTIONS
+                --help, -h
+                    Print this help text.
+                --version, -v
+                    Print stic version.
+          COMMANDS
+EOF
+        parser.commands.each do |command|
+          $stdout.puts command.to_help
+        end
+      end
+      require 'stic/cli/command'
+      ::Dir[::File.expand_path('../cli/commands/*.rb', __FILE__)].each do |file|
+        require file
+      end
+    end
+  end
+end

data/lib/stic/cli/command.rb ADDED

@@ -0,0 +1,78 @@
+module Stic
+  module CLI
+    #
+    class Command < ::Opt::Command
+      def run(_result)
+        raise NotImplementedError.new "Subclass #{self.class.name} to " \
+                                      'implement custom command.'
+      end
+      def site
+        @site ||= begin
+          Stic::Site.lookup.tap do |site|
+            unless site
+              puts 'Not in a stic site. You need to run the ' \
+                   '`stic` command within a stic site.'
+              exit 1
+            end
+          end
+        end
+      end
+      def to_help
+        <<-EOF.gsub(/^ {4}/, '')
+          build
+              Build current side ot given output path.
+              --target, -t
+                  Output path the side will be written to. Existing files
+                  will be overriden and/or deleted. Defaults to `site`
+                  in project root. (Not yet supported)
+        EOF
+      end
+      class << self
+        def define(name, &block)
+          CLI.parser.commands << new(name).tap do |cmd|
+            cmd.instance_eval(&block)
+          end
+        end
+      end
+    end
+    class Build < Command
+      define 'build' do
+        option '--target, -t', nargs: 1
+      end
+      def run(_result)
+        STDOUT.puts  " Configuration files: #{site.config.files.join(", ")}"
+        STDOUT.puts  "              Source: #{site.source}"
+        STDOUT.puts  "              Target: #{site.target}"
+        STDOUT.print '       Generating ... '
+        STDOUT.flush
+        str_length = 0
+        log = lambda do |str|
+          STDOUT.print "\r                      " + ' ' * str_length
+          STDOUT.print "\r                  ... #{str}"
+          STDOUT.flush
+          str_length = str.length
+        end
+        begin
+          site.run {|generator| log.call "Running #{generator.class.name}" }
+          site.write {|blob| log.call "Write #{blob.relative_url}" }
+          site.cleanup
+        rescue => e
+          STDOUT.puts
+          raise e
+        end
+        log.call 'done.'
+        STDOUT.puts
+      end
+    end
+  end
+end