contraption 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1c34da43377fb2b0cec9e0c8cf821867a18a85b
+  data.tar.gz: 8623c83b4113c1878756257ea4f43f02d8fa8ab4
+SHA512:
+  metadata.gz: 873f12c0aa72c64145879a0b09564419aef292d60fd3eee8d00553c9639279ec353b21a0c5bc77e3558ad6dc8ab7223f34b186b98263daff0c847aa1c20e4d4a
+  data.tar.gz: 78c1b4f321c8327e687f542dfc508a0f4bf8df61ed8e71a4f463fd1a5e2bdced4b9b5bf82987d5e642c5bd5f7b721e38612a2b6f2c248eceb18e7e001f195fb9

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Casey Robinson
+
+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,33 @@
+# Contraption
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'contraption'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install contraption
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+[![Code Climate](https://codeclimate.com/github/rampantmonkey/contraption.png)](https://codeclimate.com/github/rampantmonkey/contraption)
+[![Build Status](https://travis-ci.org/rampantmonkey/contraption.png?branch=master)](https://travis-ci.org/rampantmonkey/contraption)
+[![Coverage Status](https://coveralls.io/repos/rampantmonkey/contraption/badge.png?branch=master)](https://coveralls.io/r/rampantmonkey/contraption?branch=master)
+## 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,12 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+task :default => [:spec, :features]
+

data/bin/contraption

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'contraption/options'
+require 'contraption/runner'
+
+options = Contraption::Options.new ARGV
+Contraption::Runner.new(options).run!

data/contraption.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'contraption/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "contraption"
+  spec.version       = Contraption::VERSION
+  spec.authors       = ["Casey Robinson"]
+  spec.email         = ["kc@rampantmonkey.com"]
+  spec.description   = %q{Static site generator}
+  spec.summary       = %q{Static site generator}
+  spec.homepage      = "http://rampantmonkey.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13"
+  spec.add_development_dependency "cucumber", "~> 1.3"
+  spec.add_development_dependency "coveralls", "~> 0.6"
+
+  spec.add_dependency "redcarpet", "~> 2.3"
+  spec.add_dependency "aws-s3",    "~> 0.6.3"
+end

data/features/author_finalizes_draft.feature

@@ -0,0 +1,21 @@
+Feature: Author finalizes draft
+
+  As an author
+  I have a draft
+  That I want to finalize for publication
+
+  Scenario: finalize draft
+    Given I have a valid project
+    Given I have a completed draft
+    Given I have a raw format
+    Given I have a article format
+    Given I have a page format
+    Given I have a month format
+    Given I have a year format
+    Given I have a tag format
+    Given I have a tag_cloud format
+    Given I have a landing_page format
+    When I run contraption
+    Then I should have a new post
+    And The post should be the formatted version of the draft
+    And The draft should be removed

data/features/author_generates_site.feature

@@ -0,0 +1,35 @@
+Feature: Author generates website
+
+  As an author
+  I have many posts
+  That I want to publish
+
+  Scenario: generate individual posts
+    Given I have a valid project
+    Given I have a raw format
+    Given I have a article format
+    Given I have a page format
+    Given I have a month format
+    Given I have a year format
+    Given I have a tag format
+    Given I have a tag_cloud format
+    Given I have a landing_page format
+    Given The project has a post titled "A sample post" from 3 Feb 2012 tagged funny
+    Given The project has a post titled "Purple People Eaters" from 1 Mar 2013 tagged funny
+    Given The project has a post titled "Flying Monkeys" from 8 Mar 2013 tagged strange
+    When I run contraption
+    Then The site should contain 2012/02/a-sample-post.html
+    Then The site should contain 2013/03/purple-people-eaters.html
+    Then The site should contain 2013/03/flying-monkeys.html
+    Then The site should contain 2012/02/index.html
+    Then The site should contain 2013/03/index.html
+    Then The site should contain 2012/index.html
+    Then The site should contain 2013/index.html
+    Then The site should contain tags/funny/index.html
+    Then The site should contain tags/strange/index.html
+    Then The site should contain tags/index.html
+    Then The site should contain recent.html
+    And  'recent.html' should have "Flying Monkeys" before "Purple People Eaters".
+    Then The site should contain index.html
+    Then The site should contain rss
+

data/features/step_definitions/author_steps.rb

@@ -0,0 +1,52 @@
+require 'pathname'
+
+Given(/^I have a valid project$/) do
+  @root = Pathname.new('tmp/data')
+  @root.mkpath
+  @required_paths = %w[drafts posts formats].map{|p| @root + p}
+  @required_paths.each{|p| p.mkpath}
+end
+
+Given(/^I have a (\w+?) format$/) do |format_name|
+  create_format "#{format_name}", @root + 'formats'
+end
+
+Given(/^I have a completed draft$/) do
+  @post_name = 'testing-testing.md'
+  create_test_draft @post_name, (@root + 'drafts')
+end
+
+When(/^I run contraption$/) do
+  @output = @root + '..' + 'output'
+  `ruby -Ilib bin/contraption -s #{@root} -d #{@output}`
+end
+
+Then(/^I should have a new post$/) do
+  @post_path = @root + 'posts' + "#{Date.today.strftime('%Y%m%d-')+@post_name}"
+  File.exist?(@post_path).should be_true
+end
+
+Then(/^The draft should be removed$/) do
+  File.exist?(@root + 'drafts' + @post_name).should be_false
+end
+
+Then(/^The post should be the formatted version of the draft$/) do
+  post_content = File.read(@post_path)
+  post_content.should_not include('Contraption::Post')
+  post_content.should_not include('Published: now')
+end
+
+Given(/^The project has a post titled "(.*)" from (\d+) (\S+) (\d+) tagged (\S+)$/) do |title, day, month, year, tags|
+  publication = "#{day} #{month} #{year}"
+  p = create_post_with published: publication, title: title, tags: tags
+  save_post p, @root + 'posts'
+end
+
+Then(/^The site should contain (.*)$/) do |path|
+  File.exist?(@output + path).should be_true
+end
+
+Then(/^'(.*?)' should have "(.*?)" before "(.*?)"\.$/) do |path, first_string, second_string|
+  content = File.read(@output+path)
+  content.index(first_string).should < content.index(second_string)
+end

data/features/support/example_inputs.rb

@@ -0,0 +1,188 @@
+require_relative '../../lib/contraption/header'
+require_relative '../../lib/contraption/post'
+
+def create_test_draft name, path
+  content =<<-POST
+Testing... Testing...
+Type: Article
+Tags: Test
+Summary: Testing.
+Published: now
+
+Testing whether the markdown support works.
+
+Code sample
+    #include<iostream>
+
+    int main(){
+    std::cout << "Hello World.\\n";
+    return 0;
+    }
+
+Some __bold text__.
+
+And an image for good luck ![test](test2.jpg)
+  POST
+  write_file content, path+name
+end
+
+def create_post_with opts={}
+
+end
+
+def create_format name="raw", path
+  format = case name
+  when /article/
+    article_format
+  when /landing_page/
+    landing_page_format
+  when /page/
+    page_format
+  when /month/
+    month_format
+  when /year/
+    year_format
+  when /tag_cloud/
+    tag_cloud_format
+  when /tag/
+    tag_format
+  else
+    raw_format
+  end
+  write_file format, path+"#{name}.erb"
+end
+
+def raw_format
+  <<-'FORMAT'
+<%=context.title%>
+Type: <%=context.type%>
+Tags: <%=context.tags%>
+Published: <%=context.publication_date%>
+Summary: <%=context.summary%>
+
+<%=context.body%>
+  FORMAT
+end
+
+def month_format
+  <<-'FORMAT'
+<h1 class=\"archive\">ARCHIVE FOR '#{context[:month].month} #{context[:month].year}'</h1>\n<hr class=\"subtleSep\" />
+<%= context[:content] %>
+
+  FORMAT
+end
+
+def year_format
+  <<-'FORMAT'
+<h1 class=\"archive\">ARCHIVE FOR '#{context[:year].year}'</h1>\n<hr class=\"subtleSep\" />
+<%= context[:content] %>
+
+  FORMAT
+end
+
+def tag_format
+  <<-'FORMAT'
+<h1 class-\"archive\"ARCHIVE FOR '#{context[:tag]}'</h1><\n<hr class=\"subtleSep\" />
+<%= context[:content] %>
+  FORMAT
+end
+
+def tag_cloud_format
+  <<-'FORMAT'
+<%= context[:content] %>
+  FORMAT
+end
+
+def article_format
+  <<-'FORMAT'
+<article class="group">
+  <div class="grid14 thetitle">
+    <h1><%= context.title %></h1>
+  </div>
+  <div class="metadata grid2">
+    <span class="date">
+      <%= context.publication_date.strftime("%-d %b %Y")%>
+    </span>
+    <% context.tags.each do |t| %>
+      <span class="tag">
+        <a href="/tags/<%= t.to_s.gsub ' ', '_' %>">
+          <%= t.to_s %>
+        </a>
+      </span>
+    <% end %>
+  </div>
+  <div class="grid14">
+    <%= context.body %>
+  </div>
+</article>
+  FORMAT
+end
+
+def page_format
+  <<-'FORMAT'
+<!doctype html>
+<body>
+  <section class="sidebar">
+  </section>
+  <section class="content">
+  <%= context %>
+  </section>
+</body>
+  FORMAT
+end
+
+def landing_page_format
+  <<-'FORMAT'
+  <!doctype html>
+  <body class="land">
+  <section class="banner">
+  <img src="logo.png" />
+  <nav>
+    <ul>
+      <li><a href="recent.html">Posts</a></li>
+      <li><a href="projects.html">Projects</a></li>
+    </ul>
+  </nav>
+  </section>
+  <%= context[:most_recent].title %>
+  </body>
+  </html>
+  FORMAT
+end
+
+def default_post_params
+  {
+   title:     random_string,
+   type:      "Article",
+   tags:      "Test, demo",
+   summary:   "Teaser",
+   published: "now",
+   content:   "Some repeated content.\n\n"*10
+  }
+end
+
+def create_post_with options={}
+  opts = default_post_params.merge(options)
+  s = []
+  s << opts.fetch(:title)
+  s << "Type: #{opts.fetch(:type)}"
+  s << "Tags: #{opts.fetch(:tags)}"
+  s << "Summary: #{opts.fetch(:summary)}"
+  s << "Published: #{opts.fetch(:published)}"
+  s << ""
+  s << opts.fetch(:content)
+  s.join "\n"
+end
+
+def save_post post, path
+  filename = post.split("\n").first.downcase.gsub(/ /, '-') + ".md"
+  write_file post, path + filename
+end
+
+def write_file content, path
+  File.open(path, "w:UTF-8"){|o| o.puts content}
+end
+
+def random_string length=8
+  (1..length).map{('a'..'z').to_a[rand(26)] }.join
+end

data/features/support/hooks.rb

@@ -0,0 +1,3 @@
+After do
+  `rm -rf tmp`
+end

data/lib/contraption/catalog.rb

@@ -0,0 +1,65 @@
+require_relative '../contraption'
+
+module Contraption
+  class Catalog
+    include Enumerable
+
+    attr_reader :items
+
+    def initialize items
+      @items = Array items
+    end
+
+    def << new_item
+      @items.concat(Array new_item)
+    end
+
+    def by_year
+      by_date { |date| Year.new date.year }
+    end
+
+    def by_month
+      by_date { |date| Month.new date.year, date.month }
+    end
+
+    def by_day
+      by_date { |date| Day.new date.year, date.month, date.day }
+    end
+
+    def by_tag
+      all(:tags).each_with_object(Hash.new {|h,k| h[k] = []}) do |tag, result|
+        items.each do |item|
+          result[tag.to_sym] << item if item.tags.include? tag
+        end
+      end
+    end
+
+    def each
+      items.each
+    end
+
+    def most_recent n=1
+      n = items.length if n < 0
+      items.sort_by{ |item| item.publication_date }
+           .reverse
+           .take n
+    end
+
+    private
+    def by &block
+      items.group_by do |item|
+        yield item
+      end
+    end
+
+    def by_date &block
+      by { |i| yield block.call(i.publication_date) }
+    end
+
+    def all attribute
+      items.map{|item| item.public_send(attribute.to_sym)}
+           .flatten
+           .uniq
+    end
+  end
+end

data/lib/contraption/formatter.rb

@@ -0,0 +1,30 @@
+require 'erb'
+
+module Contraption
+  class Formatter
+    def initialize location
+      @source = location
+      find_formats
+    end
+
+    def format context, method=nil
+      renderer(method || context.type).result binding
+    end
+
+    def formats
+      @formats.keys
+    end
+
+    private
+    def find_formats
+      @formats = @source.list('.erb')
+                        .inject({}){|collection, f| collection[f.split('.').first.to_sym] = f; collection}
+    end
+
+    def renderer type
+      ERB.new @source.read(
+        @formats.fetch(type){ raise ArgumentError, "#{type} is not a valid format" }
+      )
+    end
+  end
+end

data/lib/contraption/header.rb

@@ -0,0 +1,83 @@
+require 'date'
+require_relative 'tag'
+
+module Contraption
+  class Header
+    class << self
+      def from string
+        Header.new (Hash[
+            string.lines
+                  .map{|l| process l}
+                  .reject{|l| l == nil}
+        ])
+      end
+
+      private
+        def process line
+          return nil if /^=+$/.match line
+          splitted = line.strip.split /^(\w+):\s+/, 2
+          return [:title, line.strip.chomp] if splitted.count == 1
+
+          key = splitted[1].downcase.to_sym
+          raw_value = splitted[2].strip
+          case key
+          when :external
+            [:external, raw_value]
+          when :filename
+            [:filename, raw_value]
+          when :published
+            [:publication_date, determine_date(raw_value)]
+          when :summary
+            [:summary, raw_value]
+          when :tags
+            [:tags, raw_value.split(/,\s+/).map{|t| Tag.new t}]
+          when :type
+            [:type, raw_value.downcase.to_sym]
+          when :title
+            [:title, raw_value]
+          else
+            nil
+          end
+        end
+
+        def determine_date raw_value
+          if raw_value.downcase == "now"
+            :now
+          else
+            DateTime.parse(raw_value)
+          end
+        end
+    end
+
+    def initialize opts={}
+      @defaults = { title: "",
+                    publication_date: "",
+                    summary: "",
+                    type: "",
+                    tags: []}.merge!(opts)
+    end
+
+    def filename ext='.md'
+      fn = @defaults.fetch(:filename) do
+        title.downcase
+             .gsub(/[^\w\s-]+/, ' ')
+             .strip
+             .gsub(/\s+/, '-') + ext
+      end.split ext
+      fn.join + ext
+    end
+
+    def update new_opts={}
+      Header.new @defaults.merge(new_opts)
+    end
+
+    def new?
+      publication_date == :now
+    end
+
+    private
+      def method_missing m, *a, &b
+        @defaults.fetch(m) { super }
+      end
+  end
+end

data/lib/contraption/http_handler.rb

@@ -0,0 +1,11 @@
+module Contraption
+  class HttpHandler
+    def protocol
+      :http
+    end
+
+    def handle request
+      request
+    end
+  end
+end