dropsite 0.3.1 → 0.3.2

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2010 Aaron Royer
+Copyright (c) 2010-2011 Aaron Royer
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the 'Software'), to deal

data/README.rdoc

@@ -0,0 +1,88 @@
+= Dropsite
+
+Dropsite creates a site of interlinked file index pages in the Public directory
+of your Dropbox. Dropsite is designed to be minimally invasive to your Public
+directory by only creating one top-level HTML page and one folder, leaving your
+directories unjunked.
+
+BE WARNED: while this seems to work fine, it is presently considered
+experimental.
+
+== Installation
+
+  gem install dropsite
+
+== Usage
+
+To create the site:
+  dropsite
+
+This deletes "index.html" and the directory "dropsite" in your Dropbox Public
+directory if they exist, creates "index.html" as the top-level index, and puts
+the rest of the index pages and assets in the "dropsite" directory.
+
+To specify a different Dropbox directory:
+  dropsite --dropbox-home ~/Somewhere/Else
+
+You can also use this if you want to test site generation elsewhere first.
+
+
+For more help:
+
+  dropsite --help
+
+== Development
+
+=== Source Repository
+
+http://github.com/aaronroyer/dropsite
+
+Git clone URL is
+
+* git://github.com/aaronroyer/dropsite.git
+
+=== Issues and Bug Reports
+
+You can open issues at Github
+
+* http://github.com/aaronroyer/dropsite/issues
+
+Or you can send me an email: aaronroyer@gmail.com
+
+== Attribution
+
+Dropsite uses icons from:
+
+famfamfam.com
+
+Echo Project (fedorahosted.org/echo-icon-theme/)
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2010-2011 Aaron Royer
+
+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.
+
+
+== Other stuff
+
+Author::   Aaron Royer <aaronroyer@gmail.com>
+Requires:: Ruby 1.8.6 or later

data/dropsite.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'dropsite'
-  s.version = '0.3.1'
+  s.version = '0.3.2'
   s.platform = Gem::Platform::RUBY
 
   s.description = "creates index pages in your Dropbox public directory"
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.email       = "aaronroyer@gmail.com"
 
   s.files           = Dir['{bin/*,lib/**/*,test/**/*}'] +
-                          %w(README LICENSE dropsite.gemspec Rakefile)
+                          %w(README.rdoc LICENSE dropsite.gemspec Rakefile)
 
   s.executables << 'dropsite'
 

data/lib/dropsite/application.rb

@@ -7,7 +7,7 @@ module Dropsite
     def run
       handle_options
 
-      options.dropbox_home = dropbox_dir if not options.dropbox_home
+      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'
@@ -33,12 +33,12 @@ module Dropsite
     end
 
     def create_config_dir
-      if dropsite_config_dir
-        puts "Config directory already exists at: #{dropsite_config_dir}"
+      if Dropsite.dropsite_config_dir
+        puts "Config directory already exists at: #{Dropsite.dropsite_config_dir}"
         exit
       end
 
-      config_dir = File.join(dropbox_dir, '.dropsite')
+      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
@@ -78,7 +78,8 @@ module Dropsite
     attr_reader :path, :exclude
 
     def initialize(path=nil)
-      @path = path || dropsite_config_dir ? File.join(dropsite_config_dir, 'config.yml') : ''
+      @path = path || Dropsite.dropsite_config_dir ?
+        File.join(Dropsite.dropsite_config_dir, 'config.yml') : ''
     end
 
     def read

data/lib/dropsite/dir_renderer.rb

@@ -50,5 +50,9 @@ module Dropsite
     def built_in?
       false
     end
+
+    def plugin_assets_dir
+      File.join(File.dirname(__FILE__), 'plugins', underscorize(self.class.name), 'assets')
+    end
   end
 end

data/lib/dropsite/globals.rb

@@ -1,44 +1,3 @@
-# Some utility methods to dump into Object
-
-# Attempts to find the Dropbox directory (not the Public directory, the Dropbox base
-# directory) on this box. Returns nil if an existing directory could not be found.
-def dropbox_dir
-  return ENV['DROPBOX_HOME'] if ENV['DROPBOX_HOME']
-
-  path = case RUBY_PLATFORM
-  when /darwin/, /linux/, /freebsd/
-    File.join(home_dir, 'Dropbox')
-  when /win32/, /mingw/
-    File.join(home_dir, 'My Documents', 'My Dropbox')
-  end
-
-  File.exist?(path) ? path : nil
-end
-
-# Find the configuration directory for Dropsite. The folder .dropsite is
-# looked for from most "local" to the Public folder outward. First in the
-# Public folder, then the Dropsite directory itself (recommended place) and
-# then the user's home directory.
-def dropsite_config_dir
-  config_dir_name = '.dropsite'
-  [
-    File.join(dropbox_dir, 'Public', config_dir_name),
-    File.join(dropbox_dir, config_dir_name),
-    File.join(home_dir, config_dir_name)
-  ].find {|dir| File.exist? dir}
-end
-
-# Platform-specific home directory
-def home_dir
-  home = ENV['HOME']
-  home = ENV['USERPROFILE'] if not home
-  if !home && (ENV['HOMEDRIVE'] && ENV['HOMEPATH'])
-    home = File.join(ENV['HOMEDRIVE'], ENV['HOMEPATH'])
-  end
-  home = File.expand_path('~') if not home
-  home = 'C:/' if !home && RUBY_PLATFORM =~ /mswin|mingw/
-  home
-end
 
 # Convert a camel-cased string into a lowercase, underscore separated string
 def underscorize(camel_cased_word)

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

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 class ImageThumbnails < Dropsite::DirRenderer
   def can_render?(site_dir)
     return false if not thumbnail_generator
@@ -12,11 +14,23 @@ class ImageThumbnails < Dropsite::DirRenderer
       src_image = e.abs_path
       case thumbnail_generator
       when :image_science
-        write_thumb_with_image_science(src_image, assets_dir)
+        begin
+          write_thumb_with_image_science(src_image, assets_dir)
+        rescue RuntimeError => e # I believe this is as specific as it gets
+          site_dir.warning "Could not create thumbnail for #{src_image} with ImageScience, " +
+            "a possible reason is that ImageScience cannot create thumbs for animated gifs" +
+            "\nError message: #{e.message}"
+          write_default_thumbnail(src_image, site_dir)
+        end
       when :rmagick
-        write_thumb_with_rmagick(src_image, assets_dir)
+         begin
+           write_thumb_with_rmagick(src_image, assets_dir)
+          rescue ImageMagickError => e
+            site_dir.warning "Could not create thumbnail for #{src_image} with RMagick\n#{e.message}"
+            write_default_thumbnail(src_image, assets_dir)
+          end
       else
-        raise "Unrecognized thumbnail generator: #{thumbnail_generator}"
+        site_dir.error "Unrecognized thumbnail generator: #{thumbnail_generator}"
       end
     end
   end
@@ -62,4 +76,15 @@ class ImageThumbnails < Dropsite::DirRenderer
   def thumb_file_name(image_file_name)
     File.basename(image_file_name).sub(/\.\w+$/, '') + '-thumb' + File.extname(image_file_name)
   end
+
+  def write_default_thumbnail(src_image, site_dir)
+    # Need to figure out what type of file this is to make it work
+    default_thumb = File.join(plugin_assets_dir, 'images', 'icons', "image-large#{File.extname(src_image)}")
+
+    if File.exist? default_thumb
+      FileUtils.cp(default_thumb,File.join(site_dir.page_assets_dir, thumb_file_name(src_image)))
+    else
+      site_dir.error "BUG: no default thumb type exists for files with extension: #{File.extname(src_image)}"
+    end
+  end
 end

data/lib/dropsite/site.rb

@@ -76,9 +76,26 @@ module Dropsite
       File.join(@site_files_dir, 'dropsite-assets')
     end
 
-    def notice(message)
+    # User message themes loosely based on those from github.com/mxcl/homebrew
+
+    # Output a normal user message
+    def notice(msg, strong=false)
+      # TODO: add a verbosity setting and use it here
+      return if @quiet
+      puts "#{Tty.blue}==>#{strong ? Tty.bold_white : Tty.reset + Tty.white} #{msg}#{Tty.reset}"
+    end
+
+    # Output a warning message
+    def warning(msg)
+      return if @quiet
+      puts "#{Tty.yellow}Warning#{Tty.reset}: #{msg}"
+    end
+
+    # Output an error message
+    def error(msg, err=nil)
       return if @quiet
-      warn "#{File.basename($0)}: #{message}"
+      puts "#{Tty.red}Error#{Tty.reset}: #{msg}#{', details follow...' if err}"
+      puts err.to_s if err
     end
 
     protected
@@ -112,3 +129,22 @@ module Dropsite
     end
   end
 end
+
+# Add a little color - based on some stuff from github.com/mxcl/homebrew
+class Tty
+  class << self
+    def blue; bold 34; end
+    def white; escape 39; end
+    def bold_white; bold 39; end
+    def red; underline 31; end
+    def yellow; underline 33 ; end
+    def reset; escape 0; end
+    def em; underline 39; end
+
+    private
+    def color(n); escape "0;#{n}" end
+    def bold(n); escape "1;#{n}" end
+    def underline(n); escape "4;#{n}" end
+    def escape(n); "\033[#{n}m" if $stdout.tty? end
+  end
+end

data/lib/dropsite/site_item.rb

@@ -1,25 +1,31 @@
 module Dropsite
   class SiteItem
     include Enumerable, RenderHelper
-    
+
     attr_accessor :path
-    
+
     def name
       File.basename @path
     end
-    
+
     def top_level?
       @path.sub(/^\//, '') == name
     end
-    
+
     def <=>(other)
       name <=> other.name
     end
-    
-    protected
-    
-    def notice(message)
-      @site.notice(message) if @site
+
+    def notice(msg)
+      @site.notice(msg) if @site
+    end
+
+    def warning(msg)
+      @site.warning(msg) if @site
+    end
+
+    def error(msg)
+      @site.error(msg) if @site
     end
   end
 end

data/lib/dropsite.rb

@@ -1,5 +1,45 @@
 module Dropsite
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
+
+  # Attempts to find the Dropbox directory (not the Public directory, the Dropbox base
+  # directory) on this box. Returns nil if an existing directory could not be found.
+  def dropbox_dir
+    return ENV['DROPBOX_HOME'] if ENV['DROPBOX_HOME']
+
+    path = case RUBY_PLATFORM
+    when /darwin/, /linux/, /freebsd/
+      File.join(home_dir, 'Dropbox')
+    when /win32/, /mingw/
+      File.join(home_dir, 'My Documents', 'My Dropbox')
+    end
+
+    File.exist?(path) ? path : nil
+  end
+
+  # Find the configuration directory for Dropsite. The folder .dropsite is
+  # looked for from most "local" to the Public folder outward. First in the
+  # Public folder, then the Dropsite directory itself (recommended place) and
+  # then the user's home directory.
+  def dropsite_config_dir
+    config_dir_name = '.dropsite'
+    [
+      File.join(dropbox_dir, 'Public', config_dir_name),
+      File.join(dropbox_dir, config_dir_name),
+      File.join(home_dir, config_dir_name)
+    ].find {|dir| File.exist? dir}
+  end
+
+  # Platform-specific home directory
+  def home_dir
+    home = ENV['HOME']
+    home = ENV['USERPROFILE'] if not home
+    if !home && (ENV['HOMEDRIVE'] && ENV['HOMEPATH'])
+      home = File.join(ENV['HOMEDRIVE'], ENV['HOMEPATH'])
+    end
+    home = File.expand_path('~') if not home
+    home = 'C:/' if !home && RUBY_PLATFORM =~ /mswin|mingw/
+    home
+  end
 end
 
 include Dropsite

data/test/helper.rb

@@ -16,12 +16,20 @@ module Fixtures
 
   def clean_tmp_dir
     Dir.entries(TMP_DIR).reject {|e| %w[. .. .gitignore].include? e}.each do |entry|
-    file = File.join(TMP_DIR, entry)
-    if File.directory?(file)
-      FileUtils.rm_rf(file)
-    else
-      File.delete(file)
+        file = File.join(TMP_DIR, entry)
+        if File.directory?(file)
+          FileUtils.rm_rf(file)
+        else
+          File.delete(file)
+        end
     end
-end
+  end
+
+  def use_tmp_ruby_inline_dir
+    # Don't use the regular ~/.ruby_inline dir (ImageScience uses RubyInline) and leave
+    # the cached compiled code there, it causes some problems when testing with different
+    # Ruby versions. Delete it after every test.
+    ENV['INLINEDIR'] = File.join(TMP_DIR, 'ruby_inline')
+    #Dir.mkdir(ENV['INLINEDIR'])
   end
 end

data/test/integration/test_process_site.rb

@@ -5,7 +5,10 @@ require 'nokogiri'
 class TestProcessSite < Test::Unit::TestCase
   include Fixtures
 
-  def setup; clean_tmp_dir end
+  def setup
+    clean_tmp_dir
+    use_tmp_ruby_inline_dir
+  end
   def teardown; clean_tmp_dir end
 
   def test_process_with_only_simple_index_pages

data/test/integration/test_process_site_many_folders.rb

@@ -5,7 +5,12 @@ require 'nokogiri'
 class TestProcessSiteManyFolders < Test::Unit::TestCase
   include Fixtures
 
-  def setup; clean_tmp_dir end
+  def setup
+    clean_tmp_dir
+    use_tmp_ruby_inline_dir
+  end
+
+  def teardown; clean_tmp_dir end
 
   def test_process_with_many_folders
     test_public_dir = File.join(TMP_DIR, 'many_folders_public')

data/test/integration/test_process_site_with_thumbnails.rb

@@ -7,16 +7,10 @@ class TestProcessSiteWithThumbnails < Test::Unit::TestCase
 
   def setup
     clean_tmp_dir
-    # Don't use the regular ~/.ruby_inline dir (ImageScience uses RubyInline) and leave
-    # the cached compiled code there, it causes some problems when testing with different
-    # Ruby versions. Delete it after every test.
-    ENV['INLINEDIR'] = File.join(TMP_DIR, 'ruby_inline')
-    Dir.mkdir(ENV['INLINEDIR'])
+    use_tmp_ruby_inline_dir
   end
 
-  def teardown
-    clean_tmp_dir
-  end
+  def teardown; clean_tmp_dir end
 
   def test_process_with_image_thumbnails
     test_public_dir = File.join(TMP_DIR, 'simple_public')
@@ -37,4 +31,15 @@ class TestProcessSiteWithThumbnails < Test::Unit::TestCase
     assert File.exist?(File.join(people_thumbs_dir, 'beach-thumb.jpg'))
     assert File.exist?(File.join(people_thumbs_dir, 'concert-thumb.jpg'))
   end
+
+  def test_process_with_image_thumbnails
+    test_public_dir = File.join(TMP_DIR, 'pics_with_animated_gif_public')
+    FileUtils.cp_r(File.join(FIXTURES_DIR, 'pics_with_animated_gif_public'), test_public_dir)
+    Site.new(:public_dir => test_public_dir, :quiet => true).process
+
+    # ImageScience can't create thumbs for animated gifs, but a default should be copied in its place
+
+    assert File.exist?(File.join(test_public_dir, *%w[dropsite dropsite-root-index-directory-assets kdog-thumb.gif]))
+    # Should be linked in the page as normal
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dropsite
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Aaron Royer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-26 00:00:00 -05:00
+date: 2011-02-27 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +36,12 @@ files:
 - lib/dropsite/plugins/image_thumbnails/assets/css/reset.css
 - lib/dropsite/plugins/image_thumbnails/assets/images/icons/directory-large.png
 - lib/dropsite/plugins/image_thumbnails/assets/images/icons/directory.png
+- lib/dropsite/plugins/image_thumbnails/assets/images/icons/image-large.bmp
+- lib/dropsite/plugins/image_thumbnails/assets/images/icons/image-large.gif
+- lib/dropsite/plugins/image_thumbnails/assets/images/icons/image-large.jpeg
+- lib/dropsite/plugins/image_thumbnails/assets/images/icons/image-large.jpg
+- lib/dropsite/plugins/image_thumbnails/assets/images/icons/image-large.png
+- lib/dropsite/plugins/image_thumbnails/assets/images/icons/image-large.tiff
 - lib/dropsite/plugins/image_thumbnails/assets/images/row-bg.png
 - lib/dropsite/plugins/image_thumbnails/image_thumbnails.erb
 - lib/dropsite/plugins/image_thumbnails/image_thumbnails.rb
@@ -58,6 +64,7 @@ files:
 - lib/dropsite/site_item.rb
 - lib/dropsite.rb
 - test/fixtures/many_folders_public/one/two/three/four/five/six/seven/eight/file.txt
+- test/fixtures/pics_with_animated_gif_public/kdog.gif
 - test/fixtures/simple_public/file1.txt
 - test/fixtures/simple_public/file2.txt
 - test/fixtures/simple_public/pics/leaves.jpg
@@ -74,7 +81,7 @@ files:
 - test/unit/test_site.rb
 - test/unit/test_site_dir.rb
 - test/unit/test_site_file.rb
-- README
+- README.rdoc
 - LICENSE
 - dropsite.gemspec
 - Rakefile

data/README

@@ -1,25 +0,0 @@
-dropsite
-    gem install dropsite
-
-Dropsite creates a site of interlinked file index pages in the Public directory
-of your Dropbox. The site created is minimally invasive to your Public
-directory by only creating one top-level HTML page and one folder, leaving your
-directories unjunked.
-
-BE WARNED: while this seems to work fine, it is presently considered
-experimental.
-
-To create the site:
-    $ dropsite
-
-This deletes "index.html" and the directory "dropsite" in your Dropbox Public
-directory if they exist, creates "index.html" as the top-level index, and puts
-the rest of the index pages and assets in the "dropsite" directory.
-
-To specify a different Dropbox directory:
-    $ dropsite --dropbox-home ~/Somewhere/Else
-
-You can also use this if you just want to test this elsewhere before turning
-it loose on your precious files.
-
-MIT licensed - see LICENSE