ignoramos 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33b3c974ee5d9c39f5917c0cfbf433aa443ff6ec
+  data.tar.gz: 5d636d2196ac7dbc69fe47c9112fc853a52a0d8a
+SHA512:
+  metadata.gz: f1e9153849efd1bfc9f0c217e54c8c58fba6b12e5c419792edc15ac10f06d0a8e3a4e6f325bb6e24405cae5403c27523fb649218eea0f63f58d1e7be8ac762bc
+  data.tar.gz: 3a96d8a332415d5531c8b41826910b25748533687f997045d848985e0356cf5d65fbec76b6a527566f64a9722b15a673410355e0c12be2fb4c2d7d530dfdfa8c

data/.gitignore

@@ -0,0 +1,22 @@
+*.a
+*.bundle
+*.gem
+*.o
+*.rbc
+*.so
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+mkmf.log
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ignoramos.gemspec
+gemspec
+
+gem 'liquid', '~> 2.6.1'
+gem 'redcarpet', '~> 3.1.2'
+gem 'rouge', '~> 1.6.1'
+gem 'twitter', '~> 5.11.0'
+
+group :development, :test do
+  gem 'rspec', '~> 3.0.0'
+  gem 'fakefs', '~> 0.5.0'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'coveralls', require: false
+  gem 'timecop'
+end

data/Guardfile

@@ -0,0 +1,8 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/commands/(.+)\.rb$})     { |m| "spec/commands/#{m[1]}_spec.rb" }
+  watch(%r{^lib/models/(.+)\.rb$})     { |m| "spec/models/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Amos Chan
+
+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,63 @@
+Ignoramos: A static-site generator
+==================================
+
+[![Build
+Status](https://travis-ci.org/achan/ignoramos.svg?branch=master)](https://travis-ci.org/achan/ignoramos)
+[![Code
+Climate](https://codeclimate.com/github/achan/ignoramos/badges/gpa.svg)](https://codeclimate.com/github/achan/ignoramos)
+[![Coverage
+Status](https://img.shields.io/coveralls/achan/ignoramos.svg)](https://coveralls.io/r/achan/ignoramos)
+
+Getting started
+===============
+
+```
+~ $ gem install ignoramos
+~ $ ignoramos new mysite
+```
+
+The `new` command will create a directory with the name provided and the
+directory structure below.
+
+Directory structure
+===================
+
+```
+.
+├── _config.yml
+├── _drafts
+|   ├── not-ready-to-be-published.md
+|   └── to-be-reviewed-by-editor.md
+├── _includes
+|   ├── footer.html
+|   └── header.html
+├── _layouts
+|   ├── default.html
+|   └── post.html
+├── _posts
+|   ├── 2014-06-22-hello-world.md
+|   └── 2014-07-19-hello-world-pt-2.md
+└── _site
+    └── <point web root here>
+```
+
+```
+$ ignoramos build
+```
+
+The `build` command is expected to be run at the root directory of the
+application. It will generate all posts in the `_posts` directory and copy
+every file not prefixed with `_` into `_site`.
+
+How posts are built
+===================
+
+ - Load the markdown file
+ - Parse the post for YAML to determine layout
+ - Render layout as content
+ - Render liquid layout (header, footer, content)
+
+After all posts and pages are generated, all remaining files that are not from a
+folder prefixed with `_` will be copied over to `_site`. Custom files take
+precedence, so if your files conflict with generated ones, yours will overwrite
+the generated file.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'coveralls'
+Coveralls.wear!
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/ignoramos

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'ignoramos'
+
+Ignoramos.new(ARGV)

data/ignoramos.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "ignoramos"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Amos Chan"]
+  spec.email         = ["amosschan@gmail.com"]
+  spec.summary       = %q{A static site generator for blogs and microposts.}
+  spec.description   = spec.summary
+  spec.homepage      = "http://rubygems.org/gems/ignoramos"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/commands/build_command.rb

@@ -0,0 +1,188 @@
+require 'liquid'
+require 'fileutils'
+require 'models/post'
+require 'models/page'
+require 'models/app_config'
+
+class BuildCommand
+  def initialize(dir = Dir.pwd)
+    @dir = dir
+  end
+
+  def execute
+    Liquid::Template.file_system = Liquid::LocalFileSystem.new("#{ @dir }/_includes")
+    FileUtils.rm_rf("#{ @dir }/_site")
+    mkdir_p("_site")
+
+    generate_pages
+    generate_posts
+    generate_tags_index
+    generate_homepage
+
+    copy_custom_files
+  end
+
+  private
+  def config
+    @config ||= AppConfig.new(read_file("_config.yml"))
+  end
+
+  def copy_custom_files
+    custom_files.each { |fn| copy_into_site(fn) }
+  end
+
+  def copy_into_site(filename)
+    destination = sandbox_filename(filename)
+
+    if File.directory?(filename)
+      destination = destination.slice(0..(destination.rindex('/')))
+    end
+
+    FileUtils.cp_r(filename, destination)
+  end
+
+  def sandbox_filename(filename)
+    filename.gsub(@dir, "#{ @dir }/_site")
+  end
+
+  def custom_files
+    @custom_files ||= Dir.glob("#{@dir}/[^_]*")
+  end
+
+  def posts
+    @posts ||= load_posts
+  end
+
+  def pages
+    @pages ||= load_posts('_pages') { |contents| Page.new(contents) }
+  end
+
+  def load_posts(dir='_posts', &block)
+    posts = []
+
+    Dir.foreach("#{ @dir }/#{ dir }") do |item|
+      next if item == '.' || item == '..'
+
+      contents = read_file("#{ dir }/#{ item }")
+      posts << if block_given?
+        yield contents
+      else
+        Post.new(contents)
+      end
+    end
+
+    posts
+  end
+
+  def generate_pages
+    generate_dir(pages, 'page') { |p| { 'page' => p } }
+  end
+
+  def generate_posts
+    generate_dir(posts, 'post') { |p| { 'post' => p } }
+  end
+
+  def generate_dir(posts, template, &block)
+    posts.each do |post|
+      params = yield post
+      layout = read_file("_layouts/#{ post.vars['layout'] }/#{ template }.liquid")
+      post_params = { 'site' => site_config }.merge(params.merge(post.vars))
+      post_params['title'] = "#{ post_params['title'] } - #{ config.vars['site']['name'] }"
+      mkdir_p("_site#{ post.path }")
+      new_file("_site#{ post.permalink }",
+               Liquid::Template.parse(layout).render(post_params))
+    end
+  end
+
+  def tags
+    tags = {}
+    posts.each do |p|
+      p.tags.each do |t|
+        tags[t] ||= []
+        tags[t] << p
+      end
+    end
+
+    tags.sort.map do |name, posts|
+      { 'name' => name, 'posts' => posts.sort_by { |p| p.title } }
+    end
+  end
+
+  def generate_tags_index
+    new_tags_index_file("_site/tags.html",
+                        "Tag Index - #{ config.vars['site']['name'] }",
+                       tags)
+
+    generate_index_per_tag
+  end
+
+  def tags_layout
+    @layout ||= read_file("_layouts/default/tags.liquid")
+  end
+
+  def new_tags_index_file(filename, title, tags)
+    new_file(filename,
+             Liquid::Template.parse(tags_layout).render({
+               'title' => title,
+               'tags' => tags,
+               'site' => site_config
+             }))
+  end
+
+  def generate_index_per_tag
+    mkdir_p("_site/tags")
+
+    tags.each do |tag|
+      new_tags_index_file("_site/tags/#{ tag['name'] }.html",
+                          "##{ tag['name'] } - #{ config.vars['site']['name'] }",
+                          [tag])
+    end
+  end
+
+  def generate_homepage
+    homepage_posts = posts.sort_by { |p| [p.timestamp, p.title] }.
+                           reverse.
+                           first(5)
+
+    layout = read_file("_layouts/default/posts.liquid")
+
+    new_file("_site/index.html",
+             Liquid::Template.parse(layout).render({
+               'posts' => homepage_posts,
+               'title' => config.vars['site']['name'],
+               'site' => site_config
+             }))
+  end
+
+  def site_config
+    {
+      "description" => config.site_description,
+      "site_map" => config.site_map,
+      "user" => config.user
+    }
+  end
+
+  def mkdir_p(dir)
+    FileUtils.mkdir_p("#{ @dir }/#{ dir }")
+  end
+
+  def new_file(filename, contents)
+    new_post_file = File.new("#{ @dir }/#{ filename }", 'w')
+    new_post_file.write(contents)
+    new_post_file.close
+  end
+
+  def read_file(filename)
+    File.open("#{ @dir }/#{ filename }", 'r') do |file|
+      file.read()
+    end
+  end
+
+  def cache
+    @cache ||= {}
+  end
+
+  def template(layout)
+    cache[layout.to_sym] ||= read_file("_layouts/#{ layout }/post.liquid")
+  end
+end

data/lib/commands/new_command.rb

@@ -0,0 +1,34 @@
+require 'fileutils'
+
+class NewCommand
+  attr_accessor :dir
+
+  def initialize(dir)
+    @dir = dir.to_s
+  end
+
+  def execute
+    FileUtils.mkdir_p([
+      "#{ @dir }/_drafts",
+      "#{ @dir }/_includes",
+      "#{ @dir }/_layouts",
+      "#{ @dir }/_pages",
+      "#{ @dir }/_posts",
+      "#{ @dir }/_site"
+    ])
+
+    blog_name = 'My First Blog'
+    tagline = 'A short description of my blog'
+    desc = 'Site description'
+
+    new_file("_config.yml",
+             "---\nsite:\n  name: #{ blog_name }\n  tagline: #{ tagline }\n  description: #{ desc }")
+  end
+
+  private
+  def new_file(filename, contents)
+    new_post_file = File.new("#{ @dir }/#{ filename }", 'w')
+    new_post_file.write(contents)
+    new_post_file.close
+  end
+end

data/lib/commands/tweet_command.rb

@@ -0,0 +1,64 @@
+require 'liquid'
+require 'fileutils'
+require 'models/post'
+require 'models/app_config'
+require 'twitter'
+require 'twitter/tweet'
+
+class TweetCommand
+  LAYOUT = <<-LAYOUT
+---
+title: tweet {{tweet.id}}
+timestamp: {{tweet.timestamp}}
+layout: tweet
+tweet: {{tweet.url}}
+---
+
+{{tweet.content}}
+LAYOUT
+
+  def initialize(tweet)
+    @tweet = tweet
+    @dir = Dir.pwd
+  end
+
+  def execute
+    tweet = twitter.update(@tweet)
+
+    new_file("_posts/tweet-#{tweet.id}.md",
+             Liquid::Template.parse(LAYOUT).render({
+               'tweet' => {
+                 'content' => @tweet,
+                 'id' => tweet.id,
+                 'url' => tweet.uri.to_s,
+                 'timestamp' => DateTime.now
+               }
+             }))
+  end
+
+  private
+  def app_config
+    @config ||= AppConfig.new(read_file("_config.yml"))
+  end
+
+  def new_file(filename, contents)
+    new_post_file = File.new("#{@dir}/#{filename}", 'w')
+    new_post_file.write(contents)
+    new_post_file.close
+  end
+
+  def read_file(filename)
+    File.open("#{@dir}/#{filename}", 'r') do |file|
+      file.read()
+    end
+  end
+
+  def twitter
+    @twitter ||= Twitter::REST::Client.new do |config|
+      config.consumer_key        = "RerlMuPVgYySMdqvuaBeSw"
+      config.consumer_secret     = "Ccq3hS7fMplpjwCfvpVyPQXV6nPGGGonXSAdmi8ZIc"
+      config.access_token        = app_config.vars['twitter']['access_token']
+      config.access_token_secret = app_config.vars['twitter']['access_token_secret']
+    end
+  end
+end