docter 1.0.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+1.0.0 (6/3/2007)
+* First release of working code.

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2006-2007, Intalio Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README

@@ -0,0 +1 @@
+

data/lib/docter/collection.rb

@@ -0,0 +1,307 @@
+module Docter
+
+  class Collection
+
+    class ToCResource < Resource::Base
+
+      def initialize(collection, *args)
+        super(*args)
+        init_from *args
+        @collection = collection
+      end
+      
+      def page(path)
+        @collection.page(path)
+      end
+
+      def toc()
+        load
+        @toc
+      end
+
+      def title()
+        load
+        @title
+      end
+
+    protected
+
+      if defined?(::RedCloth)
+        def create_from_textile(text, options)
+          html = RedCloth.new(erb_this(text, binding), [:no_span_caps]).to_html(:textile)
+          create_from_html html, options
+        end
+
+        def create_from_markup(text, options)
+          html = RedCloth.new(erb_this(text, binding), [:no_span_caps]).to_html(:markup)
+          create_from_html html, options
+        end
+      else
+        def create_from_textile(text, options)
+          fail "You need to install RedCloth first:\n  gem install RedCloth"
+        end
+        alias :create_from_markup :create_from_textile
+      end
+
+      def create_from_html(html, options)
+        @toc = ToC.new.tap do |toc|
+          html.scan(regexp_element("ol")).each do |tag, attrs, list|
+            list.scan(regexp_element("li")).each do |tag, attrs, item|
+              if item[regexp_element("a")]
+                attrs, title = $2, $3
+                url = $3 if attrs =~ regexp_attribute("href")
+                if page = page(url)
+                  toc.add page.toc_entry 
+                else
+                  toc.add url, inner_text_from(title)
+                end
+              else
+                url, title = "#", inner_text_from(item)
+                if page = page(item.strip.gsub(/\s+/, " ").downcase + ".html")
+                  toc.add page.toc_entry 
+                else
+                  toc.add url, inner_text_from(title)
+                end
+              end
+            end
+          end
+          @title = inner_text_from($3) if html =~ regexp_element("h1")
+        end
+      end
+
+    end
+
+
+    include HTML
+
+    def initialize(title = nil)
+      @title = title
+      @sources = FileList[]
+    end
+
+    # The collection title (HTML encoded).
+    def title()
+      @title || if @toc_resource
+        @toc_resource.reload if @toc_resource.modified?
+        @toc_resource.title
+      end || ""
+    end
+
+    # :call-seq:
+    #   toc() => ToC
+    #
+    # Returns the collection's ToC.
+    def toc()
+      if @toc_resource
+        @toc_resource.reload if @toc_resource.modified?
+        @toc_resource.toc
+      else
+        @toc ||= pages.inject(ToC.new) { |toc, page| toc.add page.toc_entry ; toc }
+      end
+    end
+
+    # :call-seq:
+    #   using(toc) => self
+    #
+    # Specifies the ToC to use. You can load an exiting ToC object, or specify a filename
+    # containing the ToC.
+    def using(toc)
+      self.toc = toc
+      self
+    end
+
+    # :call-seq:
+    #   toc = toc|filename|nil
+    #
+    # Sets the ToC. You can provide an existing ToC, provide a ToC file name, or nil to create
+    # the default ToC from all pages in this collection.
+    def toc=(toc)
+      case toc
+      when String
+        @toc_resource = ToCResource.new(self, toc)
+      when ToCResource
+        @toc_resource = toc
+      when ToC, nil
+        @toc = toc
+      end
+    end
+
+    # :call-seq:
+    #   include(*paths) => self
+    #
+    # Adds files and directories to the collection.
+    def include(*paths)
+      @sources.include *paths.flatten
+      self
+    end
+
+    alias :add :include
+
+    # :call-seq:
+    #   exclude(*paths) => self
+    #
+    # Excludes files or directories from the collection.
+    def exclude(*paths)
+      @sources.exclude *paths.flatten
+      self
+    end
+
+    # :call-seq:
+    #   page(path) => Page
+    #
+    # Returns a page based on its path.
+    #
+    # For example:
+    #   collection.include("doc/pages")
+    #   collection.page("index.html")
+    # Will return a page generated from "doc/pages/index.textile".
+    def page(path)
+      pages.find { |page| page.path == path }
+    end
+
+    # :call-seq:
+    #   pages() => Pages
+    #
+    # Returns all the pages in this collection/
+    def pages()
+      @pages = @sources.map { |path| File.directory?(path) ? FileList[File.join(path, "**/*")] : path }.flatten.
+        inject(@pages || {}) { |pages, file| pages[file] ||= Page.new(file, :collection=>self) ; pages }
+      @pages.values
+    end
+
+    def prev(page)
+      pages = toc.map { |entry| page(entry.url) }.compact
+      index = pages.index(page)
+      pages[index - 1] if index > 0
+    end
+
+    def next(page)
+      pages = toc.map { |entry| page(entry.url) }.compact
+      pages[pages.index(page) + 1]
+    end
+
+    # :call-seq:
+    #   file(path) => filename
+    #
+    # Returns the full path based on the relative path. For example:
+    #   collection.include("pages", "LICENSE")
+    #   collection.find("index.textile") => "pages/index.textile"
+    #   collection.find("LICENSE") => "LICENSE"
+    def file(path)      
+      @sources.inject(nil) do |found, file|
+        break found if found
+        if File.directory?(file)
+          base = file + "/"
+          FileList[File.join(file, "**/*")].find { |file| file.sub(base, "") == path }
+        else
+          file if File.basename(file) == path
+        end
+      end
+    end
+
+    # :call-seq:
+    #   render(template, page, options?) => html
+    #   render(template, options?) => html
+    #
+    # Render page or collection using the template.
+    #
+    # The first form attempts to reload the page if modified and passes the page to the template
+    # context, returning a single HTML document generated from that page.
+    #
+    # The second form attempts to reload all modified pages from the ToC, and passes all these
+    # pages to the template context, returning a single HTML document generates from pages as
+    # ordered by the ToC.
+    def render(template, *args)
+      options = Hash === args.last ? args.pop : {}
+      template = Template.new(template) unless Template === template
+      template.reload if template.modified?
+      if page = args.shift
+        page.reload if page.modified?
+        template.render options.merge(:collection=>self, :page=>page, :one_page=>false)
+      else
+        pages = toc.map { |entry| page(entry.url) }.compact
+        pages.each { |page| page.reload if page.modified? }
+        html = template.render(options.merge(:collection=>self, :pages=>pages, :one_page=>true))
+
+        url_map = pages.inject({}) { |map, page| map[page.path] = "##{page.id}" ; map }
+        html.gsub(regexp_element("a")) do |link|
+          link.gsub(regexp_attribute("href")) do |href|
+            url = $3
+            url = url_map[url] || url.gsub(/^(.*?)#(.*?)$/) { |path| url_map[$1] ? "##{$2}" : path }
+            %{href="#{url}"}
+          end
+        end
+      end
+    end
+
+    # :call-seq:
+    #   generate(template, to_dir, :all?)
+    #   generate(template, to_dir, pages)
+    #   generate(template, to_dir, page)
+    #   generate(template, to_dir, :one_page)
+    #
+    # The first form generates all pages from the ToC into the destination directory. The :all argument
+    # is optional. In addition, it copies all other resource files to the destination directory.
+    #
+    # The second form works the same way but only for the specified pages, and the third form for
+    # a single page. Neither copies any resource files.
+    #
+    # The fourth form generates a single HTML document in the destination directory (index.html) with
+    # all pages from the ToC, and copies all resource files to the destination directory. It will
+    # typically use a different template than the first three forms.
+    def generate(template, to_dir, *args)
+      options = Hash === args.last ? args.pop : {}
+      if args.empty? || args.first == :all
+        generate template, to_dir, pages, options
+        template.copy_resources to_dir
+      elsif args.first == :one_page
+        mkpath to_dir
+        File.join(to_dir, "index.html").tap do |filename|
+          puts "Generating #{filename}" if verbose
+          html = render(template, options)
+          File.open(filename, "w") { |file| file.write html }
+        end
+        template.copy_resources to_dir
+      else
+        mkpath to_dir
+        args.flatten.each do |page|
+          File.join(to_dir, page.path).tap do |filename|
+            puts "Generating #{filename}" if verbose
+            html = render(template, page, options)
+            File.open(filename, "w") { |file| file.write html }
+          end
+        end
+      end
+    end
+
+    # :call-seq:
+    #
+    # Returns a list of dependencies (resource files, the template file, etc). Useful when creating
+    # a Rake task based on this template.
+    def dependencies() #:nodoc:
+      files = @sources.map { |path| File.directory?(path) ? FileList[path, File.join(path, "**/*")] : path }.flatten +
+        (@toc_resource ? [@toc_resource.filename] : [])
+    end
+
+  end
+
+
+  class << self
+
+    # :call-seq:
+    #   collection(title?) => Collection
+    #
+    # Creates and returns a new collection. The collection initially does not include any files.
+    # When created from a ToC file, the collection bases its ToC on that file, otherwise it creates
+    # a ToC form all pages included in the collection.
+    def collection(title = nil)
+      Collection.new(title)
+    end
+
+    def toc(*args)
+      Collection::ToCResource.new(*args)
+    end
+
+  end
+
+end