umount-many 0.1.4 → 0.2.0

data/README.md

@@ -0,0 +1,10 @@
+umount-many
+===========
+
+`umount-many` is a little tool which allows you to unmount several file systems
+at once by using filters. For example, if you want to unmount every VFAT
+file system in reversed order, simply enter this at the command line:
+
+    umount-many -t vfat -R
+
+For a complete list, call `umount-many` with the `-h` option.

data/Rakefile

@@ -2,10 +2,9 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "umount-many"
-    gem.executables = "umount-many"
     gem.summary = "Unmount several devices based on filters"
     gem.email = "sin3141592@gmail.com"
-    gem.homepage = "http://github.com/sin3141592/umount-many"
+    gem.homepage = "https://github.com/sin3141592/umount-many"
     gem.description = gem.summary
     gem.authors = ["Hagbard Celine"]
   end

data/TODO

@@ -1,2 +1 @@
-- Write a bit of documentation
-- Of course fix the TODO's placed in the code
+- Of course fix the TODOs placed in the code

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/bin/umount-many

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # coding: utf-8
 
-require 'optparse'
-require File.join(File.dirname(__FILE__), "..", "lib", "umount-many")
+require "optparse"
+require File.expand_path("../../lib/umount-many", __FILE__)
 
 def main
   opts = Hash.new
@@ -54,7 +54,7 @@ def main
       opts[:reverse] = true
     end
   end.parse!
-  unmount_many_fs(opts)
+  UmountMany.unmount_many_fs(opts)
 end
 
-main
+main if $0 == __FILE__

data/lib/core_ext/hash.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+module HashValuesAt
+  # Works similiar to the +values_at+ method but return
+  # instead of just values an appropriate hash
+  def hash_at(*keys)
+    hash = Hash.new
+    keys.zip(self.values_at(*keys)).each {|k, v| hash[k] = v}
+    hash
+  end
+end
+
+class Hash
+  include HashValuesAt
+end

data/lib/umount-many.rb

@@ -4,124 +4,163 @@
 # == umount-many
 # umount-many allows you to unmount several file systems at once
 # You can specify several filter types to select the desired file systems
-# For example: 
+# For example:
 #   +umount-many -t ext4+
 # This command unmounts every file system that has ext4 as file system type
 # For a list of all filters use the +-h+ or +--help+ command line option
 
 require 'optparse'
 require 'set'
+require File.expand_path("../core_ext/hash.rb", __FILE__)
 
-class Hash
-  # Works similiar to the +values_at+ method but return
-  # instead of just values an appropriate hash
-  def hash_at(*keys)
-    hash = Hash.new
-    keys.zip(self.values_at(*keys)).each {|k, v| hash[k] = v}
-    hash
-  end
-end
+module UmountMany
+  # Retrieve a list of all mounted file system. Return an array with hashes
+  # of the following form_
+  # * +:device+: The device file (in +/dev+) from which the file system is
+  #   mounted.
+  # * +:mount_point+: The directory to which the file system is mounted
+  # * +:type+: The file system type (e.g. +ext4+).
+  # * +:options+: An array of options such as +rw+ and +nosuid+.
+  def self.parse_file_systems
+    # TODO: Currently calls +mount+ and parses stdout. Not such a good
+    # approach, is it?
+    # TODO: I just can the regex gurantee to work for my box (which is a linux
+    # 2.6.31 with +mount+ from util-linux-ng 2.16)
 
-def parse_file_systems
-  # TODO: Currently calls +mount+ and parses stdout. Not such a good 
-  # approach, is it?
-  # TODO: I just can the regex gurantee to work for my box (which is a linux
-  # 2.6.31 with +mount+ from util-linux-ng 2.16)
-  
-  filesystems = []
-  IO.popen("mount") do |pipe|
-    pipe.each_line do |line|
-      if line =~ /([^\s]+) on ([^\s]+) type ([^\s]+) \((.*)\)/
-        filesystems.push({:device => $1, :mount_point => $2, :type => $3, 
-                          :options => $4.split(",")})
-      else
-        STDERR.puts("Couldn't parse output from mount. " +
-                    "Skipping current line")
+    filesystems = []
+    IO.popen("mount") do |pipe|
+      pipe.each_line do |line|
+        if line =~ /([^\s]+) on ([^\s]+) type ([^\s]+) \((.*)\)/
+          filesystems.push({:device => $1, :mount_point => $2, :type => $3,
+                            :options => $4.split(",")})
+        else
+          STDERR.puts("Couldn't parse output from mount. " +
+                      "Skipping current line")
+        end
       end
     end
+    filesystems
   end
-  filesystems
-end
-
-def filter_by_device(filesystems, device)
-  filesystems.select {|e| e[:device] == device}
-end
-
-def filter_by_mount_point(filesystems, mp)
-  filesystems.select {|e| e[:mount_point] == mp}
-end
 
-def filter_by_type(filesystems, type)
-  filesystems.select {|e| e[:type].downcase == type.downcase}
-end
+  # Check if a file system is mounted from +device+.
+  def self.filter_by_device(filesystems, device)
+    filesystems.select {|e| e[:device] == device}
+  end
 
-def filter_by_options(filesystems, option)
-  filesystems.select {|e| e[:options].include?(option)}
-end
+  # Check if a file system is mounted on +mp+.
+  def self.filter_by_mount_point(filesystems, mp)
+    filesystems.select {|e| e[:mount_point] == mp}
+  end
 
-def collect_filters(opts)
-  filters = []
-  opts.hash_at(:mount_point, :device, :type, :options).each do |filter, v|
-    filters.push filter if v && !v.empty?
+  # Check if a file system is of the given +type+.
+  def self.filter_by_type(filesystems, type)
+    filesystems.select {|e| e[:type].downcase == type.downcase}
   end
-  filters.map{|e| [method("filter_by_" + e.to_s), e]}
-end
 
-def report_results(to_unmount, format)
-  unless ["yaml", "json", "xml"].include?(format)
-    puts "Not a supported format for reporting: #{format}"
-    puts "See the help (-h) for a list"
-    exit 2
+  # Check if all given +options+ are set on a file system
+  def self.filter_by_options(filesystems, option)
+    # TODO: Check whether e[:options] contains *all* set options
+    # (e[:options] & options == options)
+    # Rename option to options
+    filesystems.select {|e| e[:options].include?(option)}
   end
-  if format.downcase == "xml"
-    STDERR.puts "WARNING: XML format is experimental."
-    require 'xmlsimple'
-    puts XmlSimple.xml_out(to_unmount)
-  else
-    require format
-    meth = to_unmount.method("to_" + format)
-    puts meth.call
+
+  # See which filters are set in +opts+ and return an array of the form
+  # <tt>[[filter_by_foo, foo], ...]</tt>. +filter_by_foo+ is a method object
+  # representing the according methods defined in this module. +foo+ is string
+  # naming the filter.
+  def self.collect_filters(opts)
+    filters = []
+    opts.hash_at(:mount_point, :device, :type, :options).each do |filter, v|
+      filters.push filter if v && !v.empty?
+    end
+    filters.map{|e| [method("filter_by_" + e.to_s), e]}
   end
-end
 
-def unmount_devices(devices, verbose)
-  devices.each do |device|
-    if verbose
-      print ("Unmounting #{device[:device]} mounted on " +
-             "#{device[:mount_point]}... ")
+  # Serialize the matched file system in the given +format+. Available
+  # are YAML, JSON and XML (this requires the +xmlsimple+ library). YAML and
+  # JSON use stdlib libraries.
+  def self.report_results(to_unmount, format)
+    unless ["yaml", "json", "xml"].include?(format)
+      puts "Not a supported format for reporting: #{format}"
+      puts "See the help (-h) for a list"
+      exit 2
+    end
+    if format.downcase == "xml"
+      STDERR.puts "WARNING: XML format is experimental."
+      require 'xmlsimple'
+      puts XmlSimple.xml_out(to_unmount)
+    else
+      require format
+      meth = to_unmount.method("to_" + format)
+      puts meth.call
     end
-    system "umount \"#{device[:device]}\""
-    # Needed because umount takes a bit of time
-    sleep 0.2
-    puts "DONE" if verbose
   end
-end
 
-def matched_devices(opts)
-  filesystems = parse_file_systems
-  filters = collect_filters(opts)
-  to_unmount = Set.new
-  results = filters.map {|meth, name| meth.call(filesystems, opts[name])}
-  results.each {|devices| to_unmount += Set.new(devices)}
-  to_unmount = to_unmount.to_a
-  to_unmount.reverse! if opts[:reverse]
-  to_unmount
-end
+  # Actually unmount all the given devices. If +verbose+ is +true+, print every
+  # file system before it is unmounted.
+  def self.unmount_devices(devices, verbose)
+    devices.each do |device|
+      if verbose
+        print ("Unmounting #{device[:device]} mounted on " +
+              "#{device[:mount_point]}... ")
+      end
+      system "umount \"#{device[:device]}\""
+      # Needed because umount takes a bit of time
+      sleep 0.2
+      puts "DONE" if verbose
+    end
+  end
 
-def unmount_many_fs(opts)
-  if opts[:all]
-    to_unmount = parse_file_systems
-  else 
-    to_unmount = matched_devices(opts)
+  # Collect the mounted file systems and apply the given filters. Return an
+  # array of hashes. For a description of this data structure see
+  # +parse_file_systems+.
+  def self.matched_devices(opts)
+    filesystems = parse_file_systems
+    filters = collect_filters(opts)
+    to_unmount = Set.new
+    results = filters.map {|meth, name| meth.call(filesystems, opts[name])}
+    results.each {|devices| to_unmount += Set.new(devices)}
+    to_unmount = to_unmount.to_a
+    to_unmount.reverse! if opts[:reverse]
+    to_unmount
   end
-  if opts[:simulate]
-    to_unmount.each do |device|
-      puts ("#{device[:device]} mounted on #{device[:mount_point]} as " +
-            "#{device[:type]}")
+
+  # Main interface to +umount-many+.
+  # +opts+ is a Hash which may consist of the
+  # following keys (+nil+ is the default for all keys)
+  # * +:mount_point+: A path which points to the mounted directory.
+  # * +:device+: A path to the device file (in +/dev+).
+  # * +:type+: The file system (e.g. +ext4+).
+  # * +:options+: An array of set options (e.g. +rw+ or +nosuid+). If all of
+  #   these options are set (additional may be set as well), unmount it.
+  # * +:all+: Unmount all of them (merely because we can).
+  # * +:simulate+: If true, do not unmount a single file system, but print
+  #   the collected ones to the screen (see +:reporting as well). This is
+  #   recommended to check whether the used filters match the correct
+  #   file systems.
+  # * +:reporting+: Similar to +:simulate+, but instead of printing in a human
+  #   readable format, print in a standardized and easy parsable format.
+  #   Currently available are YAML, JSON and XML.
+  # * +:verbose+: If true, print every file system as it is unmount to the
+  #   screen
+  # * +:reverse+: Reverse the file systems collection before unmounting. This is
+  #   kind of pointless for there is no guarantee for the order of file systems.
+  def self.unmount_many_fs(opts)
+    if opts[:all]
+      to_unmount = parse_file_systems
+    else
+      to_unmount = matched_devices(opts)
+    end
+    if opts[:simulate]
+      to_unmount.each do |device|
+        puts ("#{device[:device]} mounted on #{device[:mount_point]} as " +
+              "#{device[:type]}")
+      end
+    elsif opts[:reporting]
+      report_results(to_unmount, opts[:reporting])
+    else
+      unmount_devices(to_unmount, opts[:verbose])
     end
-  elsif opts[:reporting]
-    report_results(to_unmount, opts[:reporting])
-  else
-    unmount_devices(to_unmount, opts[:verbose])
   end
 end

data/umount-many.gemspec

@@ -1,34 +1,39 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{umount-many}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Hagbard Celine"]
-  s.date = %q{2010-10-05}
+  s.date = %q{2011-01-23}
   s.default_executable = %q{umount-many}
   s.description = %q{Unmount several devices based on filters}
   s.email = %q{sin3141592@gmail.com}
   s.executables = ["umount-many"]
   s.extra_rdoc_files = [
+    "README.md",
     "TODO"
   ]
   s.files = [
+    "README.md",
     "Rakefile",
-     "TODO",
-     "VERSION",
-     "bin/umount-many",
-     "lib/umount-many.rb",
-     "pkg/umount-many-0.1.0.gem",
-     "pkg/umount-many-0.1.1.gem",
-     "umount-many.gemspec"
+    "TODO",
+    "VERSION",
+    "bin/umount-many",
+    "lib/core_ext/hash.rb",
+    "lib/umount-many.rb",
+    "pkg/umount-many-0.1.0.gem",
+    "pkg/umount-many-0.1.1.gem",
+    "pkg/umount-many-0.1.3.gem",
+    "pkg/umount-many-0.1.4.gem",
+    "umount-many-0.1.4.gem",
+    "umount-many.gemspec"
   ]
-  s.homepage = %q{http://github.com/sin3141592/umount-many}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.homepage = %q{https://github.com/sin3141592/umount-many}
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Unmount several devices based on filters}

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Hagbard Celine
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-05 00:00:00 +02:00
+date: 2011-01-23 00:00:00 +01:00
 default_executable: umount-many
 dependencies: []
 
@@ -25,23 +25,29 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
+- README.md
 - TODO
 files: 
+- README.md
 - Rakefile
 - TODO
 - VERSION
 - bin/umount-many
+- lib/core_ext/hash.rb
 - lib/umount-many.rb
 - pkg/umount-many-0.1.0.gem
 - pkg/umount-many-0.1.1.gem
+- pkg/umount-many-0.1.3.gem
+- pkg/umount-many-0.1.4.gem
+- umount-many-0.1.4.gem
 - umount-many.gemspec
 has_rdoc: true
-homepage: http://github.com/sin3141592/umount-many
+homepage: https://github.com/sin3141592/umount-many
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement