CarmineContraption 0.0.6 → 0.1.0

data/Rakefile

@@ -14,3 +14,7 @@ task :build_gem do
   system "gem build carmine_contraption.gemspec"
   system "mv *.gem pkg/"
 end
+
+task :publish do
+  system "ruby -I lib bin/carmine_contraption -a"
+end

data/Readme.md

@@ -14,6 +14,9 @@ I created Carmine Contraption as a learning experience to explore many of the un
 ## Getting Started
 Currently, Carmine Contraption requires ssh access to a web server and a Git repository for the site's content. First let's take a look at the folder structures that Carmine Contraption works with.
 
+## Gem
+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.
 

data/carmine_contraption.gemspec

@@ -20,7 +20,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency 'shoulda', '~> 3.3.2'
-  s.add_development_dependency 'rake', '~> 0.9.2.2'
+  s.add_development_dependency 'rake',    '~> 0.9.2.2'
 
-  s.add_runtime_dependency 'colorize', '~> 0.5.8'
+  s.add_runtime_dependency 'colorize',  '~> 0.5.8'
+  s.add_runtime_dependency 'redcarpet', '~> 2.2.2'
+  s.add_runtime_dependency 'aws-s3',    '~> 0.6.3'
 end

data/lib/carmine_contraption/formatters.rb

@@ -5,7 +5,7 @@ module CarmineContraption
   class ArticleFormatter
     def format_post context
       s = '<article class="group">
-      <div class="grid14 title"><a href="' + context.year + "/" + context.month + "/" + context.guid + '"><h1>' + context.title + '</h1></a></div>
+      <div class="grid14 thetitle"><a href="' + context.year + "/" + context.month + "/" + context.guid + '"><h1>' + context.title + '</h1></a></div>
       <div class="metadata grid2">
       <span class="date">' + context.day + ' ' + "#{context.month_alpha context.month}" + ' ' + context.year + '</span>
       '
@@ -23,7 +23,7 @@ module CarmineContraption
   class LinkFormatter
     def format_post context
       s = '<article class="group">
-      <div class="grid14 title"><a href="' + context.extra + '"><h1>' + context.title + '<span>&rarr;</span></h1></a></div>
+      <div class="grid14 thetitle"><a href="' + context.extra + '"><h1>' + context.title + '<span>&rarr;</span></h1></a></div>
       <div class="metadata grid2">
       <span class="date">' + context.day + ' ' + "#{context.month_alpha context.month}" + ' ' + context.year + '</span>
       '

data/lib/carmine_contraption/index.rb

@@ -3,17 +3,19 @@ require_relative 'post'
 require 'pathname'
 require 'time'
 require 'erb'
+require 'colorize'
 
 module CarmineContraption
   class Index
     include MonthTransform
     attr_reader :yearly_archives, :monthly_archives, :tag_archives
 
-    def initialize source, destination, template
+    def initialize source, destination, template, override=false
       @source = source
       @destination = destination
       raise "Template not found." unless template.file?
       @template = template
+      @override = override
     end
 
     def build_monthly_archives
@@ -42,12 +44,14 @@ module CarmineContraption
       Pathname.glob(@source+"*.html") { |path| @all_paths << path}
       Pathname.glob(@source+"*.md") { |path| @all_paths << path}
       @all_posts = []
-      @all_paths.sort.each do |path|
+      @all_paths.each do |path|
         @all_posts << Post.from_file(path, path.extname)
       end
+      @all_posts.sort!
     end
 
-    def write_file file, content=''
+    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) }
     end
@@ -57,7 +61,7 @@ module CarmineContraption
         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?
+        write_file path, the_post.formatted_output unless ( path.exist? and !@override )
       end
     end
 
@@ -80,7 +84,7 @@ module CarmineContraption
         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
+        write_file path+"index.html", content, true
       end
     end
 
@@ -98,6 +102,7 @@ module CarmineContraption
         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
@@ -106,17 +111,30 @@ module CarmineContraption
       @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
+        write_file path + "#{k.gsub(' ', '_').downcase}.html", content, true
       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"
+      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
+        write_file path+"index.html", content, true
       end
     end
   end

data/lib/carmine_contraption/media.rb

@@ -0,0 +1,30 @@
+module CarmineContraption
+  class Media
+    def initialize args={}
+      @values = { name:       '',
+                 local_path:  '',
+                 remote_path: ''}.merge args
+    end
+
+    def name
+      values[:name]
+    end
+
+    def local_path
+      values[:local_path]
+    end
+
+    def remote_path
+      values[:remote_path]
+    end
+
+    def update args={}
+      Media.new values.merge args
+    end
+
+    private
+      def values
+        @values
+      end
+  end
+end

data/lib/carmine_contraption/options.rb

@@ -16,10 +16,11 @@ module CarmineContraption
       @config = {source: DEFAULT_SOURCE,
                  destination: DEFAULT_DESTINATION,
                  new_post_check: true,
-                 update_repository: true
+                 update_repository: true,
+                 override: false
                 }
       @config.merge!(YAML.load_file(DEFAULT_CONFIG_FILE)) if DEFAULT_CONFIG_FILE.file?
-      @config.each_pair { |k, v| @config[k] = Pathname.new(v) if v.class == String }
+      @config.each_pair { |k, v| @config[k] = Pathname.new(v) if v.class == String and !k.to_s.include? 's3' }
       @build_targets = Hash.new(false)
       @build_targets[:individual] = true
       parse(argv)
@@ -65,6 +66,9 @@ module CarmineContraption
         opts.on("-m", "--build_monthly", "Build monthly indexes of posts") do
           @build_targets[:monthly] = true
         end
+        opts.on("-o", "--override", "Write over existing files in DESTINATION") do
+          @config[:override] = true
+        end
         opts.on("-r", "--build_rss", "Build rss feed") do
           @build_targets[:rss] = true
         end

data/lib/carmine_contraption/post.rb

@@ -1,94 +1,138 @@
 #!/usr/bin/env ruby
 
+require 'redcarpet'
+require 'colorize'
+
 require_relative 'formatters'
 require_relative 'month_transform'
+require_relative 'media'
 
 module CarmineContraption
   class Post
-    attr_accessor :title, :content, :extra, :guid, :summary, :published, :status, :type, :tags
+    attr_reader :title, :content, :extra, :guid, :summary, :published, :status, :type, :tags
 
-    extend MonthTransform
     include MonthTransform
 
-    def self.from_file path, extension=".html"
-      guid = File.basename(path, extension)
-      guid = guid[9..-1]
-      a = IO.readlines(path)
-      new_post = extract_header a
-      new_post.content = translate_markdown new_post.content if extension == ".md"
-      new_post.guid = guid
-      new_post
-    end
+    class << self
+      include MonthTransform
+
+      def from_file path, extension=".html"
+        guid = File.basename(path, extension)
+        guid = guid[9..-1]
+        a = IO.readlines(path)
+        new_post = extract_header a
+        new_post = new_post.update(content: translate_markdown(new_post.content)) if extension == ".md"
+        new_post = new_post.update(original_path: Pathname.new(File.dirname(path)))
+        new_post = new_post.update(media: find_media(new_post.content, new_post.original_path))
+        new_post.update guid: guid
+      end
 
-    def self.extract_header raw_content
-      raw_content = raw_content.split('\n') if raw_content.class == String
-      new_post = CarmineContraption::Post.new nil, '', '', '', '', '', '', '', []
-      raw_content.each_with_index do |line, i|
-        if line =~ /^\s/
-          new_post.content = raw_content[(i+1)..-1].join("\n")
-          break
+      private
+        def extract_header raw_content
+          raw_content = raw_content.split('\n') if raw_content.class == String
+          new_post = CarmineContraption::Post.new
+          raw_content.each_with_index do |line, i|
+            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
+            end
+          end
+          new_post
+        end
+
+        def ignore_separator line
+          line unless line =~ /^=+/
         end
-        l = line.split ': '
-        if l.length == 1
-          new_post.title ||= ignore_separator l[0]
-        else
-          case l[0].downcase
-          when /type/
-            new_post.type = l[1]
-          when /published/
-            new_post.published = convert_date l[1]
-          when /tags/
-            new_post.tags = parse_tags l[1]
-          when /extra/
-            new_post.extra = rejoin_string l
-          when /summary/
-            new_post.summary = rejoin_string l
+
+        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(' ')
+          else
+            date
           end
         end
-      end
-      new_post
-    end
 
-    def self.ignore_separator line
-      line unless line =~ /^=+/
-    end
+        def find_media content, path
+          a = []
+          content.scan(/<img src="([^"]*)"/) do |match|
+            if !( /http:/ =~ match[0] )
+              local_path = Pathname.new(path)
+              local_path = local_path.parent + "media" + match[0]
+              if local_path.exist?
+                a << Media.new(name:       local_path.basename,
+                               local_path: local_path.expand_path)
+              else
+                puts "#{local_path.expand_path.to_s.red} not found"
+              end
+            end
+          end
+          a
+        end
 
-    def self.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(' ')
-      else
-        date
-      end
-    end
+        def parse_tags unparsed
+          unparsed.chomp.downcase.split(', ')
+        end
 
-    def self.parse_tags unparsed
-      unparsed.chomp.downcase.split(', ')
-    end
+        def rejoin_string array
+          array[1..-1].join ': '
+        end
+
+        def translate_markdown content
+          md = Redcarpet::Markdown.new(Redcarpet::Render::HTML)
+          md.render(content)
+        end
 
-    def self.rejoin_string array
-      array[1..-1].join ': '
     end
 
-    def self.translate_markdown content
-      `echo "#{content}" | bin/markdown.pl`
+    def initialize opts={}
+      @defaults = { title: nil,
+                   content: '',
+                   extra: '',
+                   guid: '',
+                   summary: '',
+                   published: '',
+                   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]
     end
 
-    def initialize(title, content, extra, guid, summary, published, status, type, tags)
-      @title = title
-      @content = content
-      @extra = extra
-      @guid = guid
-      @summary = summary
-      @published = published
-      @status = status
-      @type = type
-      @tags = tags
+    def update opts={}
+      Post.new(@defaults.merge opts)
     end
 
     def year
@@ -103,7 +147,20 @@ module CarmineContraption
       @published[8..9]
     end
 
+    def <=> other
+      published <=> other.published
+    end
+
+    def media
+      @defaults[:media]
+    end
+
+    def original_path
+      @defaults[:original_path]
+    end
+
     def formatted_output method='type'
+      insert_remote_media_links
       formatter = CarmineContraption::RawFormatter.new
       case method
       when 'type'
@@ -118,5 +175,12 @@ module CarmineContraption
       end
       formatter.format_post self
     end
+
+    private
+      def insert_remote_media_links
+        media.each do |m|
+          content.sub!(/(<img src=")#{m.name}"/, '\1'"#{m.remote_path}\"")
+        end
+      end
   end
 end

data/lib/carmine_contraption/runner.rb

@@ -1,6 +1,9 @@
 require_relative 'options'
 require_relative 'index'
+require_relative 'uploader'
+
 require 'pathname'
+require 'colorize'
 
 module CarmineContraption
   class Runner
@@ -8,6 +11,7 @@ module CarmineContraption
       @options = Options.new(argv)
       @source = @options.source
       @destination = @options.destination
+      @override = @options.override
       @template =  Pathname.new('lib/templates/default.html.erb')
       @input_extensions = [".md", ".html"]
       @drafts_path = @source + 'drafts'
@@ -25,15 +29,29 @@ module CarmineContraption
               move_completed_draft = true
               t = Time.now
               post += 'Published: ' + t.strftime("%a, %d %b %Y %H:%M:%S %Z") + "\n"
-              posted_filename = "#{t.strftime('%Y%m%d')}-#{posted_filename}#{input_extension}"
+              posted_filename = "#{t.strftime('%Y%m%d')}-#{posted_filename}"
             else
               post += line
             end
           end
           if move_completed_draft
-           (@posts_path+posted_filename).open('w') {|f| f.write(post)}
+            puts "Publishing draft: #{posted_filename}".yellow
+            (@posts_path+posted_filename).open('w') {|f| f.write(post)}
             `rm #{i}`
             `lib/update_repo.sh #{@source} #{posted_filename}` if @options.update_repository
+            up = Uploader.new({access_key_id: @options.s3_access_key_id,
+                               secret_access_key: @options.s3_secret_access_key},
+                              @options.s3_target_bucket)
+            the_post = Post.from_file((@posts_path+posted_filename).to_s, input_extension)
+            tmp = []
+            the_post.media.each do |m|
+              puts "Uploading #{m.name}...".green
+              remote_name = "#{the_post.year}/#{the_post.month}/#{m.name}"
+              up.upload (m.update remote_path: remote_name)
+              tmp << (m.update remote_path: "http://#{@options.s3_target_bucket}/#{remote_name}")
+            end
+            the_post = the_post.update(media: tmp)
+            (@posts_path+posted_filename).open('w') { |f| f.write(the_post.formatted_output '') }
           end
         end
       end
@@ -46,7 +64,7 @@ module CarmineContraption
       end
       most_recent = all_paths.sort.last
       most_recent_extension = most_recent.extname
-      the_post = Post.from_file(most_recent, ".#{most_recent_extension}")
+      the_post = Post.from_file most_recent, most_recent_extension
       landing_template = Pathname.new('lib/templates/landing_page.html')
       output = landing_template.open('r').read
       output.gsub!(/\#\{title\}/, the_post.title)
@@ -54,6 +72,7 @@ module CarmineContraption
       link = "#{the_post.year}/#{the_post.month}/#{the_post.guid}.html"
       output.gsub!(/\#\{link\}/, link)
       (@destination + "index.html").open('w:UTF-8') {|f| f.write(output) }
+      puts "Rendering #{@destination}index.html".blue
     end
 
     def build_monthly
@@ -69,6 +88,7 @@ module CarmineContraption
     def build_tag
       @the_index.build_tag_archives
       @the_index.write_tag_archives
+      @the_index.write_tag_cloud
     end
 
     def build_individual
@@ -89,7 +109,7 @@ module CarmineContraption
     def run
       check_for_new_posts if @options.new_post_check
       if @options.build_targets.has_value?(true)
-        @the_index = Index.new @posts_path, @destination, @template
+        @the_index = Index.new @posts_path, @destination, @template, @override
         @the_index.find_all_posts
         @options.build_targets.each { |k, v| send "build_#{k}" if v }
       end