gumdrop 0.8.0 → 1.0.0

data/.gitignore

@@ -2,3 +2,6 @@
 *.gem
 output
 .sass-cache
+*.log
+old_*
+**/Gemfile.lock

data/ChangeLog.md

@@ -1,3 +1,16 @@
+# v1.0.0
+- Complete internel rearchitecture. Good stuff.
+- Gumdrop files are now straight ruby that's loaded by gumdrop. You can do any typical ruby kind of things are the root level without having any scope surprises (Gumdrop will have been loaded).
+- New event system. `Gumdrop.on :event_name {|e| }` Events:
+  - `:build`
+  - `:scan`
+  - `:generate`
+  - `:render`
+  - `:render_item`
+- All the events have :before_* and :after_* versions too.
+- Removed content filters. You can now listen for the :render_item event and set event.data.return_value to change content post-render (layout will have been applied)
+- New DataProviders: csv, xml and sqlite3
+
 # v0.8.0
 - Leveraging Thor for new CLI support.
 - Added watch command to watch filesystem and auto-compile.

data/Gemfile

@@ -1,3 +1,7 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
-gemspec
+gemspec
+
+group :test do
+  gem 'redcarpet'
+end

data/Gemfile.lock

@@ -1,31 +1,65 @@
 PATH
   remote: .
   specs:
-    gumdrop (0.7.5)
+    gumdrop (1.0.0)
       active_support
       bundle
       i18n
+      listen
+      onfire
       sinatra
       thor
       tilt
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
     active_support (3.0.0)
       activesupport (= 3.0.0)
     activesupport (3.0.0)
     bundle (0.0.1)
       bundler
+    chunky_png (1.2.5)
+    compass (0.12.2)
+      chunky_png (~> 1.2)
+      fssm (>= 0.2.7)
+      sass (~> 3.1)
+    ffi (1.0.11)
+    fssm (0.2.9)
+    hike (1.2.1)
     i18n (0.6.0)
+    jsmin (1.0.1)
+    listen (0.4.7)
+      rb-fchange (~> 0.0.5)
+      rb-fsevent (~> 0.9.1)
+      rb-inotify (~> 0.8.8)
+    minitest (3.2.0)
+    multi_json (1.3.6)
+    onfire (0.2.0)
     rack (1.4.1)
     rack-protection (1.2.0)
       rack
+    rb-fchange (0.0.5)
+      ffi
+    rb-fsevent (0.9.1)
+    rb-inotify (0.8.8)
+      ffi (>= 0.5.0)
+    redcarpet (2.1.1)
+    sass (3.2.0.alpha.261)
     sinatra (1.3.2)
       rack (~> 1.3, >= 1.3.6)
       rack-protection (~> 1.2)
       tilt (~> 1.3, >= 1.3.3)
-    thor (0.15.3)
+    sprockets (2.4.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.6)
+    stitch (0.1.6)
+      compass
+      sass (~> 3.2.0.alpha)
+    thor (0.15.4)
     tilt (1.3.3)
 
 PLATFORMS
@@ -33,3 +67,9 @@ PLATFORMS
 
 DEPENDENCIES
   gumdrop!
+  jsmin
+  minitest
+  redcarpet
+  sprockets
+  sqlite3
+  stitch

data/Rakefile

@@ -1,30 +1,46 @@
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require "gumdrop/version"
+#!/usr/bin/env rake
+
 require 'rake/testtask'
+require "bundler/gem_tasks"
 
-desc "builds gem"
-task :build do
-  system "gem build gumdrop.gemspec"
-end
- 
-desc "releases gem"
-task :release => :build do
-  system "gem push gumdrop-#{Gumdrop::VERSION}.gem"
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['specs/*_spec.rb']
+  t.verbose = false
 end
 
-desc "installs gem"
-task :install => :build do
-  system "gem install gumdrop-#{Gumdrop::VERSION}"
+task :default do
+  puts `rake -T`
 end
 
-desc "uninstalls gem"
-task :uninstall do
-  system "gem uninstall gumdrop"
+desc 'clears fixture generated output'
+task :test_output_clear do
+  require 'fileutils'
+  here= File.dirname __FILE__
+  FileUtils.rm_rf File.join( here, 'specs', 'fixtures', 'output' )
 end
 
+desc "generates fixture site then tests output against expected fixture data"
+task :test_output => :test_output_clear do
+  sh "cd specs/fixtures/source && bundle exec gumdrop build -f"
+  diff_results= `diff -w -r -y -N -q --suppress-common-lines specs/fixtures/output specs/fixtures/expected`
+  if diff_results.empty?
+    puts "\n\nPASS: All files matched!"
+    puts "#{ diff_results }"
+    diff_results.split("\n")
+  else
+    puts "\n\nFAIL: Not all files matched:\n\n"
+    puts "#{ diff_results }"
+    matcher= Regexp.new('Files (.*) and', 'i')
+    diff_results.scan(matcher).flatten.each do |fname|
+      puts "\n\n"
+      puts `diff -w -C 3 #{fname} #{fname.gsub('fixtures/output', 'fixtures/expected')}`
+    end
+  end
+  puts ""
+end
 
-Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.test_files = FileList['specs/*_spec.rb']
-  t.verbose = true
-end
+desc "test generated output > OpenDiff"
+task :test_output_ui do
+  sh "cd specs/fixtures/source && bundle exec gumdrop build -f && opendiff ../output ../expected"
+end

data/Readme.md

@@ -1,191 +1,93 @@
 # Gumdrop
 
-Gumdrop is a small and sweet cms/prototype tool. It can generate static html with relative paths, and includes a dev server that can be run via any rack server (including POW!).
+Gumdrop; The sweet cms/prototyping tool.
 
-## Install
-
-    gem install gumdrop
-
-# CLI Quick Ref
-
-### Create New Site
-
-    gumdrop --create my_new_site
-
-Shorter syntax:
-
-    gumdrop -c my_new_site
-
-### Create New Site From Template
+It generates static html and includes a dev server that can be run via any
+rack server (including POW!).
 
-    gumdrop -c my_new_site -t backbone
 
+## Install
 
-### Build Static HTML
-
-    gumdrop -b
-
-Or, you can use Rake:
-
-    rake build
-
-
-### Start Dev Server
-
-    gumdrop -s
-
-Or, using Rake again:
+```bash
+$ gem install gumdrop
+```
 
-    rake serve
 
-### Saving The Current Site As A Local Template
+## Quick Start
 
-    gumdrop -t my_template
+```bash
+$ gumdrop new SITE_NAME
+```
 
-You can then create new sites based on your local template:
+*(You can run `gumdrop help` to see a list of commands and their supported flags.)*
 
-    gumdrop -c my_new_from_my_template -t my_template
+Gumdrop will spit out a default Gumdrop project site for you, which you can then
+build by running:
 
-Local templates are stored under `~/.gumdrop/templates/`.
+```bash
+$ cd SITE_NAME
+$ gumdrop build
+```
 
+Bam! A static version of the site is now available in a newly created `./output`
+folder.
 
+Don't want the output there? Maybe you want it to put it in `./public` instead?
+No problem. Open up the `Gumdrop` project file:
 
-# Gumdrop File
+```bash
+$ $EDITOR Gumdrop
+```
 
-Gumdrop looks for a file named `Gumdrop` to indicate the root folder of your project. It'll walk up the directory structure looking for one, so you can run Gumdrop commands from sub-folders.
+At the top of the file you'll find a `Gumdrop.configure` block. Add this to the
+top of that block:
 
-The `Gumdrop` file is where you configure your site, generate dynamic content, assign view_helpers and more.
+```ruby
+Gumdrop.configure do |config|
 
-Here's the `Gumdrop` file created by the default template:
+  config.output_dir= "./public"
 
-    puts "Gumdrop v#{Gumdrop::VERSION} building..."
+  # ... Other stuff
 
-    configure do
+end
+```
 
-      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, true
-      # 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
+Now, when you run `gumdrop build` again, it'll generate all the output into
+the `./public` folder (creating it, if it doesn't exist).
 
-    end
 
+## Lots More
 
-    #  Skipping files entirely from build process... Like they don't exist.
-    # skip 'file-to-ignore.html'
-    # skip 'dont-show/**/*'
+That's enough to get you started! Poke around the code it generated to see how
+it works. You can also start with a blank slate by running:
 
-    #  Ignores source file(s) from compilation, but does load the content into memory
-    # ignore 'pages/**/*.*'
+```bash
+$ gumdrop new -t blank MY_BLANK_SITE
+```
 
-    #  NOTE: Skipping and ignoring matches like a file glob (it use File.fnmatch in fact)
-    #       (this doesn't work for files detected by stitch)
+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)
 
-    # Example site-level generator
-    generate do
-      
-      #  Requires a about.template.XX file
-      # page "about.html", 
-      #   :template=>'about', 
-      #   :passthru=>'Available in the template'
+## By The Power of...
 
-      # page 'robots.txt' do
-      #   # And content returned will be put in the file
-      #   """
-      #   User-Agent: *
-      #   Disallow: /
-      #   """
-      # end
+Greyskull? Well, not so much. But Gumdrop core is powered by these excellent
+open source projects (in alphabetical order):
 
-      #  Maybe for a tumblr-like pager
-      # pager= Gumdrop.data.pager_for :posts, base_path:'posts/page', page_size:5
+* ActiveSupport
+* Bundle
+* Listen
+* Onfire
+* Sinatra
+* Tilt
+* Thor 
 
-      # pager.each do |page|
-      #   page "#{page.uri}.html", 
-      #     template:'post_page', 
-      #     posts:page.items, 
-      #     pager:pager, 
-      #     current_page:pager.current_page
-      # end
+And will, optionally, leverage these in building your site:
 
-      #  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
-       
-    end
+* sqlite3
+* sprockets
+* stitch
+* jsmin
+* and many, many more! (todo: gotta document 'em all!)
 
-    # 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
-
-
-    # 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
-
-
-# Need To Document:
-
-- Proxy support
-- Stitch
-- "Dynamic" pages
-- Data support
-- Content filters
-- Partials
-- Config and using in pages
-- 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?
-    - If you could specify a 'prototype' for data collections, could be cool.
-- Add YamlDoc support for nodes? (Tilt compiler? or in Content)

data/bin/gumdrop

@@ -2,7 +2,6 @@
 # encoding: utf-8
 #  Copyright (c) 2011 M@ McCray. All rights reserved.
 
-# $: << File.expand_path(File.dirname(__FILE__) + "/../lib")
 require 'rubygems'
 require 'bundler/setup'
 require 'gumdrop'
@@ -10,6 +9,8 @@ Bundler.require if File.exists?('Gemfile')
 
 begin
   if Gumdrop.in_site_folder?
+    # Pre-Fetch Site and load Gumdrop file
+    Gumdrop.site()
     Gumdrop::CLI::Internal.start
   else
     Gumdrop::CLI::External.start

data/gumdrop.gemspec

@@ -15,21 +15,28 @@ Gem::Specification.new do |s|
 
    s.authors = ["Matt McCray"]
    s.email = %q{matt@elucidata.net}
-   s.summary = %q{The sweet 'n simple cms/prototyping tool.}
+   s.summary = %q{The sweet 'n simple cms and prototyping tool.}
    s.homepage = %q{https://github.com/darthapo/gumdrop}
-   s.description = %q{The sweet 'n simple cms/prototyping tool for creating static html websites and webapps.}
+   s.description = %q{The sweet 'n simple cms and prototyping tool for creating static html websites and webapps.}
 
    s.files         = `git ls-files`.split("\n")
    s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
    s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
    s.require_paths = ["lib"]
    
-   s.add_dependency 'sinatra'
+   s.add_dependency 'thor'
    s.add_dependency 'tilt'
    s.add_dependency 'active_support'
+   s.add_dependency 'onfire'
+   s.add_dependency 'sinatra'
    s.add_dependency 'listen'
-   s.add_dependency 'thor'
    s.add_dependency 'i18n'
    s.add_dependency 'bundle'
 
+   s.add_development_dependency 'minitest'
+   s.add_development_dependency 'sqlite3'
+   s.add_development_dependency 'sprockets'
+   s.add_development_dependency 'stitch'
+   s.add_development_dependency 'jsmin'
+
 end

data/lib/gumdrop/builder.rb

@@ -0,0 +1,164 @@
+require 'fileutils'
+require 'digest/md5'
+
+module Gumdrop
+
+  class Builder
+    include Util::SiteAccess
+
+    attr_reader :renderer, :checksums, :options
+
+    def initialize(opts={})
+      site.active_builder= self
+      opts= opts.to_symbolized_hash
+      @renderer= opts[:renderer] || Renderer.new
+      @copy_files=[]
+      @write_files=[]
+      @checksums={}
+      @options= opts
+      @use_checksum= if opts[:force]
+          false
+        else
+          site.config.file_change_test == :checksum
+        end
+    end
+
+    def execute
+      fire :start
+      event_block :build do
+        log.debug "[Building Site]"
+        log.debug "(Rendering)"
+        event_block :render do
+          if @options[:assets]
+            _build_assets @options[:assets], true
+          else
+            _build_assets site.contents.keys.sort
+          end
+        end
+        # All files rendered without exception, write them to disc
+        log.info "(Writing to #{ site.output_path })"
+        event_block :write do
+          @write_files.each {|files| _write files }
+          @copy_files.each  {|files| _copy files }
+        end
+      end
+      fire :end
+    rescue => ex
+      log.error _exception_message ex
+      $stderr.puts _exception_message ex, true
+      exit 1 unless site.options[:resume]
+    end
+
+  private
+
+    def _build_assets(uris, fuzzy_match=false)
+      uris.each do |uri|
+        if fuzzy_match
+          content= site.resolve uri
+        else
+          content= site.contents[uri]
+        end
+        log.error "Content not found! #{ uri }" and next if content.nil?
+        log.debug "  blackout: #{ uri }" and next if site.in_blacklist? uri
+        output_path= site.output_path / content.uri
+        if content.binary?
+          @copy_files << { content.source_path => output_path }
+        else
+          rendered_content= renderer.draw content
+          @write_files << { rendered_content => output_path }
+        end
+      end
+    end
+
+    def _copy(files)
+      files.each do |from,to|
+        event_block :copy_file do
+          if _file_changed? from, to
+            log.info "   copying: #{ _rel_path to }"
+            _ensure_path to
+            FileUtils.cp_r from, to
+          else
+            log.info " unchanged: #{ _rel_path to }"
+          end
+        end
+      end
+    end
+
+    def _write(files)
+      files.each do |rendered_content, to|
+        event_block :write_file do
+          if _file_changed? rendered_content, to, true
+            log.info "   writing: #{ _rel_path to }"
+            _ensure_path to
+            File.open to, 'w' do |f|
+              f.write rendered_content
+            end
+          else
+            log.info " unchanged: #{ _rel_path to }"
+          end
+        end
+      end
+    end
+
+    def _file_changed?(from, to, from_is_text=false)
+      return true if @options[:force]
+      return true if !File.exists? to
+      if @use_checksum
+        digest= from_is_text ? _checksum_for(from) : _checksum_for_file(from)
+        digest_to = _checksum_for_file to #@checksums[_rel_path to]
+        # puts "CHECKSUM #{digest_to} == #{digest} #{digest_to == digest}"
+        digest_to != digest
+      else
+        return true if from_is_text
+        !FileUtils.identical? from, to
+      end
+    end
+
+    def _ensure_path(to)
+      FileUtils.mkdir_p File.dirname(to)
+    end
+
+    def _checksum_for(string)
+      Digest::MD5.hexdigest( string )
+    end
+
+    def _checksum_for_file(path)
+      _checksum_for File.read( path )
+    end
+
+    def _rel_path(path)
+      path.gsub( site.output_path, '' )[1..-1]
+    end
+
+    def _exception_message(ex, short=false)
+      class_name= ex.class.to_s
+      backtrace= short ? ex.backtrace[0] : ex.backtrace
+      "{Exception: #{class_name}}\n#{[ex.to_s, backtrace].flatten.join("\n")}"
+    end
+
+  end
+
+  class << self
+    
+    def build(opts={})
+      opts= opts.to_symbolized_hash
+      site.scan
+      Builder.new(opts).execute
+    end
+
+    def rebuild
+      site.scan true
+      Builder.new.execute
+    end
+
+    # Kicks off the build process!
+    def run(opts={})
+      opts= opts.to_symbolized_hash
+      site.options= opts
+      Gumdrop.build opts
+    end
+
+
+  end
+
+end

data/lib/gumdrop/cli/external.rb

@@ -10,7 +10,7 @@ module Gumdrop::CLI
     end
 
     desc 'new [NAME]', 'Create new gumdrop project'
-    method_option :template, aliases:'-t', desc:'Template to start from', required:true
+    method_option :template, aliases:'-t', desc:'Template to start from', required:true, default:'default'
     def new(name)
       template= options[:template] || 'default'
 
@@ -36,20 +36,25 @@ module Gumdrop::CLI
         say " - #{File.basename name}" if File.directory?(name)
       end
       say  "Local templates:"
-      Dir[ home_template_path t].each do |name|
+      Dir[ home_template_path ].each do |name|
         say " - #{File.basename name}" if File.directory?(name)
       end
     end
 
-    private
+    desc "version", "Displays Gumdrop version"
+    def version
+      say "Gumdrop v#{ Gumdrop::VERSION }"
+    end
 
-      def gem_template_path(template='*')
-        File.join(self.class.source_root, 'templates', template)
-      end
+  private
 
-      def home_template_path(template='*')
-        File.expand_path File.join( "~", ".gumdrop", 'templates', template)
-      end
+    def gem_template_path(template='*')
+      self.class.source_root / 'templates' / template
+    end
+
+    def home_template_path(template='*')
+      File.expand_path "~" / '.gumdrop' / 'templates' / template
+    end
 
   end
 end