gumdrop 0.7.4 → 0.7.5

data/ChangeLog.md

@@ -1,3 +1,11 @@
+# v0.7.5
+- Gumdrop dev server will serve up files from output_dir if the file isn't found in the source tree.
+- Added new template: blank
+- Coerces content into UTF-8, if it can, when relativizing paths (to work around encoding bugs).
+- Content class defers a lot of stuff from the initializer (for slightly faster startup).
+- Changed site.node_tree to site.content_hash. More representative of what it is.
+- Paths aren't relativized for pages that set force_absolute
+
 # v0.7.4
 - All rendered content (including layouts) will relativize paths starting with / on href="" and src="" for html files. Can be set to array of file exts to process at `config.relative_paths_for= ['.html']` or sett to process all files `config.relative_paths_for= :all` or turned off entirely by `config.relative_paths= false`
 - Proxy server is disabled by default. Enable it `configure.proxy = true`

data/Readme.md

@@ -182,6 +182,8 @@ Here's the `Gumdrop` file created by the default template:
 - Project Templates
 
 # Todo / Ideas / Changes
+- Create guard-gumdrop.
+- Add automatic sqlite loading to `data_manager`?
 - New/Update Doc site.
 - Need test coverage.
 - Some kind of admin? What would that even do?

data/lib/gumdrop/content.rb

@@ -4,48 +4,75 @@ module Gumdrop
   class Content
 
     MUNGABLE_RE= Regexp.new(%Q<(href|data|src)([\s]*)=([\s]*)('|"|&quot;|&#34;|&#39;)?\\/([\\/]?)>, 'i')
+    LAYOUTLESS_EXTS= %w(.css .js .xml)
     
-    attr_accessor :path, 
-                  :level, 
-                  :filename, 
-                  :source_filename, 
-                  :type, 
-                  :ext, 
-                  :uri, 
-                  :slug, 
-                  :template, 
-                  :params, 
-                  :site, 
-                  :ignored, 
-                  :generated,
-                  :full_path
+    attr_reader :full_path, :path, :params, :site
     
     def initialize(path, site, params={})
       @site= site
       @params= HashObject.new params
       @full_path= path
-      @ignored= false
-      @generated= false
-      @path= get_source_path
-      @level= (@path.split('/').length - 1)
-      @source_filename= File.basename path
-      @filename= get_target_filename
-      @type= File.extname @source_filename
-      @ext= File.extname @filename
-      @uri= get_uri
-      @slug=@uri.gsub('/', '-').gsub(@ext, '')
-      @template= unless Tilt[path].nil?
-        Tilt.new path
+    end
+
+    def slug
+      @slug ||= uri.gsub('/', '-').gsub(ext, '')
+    end
+
+    def ignored
+      @ignored ||= false
+    end
+    def ignore(state=true)
+      @ignored= state
+    end
+
+    def generated
+      @generated ||= false
+    end
+
+    def path
+      @path ||= get_source_path
+    end
+
+    def level
+      @level ||= (path.split('/').length - 1)
+    end
+
+    def source_filename
+      @source_filename ||= File.basename @full_path
+    end
+
+    def filename
+      @filename ||= get_target_filename
+    end
+
+    def type
+      @type ||= File.extname source_filename
+    end
+
+    def ext
+      @ext ||= File.extname filename
+    end
+
+    def uri
+      @uri ||= get_uri
+    end
+
+    def template
+      @template ||= unless Tilt[@full_path].nil?
+        Tilt.new @full_path
       else
         nil
       end
     end
+    def template=(t)
+      @template = t
+    end
     
     def render(context=nil, ignore_layout=false, reset_context=true, locals={})
-      context= @site.render_context if context.nil?
+      context= site.render_context if context.nil?
       if reset_context
-        default_layout= (@ext == '.css' or @ext == '.js' or @ext == '.xml') ? nil : 'site'
-        context.reset_data 'current_depth'=>@level, 'current_slug'=>@slug, 'page'=>self, 'layout'=>default_layout, 'params'=>self.params
+        default_layout= LAYOUTLESS_EXTS.include?(ext) ? nil : 'site'
+        context.reset_data 'current_depth'=>level, 'current_slug'=>slug, 'page'=>self, 'layout'=>default_layout, 'params'=>params
       end
       context.set_content self, locals
       content= render_all(context)
@@ -60,7 +87,7 @@ module Gumdrop
     
     def renderTo(context, output_path, filters=[], opts={})
       return copyTo(output_path, opts) unless useLayout?
-      @site.report " rendering: #{@uri}", :warning
+      site.report " rendering: #{uri}", :warning
       output= render(context)
       filters.each {|f| output= f.call(output, self) }
       File.open output_path, 'w' do |f|
@@ -68,7 +95,7 @@ module Gumdrop
       end
     end
           
-    
+    # This probably belongs to the BUILD, not here
     def copyTo(output, layout=nil, opts={})
       do_copy= if File.exists? output
         !FileUtils.identical? @full_path, output
@@ -76,10 +103,10 @@ module Gumdrop
         true
       end
       if do_copy
-        @site.report "   copying: #{@uri}", :warning
+        site.report "   copying: #{uri}", :warning
         FileUtils.cp_r @full_path, output, opts
       else
-        @site.report "    (same): #{@uri}", :info
+        site.report "    (same): #{uri}", :info
       end
     end
     
@@ -92,21 +119,21 @@ module Gumdrop
     end
     
     def useLayout?
-      !@template.nil?
+      !template.nil?
     end
 
     def ignore?
-      @ignored
+      ignored
     end
     
     def to_s
-      @uri
+      uri
     end
   
   private
 
     def get_source_path
-      path= @full_path.sub @site.src_path, ''
+      path= @full_path.sub site.src_path, ''
       if path[0] == '/'
         path[1..-1] 
       else
@@ -115,7 +142,7 @@ module Gumdrop
     end
 
     def get_target_filename
-      filename_parts= @source_filename.split('.')
+      filename_parts= source_filename.split('.')
       ext= filename_parts.pop
       while !Tilt[ext].nil?
         ext= filename_parts.pop
@@ -125,11 +152,11 @@ module Gumdrop
     end
 
     def render_all(ctx)
-      if @generated or !File.exists?(@full_path)
-        content= @template.render(ctx)
+      if generated or !File.exists?(@full_path)
+        content= template.render(ctx)
       else
         content= File.read @full_path
-        exts= @source_filename.gsub @filename, ''
+        exts= source_filename.gsub filename, ''
         exts.split('.').reverse.each do |ext|
           unless ext.blank?
             templateClass= Tilt[".#{ext}"]
@@ -144,7 +171,7 @@ module Gumdrop
     end
 
     def get_uri
-      uri= File.join File.dirname(@path), @filename
+      uri= File.join File.dirname(path), filename
       if uri.starts_with? './'
         uri[2..-1]
       else
@@ -153,9 +180,10 @@ module Gumdrop
     end
 
     def relativize(content, ctx)
-      if site.config.relative_paths
-        if site.config.relative_paths_for == :all or site.config.relative_paths_for.include?(@ext)
+      if site.config.relative_paths and !ctx.force_absolute
+        if site.config.relative_paths_for == :all or site.config.relative_paths_for.include?(ext)
           path_to_root= ctx.path_to_root
+          content.force_encoding("UTF-8") if content.respond_to? :force_encoding
           content = content.gsub MUNGABLE_RE do |match|
             if $5 == '/'
               "#{ $1 }#{ $2 }=#{ $3 }#{ $4 }/"

data/lib/gumdrop/context.rb

@@ -18,8 +18,8 @@ module Gumdrop
       else
         "#{ path_to_root }#{ path }"
       end
-      if opts[:fresh] and @site.node_tree.has_key?(path)
-        uri_string += "?v=#{ @site.node_tree[path].mtime.to_i }"
+      if opts[:fresh] and @site.content_hash.has_key?(path)
+        uri_string += "?v=#{ @site.content_hash[path].mtime.to_i }"
       end
       uri_string = "/" if uri_string == ""
       uri_string
@@ -123,8 +123,8 @@ module Gumdrop
   protected
     
     def get_page(path)
-      page= @site.node_tree[path]
-      page= @site.node_tree["#{path}.html"] if page.nil? # Bit of a hack...
+      page= @site.content_hash[path]
+      page= @site.content_hash["#{path}.html"] if page.nil? # Bit of a hack...
       page= @site.partials[path] if page.nil?
       page= @site.layouts[path] if page.nil? # ???
       page

data/lib/gumdrop/generator.rb

@@ -58,12 +58,12 @@ module Gumdrop
           @site.layouts[ "#{opts[:template]}.template" ]
         end.template
       end
-      content.ignored= site.greylist.any? {|pattern| site.path_match name, pattern }
+      content.ignore site.greylist.any? {|pattern| site.path_match name, pattern }
       unless content.ignored
-        content.ignored= site.blacklist.any? {|pattern| site.path_match name, pattern }
+        content.ignore site.blacklist.any? {|pattern| site.path_match name, pattern }
       end      
       @site.report " generated: #{content.uri}", :info
-      @site.node_tree[content.uri]= content
+      @site.content_hash[content.uri]= content
     end
 
     # FIXME: Does redirect require abs-paths?
@@ -157,9 +157,9 @@ module Gumdrop
         rp = File.expand_path(opts[:root])
         relative_root = rp.gsub(sp, '')[1..-1]
         rrlen= relative_root.length - 1
-        @site.node_tree.keys.each do |path|
+        @site.content_hash.keys.each do |path|
           if path[0..rrlen] == relative_root and name != path
-            @site.node_tree.delete path
+            @site.content_hash.delete path
           end
         end
       end
@@ -185,7 +185,7 @@ module Gumdrop
     end
 
     def useLayout?
-      !@content_block.nil? or !@template.nil?
+      !@content_block.nil? or !template.nil?
     end
 
   end

data/lib/gumdrop/server.rb

@@ -31,6 +31,7 @@ module Gumdrop
 
         file_path= get_content_path params[:splat].join('/'), site
         site.report "[#{$$}] GET /#{params[:splat].join('/')} -> #{file_path}"
+        
         unless static_asset file_path
           since_last_build= Time.now.to_i - site.last_run.to_i
           # site.report "!>!>>>>> since_last_build: #{since_last_build}"
@@ -40,8 +41,8 @@ module Gumdrop
           end
         end
         
-        if site.node_tree.has_key? file_path
-          content= site.node_tree[file_path]
+        if site.content_hash.has_key? file_path
+          content= site.content_hash[file_path]
           if content.useLayout?
             site.report "[#{$$}]  *Dynamic: #{file_path} (#{content.ext})"
             content_type :css if content.ext == '.css' # Meh?
@@ -54,6 +55,11 @@ module Gumdrop
             site.report "[#{$$}]  *Static: #{file_path}"
             send_file File.join( site.src_path, file_path)
           end
+        
+        elsif File.exists? File.join(site.config.output_dir, file_path)
+            site.report "[#{$$}]  *Static (from OUTPUT): #{file_path}"
+            send_file File.join(site.config.output_dir, file_path)
+        
         else
           site.report "[#{$$}]  *Missing: #{file_path}", :error
           "#{file_path} Not Found"
@@ -69,7 +75,7 @@ module Gumdrop
         if file_path == ""
           "index.html"
         else
-          keys.detect {|k| site.node_tree.has_key?(k) }
+          keys.detect {|k| site.content_hash.has_key?(k) } or file_path
         end
       end
 
@@ -84,6 +90,7 @@ module Gumdrop
       end
       
       def static_asset(file_path)
+        return false if file_path.nil? or File.extname(file_path).nil?
         STATIC_ASSETS.include? File.extname(file_path).to_s
       end
       

data/lib/gumdrop/site.rb

@@ -31,7 +31,7 @@ module Gumdrop
                 :config,
                 :data,
                 :sitefile,
-                :node_tree,
+                :content_hash,
                 :last_run
 
     extend Callbacks
@@ -55,21 +55,23 @@ module Gumdrop
 
     def contents(*args)
       opts= args.extract_options!
-      pattern= args[0] || nil
+      pattern= args.first || nil
+
       if pattern.nil?
         if opts[:as] == :hash
-          @node_tree
+          @content_hash
         else
-          @node_tree.values
+          @content_hash.values
         end
+      
       else
         nodes = opts[:as] == :hash ? {} : []
-        @node_tree.keys.each do |path|
+        @content_hash.keys.each do |path|
           if path_match path, pattern
             if opts[:as] == :hash
-              nodes[path]= @node_tree[path]
+              nodes[path]= @content_hash[path]
             else
-              nodes << @node_tree[path]
+              nodes << @content_hash[path]
             end
           end
         end
@@ -135,7 +137,7 @@ module Gumdrop
       @greylist        = []
       @redirects       = []
 
-      @node_tree       = Hash.new {|h,k| h[k]= nil }
+      @content_hash       = Hash.new {|h,k| h[k]= nil }
       @layouts         = Hash.new {|h,k| h[k]= nil }
       @partials        = Hash.new {|h,k| h[k]= nil }
       @generators      = Hash.new {|h,k| h[k]= nil }
@@ -212,7 +214,7 @@ module Gumdrop
           if blacklist.any? {|pattern| path_match path, pattern }
             report " excluding: #{path}", :info
           else
-            node.ignored= greylist.any? {|pattern| path_match path, pattern }
+            node.ignore greylist.any? {|pattern| path_match path, pattern }
             # Sort out Layouts, Generators, and Partials
             if File.extname(path) == ".template"
               layouts[path]= node
@@ -229,7 +231,7 @@ module Gumdrop
               partials[partial_node_path]= node
             
             else
-              @node_tree[path]= node
+              @content_hash[path]= node
             end
           end
         end
@@ -250,8 +252,8 @@ module Gumdrop
       unless opts[:dry_run]
         report "[Compiling to #{@out_path}]", :info
         on_before_render(self)
-        @node_tree.keys.sort.each do |path|
-          node= @node_tree[path]
+        @content_hash.keys.sort.each do |path|
+          node= @content_hash[path]
           unless node.ignore?
             output_path= File.join(@out_path, node.to_s)
             FileUtils.mkdir_p File.dirname(output_path)

data/lib/gumdrop/version.rb

@@ -1,5 +1,5 @@
 module Gumdrop
   
-  VERSION = "0.7.4" unless defined?(::Gumdrop::VERSION)
+  VERSION = "0.7.5" unless defined?(::Gumdrop::VERSION)
   
 end

data/specs/content_spec.rb

@@ -44,7 +44,7 @@ describe Gumdrop::Content do
 
   it "should relativize all absolute paths (when starts with /)" do
     site= get_test_site
-    # puts site.node_tree.keys
+    # puts site.content_hash.keys
 
     page= site.contents('posts/post1.html').first
     content= page.render

data/specs/fixtures/expected/posts/post1.js

@@ -4,7 +4,7 @@
   Test = (function() {
 
     function Test() {
-      this.img = $('<img src="../media/my-images.png">');
+      this.img = $('<img src="/media/my-images.png">');
     }
 
     return Test;

data/templates/blank/Gemfile

@@ -0,0 +1,33 @@
+source "http://rubygems.org"
+
+gem "i18n"
+gem "sinatra"
+gem "active_support"
+gem "rake"
+gem "gumdrop"
+
+# Add your dependencies here:
+
+# For template support:
+# gem "less"
+# gem "haml"
+# gem "slim"
+# gem "sass"
+# gem "coffee-script"
+
+# For JavaScript stitching and compressing:
+# gem 'packr'
+# gem 'uglifier'
+# gem 'yui-compressor'
+# gem 'jsmin'
+# gem 'stitch-rb'
+# gem 'sprockets'
+
+# For markdown support, a couple of options:
+# gem "redcarpet"
+# gem "kramdown", :git => "git://github.com/darthapo/kramdown.git"
+# gem "rdiscount"
+# gem 'maruku'
+
+# For xml generation support:
+# gem 'builder'

data/templates/blank/Gumdrop

@@ -0,0 +1,118 @@
+puts "Gumdrop v#{Gumdrop::VERSION} building..."
+
+configure do
+
+  #  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
+
+
+#  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)
+
+
+# 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
+
+# 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
+
+# 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|  end
+# on_end do |site|  end
+
+
+# View helpers (available in rendering context):
+view_helpers do
+
+  # Calculate the years for a copyright
+  def copyright_years(start_year, divider="–")
+    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!
+  #
+
+end
+
+# Any specialized code for your site goes here...
+
+# require 'slim'
+# Slim::Engine.set_default_options pretty:true

data/templates/blank/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require "bundler/setup"
+require 'gumdrop'
+
+# For the SYNC task
+USER='user'
+SERVER='server.com'
+FOLDER="~/#{SERVER}"
+
+site= Gumdrop::Site.new "./Gumdrop"
+OUTPUT=site.config.output_dir
+
+desc "Build source files into output_dir"
+task :build do
+  system("bundle exec gumdrop -b")
+end
+
+desc "Run development server"
+task :serve do
+  system("bundle exec gumdrop -s")
+end
+
+desc "Syncs with public server using rsync (if configured)"
+task :sync do
+  cmd= "rsync -avz --delete #{OUTPUT} #{USER}@#{SERVER}:#{FOLDER}"
+  puts "Running:\n#{cmd}\n"
+  system(cmd)
+  puts "Done."
+end
+
+desc "Outputs the Gumdrop version"
+task :version do
+  puts Gumdrop::VERSION
+end
+
+task :default do
+  puts `rake -T`
+end

data/templates/default/Gemfile

@@ -25,6 +25,8 @@ gem 'stitch-rb'
 #gem 'sprockets'
 
 # For markdown support, a couple of options:
+# gem "kramdown", :git => "git://github.com/darthapo/kramdown.git"
+# gem 'redcarpet'
 # gem "rdiscount"
 # gem 'maruku'
 

data/templates/default/Gumdrop

@@ -9,7 +9,7 @@ configure do
   
   #  All the supported build configuration settings and their defaults:
   # set :relative_paths, true
-  # set :proxy_enabled, true
+  # set :proxy_enabled, false
   # set :output_dir, "./output"
   # set :source_dir, "./source"
   # set :data_dir, './data'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 7
-  - 4
-  version: 0.7.4
+  - 5
+  version: 0.7.5
 platform: ruby
 authors: 
 - Matt McCray
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-26 00:00:00 -05:00
+date: 2012-06-27 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -170,6 +170,9 @@ files:
 - templates/backbone/source/theme/styles/_tools.scss
 - templates/backbone/source/theme/templates/app.template.slim
 - templates/backbone/source/theme/templates/site.template.slim
+- templates/blank/Gemfile
+- templates/blank/Gumdrop
+- templates/blank/Rakefile
 - templates/default/Gemfile
 - templates/default/Gumdrop
 - templates/default/Rakefile