grack 0.1.0.pre2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 871dc948470e8c1dfc7615bfe4579915c4596204
-  data.tar.gz: 8adad4b912101741254af438d7e626e1f78780e5
+  metadata.gz: d654736655d180b4cb314efc2e4ff7bd90a8c6f6
+  data.tar.gz: d4568e2683c496fdfcccf1acda3f7cb2f2e01b2b
 SHA512:
-  metadata.gz: 4eda2933722fe14e321b970d622fd2caea9f7d3ceab6f68c07244ee203adaea0f9f06806e613322bd5174cc3e659a1ef827387c1c64f55d359fc9c4f49df86c5
-  data.tar.gz: 067b85e420b42ba33164c67fcef5687bac03a07aaa53a1ae90893da10dfea7a5952ad7d8944d156b6785d0a0b8b1c7b21f4c0cdf0974272d45a9bd0454544b44
+  metadata.gz: ef0f1eaf267bf0ba8ad19a93e296120be2042e4c808653fd04902b9ecc8803633083dee405b510e32f708cf585963045d24901c68a3af2e2a28d21b8d5fb1bc8
+  data.tar.gz: 60cc1821166972428122d8d0600fb550a56ed83fcb1c8b952116eb3b8d2dfef00da75241ad5fddd09ce883a69eedd9575b628ba8d1914617105b9e8d12111a48

data/NEWS.md

@@ -5,6 +5,11 @@ 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 (2016/04/30)
+
+* Removed compatibility layer for version 0.0.x. Please use the configuration parameters specified in the README and update your adapters.
+* Fix tests for git > 2.7
+
 ## v0.1.0.pre2
 
 * Minor change required for new version [rjgit adapter](https://github.com/grackorg/rjgit_grack) to work

data/README.md

@@ -63,6 +63,31 @@ 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.
 
+## 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 => ->{ Grack::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
+```
+
 ### Git Adapters
 
 Grack makes calls to the git binary through the GitAdapter abstraction class.
@@ -77,8 +102,7 @@ Grack::App.new(:git_adapter_factory => ->{ MyAdapter.new })
 Alternative adapters available:
 * [rjgit_grack](http://github.com/grackorg/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)
+  JRuby.
 
 ### Developing Adapters
 
@@ -106,34 +130,17 @@ implementation.
 * Limits push/pull access globally and per-repository.
 * Thread safe operation.
 
-## Known Bugs/Limitations
+### Hooks
 
-* Will likely block fully evented web servers when using the stock Git adapter.
+By default, grack doesn't support git hooks. This is because the default GitAdapter directly streams the requests to the `git-receive-pack` and `git-upload-pack` processes. However, alternative adapters may implement hooks.
 
-## Synopsis
+Adapters that support hooks:
 
-In `config.ru`:
+* [rjgit_grack](http://github.com/grackorg/rjgit_grack)
 
-```ruby
-require 'grack/app'
-require 'grack/git_adapter'
-
-config = {
-  :root => '/path/to/bare/repositories',
-  :allow_push => true,
-  :allow_pull => true,
-  :git_adapter_factory => ->{ Grack::GitAdapter.new }
-}
-
-run Grack::App.new(config)
-```
-
-Then run:
+## Known Bugs/Limitations
 
-```sh
-$ bundle exec rackup --host localhost --port 8080 config.ru
-$ git clone http://localhost:8080/your-repository.git
-```
+* Will likely block fully evented web servers when using the stock Git adapter.
 
 ## Runtime Requirements
 
@@ -181,7 +188,7 @@ documentation.
 Thanks to all contributors.  Without your help this project would not exist.
 
 * Scott Chacon :: schacon@gmail.com
-* Dawa Ometto :: dawa.ometto@phil.uu.nl
+* Dawa Ometto :: d.ometto@gmail.com
 * Jeremy Bopp :: jeremy@bopp.net
 
 ## License

data/lib/grack/app.rb

@@ -47,8 +47,6 @@ module Grack
     # @option opts [#call] :git_adapter_factory (->{ GitAdapter.new }) a
     #   call-able object that creates Git adapter instances per request.
     def initialize(opts = {})
-      opts = convert_old_opts(opts)
-
       @root                = Pathname.new(opts.fetch(:root, '.')).expand_path
       @allow_push          = opts.fetch(:allow_push, nil)
       @allow_pull          = opts.fetch(:allow_pull, nil)
@@ -437,46 +435,5 @@ module Grack
       }
     end
 
-    ##
-    # Converts old configuration settings to current ones.
-    #
-    # @param [Hash] opts an options hash to convert.
-    # @option opts [String] :project_root a directory path containing 1 or more
-    #   Git repositories.
-    # @option opts [Boolean, nil] :receivepack determines whether or not to
-    #   allow pushes into the repositories.  +nil+ means to defer to the
-    #   requested repository.
-    # @option opts [Boolean, nil] :uploadpack determines whether or not to
-    #   allow fetches/pulls from the repositories.  +nil+ means to defer to the
-    #   requested repository.
-    # @option opts [#create] :adapter a class that provides an interface for
-    #   interacting with Git repositories.
-    #
-    # @return an options hash with current options set based on old ones.
-    def convert_old_opts(opts)
-      opts = opts.dup
-
-      if opts.key?(:project_root) && ! opts.key?(:root)
-        opts[:root] = opts.fetch(:project_root)
-      end
-      if opts.key?(:upload_pack) && ! opts.key?(:allow_pull)
-        opts[:allow_pull] = opts.fetch(:upload_pack)
-      end
-      if opts.key?(:receive_pack) && ! opts.key?(:allow_push)
-        opts[:allow_push] = opts.fetch(:receive_pack)
-      end
-      if opts.key?(:adapter) && ! opts.key?(:git_adapter_factory)
-        adapter = opts.fetch(:adapter)
-        opts[:git_adapter_factory] =
-          if GitAdapter == adapter
-            ->{ GitAdapter.new(opts.fetch(:git_path, 'git')) }
-          else
-            require 'grack/compatible_git_adapter'
-            ->{ CompatibleGitAdapter.new(adapter.new) }
-          end
-      end
-
-      opts
-    end
   end
 end

data/tests/app_test.rb

@@ -406,64 +406,6 @@ class AppTest < Minitest::Test
     assert_equal 404, r.status
   end
 
-  def test_config_project_root_used_when_root_not_set
-    session = Rack::Test::Session.new(
-      App.new(:project_root => repositories_root)
-    )
-
-    session.get "#{example_repo_urn}/info/refs"
-    assert_equal 200, session.last_response.status
-  end
-
-  def test_config_project_root_ignored_when_root_is_set
-    session = Rack::Test::Session.new(
-      App.new(:project_root => 'unlikely/path', :root => repositories_root)
-    )
-
-    session.get "#{example_repo_urn}/info/refs"
-    assert_equal 200, session.last_response.status
-  end
-
-  def test_config_upload_pack_used_when_allow_pull_not_set
-    session = Rack::Test::Session.new(
-      App.new(:root => repositories_root, :upload_pack => false)
-    )
-
-    session.get "#{example_repo_urn}/info/refs?service=git-upload-pack"
-    assert_equal 403, session.last_response.status
-  end
-
-  def test_config_upload_pack_ignored_when_allow_pull_is_set
-    session = Rack::Test::Session.new(
-      App.new(
-        :root => repositories_root, :upload_pack => true, :allow_pull => false
-      )
-    )
-
-    session.get "#{example_repo_urn}/info/refs?service=git-upload-pack"
-    assert_equal 403, session.last_response.status
-  end
-
-  def test_config_receive_pack_used_when_allow_push_not_set
-    session = Rack::Test::Session.new(
-      App.new(:root => repositories_root, :receive_pack => false)
-    )
-
-    session.get "#{example_repo_urn}/info/refs?service=git-receive-pack"
-    assert_equal 403, session.last_response.status
-  end
-
-  def test_config_receive_pack_ignored_when_allow_push_is_set
-    session = Rack::Test::Session.new(
-      App.new(
-        :root => repositories_root, :receive_pack => true, :allow_push => false
-      )
-    )
-
-    session.get "#{example_repo_urn}/info/refs?service=git-receive-pack"
-    assert_equal 403, session.last_response.status
-  end
-
   def test_config_adapter_with_GitAdapter
     session = Rack::Test::Session.new(
       App.new(:root => repositories_root, :adapter => GitAdapter)
@@ -476,16 +418,26 @@ class AppTest < Minitest::Test
 
   def test_config_adapter_with_custom_adapter
     git_adapter = mock('git_adapter')
+    git_adapter.
+      expects(:exist?).
+      returns(true)
+    git_adapter.
+      expects(:repository_path=).
+      returns(true)
     git_adapter.
       expects(:update_server_info).
-      with("#{repositories_root}#{example_repo_urn}")
+      returns(true)
+    git_adapter.
+      expects(:file).
+      with('info/refs').
+      returns(FileStreamer.new(Tempfile.new('foo')))
     git_adapter_class = mock('git_adapter_class')
     git_adapter_class.expects(:new).with.returns(git_adapter)
     session = Rack::Test::Session.new(
       App.new(
         :root => repositories_root,
         :allow_pull => true,
-        :adapter => git_adapter_class
+        :git_adapter_factory => -> { git_adapter_class.new }
       )
     )
 

data/tests/git_adapter_test.rb

@@ -12,7 +12,7 @@ require 'grack/git_adapter'
 class GitAdapterTest < Minitest::Test
   include Grack
 
-  GIT_RECEIVE_RESPONSE = %r{\A001b# service=receive-pack\n0000[0-9a-f]{4}cb067e06bdf6e34d4abebf6cf2de85d65a52c65e refs/heads/master\000\s*report-status delete-refs side-band-64k quiet ofs-delta.*\n0000\z}
+  GIT_RECEIVE_RESPONSE = %r{\A001b# service=receive-pack\n0000[0-9a-f]{4}cb067e06bdf6e34d4abebf6cf2de85d65a52c65e refs/heads/master\000\s*report-status delete-refs side-band-64k quiet (atomic )?ofs-delta.*\n0000\z}
 
   def git_config_set(name, value)
     system(git_path, 'config', '--local', name, value, :chdir => example_repo)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grack
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre2
+  version: 0.1.0
 platform: ruby
 authors:
 - Scott Chacon
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-22 00:00:00.000000000 Z
+date: 2016-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -210,7 +210,7 @@ description: |
   Adapter.
 email:
 - schacon@gmail.com
-- dawa.ometto@phil.uu.nl
+- d.ometto@gmail.com
 - jeremy@bopp.net
 executables: []
 extensions: []
@@ -225,12 +225,10 @@ files:
 - lib/git_adapter.rb
 - lib/grack.rb
 - lib/grack/app.rb
-- lib/grack/compatible_git_adapter.rb
 - lib/grack/file_streamer.rb
 - lib/grack/git_adapter.rb
 - lib/grack/io_streamer.rb
 - tests/app_test.rb
-- tests/compatible_git_adapter_test.rb
 - tests/example/_git/COMMIT_EDITMSG
 - tests/example/_git/HEAD
 - tests/example/_git/config
@@ -276,9 +274,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -288,7 +286,6 @@ summary: This project aims to replace the builtin git-http-backend CGI handler d
   with C Git with a Rack application.
 test_files:
 - tests/app_test.rb
-- tests/compatible_git_adapter_test.rb
 - tests/example/_git/COMMIT_EDITMSG
 - tests/example/_git/HEAD
 - tests/example/_git/config

data/lib/grack/compatible_git_adapter.rb

@@ -1,99 +0,0 @@
-require 'pathname'
-
-require 'grack/file_streamer'
-
-module Grack
-  ##
-  # @deprecated Upgrade to a Git adapter implementation that implements the new
-  #   interface.
-  #
-  # A Git adapter adapter (yes an adapter for an adapter) that allows old-style
-  # Git adapter classes to be used.
-  class CompatibleGitAdapter
-    ##
-    # Creates a new instance of this adapter.
-    #
-    # @param [GitAdapter-like] adapter an old-style Git adapter instance to
-    #   wrap.
-    def initialize(adapter)
-      @adapter = adapter
-    end
-
-    ##
-    # The path to the repository on which to operate.
-    attr_reader :repository_path
-
-    ##
-    # Sets the path to the repository on which to operate.
-    def repository_path=(path)
-      @repository_path = Pathname.new(path)
-    end
-
-    ##
-    # @return [Boolean] +true+ if the repository exists; otherwise, +false+.
-    def exist?
-      repository_path.exist?
-    end
-
-    ##
-    # Process the pack file exchange protocol.
-    #
-    # @param [String] pack_type the type of pack exchange to perform.
-    # @param [#read] io_in a readable, IO-like object providing client input
-    #   data.
-    # @param [#write] io_out a writable, IO-like object sending output data to
-    #   the client.
-    # @param [Hash] opts options to pass to the Git adapter's #handle_pack
-    #   method.
-    # @option opts [Boolean] :advertise_refs (false)
-    def handle_pack(pack_type, io_in, io_out, opts = {})
-      msg = ''
-      msg = io_in.read unless opts[:advertise_refs]
-
-      @adapter.send(
-        pack_type.sub(/^git-/, '').gsub('-', '_').to_sym,
-        repository_path.to_s,
-        opts.merge(:msg => msg)
-      ) do |result|
-        while chunk = result.read(8192) do
-          io_out.write(chunk)
-        end
-      end
-    end
-
-    ##
-    # Returns an object suitable for use as a Rack response body to provide the
-    # content of a file at _path_.
-    # 
-    # @param [Pathname] path the path to a file within the repository.
-    #
-    # @return [FileStreamer] a Rack response body that can stream the file
-    #   content at _path_.
-    # @return [nil] if _path_ does not exist.
-    def file(path)
-      full_path = @repository_path + path
-      return nil unless full_path.exist?
-      FileStreamer.new(full_path)
-    end
-
-    ##
-    # Triggers generation of data necessary to service Git Basic HTTP clients.
-    #
-    # @return [void]
-    def update_server_info
-      @adapter.update_server_info(repository_path.to_s)
-    end
-
-    ##
-    # @return [Boolean] +true+ if pushes should be allowed; otherwise; +false+.
-    def allow_push?
-      @adapter.get_config_setting('receivepack') == 'true'
-    end
-
-    ##
-    # @return [Boolean] +true+ if pulls should be allowed; otherwise; +false+.
-    def allow_pull?
-      @adapter.get_config_setting('uploadpack') != 'false'
-    end
-  end
-end

data/tests/compatible_git_adapter_test.rb

@@ -1,137 +0,0 @@
-require_relative 'test_helper'
-
-require 'minitest/autorun'
-require 'minitest/unit'
-require 'mocha/setup'
-require 'pathname'
-require 'stringio'
-
-require 'grack/compatible_git_adapter'
-
-class CompatibleGitAdapterTest < Minitest::Test
-  include Grack
-
-  def test_receive_pack
-    mock_adapter = mock('git_adapter')
-    mock_adapter.
-      expects(:receive_pack).
-      with('repo/path', :advertise_refs => true, :msg => '').
-      yields(StringIO.new('results'))
-    test_git = CompatibleGitAdapter.new(mock_adapter)
-    test_git.repository_path = Pathname.new('repo/path')
-
-    output = StringIO.new
-    test_git.handle_pack(
-      'receive-pack', StringIO.new, output, :advertise_refs => true
-    )
-
-    assert_match 'results', output.string
-  end
-
-  def test_upload_pack
-    mock_adapter = mock('git_adapter')
-    mock_adapter.
-      expects(:upload_pack).
-      with('repo/path', :msg => 'input').
-      yields(StringIO.new('results'))
-    test_git = CompatibleGitAdapter.new(mock_adapter)
-    test_git.repository_path = Pathname.new('repo/path')
-
-    output = StringIO.new
-    test_git.handle_pack('upload-pack', StringIO.new('input'), output)
-
-    assert_match 'results', output.string
-  end
-
-  def test_update_server_info
-    mock_adapter = mock('git_adapter')
-    mock_adapter.expects(:update_server_info).with('repo/path').returns(nil)
-    test_git = CompatibleGitAdapter.new(mock_adapter)
-    test_git.repository_path = Pathname.new('repo/path')
-
-    test_git.update_server_info
-  end
-
-  def test_exist
-    test_git = CompatibleGitAdapter.new(nil)
-    test_git.repository_path = Dir.pwd
-    assert test_git.exist?
-    test_git.repository_path = 'a/highly/unlikely/path/to/a/repository'
-    assert ! test_git.exist?
-  end
-
-  def test_file
-    init_example_repository
-    test_git = CompatibleGitAdapter.new(nil)
-    test_git.repository_path = example_repo
-
-    assert_nil test_git.file('a/highly/unlikely/path/to/a/file')
-
-    object_path = 'objects/31/d73eb4914a8ddb6cb0e4adf250777161118f90'
-    file_path = File.join(example_repo, object_path)
-    git_file = test_git.file(object_path)
-
-    assert_equal file_path, git_file.to_path.to_s
-    assert_equal File.mtime(file_path), git_file.mtime
-  ensure
-    remove_example_repository
-  end
-
-  def test_allow_push_with_true_setting
-    mock_adapter = mock('git_adapter')
-    mock_adapter.
-      expects(:get_config_setting).
-      with('receivepack').
-      returns('true')
-    test_git = CompatibleGitAdapter.new(mock_adapter)
-
-    assert test_git.allow_push?, 'Expected allow_push? to return true'
-  end
-
-  def test_allow_push_with_false_setting
-    mock_adapter = mock('git_adapter')
-    mock_adapter.
-      expects(:get_config_setting).
-      with('receivepack').
-      returns('false')
-    test_git = CompatibleGitAdapter.new(mock_adapter)
-
-    assert ! test_git.allow_push?, 'Expected allow_push? to return false'
-  end
-
-  def test_allow_push_with_no_setting
-    mock_adapter = mock('git_adapter')
-    mock_adapter.expects(:get_config_setting).with('receivepack').returns('')
-    test_git = CompatibleGitAdapter.new(mock_adapter)
-
-    assert ! test_git.allow_push?, 'Expected allow_push? to return false'
-  end
-
-  def test_allow_pull_with_true_setting
-    mock_adapter = mock('git_adapter')
-    mock_adapter.expects(:get_config_setting).with('uploadpack').returns('true')
-    test_git = CompatibleGitAdapter.new(mock_adapter)
-
-    assert test_git.allow_pull?, 'Expected allow_pull? to return true'
-  end
-
-  def test_allow_pull_with_false_setting
-    mock_adapter = mock('git_adapter')
-    mock_adapter.
-      expects(:get_config_setting).
-      with('uploadpack').
-      returns('false')
-    test_git = CompatibleGitAdapter.new(mock_adapter)
-
-    assert ! test_git.allow_pull?, 'Expected allow_pull? to return false'
-  end
-
-  def test_allow_pull_with_no_setting
-    mock_adapter = mock('git_adapter')
-    mock_adapter.expects(:get_config_setting).with('uploadpack').returns('')
-    test_git = CompatibleGitAdapter.new(mock_adapter)
-
-    assert test_git.allow_pull?, 'Expected allow_pull? to return true'
-  end
-
-end