stickler 0.1.1 → 2.0.0a

data/spec/data/specifications/foo-1.0.0.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{foo}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jeremy Hinegardner"]
+  s.date = %q{2010-06-23}
+  s.description = %q{foo gem}
+  s.email = %q{jeremy@hinegardner.org}
+  s.files = ["README.rdoc", "lib/foo.rb", "bin/foo", "Rakefile", "foo.gemspec"]
+  s.homepage = %q{http://github.com/copiousfreetime/stickler}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{foo gem}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+  end
+end
+

data/spec/middleware/common_gem_server_helpers.rb

@@ -0,0 +1,67 @@
+require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
+require 'rubygems/server'
+
+shared_examples_for "common gem server before after" do
+
+  before do
+    @spec_dir     = File.join( @gem_dir, "specifications" )
+
+    @webrick           = ::Gem::Server.new(@gem_dir,4567,false)
+    @underlying_server = @webrick.instance_variable_get("@server")
+    @webrick_thread    = Thread.new( @webrick ) do |webrick|
+      webrick.run
+    end
+    @webrick_request  = WEBrick::HTTPRequest.new :Logger => nil
+    @webrick_response = WEBrick::HTTPResponse.new :HTTPVersion => '1.0'
+  end
+
+
+  after do
+    @underlying_server.shutdown
+    @webrick_thread.kill
+  end
+
+
+  #
+  # pulled and modified from sinatra-rubygems
+  # http://github.com/jnewland/sinatra-rubygems
+  #
+  def should_match_webrick_behavior(url)
+
+    #webrick
+    data = StringIO.new "GET #{url} HTTP/1.0\r\n\r\n"
+    @webrick_request.parse data
+    verify_webrick = {}
+    begin
+      @underlying_server.service( @webrick_request, @webrick_response)
+      verify_webrick[:status]       = @webrick_response.status
+      verify_webrick[:content_type] = @webrick_response['Content-Type']
+      verify_webrick[:body_length]  = @webrick_response.body.length
+      verify_webrick[:body]         = @webrick_response.body
+    rescue WEBrick::HTTPStatus::NotFound
+      verify_webrick = {
+        :status       => 404,
+        :content_type => 'text/html',
+        :body_length  => "446"
+      }
+    end
+
+    #sinatra
+    get url
+
+    #verify
+    if 200 == last_response.status and 200 == verify_webrick[:status] then
+      {
+        :status =>          last_response.status,
+        :content_type =>    last_response['Content-Type'],
+        :body_length =>     last_response.body.length,
+        :body =>            last_response.body
+      }.should == verify_webrick
+    else
+      last_response.status.should == verify_webrick[:status]
+    end
+
+  end
+
+
+end

data/spec/middleware/index_spec.rb

@@ -0,0 +1,26 @@
+require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
+require File.expand_path( File.join( File.dirname(__FILE__), "modern_gem_server_behavior.rb" ) )
+
+require 'stickler/middleware/index'
+require 'stickler/middleware/compression'
+
+describe Stickler::Middleware::Index do
+  def app
+    ::Rack::Builder.new do
+      use ::Stickler::Middleware::Compression
+      use ::Stickler::Middleware::Index
+      run ::Sinatra::Base
+    end
+  end
+
+  before do
+    @gem_dir = File.expand_path( File.join( File.dirname( __FILE__ ), "tmp" ) )
+    FileUtils.mkdir_p( File.join( @gem_dir, "specifications" ))
+  end
+
+  after do
+    FileUtils.rm_rf( @gem_dir )
+  end
+
+  it_should_behave_like "modern gem server indexes"
+end

data/spec/middleware/legacy_gem_server_behavior.rb

@@ -0,0 +1,33 @@
+require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
+require File.expand_path( File.join( File.dirname(__FILE__), "common_gem_server_helpers.rb" ) )
+
+require 'rubygems/server'
+
+shared_examples_for "legacy gem server indexes" do
+
+  it_should_behave_like "common gem server before after" 
+
+  LEGACY_URLS = [
+    "/yaml",
+    "/yam.Z",
+    "/Marshal.#{Gem.marshal_version}",
+    "/Marshal.#{Gem.marshal_version}.Z",
+    "/quick/index",
+    "/quick/index.rz",
+    "/quick/latest_index",
+    "/quick/latest_index.rz",
+    "/quick/Marshal.#{Gem.marshal_version}/foo-1.0.0.gemspec.rz",
+    "/quick/foo-1.0.0.gemspec.rz",
+    "/quick/Marshal.#{Gem.marshal_version}/bar-1.0.0.gemspec.rz",
+    "/quick/bar-1.0.0.gemspec.rz",
+    "/quick/does-not-exist-1.2.0.gemspec.rz"
+  ]
+
+  LEGACY_URLS.each do |url|
+    it "serves a legacy gem server index item from #{url}" do
+      should_match_webrick_behavior url
+    end
+  end
+end
+
+

data/spec/middleware/local_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
+require File.expand_path( File.join( File.dirname(__FILE__), "modern_gem_server_behavior.rb" ) )
+require File.expand_path( File.join( File.dirname(__FILE__), "legacy_gem_server_behavior.rb" ) )
+
+require 'stickler/middleware/local'
+require 'stickler/middleware/compression'
+
+describe ::Stickler::Middleware::Local do
+  def app
+    gem_dir = @gem_dir
+    ::Rack::Builder.new do
+      use ::Stickler::Middleware::Compression
+      use ::Stickler::Middleware::Local, :repo_root => gem_dir
+      run ::Sinatra::Base
+    end
+  end
+
+  before do
+    @gem_dir      = File.join( @spec_dir, "data" )
+  end
+
+  it_should_behave_like "modern gem server indexes"
+#  it_should_behave_like "legacy gem server indexes"
+
+end    

data/spec/middleware/modern_gem_server_behavior.rb

@@ -0,0 +1,20 @@
+require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
+require File.expand_path( File.join( File.dirname(__FILE__), "common_gem_server_helpers.rb" ) )
+
+shared_examples_for "modern gem server indexes" do
+
+  it_should_behave_like "common gem server before after"
+
+  MODERN_URLS = [
+  "/specs.#{Gem.marshal_version}",
+  "/specs.#{Gem.marshal_version}.gz",
+  "/latest_specs.#{Gem.marshal_version}",
+  "/latest_specs.#{Gem.marshal_version}.gz",
+  ]
+
+  MODERN_URLS.each do |url|
+    it "serves a modern gem server index item from #{url}" do
+      should_match_webrick_behavior url
+    end
+  end
+end

data/spec/middleware/not_found_spec.rb

@@ -0,0 +1,25 @@
+require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
+require 'stickler/middleware/not_found'
+
+describe ::Stickler::Middleware::NotFound do
+  def app
+    ::Stickler::Middleware::NotFound.new
+  end
+
+  before do
+    get "/"
+  end
+
+  it "should respond to a 404 on everything"  do
+    get '/'
+    last_response.status.should == 404
+  end
+
+  it "should return a 'text/html' page" do
+    last_response.content_type.should == 'text/html'
+  end
+
+  it "should say to go look somewhere else" do
+    last_response.body.should =~ /Not Found/m
+  end
+end

data/spec/repository/api_behavior.rb

@@ -0,0 +1,162 @@
+require 'stickler/repository/api'
+
+shared_examples_for "includes Repository::Api" do
+  describe "responds to all the api methods" do
+    Stickler::Repository::Api.api_methods.each do |method|
+      it "responds to ##{method}" do
+        @repo.respond_to?( method ).should == true
+      end
+    end
+  end
+end
+
+require 'digest/sha1'
+shared_examples_for "implements Repository::Api" do
+  before( :each ) do
+    @foo_gem_local_path = File.join( @gems_dir, "foo-1.0.0.gem" )
+    @foo_spec           = Stickler::SpecLite.new( 'foo', '1.0.0' )
+    @foo_digest         = Digest::SHA1.hexdigest( IO.read( @foo_gem_local_path ) )
+    @missing_spec       = Stickler::SpecLite.new( "does_not_exist", "0.1.0" )
+  end
+
+  # removed specifications_uri
+  %w[ uri gems_uri ].each do |method|
+    it "returns a URI like object from #{method}" do
+      result = @repo.send( method )
+      [ ::URI, ::Addressable::URI ].include?( result.class ).should == true
+    end
+  end
+
+  # removed specification
+  %w[ gem ].each do |thing|
+    describe "#uri_for_#{thing}" do
+      before( :each ) do
+        @repo.push( @foo_gem_local_path )
+        @method = "uri_for_#{thing}"
+      end
+
+      it "returns URI for a #{thing} that exists" do
+        uri = @repo.send( @method, @foo_spec )
+        [ ::URI, ::Addressable::URI ].include?( uri.class ).should == true
+      end
+
+      it "returns nil for a #{thing} that does not exist" do
+        @repo.send( @method, @missing_spec ).should be_nil
+      end
+    end
+  end
+
+  describe "#push" do
+    it "pushes a gem from a .gem file" do
+      @repo.push( @foo_gem_local_path )
+      @repo.search_for( Stickler::SpecLite.new( "foo", "1.0.0" ) )
+    end
+
+    it "raises an error when pushing a gem if the gem already exists" do
+      @repo.push( @foo_gem_local_path )
+      lambda { @repo.push( @foo_gem_local_path ) }.should raise_error( Stickler::Repository::Error, /gem foo-1.0.0 already exists/ )
+    end
+  end
+
+  describe "#delete" do
+    it "deletes a gem from the repo" do
+      @repo.search_for( @foo_spec ).should be_empty
+      @repo.push( @foo_gem_local_path )
+      @repo.search_for( @foo_spec ).size.should == 1
+      @repo.delete( @foo_spec ).should == true
+      @repo.search_for( @foo_spec ).should be_empty
+    end
+
+    it "returns false if it is unable to delete a gem from the repo" do
+      @repo.search_for( @foo_spec ).should be_empty
+      @repo.delete( @foo_spec ).should == false
+    end
+  end
+
+  describe "#yank" do
+    before( :each ) do
+      @repo.search_for( @foo_spec ).should be_empty
+      @repo.push( @foo_gem_local_path )
+      @response_uri = @repo.yank( @foo_spec )
+    end
+
+    it "returns the uri in which to get the gem" do
+      [ ::URI, ::Addressable::URI ].include?( @response_uri.class ).should == true
+    end
+
+    it "returns nil if the gem to yank does not exist or is already yanked" do
+      @repo.yank( @missing_spec ).should == nil
+    end
+
+    it "does not find the gem in a search" do
+      @repo.search_for( @foo_spec ).should be_empty
+    end
+
+    it "does have the #uri_for_gem" do
+      @repo.uri_for_gem( @foo_spec ).should == @response_uri
+    end
+
+    it "can still return the gem" do
+      data = @repo.get( @foo_spec )
+      sha1 = Digest::SHA1.hexdigest( data )
+      sha1.should == @foo_digest
+    end
+
+  end
+
+  describe "#search_for" do
+    it "returns specs for items that are found" do
+      @repo.push( @foo_gem_local_path )
+      @repo.search_for( @foo_spec ).should_not be_empty
+    end
+
+    it "returns an empty array when nothing is found" do
+      @repo.search_for( @missing_spec ).should be_empty
+    end
+  end
+
+  describe "#get" do
+    it "returns the bytes of the gem for a gem that exists" do
+      @repo.push( @foo_gem_local_path )
+      data = @repo.get( @foo_spec )
+      sha1 = Digest::SHA1.hexdigest( data )
+      sha1.should == @foo_digest
+    end
+
+    it "returns nil if the gem does not exist" do
+      @repo.get( @missing_spec ).should be_nil
+    end
+  end
+
+  describe "#open" do
+    before( :each ) do
+      @repo.push( @foo_gem_local_path )
+    end
+    it "reads a gem via a returned output stream" do
+      io = @repo.open( @foo_spec )
+      sha1 = Digest::SHA1.hexdigest( io.read )
+      sha1.should == @foo_digest
+    end
+
+    it "can be called with a block" do
+      sha1 = Digest::SHA1.new
+      @repo.open( @foo_spec ) do |io|
+        sha1 << io.read
+      end
+      sha1.hexdigest.should == @foo_digest
+    end
+
+    it "returns nil if the gem does not exist" do
+      @repo.open( @missing_spec ).should == nil
+    end
+
+    it "does not call the block if the gem does not exist" do
+      called = false
+      @repo.open( @missing_spec ) do |io|
+        called = true
+      end
+      called.should == false
+    end
+  end
+
+end

data/spec/repository/api_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
+require File.expand_path( File.join( File.dirname(__FILE__), "api_behavior.rb" ) )
+
+require 'stickler/repository/api'
+module Stickler::Repository
+  class Stub
+    include Stickler::Repository::Api
+  end
+end
+
+describe Stickler::Repository::Api do
+  before do
+    @repo = Stickler::Repository::Stub.new
+    @spec = Stickler::SpecLite.new( "foo", "1.0.0" )
+  end
+
+  %w[ uri gems_uri ].each do |method|
+    it "raises an error when calling unimplmented method #{method}" do
+      lambda { @repo.send( method ) }.should raise_error( NotImplementedError, /\APlease implement .*##{method}\Z/ )
+    end
+  end
+
+  %w[ uri_for_gem search_for delete yank get open ].each do |method|
+    it "raises an error when calling unimplmented method #{method} taking a spec" do
+      lambda { @repo.send( method, @spec ) }.should raise_error( NotImplementedError, /\APlease implement .*##{method}\Z/ )
+    end
+  end
+
+  %w[ push ].each do |method|
+    it "raises an error when calling unimplmented method #{method} taking some other object" do
+      lambda { @repo.send( method, Object.new ) }.should raise_error( NotImplementedError, /\APlease implement .*##{method}\Z/ )
+    end
+  end
+
+  it_should_behave_like 'includes Repository::Api'
+end
+
+

data/spec/repository/index_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
+require 'stickler/repository/index'
+
+describe ::Stickler::Repository::Index do
+
+  before do
+    @index_me = File.join( @spec_dir, "tmp" )
+    FileUtils.mkdir_p( @index_me )
+
+    @specifications = Dir.glob( File.join( @specifications_dir, "*.gemspec" ) )
+    @specifications.each do |s|
+      FileUtils.cp( s, @index_me )
+    end
+
+    @index    = ::Stickler::Repository::Index.new( @index_me )
+  end
+
+  after( :each ) do
+    FileUtils.rm_rf( @index_me )
+  end
+
+  it "indexes all the .gemspec files in the directory" do
+    @index.specs.size.should == @specifications.size
+  end
+
+  it "is able to notice changes in the index" do
+    @index.specs.size.should == @specifications.size
+    FileUtils.rm( File.join( @index_me, "foo-1.0.0.gemspec" ) )
+    @index.specs.size.should == ( @specifications.size - 1 )
+  end
+end
+

data/spec/repository/local_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
+require File.expand_path( File.join( File.dirname(__FILE__), "api_behavior.rb" ) )
+
+require 'stickler/repository/local'
+
+describe ::Stickler::Repository::Local do
+
+  before do
+    @repo_dir = File.join( @spec_dir, "tmp" )
+    @repo = ::Stickler::Repository::Local.new( @repo_dir )
+  end
+
+  after( :each ) do
+    FileUtils.rm_rf( @repo_dir )
+  end
+
+  %w[ gems specifications ].each do |sub_dir|
+    it "creates #{sub_dir} directory" do
+      new_dir = File.join( @repo_dir , sub_dir ) + File::SEPARATOR
+      File.directory?( new_dir ).should == true
+      @repo.send( "#{sub_dir}_dir" ).should == new_dir
+    end
+
+  end
+
+  it "returns a list of all the specs in the repo" do
+    Dir.glob( File.join( @gems_dir, "*.gem" ) ).each do |gem|
+      @repo.push( gem )
+    end
+    @repo.specs.size.should == 2
+  end
+
+  it_should_behave_like 'includes Repository::Api'
+  it_should_behave_like 'implements Repository::Api'
+end
+

data/spec/repository/null_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
+require File.expand_path( File.join( File.dirname(__FILE__), "api_behavior.rb" ) )
+
+require 'stickler/repository/null'
+
+describe ::Stickler::Repository::Null do
+
+  before do
+    @repo = ::Stickler::Repository::Null.new
+  end
+
+  it "sets the root_dir to the class name" do
+    @repo.root_dir.should == "Stickler::Repository::Null"
+  end
+
+  it_should_behave_like 'includes Repository::Api'
+end

data/spec/repository/remote_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
+require File.expand_path( File.join( File.dirname(__FILE__), "api_behavior.rb" ) )
+
+require 'stickler/repository/remote'
+
+describe Stickler::Repository::Remote do
+  before do
+    @repo_uri = "http://localhost:6789/"
+    @repo     = ::Stickler::Repository::Remote.new( @repo_uri )
+  end
+
+  it_should_behave_like 'includes Repository::Api'
+
+  describe "Using a live server" do
+    before do
+      @tmp_dir  = File.join( @spec_dir, "tmp" )
+      FileUtils.mkdir_p( @tmp_dir )
+
+      @pid_file = File.join( @tmp_dir , "rack.pid" )
+      @ru_file  = File.expand_path( File.join( @spec_dir, "..", "examples", "gemcutter_repo.ru" ) )
+      cmd = "rackup --port 6789 --pid #{@pid_file} --daemonize #{@ru_file}"
+      #puts cmd
+      system cmd
+
+      tries = 0
+      @acc      = ::Resourceful::HttpAccessor.new
+      loop do
+        begin
+          @acc.resource( @repo_uri + "specs.#{Gem.marshal_version}.gz" ).get
+          #puts "rackup started with pid #{IO.read( @pid_file )}"
+          break
+        rescue => e
+          tries += 1
+          sleep tries * 0.1
+        end
+      end
+    end
+
+    after do
+      pid = IO.read( @pid_file ).to_i
+      Process.kill( 'KILL', pid )
+      #FileUtils.rm_rf( @tmp_dir, :verbose => true )
+      FileUtils.rm_rf( @tmp_dir )
+    end
+
+    it_should_behave_like 'implements Repository::Api'
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

data/spec/spec_helper.rb

@@ -1,5 +1,17 @@
-require 'rubygems'
 require 'spec'
+require 'rack/test'
+
+Spec::Runner.configure do |config|
+  config.include Rack::Test::Methods
+
+  config.before( :each ) do
+    @spec_dir           = File.expand_path( File.dirname( __FILE__ ) )
+    @gem_root           = File.join( @spec_dir, 'data' )
+    @specifications_dir = File.join( @gem_root, "specifications" )
+    @gems_dir           = File.join( @gem_root, "gems" )
+  end
+
+
+end
+
 
-$: << File.expand_path( File.join( File.dirname( __FILE__ ), "..", "lib" ) )
-require 'stickler'

data/spec/spec_lite_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path( File.join( File.dirname(__FILE__), "spec_helper.rb" ) )
+
+require 'stickler/spec_lite'
+
+describe Stickler::SpecLite do
+  before do
+    @specs = {
+      :ruby => Stickler::SpecLite.new( 'foo', '0.4.2' ),
+      :win  => Stickler::SpecLite.new( 'bar', '1.0.1', "x86-mswin32" )
+    }
+  end
+
+  it "defaults to ruby platform" do
+    @specs[:ruby].platform.should == Gem::Platform::RUBY
+  end
+
+  { [:ruby, 'file_name']      => "foo-0.4.2.gem",
+    [:ruby, 'spec_file_name'] => "foo-0.4.2.gemspec" ,
+    [:win , 'file_name']      => "bar-1.0.1-x86-mswin32.gem",
+    [:win , 'spec_file_name'] => "bar-1.0.1-x86-mswin32.gemspec",
+  }.each do |params, result|
+    platform, method = *params
+    it "on a #{platform} gem ##{method} is #{result}" do
+      @specs[platform].send( method ).should == result
+    end
+  end
+
+  it "has an array format" do
+    @specs[:win].to_a.should == [ 'bar', '1.0.1', 'x86-mswin32' ]
+  end
+
+  it "returns false when compared to something that does not resond to :name, :version or :platform" do
+    x = @specs[:ruby] =~ Object.new
+    x.should == false
+  end
+
+  it "can compare against anything that responds to :name, :version and :platform" do
+    class OSpec
+      attr_accessor :name
+      attr_accessor :version
+      attr_accessor :platform
+    end
+
+    o = OSpec.new
+    o.name = @specs[:ruby].name
+    o.version = @specs[:ruby].version
+    o.platform = @specs[:ruby].platform
+    r = @specs[:ruby] =~ o
+    r.should == true
+  end
+
+  it "can be compared against another spec" do
+    (@specs[:ruby] =~ @specs[:win]).should == false
+  end
+
+  it "can be sorted" do
+    list = @specs.values
+    alib = Stickler::SpecLite.new( 'alib', '4.2' )
+    list << alib
+    list.sort.should == [ alib, @specs[:win], @specs[:ruby] ]
+  end
+end