htauth 1.0.3 → 1.1.0

data/tasks/this.rb

@@ -0,0 +1,214 @@
+require 'pathname'
+
+# Public: A Class containing all the metadata and utilities needed to manage a
+# ruby project.
+class ThisProject
+  # The name of this project
+  attr_accessor :name
+
+  # The author's name
+  attr_accessor :author
+
+  # The email address of the author(s)
+  attr_accessor :email
+
+  # The homepage of this project
+  attr_accessor :homepage 
+
+  # The regex of files to exclude from the manifest
+  attr_accessor :exclude_from_manifest
+
+  # The hash of Gem::Specifications keyed' by platform
+  attr_accessor :gemspecs
+
+  # Public: Initialize ThisProject
+  #
+  # Yields self
+  def initialize(&block)
+    @exclude_from_manifest = %r/\.(git|DS_Store)|^(doc|coverage|pkg|tmp|Gemfile(\.lock)?)|^[^\/]+\.gemspec|\.(swp|jar|bundle|so|rvmrc)$|~$/
+    @gemspecs              = Hash.new
+    yield self if block_given?
+  end
+
+  # Public: return the version of ThisProject
+  #
+  # Search the ruby files in the project looking for the one that has the
+  # version string in it. This does not eval any code in the project, it parses
+  # the source code looking for the string.
+  #
+  # Returns a String version
+  def version
+    [ "lib/#{ name }.rb", "lib/#{ name }/version.rb" ].each do |v|
+      path = project_path( v )
+      line = path.read[/^\s*VERSION\s*=\s*.*/]
+      if line then
+        return line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+      end
+    end
+  end
+
+  # Internal: Return a section of an RDoc file with the given section name
+  #
+  # path         - the relative path in the project of the file to parse
+  # section_name - the section out of the file from which to parse data
+  #
+  # Retuns the text of the section as an array of paragrphs.
+  def section_of( file, section_name )
+    re    = /^[=#]+ (.*)$/
+    sectional = project_path( file )
+    parts = sectional.read.split( re )[1..-1]
+    parts.map! { |p| p.strip }
+
+    sections = Hash.new
+    Hash[*parts].each do |k,v|
+      sections[k] = v.split("\n\n")
+    end
+    return sections[section_name]
+  end
+
+  # Internal: print out a warning about the give task
+  def task_warning( task )
+    warn "WARNING: '#{task}' tasks are not defined. Please run 'rake develop'"
+  end
+
+  # Internal: Return the full path to the file that is relative to the project
+  # root.
+  #
+  # path - the relative path of the file from the project root
+  #
+  # Returns the Pathname of the file
+  def project_path( *relative_path )
+    project_root.join( *relative_path )
+  end
+
+  # Internal: The absolute path of this file
+  #
+  # Returns the Pathname of this file.
+  def this_file_path
+    Pathname.new( __FILE__ ).expand_path
+  end
+
+  # Internal: The root directory of this project
+  #
+  # This is defined as being the directory that is in the path of this project
+  # that has the first Rakefile
+  #
+  # Returns the Pathname of the directory
+  def project_root
+    this_file_path.ascend do |p|
+      rakefile = p.join( 'Rakefile' )
+      return p if rakefile.exist?
+    end
+  end
+
+  # Internal: Returns the contents of the Manifest.txt file as an array
+  #
+  # Returns an Array of strings
+  def manifest
+    manifest_file = project_path( "Manifest.txt" )
+    abort "You need a Manifest.txt" unless manifest_file.readable?
+    manifest_file.readlines.map { |l| l.strip }
+  end
+
+  # Internal: Return the files that define the extensions
+  #
+  # Returns an Array
+  def extension_conf_files
+    manifest.grep( /extconf.rb\Z/ )
+  end
+
+  # Internal: Returns the gemspace associated with the current ruby platform
+  def platform_gemspec
+    gemspecs[platform]
+  end
+
+  def core_gemspec
+    Gem::Specification.new do |spec|
+      spec.name        = name
+      spec.version     = version
+      spec.author      = author
+      spec.email       = email
+      spec.homepage    = homepage
+
+      spec.summary     = summary
+      spec.description = description
+      spec.license     = license
+
+      spec.files       = manifest
+      spec.executables = spec.files.grep(/^bin/) { |f| File.basename(f) }
+      spec.test_files  = spec.files.grep(/^spec/)
+
+      spec.extra_rdoc_files += spec.files.grep(/(txt|rdoc|md)$/)
+      spec.rdoc_options = [ "--main"  , 'README.md',
+                            "--markup", "tomdoc" ]
+    end
+  end
+
+  # Internal: Return the gemspec for the ruby platform
+  def ruby_gemspec( core = core_gemspec, &block )
+    yielding_gemspec( 'ruby', core, &block )
+  end
+
+  # Internal: Return the gemspec for the jruby platform
+  def java_gemspec( core = core_gemspec, &block )
+    yielding_gemspec( 'java', core, &block )
+  end
+
+  # Internal: give an initial spec and a key, create a new gemspec based off of
+  # it.
+  #
+  # This will force the new gemspecs 'platform' to be that of the key, since the
+  # only reason you would have multiple gemspecs at this point is to deal with
+  # different platforms.
+  def yielding_gemspec( key, core )
+    spec = gemspecs[key] ||= core.dup
+    spec.platform = key
+    yield spec if block_given?
+    return spec
+  end
+
+  # Internal: Set the recovery gem development dependency
+  #
+  # These are dynamically set since they cannot be hard coded as there is 
+  # no way to ship them correctly in the gemspec
+  #
+  # Returns nothing.
+  def set_coverage_gem
+    if RUBY_VERSION < "1.9.0"
+      platform_gemspec.add_development_dependency( 'rcov', '~> 1.0.0' )
+    else
+      platform_gemspec.add_development_dependency( 'simplecov', '~> 0.8.2' )
+    end
+  end
+
+  # Internal: Return the platform of ThisProject at the current moment in time.
+  def platform
+    (RUBY_PLATFORM == "java") ? 'java' : Gem::Platform::RUBY
+  end
+
+  # Internal: Return the DESCRIPTION section of the README.rdoc file
+  def description_section
+    section_of( 'README.md', 'DESCRIPTION')
+  end
+ 
+ # Internal: Return the summary text from the README 
+  def summary
+    description_section.first
+  end
+
+  # Internal: Return the full description text from the READEM
+  def description
+    description_section.join(" ").tr("\n", ' ').gsub(/[{}]/,'').gsub(/\[[^\]]+\]/,'') # strip rdoc
+  end
+
+  def license
+    "ISC"
+  end
+
+  # Internal: The path to the gemspec file
+  def gemspec_file
+    project_path( "#{ name }.gemspec" )
+  end
+end
+
+This = ThisProject.new

metadata

@@ -1,62 +1,101 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: htauth
-version: !ruby/object:Gem::Version 
-  version: 1.0.3
+version: !ruby/object:Gem::Version
+  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Jeremy Hinegardner
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2008-12-21 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
   name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 1.5.0
-    version: 
-description: HTAuth is a pure ruby replacement for the Apache support programs htdigest and htpasswd.  Command line and API access are provided for access to htdigest and htpasswd files.
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: HTAuth is a pure ruby replacement for the Apache support programs htdigest
+  and htpasswd.  Command line and API access are provided for access to htdigest and
+  htpasswd files.
 email: jeremy@copiousfreetime.org
-executables: 
+executables:
 - htdigest-ruby
 - htpasswd-ruby
 extensions: []
-
-extra_rdoc_files: 
-- README
-- HISTORY
+extra_rdoc_files:
+- CONTRIBUTING.md
+- HISTORY.md
+- Manifest.txt
+- README.md
+files:
+- CONTRIBUTING.md
+- HISTORY.md
 - LICENSE
-- lib/htauth/algorithm.rb
-- lib/htauth/crypt.rb
-- lib/htauth/digest.rb
-- lib/htauth/digest_entry.rb
-- lib/htauth/digest_file.rb
-- lib/htauth/entry.rb
-- lib/htauth/file.rb
-- lib/htauth/md5.rb
-- lib/htauth/passwd.rb
-- lib/htauth/passwd_entry.rb
-- lib/htauth/passwd_file.rb
-- lib/htauth/plaintext.rb
-- lib/htauth/sha1.rb
-- lib/htauth/version.rb
-- lib/htauth.rb
-files: 
+- Manifest.txt
+- README.md
+- Rakefile
 - bin/htdigest-ruby
 - bin/htpasswd-ruby
+- lib/htauth.rb
 - lib/htauth/algorithm.rb
 - lib/htauth/crypt.rb
 - lib/htauth/digest.rb
 - lib/htauth/digest_entry.rb
 - lib/htauth/digest_file.rb
 - lib/htauth/entry.rb
+- lib/htauth/errors.rb
 - lib/htauth/file.rb
 - lib/htauth/md5.rb
 - lib/htauth/passwd.rb
@@ -65,7 +104,6 @@ files:
 - lib/htauth/plaintext.rb
 - lib/htauth/sha1.rb
 - lib/htauth/version.rb
-- lib/htauth.rb
 - spec/crypt_spec.rb
 - spec/digest_entry_spec.rb
 - spec/digest_file_spec.rb
@@ -77,45 +115,63 @@ files:
 - spec/plaintext_spec.rb
 - spec/sha1_spec.rb
 - spec/spec_helper.rb
-- README
-- HISTORY
-- LICENSE
-- tasks/announce.rake
-- tasks/distribution.rake
-- tasks/documentation.rake
-- tasks/rspec.rake
-- tasks/rubyforge.rake
-- tasks/config.rb
-- tasks/utils.rb
-- gemspec.rb
-has_rdoc: true
-homepage: http://copiousfreetime.rubyforge.org/htauth
+- spec/test.add.digest
+- spec/test.add.passwd
+- spec/test.delete.digest
+- spec/test.delete.passwd
+- spec/test.original.digest
+- spec/test.original.passwd
+- spec/test.update.digest
+- spec/test.update.passwd
+- tasks/default.rake
+- tasks/this.rb
+homepage: http://github.com/copiousfreetime/htauth
+licenses:
+- ISC
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --line-numbers
-- --inline-source
+rdoc_options:
 - --main
-- README
-require_paths: 
+- README.md
+- --markup
+- tomdoc
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: copiousfreetime
-rubygems_version: 1.3.1
+rubyforge_project: 
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 2
-summary: HTAuth is a pure ruby replacement for the Apache support programs htdigest and htpasswd
-test_files: []
-
+specification_version: 4
+summary: HTAuth is a pure ruby replacement for the Apache support programs htdigest
+  and htpasswd.  Command line and API access are provided for access to htdigest and
+  htpasswd files.
+test_files:
+- spec/crypt_spec.rb
+- spec/digest_entry_spec.rb
+- spec/digest_file_spec.rb
+- spec/digest_spec.rb
+- spec/md5_spec.rb
+- spec/passwd_entry_spec.rb
+- spec/passwd_file_spec.rb
+- spec/passwd_spec.rb
+- spec/plaintext_spec.rb
+- spec/sha1_spec.rb
+- spec/spec_helper.rb
+- spec/test.add.digest
+- spec/test.add.passwd
+- spec/test.delete.digest
+- spec/test.delete.passwd
+- spec/test.original.digest
+- spec/test.original.passwd
+- spec/test.update.digest
+- spec/test.update.passwd

data/HISTORY

@@ -1,26 +0,0 @@
-= Changelog
-== Version 1.0.3 2008-12-20
-
-* update highline dependency
-
-== Version 1.0.2 2008-11-30
-
-=== Minor enhancement 
-
-* Change project layout 
-
-== Version 1.0.1 2008-02-06
-
-=== Bugfixes
-
-* fix require dependency chain
-* fix gem dependency on rake
-
-== Version 1.0.0 2008-02-05
-
-* Initial public release
-
-=== Release Notes
-
-* Look at 'htpasswd-ruby' and 'htdigest-ruby' to get started.
-

data/gemspec.rb

@@ -1,43 +0,0 @@
-require 'rubygems'
-require 'htauth/version'
-require 'tasks/config'
-
-HTAuth::GEM_SPEC = Gem::Specification.new do |spec|
-  proj = Configuration.for('project')
-  spec.name         = proj.name
-  spec.version      = HTAuth::VERSION
-  
-  spec.author       = proj.author
-  spec.email        = proj.email
-  spec.homepage     = proj.homepage
-  spec.summary      = proj.summary
-  spec.description  = proj.description
-  spec.platform     = Gem::Platform::RUBY
-
-  
-  pkg = Configuration.for('packaging')
-  spec.files        = pkg.files.all
-  spec.executables  = pkg.files.bin.collect { |b| File.basename(b) }
-
-  # add dependencies here
-  # spec.add_dependency("rake", ">= 0.8.1")
-  spec.add_dependency("highline", "~> 1.5.0")
-   
-  
-  if rdoc = Configuration.for_if_exist?('rdoc') then
-    spec.has_rdoc         = true
-    spec.extra_rdoc_files = pkg.files.rdoc
-    spec.rdoc_options     = rdoc.options + [ "--main" , rdoc.main_page ]
-  else
-    spec.has_rdoc         = false
-  end 
-
-  if test = Configuration.for_if_exist?('testing') then
-    spec.test_files       = test.files
-  end 
-
-  if rf = Configuration.for_if_exist?('rubyforge') then
-    spec.rubyforge_project  = rf.project
-  end 
-
-end

data/tasks/announce.rake

@@ -1,38 +0,0 @@
-require 'tasks/config'
-#-------------------------------------------------------------------------------
-# announcement methods
-#-------------------------------------------------------------------------------
-
-proj_config = Configuration.for('project')
-namespace :announce do
-  desc "create email for ruby-talk"
-  task :email do
-    info = Utils.announcement
-
-    File.open("email.txt", "w") do |mail|
-      mail.puts "From: #{proj_config.author} <#{proj_config.email}>"
-      mail.puts "To: ruby-talk@ruby-lang.org"
-      mail.puts "Date: #{Time.now.rfc2822}"
-      mail.puts "Subject: [ANN] #{info[:subject]}"
-      mail.puts
-      mail.puts info[:title]
-      mail.puts
-      mail.puts info[:urls]
-      mail.puts 
-      mail.puts info[:description]
-      mail.puts 
-      mail.puts "{{ Release notes for Version #{HTAuth::VERSION} }}"
-      mail.puts 
-      mail.puts info[:release_notes]
-      mail.puts
-      mail.puts info[:urls]
-    end 
-    puts "Created the following as email.txt:"
-    puts "-" * 72
-    puts File.read("email.txt")
-    puts "-" * 72
-  end 
-
-  CLOBBER << "email.txt"
-end
-

data/tasks/config.rb

@@ -1,98 +0,0 @@
-require 'configuration'
-
-require 'rake'
-require 'tasks/utils'
-
-#-----------------------------------------------------------------------
-# General project configuration
-#-----------------------------------------------------------------------
-Configuration.for('project') {
-  name          "htauth"
-  version       "1.0.1"
-  author        "Jeremy Hinegardner"
-  email         "jeremy@copiousfreetime.org"
-  homepage      "http://copiousfreetime.rubyforge.org/htauth"
-  description   Utils.section_of("README", "description")
-  summary       description.split(".").first
-  history       "HISTORY"
-  license       FileList["LICENSE", ]
-  readme        "README"
-}
-
-#-----------------------------------------------------------------------
-# Packaging 
-#-----------------------------------------------------------------------
-Configuration.for('packaging') {
-  # files in the project 
-  proj_conf = Configuration.for('project')
-  files {
-    bin       FileList["bin/*"]
-    lib       FileList["lib/**/*.rb"]
-    test      FileList["spec/**/*.rb", "test/**/*.rb"]
-    data      FileList["data/**/*"]
-    tasks     FileList["tasks/**/*.r{ake,b}"]
-    rdoc      FileList[proj_conf.readme, proj_conf.history,
-                       proj_conf.license] + lib
-    all       bin + lib + test + data + rdoc + tasks 
-  }
-
-  # ways to package the results
-  formats {
-    tgz true
-    zip true
-    rubygem Configuration::Table.has_key?('rubygem')
-  }
-}
-
-#-----------------------------------------------------------------------
-# Gem packaging
-#-----------------------------------------------------------------------
-Configuration.for("rubygem") {
-  spec "gemspec.rb"
-  Configuration.for('packaging').files.all << spec
-}
-
-#-----------------------------------------------------------------------
-# Testing
-#   - change mode to 'testunit' to use unit testing
-#-----------------------------------------------------------------------
-Configuration.for('test') {
-  mode      "spec"
-  files     Configuration.for("packaging").files.test
-  options   %w[ --format specdoc --color ]
-  ruby_opts %w[ ]
-}
-
-#-----------------------------------------------------------------------
-# Rcov 
-#-----------------------------------------------------------------------
-Configuration.for('rcov') {
-  output_dir  "coverage"
-  libs        %w[ lib ]
-  rcov_opts   %w[ --html ]
-  ruby_opts   %w[ ]
-  test_files  Configuration.for('packaging').files.test
-}
-
-#-----------------------------------------------------------------------
-# Rdoc 
-#-----------------------------------------------------------------------
-Configuration.for('rdoc') {
-  files       Configuration.for('packaging').files.rdoc
-  main_page   files.first
-  title       Configuration.for('project').name
-  options     %w[ --line-numbers --inline-source ]
-  output_dir  "doc"
-}
-
-#-----------------------------------------------------------------------
-# Rubyforge 
-#-----------------------------------------------------------------------
-Configuration.for('rubyforge') {
-  project       "copiousfreetime"
-  user          "jjh"
-  host          "rubyforge.org"
-  rdoc_location "#{user}@#{host}:/var/www/gforge-projects/#{project}/htauth"
-}
-
-