stickler 0.1.1 → 2.0.0a

data/lib/stickler/repository.rb

@@ -1,502 +1,10 @@
-
-# Copyright (c) 2008 Jeremy Hinegardner
-# All rights reserved.  Licensed under the same terms as Ruby.  No warranty is
-# provided.  See LICENSE and COPYING for details.
-#++
-
-require 'stickler'
-require 'fileutils'
-require 'ostruct'
-require 'highline'
-require 'stickler/configuration'
-require 'stickler/source_group'
+require 'stickler/error'
+require 'rubygems/format'
+require 'rubygems/platform'
+require 'rubygems/dependency'
 
 module Stickler
-  # 
-  # A Repository a directory with a particular layout used by stickler.  It is
-  # is very similar to a GEM_HOME directory.   The layout is as follows, this is
-  # all assumed to be under STICKLER_HOME.
-  #
-  #   stickler.yml    - the Stickler configuration file for this repository.
-  #                     The existence of this file indicates this is the root 
-  #                     of a stickler repository
-  #   gems/           - storage of the actual gem files
-  #   cache/          - cache of gem files downloaded from upstream sources
-  #                     managed by the rubygems fetcher classes
-  #   specifications/ - ruby gemspec files 
-  #   log/            - directory holding rotating logs files for stickler
-  #   dist/           - directory holding the distributable gem index location,
-  #                     rsync this to your webserver, or serve from it directly.
-  #
-  #
-  class Repository
-    class Error < ::StandardError ; end
-
-    # The repository directory.  the directory containing the stickler.yml file
-    attr_reader :directory
-
-    # The configuration
-    attr_reader :configuration
-
-    # Are requrements satisfied in a minimal or maximal approach
-    attr_reader :requirement_satisfaction_behavior
-
-    class << self
-      def other_dir_names 
-        %w[ gems_dir log_dir specification_dir dist_dir cache_dir ]
-      end
-
-      def config_file_basename
-        "stickler.yml"
-      end
-
-      def basedir
-        "stickler"
-      end
-
-      # 
-      # What should the default stickler directory be, this is one of two
-      # things.  If there is a stickler.yml file in the current directory, then
-      # the default directory is the current directory, otherwise, it is the
-      # _stickler_ directory below the current_directory
-      #
-      def default_directory
-        defaults = [ File.join( Dir.pwd, config_file_basename ), File.join( Dir.pwd, basedir ) ]
-        defaults.each do |def_dir|
-          if File.exist?( def_dir ) then
-            return File.dirname( def_dir ) if File.file?( def_dir )
-            return def_dir
-          end
-        end
-        return defaults.last
-      end
-
-      #
-      # gem requirement information 
-      #
-      def requirement_meta
-        [ [ "="  , "Equals version" ],
-          [ "!=" , "Not equal to version" ],
-          [ ">"  , "Greater than version" ],
-          [ "<"  , "Less than version" ],
-          [ ">=" , "Greater than or equal to" ],
-          [ "<=" , "Less than or equal to" ],
-          [ "~>" , "Approximately greater than" ]]
-      end
-    end
-
-    #
-    # Initialize a stickler repository
-    #
-    def initialize( opts )
-
-      @directory = File.expand_path( opts['directory'] )
-      @requirement_satisfaction_behavior = ( opts['requirements'] || "maximum" ).to_sym
-      enhance_logging( opts ) if File.directory?( log_dir )
-      @overwrite = opts['force']
-
-      @configuration = nil
-      load_configuration if File.exist?( config_file )
-
-    end
-
-    def configuration_loaded?
-      @configuration.nil?
-    end
-
-    #
-    # should existing items be overwritten
-    #
-    def overwrite?
-      @overwrite
-    end
-
-    #
-    # update logging by turning on a log file in the repository directory, and
-    # possibly turning off the stdout logger that is the default.
-    #
-    def enhance_logging( opts )
-
-      layout = ::Logging::Layouts::Pattern.new(
-        :pattern      => "[%d] %c %6p %5l : %m\n",
-        :date_pattern => "%Y-%m-%d %H:%M:%S"
-      )
-      Logging::Logger.root.add_appenders ::Logging::Appenders::RollingFile.new( 'stickler_rolling_logfile',
-                                                                 { :filename => log_file,
-                                                                   :layout   => layout,
-                                                                   # at 5MB roll the log
-                                                                   :size     => 5 * (1024**2),
-                                                                   :keep     => 5,
-                                                                   :safe     => true,
-                                                                   :level    => :debug
-                                                                  }) 
-    end
-
-    #
-    # return a handle to the repository configuration found in stickler.yml.
-    #
-    def load_configuration
-      begin
-        @configuration = Configuration.new( config_file )
-        source_group # force load
-      rescue => e
-        logger.error "Failure to load configuration #{e}"
-        exit 1
-      end
-    end
-
-    #
-    # The configuration file for the repository
-    # 
-    def config_file
-      @config_file ||= File.join( directory, Repository.config_file_basename )
-    end
-
-    #
-    # The log directory
-    #
-    def log_dir
-      @log_dir ||= File.join( directory, 'log' )
-    end
-
-    #
-    # The log file 
-    #
-    def log_file
-      @log_file ||= File.join( log_dir, 'stickler.log' )
-    end
-
-    #
-    # The gem storage directory.  
-    #
-    # This holds the raw gem files downloaded from the sources.  This is
-    # equivalent to a gem installations 'gems' directory.
-    #
-    def gems_dir
-      @gems_dir ||= File.join( directory, 'gems' )
-    end
-
-    #
-    # The Gem specification directory
-    #
-    def specification_dir
-      @specification_dir ||= File.join( directory, 'specifications' )
-    end
-
-    #
-    # The cache dir for the downloads
-    #
-    def cache_dir
-      @cache_dir ||= File.join( directory, 'cache' )
-    end
-
-    #
-    # The Distribution directory
-    #
-    # this is the document root for the webserver that will serve your rubygems.
-    # Or they can be served directly from this location
-    #
-    def dist_dir
-      @dist_dir ||= File.join( directory, 'dist' )
-    end
-
-    #
-    # logging handler
-    #
-    def logger
-      @logger ||= ::Logging::Logger[self]
-    end
-
-    # 
-    # The SourceGroup containing all of the sources for this repository
-    #
-    def source_group
-      unless @source_group
-        sg = SourceGroup.new( self )
-        Console.info "Setting up sources"
-        configuration.sources.each do |source_uri|
-          sg.add_source( source_uri )
-        end
-        @source_group = sg 
-      end 
-      return @source_group
-    end
-
-    #
-    # Is the repository valid?
-    #
-    def valid?
-      if @valid.nil? then 
-        begin
-          valid!
-          @valid = true
-        rescue StandardError => e
-          logger.error "Repository is not valid : #{e}"
-          @valid = false
-        end
-      end
-      return @valid
-    end
-
-    #
-    # raise an error if the repository is not valid
-    #
-    def valid!
-      raise Error, "#{directory} does not exist" unless File.exist?( directory )
-      raise Error, "#{directory} is not writable" unless File.writable?( directory )
-
-      raise Error, "#{config_file} does not exist" unless File.exist?( config_file )
-      raise Error, "#{config_file} is not loaded" unless configuration
-
-      Repository.other_dir_names.each do |method|
-        other_dir = self.send( method )
-        raise Error, "#{other_dir} does not exist" unless File.exist?( other_dir )
-        raise Error, "#{other_dir} is not writeable" unless File.writable?( other_dir )
-      end
-
-      if File.exist?( log_file ) then
-        raise Error, "#{log_file} is not writable" unless File.writable?( log_file )
-      end
-    end
-
-    #
-    # Setup the repository. 
-    #
-    # This is executed with the 'setup' mode on the command line. Only those
-    # files and directories that do not already exist are created.  Nothing is
-    # destroyed.
-    # 
-    def setup 
-      if File.exist?( directory ) then
-        Console.info "repository root already exists #{directory}"
-      else
-        FileUtils.mkdir_p( directory ) 
-        Console.info "created repository root #{directory}"
-      end
-
-      Repository.other_dir_names.each do |method|
-        d = self.send( method )
-        if File.exist?( d ) then
-          Console.info "directory #{d} already exists"
-        else
-          FileUtils.mkdir_p( d ) 
-          Console.info "created directory #{d}"
-        end
-      end
-
-      if overwrite? or not File.exist?( config_file ) then
-        FileUtils.cp Stickler::Paths.data_path( Repository.config_file_basename ), config_file
-        Console.info "copied in default configuration to #{config_file}"
-      else
-        Console.info "configuration file #{config_file} already exists"
-      end
-
-      # load the configuration for the repo
-      load_configuration
-
-    rescue => e
-      $stderr.puts "Unable to setup the respository"
-      $stderr.puts e
-      $stderr.puts e.backtrace.join("\n")
-      exit 1
-    end
-
-    #
-    # Report information about the repository.  This is what is called from the
-    # 'info' mode on the commandline
-    #
-    def info
-      return unless valid?
-
-      Console.info ""
-      Console.info "Upstream Sources"
-      Console.info "----------------"
-      Console.info ""
-
-      max_width = configuration.sources.collect { |s| s.length }.max
-      source_group.sources.each do |source|
-        Console.info "  #{source.uri.to_s.rjust( max_width )} : #{source.source_specs.size} gems available"
-        Console.info "  #{" ".rjust( max_width )} : #{source_group.existing_specs_for_source_uri( source.uri ).size} gems existing"
-      end
-
-
-      Console.info ""
-      Console.info "Configured gems (in stickler.yml)"
-      Console.info "---------------------------------"
-      Console.info ""
-      configuration.gem_dependencies.sort.each do |dep|
-        Console.info "#{dep.name} : #{dep.version_requirements}"
-      end
-
-      Console.info ""
-      Console.info "Existing gems"
-      Console.info "-------------"
-      Console.info ""
-
-      source_group.gems.keys.sort.each do |g|
-        puts g
-      end
-
-
-    end
-
-    #
-    # Add a source to the repository
-    #
-    def add_source( source_uri )
-      load_configuration unless configuration_loaded?
-      if configuration.sources.include?( source_uri ) then
-        Console.info "#{source_uri} already in sources"
-      else
-        source_group.add_source( source_uri )
-        configuration.sources << source_uri
-        configuration.write
-        Console.info "#{source_uri} added to sources"
-      end
-    end
-
-    #
-    # Remove a source from the repository
-    #
-    def remove_source( source_uri )
-      load_configuration unless configuration_loaded?
-      uri = ::URI.parse source_uri
-      if configuration.sources.delete( source_uri ) then
-        source_group.remove_source( source_uri )
-        configuration.write
-        Console.info "#{source_uri} removed from sources"
-      else
-        Console.info "#{source_uri} is not one of your sources"
-        Console.info "Your sources are:"
-        configuration.sources.each do |src|
-          Console.info "  #{src}"
-        end
-      end
-    end
-
-    #
-    # Add a gem to the repository
-    #
-    def add_gem( gem_name, version )
-
-      Console.info ""
-
-      ::HighLine.track_eof = false
-      hl = ::HighLine.new( STDIN, STDOUT, :auto)
-      hl.say("You need to pick the #{gem_name} Requirement to configure Stickler.")
-      hl.say("This involves picking one of the following Requirement operators")
-      hl.say('See http://docs.rubygems.org/read/chapter/16#page74 for operator info.')
-      hl.say("\nYou need to (1) pick an operator and (2) pick a requirement.")
-      hl.say("The most common operators are >=, > and ~>")
-
-      op = hl.choose(*Repository.requirement_meta.collect { |k,v| "#{k.ljust(3)}#{v}" } ) do |m|
-        m.prompt =  "(1) Pick an operator ? "
-      end
-
-      op = op.split.first # get only the operator, not the trailing text
-
-      version = ::Gem::Requirement.default if version == :latest
-      search_pattern = ::Gem::Dependency.new( gem_name, version ) 
-      choices = []
-      source_group.search( search_pattern ).each do |spec|
-        choices << "#{op} #{spec.version.to_s}"
-      end
-      choices = choices.sort.reverse
-
-      hl.say("\nNow to pick a requirement.  Based upon your chosen operator '#{op}',")
-      hl.say("These are the available version of the #{gem_name} gem.")
-      requirement = hl.choose do |m|
-        m.flow = :columns_down
-        m.prompt = "(2) Pick a requirement ? "
-        m.choices( *choices )
-      end
-
-      Console.info ""
-
-      dep = ::Gem::Dependency.new( gem_name, requirement ) 
-      if configuration.gem_dependencies.include?( dep ) then
-        Console.info "#{dep} is already in your list of gems"
-      else
-        source_group.add_from_dependency( dep )
-        configuration.gem_dependencies << dep 
-        configuration.write
-      end
-    end
-
-    #
-    # Remove a gem from the repository
-    #
-    def remove_gem( gem_name, version )
-      Console.info ""
-      version = ::Gem::Requirement.default if version == :all
-      search_pattern = ::Gem::Dependency.new( gem_name, version )
-      ulist = source_group.search_existing( search_pattern )
-      source_group.search_existing( search_pattern ).each do |spec|
-        source_group.remove( spec )
-        configuration.gem_dependencies.reject! { |d| d.name == spec.name }
-      end
-      configuration.write
-    end
-
-    #
-    # Sync the repository
-    #
-    def sync( rebuild = false )
-      Console.info ""
-      Console.info "Making sure that all gems listed in configuration are available"
-      Console.info ""
-
-      if rebuild then
-        Console.info "Removing existing gems and specifications ... "
-        Dir[ File.join( gems_dir, "*.gem" ) ].each { |g| FileUtils.rm_f g }
-        Dir[ File.join( specification_dir , "*.gemspec" ) ].each { |s| FileUtils.rm_f s }
-      end
-      configuration.gem_dependencies.each do |dep|
-        source_group.add_from_dependency( dep )
-      end
-    end
-
-    #
-    # generate the system configuration to be used by rubygem clients of the
-    # repository that stickler managers
-    #
-    def generate_sysconfig( to = $stdout )
-      Console.info "Generating configuration to stdout"
-      txt = <<-cfg
-#
-# This is the system wide configuration to be used by
-# rubygem clients that install gems from the repository
-# located at :
-#
-#   #{configuration.downstream_source}
-#
-# On Unix like machines install in
-#
-#   /etc/gemrc
-#
-# On Windows machines install in
-#
-#   C:\\Documents and Settings\\All Users\\Application Data\\gemrc
-#
----
-:sources:
-- #{configuration.downstream_source}
-cfg
-      to.puts txt
-    end
-
-    #
-    # Generate the gem index that can be rsynced to another location
-    #
-    #
-    def generate_index
-      require 'rubygems/indexer'
-      Console.info "Generating rubygems index in #{dist_dir}"
-      FileUtils.rm_rf dist_dir
-      FileUtils.mkdir_p dist_dir
-      FileUtils.cp_r gems_dir, dist_dir
-      indexer = ::Gem::Indexer.new dist_dir
-      indexer.generate_index
-    end
+  module Repository
+    class Error < ::Stickler::Error ; end 
   end
-end 
+end

data/lib/stickler/spec_lite.rb

@@ -1,3 +1,6 @@
+require 'rubygems/platform'
+require 'rubygems/version'
+
 module Stickler
   #
   # A lightweight version of a gemspec that only responds to name, version,
@@ -6,43 +9,86 @@ module Stickler
   # encapsulates that.
   #
   class SpecLite
+    include Comparable
+
     attr_reader :name
     attr_reader :version
     attr_reader :platform
 
-    def initialize( name, version, platform )
+    def initialize( name, version, platform = Gem::Platform::RUBY )
       @name = name
-      @version = version
-      @new_platform = Gem::Platform.new( platform )
-      @platform = platform
+      @version = Gem::Version.new( version )
+      @platform = Gem::Platform.new( platform )
     end
 
     def full_name
       if platform == Gem::Platform::RUBY or platform.nil? then
-        "#{name}-#{version}"
+        name_version
       else
-        "#{name}-#{version}-#{platform}"
+        "#{name_version}-#{platform}"
       end
     end
+    alias :to_s :full_name
+
+    def file_name
+      full_name + ".gem"
+    end
+
+    def spec_file_name
+      full_name + ".gemspec"
+    end
 
     def name_version
       "#{name}-#{version}"
     end
 
     def to_a
+      [ name, version.to_s, platform.to_s ]
+    end
+
+    # 
+    # Convert to the array format used by rubygems itself
+    #
+    def to_rubygems_a
       [ name, version, platform.to_s ]
     end
 
-    def to_s
-      full_name
+    #
+    # Lets be comparable!
+    #
+    def <=>(other)
+      return 0 if other.object_id == self.object_id
+      other = coerce( other )
+      [ :name, :version, :platform ].each do |method|
+        result = ( self.send( method ).<=>( other.send( method ) ) )
+        return result unless 0 == result
+      end
+      return 0
+    end
+
+    #
+    # See if another Spec is the same as this spec
+    #
+    def =~(other)
+      other = coerce( other )
+      return (other and 
+              self.name == other.name and
+              self.version.to_s == other.version.to_s and
+              self.platform == other.platform )
     end
-  end
-end
 
-module Gem
-  class Specification
-    def name_version
-      "#{name}-#{version}"
+    private
+
+    def coerce( other )
+      if self.class === other then
+        other
+      elsif other.respond_to?( :name ) and 
+            other.respond_to?( :version ) and 
+            other.respond_to?( :platform ) then
+        SpecLite.new( other.name, other.version, other.platform )
+      else
+        return false
+      end
     end
   end
 end

data/lib/stickler/version.rb

@@ -3,16 +3,16 @@
 # All rights reserved.  Licensed under the same terms as Ruby.  No warranty is
 # provided.  See LICENSE and COPYING for details.
 #++
-#
+
 module Stickler
 
   # Version access in every possibly way that people might want to get it.
   #
   module Version
 
-    MAJOR = 0
-    MINOR = 1
-    BUILD = 1
+    MAJOR = 2
+    MINOR = 0
+    BUILD = 0
 
     def self.to_ary
       [ MAJOR, MINOR, BUILD ]
@@ -27,10 +27,10 @@ module Stickler
     end
 
     # Version string constant
-    STRING = Version.to_s.freeze
+    STRING = Version.to_s
     
   end
 
   # Version string constant
-  VERSION = Version.to_s.freeze
+  VERSION = Version.to_s
 end

data/lib/stickler/web.rb

@@ -0,0 +1,19 @@
+require 'stickler/middleware/compression'
+require 'stickler/middleware/gemcutter'
+require 'stickler/middleware/mirror'
+require 'stickler/middleware/index'
+require 'rack/cascade'
+
+module Stickler
+  class Web < ::Sinatra::Base
+
+    disable :sessions
+    enable  :logging, :dump_errors, :clean_trace
+
+    use Stickler::Middleware::Compression
+    use Stickler::Middleware::Gemcutter, :serve_indexes => false
+    use Stickler::Middleware::Mirror,    :serve_indexes => false
+    use Stickler::Middleware::Index,     :serve_indexes => true
+    run Stickler::Middleware::NotFound
+  end
+end

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

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bar}
+  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{bar gem}
+  s.email = %q{jeremy@hinegardner.org}
+  s.files = ["README.rdoc", "lib/bar.rb", "bin/bar", "Rakefile", "bar.gemspec"]
+  s.homepage = %q{http://github.com/copiousfreetime/stickler}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{bar 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
+