stickler 2.0.0a → 2.0.1

data/man/asciidoc.conf

@@ -0,0 +1,25 @@
+## linkstick: macro
+# 
+# Usage: linkstick:command[manpage-section]
+# 
+# Modelled after the linkgit macro 
+#
+# {0} is the manpage section, {target} is the command
+#
+##
+
+[macros]
+(?su)[\\]?(?P<name>linkstick):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
+
+ifdef::backend-docbook[]
+[linkstick-inlinemacro]
+{0%{target}}
+{0#<citerefentry>}
+{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
+{0#</citerefentry>}
+endif::backend-docbook[]
+
+ifdef::backend-xhtml11[]
+[linkstick-inlinemacro]
+<strong><a href="{target}.html">{target}{0?({0})}</a></strong>
+endif::backend-xhtml11[]

data/man/stickler-passenger-config.asciidoc

@@ -0,0 +1,74 @@
+STICKLER-PASSENGER-CONFIG(1)
+============================
+
+NAME
+----
+stickler-passenger-config - output a Phusion Passenger config for stickler
+
+
+SYNOPSIS
+--------
+*stickler-passenger-config* ['--help'] ['COMMAND'] ['COMMAND_OPTIONS'] /path/to/stickler/root
+
+
+DESCRIPTION
+-----------
+*stickler-passenger-config* will create a stickler web application directory,
+including the config.ru file for use with link:http://modrails.com/[Phusion
+Passenger].  It will then output the stanza to be incorporated into an
+link:http://httpd.apache.org/[Apache] or link:http://nginx.net[Nginx]
+configuration.
+
+
+COMMANDS
+--------
+[horizontal]
+*apache2*:: Output an Apache config.
+
+*nginx*:: Output an Nginx config.
+
+
+OPTIONS
+-------
+*-h, --help*::
+    Show the help message
+
+*-v, --version*::
+    Output the version.
+
+
+EXAMPLES
+--------
+Output a passenger config for use with apache.
+
+---------------------------------------------------
+stickler-passenger-config apache2 /var/lib/stickler
+---------------------------------------------------
+
+
+Output a pasenger a config to be integrated with an nginx config.
+-------------------------------------------------
+stickler-passenger-config nginx /var/lib/stickler
+-------------------------------------------------
+
+
+SEE ALSO
+--------
+linkstick:stickler[1], linkstick:stickler-server[1]
+
+
+AUTHOR
+------
+Written by Jeremy Hinegardner <jeremy@hinegardner.org>
+
+
+RESOURCES
+---------
+GitHub project: http://www.github.com/copiousfreetime/stickler
+
+
+BUGS
+----
+Please report bugs to the github issue tracker
+http://github.com/copiousfreetime/stickler/issues
+

data/man/stickler-server.asciidoc

@@ -0,0 +1,87 @@
+STICKLER-SERVER(1)
+==================
+
+NAME
+----
+stickler-server - start and stop the stickler server process
+
+
+SYNOPSIS
+--------
+*stickler-server* ['--help'] ['COMMAND'] ['COMMAND_OPTIONS'] /path/to/stickler/root
+
+
+DESCRIPTION
+-----------
+stickler-server is the daemon process that houses the repositories of
+proprietary gems and/or mirrors of third party gems.
+
+
+COMMANDS
+--------
+[horizontal]
+*start*:: Start the stickler server process
+
+*stop*:: Stop the stickler server process
+
+
+OPTIONS
+-------
+*-d, --daemonize*::
+    Daemonize the server
+
+*--help*::
+    Show the help message
+
+*-h, --host*='HOST'::
+    The host address to bind to (default: 0.0.0.0)
+
+*-o, --port*='PORT'::
+    The port to bind to (default: 6789)
+
+*-p, --pid*='PID_FILE'::
+    Path to wriate a pid file to after daemonizing
+
+*-s, --server*='SERVER'::
+    The rack handler to use: thin, mongrel, webrick, etc.
+
+*-v, --version*::
+    Output the version.
+
+
+EXAMPLES
+--------
+Start the server, daemonized, using /var/lib/stickler as the root directory of
+all the repositories.
+
+---------------------------------------------------
+stickler-server start --daemonize /var/lib/stickler
+---------------------------------------------------
+
+Stop the server that is using /var/lib/stickler as its root directory.
+
+--------------------------------------
+stickler-server stop /var/lib/stickler
+--------------------------------------
+
+
+SEE ALSO
+--------
+linkstick:stickler[1], linkstick:stickler-passenger-config[1]
+
+
+AUTHOR
+------
+Written by Jeremy Hinegardner <jeremy@hinegardner.org>
+
+
+RESOURCES
+---------
+GitHub project: http://www.github.com/copiousfreetime/stickler
+
+
+BUGS
+----
+Please report bugs to the github issue tracker
+http://github.com/copiousfreetime/stickler/issues
+

data/man/stickler.asciidoc

@@ -0,0 +1,148 @@
+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 linkstick:stickler[1] command interacts with an instance of
+linkstick:stickler-server[1] to control the publishing and mirroring of ruby
+gems.
+
+
+COMMANDS
+--------
+[horizontal]
+*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 linkstick:stickler-server[1]
+
+*config*:: Access or update the stickler client configuration.
+
+
+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 linkstick: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.
+
+[horizontal]
+*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 linkstick: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 linkstick: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 --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
+--------
+linkstick:stickler-server[1], linkstick:stickler-passenger-config[1]
+
+
+AUTHOR
+------
+Written by Jeremy Hinegardner <jeremy@hinegardner.org>
+
+
+RESOURCES
+---------
+GitHub project: http://www.github.com/copiousfreetime/stickler
+
+
+BUGS
+----
+Please report bugs to the github issue tracker
+http://github.com/copiousfreetime/stickler/issues

data/spec/middleware/common_gem_server_helpers.rb

@@ -4,9 +4,9 @@ require 'rubygems/server'
 shared_examples_for "common gem server before after" do
 
   before do
-    @spec_dir     = File.join( @gem_dir, "specifications" )
+    @webrick_spec_dir     = File.join( @webrick_gem_dir, "specifications" )
 
-    @webrick           = ::Gem::Server.new(@gem_dir,4567,false)
+    @webrick           = ::Gem::Server.new(@webrick_gem_dir,4567,false)
     @underlying_server = @webrick.instance_variable_get("@server")
     @webrick_thread    = Thread.new( @webrick ) do |webrick|
       webrick.run
@@ -58,6 +58,8 @@ shared_examples_for "common gem server before after" do
         :body =>            last_response.body
       }.should == verify_webrick
     else
+      puts "webrick: #{verify_webrick[:body]}"
+      #puts "sinatra: #{last_response.body}"
       last_response.status.should == verify_webrick[:status]
     end
 

data/spec/middleware/index_spec.rb

@@ -14,12 +14,12 @@ describe Stickler::Middleware::Index do
   end
 
   before do
-    @gem_dir = File.expand_path( File.join( File.dirname( __FILE__ ), "tmp" ) )
-    FileUtils.mkdir_p( File.join( @gem_dir, "specifications" ))
+    @webrick_gem_dir = File.expand_path( File.join( File.dirname( __FILE__ ), "tmp" ) )
+    FileUtils.mkdir_p( File.join( @webrick_gem_dir , "specifications" ))
   end
 
   after do
-    FileUtils.rm_rf( @gem_dir )
+    FileUtils.rm_rf( @webrick_gem_dir )
   end
 
   it_should_behave_like "modern gem server indexes"

data/spec/middleware/legacy_gem_server_behavior.rb

@@ -16,9 +16,7 @@ shared_examples_for "legacy gem server indexes" do
     "/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"
   ]

data/spec/middleware/local_spec.rb

@@ -7,16 +7,16 @@ require 'stickler/middleware/compression'
 
 describe ::Stickler::Middleware::Local do
   def app
-    gem_dir = @gem_dir
+    repo_root = @sinatra_gem_dir 
     ::Rack::Builder.new do
       use ::Stickler::Middleware::Compression
-      use ::Stickler::Middleware::Local, :repo_root => gem_dir
+      use ::Stickler::Middleware::Local, :repo_root => repo_root
       run ::Sinatra::Base
     end
   end
 
   before do
-    @gem_dir      = File.join( @spec_dir, "data" )
+    @sinatra_gem_dir = @webrick_gem_dir = @gem_root
   end
 
   it_should_behave_like "modern gem server indexes"

data/spec/middleware/modern_gem_server_behavior.rb

@@ -10,6 +10,8 @@ shared_examples_for "modern gem server indexes" do
   "/specs.#{Gem.marshal_version}.gz",
   "/latest_specs.#{Gem.marshal_version}",
   "/latest_specs.#{Gem.marshal_version}.gz",
+  "/quick/Marshal.#{Gem.marshal_version}/foo-1.0.0.gemspec.rz",
+  "/quick/Marshal.#{Gem.marshal_version}/bar-1.0.0.gemspec.rz",
   ]
 
   MODERN_URLS.each do |url|

data/spec/paths_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path( File.join( File.dirname( __FILE__ ), "spec_helper.rb" ) )
+
+require 'stickler/paths'
+
+describe Stickler::Paths do
+  it "can access the root dir of the project" do
+    Stickler::Paths.root_dir.should == File.expand_path( File.join( File.dirname( __FILE__ ), ".." ) ) + ::File::SEPARATOR
+  end
+
+  it "can access the lib path of the project" do
+    Stickler::Paths.lib_path.should == File.expand_path( File.join( File.dirname( __FILE__ ), "..", "lib" ) ) + ::File::SEPARATOR
+  end
+end

data/spec/spec_lite_spec.rb

@@ -53,6 +53,20 @@ describe Stickler::SpecLite do
     (@specs[:ruby] =~ @specs[:win]).should == false
   end
 
+  it "can be compared against something with the same name and version but different platform" do
+    list = []
+    list << r = Stickler::SpecLite.new( 'alib', '4.2' )
+    list << u = Stickler::SpecLite.new( 'alib', '4.2', 'x86-mswin32' ) 
+    list.sort.should == [ r, u ]
+  end
+
+  it 'converts platform comparisons to something that can be compared' do
+    list = []
+    list << h2 = Stickler::SpecLite.new( 'htimes', '1.1.1', 'x86-mingw32' )
+    list << h1 = Stickler::SpecLite.new( 'htimes', '1.1.1', 'java' )
+    list.sort.should == [ h1, h2 ]
+  end
+
   it "can be sorted" do
     list = @specs.values
     alib = Stickler::SpecLite.new( 'alib', '4.2' )