halcyon 0.4.0 → 0.5.0

data/support/generators/halcyon/halcyon_generator.rb

@@ -0,0 +1,52 @@
+require 'rbconfig'
+
+class HalcyonGenerator < RubiGen::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+  
+  default_options   :shebang => DEFAULT_SHEBANG
+  
+  attr_reader :app_name, :module_name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = args.shift
+    @app_name     = File.basename(File.expand_path(@destination_root))
+    @module_name  = app_name.camelize
+    # extract_options
+  end
+  
+  def manifest
+    record do |m|
+      source = File.expand_path(File.join(File.dirname(__FILE__), 'templates')) << File::Separator
+      
+      m.directory ''
+      Dir[source + '**/*'].each do |path|
+        path = path.sub(source, '')
+        if File.directory?(source+path)
+          m.directory path
+        else
+          m.template path, path, :assigns => {:app => @module_name, :unix => @app_name}
+        end
+      end
+      m.directory 'log'
+    end
+  end
+  
+  protected
+  def banner
+    <<-"end;"
+      Create a stub for #{File.basename $0} to get started.
+      
+      Usage: #{File.basename $0} [options] /path/to/your/app"
+    end;
+  end
+  
+  def add_options!(opts)
+    opts.separator ''
+    opts.separator "#{File.basename $0} options:"
+    opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+  end
+  
+end

data/support/generators/halcyon/templates/README

@@ -0,0 +1,26 @@
+= Application
+
+
+== Introduction
+
+...
+
+
+== Installation
+
+...
+
+
+=== Dependencies
+
+* Halcyon (halcyon >= 0.5.0)
+* ...
+
+== License
+
+...
+
+
+== Contact
+
+...

data/support/generators/halcyon/templates/Rakefile

@@ -0,0 +1,32 @@
+%w(rubygems rake rake/clean rake/rdoctask fileutils pp halcyon).each{|dep|require dep}
+
+include FileUtils
+
+# Halcyon.root => the root application directory
+# Halcyon.app  => the application name
+
+desc "Start the application on port 4647"
+task :start do
+  sh "halcyon start -p 4647"
+end
+
+desc "Generate RDoc documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.options << '--line-numbers' << '--inline-source' <<
+    '--main' << 'README' <<
+    '--title' << "#{Halcyon.app} Documentation" <<
+    '--charset' << 'utf-8'
+  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('app/**/*.rb')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# = Custom Rake Tasks
+# 
+# Add your custom rake tasks here.
+
+# ...
+
+# = Default Task
+task :default => Rake::Task['start']

data/support/generators/halcyon/templates/app/application.rb

@@ -0,0 +1,43 @@
+class Application < Halcyon::Controller
+  
+  # Summary of available services
+  # 
+  # This method is just a sample and can be removed altogether. It may be
+  # advised to advertise available functionality for public-facing applications
+  # to clarify usage.
+  # 
+  # Returns [{:path=>String:path,Symbol:method=>[Hash:params, *:sample],...},...]
+  def index
+    ok([
+      {
+        :path => "/time",
+        :GET => [{}, Time.now.to_s],
+        :POST => [{:format => "strftime compatible"}, Time.now.strftime("%Y-%m-%dT%H:%M%:%S%Z")]
+      },
+      {
+        :path => "/",
+        :GET => [{}, "[{:path=>String:path,Symbol:method=>[Hash:params, *:sample],...},...]"]
+      }
+    ])
+  end
+  
+  # Responds with the current time in either generic or specific formats
+  # 
+  # GET
+  #   returns the current time
+  # POST
+  #   returns the current time formatted acccording to +format+
+  # 
+  # Returns String:time
+  def time
+    case method
+    when :get
+      ok(Time.now.to_s)
+    when :post
+      ok(Time.now.strftime(post[:format] || "%Y-%m-%dT%H:%M%:%S%Z"))
+    else
+      raise NotImplemented.new
+    end
+  end
+  
+end

data/support/generators/halcyon/templates/config/config.yml

@@ -0,0 +1,36 @@
+# = Framework
+# 
+# <tt>allow_from</tt>: specifies what connections to accept;
+# * <tt>all</tt>: allow connections from all clients
+# * <tt>local</tt>: only allow connections from the same host (localhost et al)
+# * <tt>halcyon_clients</tt>: only Halcyon clients (tests the User-Agent only)
+allow_from: all
+
+# = Environment
+# 
+# Uncomment to manually specify the environment to run the application in.
+# Defaults to <tt>:development</tt>.
+# 
+# environment: production
+
+# = Logging
+# 
+# Configures the logging client in the framework, including destination,
+# level filter, and what logger to use.
+# 
+# <tt>type</tt>: the logger to use (defaults to Ruby's <tt>Logger</tt>)
+# * <tt>Logger</tt>
+# * <tt>Analogger</tt>
+# * <tt>Logging</tt>
+# * <tt>Log4r</tt>
+# <tt>file</tt>: the log file; leave unset for STDOUT
+# <tt>level</tt>: the message filter level (default to <tt>debug</tt>)
+# * specific to the client used, often is: debug, info, warn, error, fatal
+logging:
+  type: Logger
+  # file: # STDOUT
+  level: debug
+
+# = Application
+# 
+# Your application-specific configuration options here.

data/support/generators/halcyon/templates/config/init/environment.rb

@@ -0,0 +1,11 @@
+# = Environment
+# 
+# Sets the environment unless already set.
+# 
+# Creates the <tt>Halcyon.environment</tt> configurable attribute. Since this
+# is mapped to <tt>Halcyon.config[:environment]</tt>, environment can be set
+# by setting the <tt>environment:</tt> configuration value in the
+# <tt>config/config.yml</tt> file.
+
+Halcyon.configurable_attr(:environment)
+Halcyon.environment = :development unless Halcyon.environment

data/support/generators/halcyon/templates/config/init/hooks.rb

@@ -0,0 +1,39 @@
+# = Hooks
+#
+# Specify actions to run at specific times during the application's execution,
+# such as the startup or shutdown events.
+# 
+# Available Hooks
+#   +startup+
+#   +shutdown+
+# 
+# All hooks take the current application configuration as its sole block param.
+# 
+# Examples
+#   Halcyon::Application.startup do |config|
+#     # Halcyon.db set in config/initialize/database.rb
+#     ::DB = Sequel(Halcyon.db)
+#     logger.info "Connected to database"
+#   end
+# 
+# The +logger+ object is available to log messages on status or otherwise.
+
+# = Startup
+# 
+# Run when the Halcyon::Application object is instanciated, after all
+# initializers are loaded.
+# 
+# Ideal for establishing connections to resources like databases.
+# Establish configuration options in initializer files, though.
+Halcyon::Application.startup do |config|
+  logger.info 'Define startup tasks in config/init/hooks.rb'
+end
+
+# = Shutdown
+# 
+# Run <tt>at_exit</tt>. Should run in most cases of termination.
+# 
+# Ideal for closing connections to resources.
+Halcyon::Application.shutdown do |config|
+  logger.info 'Define shutdown tasks in config/init/hooks.rb'
+end

data/support/generators/halcyon/templates/config/init/requires.rb

@@ -0,0 +1,10 @@
+# = Required Libraries
+# 
+# Specify required libraries specific to the operation of your application.
+# 
+# Examples
+#   %(digest/md5 tempfile date).each{|dep|require dep}
+# 
+# RubyGems should already be required by Halcyon, so don't include it.
+
+%w().each{|dep|require dep}

data/support/generators/halcyon/templates/config/init/routes.rb

@@ -0,0 +1,50 @@
+# = Routes
+# 
+# Halcyon::Application::Router is the request routing mapper for the merb
+# framework.
+# 
+# You can route a specific URL to a controller / action pair:
+# 
+#   r.match("/contact").
+#     to(:controller => "info", :action => "contact")
+# 
+# You can define placeholder parts of the url with the :symbol notation. These
+# placeholders will be available in the params hash of your controllers. For example:
+# 
+#   r.match("/books/:book_id/:action").
+#     to(:controller => "books")
+# 
+# Or, use placeholders in the "to" results for more complicated routing, e.g.:
+# 
+#   r.match("/admin/:module/:controller/:action/:id").
+#     to(:controller => ":module/:controller")
+# 
+# You can also use regular expressions, deferred routes, and many other options.
+# See merb/specs/merb/router.rb for a fairly complete usage sample.
+# 
+# Stolen directly from generated Merb app. All documentation applies.
+# Read more about the Merb router at http://merbivore.com/.
+Halcyon::Application.route do |r|
+  
+  # Sample route for the sample functionality in Application.
+  # Safe to remove!
+  r.match('/time').to(:controller => 'application', :action => 'time')
+  
+  # RESTful routes
+  # r.resources :posts
+
+  # This is the default route for /:controller/:action/:id
+  # This is fine for most cases.  If you're heavily using resource-based
+  # routes, you may want to comment/remove this line to prevent
+  # clients from calling your create or destroy actions with a GET
+  r.default_routes
+  
+  # Change this for the default route to be available at /
+  r.match('/').to(:controller => 'application', :action => 'index')
+  # It can often be useful to respond with available functionality if the
+  # application is a public-facing service.
+  
+  # Default not-found route
+  {:action => 'not_found'}
+  
+end

data/support/generators/halcyon/templates/lib/client.rb

@@ -0,0 +1,77 @@
+%w(rubygems halcyon).each{|dep|require dep}
+
+module <%= app %>
+  
+  # = Client
+  # 
+  # The client interface for accessing services provided by the Halcyon
+  # application as defined in the controllers in <tt>app/</tt>.
+  # 
+  # == Usage
+  # 
+  # To use the Client in your application, create an instance and call methods
+  # defined here. For example:
+  # 
+  #   client = <%= app %>::Client.new('http://localhost:4647/')
+  #   client.time #=> "Tue Apr 15 21:04:15 -0400 2008"
+  # 
+  # You can just as easily call the primary <tt>get</tt>, <tt>post</tt>,
+  # <tt>put</tt>, and <tt>delete</tt> methods as well, passing in the +path+
+  # and any params. For example:
+  # 
+  #   client.get('/time') #=> "Tue Apr 15 21:04:15 -0400 2008"
+  # 
+  # By default, if you enter a bad (non-existent) path or the application
+  # raises an exception and cannot complete successfully, the standard response
+  # format will be returned but with more appropriate +status+ and +body+
+  # values. For instance:
+  # 
+  #   client.get('/nonexistent/path') #=> {:status=>404,:body=>"Not Found"}
+  # 
+  # Exceptions can be raised on any +status+ returned other than +200+ if you
+  # set <tt>Halcyon::Client#raise_exceptions!</tt> to +true+ (which is the
+  # default param).
+  # 
+  #   client.raise_exceptions! #=> true
+  #   client.get('/nonexistent/path') #=> NotFound exception is raised
+  # 
+  # These exceptions all inherit from <tt>Halcyon::Exceptions::Base</tt> so
+  # <tt>rescue</tt>ing just normal Halcyon errors is trivial.
+  # 
+  # However, setting this value can cause the meaning and the appropriate
+  # error-handling measures put in place in actions. Although each method
+  # could just as easily set the +raise_exceptions+ configuration option
+  # itself, it is not advised to do so due to the possibility of non-
+  # consistent and confusing behavior it can cause.
+  # 
+  # If raising exceptions is preferred, it should be set as soon as the
+  # client is created and the client methods should be designed accordingly.
+  class Client < Halcyon::Client
+    
+    def self.version
+      VERSION.join('.')
+    end
+    
+    # Sample of a client method to wrap an API call
+    def time
+      get('/time')[:body]
+    end
+    
+    # More comprehensive sample client method
+    def strftime(format = nil)
+      if (res = post('/time', :format => format))[:status] == 200
+        # success
+        res[:body]
+      else
+        # failure
+        # returns the whole response to indicate an error happened, but could
+        # just as easily raise an exception.
+        # but if an exception is prefererd, read the documentation for
+        # <tt>Halcyon::Client#raise_exceptions!</tt> instead.
+        res
+      end
+    end
+    
+  end
+  
+end

data/support/generators/halcyon/templates/runner.ru

@@ -0,0 +1,8 @@
+require 'halcyon'
+
+$:.unshift(Halcyon.root/'lib')
+
+puts "(Starting in #{Halcyon.root})"
+
+Thin::Logging.silent = true if defined? Thin
+run Halcyon::Runner.new

data/support/generators/halcyon_flat/halcyon_flat_generator.rb

@@ -0,0 +1,52 @@
+require 'rbconfig'
+
+class HalcyonFlatGenerator < RubiGen::Base
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+  
+  default_options   :shebang => DEFAULT_SHEBANG
+  
+  attr_reader :app_name, :module_name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = args.shift
+    @app_name     = File.basename(File.expand_path(@destination_root))
+    @module_name  = app_name.camelize
+    # extract_options
+  end
+  
+  def manifest
+    record do |m|
+      source = File.expand_path(File.join(File.dirname(__FILE__), 'templates')) << File::Separator
+      
+      m.directory ''
+      Dir[source + '**/*'].each do |path|
+        path = path.sub(source, '')
+        if File.directory?(source+path)
+          m.directory path
+        else
+          m.template path, path, :assigns => {:app => @module_name, :unix => @app_name}
+        end
+      end
+      m.directory 'log'
+    end
+  end
+  
+  protected
+  def banner
+    <<-"end;"
+      Create a stub for #{File.basename $0} to get started.
+      
+      Usage: #{File.basename $0} [options] /path/to/your/app"
+    end;
+  end
+  
+  def add_options!(opts)
+    opts.separator ''
+    opts.separator "#{File.basename $0} options:"
+    opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+  end
+  
+end