brite 0.6.0 → 0.7.0

data/.ruby

@@ -0,0 +1,56 @@
+---
+source:
+- var
+authors:
+- name: trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2006'
+replacements: []
+alternatives: []
+requirements:
+- name: neapolitan
+  version: 0.4.0+
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: reap
+  groups:
+  - build
+  development: true
+- name: lemon
+  groups:
+  - test
+  development: true
+- name: ae
+  groups:
+  - test
+  development: true
+dependencies: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/brite.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/brite
+  code: http://github.com/rubyworks/brite
+  bugs: http://github.com/rubyworks/brite/issues
+  mail: http://groups.google.com/groups/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+summary: Super Simple Static Site Generation
+title: Brite
+version: 0.7.0
+name: brite
+description: ! 'Brite is an easy to use, light-weight website generator. It supports
+
+  a variety of backend rendering engines including erb, liquid, rdoc,
+
+  markdown, textile and so on.'
+organization: RubyWorks
+date: '2011-12-17'

data/COPYING.rdoc

@@ -0,0 +1,30 @@
+= COPYRIGHT NOTICES
+
+== Brite - Copyright (c) 2009 Rubyworks
+
+PROJECT:: Brite
+WEBSITE:: http://rubyworks.github.com/brite
+LICENSE:: BSD-2-Clause License
+
+    Copyright (c) 2009 Rubyworks
+
+    Redistribution and use in source and binary forms, with or without modification, are
+    permitted provided that the following conditions are met:
+
+       1. Redistributions of source code must retain the above copyright notice, this list of
+          conditions and the following disclaimer.
+
+       2. Redistributions in binary form must reproduce the above copyright notice, this list
+          of conditions and the following disclaimer in the documentation and/or other materials
+          provided with the distribution.
+
+    THIS SOFTWARE IS PROVIDED BY <COPYRIGHT HOLDER> ``AS IS'' AND ANY EXPRESS OR IMPLIED
+    WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+    FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> OR
+    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+    ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/HISTORY.rdoc

@@ -1,6 +1,20 @@
 = RELEASE HISTORY
 
-== 0.6.0 / 2008-11-12
+
+== 0.7.0 / 2011-12-15
+
+New release of Brite cleans up the code a great deal, adds templated route
+support via `route` field, and actually adds a few unit tests (wowzeres,
+that's a good thing, right?). 
+
+Changes:
+
+* Add route field for templated routes.
+* Fix use of config field defaults.
+* Add some initial unit tests.
+
+
+== 0.6.0 / 2010-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
@@ -14,7 +28,7 @@ Changes:
 * Sow templates modified to work with latest release.
 
 
-== 0.5.0 / 2008-10-25
+== 0.5.0 / 2010-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

data/README.rdoc

@@ -2,60 +2,68 @@
 
 A Shiny Static Website Generator
 
-* home: http://proutils.github.com/brite
-* code: http://github.com/proutils/brite
+{Homepage}[http://rubyworks.github.com/brite] /
+{Documentation}[http://rubydoc.info/gems/brite/frames] /
+{Report Issue}[http://github.com/rubyworks/brite/issues] /
+{Development}[http://github.com/rubyworks/brite] /
+{Mailing List}[http://groups.google.com/group/rubyworks-mailinglist]
+
+{<img src="http://travis-ci.org/rubyworks/brite.png" />}[http://travis-ci.org/rubyworks/brite]
 
 
 == DESCRIPTION
 
 Brite is an inovative static website/blog generation utility
-which is as easy to use as it is versitle.
+which is as easy to use as it is versatile.
 
 
 == FEATURES
 
-* Generates files in place (no special subdirectories required).
-* Utilizes multi-format templates via Neapolitan.
-* Supports many markup and templating formats.
+* Site layout is 100% user-defined.
+* Can generate files in place, so no "special directories" are required.
+* Alternatively templated routes can customize the site organization. 
+* Supports multi-format templates via Neapolitan template engine.
+* Supports many markup and templating formats via Malt or Tilt.
 
 
 == SYNOPSIS
 
-To use Brite create .page, .post and .layout files and then
-run:
+Very briefly, one creates `.page`, `.post`, .part and `.layout` files and 
+then runs:
 
   $ 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.
+Voila, website made!
+
+Of course, the question really is how does one go about creating `.page`,
+`.post`, `.part` and `.layout` files and such. For information about that see the
+{Brite website}[https://rubyworks.github.com/brite] and see the
+{Getting Started Tutorial}[https://github.com/rubyworks/brite/wiki/Getting-Started].
+
+For a quick start, have a look at the {brite-site repository}[https://github.com/rubyworks/brite-site]
+which contains a generic Brite project anyone can use to start their own Brite Site.
+
+To get further under the hood see Brite source code in the
+{GitHub hosted repository}[http://github.com/rubyworks/brite]
+and read the {API documentation}[http://rubydoc.info/gems/brite/frames].
 
 
 == HOW TO INSTALL
 
 === RubyGems
 
-  $ sudo gem install brite
+  $ 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
+If you're old fashion and want to install to a site location,
+see Setup.rb[http://rubyworks.github.com/setup].
 
-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
+== COPYRIGHTS
 
-   http://www.apache.org/licenses/LICENSE-2.0
+Copyright (c) 2009 Rubyworks
 
-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.
+Brite is distributable in accordance to the *BSD-2-Clause* license.
 
+See COPYING.rdoc file for details.

data/bin/brite-server

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

data/lib/brite.rb

@@ -6,6 +6,7 @@
 #
 module Brite; end
                                
-require 'brite/meta/data'
+require 'brite/version'
 require 'brite/controller'
 require 'brite/command'
+

data/lib/brite.yml

@@ -0,0 +1,56 @@
+---
+source:
+- var
+authors:
+- name: trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Rubyworks
+  year: '2006'
+replacements: []
+alternatives: []
+requirements:
+- name: neapolitan
+  version: 0.4.0+
+- name: detroit
+  groups:
+  - build
+  development: true
+- name: reap
+  groups:
+  - build
+  development: true
+- name: lemon
+  groups:
+  - test
+  development: true
+- name: ae
+  groups:
+  - test
+  development: true
+dependencies: []
+conflicts: []
+repositories:
+- uri: git://github.com/rubyworks/brite.git
+  scm: git
+  name: upstream
+resources:
+  home: http://rubyworks.github.com/brite
+  code: http://github.com/rubyworks/brite
+  bugs: http://github.com/rubyworks/brite/issues
+  mail: http://groups.google.com/groups/rubyworks-mailinglist
+extra: {}
+load_path:
+- lib
+revision: 0
+summary: Super Simple Static Site Generation
+title: Brite
+version: 0.7.0
+name: brite
+description: ! 'Brite is an easy to use, light-weight website generator. It supports
+
+  a variety of backend rendering engines including erb, liquid, rdoc,
+
+  markdown, textile and so on.'
+organization: RubyWorks
+date: '2011-12-17'

data/lib/brite/command.rb

@@ -5,78 +5,123 @@ module Brite
 
   # Initialize and run Command.
   def self.cli(*argv)
-    Command.new(*argv).call
+    Command.call(*argv)
   end
 
-  # Webrite command line interface.
-  class Command
+  # Brite command module.
+  module Command
+    extend self
 
-    # New Command.
-    def initialize(*argv)
-      @output   = nil #@argv.shift
-      @url      = nil
-      @dryrun   = false
-      @trace    = false
+    # Execute command.
+    #
+    # @public
+    def call(*argv)
+      options = parse(argv)
+
+      begin
+        controller(options).build
+      rescue => e
+        $DEBUG ? raise(e) : puts(e.message)
+      end
+    end
+
+    # Create an instance of Brite::Controller given controller options.
+    #
+    # @private
+    #
+    # @return [Controller] New controller instance.
+    def controller(options)
+      Controller.new(options)
+    end
+
+    # Parse controller options from command line arguments.
+    #
+    # @private
+    #
+    # @return [Hash] controller options
+    def parse(argv)
+      parser = OptionParser.new
+
+      options = {
+        :output => nil,
+        :url    => nil
+      }
+
+      options_url     parser, options
+      options_general parser, options
+      options_help    parser, options
 
       parser.parse!(argv)
 
-      @location = argv.shift || '.'
+      options[:location] = argv.shift || '.'
+
+      options
     end
 
-    # Returns an OptionParser instance.
-    def parser
-      OptionParser.new do |opt|
-        opt.on("--url URL", "site URL") do |url|
-          @url = url
-        end
-
-        opt.on("--trace", "show extra operational information") do
-          @trace = true
-        end
-
-        opt.on("--dryrun", "-n", "don't actually write to disk") do
-          @dryrun = true
-        end
-
-        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
+    # Add `--url` option to command line parser.
+    #
+    # @param [OptionParser] parser
+    #   An instance of option parser.
+    #
+    # @param [Hash] options
+    #   An options hash to be passed to Controller.
+    #
+    # @private
+    def options_url(parser, options)
+      parser.on("--url URL", "website fully qualified URL") do |url|
+        options[:url] = url
       end
     end
 
+    # Add `--trace`, `--dryrun`, `--force`, `--debug` and `--warn` options
+    # to command line interface. These are all "global" options which means
+    # they set global variables if used.
     #
-    def call
-      begin
-        controller.build
-      rescue => e
-        $DEBUG ? raise(e) : puts(e.message)
+    # @param [OptionParser] parser
+    #   An instance of option parser.
+    #
+    # @param [Hash] options
+    #   An options hash to be passed to Controller.
+    #
+    # @private
+    def options_general(parser, options)
+      parser.on("--trace", "show extra operational information") do
+        $TRACE = true
+      end
+
+      parser.on("--dryrun", "-n", "don't actually write to disk") do
+        $DRYRUN = true
+      end
+
+      parser.on("--force", "force overwrites") do
+        $FORCE = true
+      end
+
+      parser.on("--debug", "run in debug mode") do
+        $DEBUG   = true
+      end
+
+      parser.on("--warn", "show Ruby warnings") do
+        $VERBOSE = true
       end
     end
 
-    def controller
-      Controller.new(
-        :location => @location,
-        :output   => @output,
-        :url      => @url,
-        :dryrun   => @dryrun,
-        :trace    => @trace
-      )
+    # Add `--help` option to command line parser.
+    #
+    # @param [OptionParser] parser
+    #   An instance of option parser.
+    #
+    # @param [Hash] options
+    #   An options hash to be passed to Controller.
+    #
+    # @private
+    def options_help(parser, options)
+      parser.on_tail("--help", "display this help message") do
+        puts opt
+        exit
+      end
     end
 
   end
 
 end
-