dropsite 0.2.1 → 0.3.0

data/Rakefile

@@ -2,12 +2,21 @@ require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-Rake::TestTask.new do |t|
+Rake::TestTask.new("test:units") do |t|
   t.libs << 'lib'
-  t.pattern = 'test/**/test_*.rb'
+  t.libs << '.'
+  t.pattern = 'test/unit/**/test_*.rb'
 end
 
-task :default => [:test]
+Rake::TestTask.new("test:integration") do |t|
+  t.libs << 'lib'
+  t.libs << '.'
+  t.pattern = 'test/integration/**/test_*.rb'
+end
+
+task :test => ['test:units', 'test:integration']
+
+task :default => 'test:units'
 
 begin
   require 'rcov/rcovtask'

data/bin/dropsite

@@ -1,38 +1,5 @@
 #!/usr/bin/env ruby
-
-require 'optparse'
-
-# TODO: take this out later
 $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'dropsite'
-include Dropsite
-
-options = {
-  :quiet => false
-}
-
-OptionParser.new do |opts|
-  opts.on('-d', '--dropbox-home [PATH]', 'Specify Dropbox directory') {|path| options[:dropbox_home] = path }
-  opts.on('-q', '--quiet', 'Suppress site processing output') {|| options[:quiet] = true }
-  opts.on_tail('-h', '--help', 'Show this message') do
-    puts opts
-    exit
-  end
-  opts.on_tail('--version', 'Show version') do
-    puts "Dropsite version: #{Dropsite::VERSION}"
-    exit
-  end
-end.parse!
-
-options[:dropbox_home] = Dropsite.find_dropbox_dir if not options[:dropbox_home]
-
-if !options[:dropbox_home] || !File.exist?(options[:dropbox_home])
-  $stderr.puts 'Dropbox home directory cannot be found or does not exist'
-  $stderr.puts 'Set valid directory with --dropbox-home DIRECTORY'
-  exit 1
-end
-
-options[:public_dir] = File.join(options[:dropbox_home], 'Public')
 
-site = Dropsite::Site.new(options)
-site.process
+Dropsite::Application.new.run

data/dropsite.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'dropsite'
-  s.version = '0.2.1'
+  s.version = '0.3.0'
   s.platform = Gem::Platform::RUBY
 
   s.description = "creates index pages in your Dropbox public directory"

data/lib/dropsite/application.rb

@@ -0,0 +1,93 @@
+require 'optparse'
+require 'ostruct'
+require 'yaml'
+
+module Dropsite
+  class Application
+    def run
+      handle_options
+
+      options.dropbox_home = Dropsite.dropbox_dir if not options.dropbox_home
+
+      if !options.dropbox_home || !File.exist?(options.dropbox_home)
+        $stderr.puts 'Dropbox home directory cannot be found or does not exist'
+        $stderr.puts 'Set valid directory with --dropbox-home DIRECTORY'
+        exit 1
+      end
+
+      if options.create_config_dir
+        create_config_dir
+      else
+        options.public_dir = File.join(options.dropbox_home, 'Public')
+        cf = ConfigFile.new.read
+        options.exclude = cf.exclude if cf.exist?
+        site = Dropsite::Site.new(options)
+        site.process
+      end
+    end
+
+    def options
+      @options ||= OpenStruct.new
+    end
+
+    def create_config_dir
+      if Dropsite.dropsite_config_dir
+        puts "Config directory already exists at: #{Dropsite.dropsite_config_dir}"
+        exit
+      end
+
+      config_dir = File.join(Dropsite.dropbox_dir, '.dropsite')
+      Dir.mkdir(config_dir)
+      File.open(File.join(config_dir, 'config.yml'), 'w') do |f|
+        # TODO: put the contents in there
+        f.puts ''
+      end
+      Dir.mkdir(File.join(config_dir, 'plugins'))
+    end
+
+    private
+
+    def handle_options
+      OptionParser.new do |opts|
+        opts.on('-d', '--dropbox-home [PATH]', 'Specify Dropbox directory') do |path|
+          options.dropbox_home = path
+        end
+        opts.on('-q', '--quiet', 'Suppress site processing output') do
+          options.quiet = true
+        end
+        opts.on('-c', '--create-config-files', 'Create a dropsite config dir in the Dropbox home') do
+          options.create_config_dir = true
+        end
+        opts.on_tail('-h', '--help', 'Show this message') do
+          puts opts
+          exit
+        end
+        opts.on_tail('--version', 'Show version') do
+          puts "Dropsite version: #{Dropsite::VERSION}"
+          exit
+        end
+      end.parse!
+    end
+  end
+
+  # Wraps the main configuration file. Exists mostly in case of future
+  # expansion of configuration options.
+  class ConfigFile
+    attr_reader :path, :exclude
+
+    def initialize(path=nil)
+      @path = path || File.join(Dropsite.dropsite_config_dir, 'config.yml')
+    end
+
+    def read
+      return if not exist?
+      config = YAML::load(IO.read(path))
+      @exclude = config['exclude']
+      self
+    end
+
+    def exist?
+      File.exist? path
+    end
+  end
+end

data/lib/dropsite/dir_renderer.rb

@@ -3,39 +3,37 @@ require 'erb'
 module Dropsite
   class DirRenderer
     TEMPLATE_EXTENSIONS = ['.erb']
-    
+
     @@renderers = []
-    
+
     def self.inherited(subclass)
       renderer = subclass.new
-      
+
       plugin_dir = File.dirname(caller[0].split(':')[0])
       template_file = Dir.entries(plugin_dir).find {|e| TEMPLATE_EXTENSIONS.include? File.extname(e)}
       renderer.template_path = template_file ? File.join(plugin_dir, template_file) : nil
       renderer.assets_dir = File.join(plugin_dir, 'assets')
       @@renderers << renderer
     end
-    
-    def DirRenderer.renderers
+
+    def self.renderers
       @@renderers
     end
-    
-    # Find the first renderer that can render the given SiteDir. Non-default (user) plugins
-    # are searched first.
-    def DirRenderer.find_renderer(site_dir)
-      @@renderers.partition {|r| !r.is_default? }.flatten.find {|r| r.can_render?(site_dir)}
-    end
-    
-    def DirRenderer.find_renderer_and_render(site_dir)
-      DirRenderer.find_renderer(site_dir).render(site_dir)
-    end
-    
+
     attr_accessor :template_path, :assets_dir
-    
-    # Overridden in subclass if you don't want to just find and use a template
+
+    # Overridden in subclass to indicate, usually based on the SiteDir contents, whether
+    # this renderer can render the SiteDir. This is false by default, unless the renderer
+    # is a built_in (included with Dropsite).
+    def can_render?(site_dir)
+      built_in?
+    end
+
+    # Optionally overridden in subclass to do the work of rendering. By default this will
+    # find plugin_name.erb in the plugin directory and use it to render.
     def render(site_dir)
       site_dir.rendered_by = self.class
-      
+
       if File.extname(template_path) == '.erb'
         @template = @template || ERB.new(IO.read(template_path))
         @template.result(site_dir.get_binding)
@@ -43,13 +41,13 @@ module Dropsite
         raise "Don't know how to render: #{template_path}"
       end
     end
-    
-    # Overriden in subclass or this won't do jack
-    def can_render?(site_dir)
-      is_default?
+
+    # Optionally overridden in subclass to write any files that will be needed to display
+    # the page (rendered by the render method) properly. This does nothing by default.
+    def write_page_assets(site_dir)
     end
-    
-    def is_default?
+
+    def built_in?
       false
     end
   end

data/lib/dropsite/plugins/image_thumbnails/assets/css/image_thumbnails.css

@@ -0,0 +1,87 @@
+body {
+	background-color: white;
+	color: #484848;
+	font: 13.34px Helvetica, Arial, freesans, clean, sans-serif;
+	font-size: 90%;
+	text-align: center;
+}
+
+#content {
+	width: 920px;
+	margin-left: auto;
+	margin-right: auto;
+	text-align: left;
+}
+
+#breadcrumbs {
+	margin-top: 20px;
+	font-size: 140%;
+}
+
+#breadcrumbs .sep {
+	margin-left: 5px;
+	margin-right: 10px;
+}
+
+#breadcrumbs .root-link, #breadcrumbs .parent-dir-link {
+	text-decoration: none;
+}
+
+#breadcrumbs .root-link:hover, .parent-dir-link:hover {
+	text-decoration: underline;
+}
+
+#breadcrumbs .root-link {
+	color: #4183C4;
+	font-weight: bold;
+}
+
+#breadcrumbs .parent-dir-link {
+	color: #4183C4;
+}
+
+#breadcrumbs .current-dir {
+	color: #000000;
+}
+
+#file-list {
+	margin-top: 10px;
+	width: 100%;
+}
+
+#file-list .header {
+	background-color: #eaeaea;
+	border: 1px solid #e1e1e1;
+	color: #999999;
+	height: 28px;
+}
+
+.thumb-link {
+	width: 152px;
+	margin: 3px;
+	padding: 5px;
+	float: left;
+	text-align: center;
+	border: 2px solid #fff;
+	font-family: Monaco, 'Courier New', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+	text-decoration: none;
+}
+
+.thumb-link:hover {
+	border: 2px solid #4183C4;
+}
+
+.thumb-link .dir-container {
+	width: 100px;
+	height: 100px;
+}
+
+.thumb-link .dir-container img {
+	margin-top: 30px;
+	margin-left: 54px;
+}
+
+.image .name {
+	margin-left: auto;
+	margin-right: auto;
+}

data/lib/dropsite/plugins/image_thumbnails/assets/css/reset.css

@@ -0,0 +1,30 @@
+body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,form,fieldset,input,textarea,p,blockquote,th,td { 
+	margin:0;
+	padding:0;
+}
+table {
+	border-collapse:collapse;
+	border-spacing:0;
+}
+fieldset,img { 
+	border:0;
+}
+address,caption,cite,code,dfn,em,strong,th,var {
+	font-style:normal;
+	font-weight:normal;
+}
+ol,ul {
+	list-style:none;
+}
+caption,th {
+	text-align:left;
+}
+h1,h2,h3,h4,h5,h6 {
+	font-size:100%;
+	font-weight:normal;
+}
+q:before,q:after {
+	content:'';
+}
+abbr,acronym { border:0;
+}

data/lib/dropsite/plugins/image_thumbnails/image_thumbnails.erb

@@ -0,0 +1,49 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+	"http://www.w3.org/TR/html4/strict.dtd">
+<%
+def thumb_name(image_file_name)
+	File.basename(image_file_name).sub(/\.\w+$/, '') + '-thumb' + File.extname(image_file_name)
+end
+def shorten(file_name)
+	if file_name.size < 20
+		file_name
+	else
+		file_name[0..7] + '...' + file_name[-8..-1]
+	end
+end
+%>
+<html>
+	<head>
+		<meta http-equiv="Content-type" content="text/html; charset=utf-8">
+		<title>My Dropbox Files<%= " - #{name}" if !root? %></title>
+		<%= stylesheet_link_tag 'reset' %>
+		<%= stylesheet_link_tag 'image_thumbnails' %>
+	</head>
+	<body>
+		<div id="content">
+			<div id="breadcrumbs">
+				<a class="root-link" href="<%= back_link('root') %>">my files</a>
+				<% each_parent_directory_link_tag(false, {:class => 'parent-dir-link'}) do |tag| %>
+					<span class="sep">/</span><%= tag %>
+				<% end %>
+				<% if !root? %>
+					<span class="sep">/</span><span class="current-dir"><%= name %></span>
+				<% end %>
+			</div>
+			<% dirs.sort.each do |dir| %>
+				<a class="thumb-link" href="<%= url_for dir %>">
+					<div class="dir-container">
+						<%= image_tag 'icons/directory-large.png' %>
+					</div>
+					<div class="name"><%= shorten dir.name %></div>
+				</a>
+			<% end %>
+			<% files.sort.each do |file| %>
+				<a class="thumb-link" href="<%= url_for file %>">
+					<%= page_asset_image_tag thumb_name(file.name) %>
+					<div class="name"><%= shorten file.name %></div>
+				</a>
+			<% end %>
+		</div>
+	</body>
+</html>

data/lib/dropsite/plugins/image_thumbnails/image_thumbnails.rb

@@ -0,0 +1,65 @@
+class ImageThumbnails < Dropsite::DirRenderer
+  def can_render?(site_dir)
+    return false if not thumbnail_generator
+    !site_dir.files.empty? && site_dir.files.all? {|e| e.file_type == :image}
+  end
+
+  def write_page_assets(site_dir)
+    raise 'No thumbnail generator' if not thumbnail_generator
+
+    assets_dir = site_dir.page_assets_dir
+    site_dir.entries.find_all {|e| e.is_a? SiteFile}.each do |e|
+      src_image = e.abs_path
+      case thumbnail_generator
+      when :image_science
+        write_thumb_with_image_science(src_image, assets_dir)
+      when :rmagick
+        write_thumb_with_rmagick(src_image, assets_dir)
+      else
+        raise "Unrecognized thumbnail generator: #{thumbnail_generator}"
+      end
+    end
+  end
+
+  def built_in?
+    true
+  end
+
+  def thumbnail_generator
+    return @thumbnail_generator_cache if instance_variables.include?('@thumbnail_generator_cache')
+
+    begin
+      require 'image_science'
+      return @thumbnail_generator_cache = :image_science
+    rescue LoadError
+    end
+
+    begin
+      require 'rmagick'
+      return @thumbnail_generator_cache = :rmagick
+    rescue LoadError
+    end
+
+    return @thumbnail_generator_cache = nil
+  end
+
+  protected
+
+  def write_thumb_with_image_science(src_image, assets_dir)
+    ImageScience.with_image(src_image) do |img|
+      img.cropped_thumbnail(100) do |thumb|
+        thumb.save(File.join(assets_dir, thumb_file_name(src_image)))
+      end
+    end
+  end
+
+  def write_thumb_with_rmagick(src_image, assets_dir)
+    img = Magick::Image::read(src_image).first
+    thumb = img.resize_to_fill(100, 100)
+    thumb.write File.join(assets_dir, thumb_file_name(src_image))
+  end
+
+  def thumb_file_name(image_file_name)
+    File.basename(image_file_name).sub(/\.\w+$/, '') + '-thumb' + File.extname(image_file_name)
+  end
+end

data/lib/dropsite/plugins/simple_index/simple_index.erb

@@ -26,7 +26,7 @@
 				<% @entries.sort.each do |entry| %>
 				<tr class="entry">
 					<td class="icon"><%= image_tag "icons/#{entry.file_type}.png" %></td>
-					<td class="link"><a href="<%= entry.link %>"><%= entry.name %></a></td>
+					<td class="link"><a href="<%= url_for entry %>"><%= entry.name %></a></td>
 					<td class="type"><%= entry.file_type %></td>
 					<td class="size"><%= entry.size %></td>
 				</tr>

data/lib/dropsite/plugins/simple_index/simple_index.rb

@@ -1,5 +1,5 @@
 class SimpleIndex < Dropsite::DirRenderer
-  def is_default?
+  def built_in?
     true
   end
 end

data/lib/dropsite/render_helper.rb

@@ -4,6 +4,9 @@ module Dropsite
   module RenderHelper
     attr_accessor :rendered_by
 
+
+    # Helpers for linking to other Dropsite rendered pages
+
     def link
       # TODO: URL escape links
       if top_level? && (!is_a? SiteDir)
@@ -20,18 +23,21 @@ module Dropsite
       end
     end
 
-    def stylesheet_link_tag(stylesheet_name)
-      stylesheet_name = "#{stylesheet_name}.css" if not stylesheet_name =~ /\.css$/
-      %{<link rel="stylesheet" href="#{assets_link_base}css/#{stylesheet_name}" type="text/css" media="screen">}
-    end
-
-    def javascript_include_tag(javascript_file_name)
-      javascript_file_name = "#{javascript_file_name}.js" if not javascript_file_name =~ /\.js$/
-      %{<script type="text/javascript" src="#{assets_link_base}js/#{javascript_file_name}"></script>}
-    end
-
-    def image_tag(image_file_name)
-      %{<img src="#{assets_link_base}images/#{image_file_name}" />}
+    # Creates a relative URL, from the page for the current object, for the given SiteItem.
+    # This assumes the current object is a SiteDir.
+    def url_for(entry)
+      if entry.top_level? && (!entry.is_a? SiteDir)
+        entry.name
+      else
+        if entry.is_a? SiteDir # TODO: do a dynamic renderable test?
+          entry.top_level? ? "dropsite/#{entry.path}.html" : "#{name}/#{entry.name}.html".sub(/^\//, '')
+        else
+          # Builds a link back up to the file in Public root since the pages
+          # are built in a parallel directory structure
+          dirs_up = entry.path.split(File::SEPARATOR).size - 1
+          (['..'] * dirs_up).join('/') + "/#{entry.path}"
+        end
+      end
     end
 
     def parent_directory_link_tag(levels_up=1, options={})
@@ -51,16 +57,6 @@ module Dropsite
       end
     end
 
-    def assets_link_base
-      if root?
-        "dropsite/dropsite-assets/#{Dropsite.underscorize(rendered_by)}/"
-      else
-        # Work our way BACK up the path - crazy, right? Gotta do it though.
-        dirs_up = path.split(File::SEPARATOR).size - 1
-        (['..'] * dirs_up).join('/') + "#{'/' if dirs_up > 0}dropsite-assets/#{Dropsite.underscorize(rendered_by)}/"
-      end
-    end
-
     # Get a link to a parent page
     def back_link(levels_up=1)
       # TODO: factor this out a bit between parent_dir_name
@@ -84,6 +80,48 @@ module Dropsite
       end
     end
 
+
+    # Helpers for including assets from the plugin assets directory
+
+    def stylesheet_link_tag(stylesheet_name)
+      stylesheet_name = "#{stylesheet_name}.css" if not stylesheet_name =~ /\.css$/
+      %{<link rel="stylesheet" href="#{plugin_assets_link_base}css/#{stylesheet_name}" type="text/css" media="screen">}
+    end
+
+    def javascript_include_tag(javascript_file_name)
+      javascript_file_name = "#{javascript_file_name}.js" if not javascript_file_name =~ /\.js$/
+      %{<script type="text/javascript" src="#{plugin_assets_link_base}js/#{javascript_file_name}"></script>}
+    end
+
+    def image_tag(image_file_name)
+      %{<img src="#{plugin_assets_link_base}images/#{image_file_name}" />}
+    end
+
+
+    # Helpers for including assets from the page assets (assets for an individual page,
+    # created by the write_page_assets method for a given renderer)
+
+    # Creates an img tag for the given page asset image. This links to a file directly
+    # in the page asset directory and an 'image' folder is not assumed.
+    def page_asset_image_tag(image_file_name)
+      %{<img src="#{page_assets_link_base}#{image_file_name}" />}
+    end
+
+
+    def plugin_assets_link_base
+      if root?
+        "dropsite/dropsite-assets/#{Dropsite.underscorize(rendered_by)}/"
+      else
+        # Work our way BACK up the path - crazy, right? Gotta do it though.
+        dirs_up = path.split(File::SEPARATOR).size - 1
+        (['..'] * dirs_up).join('/') + "#{'/' if dirs_up > 0}dropsite-assets/#{Dropsite.underscorize(rendered_by)}/"
+      end
+    end
+
+    def page_assets_link_base
+      "#{root? ? 'dropsite/' : ''}#{page_assets_dir_name}/"
+    end
+
     def get_binding
       binding
     end