dropsite 0.2.1 → 0.3.0

data/lib/dropsite/site.rb

@@ -1,35 +1,34 @@
 require 'fileutils'
 
 module Dropsite
-  VERSION = '0.2'
-  
   # Main site builder class. Some inspiration here from Jekyll (github.com/mojombo/jekyll).
   class Site
-    attr_reader :site_tree, :public_dir
-    
+    attr_reader :site_tree, :public_dir, :exclude, :disabled_plugins, :site_files_dir
+
     def initialize(config)
       if config.is_a? String
         @public_dir = config
-        @excludes = []
+        @exclude, @disabled_plugins = [], []
         @quiet = false
       else
         @config = config.clone
         @public_dir = config[:public_dir]
-        @excludes = config[:excludes] || []
+        @exclude = config[:exclude] || []
+        @disabled_plugins = config[:disabled_plugins] || []
         @quiet = config[:quiet] || false
       end
-      
+
       @site_tree = nil
       @site_files_dir = File.join(@public_dir, 'dropsite')
     end
-    
+
     def process
       clean
       read
       render
       write
     end
-    
+
     # Cleans up files previously generated by Dropsite (or at least ones)
     # that look like they are. By default this will be an index.html
     # file and dropsite directory in the Public directory root.
@@ -38,49 +37,52 @@ module Dropsite
         notice "Deleting existing site files dir at #{@site_files_dir}"
         FileUtils.rm_rf(@site_files_dir)
       end
-      
+
       index_file = File.join(@public_dir, 'index.html')
       if File.exist?(index_file)
         notice "Deleting existing top-level index at #{index_file}"
         File.delete(index_file)
       end
     end
-    
+
     def read
       @site_tree = read_directory
     end
-    
+
     def render
-      @site_tree.render
+      site_tree.render
     end
-    
+
     def write
-      notice "Creating site files dir at #{@site_files_dir}"
-      Dir.mkdir(@site_files_dir)
-      @site_tree.write
-      
-      site_assets_dir = File.join(@site_files_dir, 'dropsite-assets')
-      Dir.mkdir(site_assets_dir)
+      notice "Creating site files dir at #{site_files_dir}"
+      Dir.mkdir(site_files_dir)
+      site_tree.write
+
+      Dir.mkdir(assets_dir)
       DirRenderer.renderers.each do |r|
         if File.exist? r.assets_dir
-          FileUtils.cp_r(r.assets_dir, File.join(site_assets_dir, Dropsite.underscorize(r.class.to_s)))
+          FileUtils.cp_r(r.assets_dir, File.join(assets_dir, Dropsite.underscorize(r.class.to_s)))
         end
       end
     end
-    
+
+    def assets_dir
+      File.join(@site_files_dir, 'dropsite-assets')
+    end
+
     def notice(message)
       return if @quiet
       warn "#{File.basename($0)}: #{message}"
     end
-    
+
     protected
-    
+
     def read_directory(dir='')
       base = File.join(@public_dir, dir)
       entries = filter_entries(Dir.entries(base))
-      
+
       dir_entries = []
-      
+
       entries.each do |f|
         f_abs = File.join(base, f)
         f_rel = File.join(dir, f).sub(/^\//, '')
@@ -96,10 +98,10 @@ module Dropsite
       end
       SiteDir.new(dir, dir_entries, self)
     end
-    
+
     def filter_entries(entries)
       entries.reject do |e|
-        ['.', '_', '#'].include?(e[0..0]) || e[-1..-1] == '~' || @excludes.include?(e)
+        ['.', '_', '#'].include?(e[0..0]) || e[-1..-1] == '~' || @exclude.include?(e)
       end
     end
   end

data/lib/dropsite/site_dir.rb

@@ -1,59 +1,111 @@
 module Dropsite
   class SiteDir < SiteItem
     attr_accessor :entries
-    
+    attr_reader :site, :path, :content
+
     def initialize(path, entries, site)
       @path = path == '/' ? '' : path
       @entries = entries
       @site = site
       @content = nil
     end
-    
+
     def render
-      @content = Dropsite::DirRenderer.find_renderer_and_render(self)
+      @content = renderer.render(self)
       dirs.each {|dir| dir.render}
     end
-    
+
+    # Writes the page for this directory, plus any additional files needed by the page.
     def write
       if root?
-        # The root site directory was created in Site
-        index_file = File.join(@site.public_dir, 'index.html')
+        index_file = File.join(page_dir, 'index.html')
         notice "Writing top level index file at #{index_file}"
-        File.open(index_file, 'w') {|f| f.puts @content}
+        File.open(index_file, 'w') {|f| f.puts content}
       else
-        # Sub-directories all need to be created here
-        pieces = @path.sub(/^\//, '').split('/')
-        dir_name = File.join(@site.public_dir, 'dropsite', *pieces)
-        index_file = dir_name + '.html'
-        notice "Writing index file at #{index_file}"
-        File.open(index_file, 'w') {|f| f.puts @content}
-        Dir.mkdir(dir_name)
+        # First create the index page
+        index_file = File.join(page_dir, name + '.html')
+        notice "Writing index file for directory #{path} at #{index_file}"
+        File.open(index_file, 'w') {|f| f.puts content}
+
+        # Create a directory to contain index pages for any child directories
+        Dir.mkdir(File.join(page_dir, name))
       end
       dirs.sort.each{|dir| dir.write}
+
+      # Determine if the page assets directory is necessary, to avoid clutter
+      writing_page_assets = true
+      begin
+        # Detect whether the write_page_assets method is overridden
+        # In case this explodes in 1.8.6 we'll always create the directory
+        writing_page_assets = renderer.class.instance_method(:write_page_assets).owner != DirRenderer
+      rescue
+      end
+
+      # The renderer knows what assets are linked to and what needs to be available
+      # to display the page properly
+      if writing_page_assets
+        Dir.mkdir(page_assets_dir)
+        renderer.write_page_assets(self)
+      end
     end
-    
-    def files
-      @entries.find_all {|e| e.is_a? SiteFile}
+
+    # All regular files in this directory
+    def files; entries.find_all {|e| e.is_a? SiteFile} end
+
+    # All directories in this directory
+    def dirs; entries.find_all {|e| e.is_a? SiteDir} end
+
+    # Is this the site root directory?
+    def root?; path == '' end
+
+    # The file type is always 'directory'
+    def file_type; 'directory' end
+
+    # The human readable size is blank
+    def size; '' end
+
+    # Directory where the page will be written
+    def page_dir
+      if root?
+        site.public_dir
+      else
+        pieces = path.sub(/^\//, '').split('/')
+        File.join(site.site_files_dir, *pieces[0..-2])
+      end
     end
-    
-    def dirs
-      @entries.find_all {|e| e.is_a? SiteDir}
+
+    # Directory to store extra files needed by the page rendered to represent this directory.
+    # This will almost always be the directory the page is in, except for the case of the
+    # root index page. Since the root index page is in Dropbox/Public and we don't want to
+    # pollute that directory we put the assets in the root of the dropsite directory.
+    def page_assets_dir
+      File.join(root? ? site.site_files_dir : page_dir, page_assets_dir_name)
     end
-    
-    def root?
-      @path == ''
+
+    def to_s
+      "SiteDir(#{is_root? ? 'root' : path})"
     end
-    
-    def file_type
-      'directory'
+
+    protected
+
+    def page_assets_dir_name
+      "dropsite-#{root? ? 'root-index-directory' : name}-assets"
     end
-    
-    def size
-      ''
+
+    # Find the first renderer that can render this SiteDir. Non-built-in (user) plugins
+    # are searched first.
+    def renderer
+      DirRenderer.renderers.partition {|r| !r.built_in?}.flatten.find do |r|
+        r.can_render?(self) && !plugin_disabled?(r)
+      end
     end
-    
-    def to_s
-      "SiteDir(#{is_root? ? 'root' : @path})"
+
+    # Figures out whether the plugin with the given name is disabled. This matches against the
+    # Site's disabled list, ignoring underscores and case.
+    def plugin_disabled?(plugin)
+      site.disabled_plugins.find do |p|
+        p.gsub(/_/, '').downcase == plugin.class.name.gsub(/_/, '').downcase
+      end
     end
   end
 end

data/lib/dropsite/site_file.rb

@@ -1,29 +1,30 @@
 module Dropsite
   class SiteFile < SiteItem
     EXTENSIONS = {
-      'image' => %w[jpg jpeg gif png],
-      'text' => %w[txt],
-      'pdf' => %w[pdf]
+      :image => %w[jpg jpeg gif png],
+      :text => %w[txt],
+      :pdf => %w[pdf]
     }
-    
-    attr_accessor :size_in_bytes
-    
+
+    attr_accessor :size_in_bytes, :abs_path
+
     def initialize(rel_path, abs_path=nil, site=nil)
       @path = rel_path
+      @abs_path = abs_path
       @size_in_bytes = File.size(abs_path) if abs_path
       @site = site
     end
-    
+
     def file_type
       if File.extname(name).empty?
-        'unknown'
+        :unknown
       else
         ext = File.extname(name).sub(/^\./, '')
         EXTENSIONS.each {|k, v| return k if v.include? ext}
-        return 'unknown'
+        return :unknown
       end
     end
-    
+
     # Human readable file size
     def size
       return '' if !@size_in_bytes
@@ -33,7 +34,7 @@ module Dropsite
       s = "%.1f" % (@size_in_bytes.to_f / 1024 ** e)
       s.sub(/\.?0*$/, " #{units[e]}")
     end
-    
+
     def to_s
       "SiteFile(#{@path})"
     end

data/lib/dropsite.rb

@@ -1,21 +1,46 @@
-
 module Dropsite
-  
+  VERSION = '0.2.1'
+
   # 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 find_dropbox_dir
+  def dropbox_dir
     return ENV['DROPBOX_HOME'] if ENV['DROPBOX_HOME']
-    
+
     path = case RUBY_PLATFORM
     when /darwin/, /linux/, /freebsd/
-      File.join(ENV['HOME'], 'Dropbox')
+      File.join(home_dir, 'Dropbox')
     when /win32/, /mingw/
-      File.join(ENV['USERPROFILE'], 'My Documents', 'My Dropbox')
+      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)
     camel_cased_word.to_s.gsub(/::/, '/').
@@ -25,6 +50,6 @@ module Dropsite
   end
 end
 
-%w[dir_renderer render_helper plugins site site_item site_dir site_file].each do |lib|
+%w[dir_renderer render_helper plugins site site_item site_dir site_file application].each do |lib|
   require File.join('dropsite', lib)
 end

data/test/fixtures/many_folders_public/one/two/three/four/five/six/seven/eight/file.txt

@@ -0,0 +1 @@
+Contents in the file

data/test/helper.rb

@@ -6,9 +6,22 @@ begin
 rescue LoadError
 end
 
-FILE_DIR = File.dirname(__FILE__)
-
-require File.join(FILE_DIR, *%w[.. lib dropsite])
+require File.join(File.dirname(__FILE__), *%w[.. lib dropsite])
 include Dropsite
 
-FIXTURES_DIR = File.join(FILE_DIR, 'fixtures')
+# Fixtures and tmp dir helpers
+module Fixtures
+  FIXTURES_DIR = File.join(File.dirname(__FILE__), 'fixtures')
+  TMP_DIR = File.join(FIXTURES_DIR, 'tmp')
+
+  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)
+    end
+end
+  end
+end

data/test/{test_write_site.rb → integration/test_process_site.rb}

@@ -1,60 +1,60 @@
-require File.join(File.dirname(__FILE__), 'helper')
+require File.join(File.dirname(__FILE__), '..', 'helper')
 require 'fileutils'
 require 'nokogiri'
 
-class TestWriteSite < Test::Unit::TestCase
-  TMP_DIR = File.join(FIXTURES_DIR, 'tmp')
-  
-  def setup
-    clean_tmp_dir
-  end
-  
-  def teardown
-    clean_tmp_dir
-  end
-  
-  def test_simple_process
-    FileUtils.cp_r(File.join(FIXTURES_DIR, 'simple_public'), File.join(TMP_DIR, 'simple_public'))
-    site = Site.new(:public_dir => File.join(TMP_DIR, 'simple_public'), :quiet => true)
+class TestProcessSite < Test::Unit::TestCase
+  include Fixtures
+
+  def setup; clean_tmp_dir end
+  def teardown; clean_tmp_dir end
+
+  def test_process_with_only_simple_index_pages
+    test_public_dir = File.join(TMP_DIR, 'simple_public')
+    FileUtils.cp_r(File.join(FIXTURES_DIR, 'simple_public'), test_public_dir)
+    site = Site.new(
+      :public_dir => test_public_dir,
+      :quiet => true,
+      :disabled_plugins => ['image_thumbnails']
+    )
     site.process
-    
+
     # Check that all the index pages are there
-    
+
     index_file = File.join(site.public_dir, 'index.html')
     assert File.exist?(index_file)
     index_doc = Nokogiri::HTML(IO.read(index_file))
     assert_equal 3, index_doc.css('.entry').size
-    
+
     assert_equal 'dropsite/pics.html', index_doc.css('a').find {|a| a.content == 'pics'}.attribute('href').value
-    
+
     site_dir = File.join(site.public_dir, 'dropsite')
     assert File.exist?(site_dir)
     assert File.directory?(site_dir)
-    
+
     pics_file = File.join(site_dir, 'pics.html')
     assert File.exist?(pics_file)
     pics_doc = Nokogiri::HTML(IO.read(pics_file))
     assert_equal 3, pics_doc.css('.entry').size
-    
+
     # Make sure the the links are correct
-    
+
     ['leaves.jpg', 'sculpture.jpg'].each do |pic|
       assert_equal "../pics/#{pic}", pics_doc.css('a').find {|a| a.content == pic}.attribute('href').value
     end
-    
+
     assert_equal 'pics/people.html', pics_doc.css('a').find {|a| a.content == 'people'}.attribute('href').value
-    
+
     people_file = File.join(site_dir, 'pics', 'people.html')
     assert File.exist?(people_file)
     people_doc = Nokogiri::HTML(IO.read(people_file))
     assert_equal 2, people_doc.css('.entry').size
-    
+
     ['beach.jpg', 'concert.jpg'].each do |pic|
       assert_equal "../../pics/people/#{pic}", people_doc.css('a').find {|a| a.content == pic}.attribute('href').value
     end
-    
+
     # Check that the assets were copied in
-    
+
     assets_dir = File.join(site.public_dir, 'dropsite', 'dropsite-assets')
     assert File.exist?(assets_dir)
     assert File.directory?(assets_dir)
@@ -62,23 +62,23 @@ class TestWriteSite < Test::Unit::TestCase
     assert File.exist?(simple_index_assets_dir)
     assert File.directory?(simple_index_assets_dir)
     assert File.exist?(File.join(simple_index_assets_dir, 'css', 'simple_index.css'))
-    
+
     # Check that the assets are included correctly
-    
+
     assert_equal 1, index_doc.css('link').find_all {|l|
       l.attribute('href').value == 'dropsite/dropsite-assets/simple_index/css/simple_index.css'
     }.size
     assert_equal 1, index_doc.css('script').find_all {|l|
       l.attribute('src').value == 'dropsite/dropsite-assets/simple_index/js/simple_index.js'
     }.size
-    
+
     assert_equal 1, pics_doc.css('link').find_all {|l|
       l.attribute('href').value == 'dropsite-assets/simple_index/css/simple_index.css'
     }.size
     assert_equal 1, pics_doc.css('script').find_all {|l|
       l.attribute('src').value == 'dropsite-assets/simple_index/js/simple_index.js'
     }.size
-    
+
     assert_equal 1, people_doc.css('link').find_all {|l|
       l.attribute('href').value == '../dropsite-assets/simple_index/css/simple_index.css'
     }.size
@@ -86,17 +86,4 @@ class TestWriteSite < Test::Unit::TestCase
       l.attribute('src').value == '../dropsite-assets/simple_index/js/simple_index.js'
     }.size
   end
-  
-  protected
-  
-  def clean_tmp_dir
-     Dir.entries(TMP_DIR).reject {|e| e =~ /^\./}.each do |entry|
-        file = File.join(TMP_DIR, entry)
-        if File.directory?(file)
-          FileUtils.rm_rf(file)
-        else
-          File.delete(file)
-        end
-      end
-  end
 end

data/test/integration/test_process_site_many_folders.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), '..', 'helper')
+require 'fileutils'
+require 'nokogiri'
+
+class TestProcessSiteManyFolders < Test::Unit::TestCase
+  include Fixtures
+
+  def setup; clean_tmp_dir end
+
+  def test_process_with_many_folders
+    test_public_dir = File.join(TMP_DIR, 'many_folders_public')
+    FileUtils.cp_r(File.join(FIXTURES_DIR, 'many_folders_public'), test_public_dir)
+    site = Site.new(:public_dir => test_public_dir, :quiet => true)
+    site.process
+
+    # TODO: add some tests
+  end
+end

data/test/integration/test_process_site_with_thumbnails.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), '..', 'helper')
+require 'fileutils'
+require 'nokogiri'
+
+class TestProcessSiteWithThumbnails < Test::Unit::TestCase
+  include Fixtures
+
+  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'])
+  end
+
+  def teardown
+    clean_tmp_dir
+  end
+
+  def test_process_with_image_thumbnails
+    test_public_dir = File.join(TMP_DIR, 'simple_public')
+    FileUtils.cp_r(File.join(FIXTURES_DIR, 'simple_public'), test_public_dir)
+    site = Site.new(
+      :public_dir => test_public_dir,
+      :quiet => true
+      # Don't disable image_thumbnails
+    )
+    site.process
+
+    # Just test the differences from processing with simple index pages, trust
+    # basic Dropsite setup is there
+
+    # TODO: make sure code using both image libraries is tested
+
+    people_thumbs_dir = File.join(test_public_dir, *%w[dropsite pics dropsite-people-assets])
+    assert File.exist?(File.join(people_thumbs_dir, 'beach-thumb.jpg'))
+    assert File.exist?(File.join(people_thumbs_dir, 'concert-thumb.jpg'))
+  end
+end

data/test/unit/test_application.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), '..', 'helper')
+
+class TestApplication < Test::Unit::TestCase
+  include Fixtures
+
+  def setup; clean_tmp_dir end
+  def teardown; clean_tmp_dir end
+
+  def test_create_config_files
+    ENV['DROPBOX_HOME'] = TMP_DIR
+    ARGV << '-c'
+    Application.new.run
+
+    config_dir = File.join(TMP_DIR, '.dropsite')
+    assert File.directory?(config_dir), 'Config dir created'
+    assert File.file?(File.join(config_dir, 'config.yml')), 'Main config file created'
+    assert File.directory?(File.join(config_dir, 'plugins')), 'plugins dir created'
+  end
+end

data/test/unit/test_config_file.rb

@@ -0,0 +1,34 @@
+require File.join(File.dirname(__FILE__), '..', 'helper')
+
+class TestConfigFile < Test::Unit::TestCase
+  include Fixtures
+
+  def setup
+    clean_tmp_dir
+    ENV['DROPBOX_HOME'] = TMP_DIR
+    config_dir = File.join(TMP_DIR, '.dropsite')
+    Dir.mkdir(config_dir) if !File.exist?(config_dir)
+  end
+
+  def teardown; clean_tmp_dir end
+
+  def test_read_exclude
+    write_config_file <<-YAML
+exclude: [ignore_this, and_also_this]
+YAML
+
+    cf = ConfigFile.new
+    cf.read
+
+    es = cf.exclude
+    assert_equal 2, es.size
+    assert es.include?('ignore_this')
+    assert es.include?('and_also_this')
+  end
+
+  private
+
+  def write_config_file(content)
+    File.open(File.join(TMP_DIR, '.dropsite', 'config.yml'), 'w') {|f| f.puts content}
+  end
+end