homedir 3.0.alpha2 → 3.0.alpha4

data/.travis.yml

@@ -1,5 +1,4 @@
 rvm:
-  - jruby
   - 1.8.7
   - 1.9.2
   - 1.9.3

data/Guardfile

@@ -7,11 +7,15 @@ guard 'bundler' do
   # watch(/^.+\.gemspec/)
 end
 
-guard 'rspec', :version => 2, :cli => "--color --format doc --fail-fast" do
+guard 'rspec', :version => 2, :cli => "--color --format doc" do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
-  watch('spec/factories.rb')  { "spec" }
+  watch(%r{^lib/})                 { "spec/integration" }
+  #watch(%r{^(lib|bin)/})           { "spec/acceptance" }
+  watch(%r{^lib/(.+)\.rb$})        { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')     { "spec" }
+  watch('spec/factories.rb')       { "spec" }
+  watch(%r{^spec/support/.+\.rb})  { "spec" }
+  watch(%r{^spec/examples/})       { "spec" }
 end
 
 

data/README.mkd

@@ -22,7 +22,17 @@ That's it!
 
 ## Support
 
-You can find me on freenode's IRC servers as the user 'docwhat'.  I'm usually on the #homedir channel.
+* File an [issue](https://github.com/docwhat/homedir/issues).
+* Freenode IRC in [`#homedir`](http://webchat.freenode.net/?channels=rvm).
+* Contact me [directly](http://docwhat.org/email).
+
+## Contributing
+
+I love having people help me.  All changes are welcome!
+
+* Submit a [pull request](https://github.com/docwhat/homedir/pulls)
+* Add to the [wiki](https://github.com/docwhat/homedir/wiki).
+* Use the github instant editing feature.
 
 ## The Story So Far…
 

data/homedir.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('factory_girl', ["~> 2.5.2"])
 
   gem.add_development_dependency('yard')
+  gem.add_development_dependency('redcarpet')
 
   gem.add_development_dependency('guard')
   gem.add_development_dependency('guard-rspec')

data/lib/homedir.rb

@@ -2,8 +2,9 @@
 # COPYRIGHT:: Copyright (c) 2012 Christian Höltje
 # LICENSE::   The MIT License. See the file LICENSE distributed with this source.
 require 'homedir/package'
+require 'homedir/catalog'
+require 'homedir/package_discovery_loader'
+require 'homedir/errors'
 
 module Homedir
-  class Error < StandardError
-  end
 end

data/lib/homedir/catalog.rb

@@ -1,8 +1,11 @@
 require 'homedir/errors'
+require 'set'
 
 module Homedir
-  class Catalog < Set
+  class Catalog < ::Set
 
+    # Find the package with the name `name`
+    #
     # @param {String} name The name of the {Homedir::Package package} to find.
     # @return {Homedir::Package} The package that matches the `name`
     def find_by_name name

data/lib/homedir/cli.rb

@@ -1,4 +1,6 @@
 require 'thor'
+require 'homedir'
+require 'pathname'
 
 module Homedir
   # The command line interface for {Homedir}.
@@ -7,7 +9,28 @@ module Homedir
   # information
   class CLI < Thor
 
-    desc "list", "List all known packages."
+    no_tasks do
+      # The directories to scan for repositories
+      #
+      # @return {Enumerable} A list of Pathname objects
+      def repositories
+        [ Pathname.new(ENV['HOME']) + '.homedir' + 'packages']
+      end
+
+      # Helper method to initialize the catalog, if needed.
+      #
+      # @return {Homedir::Catalog} A populated catalog
+      def catalog
+        @catalog ||= Catalog.new.tap do |cat|
+          pdl = PackageDiscoveryLoader.new(cat)
+          repositories.each do |repo|
+            pdl.load_from_directory(repo)
+          end
+        end
+      end
+    end
+
+    desc "list", "Lists available packages."
     method_option(
       :remote,
       :type => :boolean,
@@ -15,8 +38,11 @@ module Homedir
       :aliases => '-r',
       :description => "Queries the remote server")
     def list
-      # FIXME: list needs to do something
-      puts "Not implemented yet"
+      packages = catalog.to_a # TODO sort
+      puts "#{packages.length} local packages found:"
+      packages.each do |package|
+        puts " * #{package}"
+      end
     end
 
     desc "info PACKAGE", "Describe a specific PACKAGE in detail."
@@ -50,6 +76,11 @@ module Homedir
       puts "Not implemented yet #{package_name.inspect}"
     end
 
+    desc "repair", "Scans through your home directory and repairs all links. Warning: This can take a long time."
+    def repair
+      # FIXME: needs to do something
+      puts "Not implemented yet"
+    end
   end
 end
 

data/lib/homedir/errors.rb

@@ -14,4 +14,8 @@ module Homedir
   # message for the list of acceptable characters in a name.
   class InvalidNameError < Error
   end
+
+  # The directory does not contain a package
+  class InvalidPackageDirectoryError < Error
+  end
 end

data/lib/homedir/hacks.rb

@@ -0,0 +1,9 @@
+require 'fileutils'
+require 'pathname'
+
+# This is adds a couple of methods to make my Homedir work better.
+class Pathname
+  def mkdir_p *args
+    FileUtils.mkdir_p(self.to_s, *args)
+  end
+end

data/lib/homedir/package.rb

@@ -20,12 +20,16 @@ module Homedir
       :directory,
     ].freeze
     DEFAULT_VALUES = {
-      :name           => nil,
-      :description    => nil,
-      :dependencies   => [],
-      :post_install   => nil,
-      :pre_uninstall  => nil,
-      :directory      => nil,
+      :name         => nil,
+      :description  => nil,
+      :dependencies => [],
+      :pre_install  => nil,
+      :post_install => nil,
+      :pre_remove   => nil,
+      :post_remove  => nil,
+      :pre_update   => nil,
+      :post_update  => nil,
+      :directory    => nil,
     }.freeze
 
     # The name of the package.
@@ -44,16 +48,40 @@ module Homedir
     # A list of package names this package depends on.
     #
     # When assigning a list, they can either be {Homedir::Package Package} objects or strings.
-    # @return [Enumerable] A list of package {#name names}.
+    # @return [Set] The set of package {#name names}.
     attr_reader :dependencies
 
-    # A script that should run after install.
+    # A script to run before a package is enabled.
+    #
+    # @return {String}
+    attr_accessor :pre_install
+
+    # A script to run after a package is enabled.
     #
     # @return {String}
     attr_accessor :post_install
 
-    # A script to run before install.
-    attr_accessor :pre_uninstall
+    # A script to run before the package is disabled.
+    # @return {String}
+    attr_accessor :pre_remove
+
+    # A script to run after the package is disabled
+    # @return {String}
+    attr_accessor :post_remove
+
+    # A script to run before upgrading the package's source
+    #
+    # This is run before any upgrade steps run for the package source.
+    # @return {String}
+    attr_accessor :pre_update
+
+    # A script that runs after upgrading the package's source
+    #
+    # This is run after a package is upgraded and after the
+    # the package has been re-enabled but before the pre_install
+    # script.
+    # @return {String}
+    attr_accessor :post_update
 
     # The directory where the package is stored.
     #
@@ -62,15 +90,15 @@ module Homedir
     # @return {Pathname}
     attr_reader :directory
 
-    # Create a new {Homedir::Package Package} instance.
+    # Create a new {Package} instance.
     #
     # @param {Hash} options
-    # @option options [String] :name The name of the package.
-    # @option options [String] :description The description of the package.
-    # @option options [Enumerable] :dependencies A list of {Homedir::Package packages} or {String strings}.
-    # @option options [Pathname] :directory The directory the packages is located at.
-    # @option options [String] :post_install Commands to run after installing the package.
-    # @option options [String] :pre_uninstall Commands to run before uninstalling the package.
+    # @option options {String} :name The name of the package.
+    # @option options {String} :description The description of the package.
+    # @option options {Enumerable} :dependencies A list of {Homedir::Package packages} or {String strings}.
+    # @option options {Pathname} :directory The directory the packages is located at.
+    # @option options {String} :post_install Commands to run after installing the package.
+    # @option options {String} :pre_uninstall Commands to run before uninstalling the package.
     def initialize(options = {})
       options = DEFAULT_VALUES.merge(options)
 
@@ -100,7 +128,7 @@ module Homedir
 
     # {include:#dependencies}
     def dependencies= value
-      @dependencies = value.map { |p| p.to_s }
+      @dependencies = Set.new( value.map { |p| p.to_s } )
     end
 
     # {include:#directory}
@@ -159,5 +187,6 @@ module Homedir
     def to_s
       @name
     end
+
   end
 end

data/lib/homedir/package_discovery_loader.rb

@@ -0,0 +1,29 @@
+require 'homedir/package_loader'
+
+module Homedir
+  class PackageDiscoveryLoader
+    attr_reader :catalog
+    def initialize(catalog=nil)
+      @catalog = catalog
+    end
+
+    def loader
+      @loader ||= PackageLoader.new
+    end
+
+    # Recursively loads packages from the directory into {#catalog}
+    #
+    # @params {Pathname} path The directory to start scanning from
+    # @return {Homedir::PackageDiscoveryLoader} self
+    def load_from_directory path
+      if loader.path_is_valid?(path)
+        catalog << loader.load_from_path(path)
+      else
+        path.children.each do |child|
+          load_from_directory(child) if child.directory?
+        end
+      end
+      return self
+    end
+  end
+end

data/lib/homedir/package_loader.rb

@@ -0,0 +1,48 @@
+require 'homedir/errors'
+require 'homedir/package_version1_loader'
+require 'homedir/package_version2_loader'
+require 'homedir/package_version3_loader'
+
+module Homedir
+  class PackageLoader
+
+    # The list of loaders, in the order they should be tried
+    #
+    # @return {Enumerable} A list of package loaders
+    def loaders
+      # The order is important
+      @loaders ||= [
+        PackageVersion3Loader.new,
+        PackageVersion2Loader.new,
+        PackageVersion1Loader.new,
+      ].freeze
+    end
+
+    # Loads a package from a path
+    #
+    # @param {Pathname} path The directory of the package
+    # @return {Homedir::Package} The package object
+    def load_from_path path
+      loaders.each do |loader|
+        begin
+          return loader.load_from_path(path) if loader.path_is_valid?(path)
+        rescue InvalidPackageDirectoryError
+          next
+        end
+      end
+
+      raise InvalidPackageDirectoryError.new("The directory '#{path}' doesn't contain a valid package")
+    end
+
+    # Is the path a valid version1 package directory?
+    #
+    # @return {Boolean} Returns true if the path is a valid package directory.
+    def path_is_valid? path
+      loaders.each do |loader|
+        return true if loader.path_is_valid?(path)
+      end
+      return false
+    end
+
+  end
+end

data/lib/homedir/package_version1_loader.rb

@@ -0,0 +1,70 @@
+require 'homedir/package'
+require 'homedir/errors'
+
+module Homedir
+  class PackageVersion1Loader
+
+    # Loads a package from a path
+    #
+    # @param {Pathname} path The directory of the package
+    # @return {Homedir::Package} The package object
+    def load_from_path(path)
+      raise InvalidPackageDirectoryError.new("The directory '#{path}' is not a version 1 package.") unless path_is_valid?(path)
+      control_path = path + '.homedir.control'
+
+      control = parse_control_file control_path
+
+      pkg = Package.new( :directory => path )
+
+      pkg.name = control[:package]
+      pkg.description = control[:description] || ''
+      pkg.dependencies = (control[:depends] || '').split("\n")
+
+      return pkg
+    end
+
+    # Is the path a valid version1 package directory?
+    #
+    # @return {Boolean} Returns true if the path is a valid package directory.
+    def path_is_valid? path
+      return false unless (path).directory?
+      return false unless (path + '.homedir.control').file?
+      return true
+    end
+
+    # Parse a control file
+    #
+    # @param {Pathname} path The path to control file
+    # @return {Hash} A hash containing the keys/values.
+    # @see {#parse_control_stream}
+    def parse_control_file path
+      path.open('r') { |f| parse_control_stream f }
+    end
+
+    # Parse a version 1 control from a stream
+    #
+    # This is *not* a robust parser.
+    # @param {IO} stream An IO stream to read from
+    # @return {Hash} A hash containing the keys/values.
+    def parse_control_stream stream
+      contents = stream.read()
+
+      hash = {}
+      last_key = nil
+      last_value = nil
+      contents.split(/[\r\n]+/).each do |line|
+        next if line =~ /^\s*#/
+        if line =~ /^\s/
+          last_value << line.strip unless last_key.nil?
+        elsif line.include? ":"
+          hash[last_key.to_sym] = last_value.join("\n") unless last_key.nil?
+          last_key, value = line.split(/\s*:\s*/, 2)
+          last_value = value.strip.empty? ? [] : [ value.strip ]
+        end
+      end
+      hash[last_key.to_sym] = last_value.join("\n") unless last_key.nil?
+
+      return hash
+    end
+  end
+end

data/lib/homedir/package_version2_loader.rb

@@ -0,0 +1,48 @@
+require 'homedir/package'
+require 'homedir/package_version1_loader'
+require 'homedir/errors'
+
+module Homedir
+  class PackageVersion2Loader < PackageVersion1Loader
+
+    # Loads a package from a path
+    #
+    # @param {Pathname} path The directory of the package
+    # @return {Homedir::Package} The package object
+    def load_from_path(path)
+      raise InvalidPackageDirectoryError.new("The directory '#{path}' is not a version 2 package.") unless path_is_valid?(path)
+      control_path = path + '.homedir' + 'control'
+
+      control = parse_control_file control_path
+
+      pkg = Package.new( :directory => path )
+
+      pkg.name = control[:package]
+      pkg.description = control[:description] || ''
+      pkg.dependencies = (control[:depends] || '').split("\n")
+
+      ['pre', 'post'].each do |prefix|
+        ['install', 'remove'].each do |action|
+          filepath = (path + ".homedir" + "#{prefix}-#{action}")
+          if filepath.file? and filepath.executable?
+            filepath.open('r') do |f|
+              pkg.send("#{prefix}_#{action}=", f.read())
+            end
+          end
+        end
+      end
+
+      return pkg
+    end
+
+    # Is the path a valid version2 package directory?
+    #
+    # @return {Boolean} Returns true if the path is a valid package directory.
+    def path_is_valid? path
+      return false unless (path).directory?
+      return false unless (path + '.homedir').directory?
+      return false unless (path + '.homedir' + 'control').file?
+      return true
+    end
+  end
+end