ichiban 0.0.2 → 1.0.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ichiban
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-04 00:00:00.000000000Z
+date: 2012-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &2157055820 !ruby/object:Gem::Requirement
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157055820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: erubis
-  requirement: &2157055400 !ruby/object:Gem::Requirement
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157055400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: maruku
-  requirement: &2157054980 !ruby/object:Gem::Requirement
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,72 +53,114 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2157054980
-description: The most elegant way to compile static websites
-email:
-- jarrettcolby@gmail.com
-executables:
-- ichiban.rb
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: lorax
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Static website compiler with advanced feature, including watcher script.
+email: jarrett@madebyhq.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- Gemfile
-- README
-- bin/ichiban.rb
-- ichiban.gemspec
-- klass.rb
-- lib/ichiban.rb
 - lib/ichiban/command.rb
-- lib/ichiban/compilation.rb
 - lib/ichiban/config.rb
-- lib/ichiban/erb_page.rb
-- lib/ichiban/files.rb
+- lib/ichiban/deleter.rb
+- lib/ichiban/dependencies.rb
+- lib/ichiban/file.rb
 - lib/ichiban/helpers.rb
-- lib/ichiban/layouts.rb
-- lib/ichiban/loading.rb
+- lib/ichiban/html_compiler.rb
 - lib/ichiban/logger.rb
-- lib/ichiban/mapping.rb
-- lib/ichiban/path.rb
-- lib/ichiban/script_runner.rb
-- lib/ichiban/tasks.rb
-- lib/ichiban/version.rb
+- lib/ichiban/markdown.rb
 - lib/ichiban/watcher.rb
-- sample/Rakefile
-- sample/compiled/about.html
-- sample/compiled/bad.html
-- sample/compiled/images/check.png
-- sample/compiled/index.html
-- sample/compiled/javascripts/interaction.js
-- sample/compiled/staff/_employee.html
-- sample/compiled/staff/andre-marques.html
-- sample/compiled/staff/index.html
-- sample/compiled/staff/jarrett-colby.html
-- sample/compiled/stylesheets/reset.css
-- sample/compiled/stylesheets/screen.css
-- sample/config.rb
-- sample/content/about.html
-- sample/content/bad.html
-- sample/content/index.html
-- sample/content/staff/_employee.html
-- sample/content/staff/index.html
-- sample/data/employees.csv
-- sample/errors/404.html
-- sample/helpers/staff_helper.rb
-- sample/images/check.png
-- sample/javascripts/interaction.js
-- sample/layouts/default.html
-- sample/models/employee.rb
-- sample/scripts/bad.rb
-- sample/scripts/staff.rb
-- sample/stylesheets/reset.css
-- sample/stylesheets/screen.scss
-- spec/integration_spec.rb
-- spec/path_spec.rb
-- spec/spec_helper.rb
-homepage: ''
+- lib/ichiban.rb
+homepage: https://github.com/jarrett/ichiban
 licenses: []
-post_install_message: 
+post_install_message: ! 'Ichiban was installed successfully.
+
+  Type `ichiban` for usage hints.
+
+
+  If you intend to use Markdown in your projects,
+
+  be sure to install one of these Markdown gems:
+
+  redcarpet
+
+  maruku
+
+  rdiscount
+
+
+  For more information:
+
+  https://github.com/jarrett/ichiban'
 rdoc_options: []
 require_paths:
 - lib
@@ -125,12 +177,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: ichiban
-rubygems_version: 1.8.11
+rubyforge_project: 
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Static website compiler
-test_files:
-- spec/integration_spec.rb
-- spec/path_spec.rb
-- spec/spec_helper.rb
+summary: Ichiban
+test_files: []

data/.gitignore

@@ -1,5 +0,0 @@
-pkg/*
-*.gem
-.bundle
-.sass-cache
-.sass-cache/**/*

data/Gemfile

@@ -1,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in ichiban.gemspec
-gemspec

data/README

@@ -1,56 +0,0 @@
-To use, create a folder for your project. Populate it with the appropriate folders. Create a Rakefile and add this:
-
-require 'ichiban'
-Ichiban::Tasks.new.define
-
-Overall design
-==============
-
-The Rakefile should have as little in it as possible.
-
-Each individual bit of functionality should be separate and self-sufficient, although they can all depend on a configured project.
-
-For each of the following:
-
-- Content file
-- Stylesheet
-- JS
-- Image
-
-...do each of these:
-
-- Compile/copy one
-- List all
-- List stale
-- Compile/copy all
-- Compile/copy stale
-
-Listing is done in files.rb. Compiling is done in compilation.rb.
-
-Further:
-
-- List all data files
-- Run scripts
-
-The compilation logger needs to be accessible from everywhere so that generators etc. can get to it.
-
-The watcher should delete files in the compiled directory when they're no longer needed. This can't be automatically determined for files based on scripts.
-
-The watcher should use the fork process described here:
-
-http://rkh.im/code-reloading
-
-Initially, the watcher forks. Both the parent and child process watch for changes, but they respond differently. The parent's only job is to kill the
-child and refork upon changes to models, scripts, and helpers. The child's job is to compile.
-
-Scripts should have an optional dependencies block:
-
-dependencies('data/employees.csv', 'data/stores.csv') do
-  # Generate calls go here
-end
-
-This will cause the block to run only when employees.csv or stores.csv has changed. Since there's no way to infer the output file paths,
-we need to simply keep track of when the script was last run. Then, if any of the dependencies have changed after that, we re-run the script.
-To track this, we'll store a JSON hash in scripts/.last_runs
-
-{'employees.rb': 1316041807}

data/bin/ichiban.rb

@@ -1,6 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-require 'ichiban'
-
-Ichiban::Command.new(ARGV).run

data/ichiban.gemspec

@@ -1,25 +0,0 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "ichiban/version"
-
-Gem::Specification.new do |s|
-  s.name        = "ichiban"
-  s.version     = Ichiban::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Jarrett Colby"]
-  s.email       = ["jarrettcolby@gmail.com"]
-  s.homepage    = ""
-  s.summary     = %q{Static website compiler}
-  s.description = %q{The most elegant way to compile static websites}
-
-  s.rubyforge_project = "ichiban"
-  
-  s.add_dependency 'activesupport'
-  s.add_dependency 'erubis'
-  s.add_dependency 'maruku'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
-end

data/klass.rb

@@ -1,7 +0,0 @@
-
-    class Foo
-      def bar
-        puts 'bar'
-      end
-    end
-  

data/lib/ichiban/compilation.rb

@@ -1,93 +0,0 @@
-module Ichiban
-  class Compiler
-    include Layouts
-    
-    # This should not be called from the watcher. The watcher should have a more fine-grained way of looking at changed files.
-    def compile
-      load_all_ruby_files
-      compile_stale
-      run_scripts
-    end
-    
-    # Includes, content, images, etc
-    def compile_all
-      content_files.each { |path| compile_content_file(path) }
-      javascripts.each { |path| copy_javascript(path) }
-      images.each { |path| copy_image(path) }
-      stylesheets.each { |path| copy_or_compile_stylesheet(path) }
-    end
-    
-    def compile_content_file(src_path)
-      dest_path = content_dest(src_path)
-      FileUtils.mkdir_p File.dirname(dest_path.abs)
-      File.open(dest_path.replace_ext('html').abs, 'w') do |f|
-        begin
-          f.write(compile_content_file_to_string(src_path))
-        rescue Exception => exc
-          Ichiban.logger.exception(exc)
-        end
-      end
-    end
-    
-    def compile_content_file_to_string(src_path)
-      erb_context = ErbPage::Context.new(:_current_path => content_dest(src_path).web)
-      result = ErbPage.new(File.read(src_path.abs), :filename => src_path.abs).evaluate(erb_context)
-      result = case src_path.ext
-      when 'markdown'
-        Maruku.new(result).to_html
-      when 'html'
-        result
-      else
-        raise "compile_file_to_string doesn't know how to handle #{src_path.abs}"
-      end
-      wrap_in_layouts(erb_context, result)
-    end
-    
-    # Includes, content, images, etc
-    def compile_stale
-      stale_content_files.each { |path| compile_content_file(path) }
-      stale_javascripts.each { |path| copy_js(path) }
-      stale_images.each { |path| copy_image(path) }
-      stale_stylesheets.each { |path| copy_or_compile_stylesheet(path) }
-    end
-    
-    def copy_image(path)
-      dest = image_dest(path)
-      FileUtils.mkdir_p(dest.dirname)
-      FileUtils.cp(path.abs, dest.abs)
-    end
-    
-    def copy_javascript(path)
-      dest = javascript_dest(path)
-      FileUtils.mkdir_p(dest.dirname)
-      FileUtils.cp(path.abs, dest.abs)
-    end
-    
-    def copy_or_compile_stylesheet(path)
-      dest = stylesheet_dest(path)
-      case path.ext
-      when 'css'
-        FileUtils.mkdir_p(dest.dirname)
-        FileUtils.cp(path.abs, dest.abs)
-      when 'scss', 'sass'
-        Sass.compile_file(path.abs, dest.abs, :style => :compressed)
-      end
-    end
-    
-    def fresh
-      load_all_ruby_files
-      compile_all
-      run_scripts
-    end
-    
-    def run_scripts
-      scripts.each do |path|
-        begin
-          ScriptRunner.run_script_file(path)
-        rescue Exception => exc
-          Ichiban.logger.exception(exc)
-        end
-      end
-    end
-  end
-end

data/lib/ichiban/erb_page.rb

@@ -1,16 +0,0 @@
-module Ichiban
-  class ErbPage < Erubis::Eruby
-    def add_preamble(src)
-      src << "@_erb_out = _buf = '';"
-    end
-    
-    class Context < Erubis::Context
-      include ::Ichiban::Helpers
-      include ::Erubis::XmlHelper
-      
-      def layout_stack
-        @_layout_stack or ['default']
-      end
-    end
-  end
-end

data/lib/ichiban/files.rb

@@ -1,105 +0,0 @@
-=begin
-- Content file
-- Stylesheet
-- JS
-- Image
-
-...do each of these:
-
-- Compile/copy one
-- List all
-- List stale
-- Compile/copy all
-- Compile/copy stale
-=end
-
-module Ichiban
-  class Compiler    
-    def content_files
-      paths_in('content').reject { |path| path.directory? }
-    end
-    
-    def data_files
-      paths_in 'data'
-    end
-    
-    def helpers
-      paths_in 'helpers', 'rb'
-    end
-    
-    def images
-      paths_in 'images'
-    end
-    
-    def models
-      paths_in 'models', 'rb'
-    end
-    
-    # Returns all stylesheet except for those beginning with an underscore
-    def stylesheets
-      paths_in('stylesheets').reject { |path| path.filename.start_with?('_') }
-    end
-    
-    def javascripts
-      paths_in 'javascripts', 'js'
-    end
-    
-    def scripts
-      paths_in 'scripts', 'rb'
-    end
-    
-    # For the stale methods, we rely on the source-destination mapping as provided by mapping.rb.
-    
-    def stale_content_files
-      stale(content_files) do |src_path|
-        content_dest(src_path)
-      end
-    end
-    
-    def stale_images
-      stale(images) do |src_path|
-        image_dest(src_path)
-      end
-    end
-    
-    def stale_stylesheets
-      stale(stylesheets) do |src_path|
-        stylesheet_dest(src_path)
-      end
-    end
-    
-    def stale_javascripts
-      stale(javascripts) do |src_path|
-        javascript_dest(src_path)
-      end
-    end
-    
-    private
-    
-    def paths_in(dir, ext = nil)
-      pattern = ext ? "**/*.#{ext}" : '**/*'
-      Dir.glob(File.join(Ichiban.project_root, dir, pattern)).collect { |abs| Path.new abs }
-    end
-    
-    # This method accepts a block. The block will be passed a source file path and must return either a destination path or an array thereof.
-    def stale(source_paths)
-      source_paths.reject do |path|
-        dest = yield(path)
-        dest = [dest] unless dest.is_a?(Array)
-        up_to_date?(path, *dest)
-      end
-    end
-    
-    # Accepts one source file and one or more destination files. Pass in Path objects.
-    # Note that this method is different from the one in FileUtils: The FileUtils version accepts
-    # one destination and multiple sources.
-    def up_to_date?(src, *dests)
-      src_time = File.mtime(src.abs)
-      dests.each do |dest|
-        return false if !File.exists?(dest.abs)
-        return false unless File.mtime(dest.abs) > src_time
-      end
-      true
-    end
-  end
-end

data/lib/ichiban/layouts.rb

@@ -1,10 +0,0 @@
-module Ichiban
-  module Layouts
-    def wrap_in_layouts(erb_context, html)
-      erb_context.layout_stack.reverse.inject(html) do |html, layout_name|
-        layout_path = Path.new(File.join(Ichiban.project_root, 'layouts', layout_name + '.html'))
-        ErbPage.new(File.read(layout_path.abs), :filename => layout_path.abs).evaluate(erb_context) { html }
-      end
-    end
-  end
-end

data/lib/ichiban/loading.rb

@@ -1,19 +0,0 @@
-module Ichiban
-  class Compiler
-    def load_all_ruby_files
-      models.each { |path| load path.abs }
-      helpers.each { |path| load_helper path }
-    end
-    
-    def load_helper(path)
-      load path.abs
-      mod_name = path.filename_without_ext.classify
-      begin
-        mod = Object.const_get(mod_name)
-      rescue NameError
-        raise "Expected #{path.abs} to define module #{classname}"
-      end
-      ErbPage::Context.send(:include, mod)
-    end
-  end
-end

data/lib/ichiban/mapping.rb

@@ -1,38 +0,0 @@
-module Ichiban
-  class Compiler
-    def content_dest(src_path)
-      if src_path.ext == 'markdown'
-        src_path = src_path.replace_ext('html')
-      end
-      Path.new(
-        File.join(Ichiban.project_root, 'compiled',
-          src_path.relative_from('content')
-        )
-      )
-    end
-    
-    def image_dest(src_path)
-      Path.new(
-        File.join(Ichiban.project_root, 'compiled', 'images',
-          src_path.relative_from('images')
-        )
-      )
-    end
-    
-    def javascript_dest(src_path)
-      Path.new(
-        File.join(Ichiban.project_root, 'compiled', 'javascripts',
-          src_path.relative_from('javascripts')
-        )
-      )
-    end
-    
-    def stylesheet_dest(src_path)
-      Path.new(
-        File.join(Ichiban.project_root, 'compiled', 'stylesheets',
-          src_path.relative_from('stylesheets')
-        )
-      ).replace_ext('css')
-    end
-  end
-end

data/lib/ichiban/path.rb

@@ -1,55 +0,0 @@
-# A Path object is a wrapper around an absolute path.
-
-class Path
-  attr_reader :abs
-  
-  def directory?
-    File.directory?(abs)
-  end
-  
-  def dirname
-    File.dirname(abs)
-  end
-  
-  def ext
-    File.extname(abs).slice(1..-1)
-  end
-  
-  def filename
-    File.basename(abs)
-  end
-  
-  def filename_without_ext
-    File.basename(abs, File.extname(abs))
-  end
-  
-  def initialize(abs)
-    @abs = abs
-  end
-  
-  # Returns a string relative to the given folder
-  def relative_from(folder_in_project_root)
-    prefix = File.join(Ichiban.project_root, folder_in_project_root)
-    raise(ArgumentError, "#{abs} does not start with #{prefix}") unless abs.start_with?(prefix)
-    abs.slice(prefix.length..-1)
-  end
-  
-  def replace_ext(new_ext)
-    self.class.new(abs.sub(/\..+$/, '.' + new_ext))
-  end
-  
-  # Only meaningful for paths in the compiled directory. Returns a string representing the path from the web root.
-  # Assumes Ichiban's standard URL rewriting rules are in effect.
-  def web
-    web_path = relative_from('compiled')    
-    if web_path.end_with?('.html')
-      if web_path.end_with?('index.html')
-        web_path.slice(0..-11) # Slice index.html off the end
-      else
-        web_path.slice(0..-6) + '/' # Slice .html off the end and add the trailing slash
-      end
-    else
-      web_path
-    end
-  end
-end