gopher2000 0.3.0 → 0.4.0

data/examples/figlet.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+#
+# Simple gopher example
+#
+
+require 'gopher2000'
+
+set :host, '0.0.0.0'
+set :port, 7070
+
+route '/figlet' do
+  render :figlet
+end
+
+#
+# special text output rendering
+#
+text :figlet do
+  @text = "Hello!"
+
+  # nicely wrapped text
+  figlet @text
+
+  # spacing
+  br(2)
+end

data/gopher2000.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "watchr"
   s.add_development_dependency "eventmachine"
 
+  s.add_runtime_dependency "artii", ">= 2.0.1"
   s.add_runtime_dependency "eventmachine"
   s.add_runtime_dependency "logging"
 end

data/lib/gopher2000/base.rb

@@ -91,9 +91,9 @@ module Gopher
     #
     # mount a directory for browsing via gopher
     #
-    # @param [Hash] A hash specifying the path your route will answer to, and the filesystem path to use '/route' => '/home/path/etc'
-    #
-    # @param [Hash] a hash of options for the mount. Primarily this is a filter, which will restrict the list files outputted. example: :filter => '*.jpg'
+    # @param [Hash] path A hash specifying the path your route will answer to, and the filesystem path to use '/route' => '/home/path/etc'
+    # @param [Hash] opts a hash of options for the mount. Primarily this is a filter, which will restrict the list files outputted. example: :filter => '*.jpg'
+	# @param [Class] klass The class that should be used to handle this mount. You could write and use a custom handler if desired
     #
     # @example mount the directory '/home/user/foo' at the gopher path '/files', and only show JPG files:
     #   mount '/files' => '/home/user/foo', :filter => '*.jpg'
@@ -118,8 +118,7 @@ module Gopher
 
     #
     # define a route.
-    # @param [String] the path your route will answer to. This is
-    # basically a URI path
+    # @param [String] path the path your route will answer to. This is basically a URI path
     # @yield a block that handles your route
     #
     # @example respond with a simple string
@@ -145,6 +144,7 @@ module Gopher
 
     #
     # specify a default route to handle requests if no other route exists
+    # @yield a block to handle the default route
     #
     # @example render a template
     #   default_route do
@@ -158,7 +158,7 @@ module Gopher
     #
     # lookup an incoming path
     #
-    # @param [String] the selector path of the incoming request
+    # @param [String] selector the selector path of the incoming request
     #
     def lookup(selector)
       unless routes.nil?
@@ -190,7 +190,7 @@ module Gopher
 
     #
     # find and run the first route which matches the incoming request
-    # @param [Request] Gopher::Request object
+    # @param [Request] req Gopher::Request object
     #
     def dispatch(req)
       debug_log(req)
@@ -233,11 +233,11 @@ module Gopher
     # define a template which will be used to render a gopher-style
     # menu.
     #
-    # @param [String/Symbol] -- the name of the template. This is what
-    # identifies the template when making a call to render
+    # @param [String/Symbol] name the name of the template. This is what
+    #   identifies the template when making a call to render
     # @yield a block which will output the menu. This block is
-    # executed within an instance of Gopher::Rendering::Menu and will
-    # have access to all of its methods.
+    #   executed within an instance of Gopher::Rendering::Menu and will
+    #   have access to all of its methods.
     #
     # @example a simple menu:
     #  menu :index do
@@ -273,7 +273,7 @@ module Gopher
     # access to the methods defined in Gopher::Rendering::Text for
     # wrapping strings, adding simple headers, etc.
     #
-    # @param [String/Symbol] -- the name of the template. This is what identifies the template when making a call to render
+    # @param [String/Symbol] name the name of the template. This is what identifies the template when making a call to render
     #
     # @yield a block which will output the menu. This block is executed within an instance of Gopher::Rendering::Text and will have access to all of its methods.
     # @example simple example
@@ -295,7 +295,7 @@ module Gopher
 
     #
     # find a template
-    # @param [String/Symbol] name of the template
+    # @param [String/Symbol] t name of the template
     # @return template block and the class context it should use
     #
     def find_template(t)
@@ -311,8 +311,8 @@ module Gopher
 
     #
     # Find the desired template and call it within the proper context
-    # @param [String/Symbol] name of the template to render
-    # @param [Array] optional arguments to be passed to template
+    # @param [String/Symbol] template name of the template to render
+    # @param [Array] arguments optional arguments to be passed to template
     # @return result of rendering
     #
     def render(template, *arguments)
@@ -411,7 +411,7 @@ module Gopher
     # turn a path string with optional keys (/foo/:bar/:boo) into a
     # regexp which will be used when searching for a route
     #
-    # @param [String] the path to compile
+    # @param [String] path the path to compile
     #
     def compile(path)
       keys = []
@@ -448,7 +448,7 @@ module Gopher
       # generate a method which we will use to run routes. this is
       # based on #generate_method as used by sinatra.
       # @see https://github.com/sinatra/sinatra/blob/master/lib/sinatra/base.rb
-      # @param [String] name to use for the method
+      # @param [String] method_name name to use for the method
       # @yield block to use for the method
       def generate_method(method_name, &block)
         define_method(method_name, &block)

data/lib/gopher2000/dispatcher.rb

@@ -22,7 +22,7 @@ module Gopher
     #
     # called by EventMachine when there's an incoming request
     #
-    # @param [String] incoming selector
+    # @param [String] selector incoming selector
     # @return Response object
     #
     def receive_data(selector)
@@ -31,7 +31,7 @@ module Gopher
 
     #
     # generate a request object from an incoming selector, and dispatch it to the app
-    # @param [String] incoming selector
+    # @param [Request] request Request object to handle
     # @return Response object
     #
     def call!(request)

data/lib/gopher2000/dsl.rb

@@ -81,7 +81,7 @@ module Gopher
     end
 
     # watch the specified script for changes
-    # @param [String] script to watch
+    # @param [String] f script to watch
     def watch(f)
       application.scripts << f
     end

data/lib/gopher2000/handlers/directory_handler.rb

@@ -27,7 +27,7 @@ module Gopher
 
       #
       # strip slashes, extra dots, etc, from an incoming selector and turn it into a 'normalized' path
-      # @param [String] path
+      # @param [String] p path to check
       # @return clean path string
       #
       def sanitize(p)
@@ -65,12 +65,10 @@ module Gopher
       #
       # handle a request
       #
-      # @param [Hash] the params as parsed during the dispatching process - the main thing here should be :splat, which will basically be the path requested.
-      # @param [Request] - the Request object for this session -- not currently used?
+      # @param [Hash] params the params as parsed during the dispatching process - the main thing here should be :splat, which will basically be the path requested.
+      # @param [Request] request the Request object for this session -- not currently used?
       #
       def call(params = {}, request = nil)
-#        debug_log "DirectoryHandler: call #{params.inspect}, #{request.inspect}"
-
         lookup = request_path(params)
 
         raise Gopher::InvalidRequest if ! contained?(lookup)
@@ -86,7 +84,7 @@ module Gopher
 
       #
       # generate a directory listing
-      # @param [String] path to directory
+      # @param [String] dir path to directory
       # @return rendered directory output for a response
       #
       def directory(dir)

data/lib/gopher2000/rendering/base.rb

@@ -5,6 +5,8 @@ module Gopher
   #
   module Rendering
 
+	require 'artii'
+
     # "A CR LF denotes the end of the item." RFC 1436
     # @see http://www.faqs.org/rfcs/rfc1436.html
     LINE_ENDING = "\r\n"
@@ -94,6 +96,32 @@ module Gopher
         self.to_s
       end
 
+	  #
+	  # output a figlet, which is a big ASCII art header like this:
+	  #    _    _      _ _       _
+	  #   | |  | |    | | |     | |
+	  #   | |__| | ___| | | ___ | |
+	  #   |  __  |/ _ \ | |/ _ \| |
+	  #   | |  | |  __/ | | (_) |_|
+	  #   |_|  |_|\___|_|_|\___/(_)
+	  #
+	  # This method doesn't do any width checks, so you should be
+	  # careful with it.
+	  # You can get a list of fonts from the artii source code or
+	  # http://www.figlet.org/examples.html
+	  # https://github.com/miketierney/artii/tree/master/lib/figlet/fonts
+
+	  # @param [String] str the text you want to use for your figlet
+	  # @param [String] font name of the font. Defaults to 'big'.
+	  #
+	  def figlet(str, font = 'big')
+		a = Artii::Base.new(:font => font)
+		a.asciify(str).split("\n").each do |l|
+		  text l
+		end
+		self.to_s
+	  end
+
       #
       # output a centered string with a nice underline below it,
       # centered on the current output width
@@ -119,6 +147,11 @@ module Gopher
         underline(@width, under)
       end
 
+	  #
+	  # output a 'small' header, just the text with an underline
+      # @param [String] str - the string to output
+      # @param [String] under - the desired underline character
+	  #
 	  def small_header(str, under = '=')
 		str = " " + str + " "
 		text(str)

data/lib/gopher2000/rendering/menu.rb

@@ -15,7 +15,7 @@ module Gopher
       NO_PORT = 0
 
       # Sanitizes text for use in gopher menus
-      # @param [String] text text to cleanup
+      # @param [String] raw text to cleanup
       # @return string that can be used in a gopher menu
       def sanitize_text(raw)
         raw.
@@ -111,7 +111,7 @@ module Gopher
       # Determines the gopher type for +selector+ based on the
       # extension. This is a pretty simple check based on the entities
       # list in http://www.ietf.org/rfc/rfc1436.txt
-      # @param [String] selector, presumably a link to a file name with an extension
+      # @param [String] selector presumably a link to a file name with an extension
       # @return gopher selector type
       #
       def determine_type(selector)

data/lib/gopher2000/server.rb

@@ -8,7 +8,7 @@ module Gopher
 
     #
     # constructor
-    # @param [Application] instance of Gopher::Application we want to run
+    # @param [Application] a instance of Gopher::Application we want to run
     #
     def initialize(a)
       @app = a

data/lib/gopher2000/version.rb

@@ -1,4 +1,4 @@
 module Gopher
   # current version of the app
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/rendering/base_spec.rb

@@ -31,6 +31,13 @@ describe Gopher::Rendering::Base do
     end
   end
 
+  describe "figlet" do
+    it "outputs a figlet" do
+      @ctx.figlet('pie').should == "        _      \r\n       (_)     \r\n  _ __  _  ___ \r\n | '_ \\| |/ _ \\\r\n | |_) | |  __/\r\n | .__/|_|\\___|\r\n | |           \r\n |_|           \r\n"
+    end
+  end
+
+
   describe "big_header" do
     it "outputs a box with text" do
       @ctx.width(5)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gopher2000
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-02 00:00:00.000000000Z
+date: 2012-05-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18116460 !ruby/object:Gem::Requirement
+  requirement: &13099820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18116460
+  version_requirements: *13099820
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &18115520 !ruby/object:Gem::Requirement
+  requirement: &13098680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18115520
+  version_requirements: *13098680
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &18114820 !ruby/object:Gem::Requirement
+  requirement: &13096940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18114820
+  version_requirements: *13096940
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &18113580 !ruby/object:Gem::Requirement
+  requirement: &13066600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18113580
+  version_requirements: *13066600
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &18093380 !ruby/object:Gem::Requirement
+  requirement: &13062740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18093380
+  version_requirements: *13062740
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &18092340 !ruby/object:Gem::Requirement
+  requirement: &13003680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18092340
+  version_requirements: *13003680
 - !ruby/object:Gem::Dependency
   name: watchr
-  requirement: &18086720 !ruby/object:Gem::Requirement
+  requirement: &13002280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18086720
+  version_requirements: *13002280
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &18032500 !ruby/object:Gem::Requirement
+  requirement: &13001380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18032500
+  version_requirements: *13001380
+- !ruby/object:Gem::Dependency
+  name: artii
+  requirement: &13000160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *13000160
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &18031440 !ruby/object:Gem::Requirement
+  requirement: &12998560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +120,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18031440
+  version_requirements: *12998560
 - !ruby/object:Gem::Dependency
   name: logging
-  requirement: &18029980 !ruby/object:Gem::Requirement
+  requirement: &12997620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,7 +131,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *18029980
+  version_requirements: *12997620
 description: Gopher2000 is a ruby-based Gopher server. It is built for speedy, enjoyable
   development of all sorts of gopher sites.
 email:
@@ -138,6 +149,7 @@ files:
 - Rakefile
 - bin/gopher2000
 - examples/default_route.rb
+- examples/figlet.rb
 - examples/nyan.rb
 - examples/simple.rb
 - examples/twitter.rb
@@ -191,7 +203,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -579980991170337830
+      hash: -984672476065544858
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -200,7 +212,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -579980991170337830
+      hash: -984672476065544858
 requirements: []
 rubyforge_project: gopher2000
 rubygems_version: 1.8.17