RubyGems - bijou - Versions diffs - 0.1.0 - Mend

bijou 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (53) hide show

data/ChangeLog.txt +4 -0
data/LICENSE.txt +58 -0
data/README.txt +48 -0
data/Rakefile +105 -0
data/doc/INSTALL.rdoc +260 -0
data/doc/README.rdoc +314 -0
data/doc/releases/bijou-0.1.0.rdoc +60 -0
data/examples/birthday/birthday.rb +34 -0
data/examples/holiday/holiday.rb +61 -0
data/examples/holiday/letterhead.txt +4 -0
data/examples/holiday/signature.txt +9 -0
data/examples/phishing/letter.txt +29 -0
data/examples/phishing/letterhead.txt +4 -0
data/examples/phishing/phishing.rb +21 -0
data/examples/phishing/signature.txt +9 -0
data/examples/profile/profile.rb +46 -0
data/lib/bijou.rb +15 -0
data/lib/bijou/backend.rb +542 -0
data/lib/bijou/cgi/adapter.rb +201 -0
data/lib/bijou/cgi/handler.rb +5 -0
data/lib/bijou/cgi/request.rb +37 -0
data/lib/bijou/common.rb +12 -0
data/lib/bijou/component.rb +108 -0
data/lib/bijou/config.rb +60 -0
data/lib/bijou/console/adapter.rb +167 -0
data/lib/bijou/console/handler.rb +4 -0
data/lib/bijou/console/request.rb +26 -0
data/lib/bijou/context.rb +431 -0
data/lib/bijou/diagnostics.rb +87 -0
data/lib/bijou/errorformatter.rb +322 -0
data/lib/bijou/exception.rb +39 -0
data/lib/bijou/filters.rb +107 -0
data/lib/bijou/httprequest.rb +108 -0
data/lib/bijou/httpresponse.rb +268 -0
data/lib/bijou/lexer.rb +513 -0
data/lib/bijou/minicgi.rb +159 -0
data/lib/bijou/parser.rb +1026 -0
data/lib/bijou/processor.rb +404 -0
data/lib/bijou/prstringio.rb +400 -0
data/lib/bijou/webrick/adapter.rb +174 -0
data/lib/bijou/webrick/handler.rb +32 -0
data/lib/bijou/webrick/request.rb +45 -0
data/script/cgi.rb +25 -0
data/script/console.rb +7 -0
data/script/server.rb +7 -0
data/test/t1.cfg +5 -0
data/test/tc_config.rb +26 -0
data/test/tc_filter.rb +25 -0
data/test/tc_lexer.rb +120 -0
data/test/tc_response.rb +103 -0
data/test/tc_ruby.rb +62 -0
data/test/tc_stack.rb +50 -0
metadata +121 -0

data/lib/bijou/cgi/adapter.rb ADDED Viewed

@@ -0,0 +1,201 @@
+require 'cgi'
+require 'bijou/processor'
+require 'bijou/httpresponse'
+require 'bijou/cgi/request'
+module Bijou
+  #
+  # This module allows Bijou to run under CGI. It has only been tested under
+  # Apache.
+  #
+  module CGI
+    #
+    # This adapter encapsulates the differences between the CGI and the
+    # interfaces expected within the Bijou environment.
+    #
+    class Bijou::CGI::Adapter
+      def self.handle
+        t0 = Time.now
+        # Use binmode so CR\LF pairs aren't translated on Windows.
+        $stdout.binmode if defined? $stdout.binmode
+        #
+        # Initialize the configuration.
+        #
+        document_root = ENV['DOCUMENT_ROOT']
+        # The document root must be specified.
+        if !FileTest.directory?(document_root)
+          return self::error("The document root is invalid. " +
+                             "Please check the CGI configuration.")
+        end
+        path_info = ENV['PATH_INFO']
+        bijou_cache = ENV['BIJOU_CACHE']
+        bijou_config = ENV['BIJOU_CONFIG']
+        if bijou_config
+          begin
+            config = Bijou::Config.load_file(bijou_config)
+          rescue SyntaxError
+            error = $!.to_s
+            error << "\nStack: " + $@.join("\n")
+            return self::diagnostic("Error loading configuration.", error)
+          end
+          if (!config)
+            return self::error("The configuration file path is invalid. " +
+                               "Please check the CGI configuration.")
+          end
+        else
+          config = Bijou::Config.new
+        end
+        # The CGI value is always used for the document root because the
+        # server may have expectations about it.
+        config.document_root = document_root
+        # The config file overrides the CGI cache root value
+        if !config.cache_root && bijou_cache
+          config.cache_root = bijou_cache
+        end
+        config.includes.each do |inc|
+          $:.push inc
+        end
+        #
+        # Load the requested page.
+        #
+        processor = Bijou::Processor.new
+        # Build the page from the request.
+        begin
+          context = processor.load(path_info, config)
+        rescue Exception
+          msg = Bijou::ErrorFormatter.format_error :html, 4
+          return self.formatted_error("Error loading page", msg)
+        end
+        #
+        # Prepare the request data.
+        #
+        context.request = Bijou::CGI::Request.new(true)
+        context.response = HttpResponse.new
+        args = {}
+        args.replace(context.request.params);
+        #
+        # Handle the request.
+        #
+        begin
+          context.render(args)
+        rescue EndRequest
+          # Normal end request; possibly a redirect.
+        rescue Exception
+          msg = Bijou::ErrorFormatter.format_error :html, 4, context
+          return self.formatted_error("Error rendering page", msg)
+        end
+        #
+        # Return the response.
+        #
+        # print "Content-Type: text/html; charset=iso-8859-1\r\n\r\n"
+        print context.response.render_headers
+        if !context.response.suppress_content
+          puts context.output
+          if config.debug
+            t1 = Time.now
+            # self.print_request(context)
+            # self.print_environment
+            puts "<pre>" + "Time: #{t1 - t0}"
+            puts "Log:"
+            puts ::CGI.escapeHTML(context.get_log)
+            puts "Trace:"
+            puts ::CGI.escapeHTML(context.get_trace)
+            puts "</pre>"
+          end
+        end
+      end
+      def self.error(message)
+        print "Content-Type: text/html; charset=iso-8859-1\r\n\r\n"
+        puts '<html><h1>500 Internal server error</h1>' +
+          "<p>#{message}</p>" +
+          '</html>'
+        return nil
+      end
+      def self.diagnostic(message, diagnostic)
+        print "Content-Type: text/html; charset=iso-8859-1\r\n\r\n"
+        puts '<html><h1>500 Internal server error</h1>' +
+          "<h3>#{message}</h3>" +
+          "<pre>#{::CGI::escapeHTML(diagnostic)}</pre>" +
+          '</html>'
+        return nil
+      end
+      def self.formatted_error(title, message)
+        print "Content-Type: text/html; charset=iso-8859-1\r\n\r\n"
+        puts '<html>'
+        puts '<head><title>Bijou Error</title>'
+        puts '<style type="text/css">'
+        puts Bijou::ErrorFormatterHTML.style
+        puts '</style>'
+        puts '</head>'
+        puts '<body>'
+        puts "<h1>#{title}</h1>"
+        puts message
+        puts '</body>'
+        puts '</html>'
+        return nil
+      end
+      def self.print_environment()
+        #        print "Content-Type: text/html; charset=iso-8859-1\r\n\r\n"
+        #        print "Hello, world!"
+        #        puts $:
+        print "<pre>" +
+          ::CGI::escapeHTML(
+                            ENV.collect() do |key, value|
+                              key + " --> " + value + "\n"
+                            end.join("")
+                            ) +
+          "</pre>"
+      end
+      def self.print_request(context)
+        #        print "Content-Type: text/html; charset=iso-8859-1\r\n\r\n"
+        #        print "Hello, world!"
+        #        puts $:
+        cgi = context.request.cgi
+        print "<pre>" +
+          ::CGI::escapeHTML(
+                            "query: " + cgi.query_string.inspect + "\n" +
+                            "form: " + cgi.form.inspect + "\n" +
+                            "cookies: " + cgi.cookies.inspect + "\n" +
+                            "params: " + cgi.params.inspect + "\n"
+                            ) +
+          "</pre>"
+      end
+    end
+  end
+end

data/lib/bijou/cgi/handler.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require 'cgi'
+require 'bijou/cgi/adapter'
+Bijou::CGI::Adapter.handle

data/lib/bijou/cgi/request.rb ADDED Viewed

@@ -0,0 +1,37 @@
+require 'bijou/minicgi'
+require 'bijou/httprequest'
+module Bijou
+  module CGI
+    #
+    # The request object adapts the CGI environment to a standardized
+    # Bijou interface. The normal Ruby cgi class is not used in this
+    # case. The Bijou::MiniCGI class adapts some of the useful functionality
+    # provided by the normal cgi class for use from the request object.
+    #
+    class Request < Bijou::HttpRequest
+      #
+      # Set single to true to have request parameters with single values
+      # be converted from an array to a single value. Otherwise, all parameter
+      # values will be arrays.
+      #
+      def initialize(single=true)
+        super()
+        @cgi = Bijou::MiniCGI.new(single)
+        @params = @cgi.params
+        @query_string = @cgi.get
+        @form = @cgi.post
+        @cookies = @cgi.cookies
+        @server_variables = @cgi.server
+        @http_method = @cgi.method
+      end
+      attr_reader :cgi
+    end
+  end
+end

data/lib/bijou/common.rb ADDED Viewed

@@ -0,0 +1,12 @@
+#
+# Copyright (c) 2007-2008 Todd Lucas. All rights reserved.
+#
+# common.rb - Shared declarations
+#
+#
+# The Bijou module contains all related classes to help keep the global
+# namespace clean.
+#
+module Bijou
+end

data/lib/bijou/component.rb ADDED Viewed

@@ -0,0 +1,108 @@
+#
+# Copyright (c) 2007-2008 Todd Lucas. All rights reserved.
+#
+# component.rb - The base class of all Bijou runtime components.
+#
+require 'bijou/common'
+require 'bijou/filters'
+require 'bijou/context'
+module Bijou
+  #
+  # The Component class is used to represent Bijou pages, components, and
+  # containers. It is the default base class used during the code generation
+  # phase.
+  #
+  # A component may use the <tt>base</tt> directive to specify an alternative
+  # class. This can be done to provide helper functions to a page or to
+  # override certain methods, for example. Any custom base class should
+  # derive from Bijou::Component. The file implementing the class will also
+  # need to be part of the require_list array in Bijou::Config.
+  #
+  class Component
+    alias raw_puts puts
+    alias raw_print print
+    alias raw_printf printf
+    attr_reader :context
+    # If the <%! container %> directive is used, the derived class will
+    # return a physical path to the containing file.
+    def self.container
+      nil
+    end
+    # Used for meaningful stack frames in errors (to work around an eval
+    # shortcoming).
+    def self.source_filename
+      nil
+    end
+    # Used for meaningful stack frames in errors (to work around an eval
+    # shortcoming).
+    def self.cache_filename
+      nil
+    end
+    def initialize(context)
+      @context = context
+    end
+    # The backing method for the %init block.
+    def init(args)
+    end
+    # The backing method for the %fini block.
+    def fini
+    end
+    # A synonym for Context#sinvoke.
+    def sinvoke(name, args={})
+      @context.sinvoke(name, args)
+    end
+    # A synonym for Context#invoke.
+    def invoke(name, args={})
+      @context.invoke(name, args)
+    end
+    # Behaves similarly to IO#puts, except the output is rendered to the
+    # response stream.
+    def puts(*args)
+      @context.writeline(args.join("\n"))
+    end
+    # Behaves similarly to IO#print, except the output is rendered to the
+    # response stream.
+    def print(*args)
+      sep = ''
+      term = ''
+      if $,
+        sep = $,
+      end
+      if $\
+        term = $\
+      end
+      @context.write(args.join(sep) + term)
+    end
+    # Behaves similarly to IO#printf, except the output is rendered to the
+    # response stream.
+    def printf(format, *args)
+      @context.write(sprintf(format, *args))
+    end
+    # A synonym for Context#request.
+    def request
+      @context.request
+    end
+    # A synonym for Context#response.
+    def response
+      @context.response
+    end
+  end
+end

data/lib/bijou/config.rb ADDED Viewed

@@ -0,0 +1,60 @@
+#
+# Copyright (c) 2007-2008 Todd Lucas. All rights reserved.
+#
+# config.rb - Encapsulates the loaded configuration.
+#
+require 'bijou/common'
+module Bijou
+  class Log
+    None = 0
+    Error = 1
+    Warn = 2
+    Info = 3
+  end
+  class Config
+    def initialize
+      @file_path = nil
+      @document_root = nil
+      @cache_root = nil
+      @cache_ext = '.obj'
+      @includes = []
+      @component_base = nil
+      @require_list = nil
+      @cache = true
+      @debug = false
+      @trace_level = Bijou::Log::None
+      @trace_buffer = true
+    end
+    attr_accessor :file_path
+    attr_accessor :document_root
+    attr_accessor :cache_root
+    attr_accessor :cache_ext
+    attr_accessor :includes
+    attr_accessor :component_base
+    attr_accessor :require_list
+    attr_accessor :cache
+    attr_accessor :debug
+    attr_accessor :trace_level
+    attr_accessor :trace_buffer
+    def self.load_file(file_path)
+      if file_path && !file_path.empty?
+        f = File.open(file_path, "r")
+        cfg = new
+        cfg.instance_eval(f.read(), file_path)
+        cfg.file_path = file_path
+        return cfg
+      end
+      nil
+    end
+  end
+end

data/lib/bijou/console/adapter.rb ADDED Viewed

@@ -0,0 +1,167 @@
+require 'getoptlong'
+require 'bijou/processor'
+require 'bijou/httpresponse'
+require 'bijou/console/request'
+module Bijou
+  #
+  # This module allows Bijou to be invoked from the command-line using
+  # stdin and stdout.
+  #
+  module Console
+    #
+    # This adapter sets up an approximation of a web server environment,
+    # so that Bijou can be run from the command line. This permits simple
+    # testing and experimentation. It also allows for the use of certain
+    # debugging tools and techniques that would otherwise not be available.
+    #
+    class Bijou::Console::Adapter
+      def self.handle
+        opts = GetoptLong.new(
+          [ "--config" , "-c",            GetoptLong::OPTIONAL_ARGUMENT ],
+          [ "--query",   "-q",            GetoptLong::REQUIRED_ARGUMENT ],
+          [ "--help",    "-h", "-?",      GetoptLong::NO_ARGUMENT ]
+        )
+        debug = false
+        t0 = Time.now
+        document_root = ENV['DOCUMENT_ROOT']
+        path_info = ENV['PATH_INFO']
+        bijou_cache = ENV['BIJOU_CACHE']
+        bijou_config = ENV['BIJOU_CONFIG']
+        query_string = ''
+        # process the parsed options
+        opts.each do |opt, arg|
+          case opt
+          when '--config'
+            bijou_config = arg
+          when '--query'
+            query_string = arg
+          when '--help'
+            return usage()
+          end
+        end
+        if ARGV.length == 1
+          path_info = ARGV[0]
+        elsif !document_root
+          puts "Missing document argument (try --help)"
+          return 0
+        end
+        if bijou_config
+          begin
+            config = Bijou::Config.load_file(bijou_config)
+          rescue SyntaxError
+            error = $!.to_s
+            error << "\nStack: " + $@.join("\n")
+            return self::diagnostic("Error loading configuration.", error)
+          end
+          if (!config)
+            return self::error("The configuration file path is invalid.")
+          end
+        else
+          config = Bijou::Config.new
+        end
+        # The config file overrides the environment settings.
+        if !config.document_root || config.document_root.empty?
+          if document_root
+            config.document_root = document_root
+          else
+            config.document_root = Dir.getwd
+          end
+        end
+        if !config.cache_root && bijou_cache
+          config.cache_root = bijou_cache
+        end
+        # The config file overrides the environment cache root value
+        if !config.cache_root && bijou_cache
+          config.cache_root = bijou_cache
+        end
+        # No need to defer trace render when outside of an HTTP environment.
+        config.trace_buffer = false
+        config.includes.each do |inc|
+          $:.push inc
+        end
+        processor = Bijou::Processor.new
+        # Build the page from the request.
+        begin
+          context = processor.load(path_info, config)
+        rescue Exception
+          msg = Bijou::ErrorFormatter.format_error :text, 4, context
+          return self::diagnostic("Error loading page", msg)
+        end
+        #
+        # Prepare the request data.
+        #
+        context.request = Bijou::Console::Request.new(query_string)
+        context.response = Bijou::HttpResponse.new
+        args = {}
+        args.replace(context.request.params);
+        # Render the result of executing the page.
+        begin
+          context.render(args)
+        rescue Exception
+          msg = Bijou::ErrorFormatter.format_error :text, 4, context
+          return self::diagnostic("Syntax error loading page", msg)
+        end
+        puts context.output;
+        t3 = Time.now
+        if debug
+          puts context.get_log
+          if config.trace_level > 0
+            # print_environment
+            puts context.get_trace
+          end
+        end
+      end
+      def self.error(message)
+        puts "error: #{message}"
+        return nil
+      end
+      def self.diagnostic(message, diagnostic)
+        puts "#{message}:\n#{diagnostic}"
+        return nil
+      end
+      def self.print_environment()
+        print ENV.collect() do |key, value|
+          key + " --> " + value + "\n"
+        end.join("")
+      end
+      def self.usage()
+        puts "Renders a Bijou console to stdout.\n\n"
+        puts "#{File.basename($0)} filename\n\n"
+        puts "  -h, --help         This help message"
+        puts "  -c, --config file  Specify a config file"
+        puts '  -q, --query args   Pass query string arguments (e.g, "a=1&b=2")'
+      end
+    end
+  end
+end