grack 0.0.2 → 0.1.0.pre1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb383037da24ee5963414d2d7dee6cb496b602fe
+  data.tar.gz: df32f8f77576e5602c9d6e77970083b30fd69a9c
+SHA512:
+  metadata.gz: df02a597393545859f15d6c94136c4c61e9c291943ecc96d7271a62b21fa3d0bd45383a13b874db89c4bb0009fc2e333aac25c159f72052fc5f20a4bdbae779a
+  data.tar.gz: 711850b57b041acd41e2fa8809fb643549ac640ad1d358ccea47a97ebd41763b869ed39c8054f2da1e3f9a791b1d2bfbd2d524e4df4981967c8bcee144b7fb61

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.2.2
+script: bundle exec rake test

data/.yardopts

@@ -0,0 +1 @@
+--protected --private --main README.md lib/**/*.rb - NEWS.md LICENSE

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2015 Scott Chacon <schacon@gmail.com>
+
+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/NEWS.md

@@ -0,0 +1,19 @@
+# News and Notifications by Version
+
+This file lists noteworthy changes which may affect users of this project.  More
+detailed information is available in the rest of the documentation.
+
+**NOTE:** Date stamps in the following entries are in YYYY/MM/DD format.
+
+## v0.1.0.pre1 
+
+* Moved projects to [grackorg/grack](https://github.com/grackorg/grack)
+* Test release for major rewrite. See https://github.com/grackorg/grack/pull/3.
+
+## v0.0.2 (2012/10/10)
+
+* Fix the file list in the gem.
+
+## v0.0.1 (2012/10/10)
+
+* Birthday

data/README.md

@@ -0,0 +1,211 @@
+[![Gem Version](https://badge.fury.io/rb/grack.svg)](http://badge.fury.io/rb/grack)
+[![Build Status](https://travis-ci.org/grackorg/grack.svg?branch=master)](https://travis-ci.org/grackorg/grack)
+[![Dependency Status](https://gemnasium.com/grackorg/grack.svg)](https://gemnasium.com/grackorg/grack)
+
+# Grack - Ruby/Rack Git Smart HTTP Server Handler
+
+This project aims to replace the builtin git-http-backend CGI handler
+distributed with C Git with a Rack application.
+
+## Links
+
+* Homepage :: https://github.com/grackorg/grack
+* Source :: https://github.com/grackorg/grack.git
+
+## Description
+
+This project aims to replace the builtin git-http-backend CGI handler
+distributed with C Git with a Rack application. By default, Grack uses calls to
+git on the system to implement Smart HTTP. Since the git-http-backend is really
+just a simple wrapper for the upload-pack and receive-pack processes with the
+'--stateless-rpc' option, this does not actually re-implement very much.
+However, it is possible to use a different backend by specifying a different
+Adapter.
+
+The default git-http-backend only runs as a CGI script, and specifically is
+only targeted for Apache 2.x usage (it requires PATH_INFO to be set and
+specifically formatted).  So, instead of trying to get it to work with other
+CGI capable webservers (Lighttpd, etc), we can get it running on nearly every
+major and minor webserver out there by making it Rack capable.  Rack
+applications can run with the following handlers:
+
+* CGI
+* FCGI
+* Mongrel (and EventedMongrel and SwiftipliedMongrel)
+* WEBrick
+* SCGI
+* LiteSpeed
+* Thin
+
+These web servers include Rack handlers in their distributions:
+
+* Ebb
+* Fuzed
+* Phusion Passenger (which is mod_rack for Apache and for nginx)
+* Unicorn
+
+With [Warbler](http://caldersphere.rubyforge.org/warbler/classes/Warbler.html),
+and JRuby, we can also generate a WAR file that can be deployed in any Java web
+application server (Tomcat, Glassfish, Websphere, JBoss, etc).
+
+By default, Grack uses calls to git on the system to implement Smart HTTP.
+Since the git-http-backend is really just a simple wrapper for the upload-pack
+and receive-pack processes with the '--stateless-rpc' option, this does not
+actually re-implement very much. However, it is possible to use a different
+backend by specifying a different Adapter. See below for a list.
+
+Note that while it is technically possible to host non-bare repositories with
+this gem, it is discouraged.  The only somewhat safe option is to serve such a
+repository as read-only since there is a greater risk of arbitrary filesystem
+traversal when a checkout tree must be traversed to reach the repository
+administrative area (`.git` directory).  Additionally, any recent version of Git
+prevents pushes into non-bare repositories by default since pushing into the
+currently checked out branch can effectively "break" the checkout tree.
+
+### Git Adapters
+
+Grack makes calls to the git binary through the GitAdapter abstraction class.
+Grack can be made to use a different backend by specifying a call-able object,
+such as a lambda, in Grack's configuration that provides new adapter instances
+per request. For example:
+
+```ruby
+Grack::App.new(:git_adapter_factory => ->{ MyAdapter.new })
+```
+
+Alternative adapters available:
+* [rjgit_grack](http://github.com/dometto/rjgit_grack) lets Grack use the
+  [RJGit](http://github.com/repotag/rjgit) gem to implement Smart HTTP in pure
+  Jruby. (Currently requires use of backward compatibility support via
+  Grack::CompatibleGitAdapter)
+
+### Developing Adapters
+
+Adapters are abstraction classes that handle the actual implementation of the
+Smart HTTP protocol (advertising refs, uploading and receiving packfiles). Such
+abstraction classes must have the following methods:
+
+```ruby
+MyAdapter.repository_path=(repository_path)
+MyAdapter.exist?
+MyAdapter.handle_pack(kind, io_in, io_out, opts = {})
+MyAdapter.file(path)
+MyAdapter.update_server_info
+MyAdapter.allow_push?
+MyAdapter.allow_pull?
+```
+
+See `Grack::GitAdapter` for more detailed documentation and an example
+implementation.
+
+## Features
+
+* Supports Git Smart HTTP protocol.
+* Supports Git Basic HTTP protocol.
+* Limits push/pull access globally and per-repository.
+* Thread safe operation.
+
+## Known Bugs/Limitations
+
+* Will likely block fully evented web servers when using the stock Git adapter.
+
+## Synopsis
+
+In `config.ru`:
+
+```ruby
+require 'grack/app'
+require 'grack/git_adapter'
+
+config = {
+  :root => '/path/to/bare/repositories',
+  :allow_push => true,
+  :allow_pull => true,
+  :git_adapter_factory => ->{ GitAdapter.new }
+}
+
+run Grack::App.new(config)
+```
+
+Then run:
+
+```sh
+$ bundle exec rackup --host localhost --port 8080 config.ru
+$ git clone http://localhost:8080/your-repository.git
+```
+
+## Runtime Requirements
+
+* Ruby >=1.9.3
+* Git >=1.7 (if using the included Git adapter)
+* rack (>= 0)
+
+## Development Requirements
+
+* All runtime requirements
+* rake (>= 10.1.1, ~> 10.1)
+* rack-test (>= 0.6.3, ~> 0.6)
+* minitest (>= 5.8.0, ~> 5.8)
+* mocha (>= 1.1.0, ~> 1.1)
+* simplecov (>= 0.10.0, ~> 0.10)
+* yard (>= 0.8.7.3, ~> 0.8.7)
+* redcarpet (>= 3.1.0, ~> 3.1)
+* github-markup (>= 1.0.2, ~> 1.0)
+* pry (~> 0)
+
+## Contributing
+
+Contributions for bug fixes, documentation, extensions, tests, etc. are
+encouraged.
+
+1. Clone the repository.
+2. Fix a bug or add a feature.
+3. Add tests for the fix or feature.
+4. Make a pull request.
+
+## Development
+
+After checking out the source, run:
+
+```sh
+$ bundle install
+$ bundle exec rake test yard
+```
+
+This will install all dependencies, run the tests/specs, and generate the
+documentation.
+
+## Authors
+
+Thanks to all contributors.  Without your help this project would not exist.
+
+* Scott Chacon :: schacon@gmail.com
+* Dawa Ometto :: dawa.ometto@phil.uu.nl
+* Jeremy Bopp :: jeremy@bopp.net
+
+## License
+
+```
+(The MIT License)
+
+Copyright (c) 2015 Scott Chacon <schacon@gmail.com>
+
+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/Rakefile

@@ -0,0 +1,222 @@
+# encoding: UTF-8
+# -*- ruby -*-
+
+require 'erb'
+require 'rake/testtask'
+require 'rubygems/package_task'
+require 'rake/clean'
+require 'yard'
+
+# Load the gemspec file for this project.
+GEMSPEC = Dir['*.gemspec'].first
+SPEC = eval(File.read(GEMSPEC), nil, GEMSPEC)
+
+# A dynamically generated list of files that should match the manifest (the
+# combined contents of SPEC.files and SPEC.test_files).  The idea is for this
+# list to contain all project files except for those that have been explicitly
+# excluded.  This list will be compared with the manifest from the SPEC in order
+# to help catch the addition or removal of files to or from the project that
+# have not been accounted for either by an exclusion here or an inclusion in the
+# SPEC manifest.
+#
+# NOTE:
+# It is critical that the manifest is *not* automatically generated via globbing
+# and the like; otherwise, this will yield a simple comparison between
+# redundantly generated lists of files that probably will not protect the
+# project from the unintentional inclusion or exclusion of files in the
+# distribution.
+PKG_FILES = FileList.new(Dir.glob('**/*', File::FNM_DOTMATCH)) do |files|
+  # Exclude anything that doesn't exist as well as directories.
+  files.exclude {|file| ! File.exist?(file) || File.directory?(file)}
+  # Exclude Git administrative files.
+  files.exclude('.git/**/*', '**/.gitignore', '**/.gitmodule', '**/.gitkeep')
+  # Exclude editor swap/temporary files.
+  files.exclude('**/.*.sw?', '**/.sw?')
+  # Exclude the gemspec file.
+  files.exclude(GEMSPEC)
+  # Exclude the README template file.
+  files.exclude('README.md.erb')
+  # Exclude resources for bundler.
+  files.exclude('Gemfile', 'Gemfile.lock')
+  files.exclude(%r{^.bundle([/\\]|$)})
+  files.exclude(%r{^vendor/bundle([/\\]|$)})
+  # Exclude generated content, except for the README file.
+  files.exclude(%r{^(pkg|doc|coverage|.yardoc)([/\\]|$)})
+  # Exclude examples.
+  files.exclude('examples/**/*')
+  # Exclude Rubinius compiled Ruby files.
+  files.exclude('**/*.rbc')
+end
+
+# Make sure that :clean and :clobber will not whack the repository files.
+CLEAN.exclude('.git/**')
+# Vim swap files are fair game for clean up.
+CLEAN.include('**/.*.sw?')
+
+# Returns the value of the VERSION environment variable as a Gem::Version object
+# assuming it is set and a valid Gem version string.  Otherwise, raises an
+# exception.
+def get_version_argument
+  version = ENV['VERSION']
+  if version.to_s.empty?
+    raise "No version specified: Add VERSION=X.Y.Z to the command line"
+  end
+  begin
+    Gem::Version.create(version.dup)
+  rescue ArgumentError
+    raise "Invalid version specified in `VERSION=#{version}'"
+  end
+end
+
+# Performs an in place, per line edit of the file indicated by _path_ by calling
+# the sub method on each line and passing _pattern_, _replacement_, and _b_ as
+# arguments.
+def file_sub(path, pattern, replacement = nil, &b)
+  tmp_path = "#{path}.tmp"
+  File.open(path) do |infile|
+    File.open(tmp_path, 'w') do |outfile|
+      infile.each do |line|
+        outfile.write(line.sub(pattern, replacement, &b))
+      end
+    end
+  end
+  File.rename(tmp_path, path)
+end
+
+# Updates the version string in the gemspec file to the string in _version_.
+def set_version(version)
+  file_sub(GEMSPEC, /(\.version\s*=\s*).*/, "\\1'#{version}'")
+end
+
+# Returns a string that is line wrapped at word boundaries, where each line is
+# no longer than _line_width_ characters.
+#
+# This is mostly lifted directly from ActionView::Helpers::TextHelper.
+def word_wrap(text, line_width = 80)
+  text.split("\n").collect do |line|
+    line.length > line_width ?
+      line.gsub(/(.{1,#{line_width}})(\s+|$)/, "\\1\n").strip :
+      line
+  end * "\n"
+end
+
+desc 'Alias for build:gem'
+task :build => 'build:gem'
+
+# Build related tasks.
+namespace :build do
+  # Create the gem and package tasks.
+  Gem::PackageTask.new(SPEC).define
+
+  # Ensure that the manifest is consulted when building the gem.  Any
+  # generated/compiled files should be available at that time.
+  task :gem => :check_manifest
+
+  desc 'Verify the manifest'
+  task :check_manifest do
+    manifest_files = (SPEC.files + SPEC.test_files).sort.uniq
+    pkg_files = PKG_FILES.sort.uniq
+    if manifest_files != pkg_files then
+      common_files = manifest_files & pkg_files
+      manifest_files -= common_files
+      pkg_files -= common_files
+      message = ["The manifest does not match the automatic file list."]
+      unless manifest_files.empty? then
+        message << "  Extraneous files:\n    " + manifest_files.join("\n    ")
+      end
+      unless pkg_files.empty?
+        message << "  Missing files:\n    " + pkg_files.join("\n    ")
+      end
+      raise message.join("\n")
+    end
+  end
+
+  # Creates the README.md file from its template and other sources.
+  file 'README.md' => ['README.md.erb', 'LICENSE', GEMSPEC] do
+    spec = SPEC
+    File.open('README.md', 'w') do |readme|
+      readme.write(
+        ERB.new(File.read('README.md.erb'), nil, '-').result(binding)
+      )
+    end
+  end
+end
+
+# Ensure that the clobber task also clobbers package files.
+task :clobber => 'build:clobber_package'
+
+# Create the documentation task.
+YARD::Rake::YardocTask.new
+# Ensure that the README file is (re)generated first.
+task :yard => 'README.md'
+
+# Gem related tasks.
+namespace :gem do
+  desc 'Alias for build:gem'
+  task :build => 'build:gem'
+
+  desc 'Publish the gemfile'
+  task :publish => ['version:check', :test, 'repo:tag', :build] do
+    sh "gem push pkg/#{SPEC.name}-#{SPEC.version}*.gem"
+  end
+end
+
+Rake::TestTask.new do |t|
+  t.pattern = 'tests/**/*_test.rb'
+end
+
+# Version string management tasks.
+namespace :version do
+  desc 'Set the version for the project to a specified version'
+  task :set do
+    set_version(get_version_argument)
+  end
+
+  desc 'Set the version for the project back to 0.0.0'
+  task :reset do
+    set_version('0.0.0')
+  end
+
+  desc 'Check that all version strings are correctly set'
+  task :check => ['version:check:spec', 'version:check:news']
+
+  namespace :check do
+    desc 'Check that the version in the gemspec is correctly set'
+    task :spec do
+      version = get_version_argument
+      if version != SPEC.version
+        raise "The given version `#{version}' does not match the gemspec version `#{SPEC.version}'"
+      end
+    end
+
+    desc 'Check that the NEWS.md file mentions the version'
+    task :news do
+      version = get_version_argument
+      begin
+        File.open('NEWS.md') do |news|
+          unless news.each_line.any? {|l| l =~ /^## v#{Regexp.escape(version.to_s)} /}
+            raise "The NEWS.md file does not mention version `#{version}'"
+          end
+        end
+      rescue Errno::ENOENT
+        raise 'No NEWS.md file found'
+      end
+    end
+  end
+end
+
+# Repository and workspace management tasks.
+namespace :repo do
+  desc 'Tag the current HEAD with the version string'
+  task :tag => :check_workspace do
+    version = get_version_argument
+    sh "git tag -s -m 'Release v#{version}' v#{version}"
+  end
+
+  desc 'Ensure the workspace is fully committed and clean'
+  task :check_workspace => ['README.md'] do
+    unless `git status --untracked-files=all --porcelain`.empty?
+      raise 'Workspace has been modified.  Commit pending changes and try again.'
+    end
+  end
+end