middleman-webcomic 0.5.0

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+*.gem
+*.lock
+examples/**/output
+.sass-cache

data/ChangeLog.md

@@ -0,0 +1,11 @@
+# v0.5.0
+- Updated to support Middleman's new auto-discovery.
+- Includes boilerplate site.
+
+# v0.4.0
+- Added storyline support and helpers.
+
+  This introduces a breaking change to how the data is added to middle data_content, fortunately I'm the only one using it right now. :)
+
+# v0.2.1
+- Initial release. Yay!

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/License

@@ -0,0 +1,18 @@
+Copyright (C) 2011 by Matt McCray
+
+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

data/Rakefile

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "middleman-webcomic/version"
+ 
+desc "builds gem"
+task :build do
+  system "gem build middleman-webcomic.gemspec"
+end
+ 
+desc "releases gem"
+task :release => :build do
+  system "gem push middleman-webcomic-#{Middleman::Webcomic::VERSION}.gem"
+end
+
+desc "installs gem"
+task :install => :build do
+  system "gem install middleman-webcomic-#{Middleman::Webcomic::VERSION}"
+end
+
+desc "uninstalls gem"
+task :uninstall do
+  system "gem uninstall middleman-webcomic"
+end

data/Readme.md

@@ -0,0 +1,22 @@
+# Webcomic for MiddleMan
+
+*Updated for Middleman auto-discovery.*
+
+After you install the gem:
+
+    gem install middleman-webcomic
+
+Create a new webcomic site like this:
+
+    middleman init MY_SITE --template=webcomic
+
+Then customize to your satisfaction.
+
+# Live Sites
+
+This extension is used in conjunction with MiddleMan on the following sites:
+
+* [ZooDotCom](http://www.zoodotcom.com)
+* [Tactless Comics](http://tactless.inkwellian.com)
+* [Darkshore Detectives](http://darkshore.inkwellian.com)
+

data/lib/middleman-webcomic/cli.rb

@@ -0,0 +1,5 @@
+
+# To use: Thor
+#
+#  mm-webcomic init|new|check
+#

data/lib/middleman-webcomic/data.rb

@@ -0,0 +1,213 @@
+require 'thor'
+require 'date'
+
+class String
+  def create_slug
+    s= self.downcase.gsub(/'/, '').gsub(/[^a-z0-9]+/, '-')
+    s.chop! if s[-1] == '-'
+    s
+  end
+end
+
+module Middleman
+  
+  module Webcomic
+
+    def self.load_from(path, app)
+      all= []
+      Dir["#{path}/*.comic*"].each do |filename| # Hardcoded for markdown... For now
+        comic = Comic.new(filename, app)
+        #puts comic.pub_date.inspect
+        all << comic if comic.publishable?
+      end
+
+      if app.settings.webcomic_sort_by == :publish_date
+        all.sort! {|x,y| y.pub_date <=> x.pub_date }
+      else
+        fld= app.settings.webcomic_sort_by
+        all.sort! {|x,y| y[fld] <=> x[fld] }
+      end
+    
+      # Update all the position info...
+      cl= all.length
+      all.each_with_index do |comic, i|
+        comic[:position]= (cl - i)
+        comic[:index]= i
+        comic.first= all[-1]
+        comic.last= all[0]
+        comic.next= i > 0  ? all[i - 1] :  nil
+        comic.prev= i < (cl - 1) ? all[i + 1] : nil
+        if app.settings.webcomic_enable_stories and comic.story 
+          Story.find_or_create_for comic
+        end
+      end
+    
+      stories= Story.all
+      stories.sort! {|x,y| y.pub_date <=> x.pub_date }
+      sl= stories.length
+      stories.each_with_index do |story, i|
+        story.position= (sl - i)
+        # puts "##{story.position} - #{story.title}(#{story.slug}): #{story.comics.length}"
+      end
+    
+      [all, stories]
+    end
+  
+    class Story
+      attr_accessor :title, :slug, :comics, :position
+    
+      def initialize(title)
+        @title= title
+        @slug= @title.create_slug
+        @comics= []
+        @position= nil
+      end
+    
+      def pub_date
+        @comics.last.pub_date
+      end
+    
+      def add_comic(comic)
+        @comics << comic
+      end
+    
+      class << self
+      
+        def all
+          @stories ||= {}
+          @stories.values
+        end
+      
+        def find_or_create_for(comic)
+          title= comic.story
+          @stories ||= {}
+          unless @stories.has_key? title
+            story= @stories[title]= new(title)
+          end
+          @stories[title].add_comic comic
+          @stories[title]
+        end
+      end
+    end
+
+    class Comic
+  
+      attr_accessor :content, :source, :metadata, :path, :next, :prev, :first, :last
+  
+      def initialize(path, app)
+        @app= app
+        settings= app.settings
+        @path= path
+        @source= ""
+        @content= ""
+        @next= nil
+        @prev= nil
+        @first= nil
+        @last= nil
+        @metadata= ::Thor::CoreExt::HashWithIndifferentAccess.new({})
+        @metadata[:ext]= File.extname(path)
+        @metadata[:publish_date]= Date.today #Time.now.strftime "%Y-%m-%d"
+        @metadata[:slug]= File.basename(path).gsub( @metadata[:ext], '').gsub('.comic','')
+      
+        if /^([\d]{2})([\d]{2})([\d]{2})\-(.*)(\.comic#{@metadata[:ext]})$/ =~ File.basename(path)
+          year= "20#{ $1 }"
+          month= $2
+          day= $3
+          @metadata[:publish_date]= Date.parse "#{year}-#{month}-#{day}"
+          @metadata[:slug]= $4
+        end
+      
+        @metadata[:title]= @metadata[:slug].titleize rescue @metadata[:slug]
+        @metadata[:slug]= @metadata[:slug].downcase
+      
+        # Parse yaml header...
+        begin
+          read_yaml()
+        rescue
+          puts "Error reading YAML! #{self.slug}"
+        end
+      
+        if self.filename.nil?
+          throw "Filename Missing: Comics must define a filename! (#{self.slug})"
+        end
+
+        if publishable?
+          # Dont' waste time if it's not a publishable comic
+          engine= Tilt[path].new { @source }
+          @content= engine.render
+        end
+      end
+    
+      def [](key)
+        @metadata[key]
+      end
+      def []=(key, value)
+        #puts "Setting #{key} to #{value}"
+        @metadata[key]= value
+      end
+    
+      def method_missing(key, value=nil)
+        if @metadata.has_key? key
+          @metadata[key]
+        elsif @metadata.has_key? key.to_s
+          @metadata[key.to_s]
+        else
+          #super Should it throw an error?
+          nil
+        end
+      end
+    
+      def to_json *a
+        data= @metadata.reject {|k,v| k == :ext or k == "ext" }
+        data.to_json *a
+      end
+    
+      def publishable?
+        @is_publishable ||= begin
+          now= Time.now
+          now_string = now.strftime "%Y-%m-%d"
+          today= Date.parse(now_string)
+          pubdate= self.pub_date
+          case pubdate
+          when String
+            self['publish_date']= Date.parse(pubdate)
+            pubdate <= now_string
+          when Time
+            self['publish_date']= Date.parse(pubdate.strftime('%Y-%m-%d'))
+            pubdate <= now
+          when Date
+            pubdate <= today
+          else
+            true
+          end
+        end
+      end
+  
+      def pub_date
+        date= self.publish_on || self.publish_date || self.date
+        case date
+        when String
+          Date.parse(date)
+        when Time
+          Date.parse(date.strftime('%Y-%m-%d'))
+        when Date
+          date
+        else
+          Date.today
+        end
+      end
+    
+    private
+  
+      def read_yaml()
+        @raw = File.read(@path)
+        data, source= @app.parse_front_matter @raw
+        data.each_pair do |k,v|
+          @metadata[k]= v
+        end
+        @source= source
+      end
+  
+    end
+  end
+end

data/lib/middleman-webcomic/feature.rb

@@ -0,0 +1,172 @@
+require 'fileutils'
+
+module Middleman
+  module Features
+    module Webcomic
+      class << self
+
+        def registered(app)
+          puts "Webcomic v#{::Middleman::Webcomic::VERSION}"
+      
+          # Default settings:
+          app.set :webcomic_images, "images/comics"
+          app.set :webcomic_source, "comics"
+          app.set :webcomic_source_images, "comics/images"
+          app.set :webcomic_source_type, :markdown
+          app.set :webcomic_uri, "comics"
+          app.set :webcomic_template, "/comics/template.html"
+          app.set :webcomic_domain, "http://MYSITE.dev" # ?
+          
+          # ???
+          app.set :webcomic_enable_stories, false
+          app.set :webcomic_story_uri, "story"
+          app.set :webcomic_story_template, "/comics/story_template.html"
+
+          app.set :webcomic_enable_tags, false
+          app.set :webcomic_sort_by, :publish_date # or slug? and metadata
+          app.set :webcomic_slug_field, :slug
+          
+          app.set :webcomic_include_comic_in_feed, true
+
+          app.helpers ::Middleman::Features::Webcomic::Helpers
+      
+          app.after_configuration do
+            comics, stories= ::Middleman::Webcomic.load_from( File.join(app.root, app.settings.webcomic_source), app )
+
+            # puts comics.inspect
+
+            comics.each do |comic|
+              #puts "-> #{comic.filename} (#{comic.metadata.inspect})"
+              src_path= File.join(app.root, app.settings.webcomic_source_images, comic.filename)
+              tgt_path= File.join(app.views, app.settings.webcomic_images, comic.filename)
+              
+              unless File.exists? tgt_path
+                if File.exists? src_path
+                  puts "Moving into place: #{comic.filename}"
+                  FileUtils.mkdir_p File.dirname(tgt_path), :verbose=>false
+                  FileUtils.cp src_path, tgt_path, :verbose=>false
+                else
+                  puts "MISSING COMIC: #{comic.filename}"
+                end
+              end
+              
+              slug_field= app.settings.webcomic_slug_field
+              if File.exists? tgt_path
+                #puts "Building: /#{app.settings.webcomic_uri}/#{comic[slug_field]}.html"
+                app.page "/#{app.settings.webcomic_uri}/#{comic[slug_field]}.html", :proxy=>app.settings.webcomic_template, :ignore=>true do
+                  @comic= comic
+                end
+              else
+                puts "Skipping #{comic.filename} (#{comic[slug_field]})"
+              end
+            end
+            
+            if app.settings.webcomic_enable_stories
+              stories.each do |story|
+                app.page "/#{app.settings.webcomic_story_uri}/#{story.slug}.html", :proxy=>app.settings.webcomic_story_template, :ignore=>true do
+                  @story= story
+                end
+              end
+            end
+            
+            app.data_content 'webcomic', {
+              :strips=>comics,
+              :stories=>stories
+            }
+          end
+        end
+        alias :included :registered
+
+      end
+    
+      module Helpers
+        def current_comic
+          (@comic || last_comic)
+        end
+
+        def first_comic
+          data.webcomic.strips.last
+        end
+
+        def last_comic
+          data.webcomic.strips.first
+        end
+
+        def next_comic
+          current_comic.next
+        end
+
+        def prev_comic
+          current_comic.prev
+        end
+
+        def comic_image_url(comic)
+          "/#{settings.webcomic_images}/#{comic.filename}"
+        end
+        alias :comic_image_for :comic_image_url
+
+        def current_comic_image
+          comic_image_for current_comic
+        end
+        alias :current_comic_image_url :current_comic_image
+
+        def comic_path_url(comic)
+          "/#{settings.webcomic_uri}/#{comic[settings.webcomic_slug_field]}"
+        end
+        alias :comic_path_for :comic_path_url
+
+        def current_comic_path
+          comic_path_for current_comic
+        end
+
+        def first_comic_path
+          comic_path_for first_comic
+        end
+
+        def last_comic_path
+          comic_path_for last_comic
+        end
+
+        def next_comic_path
+          comic_path_for next_comic
+        end
+
+        def prev_comic_path
+          comic_path_for prev_comic
+        end
+
+
+        # Story Helpers
+        def start_story_path_for(object)
+          story = if object.is_a? Story
+            object
+          else # it's a comic... right?
+            data.webcomic.stories.detect  {|s| s.title == object.story }
+          end
+          comic_path_for story.comics.last
+        end
+
+        def story_path_for(object)
+          story = if object.is_a? Story
+            object
+          else # it's a comic... right?
+            data.webcomic.stories.detect  {|s| s.title == object.story }
+          end
+          "/#{settings.webcomic_story_uri}/#{story.slug}"
+        end
+        
+        # Feed Helpers
+        
+        def webcomic_feed_data
+          data.webcomic.strips[0...10]
+        end
+        
+        def feed_absolute_paths(source, path=settings.webcomic_domain)
+          source.gsub( /src=(["']*)\//) do |match|
+            "#{match[0...-1]}#{path}/"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/middleman-webcomic/mock_app.rb

@@ -0,0 +1,31 @@
+require 'middleman'
+require 'slim'
+require 'tilt'
+
+module Middleman
+  module Webcomic
+    class MockApp
+  
+      attr_reader :settings
+    
+      def initialize(settings={})
+        @settings= ::Thor::CoreExt::HashWithIndifferentAccess.new(settings)
+      end
+    
+      def method_missing(key, value=nil)
+        if @settings.has_key? key
+          @settings[key]
+        elsif @settings.has_key? key.to_s
+          @settings[key.to_s]
+        else
+          #super Should it throw an error?
+          nil
+        end
+      end
+  
+      def parse_front_matter(content)
+        Middleman::CoreExtensions::FrontMatter.parse_front_matter(content)
+      end
+    end
+  end
+end

data/lib/middleman-webcomic/pager.rb

@@ -0,0 +1,51 @@
+module Middleman
+  module Webcomic
+    class Pager
+      attr_reader :all, :pages, :base_url, :current_page, :page_sets
+
+      def initialize(articles, base_path="/page", page_size=5)
+        @all= articles
+        @page_size= page_size
+        @base_path= base_path
+        @page_sets= @all.in_groups_of(page_size, false)
+        @pages= []
+        @current_page=1
+        @page_sets.each do |art_ary|
+          @pages << Thor::CoreExt::HashWithIndifferentAccess.new({
+            'articles' => art_ary,
+            'page' => @current_page,
+            'uri' => "#{base_path}/#{current_page}",
+            'pager' => self
+          })
+          @current_page += 1
+        end
+        @current_page= nil
+      end
+
+      def length
+        @pages.length
+      end
+  
+      def first
+        @pages.first
+      end
+  
+      def last
+        @pages.last
+      end
+
+      def each
+        @current_page=1
+        @pages.each do |page_set|
+          yield page_set
+          @current_page += 1
+        end
+        @current_page= nil
+      end
+  
+      def [](key)
+        @pages[key]
+      end
+    end
+  end
+end

data/lib/middleman-webcomic/tasks.rb

@@ -0,0 +1,53 @@
+# Rake tasks
+require 'rake'
+
+def ask message
+  print message
+  STDIN.gets.chomp
+end
+
+NOTES_PATH= File.expand_path "./comics/notes" unless defined?(NOTES_PATH)
+IMAGE_PATH= File.expand_path "./comics/images" unless defined?(IMAGE_PATH)
+
+namespace :webcomic do
+
+desc "Creates a new Comic notes entry from image"
+task :create do
+  
+  require 'yaml'
+  require 'date'
+  Dir["#{IMAGE_PATH}/*.{jpg,jpe,jpeg,gif,png}"].each do |img_file|
+    img_filename = File.basename( img_file )
+    basename= img_filename.gsub( File.extname(img_filename), '' )
+    note_filename = "#{basename}.comic.markdown"
+    path= File.join NOTES_PATH, note_filename
+    
+    unless File.exists? path
+      create_notes = ask("Notes for '#{img_filename}' are missing, create? [Yn] ")
+      if create_notes.upcase[0] != 'N'
+        meta= {
+          'title' => basename,
+          'slug' => basename,
+          'publish_date' => Date.today,
+          'filename' => img_filename
+        }.to_yaml
+        
+        meta << "---\n\n"
+        meta << "\n\n"
+        
+        File.open(path, "w") do |file|
+          file.write meta
+        end
+        puts "Created #{path}"
+      end
+    end
+  end
+  
+end
+
+# desc "Validates that there are notes for each image"
+# task :validate do
+#   ptus "Coming Soon!"
+# end
+
+end

data/lib/middleman-webcomic/template/Gemfile.tt

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem "middleman"
+gem 'slim'
+gem 'coffee-script'
+gem 'builder'
+gem "middleman-webcomic" #, :git=>"git@github.com:darthapo/middleman-webcomic.git"

data/lib/middleman-webcomic/template/Rakefile.tt

@@ -0,0 +1,28 @@
+# Settings:
+NOTES_PATH= File.expand_path("./comics/notes")
+IMAGE_PATH= File.expand_path("./comics/images")
+
+# For the SYNC task
+SERVER='USERNAME@YOURSITE.COM'
+FOLDER="~/YOURSITE.COM"
+
+require 'middleman-webcomic/tasks'
+
+desc "Runs server"
+task :server do
+  system "middleman server"
+end
+
+desc "Runs build"
+task :build do
+  system "middleman build"
+end
+
+desc "Syncs with public server using rsync (if configured)"
+task :sync=>:build do
+  cmd= "rsync -avz --delete build/ #{SERVER}:#{FOLDER}"
+  puts "Running:\n#{cmd}\n"
+  system(cmd)
+  puts "Done."
+end
+

data/lib/middleman-webcomic/template/config.ru

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler/setup'
+require 'middleman'
+
+run Middleman.server
+
+# Rack config
+
+# Look for index files in folders like Apache
+# require "rack/contrib/try_static"
+# use Rack::TryStatic, :root => "build", :urls => %w[/], :try => ['.html', 'index.html', '/index.html']
+
+# Cache static assets
+# require "rack/contrib/static_cache"
+# use Rack::StaticCache, :urls => ['/'], :root => 'build'