brite 0.5 → 0.6.0

data/HISTORY.rdoc

@@ -0,0 +1,30 @@
+= RELEASE HISTORY
+
+== 0.6.0 / 2008-11-12
+
+Version 0.6 is a full rewrite of Brite's underlying site generation system.
+Where as before the Site and Page classes handled their own rendering, now
+they are simply information containers and the Controller class handles
+rendering. This has made for a much cleaner and more maintainable design.
+Overall functionality has remained the same.
+
+Changes:
+
+* Complete rewrite of the site generation system.
+* Sow templates modified to work with latest release.
+
+
+== 0.5.0 / 2008-10-25
+
+Brite (formerly Webrite) has been completely rewritten from the ground-up,
+applying a number of ideas gathered from other systems and adding further
+innovations. This is still an early release, and in need of features
+and overt tire-kicking, but hey I'm already using to generate a pretty
+damn nice looking site.
+
+Changes:
+
+* 1 Monumentously Important Enhancment
+
+    * Happy Rebirthday!
+

data/LICENSE

@@ -1,23 +1,205 @@
-The MIT License
+.
 
-Copyright (c) 2009 Thomas Sawyer
+                             Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
 
-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:
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+   1. Definitions.
 
-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.
+      "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 [yyyy] [name of copyright owner]
+
+   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.rdoc

@@ -0,0 +1,61 @@
+= Brite
+
+A Shiny Static Website Generator
+
+* home: http://proutils.github.com/brite
+* code: http://github.com/proutils/brite
+
+
+== DESCRIPTION
+
+Brite is an inovative static website/blog generation utility
+which is as easy to use as it is versitle.
+
+
+== FEATURES
+
+* Generates files in place (no special subdirectories required).
+* Utilizes multi-format templates via Neapolitan.
+* Supports many markup and templating formats.
+
+
+== SYNOPSIS
+
+To use Brite create .page, .post and .layout files and then
+run:
+
+  $ brite
+
+For details please see the Brite website and the GitHub repository. In
+particular have a look at the `site/` directory which contains Brites
+own website built on Brite.
+
+
+== HOW TO INSTALL
+
+=== RubyGems
+
+  $ sudo gem install brite
+
+=== Setup.rb
+
+If you're old fashion and want to install to a site
+location, see Setup.rb[http://rubyworks.github.com/setup].
+
+
+== COPYRIGHT/LICENSE
+
+Copyright (c) 2009 Thomas Sawyer
+
+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/Syckfile

@@ -0,0 +1,76 @@
+---
+email:
+  service : Email
+  file    : ~
+  subject : ~
+  mailto  :
+    - ruby-talk@ruby-lang.org
+    - proutils@googlegroups.com
+  parts   : ~
+  active  : true
+
+gemcutter:
+  active: true
+
+grancher:
+  active: true
+
+box:
+  service: Box
+  types  : [gem]
+  spec   : false
+  active : true
+
+dnote:
+  service  : DNote
+  loadpath : ~
+  labels   : ~
+  output   : ~
+  format   : ~
+  active   : true
+
+rdoc:
+  service : RDoc
+  template: redfish
+  exclude : [Syckfile]
+  output  : site/docs/api
+  active  : true
+
+ridoc:
+  service: RIDoc
+  include: ~
+  exclude: ~
+  output : ri
+  active : true
+
+stats:
+  service  : Stats
+  title    : ~
+  loadpath : ~
+  exclude  : ~
+  output   : ~
+  active   : true
+
+vclog:
+  service  : vclog
+  formats  : html,rdoc
+  layout   : history
+  typed    : true
+  output   : ~
+  active   : false
+
+testrb:
+  service  : TestUnit
+  tests    : ~
+  exclude  : ~
+  loadpath : ~
+  requires : ~
+  live     : false   
+  active   : false
+
+syntax:
+  service  : Syntax
+  loadpath : ~
+  exclude  : ~
+  active   : false
+

data/bin/brite

@@ -1,3 +1,3 @@
-#! /usr/bin/ruby
-require 'brite/command'
-Brite::Command.start
+#!/usr/bin/env ruby
+require 'brite'
+Brite.cli(*ARGV)

data/bin/brite-server

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'brite/server'
+Brite::Server.start
+

data/lib/brite.rb

@@ -0,0 +1,11 @@
+# Brite namespace.
+#
+#  "entia non sunt multiplicanda praeter necessitatem"
+#
+#                                          --Ockham's razor
+#
+module Brite; end
+                               
+require 'brite/meta/data'
+require 'brite/controller'
+require 'brite/command'

data/lib/brite/command.rb

@@ -1,83 +1,80 @@
-require 'brite/site'
+require 'optparse'
+require 'brite/controller'
 
 module Brite
 
-  # Webrite command line interface.
+  # Initialize and run Command.
+  def self.cli(*argv)
+    Command.new(*argv).call
+  end
 
+  # Webrite command line interface.
   class Command
 
-    def self.start
-      new.start
+    # New Command.
+    def initialize(*argv)
+      @output   = nil #@argv.shift
+      @url      = nil
+      @dryrun   = false
+      @trace    = false
+
+      parser.parse!(argv)
+
+      @location = argv.shift || '.'
     end
 
-    def initialize(argv=nil)
-      @argv ||= ARGV.dup
+    # Returns an OptionParser instance.
+    def parser
+      OptionParser.new do |opt|
+        opt.on("--url URL", "site URL") do |url|
+          @url = url
+        end
 
-      @noharm = @argv.delete('--dryrun') || @argv.delete('--noharm')
-      @debug  = @argv.delete('--debug')
+        opt.on("--trace", "show extra operational information") do
+          @trace = true
+        end
 
-      @argv.reject!{ |e| e =~ /^-/ }
+        opt.on("--dryrun", "-n", "don't actually write to disk") do
+          @dryrun = true
+        end
 
-      @location = @argv.shift || '.'
-      #@output = @argv.shift
+        opt.on("--force", "force overwrites") do
+          $FORCE = true
+        end
+
+        opt.on("--debug", "run in debug mode") do
+          $DEBUG   = true
+        end
+
+        opt.on("--warn", "show Ruby warnings") do
+          $VERBOSE = true
+        end
+
+        opt.on_tail("--help", "display this help message") do
+          puts opt
+          exit
+        end
+      end
     end
 
     #
-    def start
+    def call
       begin
-        site.build
+        controller.build
       rescue => e
-        @debug ? raise(e) : puts(e.message)
+        $DEBUG ? raise(e) : puts(e.message)
       end
     end
 
-    def site
-      Site.new(
+    def controller
+      Controller.new(
         :location => @location,
         :output   => @output,
-        :noharm   => @noharm,
+        :url      => @url,
+        :dryrun   => @dryrun,
         :trace    => @trace
       )
     end
-  end
-
-  #
-  # Command to generate a single part to standard out.
-  #
-
-  class PartCommand
-
-    def self.start
-      new.start
-    end
-
-    def initialize(argv=nil)
-      @argv ||= ARGV.dup
-    end
-
-    def start
-      render(parts)
-    end
-
-    # render a single part to stdout.
-
-    def render(parts)
-      $stdout << Page.new(parts).to_html
-    end
-
-  private
-
-    def parts
-      parts = []
-      @argv.each do |x|
-        if /^-/ =~ x
-          parts << [x.sub(/-{1,2}/,'')]
-        else
-          parts.last < x
-        end
-      end
-      Hash[*parts]
-    end
 
   end