doculab 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem "tilt"
+gem "RedCloth", :require => 'redcloth'
+
+group :development do
+  gem "rails", "3.0.0.rc"
+  gem 'jeweler'
+  gem "rspec-rails", ">= 2.0.0.beta"
+  gem 'cucumber'
+  gem 'cucumber-rails'
+  gem 'capybara'
+end

data/Gemfile.lock

@@ -0,0 +1,133 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.3)
+    abstract (1.0.0)
+    actionmailer (3.0.0.rc)
+      actionpack (= 3.0.0.rc)
+      mail (~> 2.2.5)
+    actionpack (3.0.0.rc)
+      activemodel (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.9)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.22)
+    activemodel (3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0.rc)
+      activemodel (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      arel (~> 0.4.0)
+      tzinfo (~> 0.3.22)
+    activeresource (3.0.0.rc)
+      activemodel (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+    activesupport (3.0.0.rc)
+    arel (0.4.0)
+      activesupport (>= 3.0.0.beta)
+    builder (2.1.2)
+    capybara (0.3.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.3)
+    cucumber (0.8.5)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.1.4)
+      json_pure (~> 1.4.3)
+      term-ansicolor (~> 1.0.4)
+    cucumber-rails (0.3.2)
+      cucumber (>= 0.8.0)
+    culerity (0.2.10)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    gemcutter (0.6.1)
+    gherkin (2.1.5)
+      trollop (~> 1.16.2)
+    git (1.2.5)
+    i18n (0.4.1)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    mail (2.2.5)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    nokogiri (1.4.3.1)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.9)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rails (3.0.0.rc)
+      actionmailer (= 3.0.0.rc)
+      actionpack (= 3.0.0.rc)
+      activerecord (= 3.0.0.rc)
+      activeresource (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      bundler (>= 1.0.0.rc.1)
+      railties (= 3.0.0.rc)
+    railties (3.0.0.rc)
+      actionpack (= 3.0.0.rc)
+      activesupport (= 3.0.0.rc)
+      rake (>= 0.8.3)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rspec (2.0.0.beta.19)
+      rspec-core (= 2.0.0.beta.19)
+      rspec-expectations (= 2.0.0.beta.19)
+      rspec-mocks (= 2.0.0.beta.19)
+    rspec-core (2.0.0.beta.19)
+    rspec-expectations (2.0.0.beta.19)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.19)
+    rspec-rails (2.0.0.beta.19)
+      rspec (= 2.0.0.beta.19)
+      webrat (>= 0.7.2.beta.1)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.0.27)
+      ffi (>= 0.6.1)
+      json_pure
+      rubyzip
+    term-ansicolor (1.0.5)
+    thor (0.14.0)
+    tilt (1.0.1)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    trollop (1.16.2)
+    tzinfo (0.3.22)
+    webrat (0.7.2.beta.1)
+      nokogiri (>= 1.2.0)
+      rack (>= 1.0)
+      rack-test (>= 0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  capybara
+  cucumber
+  cucumber-rails
+  jeweler
+  rails (= 3.0.0.rc)
+  rspec-rails (>= 2.0.0.beta)
+  tilt

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2010 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,3 @@
+= Doculab
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,74 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :development)
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+require 'cucumber/rake/task'
+
+require 'jeweler'
+
+# Specs #######################################################################
+Rspec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Doculab'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Cucumber ####################################################################
+namespace :cucumber do
+  Cucumber::Rake::Task.new(:ok, 'Run features that should pass') do |t|
+    t.fork = true # You may get faster startup if you set this to false
+    t.profile = 'default'
+  end
+
+  Cucumber::Rake::Task.new(:wip, 'Run features that are being worked on') do |t|
+    t.fork = true # You may get faster startup if you set this to false
+    t.profile = 'wip'
+  end
+
+  Cucumber::Rake::Task.new(:rerun, 'Record failing features and run only them if any exist') do |t|
+    t.fork = true # You may get faster startup if you set this to false
+    t.profile = 'rerun'
+  end
+
+  desc 'Run all features'
+  task :all => [:ok, :wip]
+end
+task :cucumber => 'cucumber:ok'
+task :features => :cucumber do
+  STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+end
+
+# Gem #########################################################################
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "doculab"
+  gem.summary = "A Rails Engine for creating a simple documentation site"
+  gem.description = "A Rails Engine for a simple file-based CMS, suitable for a documentation site.  Originally created to power the Chargify documentation at http://docs.chargify.com"
+  gem.email = "michael@webadvocate.com"
+  gem.homepage = "http://github.com/grasshopperlabs/doculab"
+  gem.authors = ["Michael Klett"]
+  gem.add_dependency "tilt"
+  gem.add_dependency "RedCloth"
+  gem.add_development_dependency "rails", ">= 3.0.0.rc"
+  gem.add_development_dependency "rspec-rails", ">= 2.0.0.beta"
+  gem.add_development_dependency 'jeweler'
+  gem.add_development_dependency 'cucumber'
+  gem.add_development_dependency 'cucumber-rails'
+  gem.add_development_dependency 'capybara'
+  # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+end
+Jeweler::GemcutterTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/controllers/doculab/docs_controller.rb

@@ -0,0 +1,50 @@
+module Doculab
+  class DocsController < ApplicationController
+    rescue_from Doc::FileNotFound, :with => :handle_file_not_found
+    layout :select_layout
+    helper TableOfContentsHelper
+    caches_page :index, :show
+  
+    def index
+      find('index')
+      render :text => @doc.render, :layout => true
+    end
+  
+    def show
+      find(params[:permalink])
+      render :text => @doc.render, :layout => true
+    end
+  
+    protected
+      def find(permalink)
+        @doc = Doc.find(permalink)
+        @page = lookup_page(permalink)
+      end
+      
+      def handle_file_not_found(e)
+        @doc = Doc.new(:title => "File Not Found", :content => e.message)
+        @page = TableOfContents::Page.new("File Not Found")
+        render :text => e.message, :layout => true
+      end
+      
+      def lookup_page(permalink)
+        if permalink == 'index'
+          TableOfContents::Page.new(Doculab.title)
+        elsif page = TableOfContents.lookup(permalink)
+          page
+        else
+          TableOfContents::Page.new(permalink.titleize)
+        end
+      end
+      
+      def select_layout
+        case params[:permalink]
+        when 'index', NilClass
+          Doculab.index_layout
+        else
+          Doculab.main_layout
+        end
+      end
+    # end protected
+  end
+end

data/app/helpers/doculab/docs_helper.rb

@@ -0,0 +1,15 @@
+module Doculab
+  module DocsHelper
+    def doc_content
+      content_for?(:doc_content) ? yield(:doc_content) : yield
+    end
+    
+    def doc
+      @doc
+    end
+  
+    def sections
+      Doculab::TableOfContents.sections
+    end
+  end
+end

data/app/helpers/doculab/table_of_contents_helper.rb

@@ -0,0 +1,34 @@
+module Doculab
+  module TableOfContentsHelper
+    def page_title
+      parts = []
+      
+      if @page
+        parts << @page.title
+      end
+      
+      parts << "Chargify Documentation"
+      
+      parts.join(" - ")
+    end
+    
+    
+    def toc_link(page)
+      if page.doc
+        link_to page.title, doculab_doc_path(page.permalink), :class => current_page?(page) ? 'current' : nil
+      else
+        page.title
+      end
+    end
+    
+    def page
+      @page
+    end
+    
+    private
+    
+      def current_page?(page)
+        page && (page == @page)
+      end
+  end
+end

data/app/models/doculab/doc.rb

@@ -0,0 +1,61 @@
+module Doculab
+  class Doc
+    cattr_reader :valid_attributes
+    @@valid_attributes = [:permalink, :file, :title, :content, :section]
+
+    cattr_writer :directory
+
+    attr_accessor *@@valid_attributes
+
+    def initialize(attributes = {})
+      attributes.assert_valid_keys(@@valid_attributes)
+      attributes.each do |field, value|
+        send("#{field}=", value)
+      end
+    end
+
+    def render
+      template = ::Tilt.new(file)
+      template.render(self)
+    end
+
+    def self.find(permalink)
+      file = file_for_permalink(permalink)
+
+      unless file && File.exist?(file)
+        raise FileNotFound, "No file found for '#{permalink}'"
+      end
+
+      content = File.read(file)
+      self.new(:permalink => permalink, :file => file, :content => content)
+    end
+
+    def self.directory
+      @@directory ||= Rails.root.join('doculab', 'docs')
+      Pathname.new(@@directory)
+    end
+
+    # Returns an array of filenames for all files in the docs directory
+    def self.filenames
+      filepaths.collect {|fn| File.basename(fn) }
+    end
+
+    def self.filepaths
+      Dir.glob(directory.join("*.{#{extensions.join(',')}}"))
+    end
+
+    class FileNotFound < StandardError; end
+
+    private
+
+      # Returns an array of available extensions
+      def self.extensions
+        %w(textile md)
+      end
+
+      def self.file_for_permalink(permalink)
+        filepaths.detect {|fn| File.basename(fn).split('.').first == permalink }
+      end
+
+  end
+end

data/app/models/doculab/table_of_contents.rb

@@ -0,0 +1,88 @@
+module Doculab
+  module TableOfContents
+    mattr_reader :sections
+    mattr_reader :pages
+
+    def self.define(&block)
+      @@sections = []
+      @@pages = []
+      self.instance_eval(&block)
+      return self
+    end
+
+    def self.section(title, &block)
+      section = Section.new(title)
+      @@sections << section
+      section.build(block)
+    end
+    
+    def self.add_page(page)
+      @@pages << page
+    end
+    
+    def self.lookup(permalink)
+      pages.detect { |p| p.permalink == permalink }
+    end
+    
+    class Section
+      attr_reader :title, :pages
+      
+      def initialize(title)
+        @title = title
+        @pages = []
+      end
+      
+      def build(block)
+        instance_eval(&block)
+      end
+      
+      def page(title, options = {})
+        add_page(Page.new(title, self, options))
+      end
+      
+      private
+      
+        def add_page(page)
+          @pages << page
+          TableOfContents.add_page(page)
+        end
+        
+    end
+    
+    class Page
+      attr_reader :parent, :title, :permalink, :doc
+      
+      def initialize(title, parent = nil, options = {})
+        @parent = parent
+        @title = title
+        @permalink = options[:permalink] || title.parameterize
+        @doc = begin
+          Doc.find(permalink)
+        rescue
+          nil
+        end
+      end
+      
+      def filename(extension = "textile")
+        Doc.directory.join("#{permalink}.#{extension}")
+      end
+      
+      def next_page
+        return nil if index.nil?
+        TableOfContents.pages[index+1]
+      end
+      
+      def previous_page
+        fetch_index = (index || 0)-1
+        return nil if fetch_index < 0
+        TableOfContents.pages[fetch_index]
+      end
+      
+      private
+      
+        def index
+          TableOfContents.pages.index(self)
+        end
+    end
+  end
+end

data/app/sweepers/doculab/cache_sweeper.rb

@@ -0,0 +1,17 @@
+module Doculab
+  class CacheSweeper
+
+    def self.sweep!
+      File.delete(*cached_file_list)
+    end
+  
+    private
+
+      def self.cached_file_list
+        list = Dir.glob(File.join(Rails.public_path, "**", "*.html"))
+        list.reject {|file| File.basename(file) =~ /^\d{3}.html$/ }
+      end
+    
+    # end private
+  end
+end

data/config/cucumber.yml

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  scope Doculab.route_base, :module => "doculab" do
+    match ':permalink' => 'docs#show', :as => "doculab_doc"
+    root :to => 'docs#index', :as => "doculab_root"
+  end
+end