CarmineContraption 0.1.0 → 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 20a2c70d35267d05960e810047bdef045d63b903
+  data.tar.gz: 553ea900ca9ae8dc4010f33173c2cca0f90b81dd
+SHA512:
+  metadata.gz: 059a83a1e06aa97cc8ab2c0bd9e6021f5d5ccc4f6f94088bf75fe3bbe38dea738c5920aab2c1189f550c902e2e19f0e69dde5980a3e483e2a7cfc8aecfb572d7
+  data.tar.gz: f6e16bea89780b765c77e7702a09cdf45f75aa677c9a1b545168c2e94db3834ddeeb806b26f93f3c3d50f502952fe4af4e122e5a92e6d70e0111ae8dec0f3c32

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+script bundle exec rake

data/Rakefile

@@ -1,13 +1,11 @@
-require 'pathname'
-require 'colorize'
+require 'rake/testtask'
 
 task default: [:test]
 
-task :test do
-  Pathname.glob("test/test_*.rb") do |path|
-    puts "\nExecuting #{path.basename.to_s.magenta}"
-    ruby path
-  end
+Rake::TestTask.new do |t|
+  t.libs << 'lib/carmine_contraption'
+  t.test_files = FileList['test/lib/carmine_contraption/test_*.rb']
+  t.verbose = true
 end
 
 task :build_gem do

data/Readme.md

@@ -18,7 +18,7 @@ Currently, Carmine Contraption requires ssh access to a web server and a Git rep
 I have published Carmine Contraption as a [gem on RubyGems.org](https://rubygems.org/gems/CarmineContraption). Just use `gem install CarmineContraption` to test it out.
 
 ### Content Folder Structure
-This is the tree that you write in. More specifically, the drafts folder. `content` is known as `source` within the bowels of Carmine Contraption.
+This is the tree that you write in. More specifically, the drafts folder. `content` is known as `source` within the bowels of Carmine Contraption. `formats` and `templates` contain layout and styling for posts. `formats` contain html templates for displaying individual posts. `templates` contain templates for displaying collections of posts.
 
     content
           |
@@ -28,11 +28,29 @@ This is the tree that you write in. More specifically, the drafts folder. `conte
           |        |
           |        |-- another_draft.md
           |
+          |-- formats
+          |         |
+          |         |-- article.html.erb
+          |         |
+          |         |-- link.html.erb
+          |         |
+          |         |-- raw.md.erb
+          |         |
+          |         |-- rss.xml.erb
+          |
           |-- posts
-                  |
-                  |-- 20120721-on-metaprogramming.html
-                  |
-                  |-- 20120801-example-post.md
+          |       |
+          |       |-- 20120721-on-metaprogramming.html
+          |       |
+          |       |-- 20120801-example-post.md
+          |
+          |-- templates
+                      |
+                      |-- default.html.erb
+                      |
+                      |-- landing_page.html.erb
+                      |
+                      |-- rss.xml.erb
 
 ### Server Folder Structure
 This layout is the living, breathing incarnation of your content. `www` is known as `destination` to Carmine Contraption. I have only listed the directories that Carmine Contraption will generate and modify. Other useful directories you may consider including are `css` and `js`.
@@ -79,13 +97,19 @@ The header tags can be placed in any order. Once Carmine Contraption encounters
 
 To mark a post as ready to publish add `publish-now` as a line anywhere in the file. This line will be replaced with the Publication timestamp.
 
+### Formatters and Templates
+Formatters and templates are very similar. Both are [ERB](http://ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html) files. Both are given one variable for parsing, `context`. The main distinction is the expected use case. Formatters are meant for styling/laying out a single post, while templates represent the overall structure of the website.  To handle the different purposes the contents of `context` are slightly different: formatters are given an instance of `CarmineContraption::Post`, while templates are passed a string containing a collection of formatted posts.
+
 ## Contributing
-### Build Status
-All statuses provided by [Gitlab CI](https://github.com/gitlabhq/gitlab-ci).
+To suggest a feature or report a bug create a [new issue](https://github.com/rampantmonkey/carmine_contraption/issues/new).
+
+Pull requests will also be considered.
+
+### Status
 
-- Master → ![master](http://ci.rampantmonkey.com/projects/1/status?ref=master)
-- Dev → ![dev](http://ci.rampantmonkey.com/projects/1/status?ref=dev)
-- Testing → ![testing](http://ci.rampantmonkey.com/projects/1/status?ref=testing)
+[![Build Status](https://travis-ci.org/rampantmonkey/carmine_contraption.png?branch=master)](https://travis-ci.org/rampantmonkey/carmine_contraption)
+[![Code Climate](https://codeclimate.com/github/rampantmonkey/carmine_contraption.png)](https://codeclimate.com/github/rampantmonkey/carmine_contraption)
+[![Gem Version](https://badge.fury.io/rb/CarmineContraption.png)](http://badge.fury.io/rb/CarmineContraption)
 
 ## License
 Carmine Contraption is licensed under [The MIT License](http://opensource.org/licenses/MIT).

data/carmine_contraption.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Casey Robinson"]
   s.email       = ["kc@rampantmonkey.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/rampantmonkey/carmine_contraption"
   s.summary     = "Static Website Generator"
   s.description = "Longer and more detailed version of summary..."
 

data/lib/carmine_contraption.rb

@@ -0,0 +1,34 @@
+require 'carmine_contraption/black_hole.rb'
+require 'carmine_contraption/error.rb'
+require 'carmine_contraption/formatter.rb'
+require 'carmine_contraption/index.rb'
+require 'carmine_contraption/media.rb'
+require 'carmine_contraption/options.rb'
+require 'carmine_contraption/post.rb'
+require 'carmine_contraption/runner.rb'
+require 'carmine_contraption/uploader.rb'
+require 'carmine_contraption/version.rb'
+require 'carmine_contraption/writer.rb'
+
+require 'yaml'
+
+module CarmineContraption
+  def Maybe value
+    value.nil? ? BlackHole.new : value
+  end
+
+  at_exit do
+    if $!
+      puts "Something bad happened. See `/tmp/crash.log` for details"
+      open('/tmp/crash.log', 'a') do |log|
+        error = { timestamp: Time.now,
+                  message:   $!.message,
+                  backtrace: $!.backtrace
+        }
+        YAML.dump error, log
+      end
+      exit!
+    end
+  end
+end
+

data/lib/carmine_contraption/black_hole.rb

@@ -0,0 +1,12 @@
+require_relative '../carmine_contraption'
+
+module CarmineContraption
+  class BlackHole
+    def method_missing *args, &block
+      self
+    end
+
+    def nil?; true; end
+  end
+end
+

data/lib/carmine_contraption/error.rb

@@ -0,0 +1,5 @@
+module CarmineContraption
+  class Error < StandardError; end
+
+  class MissingFormat < Error; end
+end

data/lib/carmine_contraption/formatter.rb

@@ -0,0 +1,34 @@
+require 'time'
+require 'erb'
+
+module CarmineContraption
+  class Formatter
+    attr_reader :directory
+
+    def initialize formatter_directory='./'
+      @directory = Pathname.new(formatter_directory).expand_path
+      find_formats
+    end
+
+    def format context, method
+      renderer = ERB.new formats_hash.fetch(method) { raise MissingFormat, "formatter #{method} not found" }.read
+      renderer.result binding
+    end
+
+    def formats
+      @formats.keys
+    end
+
+    private
+      def find_formats
+        tmp = {}
+        Pathname.glob(@directory+"*") { |path| tmp[path.basename.to_s.split('.')[0].to_sym] = path }
+        @formats = tmp
+      end
+
+      def formats_hash
+        @formats
+      end
+
+  end
+end

data/lib/carmine_contraption/index.rb

@@ -1,141 +1,82 @@
-require_relative 'month_transform.rb'
-require_relative 'post'
+require_relative '../carmine_contraption'
 require 'pathname'
 require 'time'
 require 'erb'
 require 'colorize'
+require 'date'
 
 module CarmineContraption
   class Index
-    include MonthTransform
-    attr_reader :yearly_archives, :monthly_archives, :tag_archives
+    attr_reader :base, :destination, :all_posts
 
-    def initialize source, destination, template, override=false
-      @source = source
+    def initialize base_path, destination
+      @base = base_path
+      @source = base_path + "posts"
       @destination = destination
-      raise "Template not found." unless template.file?
-      @template = template
-      @override = override
+      find_all_posts
     end
 
-    def build_monthly_archives
-      @monthly_archives = {}
-      collect_archives { |the_post| (@monthly_archives[the_post.year + the_post.month] ||=[]) << the_post}
+    def yearly_archives
+      build_yearly_archives unless @yearly
+      @yearly
     end
 
-    def build_tag_archives
-      @tag_archives = {}
-      collect_archives { |the_post| the_post.tags.each { |t| (@tag_archives[t.gsub(' ', '_').downcase] ||=[]) << the_post } }
+    def monthly_archives
+      build_monthly_archives unless @monthly
+      @monthly
     end
 
-    def build_yearly_archives
-      @yearly_archives = {}
-      collect_archives { |the_post| (@yearly_archives[the_post.year] ||= []) << the_post}
+    def tag_archives
+      build_tag_archives unless @tagly
+      @tagly
     end
 
-    def collect_archives
-      @all_posts.each do |a|
-        yield a
-      end
-    end
-
-    def find_all_posts
-      @all_paths = []
-      Pathname.glob(@source+"*.html") { |path| @all_paths << path}
-      Pathname.glob(@source+"*.md") { |path| @all_paths << path}
-      @all_posts = []
-      @all_paths.each do |path|
-        @all_posts << Post.from_file(path, path.extname)
-      end
-      @all_posts.sort!
+    def build_date_from_key k
+      d = Date.new k[0..3].to_i, k[4..5].to_i
     end
 
-    def write_file file, content='', supress_message=false
-      puts "Rendering #{file}".blue unless supress_message
-      renderer = ERB.new(@template.read)
-      file.open('w:UTF-8') { |f| f.write renderer.result(binding) }
+    def longest_tag
+      find_length_of_most_used_tag
     end
 
-    def write_individual_posts
-      @all_posts.each do |the_post|
-        path = @destination + the_post.year + the_post.month
-        path.mkpath
-        path += "#{the_post.guid}.html"
-        write_file path, the_post.formatted_output unless ( path.exist? and !@override )
+    private
+      def build_monthly_archives
+        @monthly = {}
+        collect_archives { |the_post| (@monthly[the_post.published.strftime "%Y%m"] ||=[]) << the_post}
       end
-    end
 
-    def write_main_page
-      content = ""
-      @all_posts[-8..-1].reverse.each do |the_post|
-        content << the_post.formatted_output
-      end
-      content << %Q{<section class="archive_title">\n<h2>Archives</h2>\n<section class="archives">\n}
-      @monthly_archives.keys.reverse.each do |k|
-        content << %Q{<a href="/#{k[0..3]}/#{k[4..5]}/" class="nohover">#{month_alpha_long k[4..5]} #{k[0..3]}</a>\n}
+      def build_tag_archives
+        @tagly = {}
+        collect_archives { |the_post| the_post.tags.each { |t| (@tagly[t.gsub(' ', '_').downcase] ||=[]) << the_post } }
       end
-      content << %Q{</section>\n</section>\n}
-      write_file @destination + "recent.html", content
-    end
 
-    def write_monthly_archives
-      @monthly_archives.keys.each do |k|
-        path = @destination + k[0..3] + k[4..5]
-        path.mkpath
-        content = "<h1 class=\"archive\">ARCHIVE FOR '<emph>#{(month_alpha_long k[4..5]).upcase} #{k[0..3]}</emph>'</h1>\n<hr class=\"subtleSep\" />"
-        @monthly_archives[k].each { |the_post| content << the_post.formatted_output }
-        write_file path+"index.html", content, true
+      def build_yearly_archives
+        @yearly = {}
+        collect_archives { |the_post| (@yearly[the_post.published.strftime "%Y"] ||= []) << the_post}
       end
-    end
 
-    def write_rss
-      content = %Q(<?xml version="1.0" encoding="utf-8" ?>\n<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom">\n<channel>\n<title>Rampant Monkey</title>\n<link>http://rampantmonkey.com</link>\n<description>Rampant Monkey - Kitchen Sink</description>\n<language>en-us</language>\n<atom:link href="http://rampantmonkey.com/rss.xml" rel="self" type="application/rss+xml" /><lastBuildDate>#{Time.now.strftime("%a, %d %b %Y %H:%M:%S %Z")}</lastBuildDate>\n)
-      @all_posts.reverse.each { |the_post| content += the_post.formatted_output 'rss' }
-      content += %Q(</channel>\n</rss>)
-      feed_path = @destination + "rss.xml"
-      feed_path.open('w:UTF-8') { |f| f.write(content) }
-      rss_base_path = @destination+"rss"
-      rss_base_path.mkpath
-      @tag_archives.keys.each do |k|
-        content = %Q(<?xml version="1.0" encoding="utf-8" ?>\n<rss version="2.0" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom">\n<channel>\n<title>Rampant Monkey</title>\n<link>http://rampantmonkey.com</link>\n<description>Rampant Monkey - #{k}</description>\n<language>en-us</language>\n<atom:link href="http://rampantmonkey.com/rss/#{k}.xml" rel="self" type="application/rss+xml" /><lastBuildDate>#{Time.now.strftime("%a, %d %b %Y %H:%M:%S %Z")}</lastBuildDate>\n)
-        @tag_archives[k].reverse.each { |the_post| content += the_post.formatted_output 'rss' }
-        content += %Q(</channel>\n</rss>)
-        (rss_base_path + "#{k}.xml").open('w:UTF-8') { |f| f.write(content) }
-      end
-      puts "Updating RSS feed".blue
-    end
 
-    def write_tag_archives
-      path = @destination + "tags"
-      path.mkpath
-      @tag_archives.keys.each do |k|
-        content = "<h1 class=\"archive\">ARCHIVE FOR '<emph>#{k.upcase.gsub('_', ' ')}</emph>' CATEGORY</h1>\n<hr class=\"subtleSep\" />"
-        @tag_archives[k].reverse.each { |the_post| content << the_post.formatted_output }
-        write_file path + "#{k.gsub(' ', '_').downcase}.html", content, true
+      def find_all_posts
+        @all_paths = []
+        Pathname.glob(@source+"*.html") { |path| @all_paths << path}
+        Pathname.glob(@source+"*.md") { |path| @all_paths << path}
+        @all_posts = []
+        @all_paths.each do |path|
+          @all_posts << Post.from_file(path, path.extname)
+        end
+        @all_posts.sort!
       end
-    end
 
-    def write_tag_cloud
-      path = @destination + "tags" + "index.html"
-      content = "<h1 class=\"archive\">TAG CLOUD</h1>\n<hr class=\"subtleSep\" />"
-      content += "<section class=\"tag_cloud \">\n"
-      max = @tag_archives.max_by { |k, v| v.length }[-1].length
-      @tag_archives.sort_by{|k,v| k}.each do |k, v|
-        size = (1+v.length.to_f/max) * 0.8
-        content += "<span style=\"font-size: #{size}em;\"><a href=\"tags/#{k.gsub(' ', '_').downcase}.html\">#{k.gsub('_', ' ')}</a></span>\n"
+
+      def collect_archives
+        @all_posts.each do |a|
+          yield a
+        end
       end
-      content += "</section>\n"
-      write_file path, content
-    end
 
-    def write_yearly_archives
-      @yearly_archives.keys.each do |k|
-        path = @destination + k
-        path.mkpath
-        content = "<h1 class=\"archive\">ARCHIVE FOR '<emph>#{k}</emph>'</h1>\n<hr class=\"subtleSep\" />"
-        @yearly_archives[k].each { |the_post| content << the_post.formatted_output }
-        write_file path+"index.html", content, true
+      def find_length_of_most_used_tag
+        tag_archives.max_by { |k,v| v.length }[-1].length
       end
-    end
+
   end
 end

data/lib/carmine_contraption/media.rb

@@ -15,7 +15,7 @@ module CarmineContraption
     end
 
     def remote_path
-      values[:remote_path]
+      values[:remote_path] + name.to_s
     end
 
     def update args={}

data/lib/carmine_contraption/post.rb

@@ -2,19 +2,14 @@
 
 require 'redcarpet'
 require 'colorize'
+require 'date'
 
-require_relative 'formatters'
-require_relative 'month_transform'
-require_relative 'media'
+require_relative '../carmine_contraption'
 
 module CarmineContraption
   class Post
-    attr_reader :title, :content, :extra, :guid, :summary, :published, :status, :type, :tags
-
-    include MonthTransform
 
     class << self
-      include MonthTransform
 
       def from_file path, extension=".html"
         guid = File.basename(path, extension)
@@ -35,46 +30,39 @@ module CarmineContraption
             if line =~ /^\s/
               new_post = new_post.update(content: raw_content[(i+1)..-1].join("\n"))
               break
-            end
-            l = line.split ': '
-            if l.length == 1
-              new_post = new_post.update(title: (ignore_separator l[0])) unless new_post.title
             else
-              case l[0].downcase
-              when /type/
-                new_post = new_post.update(type: l[1])
-              when /published/
-                new_post = new_post.update published: (convert_date l[1])
-              when /tags/
-                new_post = new_post.update tags: (parse_tags l[1])
-              when /extra/
-                new_post = new_post.update extra: (rejoin_string l)
-              when /summary/
-                new_post = new_post.update summary: (rejoin_string l)
-              end
+              new_post = process_header_line line, new_post
             end
           end
           new_post
         end
 
-        def ignore_separator line
-          line unless line =~ /^=+/
+        def process_header_line line, new_post
+          l = line.split ': '
+          if l.length == 1
+            new_post = new_post.update(title: (ignore_separator l[0])) unless new_post.title
+          else
+            new_post = new_post.update(header_switch l[0].downcase.to_sym, l)
+          end
+          new_post
         end
 
-        def convert_date date
-          if date =~ /^\D/
-            published = date.split(' ')
-            tmp = []
-            tmp[0] = "#{published[3]}-#{month_arabic published[2]}-#{published[1]}"
-            tmp[1] = published[4]
-            tmp[2] = '-0400'
-            tmp[2] = '-0500' if published[-1] == 'EST'
-            tmp.join(' ')
+        def header_switch sym, split_line
+          case sym
+          when :published
+            split_line[1] = split_line[1].gsub(/<\/p>/, '')
+            { published: (DateTime.parse split_line[1]) }
+          when :tags
+            { tags: (parse_tags split_line[1]) }
           else
-            date
+            { sym => rejoin_string(split_line) }
           end
         end
 
+        def ignore_separator line
+          line unless line =~ /^=+/
+        end
+
         def find_media content, path
           a = []
           content.scan(/<img src="([^"]*)"/) do |match|
@@ -114,66 +102,33 @@ module CarmineContraption
                    guid: '',
                    summary: '',
                    published: '',
+                   path: nil,
                    status: '',
                    type: '',
                    tags: [],
                    media: [],
-                   original_path: ''}
-      @defaults.merge!(opts)
-      @title = @defaults[:title]
-      @content = @defaults[:content]
-      @extra = @defaults[:extra]
-      @guid = @defaults[:guid]
-      @summary = @defaults[:summary]
-      @published = @defaults[:published]
-      @status = @defaults[:status]
-      @type = @defaults[:type]
-      @tags = @defaults[:tags]
+                   original_path: ''}.merge!(opts)
     end
 
-    def update opts={}
-      Post.new(@defaults.merge opts)
-    end
-
-    def year
-      @published[0..3]
+    def method_missing method, *args, &block
+      @defaults.fetch(method) { super }
     end
 
-    def month
-      @published[5..6]
-    end
-
-    def day
-      @published[8..9]
+    def update opts={}
+      Post.new(@defaults.merge opts)
     end
 
     def <=> other
       published <=> other.published
     end
 
-    def media
-      @defaults[:media]
-    end
-
-    def original_path
-      @defaults[:original_path]
-    end
-
-    def formatted_output method='type'
+    def formatted_output formatter, method=nil
       insert_remote_media_links
-      formatter = CarmineContraption::RawFormatter.new
-      case method
-      when 'type'
-        case @type.downcase
-        when /article/
-          formatter = CarmineContraption::ArticleFormatter.new
-        when /link/
-          formatter = CarmineContraption::LinkFormatter.new
-        end
-      when 'rss'
-        formatter = CarmineContraption::RssFormatter.new
+      if method
+        formatter.format self, method
+      else
+        formatter.format self, type.chomp.downcase.to_sym
       end
-      formatter.format_post self
     end
 
     private