unix-whereis 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "depq", ">= 0.4"
+   gem "hash-utils", ">= 0.9.0"
+   gem "pipe-run", ">= 0.1.0"
+   gem "command-builder", ">= 0.1.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    command-builder (0.1.0)
+      hash-utils (>= 0.7.0)
+    git (1.2.5)
+    hash-utils (0.9.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    pipe-run (0.1.0)
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  command-builder (>= 0.1.0)
+  hash-utils (>= 0.9.0)
+  jeweler (~> 1.5.2)
+  pipe-run (>= 0.1.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+Unix Whereis
+============
+
+**Unix Whereis** provides Ruby interface to UNIX `whereis` command. 
+Some examples follow: (for details, see module documentation)
+
+    require "unix/whereis"
+    
+    Whereis.file? :ls   
+    # will return ["/bin/ls", "/usr/share/man/man1/ls.1.gz", "/usr/share/man/man1/ls.1p.gz"]
+    
+    Whereis.binary? :ls
+    # will return ["/bin/ls"]
+    
+    Whereis.available? :ls
+    # will return true
+    
+Contributing
+------------
+
+1. Fork it.
+2. Create a branch (`git checkout -b 20101220-my-change`).
+3. Commit your changes (`git commit -am "Added something"`).
+4. Push to the branch (`git push origin 20101220-my-change`).
+5. Create an [Issue][2] with a link to your branch.
+6. Enjoy a refreshing Diet Coke and wait.
+
+Copyright
+---------
+
+Copyright © 2011 [Martin Kozák][3]. See `LICENSE.txt` for
+further details.
+
+[2]: http://github.com/martinkozak/qrpc/issues
+[3]: http://www.martinkozak.net/

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "unix-whereis"
+  gem.homepage = "https://github.com/martinkozak/unix-whereis"
+  gem.license = "MIT"
+  gem.summary = "Ruby interface to UNIX 'whereis' command."
+  gem.email = "martinkozak@martinkozak.net"
+  gem.authors = ["Martin Kozák"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "qrpc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/unix/whereis.rb

@@ -0,0 +1,220 @@
+# encoding: utf-8
+# (c) 2011 Martin Kozák (martinkozak@martinkozak.net)
+
+require "command-builder"
+require "pipe-run"
+require "hash-utils/hash"
+
+##
+# UNIX +whereis+ command frontend.
+# @see
+#
+
+class Whereis
+
+    ##
+    # Target types to arguments conversion table.
+    #
+
+    TYPES = {
+        :binary => :b,
+        :manual => :m,
+        :source => :s,
+        :unusual => :u,
+    }
+    
+    ##
+    # Target type path settings to arguments conversion table.
+    #
+    
+    PATHS = {
+        :binary => :B,
+        :manual => :M,
+        :source => :S,
+    }
+    
+    ##
+    # Checks where is some file. By default uses default 
+    # whereis options.
+    #
+    # @overload file?(name, options = nil)
+    #   Checks according to file name and single type specification. 
+    #   Can be replaced by specialized methods of the module which use 
+    #   it. Type specification can be +:binary+, +:manual+ or +:source+.
+    #   @param [String] name name or wildcard of the file
+    #   @param [Symbol] options type of the file
+    #   @return [Array] list of found locations
+    #
+    # @overload file?(name, options = [ ])
+    #   Allows define multiple types for checking with eventual addition 
+    #   of the +whereis+ "unusual" setting.
+    #   @param [String] name name or wildcard of the file
+    #   @param [Array] options array of type of the files and eventually the +:unusual+ specification
+    #   @return [Array] list of found locations
+    #   @see TYPES
+    #   
+    # @overload file?(name, options = { })
+    #   Allows define paths for each type and eventually the unusual 
+    #   settings too.
+    #   @param [String] name name or wildcard of the file
+    #   @param [Hash] options path specifications and/or +:unusual+ setting (see below)
+    #   @option options [String] :binary path to binaries folder
+    #   @option options [String] :manual path to manual pages folder
+    #   @option options [String] :source path to sources folder
+    #   @option options [Boolean] :unusual +true+ for set the "unusual" flag
+    #   @return [Array] list of found locations
+    #   @see PATHS
+    #
+    # @return [Array] list of found locations
+    #
+
+    def self.file?(name, options = [ ])
+    
+        # Parses arguments
+        cmd = CommandBuilder::new(:whereis)
+ 
+        if options.kind_of? Symbol
+            __add_type(cmd, options)
+        elsif options.kind_of? Array
+            options.each { |i| __add_type(cmd, i) }
+        elsif options.kind_of? Hash
+            options.each_pair { |n, v| __add_path(cmd, n, v) }
+        end
+        
+        cmd << name.to_s
+        
+        # Parses output
+        output = Pipe.run(cmd.to_s)[(name.to_s.length + 2)..-1]
+        return output.split(" ")
+    end
+    
+    ##
+    # Checks where is some binary file. By default uses default 
+    # whereis options.
+    #
+    # @overload binary?(name, options = nil)
+    #   Checks according to name and +:unusual+ settings.
+    #   @param [String] name name or wildcard of the file
+    #   @param [:unusual, nil] options  eventuall +:unusual+ settings
+    #   @return [Array] list of found locations
+    # @overload binary?(name, options = { })
+    #   Checks according to name and additionaů options.
+    #   @param [String] name name or wildcard of the file
+    #   @param [Hash] options options
+    #   @option options [String] :path path to binary folder
+    #   @option options [Boolean] :unusual +true+ it it's set, +false+ in otherwise
+    #   @return [Array] list of found locations
+    #
+    # @return [Array] list of found locations
+    #
+    
+    def self.binary?(name, options = nil)
+        __get(name, :binary, options)
+    end
+    
+    ##
+    # Checks where is some manual page file. By default uses default 
+    # whereis options.
+    #
+    # @overload manual?(name, options = nil)
+    #   Checks according to name and +:unusual+ settings.
+    #   @param [String] name name or wildcard of the file
+    #   @param [:unusual, nil] options  eventuall +:unusual+ settings
+    #   @return [Array] list of found locations
+    # @overload manual?(name, options = { })
+    #   Checks according to name and additionaů options.
+    #   @param [String] name name or wildcard of the file
+    #   @param [Hash] options options
+    #   @option options [String] :path path to manual pages folder
+    #   @option options [Boolean] :unusual +true+ it it's set, +false+ in otherwise
+    #   @return [Array] list of found locations
+    #
+    # @return [Array] list of found locations
+    #
+    
+    def self.manual?(name, options = nil)
+        __get(name, :manual, options)
+    end
+    
+    ##
+    # Checks where is some source file. By default uses default 
+    # whereis options.
+    #
+    # @overload source?(name, options = nil)
+    #   Checks according to name and +:unusual+ settings.
+    #   @param [String] name name or wildcard of the file
+    #   @param [:unusual, nil] options  eventuall +:unusual+ settings
+    #   @return [Array] list of found locations
+    # @overload source?(name, options = { })
+    #   Checks according to name and additionaů options.
+    #   @param [String] name name or wildcard of the file
+    #   @param [Hash] options options
+    #   @option options [String] :path path to source folder
+    #   @option options [Boolean] :unusual +true+ it it's set, +false+ in otherwise
+    #   @return [Array] list of found locations
+    #
+    # @return [Array] list of found locations
+    #
+    
+    def self.source?(name, options = nil)
+        __get(name, :source, options)
+    end
+    
+    ##
+    # Indicates, file of the target type is available.
+    #
+    
+    def self.available?(name, type = :binary)
+        self.file?(name, type).length > 0
+    end
+    
+
+    
+    private
+    
+    ##
+    # Translates type specific calls to general calls.
+    #
+    
+    def self.__get(name, type, options = nil)
+        if options.kind_of? Hash
+            arg = { }
+            if options[:path]
+                arg[type] = options[:path]
+            end
+            if options[:unusual]
+                arg[:unusual] = options[:unusual]
+            end
+        elsif options == :unusual
+            arg = [type, :unusual]
+        elsif options.kind_of? NilClass
+            arg = type
+        else 
+            raise Exception::new("Hash, Symbol or nil expected in options.")
+        end
+        
+        self.file?(name, arg)
+    end
+    
+    ##
+    # Adds type argument to command according to type specification.
+    #
+    
+    def self.__add_type(cmd, type)
+        cmd << self::TYPES[type]
+    end
+
+    ##
+    # Adds path arguments to command according to type and 
+    # paths specification.
+    #
+        
+    def self.__add_path(cmd, type, path)
+        if type != :unusual
+            cmd.arg(self::PATHS[type], path)
+        end
+        
+        __add_type(cmd, type)
+    end
+    
+end

data/test

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+
+$:.push("./lib")
+require "unix/whereis"
+
+puts Whereis.available?(:jpegoptim).inspect

data/unix-whereis.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{unix-whereis}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Kozák"]
+  s.date = %q{2011-02-21}
+  s.email = %q{martinkozak@martinkozak.net}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/unix/whereis.rb",
+    "test",
+    "unix-whereis.gemspec"
+  ]
+  s.homepage = %q{https://github.com/martinkozak/unix-whereis}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{Ruby interface to UNIX 'whereis' command.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<hash-utils>, [">= 0.9.0"])
+      s.add_runtime_dependency(%q<pipe-run>, [">= 0.1.0"])
+      s.add_runtime_dependency(%q<command-builder>, [">= 0.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<hash-utils>, [">= 0.9.0"])
+      s.add_dependency(%q<pipe-run>, [">= 0.1.0"])
+      s.add_dependency(%q<command-builder>, [">= 0.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<hash-utils>, [">= 0.9.0"])
+    s.add_dependency(%q<pipe-run>, [">= 0.1.0"])
+    s.add_dependency(%q<command-builder>, [">= 0.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: unix-whereis
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Martin Koz\xC3\xA1k"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-21 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hash-utils
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: pipe-run
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: command-builder
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: 
+email: martinkozak@martinkozak.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/unix/whereis.rb
+- test
+- unix-whereis.gemspec
+has_rdoc: true
+homepage: https://github.com/martinkozak/unix-whereis
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 314693073242777781
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Ruby interface to UNIX 'whereis' command.
+test_files: []
+