gumdrop 0.8.0 → 1.0.0

data/templates/default/Gumdrop

@@ -1,98 +1,164 @@
 
-configure do
+Gumdrop.configure do|config|
 
-  set :site_title,   "My Site"
-  set :site_tagline, "My home on thar intarwebs!"
-  set :site_author,  "Me"
-  set :site_url,     "http://www.mysite.com"
-  
-  #  All the supported build configuration settings and their defaults:
-  # 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
-
-end
+  # You can add whatever custom config options you'd like:
 
+  config.site_title=   "My Site"
+  config.site_tagline= "My home on thar intarwebs!"
+  config.site_author=  "Me"
+  config.site_url=     "http://www.mysite.com"
 
-#  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/**/*.*'
+  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'
+  })
 
-#  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
 
+# 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
 
-# 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
+end
 
-  #  Maybe for a tumblr-like pager
-  # pager= Gumdrop.data.pager_for :posts, base_path:'posts/page', page_size:5
+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
 
-  # pager.each do |page|
-  #   page "#{page.uri}.html", 
-  #     template:'post_page', 
-  #     posts:page.items, 
-  #     pager:pager, 
-  #     current_page:pager.current_page
+  # 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
-
-  #  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
-   
+  # 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..."
-end
-# on_end do |site|  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
-#   end
-# end
+  # 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
 
 
-# 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;")
@@ -110,26 +176,31 @@ view_helpers do
 
 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
+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/ReadMe.md

@@ -0,0 +1,14 @@
+# Welcome to Gumdrop!
+
+This is an example site that you can use as a starting point. Or you can just
+poke around and see what all can be done and then start with an empty project
+by running this (in a non-Gumdrop site folder):
+
+    $ gumdrop new -t blank MY_NEW_SITE
+
+## Lots More
+
+Gumdrop can do quite a lot and is very configurable. Be sure and read the wiki
+for documentation and more examples!
+
+[https://github.com/darthapo/gumdrop/wiki](https://github.com/darthapo/gumdrop/wiki)

data/templates/default/config.ru

@@ -5,6 +5,7 @@ require 'bundler'
 
 begin
   Bundler.setup(:default, :development)
+  Bundler.require if File.exists?('Gemfile')
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
   $stderr.puts "Run `bundle install` to install missing gems"

data/templates/default/data/news/20120703.yamldoc

@@ -0,0 +1,14 @@
+---
+title: Getting Ready for Release
+slug: getting-ready-for-release
+date: 2012-07-03 16:05:00 -0500
+---
+# <%= title %>
+
+Updating the docs and templates, hopeful for a launch of Gumdrop 1.0 later this week!
+
+```ruby
+Gumdrop.on :start do |event|
+  puts "Throw a party!"
+end
+```

data/templates/default/data/news/20120704.yamldoc

@@ -0,0 +1,8 @@
+---
+title: Uncle Sam Turns 236!
+slug: uncle-sam-turns-236
+date: 2012-07-04 01:00:00 -0500
+---
+# <%= title %>
+
+And looks better than you will at that age!

data/templates/{backbone/source/feed.xml.builder.txt → default/source/feed.xml.builder}

@@ -5,19 +5,19 @@ xml.feed "xmlns" => "http://www.w3.org/2005/Atom" do
   xml.id config.site_url
   xml.link "href" => config.site_url
   xml.link "href" => "#{config.site_url}/feed.xml", "rel" => "self"
-  xml.updated data.blog.first.date.to_time.iso8601
+  xml.updated data.news.first.date.to_time.iso8601
   xml.author { xml.name config.site_author }
 
-  data.blog.each do |post|
+  site.contents.find("news/**/*").each do |post|
     xml.entry do
-      url= "#{config.site_url}/posts/#{post.slug}"
+      url= "#{config.site_url}/news/#{post._id}-#{post.slug}.html"
       xml.title post.title
       xml.link "rel" => "alternate", "href" => url
       xml.id url
       xml.published post.date.to_time.iso8601
       xml.updated post.date.to_time.iso8601
       xml.author { xml.name config.site_author }
-      xml.content post.body, "type" => "html"
+      xml.content render(post), "type" => "html"
     end
   end
 end

data/templates/default/source/index.html.erb

@@ -1 +1,10 @@
-<p>Welcome to <%= config.site_title %></p>
+<p>Welcome to <%= config.site_title %></p>
+<h4>News</h4>
+<ul>
+<%
+  # We can query Gumdrop for the contents of the source_tree:
+  site.contents.find('news/**/*').each do |page|
+%>
+  <li><a href="<%= page.uri %>"><%= page.title %></a></li>
+<% end %>
+</ul>

data/templates/default/source/theme/layout/_sidebar.html

@@ -0,0 +1 @@
+<p>I'm the sidebar partial!</p>

data/templates/{backbone/source/theme/templates/site.template.slim → default/source/theme/layout/site.layout.slim}

@@ -5,8 +5,8 @@ html lang="en"
     title= config.site_title
     /[if le IE 9]
       script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"
-    link rel="stylesheet" href==uri('theme/screen.css') type="text/css" media="screen" charset="utf-8"
-    script src==uri('theme/scripts/app.js')
+    link rel="stylesheet" href='/theme/screen.css' type="text/css" media="screen" charset="utf-8"
+    script src='/theme/scripts/app.js'
   body
     div.row
       div.col.span-12
@@ -18,7 +18,7 @@ html lang="en"
         nav
           ul
             li
-              a href==uri('/') Home
+              a href='/index.html' Home
     article
       div.row
         div.col.span-8