ginatra 2.0.2 → 2.1.0

data/lib/ginatra.rb

@@ -1,9 +1,15 @@
+# We only want Rubygems if it exists. Else, we assume they know what they're doing.
+begin
+  require 'rubygems'
+rescue LoadError
+end
 require 'sinatra/base'
 require 'grit'
 require 'coderay'
 
 current_path = File.expand_path(File.dirname(__FILE__))
 
+# The Ginatra Namespace Module
 module Ginatra; end
 
 # Loading in reverse because RepoList needs to be loaded before MultiRepoList
@@ -14,9 +20,16 @@ require "#{current_path}/sinatra/partials"
 # Written myself. i know, what the hell?!
 module Ginatra
 
+  # A standard error class for inheritance.
+  # @todo Look for a refactor.
   class Error < StandardError; end
+
+  # An error related to a commit somewhere.
+  # @todo Look for a refactor.
   class CommitsError < Error; end
-  
+
+  # Error raised when commit ref passed in parameters
+  # does not exist in repository
   class InvalidCommit < Error
     def initialize(id)
       super("Could not find a commit with the id of #{id}")
@@ -24,8 +37,13 @@ module Ginatra
   end
 
   current_path = File.expand_path(File.dirname(__FILE__))
+  # @todo look for a refactor that is rip compatible
   VERSION = File.new("#{current_path}/../VERSION").read
 
+  # The main application class.
+  #
+  # This class contains all the core application logic
+  # and is what is mounted by the +rackup.ru+ files.
   class App < Sinatra::Base
 
     configure do
@@ -42,18 +60,36 @@ module Ginatra
     end
 
     helpers do
+
+      # Ginatra::Helpers module full of goodness
       include Helpers
+
+      # My Sinatra Partials implementation.
+      #
+      # check out http://gist.github.com/119874
+      # for more details
       include ::Sinatra::Partials
     end
 
+    # Let's handle a CommitsError.
+    #
+    # @todo prettify
     error CommitsError do
       'No commits were returned for ' + request.uri
     end
 
+    # The root route
+    #
+    # @todo how does this work?
     get '/' do
       erb :index
     end
 
+    # The atom feed of recent commits to a +repo+.
+    #
+    # This only returns commits to the +master+ branch.
+    #
+    # @param [String] repo the repository url-sanitised-name
     get '/:repo.atom' do
       @repo = RepoList.find(params[:repo])
       @commits = @repo.commits
@@ -62,6 +98,11 @@ module Ginatra
       builder :atom, :layout => nil
     end
 
+    # The html page for a +repo+.
+    #
+    # Shows the most recent commits in a log format
+    #
+    # @param [String] repo the repository url-sanitised-name
     get '/:repo' do
       @repo = RepoList.find(params[:repo])
       @commits = @repo.commits
@@ -69,6 +110,10 @@ module Ginatra
       erb :log
     end
 
+    # The atom feed of recent commits to a certain branch of a +repo+.
+    #
+    # @param [String] repo the repository url-sanitised-name
+    # @param [String] ref the repository ref
     get '/:repo/:ref.atom' do
       @repo = RepoList.find(params[:repo])
       @commits = @repo.commits(params[:ref])
@@ -77,6 +122,12 @@ module Ginatra
       builder :atom, :layout => nil
     end
 
+    # The html page for a given +ref+ of a +repo+.
+    #
+    # Shows the most recent commits in a log format
+    #
+    # @param [String] repo the repository url-sanitised-name
+    # @param [String] ref the repository ref
     get '/:repo/:ref' do
       params[:page] = 1
       @repo = RepoList.find(params[:repo])
@@ -85,12 +136,20 @@ module Ginatra
       erb :log
     end
 
+    # The patch file for a given commit to a +repo+.
+    #
+    # @param [String] repo the repository url-sanitised-name
+    # @param [String] commit the repository commit
     get '/:repo/commit/:commit.patch' do
       response['Content-Type'] = "text/plain"
       @repo = RepoList.find(params[:repo])
       @repo.git.format_patch({}, "--stdout", "-1", params[:commit])
     end
 
+    # The html representation of a commit.
+    #
+    # @param [String] repo the repository url-sanitised-name
+    # @param [String] commit the repository commit
     get '/:repo/commit/:commit' do
       @repo = RepoList.find(params[:repo])
       @commit = @repo.commit(params[:commit]) # can also be a ref
@@ -98,12 +157,21 @@ module Ginatra
       erb(:commit)
     end
 
+    # Download an archive of a given tree!
+    #
+    # @param [String] repo the repository url-sanitised-name
+    # @param [String] tree the repository tree
     get '/:repo/archive/:tree.tar.gz' do
       response['Content-Type'] = "application/x-tar-gz"
       @repo = RepoList.find(params[:repo])
       @repo.archive_tar_gz(params[:tree])
     end
 
+    # HTML page for a given tree in a given +repo+
+    #
+    # @todo cleanup!
+    # @param [String] repo the repository url-sanitised-name
+    # @param [String] tree the repository tree
     get '/:repo/tree/:tree' do
       @repo = RepoList.find(params[:repo])
 
@@ -121,6 +189,13 @@ module Ginatra
       erb(:tree)
     end
 
+    # HTML page for a given tree in a given +repo+.
+    #
+    # This one supports a splat parameter so you can specify a path
+    #
+    # @todo cleanup!
+    # @param [String] repo the repository url-sanitised-name
+    # @param [String] tree the repository tree
     get '/:repo/tree/:tree/*' do # for when we specify a path
       @repo = RepoList.find(params[:repo])
       @tree = @repo.tree(params[:tree])/params[:splat].first # can also be a ref (i think)
@@ -137,6 +212,10 @@ module Ginatra
       end
     end
 
+    # HTML page for a given blob in a given +repo+
+    #
+    # @param [String] repo the repository url-sanitised-name
+    # @param [String] tree the repository tree
     get '/:repo/blob/:blob' do
       @repo = RepoList.find(params[:repo])
       @blob = @repo.blob(params[:blob])
@@ -144,6 +223,13 @@ module Ginatra
       erb(:blob)
     end
 
+    # HTML page for a given blob in a given repo.
+    #
+    # Uses a splat param to specify a blob path.
+    #
+    # @todo cleanup!
+    # @param [String] repo the repository url-sanitised-name
+    # @param [String] tree the repository tree
     get '/:repo/blob/:tree/*' do
       @repo = RepoList.find(params[:repo])
       @blob = @repo.tree(params[:tree])/params[:splat].first
@@ -167,13 +253,18 @@ module Ginatra
       end
     end
 
+    # pagination route for the commits to a given ref in a +repo+.
+    #
+    # @todo cleanup!
+    # @param [String] repo the repository url-sanitised-name
+    # @param [String] ref the repository ref
     get '/:repo/:ref/:page' do
       pass unless params[:page] =~ /^(\d)+$/
       params[:page] = params[:page].to_i
       @repo = RepoList.find(params[:repo])
       @commits = @repo.commits(params[:ref], 10, (params[:page] - 1) * 10)
       @next_commits = !@repo.commits(params[:ref], 10, params[:page] * 10).empty?
-      if params[:page] - 1 > 0 
+      if params[:page] - 1 > 0
         @previous_commits = !@repo.commits(params[:ref], 10, (params[:page] - 1) * 10).empty?
       end
       @separator = @next_commits && @previous_commits

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ginatra
 version: !ruby/object:Gem::Version 
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors: 
 - Sam Elliott
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-26 00:00:00 +01:00
+date: 2009-12-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -101,19 +101,6 @@ files:
 - spec/repo_list_spec.rb
 - spec/repo_spec.rb
 - spec/spec_helper.rb
-- vendor/vegas/History.txt
-- vendor/vegas/LICENSE
-- vendor/vegas/Manifest.txt
-- vendor/vegas/README.rdoc
-- vendor/vegas/Rakefile
-- vendor/vegas/lib/vegas.rb
-- vendor/vegas/lib/vegas/runner.rb
-- vendor/vegas/test/test_app/bin/test_app
-- vendor/vegas/test/test_app/test_app.rb
-- vendor/vegas/test/test_apps.rb
-- vendor/vegas/test/test_helper.rb
-- vendor/vegas/test/test_vegas_runner.rb
-- vendor/vegas/vegas.gemspec
 - views/_actor_box.erb
 - views/_commit_info_box.erb
 - views/_header.erb
@@ -149,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: A Gitweb Clone in Sinatra and Grit

data/vendor/vegas/History.txt

@@ -1,18 +0,0 @@
-== 0.0.4 2009-08-09
-
-* new -L (--skip-launch) option doesn't launch the web browser (thanks bmabey!)
-* rubygems is required only on LoadError
-
-== 0.0.3 2009-07-06
-
-* Vegas::Runner is now Windows compatible (require win32-process gem)
-  * Includes daemon-ization
-  * PID tracking
-  * Vegas::WINDOWS is a top level boolean
-* Vegas is no longer dependent on Launchy 
-  * launching browser is done simply with open/start depending on platform
-  
-== 0.0.1 2009-04-13
-
-* 1 major enhancement:
-  * Initial release

data/vendor/vegas/LICENSE

@@ -1,22 +0,0 @@
-(The MIT License)
-
-Copyright (c) 2009 Aaron Quint, Quirkey NYC, LLC.
-
-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 OR COPYRIGHT HOLDERS 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.

data/vendor/vegas/Manifest.txt

@@ -1,5 +0,0 @@
-History.txt
-LICENSE
-README.rdoc
-lib/vegas.rb
-lib/vegas/runner.rb

data/vendor/vegas/README.rdoc

@@ -1,45 +0,0 @@
-= vegas
-
-http://code.quirkey.com/vegas
-
-== DESCRIPTION:
-
-Vegas aims to solve the simple problem of creating executable versions of Sinatra/Rack apps.
-
-== FEATURES/PROBLEMS:
-
-Currently, Vegas just includes a single class Vegas::Runner which wraps your Sinatra app to give it command line options, daemonization, PID/URL tracking, and browser launching (using Launchy).
-
-Lets say you have a gem with a sinatra application. With Vegas you can create a bin that looks like
-  
-  #!/usr/bin/env ruby
-  # ./bin/myapp
-  
-  require File.expand_path(File.dirname(__FILE__) + "/../lib/myapp")
-  require 'vegas'
-  
-  Vegas::Runner.new(Sinatra::Application, 'myapp')
-  
-
-See the website: http://code.quirkey.com/vegas for full usage/options.
-
-=== WINDOWS:
-
-Using vegas (and gems that depend on it) on Windows works but isn't 100% the same. 
-Daemon-ization and browser launching work, but you will see duplicate messages.
-
-If you see a warning like:
-
-  `expand_path': couldn't find HOME environment -- expanding `~/.vegas' (ArgumentError)
-
-You have to set your HOME path:
-
-  c:\> set HOME=%HOMEPATH%
-
-== INSTALL:
-
-  sudo gem install vegas
-
-== LICENSE:
-
-MIT LICENSE, see LICENSE for details

data/vendor/vegas/Rakefile

@@ -1,32 +0,0 @@
-%w[rubygems rake rake/clean hoe fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/vegas'
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec('vegas') do |p|
-  p.version              = Vegas::VERSION
-  p.developer('Aaron Quint', 'aaron@quirkey.com')
-  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.summary              = "Vegas aims to solve the simple problem of creating executable versions of Sinatra/Rack apps."
-  p.description          = %{Vegas aims to solve the simple problem of creating executable versions of Sinatra/Rack apps. It includes a class Vegas::Runner that wraps Rack/Sinatra applications and provides a simple command line interface and launching mechanism.}
-  p.rubyforge_name       = 'quirkey'
-  p.extra_deps         = [
-    ['sinatra','>= 0.9.1']
-  ]
-  p.extra_dev_deps = [
-    ['newgem', ">= #{::Newgem::VERSION}"],
-    ['nokogiri', ">= 1.0.6"],
-    ['bacon', ">= 1.1.0"]
-  ]
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
-  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
-  p.rsync_args = '-av --delete --ignore-errors'
-end
-
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# task :default => [:spec, :features]

data/vendor/vegas/lib/vegas/runner.rb

@@ -1,270 +0,0 @@
-require 'open-uri'
-require 'logger'
-require 'optparse'
-
-if Vegas::WINDOWS
-  begin
-    require 'win32/process'
-  rescue 
-    puts "Sorry, in order to use Vegas on Windows you need the win32-process gem:\n gem install win32-process"
-  end
-end
-
-module Vegas
-  class Runner
-    attr_reader :app, :app_name, :rack_handler, :port, :host, :options
-    
-    ROOT_DIR   = File.expand_path(File.join('~', '.vegas'))
-    PORT       = 5678
-    HOST       = WINDOWS ? 'localhost' : '0.0.0.0'
-    
-    def initialize(app, app_name, set_options = {}, &block)
-      # initialize
-      @app          = app
-      @app_name     = app_name
-      @options      = set_options || {}
-      @rack_handler = @app.send :detect_rack_handler
-      # load options from opt parser
-      define_options do |opts|
-        if block_given?
-          opts.separator ''
-          opts.separator "#{app_name} options:"
-          yield(self, opts, app)
-        end
-      end
-      # set app options
-      @host = options[:host] || HOST
-      @app.set options
-      # initialize app dir
-      FileUtils.mkdir_p(app_dir)
-      
-      return if options[:start] === false
-      
-      logger.info "Running with Windows Settings" if WINDOWS
-      logger.info "Starting #{app_name}"
-      
-      check_for_running
-      find_port
-      write_url
-      start
-    end
-    
-    def app_dir
-      File.join(ROOT_DIR, app_name)
-    end
-    
-    def pid_file
-      File.join(app_dir, "#{app_name}.pid")
-    end
-    
-    def url_file
-      File.join(app_dir, "#{app_name}.url")
-    end
-    
-    def url
-      "http://#{host}:#{port}"
-    end
-    
-    def log_file
-      File.join(app_dir, "#{app_name}.log")
-    end
-    
-    def handler_name
-      rack_handler.name.gsub(/.*::/, '')
-    end
-        
-    def find_port
-      if @port = options[:port]
-        if !port_open?
-          logger.warn "Port #{port} is already in use. Please try another or don't use -P, for auto-port"
-        end
-      else
-        @port = PORT
-        logger.info "Trying to start #{app_name} on Port #{port}"
-        while !port_open?
-          @port += 1
-          logger.info "Trying to start #{app_name} on Port #{port}"
-        end
-      end
-    end
-    
-    def port_open?(check_url = nil)
-      begin
-        open(check_url || url)
-        false
-      rescue Errno::ECONNREFUSED => e
-        true
-      end
-    end
-    
-    def write_url
-      File.open(url_file, 'w') {|f| f << url }
-    end
-    
-    def check_for_running
-      if File.exists?(pid_file) && File.exists?(url_file)
-        running_url = File.read(url_file)
-        if !port_open?(running_url)
-          logger.warn "#{app_name} is already running at #{running_url}"
-          launch!(running_url)
-          exit!
-        end
-      end
-    end
-    
-    def run!
-      rack_handler.run app, :Host => host, :Port => port do |server|
-        trap(kill_command) do
-          ## Use thins' hard #stop! if available, otherwise just #stop
-          server.respond_to?(:stop!) ? server.stop! : server.stop
-          logger.info "#{app_name} received INT ... stopping"
-          delete_pid!
-        end
-      end
-    end
-    
-    # Adapted from Rackup
-    def daemonize!
-      if RUBY_VERSION < "1.9"
-        logger.debug "Parent Process: #{Process.pid}"
-        exit! if fork
-        logger.debug "Child Process: #{Process.pid}"
-        Dir.chdir "/"
-        File.umask 0000
-        FileUtils.touch(log_file)
-        STDIN.reopen  log_file
-        STDOUT.reopen log_file, "a"
-        STDERR.reopen log_file, "a"
-      else
-        Process.daemon
-      end
-      logger.debug "Child Process: #{Process.pid}"
-
-      File.open(pid_file, 'w') {|f| f.write("#{Process.pid}") }
-      at_exit { delete_pid! }
-    end
-    
-    def launch!(specific_url = nil)
-      return if options[:skip_launch]
-      cmd = WINDOWS ? "start" : "sleep 2 && open"
-      system "#{cmd} #{specific_url || url}"
-    end
-    
-    def kill!
-      pid = File.read(pid_file)
-      logger.warn "Sending INT to #{pid.to_i}"
-      Process.kill(kill_command, pid.to_i)
-    rescue => e
-      logger.warn "pid not found at #{pid_file} : #{e}"
-    end
-    
-    def start
-      begin
-        launch!    
-        daemonize! unless options[:foreground]      
-        run!
-      rescue RuntimeError => e
-        logger.warn "There was an error starting #{app_name}: #{e}"
-        exit
-      end
-    end
-    
-    def status
-      if File.exists?(pid_file)
-        logger.info "#{app_name} running"
-        logger.info "PID #{File.read(pid_file)}"
-        logger.info "URL #{File.read(url_file)}" if File.exists?(url_file)
-      else
-        logger.info "#{app_name} not running!"
-      end
-    end
-
-    def logger
-      return @logger if @logger
-      @logger = Logger.new(STDOUT)
-      @logger.level     = options[:debug] ? Logger::DEBUG : Logger::INFO
-      @logger.formatter = Proc.new {|s, t, n, msg| "[#{t}] #{msg}\n"}
-      @logger
-    end
-    
-    private
-    def define_options
-      OptionParser.new("", 24, '  ') { |opts|
-        opts.banner = "Usage: #{app_name} [options]"
-
-        opts.separator ""
-        opts.separator "Vegas options:"
-                
-        opts.on("-s", "--server SERVER", "serve using SERVER (webrick/mongrel)") { |s|
-          @rack_handler = Rack::Handler.get(s)
-        }
-        
-        opts.on("-o", "--host HOST", "listen on HOST (default: #{HOST})") { |host|
-          @options[:host] = host
-        }
-
-        opts.on("-p", "--port PORT", "use PORT (default: #{PORT})") { |port|
-          @options[:port] = port
-        }
-
-        opts.on("-e", "--env ENVIRONMENT", "use ENVIRONMENT for defaults (default: development)") { |e|
-          @options[:environment] = e
-        }
-
-        opts.on("-F", "--foreground", "don't daemonize, run in the foreground") { |f|
-          @options[:foreground] = true
-        }
-
-        opts.on("-L", "--no-launch", "don't launch the browser") { |f|
-          @options[:skip_launch] = true
-        }
-
-        opts.on('-K', "--kill", "kill the running process and exit") {|k| 
-          kill!
-          exit
-        }
-        
-        opts.on('-S', "--status", "display the current running PID and URL then quit") {|s| 
-          status
-          exit!
-        }
-        
-        opts.on('-d', "--debug", "raise the log level to :debug (default: :info)") {|s| 
-          @options[:debug] = true
-        }
-                
-        yield opts if block_given?
-        
-        opts.separator ""
-        opts.separator "Common options:"
-
-        opts.on_tail("-h", "--help", "Show this message") do
-          puts opts
-          exit
-        end
-
-        opts.on_tail("--version", "Show version") do
-          if app.respond_to?(:version)
-            puts "#{app_name} #{app.version}"
-          end
-          puts "sinatra #{Sinatra::VERSION}"
-          puts "vegas #{Vegas::VERSION}"
-          exit
-        end
-
-        opts.parse! ARGV
-      }
-    rescue OptionParser::MissingArgument => e
-      logger.warn "#{e}, run -h for options"
-      exit
-    end
-    
-    def kill_command
-      WINDOWS ? 1 : :INT
-    end
-    
-    def delete_pid!
-      File.delete(pid_file) if File.exist?(pid_file)
-    end
-  end
-end

data/vendor/vegas/lib/vegas.rb

@@ -1,16 +0,0 @@
-begin
-  require 'sinatra'
-rescue LoadError
-  require 'rubygems'
-  require 'sinatra'
-end
-
-$LOAD_PATH.unshift File.dirname(__FILE__)
-
-module Vegas
-  VERSION = "0.0.4.1"
-  WINDOWS = !!(RUBY_PLATFORM =~ /(mingw|bccwin|wince|mswin32)/i)
-  
-  autoload :Runner, 'vegas/runner'
-end
-

data/vendor/vegas/test/test_app/bin/test_app

@@ -1,9 +0,0 @@
-#!/usr/bin/env ruby
-#
-#  Created on 2009-2-27.
-#  Copyright (c) 2009. All rights reserved.
-
-require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_app.rb'))
-require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'lib','vegas.rb'))
-
-Vegas::Runner.new(TestApp, 'test_app')

data/vendor/vegas/test/test_app/test_app.rb

@@ -1,10 +0,0 @@
-require 'rubygems'
-require 'sinatra'
-
-class TestApp < Sinatra::Base
-  
-  get '/' do
-    'This is a TEST'
-  end
-  
-end