ginatra 3.0.1 → 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: da7d713fca1a0a2164d09c4af9e0e68446f24e3b
+  data.tar.gz: 5dc258e8d928ba24192294dabc70be2b6555a124
+SHA512:
+  metadata.gz: 9f724bc83773853892f4250f32858751dbc690ff629c0829c18cbb354affa9047557dfbfece6c1c3d39188cd291621c778540940a7629a9a6d4e55b4b20ca908
+  data.tar.gz: b8da76765605a82e326d2c4722644c49614934cda7a555758d3ff5dcf040e921a14a20250667282d7791fb4d0bafa2742bc1eabd8989c824872a35c1f6b1efa5

data/.gitignore

@@ -1,16 +1,19 @@
-repos/*/
-public/*.esproj
-tmp/*
-.DS_Store
-*.log
-webrat*
-spec/*.html
-public/*.html
-_site/
-_layouts/
-**/*.swp
-*.swp
+*.gem
+*.rbc
+.bundle
+.config
 .yardoc
-doc/*
-pkg/*
-Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+repos/
+config.yml

data/.travis.yml

@@ -1,7 +1,8 @@
----
 rvm:
-- 1.9.2
-script: "bundle exec rake spec"
-before_script:
-- "bundle exec ./bin/ginatra setup"
-- "bundle exec rake repo"
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+notifications:
+  email:
+    on_success: never # default: change
+    on_failure: change # default: always

data/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# How to contribute
+
+In the spirit of open source software, **everyone** is encouraged to help
+improve this project.
+
+## Your Pull Request
+
+To make it easy to review and understand your change please keep the following
+things in mind before submitting your pull request:
+
+* Work on the latest possible state of **ginatra/master**
+* Create a branch which is dedicated to your change
+* Test your changes before creating a pull request (`bundle exec rake`)
+* If possible write a test case which confirms your change
+* Don't mix several features or bug-fixes in one pull request
+* Create a meaningful commit message
+* Explain your change (i.e. with a link to the issue you are fixing)
+* Keep it simple: don't overcomplicate things and add extra dependencies unless
+  you have a *special* reason
+
+**IMPORTANT**:
+
+Before you start working on a larger contribution, you should get in touch first
+through the issue tracker with your idea so that the project's developers can
+help out and possibly guide you. Coordinating up front makes it much easier to
+avoid frustration later on.
+
+# Thank you
+
+Each contribution is extremely helpful - thank you!

data/Gemfile

@@ -1,11 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec
-
-group :development, :test do
-  gem "rake"
-  gem "rspec"
-  gem "webrat"
-  gem "rack-test"
-  gem "cucumber"
-end

data/LICENSE.txt

@@ -0,0 +1,30 @@
+Copyright (c) 2009-2012 Samuel Elliott
+Copyright (c) 2012-2015 Nihad Abbasov
+
+MIT License
+
+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.
+
+---
+
+Contains data from external sources:
+
+depuracao/git-webby (https://github.com/depuracao/git-webby)
+  license: https://github.com/depuracao/git-webby/blob/master/LICENSE.txt

data/README.md

@@ -1,149 +1,98 @@
 # Ginatra
-[![](http://stillmaintained.com/lenary/ginatra.png)](http://stillmaintained.com/lenary/ginatra)
 
-[![](http://travis-ci.org/lenary/ginatra.png)](http://travis-ci.org/lenary/ginatra)
+[![Build Status](https://img.shields.io/travis/NARKOZ/ginatra/master.svg?style=flat)](https://travis-ci.org/NARKOZ/ginatra)
+[![Code Climate](https://img.shields.io/codeclimate/github/NARKOZ/ginatra.svg?style=flat)](https://codeclimate.com/github/NARKOZ/ginatra)
+[![Gem Version](https://img.shields.io/gem/v/ginatra.svg?style=flat)](https://rubygems.org/gems/ginatra)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/NARKOZ/ginatra/blob/master/LICENSE.txt)
 
+**Ginatra** is a simple web-based git repository browser built on Ruby Sinatra.
 
-This project  is to make a  clone of gitweb in  Ruby and Sinatra. It  serves git
-repositories out of a set of  specified directories using an array of glob-based
-paths. I have plans to make it  function just as gitweb does, including leeching
-config files and suchlike.
+[ [website](http://narkoz.github.io/ginatra) |
+[screenshots](http://narkoz.github.io/ginatra/screenshots) ]
 
-Installation
-------------
+## Features
 
-**NEW: You should be using Ruby 1.9.2: because it's awesome!**
++ Hassle free installation
++ Multiple repository support
++ Multiple branch/tag support
++ Commit history, diff, patch
++ Feeds in Atom format
++ Syntax highlighting
++ Repository stats
++ Smart HTTP support
++ [and more](http://narkoz.github.io/ginatra#features)
 
-To install ginatra:
+## Installation
 
-    $ gem install ginatra
-    ...
-    $ ginatra setup
-    checked deps
-    installed config
+There are 2 ways to install Ginatra: as a packaged Ruby gem or as a Sinatra app.  
+It's recommended to install it as a ruby gem, unless you know what you're doing.
 
-If you get those two lines of output, you're sorted. anything else and something
-has gone wrong.
+### Ginatra gem
 
-### External Dependencies
+Run the following command to install Ginatra from RubyGems:
 
-You should be using Git 1.6.3 or later just to be sure that it all works:
+```sh
+gem install ginatra -v 4.0.0
+```
 
-    $ git --version
-    git version 1.6.3
+Create config file (see [Configuration](#configuration) section in README).
 
-The other dependency you need is pygments, an awesome python syntax highlighter.
-To check whether you have it, run:
+Start the Ginatra server:
 
-    $ which pygmentize
+```sh
+ginatra run
+```
 
-If this returns a path pointing to a 'pygmentize' binary, then you're all set.
-If not you'll need to install pygments. Look at the last section of the
-[jekyll wiki "install" page](http://wiki.github.com/mojombo/jekyll/install)
-to see how to install it. Also make sure again that the `pygmentize` binary
-is on your path.
+By default Ginatra will run on `localhost:9797`
 
-If you want to play around with the code, you can clone the repository. This also allows you
-to use a special rackup file to mount it where you wish. I am yet to sort out some of the
-details of running Ginatra from a gem with a rackup.ru file.
+### Ginatra app
 
-Usage
------
+Run the following commands to install Ginatra from source:
 
-If you're just using it in development, use the following to start, check and stop Ginatra
-respectively:
+```sh
+git clone git://github.com/NARKOZ/ginatra.git
+cd ginatra/
+bundle
+```
 
-    $ ginatra server start
-    $ ginatra server status
-    $ ginatra server stop
+Create config file or modify existing (see [Configuration](#configuration) section in README).
 
-Ginatra  also runs  on thin, with the approach outlined above.
+Start the Ginatra server:
 
-**BEWARE:** There are issues running Ginatra on Passenger. We discourage Ginatra's use
-on Passenger until we can make it stable.
+```sh
+./bin/ginatra run
+```
 
-Ginatra can also start a git-daemon serving all the repositories that ginatra serves:
+By default Ginatra will run on `localhost:9797`
 
-    $ ginatra daemon start
-    $ ginatra daemon status
-    $ ginatra daemon stop
+## Configuration
 
-This runs on the default git daemon port.
+Create `~/.ginatra/config.yml` file with your own settings. See
+[`config.yml`](https://github.com/NARKOZ/ginatra/blob/master/config.yml) for a reference.
 
-You can add a glob specified list of git repositories for ginatra to serve using the
-following commands:
+`git_dirs` - Ginatra will look into these folders for git repositories. It's
+required to append `*` at the end of path. Example: `/home/Development/repos/*`
 
-    $ ginatra directory add '~/Git/ginatra/*'
-    $ ginatra directory list
-    $ ginatra directory remove '~/Git/ginatra/*'
+`ignored_files` - files to ignore in `git_dirs`
 
-These should be fairly self explanatory. Help is shown with either the --help option
-or by not specifying a sub-command like start, status, stop, add, list or remove.
+`description` - description of web interface. Used in index page.
 
+`port` - port that Ginatra server will run at.
 
-Attribution
------------
+`host` - host that Ginatra server will run at.
 
-**Authors:**
+`prefix` - prefix for the host serving Ginatra. Used when Ginatra is installed
+in subdirectory.
 
-- Samuel Elliott (lenary)
-- Ryan Bigg (radar)
-- Jan Topiński (simcha)
+`git_clone_enabled?` - enables smart HTTP support and allows to clone git
+repopsitories.
 
-**Patches**
+If you installed Ginatra as an app, you can change settings by editing
+`config.yml` file in root folder.
 
-- James Tucker (raggi)
-- Elia Schito (elia)
-- Scott Wisely (Syd)
-- Jonathan Stott (namelessjon)
-- Michael James (umjames)
+You need to restart web server after applying changes to config file.
 
-In a new spirit of openness, all those who submit a patch that gets applied will gain commit access to the main (lenary/ginatra) repository.
+## How to Contribute
 
-Screenshots
------------
-
-**Index**
-
-![Ginatra Index](http://cloud.github.com/downloads/lenary/ginatra/o%20\(5\).png "Ginatra Index")
-
-**Log**
-
-![Ginatra Log](http://cloud.github.com/downloads/lenary/ginatra/o%20\(3\).png "Ginatra Log")
-
-**Commit**
-
-![Ginatra Commit](http://cloud.github.com/downloads/lenary/ginatra/o%20\(4\).png "Ginatra Commit")
-
-**Tree**
-
-![Ginatra Tree](http://cloud.github.com/downloads/lenary/ginatra/o%20\(2\).png "Ginatra Tree")
-
-**Branch graph**
-
-![Branch graph](http://cloud.github.com/downloads/simcha/ginatra/branch-graph.png "Branch Graph")
-
-
-Licence
--------
-
-The MIT License
-
-Copyright (c) 2009 Samuel Elliott
-
-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.
+Open issues are labeled per perceived difficulty. See [contributing
+guidelines](https://github.com/NARKOZ/ginatra/blob/master/CONTRIBUTING.md).

data/Rakefile

@@ -1,19 +1,17 @@
-require "bundler"
-Bundler.setup(:default, :development)
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-task :default => ['rake:spec']
-
-desc "Clones the Test Repository"
-task :repo do |t|
-  FileUtils.cd(File.join(File.dirname(__FILE__), "repos")) do
+desc "Clone test repository"
+task :clone_repo do
+  repos_dir = File.expand_path('./repos')
+  FileUtils.cd(repos_dir) do
     puts `git clone git://github.com/atmos/hancock-client.git test`
-  end
+  end unless Dir.exists?("#{repos_dir}/test")
 end
 
-desc "Runs the RSpec Test Suite"
-RSpec::Core::RakeTask.new(:spec) do |r|
-  r.pattern = 'spec/*_spec.rb'
-  r.rspec_opts = ['--color']
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern    = FileList['spec/**/*_spec.rb']
+  spec.rspec_opts = ['--color']
 end
 
+task default: ['clone_repo', 'spec']

data/bin/ginatra

@@ -1,78 +1,94 @@
 #!/usr/bin/env ruby
 
-module Ginatra
-  module Executable
-    HELP = <<-HELP
-Usage: ginatra [ setup |
-                 version |
-                 server <options> <command> |
-                 daemon <command> |
-                 directory <command> <globs> ]
-
-Ginatra Commands:
-  setup   - Checks Dependencies and Installs Configuration
-  version - Pretty Self explanatory. Print version number and exit
-
-Ginatra Server Commands:
-  start   - Start the Ginatra HTTP Server.
-  stop    - Stop the Ginatra Server.
-  status  - How's your Ginatra Server holding up?
-
-Ginatra Daemon Commands:
-  start   - Starts the Git Daemon servimg Ginatra's Repositories
-  stop    - Stops the Git Daemon
-  restart - Restarts the Git Daemon
-  status  - Is the Git Daemon on or off?
-
-
-Ginatra Directory Commands:
-  add     - Adds the <globs> to the array of dirs that Ginatra
-              looks in for repositories.
-  remove  - Removes the <globs> from the aforementioned array.
-  list    - Lists the globs Ginatra looks in for repositories
-
-    HELP
-
-    def self.daemon
-      path = File.expand_path(File.dirname(__FILE__))
-      load "#{path}/ginatra-daemon"
-    end
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'ginatra'
+require 'optparse'
+
+options = {
+  port: Ginatra.config.port,
+  host: Ginatra.config.host
+}
+
+global_opts = OptionParser.new do |opts|
+  opts.banner = "Usage: ginatra <options> <command>"
+
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on('-v', '--version', 'Print version and exit') do
+    require_relative '../lib/ginatra/version'
+    puts "Ginatra #{Ginatra::VERSION} #{Ginatra::RELEASE_NAME}"
+    exit
+  end
+
+  opts.on_tail('-h', '--help', 'Show this help message') do
+    puts opts
+    exit
+  end
+end
+
+server_opts = {
+  'run' => OptionParser.new do |opts|
+    opts.banner = "Usage: ginatra run <options>"
 
-    def self.directory
-      path = File.expand_path(File.dirname(__FILE__))
-      load "#{path}/ginatra-directory"
+    opts.separator ""
+    opts.separator "Options:"
+
+    opts.on('-p', '--port PORT', 'Port to bind to (defaults from config file)') do |port|
+      options[:port] = port.to_i
     end
 
-    def self.server
-      path = File.expand_path(File.dirname(__FILE__))
-      load("#{path}/ginatra-server")
+    opts.on('-h', '--host HOST', 'Host address to bind to (defaults from config file)') do |host|
+      options[:host] = host
     end
 
-    def self.setup
-      path = File.expand_path(File.dirname(__FILE__))
-      load("#{path}/ginatra-setup")
+    opts.on 'Start Ginatra web server' do
+      environment = ENV['RACK_ENV'] || 'production'
+      rack_config = File.expand_path("#{__FILE__}/../../config.ru")
+      pid_file    = File.expand_path("#{__FILE__}/../../ginatra.pid")
+
+      system "rackup -D -E #{environment} -P #{pid_file} -p #{options[:port]} -o #{options[:host]} #{rack_config}"
+      puts "Ginatra runs on #{options[:host]}:#{options[:port]}"
     end
+  end,
+
+  'stop' => OptionParser.new do |opts|
+    opts.banner = "Usage: ginatra stop"
 
-    def self.execute(command, args)
-      case command
-      when "version"
-        require "ginatra"
-        puts Ginatra::VERSION
-      when "setup"
-        setup
-      when "daemon"
-        daemon
-      when "directory"
-        directory
-      when "server"
-        server
-      else
-        puts Ginatra::Executable::HELP
+    opts.on 'Stop Ginatra web server' do
+      pid_file = File.expand_path("#{__FILE__}/../../ginatra.pid")
+
+      if File.exist?(pid_file)
+        pid = File.read(pid_file)
+        Process.kill('INT', pid.to_i)
+        File.delete(pid_file)
+        puts "Stopped Ginatra web server"
       end
     end
+  end,
+
+  'status' => OptionParser.new do |opts|
+    opts.banner = "Usage: ginatra status"
+
+    opts.on 'Get status of Ginatra web server' do
+      pid_file = File.expand_path("#{__FILE__}/../../ginatra.pid")
+      status = File.exist?(pid_file) ? "running.. (pid: #{File.read(pid_file).to_i})" : 'NOT running'
+      puts "Ginatra is #{status}"
+    end
   end
-end
+}
 
-Ginatra::Executable.execute ARGV.shift, ARGV
+if ARGV.size.zero?
+  puts global_opts
 
+  %w(run stop status).each do |cmd|
+    puts
+    puts server_opts[cmd]
+  end
+
+  exit 1
+end
 
+global_opts.order!
+server_opts[ARGV.shift].order!