gumdrop 0.8.0 → 1.0.0

data/specs/render_spec.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe Gumdrop::Renderer do
+
+  it 'should be instantiatable' do
+    r= Gumdrop::Renderer.new
+    r.wont_be_nil
+  end
+
+end

data/specs/site_spec.rb

@@ -0,0 +1,79 @@
+require_relative 'spec_helper'
+
+describe Gumdrop::Site do
+
+  it 'should be configured with default settings' do
+    site= site_for_source
+    site.config.wont_be_nil
+  end
+
+  it 'should have accessors for paths' do
+    site= site_for_source
+    site.config.source_dir.wont_be_nil
+    site.config.source_dir.must_equal '.'
+    site.source_dir.wont_be_nil
+    site.source_dir.must_equal site.config.source_dir
+
+    site.output_dir.wont_be_nil
+    site.output_dir.must_equal '../output'
+
+    site.data_dir.wont_be_nil
+    site.data_dir.must_equal './data'
+  end
+
+  it 'should allow changing config settings' do
+    site= site_for_source
+    site.source_dir.must_equal '.'
+    site.source_dir.must_equal site.config.source_dir
+
+    site.config.source_dir= './crap'
+    site.config.source_dir.must_equal './crap'
+    site.source_dir.must_equal site.config.source_dir
+  end
+
+  it 'should allow listening for events' do
+    site= site_for_source
+    scanned= 0
+    site.on :scan do |event|
+      scanned += 1
+    end
+    site.clear
+    site.scan_only #true
+    scanned.must_equal 1
+  end
+
+  it 'should allow listening for events from Gumdrop too' do
+    site= site_for_source
+    scanned= 0
+    Gumdrop.site.clear 
+    Gumdrop.site.on :scan do |event|
+      scanned += 1
+    end
+    Gumdrop.on :before_scan do |event|
+      scanned += 1
+    end
+    Gumdrop.on :scan do |event|
+      scanned += 1
+    end
+    Gumdrop.on :after_scan do |event|
+      scanned += 1
+      #puts "#{event.data[:payload]} Items Scanned"
+    end
+    Gumdrop.site.scan_only
+    scanned.must_equal 4
+  end
+
+  # it 'should allow changing config settings via block' do
+  #   site= site_for_source
+  #   site.source_dir.must_equal './source'
+  #   site.source_dir.must_equal site.config.source_dir
+
+  #   Gumdrop::Site.configure do |c|
+  #     c.source_dir= './junk'
+  #   end
+
+  #   site.config.source_dir.must_equal './junk'
+  #   site.source_dir.must_equal site.config.source_dir
+  # end
+
+end

data/specs/spec_helper.rb

@@ -0,0 +1,59 @@
+require 'pp'
+require 'fileutils'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'bundler/setup'
+
+HERE= File.dirname(__FILE__)
+$LOAD_PATH << File.expand_path(File.join(HERE, '..', 'lib'))
+
+require 'gumdrop'
+
+# Paths
+
+def fixture_path(path)
+  (HERE / 'fixtures' / path).expand_path
+end
+
+def fixture_src(path)
+  fixture_path 'source' / path
+end
+
+def fixture_exp(path)
+  fixture_path 'expected' / path
+end
+
+# Content Objects
+
+def content_for_source(path, opts={})
+  # content_for fixture_src(path), site_for_source, opts
+  # site_for_source.scan_only.contents.get path
+  if opts[:generated]
+    site_for_source.scan_only
+    generator= Gumdrop::Generator.new(nil) { }
+    content= Gumdrop::Content.new(path, generator) { }
+    content
+  else
+    site_for_source.scan_only.contents.get path
+  end
+end
+
+# Site
+
+def site_for_source()
+  Gumdrop::Site.new fixture_src('Gumdrop'), mode:'test', env:'test'
+end
+
+# Custom Assertions
+
+module MiniTest::Assertions
+  WHITESPACE_RE= Regexp.new('[\s]*', 'im')
+  def assert_sorta_like(expected, source)
+    exp= expected.gsub(WHITESPACE_RE, '')
+    src= source.gsub(WHITESPACE_RE, '')
+    assert exp == src, "Expected source to match source (ignoring whitespace)\n#{ exp }\n<=>\n#{ src }"
+  end
+end
+
+String.infect_an_assertion :assert_sorta_like, :must_be_sorta_like
+

data/templates/blank/Gemfile

@@ -1,9 +1,5 @@
 source "http://rubygems.org"
 
-gem "i18n"
-gem "sinatra", :require=>false
-gem "active_support"
-gem "thor", :require=>false
 gem "gumdrop"
 
 # Add your dependencies here:

data/templates/blank/Gumdrop

@@ -1,141 +1,208 @@
 
-configure do
+Gumdrop.configure do|config|
 
-  #  All the supported build configuration settings and their defaults:
+  # You can add whatever custom config options you'd like:
 
-  # set :relative_paths, true
-  # set :proxy_enabled,  false
-  # set :output_dir,     "./output"
-  # set :source_dir,     "./source"
-  # set :data_dir,       './data'
-  # set :log,            './logs/build.log'
-  # set :ignore,         %w(.DS_Store .gitignore .git .svn .sass-cache)
-  # set :server_timeout, 15
-  # set :server_port,    4567
+  # config.site_title=   "My Site"
+  # config.site_tagline= "My home on thar intarwebs!"
+  # config.site_author=  "Me"
+  # config.site_url=     "http://www.mysite.com"
 
-  # set :server, "REMOTE_USERNAME"
-  # set :server_user, 'server.com'
-  # set :server_path, '~/server.com'
+  # config.redirects= [
+  #   { from:"old-path.html", to:"new-path.html" }
+  # ]
+  
+  # You can modify how Gumdrop runs and where it looks for things by
+  # modifying these configuration settings (included below are their
+  # default values):
+
+  # config.output_dir= "./output"
+  # config.source_dir= "./source"
+  # config.data_dir= './data'
+  # config.relative_paths= true
+  # config.relative_paths_exts= %w(.html .htm)
+  # config.default_layout= 'site'
+  # config.layout_exts= %w(.html .htm)
+  # config.proxy_enabled= false
+  # config.log= STDOUT
+  # config.log_level= :info
+  # config.server_timeout= 5
+  # config.server_port= 4567
+  # config.env= :production
+  # config.file_change_test= :checksum
+
+  # You can set ignore/blacklist here, but it'd be better to use the gumdrop 
+  # methods `Gumdrop.ignore(*paths)` and `Gumdrop.blacklist(*paths)`
+  # config.ignore= %w(**/.DS_Store .git* .git/**/* .svn/**/* **/.sass-cache/**/* Gumdrop)
+  # config.blacklist= []
+
+  # Optional, if you want to use the example 'sync' command below.
+
+  # You can call config.set and pass a hash, if you prefer that format:
+  # config.set({
+  #   server: 'example-server.com',
+  #   server_user: 'example-username',
+  #   server_path: '~/example-server.com'
+  # })
 
 end
 
+# Ignored files are not read from the source_dir into memory.
+# Use file glob pattern:
+# Gumdrop.ignore "**/ignore.me"
+
+# Blacklisted files will not be render to output_dir (even generated pages). 
+# Use file glob pattern:
+# Gumdrop.blacklist "**/wont.render"
+
+# Generators are a way of dynamically creating pages.
+# You can create generators like the following example or in the source tree
+# by creating a file with the extension `.generator`. The only difference is
+# that generators in the source_dir will assume the `base_path` of the 
+# `.generator` file path.
+# Gumdrop.generate 'Apache Specific Stuff (Example)' do
+#   page '.htaccess.erb' do
+#     # The return value will be used as the file content.
+#     # Since we give the filename (above) an .erb extension,
+#     # the rendering engine will run the following content
+#     # through erb before being saved to disk as `.htaccess`.
+#     <<-EOF
+# # For clean urls
+# DirectoryIndex index.html
+
+# <IfModule mod_rewrite.c>
+#     RewriteEngine On
+#     RewriteBase /
+
+#     # Do not do anything for already existing files and folders
+#     RewriteCond %{REQUEST_FILENAME} -f [OR]
+#     RewriteCond %{REQUEST_FILENAME} -d
+#     RewriteRule .+ - [L]
+
+#     # add .html file extension (if such file does exist)
+#     RewriteCond %{DOCUMENT_ROOT}/$1\.html -f
+#     RewriteRule ^(.+[^/])/?$ $1.html [L,QSA]
+# </IfModule>
+
+# # BEGIN Gzip
+# <IfModule mod_deflate.c>
+#   AddOutputFilterByType DEFLATE text/text text/html text/plain text/xml text/css application/x-javascript application/javascript
+# </IfModule>
+# # END Gzip
+
+# <% config.redirects.each do |opts| %>
+# Redirect <%= opts[:from] %> <%= opts[:to] %>
+# <% end %>
+#     EOF
+#   end
 
-#  Skipping files entirely from build process... Like they don't exist.
-# skip 'file-to-ignore.html'
-# skip 'dont-show/**/*'
-
-#  Ignores source file(s) from compilation, but does load the content into memory
-# ignore 'pages/**/*.*'
-
-#  NOTE: Skipping and ignoring matches like a file glob (it use File.fnmatch in fact)
-#       (this doesn't work for files detected by stitch)
-
+# end
 
-# Example site-level generator
-generate do
-  
-  #  Requires a about.template.XX file
-  # page "about.html", 
-  #   :template=>'about', 
-  #   :passthru=>'Available in the template'
-
-  # page 'robots.txt' do
-  #   # And content returned will be put in the file
-  #   """
-  #   User-Agent: *
-  #   Disallow: /
-  #   """
-  # end
-
-  #  Maybe for a tumblr-like pager
-  # pager= Gumdrop.data.pager_for :posts, base_path:'posts/page', page_size:5
-
-  # pager.each do |page|
-  #   page "#{page.uri}.html", 
-  #     template:'post_page', 
-  #     posts:page.items, 
-  #     pager:pager, 
-  #     current_page:pager.current_page
-  # end
-
-  #  Assemble javscript files in a CommonJS-like way with stitch-rb
-  # stitch 'app.js',        # JavaScript to assemble
-  #   :identifier=>'app',   # variable name for the library
-  #   :paths=>['./app'],
-  #   :root=>'./app', 
-  #   :dependencies=>[],    # List of scripts to prepend to top of file (non moduled)
-  #   :prune=>false,        # If true, removes the source files from Gumdrop.site hash
-  #   :compress=>:jsmin,    # Options are :jsmin, :yuic, :uglify
-  #   :obfuscate=>false,    # For compressors that support munging/mangling
-  #   :keep_src=>true       # Creates another file, ex: app-src.js
-  
-  # Or use sprockets 
-  # sprockets 'app.js', 
-  #   :src=>'app/index.js', 
-  #   :paths=>['./lib'], 
-  #   :prune=>true, 
-  #   :root=>'./src', 
-  #   :compress=>:packr, 
-  #   :keep_src=>true
-end
+# Gumdrop.generate 'Other Examples' do
+#   # Renders the about_site partial to about.html. 
+#   # It passes any other params on to the partial.
+#   # page "about.html",  :render=>'about_site', :passthru=>'Available to the partial'
+
+#   # If a block is passed in to `page`, the return value will be used as the file contents.
+#   page 'robots.txt' do
+#     """
+# User-Agent: *
+# Disallow: /
+#     """
+#   end
 
-# Example of using a content filter to compress CSS output
-# require 'yui/compressor'
-# content_filter do |content, info|
-#   if info.ext == '.css'
-#     puts "  Compress: #{info.filename}"
-#     compressor= YUI::CssCompressor.new
-#     compressor.compress( content )
-#   else
-#     content
+#   # Building a webapp and want to use Sprockets to assemble the JS? Gumdrop
+#   # supplies a sprockets helper (and a stitch one, if you'd prefer).
+#   # file 'app.js' do
+#   #   # file generators will not render with any layouts
+#   #   sprocket 'js/main.js'
+#   # end
+#   # You might want to keep the source .js files from being generated:
+#   # Gumdrop.blacklist "js/**/*.js"
+
+#   # You can access data from the "./data" folder (by default, it's configurable
+#   # of course) so you can create data-driven static pages... If that makes sense.
+#   data.news.each do |item|
+
+#     page "news/#{ item._id }-#{ item.slug }.html.markdown.erb", params:item do
+#       # The data manager adds item._id to the resultset. It is 
+#       # the file's basename minus extname.
+#       #
+#       # Since we added '.markdown' and '.erb' to the end of the filename,
+#       # when this page is rendered, it'll be passed through erb first,
+#       # then a markdown engine (which we've included in our Gemfile).
+#       #
+#       # Notice the params:#object option above, that will take
+#       # whatever hash values are there and merge them into the
+#       # the Content object's params -- so we can use access that
+#       # data elsewhere (see source/index.html.erb).
+#       item.content
+#     end
 #   end
+    
+#   # With all these generated pages, you might be curious what all will be
+#   # built by Gumdrop. To see an overview run:
+#   #   $ gumdrop uris
 # end
 
-# All Gumdrop Hooks: on_start, on_before_scan, on_scan, on_before_generate, on_generate, on_before_render, on_render, on_end
-on_start do |site|
+# Throughout the life of Gumdrop, several events are fired. You can listen
+# for them like this:
+Gumdrop.on :start do |event|
   puts "Gumdrop v#{Gumdrop::VERSION} building..."
+
+  # Some Gumdrop events you can listen for: 
+  # start, scan, generate, generate_item, render, render_item, end
+  #
+  # For more, see: https://github.com/darthapo/gumdrop/wiki/Gumdrop-Events
 end
-# on_end do |site|  end
 
 
-# View helpers (available in rendering context):
-view_helpers do
+# View helpers (available in the rendering context and generators):
+# Gumdrop.view_helpers do
 
-  # Calculate the years for a copyright
-  def copyright_years(start_year, divider="&#8211;")
-    end_year = Date.today.year
-    if start_year == end_year
-      "#{start_year}"
-    else
-      "#{start_year}#{divider}#{end_year}"
-    end
-  end
+#   # Calculate the years for a copyright
+#   def copyright_years(start_year, divider="&#8211;")
+#     end_year = Date.today.year
+#     if start_year == end_year
+#       "#{start_year}"
+#     else
+#       "#{start_year}#{divider}#{end_year}"
+#     end
+#   end
   
-  #
-  # Your custom helpers go here!
-  #
+#   #
+#   # Your custom helpers go here!
+#   #
+
+# end
 
-end
 
-# Add (thor) tasks to gumdrop command
-# for more: https://github.com/wycats/thor/wiki
-# tasks do
+# Add your own commands to the gumdrop command line interface (for this site)!
+# For more, see: https://github.com/wycats/thor/wiki
+# Gumdrop.cli do
   
-  # desc 'sync', "Syncs with public server using rsync (if configured)"  
-  # method_option :build, :aliases => '-b', :desc => 'Build content before syncing'
-  # method_option :dry_run, :aliases => '-d', :desc => 'Dry run'
-  # def sync
-  #   SITE.build if options[:build]
-  #   config= SITE.config
-  #   output= SITE.config.output_dir
-  #   cmd= "rsync -avz --delete #{output} #{config.server_user}@#{config.server}:#{config.server_path}"
-  #   puts "Running:\n#{cmd}\n"
-  #   system(cmd) unless options[:dry_run]
-  # end
+#   desc 'sync', "Syncs with public server using rsync (if configured)"  
+#   method_option :build, :aliases => '-b', :desc => 'Build content before syncing'
+#   method_option :dry_run, :aliases => '-d', :desc => 'Dry run'
+#   def sync
+#     Gumdrop.site.build if options[:build]
+#     config= Gumdrop.site.config
+#     output= Gumdrop.site.output_path
+#     dry_run= options[:dry_run] ? 'n' : ''
+#     unless config.server.nil? or config.server == 'example-server.com'
+#       cmd= "rsync -avz#{ dry_run } --delete #{ output } #{ config.server_user }@#{ config.server }:#{ config.server_path }"
+#       say "Running:\n#{ cmd }\n"
+#       system(cmd)
+#     else
+#       say "To use this command, please configure your server info in the Gumdrop file!"
+#     end
+#   end
 
 # end
 
-# Any specialized code for your site goes here...
+
+# Any other code you'd like to run... This is just a ruby file, after all!
 
 # require 'slim'
 # Slim::Engine.set_default_options pretty:true
+

data/templates/default/Gemfile

@@ -1,11 +1,6 @@
 source "http://rubygems.org"
 
-gem "i18n"
-gem "sinatra", :require=>false
-gem "active_support"
-gem "thor", :require=>false
-gem "rake"
-gem "gumdrop"
+gem "gumdrop", :path=>'../../'
 
 # Add your dependencies here:
 
@@ -25,11 +20,11 @@ gem 'stitch-rb'
 #gem 'sprockets'
 
 # For markdown support, a couple of options:
-# gem "kramdown", :git => "git://github.com/darthapo/kramdown.git"
+gem "kramdown", :git => "git://github.com/darthapo/kramdown.git"
 # gem 'redcarpet'
 # gem "rdiscount"
 # gem 'maruku'
 
 # For xml generation support:
-# gem 'builder'
+gem 'builder'