stickler 2.2.4 → 2.3.0

data/man/stickler.1.ronn

@@ -0,0 +1,144 @@
+STICKLER(1)
+===========
+
+NAME
+----
+stickler - command line program to interact with a stickler-server
+
+
+SYNOPSIS
+--------
+*stickler* [--help] [COMMAND] [COMMAND_OPTIONS] [gemfile(s)]
+
+
+DESCRIPTION
+-----------
+Stickler is a tool to organize and maintain an internal gem repository of
+proprietary gems and/or a mirror of third party gems.
+
+The stickler(1) command interacts with an instance of
+stickler-server(1) to control the publishing and mirroring of ruby
+gems.
+
+
+COMMANDS
+--------
+*push*: 
+    Push one or more gems to a gemserver.  This works the same as `gem push`
+    although there is no authorization mechanism.
+
+*yank*: 
+    Remove a gem from the gemserver's index.  It will still be available from
+    direct download.  This works the same as `gem yank`.
+
+*mirror*:
+    Pull a specific version of a gem from an upstream gem server and
+    store it in a stickler-server(1).
+
+*config*:
+    Access or update the stickler client configuration.
+
+*list*:
+    List all the gems in the remote repository.
+
+*unyank*:
+    Put a gem that was _yanked_ back into the gemserver index. This reverses a
+    `yank`.
+
+OPTIONS
+-------
+These are the options for all commands.  Not all options apply to all commands.
+
+*-a, --add*:
+    Add the `--server` or `--upstream` items to the config file when using the
+    `config` command.
+
+*-d, --debug*:
+    Output debug information
+
+*-g, --gem-version*='VERSION':
+    The version of the gem to yank from `--server` or to mirror from
+    `--upstream`.
+
+*-h, --help*:
+    Show the help message
+
+*-l, --list*:
+    Display the current configuration when using the `config` command.
+
+*-p, --platform*='PLATFORM':
+    The platform of the gem to yank from `--server` or to mirror from
+    `--upstream` (e.g.  ruby, java, mswin32)
+
+*-s, --server*='SERVER':
+    The gem server or stickler-server(1) URL.  This is used by all the commands.
+
+*-u, --upstream*='SERVER':
+    The upstream server from which to mirror a gem when using the `mirror`
+    command.
+
+*-v, --version*:
+    Output the version.
+
+
+CONFIGURATION
+-------------
+Stickler uses the `.gem/stickler` file to hold its configuration.  It is a yaml
+file and Currently there are two options.  These are altered using the `stickler
+config` command.
+
+*upstream*: The default upstream server from which to mirror gems.
+*server*:   The default linkstick:stickler-server[1] to interact with.
+
+An example config file
+
+    --- 
+    :server: http://stickler.example.com
+    :upstream: https://rubygems.org
+
+
+EXAMPLES
+--------
+Push the local `my_gem-1.0.0.gem` file to the stickler-server(1) at
+*stickler.example.com*
+
+    stickler push ./my_gem-1.0.0.gem --server http://stickler.example.com/
+
+Push all the gems in the `pkg` directory to the stickler-server(1) at
+*stickler.example.com*
+
+    stickler push --server http://stickler.example.com/ ./pkg/*.gem 
+
+Yank vesion 1.0.0 of my_gem from the gem index on sticker.example.com
+
+    stickler yank my_gem --version 1.0.0 --server http://stickler.example.com/
+
+Take the +third_party+ gem, version +1.4.2+ that is on *rubygems.org* and mirror
+it on *stickler.example.com*
+
+    stickler mirror third_party_gem --gem-version 0.4.2 --upstream http://rubygems.org/ --server http://stickler.example.com/
+    stickler mirror --help 
+
+Set the `server` and `upstream` configration values in the `.gem/stickler` file.
+
+    stickler config --add --server http://stickler.example.com --upstream http://rubygems.org/
+
+
+SEE ALSO
+--------
+stickler-server(1), stickler-passenger-config(1)
+
+
+AUTHOR
+------
+Written by Jeremy Hinegardner <jeremy@copiousfreetime.org>
+
+
+RESOURCES
+---------
+[GitHub project](https://www.github.com/copiousfreetime/stickler)
+
+
+BUGS
+----
+Please report bugs to the [github issue tracker](https://github.com/copiousfreetime/stickler/issues)

data/spec/middleware/local_spec.rb

@@ -1,7 +1,4 @@
-require File.expand_path( "../spec_helper",File.dirname(__FILE__) )
-
-require 'stickler/middleware/local'
-require 'stickler/middleware/compression'
+require 'spec_helper'
 
 describe Stickler::Middleware::Local do
 

data/spec/middleware/not_found_spec.rb

@@ -1,5 +1,4 @@
-require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
-require 'stickler/middleware/not_found'
+require 'spec_helper'
 
 describe ::Stickler::Middleware::NotFound do
   include Rack::Test::Methods

data/spec/paths_spec.rb

@@ -1,6 +1,4 @@
-require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
-
-require 'stickler/paths'
+require 'spec_helper'
 
 describe Stickler::Paths do
   it "can access the root dir of the project" do

data/spec/repository/api_behavior.rb

@@ -1,5 +1,3 @@
-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|
@@ -62,8 +60,8 @@ shared_examples_for "implements Repository::Api" 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 ).size.should eq 1
+      @repo.delete( @foo_spec ).should eq true
       @repo.search_for( @foo_spec ).should be_empty
     end
 
@@ -104,6 +102,38 @@ shared_examples_for "implements Repository::Api" do
 
   end
 
+  describe "#unyank" do
+    before( :each ) do
+      @repo.search_for( @foo_spec ).should be_empty
+      @repo.push( @foo_gem_local_path )
+    end
+
+    it "returns nil if the gem to unyank does not exist" do
+      non_existing_gem = @missing_spec
+      @repo.unyank( non_existing_gem ).should be_nil
+    end
+
+    #Do we even care about this?
+    xit "returns nil if the gem to unyank has not been yanked" do
+      @repo.unyank( @foo_spec ).should be_nil
+    end
+
+    context " when file has been yanked" do
+      before :each do
+        @repo.yank( @foo_spec )
+      end
+
+      it "return true if the gem is successfully unyanked" do
+        @repo.unyank( @foo_spec ).should be_true
+      end
+
+      it "finds the gem in a search" do
+        @repo.unyank( @foo_spec )
+        @repo.search_for( @foo_spec ).should_not be_empty
+      end
+    end
+  end
+
   describe "#search_for" do
     it "returns specs for items that are found" do
       @repo.push( @foo_gem_local_path )

data/spec/repository/api_spec.rb

@@ -1,7 +1,6 @@
-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 'spec_helper'
+require 'repository/api_behavior'
 
-require 'stickler/repository/api'
 module Stickler::Repository
   class Stub
     include Stickler::Repository::Api

data/spec/repository/index_spec.rb

@@ -1,5 +1,4 @@
-require File.expand_path( File.join( File.dirname(__FILE__), "..", "spec_helper.rb" ) )
-require 'stickler/repository/index'
+require 'spec_helper'
 
 describe ::Stickler::Repository::Index do
 
@@ -20,28 +19,28 @@ describe ::Stickler::Repository::Index do
   end
 
   it "indexes all the .gemspec files in the directory" do
-    @index.specs.size.should == @specifications.size
+    @index.specs.size.should eq @specifications.size
   end
 
   it "is able to notice changes in the index" do
-    @index.specs.size.should == @specifications.size
+    @index.specs.size.should eq @specifications.size
     FileUtils.rm( File.join( @index_me, "foo-1.0.0.gemspec" ) )
-    @index.specs.size.should == ( @specifications.size - 1 )
+    @index.specs.size.should eq( @specifications.size - 1 )
   end
 
   it "knows just the latest specs" do
-    @index.latest_specs.size.should == (@specifications.size - 1)
-    @index.latest_specs.collect { |s| s.full_name }.sort.should == %w[ bar-1.0.0 baz-3.1.4 baz-3.1.4-java foo-1.0.0 ]
+    @index.latest_specs.size.should eq(@specifications.size - 1)
+    @index.latest_specs.collect { |s| s.full_name }.sort.should eq(%w[ bar-1.0.0 baz-3.1.4 baz-3.1.4-java foo-1.0.0 ])
   end
 
   it "knows the pre-release specs" do
-    @index.prerelease_specs.size.should == 1
-    @index.prerelease_specs.first.full_name.should == "foo-2.0.0a"
+    @index.prerelease_specs.size.should eq 1
+    @index.prerelease_specs.first.full_name.should eq "foo-2.0.0a"
   end
 
   it "knows the released specs" do
-    @index.released_specs.size.should == 4
-    @index.released_specs.collect { |s| s.full_name }.sort.should == %w[ bar-1.0.0 baz-3.1.4 baz-3.1.4-java foo-1.0.0 ]
+    @index.released_specs.size.should eq 4
+    @index.released_specs.collect { |s| s.full_name }.sort.should eq(%w[ bar-1.0.0 baz-3.1.4 baz-3.1.4-java foo-1.0.0 ])
   end
 end
 

data/spec/repository/local_spec.rb

@@ -1,7 +1,5 @@
-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'
+require 'spec_helper'
+require 'repository/api_behavior'
 
 describe ::Stickler::Repository::Local do
 
@@ -19,8 +17,8 @@ describe ::Stickler::Repository::Local do
   %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
+      File.directory?( new_dir ).should eq true
+      @repo.send( "#{sub_dir}_dir" ).should eq new_dir
     end
 
   end
@@ -29,20 +27,20 @@ describe ::Stickler::Repository::Local do
     Dir.glob( File.join( @gems_dir, "*.gem" ) ).each do |gem|
       @repo.push( gem )
     end
-    @repo.specs.size.should == 5
+    @repo.specs.size.should eq 5
   end
 
   it "two instances with the same repo dir are the same object" do
     repo2 = ::Stickler::Repository::Local.new( File.join(@repos_dir, '1') )
-    repo2.object_id.should == @repo.object_id
-    ::Stickler::Repository::Local.repos.size.should == 1
+    repo2.object_id.should eq @repo.object_id
+    ::Stickler::Repository::Local.repos.size.should eq 1
   end
 
 
   it "keeps track of all the repository instances" do
-    repo2 = ::Stickler::Repository::Local.new( File.join(@repos_dir, "2" ) )
-    repo3 = ::Stickler::Repository::Local.new( File.join(@repos_dir, "3" ) )
-    ::Stickler::Repository::Local.repos.size.should == 3
+    ::Stickler::Repository::Local.new( File.join(@repos_dir, "2" ) )
+    ::Stickler::Repository::Local.new( File.join(@repos_dir, "3" ) )
+    ::Stickler::Repository::Local.repos.size.should eq 3
   end
 
   it_should_behave_like 'includes Repository::Api'

data/spec/repository/null_spec.rb

@@ -1,8 +1,5 @@
-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'
-
+require 'spec_helper'
+require 'repository/api_behavior'
 describe ::Stickler::Repository::Null do
 
   before do

data/spec/repository/remote_spec.rb

@@ -1,7 +1,5 @@
-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'
+require 'spec_helper'
+require 'repository/api_behavior'
 
 class SticklerTestServer
   def initialize( spec_dir, ru_file )
@@ -23,7 +21,7 @@ class SticklerTestServer
         Excon.get( @repo_uri + "specs.#{Gem.marshal_version}.gz" )
         #puts "rackup started with pid #{IO.read( @pid_file )}"
         break
-      rescue => e
+      rescue
         tries += 1
         sleep tries * 0.1
       end

data/spec/spec_helper.rb

@@ -1,7 +1,12 @@
-require 'rspec'
+if RUBY_VERSION >= '1.9.2' then
+  require 'simplecov'
+  SimpleCov.start if ENV['COVERAGE']
+end
+
+require "rspec/autorun"
+require 'stickler'
 require 'index_spec_helpers'
 
-require 'stickler/repository/local'
 
 RSpec.configure do |config|
 

data/spec/spec_lite_spec.rb

@@ -1,6 +1,4 @@
-require File.expand_path( File.join( File.dirname(__FILE__), "spec_helper.rb" ) )
-
-require 'stickler/spec_lite'
+require 'spec_helper'
 
 describe Stickler::SpecLite do
   before do

data/tasks/default.rake

@@ -0,0 +1,274 @@
+# vim: syntax=ruby
+require 'rake/clean'
+#------------------------------------------------------------------------------
+# If you want to Develop on this project just run 'rake develop' and you'll
+# have all you need to get going. If you want to use bundler for development,
+# then run 'rake develop:using_bundler'
+#------------------------------------------------------------------------------
+namespace :develop do
+
+  # Install all the development and runtime dependencies of this gem using the
+  # gemspec.
+  task :default do
+    require 'rubygems/dependency_installer'
+    installer = Gem::DependencyInstaller.new
+
+    This.set_coverage_gem
+
+    puts "Installing gem depedencies needed for development"
+    This.platform_gemspec.dependencies.each do |dep|
+      if dep.matching_specs.empty? then
+        puts "Installing : #{dep}"
+        installer.install dep
+      else
+        puts "Skipping   : #{dep} -> already installed #{dep.matching_specs.first.full_name}"
+      end
+    end
+    puts "\n\nNow run 'rake test'"
+  end
+
+  # Create a Gemfile that just references the gemspec
+  file 'Gemfile' => :gemspec do
+    File.open( "Gemfile", "w+" ) do |f|
+      f.puts 'source :rubygems'
+      f.puts 'gemspec'
+    end
+  end
+
+  desc "Create a bundler Gemfile"
+  task :using_bundler => 'Gemfile' do
+    puts "Now you can 'bundle'"
+  end
+
+  # Gemfiles are build artifacts
+  CLOBBER << FileList['Gemfile*']
+end
+desc "Boostrap development"
+task :develop => "develop:default"
+
+#------------------------------------------------------------------------------
+# Minitest - standard TestTask
+#------------------------------------------------------------------------------
+begin
+  require 'rspec/core/rake_task'
+   RSpec::Core::RakeTask.new( :test ) do |t|
+    t.ruby_opts    = %w[ -w ]
+    t.rspec_opts   = %w[ --color --format documentation ]
+  end
+  task :default => :test
+  task :test_requirements
+  task :test => :test_requirements
+rescue LoadError
+  This.task_warning( 'test' )
+end
+
+#------------------------------------------------------------------------------
+# RDoc - standard rdoc rake task, although we must make sure to use a more
+#        recent version of rdoc since it is the one that has 'tomdoc' markup
+#------------------------------------------------------------------------------
+begin
+  gem 'rdoc' # otherwise we get the wrong task from stdlib
+  require 'rdoc/task'
+  RDoc::Task.new do |t|
+    t.markup   = 'tomdoc'
+    t.rdoc_dir = 'doc'
+    t.main     = 'README.rdoc'
+    t.title    = "#{This.name} #{This.version}"
+    t.rdoc_files.include( '*.rdoc', 'lib/**/*.rb' )
+  end
+rescue LoadError => le
+  This.task_warning( 'rdoc' )
+end
+
+#------------------------------------------------------------------------------
+# Coverage - optional code coverage, rcov for 1.8 and simplecov for 1.9, so
+#            for the moment only rcov is listed.
+#------------------------------------------------------------------------------
+if RUBY_VERSION < "1.9.0"
+  begin
+   require 'rcov/rcovtask'
+   Rcov::RcovTask.new( 'coverage' ) do |t|
+     t.libs      << 'spec'
+     t.pattern   = 'spec/**/*_spec.rb'
+     t.verbose   = true
+     t.rcov_opts << "-x ^/"           # remove all the global files
+     t.rcov_opts << "--sort coverage" # so we see the worst files at the top
+   end
+  rescue LoadError
+   This.task_warning( 'rcov' )
+  end
+else
+  begin
+    require 'simplecov'
+    desc 'Run tests with code coverage'
+    task :coverage do
+      ENV['COVERAGE'] = 'true'
+      Rake::Task[:test].execute
+    end
+    CLOBBER << FileList["coverage"]
+  rescue LoadError
+    This.task_warning( 'simplecov' )
+  end
+end
+
+#------------------------------------------------------------------------------
+# Manifest - We want an explicit list of thos files that are to be packaged in
+#            the gem. Most of this is from Hoe.
+#------------------------------------------------------------------------------
+namespace 'manifest' do
+  desc "Check the manifest"
+  task :check => :clean do
+    files = FileList["**/*", ".*"].exclude( This.exclude_from_manifest ).to_a.sort
+    files = files.select{ |f| File.file?( f ) }
+
+    tmp = "Manifest.tmp"
+    File.open( tmp, 'w' ) do |f|
+      f.puts files.join("\n")
+    end
+
+    begin
+      sh "diff -du Manifest.txt #{tmp}"
+    ensure
+      rm tmp
+    end
+    puts "Manifest looks good"
+  end
+
+  desc "Generate the manifest"
+  task :generate => :clean do
+    files = %x[ git ls-files ].split("\n").sort
+    files.reject! { |f| f =~ This.exclude_from_manifest }
+    File.open( "Manifest.txt", "w" ) do |f|
+      f.puts files.join("\n")
+    end
+  end
+end
+
+#------------------------------------------------------------------------------
+# Fixme - look for fixmes and report them
+#------------------------------------------------------------------------------
+namespace :fixme do
+  task :default => 'manifest:check' do
+    This.manifest.each do |file|
+      next if file == __FILE__
+      next unless file =~ %r/(txt|rb|md|rdoc|css|html|xml|css)\Z/
+      puts "FIXME: Rename #{file}" if file =~ /fixme/i
+      IO.readlines( file ).each_with_index do |line, idx|
+        prefix = "FIXME: #{file}:#{idx+1}".ljust(42)
+        puts "#{prefix} => #{line.strip}" if line =~ /fixme/i
+      end
+    end
+  end
+
+  def fixme_project_root
+    This.project_path( '../fixme' )
+  end
+
+  def fixme_project_path( subtree )
+    fixme_project_root.join( subtree )
+  end
+
+  def local_fixme_files
+    This.manifest.select { |p| p =~ %r|^tasks/| }
+  end
+
+  def outdated_fixme_files
+    local_fixme_files.reject do |local|
+      upstream     = fixme_project_path( local )
+      Digest::SHA256.file( local ) == Digest::SHA256.file( upstream )
+    end
+  end
+
+  def fixme_up_to_date?
+    outdated_fixme_files.empty?
+  end
+
+  desc "See if the fixme tools are outdated"
+  task :outdated => :release_check do
+    if fixme_up_to_date? then
+      puts "Fixme files are up to date."
+    else
+      outdated_fixme_files.each do |f|
+        puts "#{f} is outdated"
+      end
+    end
+  end
+
+  desc "Update outdated fixme files"
+  task :update => :release_check do
+    if fixme_up_to_date? then
+      puts "Fixme files are already up to date."
+    else
+      puts "Updating fixme files:"
+      outdated_fixme_files.each do |local|
+        upstream = fixme_project_path( local )
+        puts "  * #{local}"
+        FileUtils.cp( upstream, local )
+      end
+      puts "Use your git commands as appropriate."
+    end
+  end
+end
+desc "Look for fixmes and report them"
+task :fixme => "fixme:default"
+
+#------------------------------------------------------------------------------
+# Gem Specification
+#------------------------------------------------------------------------------
+# Really this is only here to support those who use bundler
+desc "Build the #{This.name}.gemspec file"
+task :gemspec do
+  File.open( This.gemspec_file, "wb+" ) do |f|
+    f.write This.platform_gemspec.to_ruby
+  end
+end
+
+# the gemspec is also a dev artifact and should not be kept around.
+CLOBBER << This.gemspec_file.to_s
+
+# The standard gem packaging task, everyone has it.
+require 'rubygems/package_task'
+Gem::PackageTask.new( This.platform_gemspec ) do
+  # nothing
+end
+
+
+#------------------------------------------------------------------------------
+# man pages
+#------------------------------------------------------------------------------
+desc "Create the man pages"
+task :man do
+  sh "ronn --roff #{FileList["man/*.ronn"]}"
+end
+
+#------------------------------------------------------------------------------
+# Release - the steps we go through to do a final release, this is pulled from
+#           a compbination of mojombo's rakegem, hoe and hoe-git
+#
+# 1) make sure we are on the master branch
+# 2) make sure there are no uncommitted items
+# 3) check the manifest and make sure all looks good
+# 4) build the gem
+# 5) do an empty commit to have the commit message of the version
+# 6) tag that commit as the version
+# 7) push master
+# 8) push the tag
+# 7) pus the gem
+#------------------------------------------------------------------------------
+task :release_check do
+  unless `git branch` =~ /^\* master$/
+    abort "You must be on the master branch to release!"
+  end
+  unless `git status` =~ /^nothing to commit/m
+    abort "Nope, sorry, you have unfinished business"
+  end
+end
+
+desc "Create tag v#{This.version}, build and push #{This.platform_gemspec.full_name} to rubygems.org"
+task :release => [ :release_check, 'manifest:check', :gem ] do
+  sh "git commit --allow-empty -a -m 'Release #{This.version}'"
+  sh "git tag -a -m 'v#{This.version}' v#{This.version}"
+  sh "git push origin master"
+  sh "git push origin v#{This.version}"
+  sh "gem push pkg/#{This.platform_gemspec.full_name}.gem"
+end