@@ -0,0 +1 @@ +* Matt Todd <chiology@gmail.com> AUTHORS @@ -0,0 +1,58 @@ += Halcyon JSON Server Framework + +A JSON Web Server Framework designed to provide for simple applications dealing +solely with JSON requests and responses from AJAX client applications or for +lightweight server-side message transport. + +== On Rack + +Halcyon is based off of Rack. + +== Quick start + +Check out the documentation for the Aurora SAS at http://aurora.rubyforge.org/ +to see Halcyon in use. + +== Installing with RubyGems + +A Gem of Halcyon is available. You can install it with: + +$ sudo gem install halcyon + +== Contact + +Please mail bugs, suggestions and patches to +<mailto:chiology@gmail.com>. + +You are also welcome to join the #halcyon channel on irc.freenode.net. + +== License and Copyright + +Copyright (C) 2007 Matt Todd <http://purl.org/net/maraby>. + +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: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +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 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. + +== Links + +Halcyon:: <http://halcyon.rubyforge.org/> +Aurora:: <http://aurora.rubyforge.org/> + +Rack:: <http://rack.rubyforge.org/> +JSON:: <http://json.rubyforge.org/> + +Matt TOdd:: <http://maraby.org/> README @@ -0,0 +1,175 @@ +# Rakefile for Rack. -*-ruby-*- +require 'rake/rdoctask' +require 'rake/testtask' + + +desc "Run all the tests" +task :default => [:test] + +desc "Do predistribution stuff" +task :predist => [:chmod, :changelog, :rdoc] + + +desc "Make an archive as .tar.gz" +task :dist => :fulltest do + sh "export DARCS_REPO=#{File.expand_path "."}; " + + "darcs dist -d rack-#{get_darcs_tree_version}" +end + +# Helper to retrieve the "revision number" of the darcs tree. +def get_darcs_tree_version + unless File.directory? "_darcs" + $: << "lib" + require 'rack' + return Rack.version + end + + changes = `darcs changes` + count = 0 + tag = "0.0" + + changes.each("\n\n") { |change| + head, title, desc = change.split("\n", 3) + + if title =~ /^ \*/ + # Normal change. + count += 1 + elsif title =~ /tagged (.*)/ + # Tag. We look for these. + tag = $1 + break + else + warn "Unparsable change: #{change}" + end + } + + tag + "." + count.to_s +end + +def manifest + `darcs query manifest`.split("\n").map { |f| f.gsub(/\A\.\//, '') } +end + + +desc "Make binaries executable" +task :chmod do + Dir["bin/*"].each { |binary| File.chmod(0775, binary) } + Dir["test/cgi/test*"].each { |binary| File.chmod(0775, binary) } +end + +desc "Generate a ChangeLog" +task :changelog do + sh "darcs changes --repo=#{ENV["DARCS_REPO"] || "."} >ChangeLog" +end + + +desc "Generate RDox" +task "RDOX" do + sh "specrb -Ilib:test -a --rdox >RDOX" +end + +desc "Generate Rack Specification" +task "SPEC" do + File.open("SPEC", "wb") { |file| + IO.foreach("lib/rack/lint.rb") { |line| + if line =~ /## (.*)/ + file.puts $1 + end + } + } +end + +desc "Run all the fast tests" +task :test do + sh "specrb -Ilib:test -w #{ENV['TEST'] || '-a'} #{ENV['TESTOPTS'] || '-t "^(?!Rack::Handler|Rack::Adapter)"'}" +end + +desc "Run all the tests" +task :fulltest do + sh "specrb -Ilib:test -w #{ENV['TEST'] || '-a'} #{ENV['TESTOPTS']}" +end + +begin + $" << "sources" if defined? FromSrc + require 'rubygems' + + require 'rake' + require 'rake/clean' + require 'rake/packagetask' + require 'rake/gempackagetask' + require 'fileutils' +rescue LoadError + # Too bad. +else + spec = Gem::Specification.new do |s| + s.name = "rack" + s.version = get_darcs_tree_version + s.platform = Gem::Platform::RUBY + s.summary = "a modular Ruby webserver interface" + + s.description = <<-EOF +Rack provides minimal, modular and adaptable interface for developing +web applications in Ruby. By wrapping HTTP requests and responses in +the simplest way possible, it unifies and distills the API for web +servers, web frameworks, and software in between (the so-called +middleware) into a single method call. + +Also see http://rack.rubyforge.org. + EOF + + s.files = manifest + %w(SPEC RDOX) + s.bindir = 'bin' + s.executables << 'rackup' + s.require_path = 'lib' + s.has_rdoc = true + s.extra_rdoc_files = ['README', 'SPEC', 'RDOX', 'KNOWN-ISSUES'] + s.test_files = Dir['test/{test,spec}_*.rb'] + + s.author = 'Christian Neukirchen' + s.email = 'chneukirchen@gmail.com' + s.homepage = 'http://rack.rubyforge.org' + s.rubyforge_project = 'rack' + end + + Rake::GemPackageTask.new(spec) do |p| + p.gem_spec = spec + p.need_tar = false + p.need_zip = false + end +end + +desc "Generate RDoc documentation" +Rake::RDocTask.new(:rdoc) do |rdoc| + rdoc.options << '--line-numbers' << '--inline-source' << + '--main' << 'README' << + '--title' << 'Rack Documentation' << + '--charset' << 'utf-8' + rdoc.rdoc_dir = "doc" + rdoc.rdoc_files.include 'README' + rdoc.rdoc_files.include 'KNOWN-ISSUES' + rdoc.rdoc_files.include 'SPEC' + rdoc.rdoc_files.include 'RDOX' + rdoc.rdoc_files.include('lib/rack.rb') + rdoc.rdoc_files.include('lib/rack/*.rb') + rdoc.rdoc_files.include('lib/rack/*/*.rb') +end +task :rdoc => ["SPEC", "RDOX"] + +task :pushsite => [:rdoc] do + sh "rsync -avz doc/ chneukirchen@rack.rubyforge.org:/var/www/gforge-projects/rack/doc/" + sh "rsync -avz site/ chneukirchen@rack.rubyforge.org:/var/www/gforge-projects/rack/" +end + +begin + require 'rcov/rcovtask' + + Rcov::RcovTask.new do |t| + t.test_files = FileList['test/{spec,test}_*.rb'] + t.verbose = true # uncomment to see the executed command + t.rcov_opts = ["--text-report", + "-Ilib:test", + "--include-file", "^lib,^test", + "--exclude-only", "^/usr,^/home/.*/src,active_"] + end +rescue LoadError +end Rakefile @@ -20,7 +20,7 @@ options = { } opts = OptionParser.new("", 24, ' ') do |opts| - opts.banner = "Usage: halcyon [options] [config_file.yaml]" + opts.banner = "Usage: halcyon [options] [app]" opts.separator "" opts.separator "Options:" @@ -36,6 +36,10 @@ opts = OptionParser.new("", 24, ' ') do |opts| require library end + opts.on("-c", "--config PATH", "configuration stored in PATH") do |conf| + options[:config_file] = conf + end + opts.on("-s", "--server SERVER", "serve using SERVER (default: #{options[:server]})") do |serv| options[:server] = serv end @@ -70,6 +74,7 @@ opts = OptionParser.new("", 24, ' ') do |opts| opts.parse! ARGV end -options[:config_file] = ARGV.shift unless ARGV[0].nil? +fail("Halcyon needs an app to run. Try: halcyon -h") if ARGV.empty? +options[:app] = ARGV.shift puts options.inspect bin/halcyon 986ea3a4a65ea8f064cd1edc9a77a4aca3e2a657 Matt Todd chiology@gmail.com http://github.com/mtodd/halcyon/commit/e75f4a96cc33072feab97b329153ca9d48fcab53 e75f4a96cc33072feab97b329153ca9d48fcab53 2007-12-14T01:38:21-08:00 2007-12-14T01:38:21-08:00 Fixed some of the general documentation for the project and stole some code from Rack for Rakefile and for bin/halcyon. git-svn-id: svn+ssh://rubyforge.org/var/svn/halcyon/trunk@3 334d6d1c-2662-47f5-9f2d-00d938bdab95 b18e2d9f3431ce1ef4e99e47ef7ffc41278c4c8f Matt Todd chiology@gmail.com