rprogram 0.1.5 → 0.1.6

data/History.txt

@@ -1,3 +1,17 @@
+=== 0.1.6 / 2009-06-30
+
+* Use Hoe 2.2.0.
+* Removed requirement for 'open3'.
+* Renamed Compat.PATHS to Compat.paths.
+* Refactored Option#arguments.
+* Removed Option#format.
+* Refactored NonOption#arguments.
+* Renamed NonOption#leading to NonOption#leading?.
+* Removed NonOption#tailing.
+* Added NonOption#tailing?.
+* Added specs.
+* All specs pass on Ruby 1.9.1-p0 and 1.8.6-p287.
+
 === 0.1.5 / 2009-01-14
 
 * Use Kernel.system in RProgram::Program#run, instead of Open3.popen3:

data/LICENSE.txt

@@ -0,0 +1,23 @@
+
+
+The MIT License
+
+Copyright (c) 2007-2008 Hal Brodigan
+
+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/Manifest.txt

@@ -1,16 +1,14 @@
 History.txt
 Manifest.txt
+LICENSE.txt
 README.txt
 Rakefile
 lib/rprogram.rb
-lib/rprogram/version.rb
 lib/rprogram/compat.rb
 lib/rprogram/exceptions/program_not_found.rb
 lib/rprogram/exceptions.rb
 lib/rprogram/extensions/meta/object.rb
 lib/rprogram/extensions/meta.rb
-lib/rprogram/extensions/array.rb
-lib/rprogram/extensions/hash.rb
 lib/rprogram/extensions.rb
 lib/rprogram/option_list.rb
 lib/rprogram/option.rb
@@ -20,4 +18,19 @@ lib/rprogram/task.rb
 lib/rprogram/nameable.rb
 lib/rprogram/program.rb
 lib/rprogram/rprogram.rb
-test/test_rprogram.rb
+lib/rprogram/version.rb
+spec/spec_helper.rb
+spec/classes/named_program.rb
+spec/classes/aliased_program.rb
+spec/classes/ls_program.rb
+spec/classes/ls_task.rb
+spec/classes/ls_selinux_task.rb
+spec/rprogram_spec.rb
+spec/compat_spec.rb
+spec/option_examples.rb
+spec/option_spec.rb
+spec/non_option_spec.rb
+spec/option_list_spec.rb
+spec/nameable_spec.rb
+spec/program_spec.rb
+spec/task_spec.rb

data/README.txt

@@ -1,6 +1,7 @@
 = RProgram
 
 * http://rprogram.rubyforge.org/
+* http://github.com/postmodern/rprogram/
 * Postmodern (postmodern.mod3 at gmail.com)
 
 == DESCRIPTION:

data/Rakefile

@@ -2,12 +2,13 @@
 
 require 'rubygems'
 require 'hoe'
-require './lib/rprogram/version.rb'
+require 'hoe/signing'
+require './tasks/spec.rb'
 
-Hoe.new('rprogram', RProgram::VERSION) do |p|
-  p.rubyforge_name = 'rprogram'
-  p.developer('Postmodern', 'postmodern.mod3@gmail.com')
-  p.remote_rdoc_dir = ''
+Hoe.spec('rprogram') do
+  self.rubyforge_name = 'rprogram'
+  self.developer('Postmodern', 'postmodern.mod3@gmail.com')
+  self.remote_rdoc_dir = ''
 end
 
 # vim: syntax=Ruby

data/lib/rprogram/compat.rb

@@ -5,7 +5,7 @@ module RProgram
     #
     #   Compat.arch  #=> "linux"
     #
-    def self.platform
+    def Compat.platform
       RUBY_PLATFORM.split('-').last
     end
 
@@ -14,14 +14,14 @@ module RProgram
     # If the +PATH+ environment variable is not setup, an empty array will
     # be returned.
     #
-    #   Compat.PATH  #=> ["/bin", "/usr/bin"]
+    #   Compat.paths #=> ["/bin", "/usr/bin"]
     #
-    def self.PATH
+    def Compat.paths
       # return an empty array in case
       # the PATH variable does not exist
       return [] unless ENV['PATH']
 
-      if self.platform =~ /mswin32/
+      if Compat.platform =~ /mswin(32|64)/
         return ENV['PATH'].split(';')
       else
         return ENV['PATH'].split(':')
@@ -34,8 +34,8 @@ module RProgram
     #
     #   Compat.find_program('as')  #=> "/usr/bin/as"
     #
-    def self.find_program(name)
-      self.PATH.each do |dir|
+    def Compat.find_program(name)
+      Compat.paths.each do |dir|
         full_path = File.expand_path(File.join(dir,name))
 
         return full_path if File.file?(full_path)
@@ -51,8 +51,8 @@ module RProgram
     #
     #   Compat.find_program_by_names("gas","as")  #=> "/usr/bin/as"
     #
-    def self.find_program_by_names(*names)
-      names.map { |name| self.find_program(name) }.compact.first
+    def Compat.find_program_by_names(*names)
+      names.map { |name| Compat.find_program(name) }.compact.first
     end
   end
 end

data/lib/rprogram/extensions.rb

@@ -1,3 +1 @@
 require 'rprogram/extensions/meta'
-require 'rprogram/extensions/array'
-require 'rprogram/extensions/hash'

data/lib/rprogram/nameable.rb

@@ -3,7 +3,7 @@ require 'rprogram/compat'
 
 module RProgram
   module Nameable
-    def self.included(base)
+    def self.included(base) # :nodoc:
       base.metaclass_eval do
         #
         # Returns the name of the program.
@@ -60,5 +60,12 @@ module RProgram
     def program_aliases
       self.class.program_aliases
     end
+
+    #
+    # Returns the program names.
+    #
+    def program_names
+      self.class.program_names
+    end
   end
 end

data/lib/rprogram/non_option.rb

@@ -4,12 +4,6 @@ module RProgram
     # Name of the argument(s)
     attr_reader :name
 
-    # Is the argument a leading argument(s)
-    attr_reader :leading
-
-    # Is the argument a tailing argument(s)
-    attr_reader :tailing
-
     # Can the argument be specified multiple times
     attr_reader :multiple
 
@@ -28,9 +22,31 @@ module RProgram
     def initialize(options={})
       @name = options[:name]
 
-      @leading = options[:leading] || false
-      @tailing = options[:tailing] || true
-      @multiple = options[:multiple] || false
+      @tailing = if options[:leading]
+                   !(options[:leading])
+                 elsif options[:tailing]
+                   options[:tailing]
+                 else
+                   true
+                 end
+
+      @multiple = (options[:multiple] || false)
+    end
+
+    #
+    # Returns +true+ if the non-options arguments are tailing, returns
+    # +false+ otherwise.
+    #
+    def tailing?
+      @tailing == true
+    end
+
+    #
+    # Returns +true+ if the non-options arguments are leading, returns
+    # +false+ otherwise.
+    #
+    def leading?
+      !(@tailing)
     end
 
     #
@@ -38,19 +54,23 @@ module RProgram
     # specified _value_.
     #
     def arguments(value)
-      return [] if (value==nil || value==false)
+      return [] unless value
 
       if value.kind_of?(Hash)
-        return value.map { |name,value| "#{name}=#{value}" }
-      elsif value.kind_of?(Array)
-        if @multiple
-          return value.compact
-        else
-          return value.join
+        value = value.map do |key,sub_value|
+          if sub_value == true
+            key.to_s
+          elsif sub_value
+            "#{key}=#{sub_value}"
+          end
         end
+      elsif value.kind_of?(Array)
+        value = value.flatten
       else
-        return [value]
+        value = [value]
       end
+
+      return value.compact
     end
 
   end

data/lib/rprogram/option.rb

@@ -1,5 +1,3 @@
-require 'rprogram/extensions'
-
 module RProgram
   class Option
 
@@ -43,12 +41,26 @@ module RProgram
     def initialize(options={},&block)
       @flag = options[:flag]
 
-      @equals = options[:equals] || false
-      @multiple = options[:multiple] || false
-      @separator = options[:separator]
-      @sub_options = options[:sub_options] || false
-
-      @formating = block
+      @equals = (options[:equals] || false)
+      @multiple = (options[:multiple] || false)
+      @separator = if options[:separator]
+                     options[:separator]
+                   elsif options[:equals]
+                     ' '
+                   end
+      @sub_options = (options[:sub_options] || false)
+
+      @formatter = if block
+        block
+      else
+        Proc.new do |opt,value|
+          if opt.equals
+            ["#{opt.flag}=#{value.first}"]
+          else
+            [opt.flag] + value
+          end
+        end
+      end
     end
 
     #
@@ -56,47 +68,35 @@ module RProgram
     # _value_.
     #
     def arguments(value)
-      return [@flag] if value==true
-      return [] if (value==nil || value==false)
-
-      if value.respond_to?(:arguments)
-        value = value.arguments
+      return [@flag] if value == true
+      return [] unless value
+
+      value = value.arguments if value.respond_to?(:arguments)
+
+      if value.kind_of?(Hash)
+        value = value.map { |key,sub_value|
+          if sub_value == true
+            key.to_s
+          elsif sub_value
+            "#{key}=#{sub_value}"
+          end
+        }
+      elsif value.kind_of?(Array)
+        value.flatten!
+      else
+        value = [value]
       end
 
+      value.compact!
+
       if @multiple
-        if value.respond_to?(:map)
-          return value.map { |arg| format(arg) }
+        return value.inject([]) do |args,value|
+          args + @formatter.call(self,[value])
         end
-      end
-
-      if (value.kind_of?(Array) && @separator)
-        value = value.join(@separator)
-      end
-
-      return format(value)
-    end
-
-    protected
-
-    #
-    # Returns an Array of the flag and the specified _value_ in argument
-    # form.
-    #
-    def default_format(value)
-      return [@flag] + value if value.kind_of?(Array)
-      return ["#{flag}=#{value}"] if @equals
-      return [@flag, value]
-    end
-
-    #
-    # Formats specified _value_ with the option flag using
-    # either the custom formating or the default_format.
-    #
-    def format(value)
-      if @formating
-        return @formating.call(@flag,value).to_a
       else
-        return default_format(value)
+        value = [value.join(@separator)] if @separator
+
+        return @formatter.call(self,value)
       end
     end
 

data/lib/rprogram/option_list.rb

@@ -1,5 +1,3 @@
-require 'rprogram/extensions/hash'
-
 module RProgram
   class OptionList < Hash
 
@@ -23,14 +21,14 @@ module RProgram
       name = sym.to_s
 
       unless block
-        if (name =~ /=$/ && args.length==1)
-          return self[name.chop.to_sym] = args[0]
-        elsif args.length==0
+        if (name =~ /=$/ && args.length == 1)
+          return self[name.chop.to_sym] = args.first
+        elsif args.empty?
           return self[sym]
         end
       end
 
-      super(sym,*args,&block)
+      return super(sym,*args,&block)
     end
 
   end

data/lib/rprogram/options.rb

@@ -4,7 +4,7 @@ require 'rprogram/option'
 
 module RProgram
   module Options
-    def self.included(base)
+    def self.included(base) # :nodoc:
       base.metaclass_eval do
         #
         # Returns a Hash of all defined non-options.
@@ -21,7 +21,7 @@ module RProgram
           name = name.to_sym
 
           ancestors.each do |base|
-            if base.include?(Options)
+            if base.include?(RProgram::Options)
               return true if base.non_options.include?(name)
             end
           end
@@ -36,7 +36,7 @@ module RProgram
           name = name.to_sym
 
           ancestors.each do |base|
-            if base.include?(Options)
+            if base.include?(RProgram::Options)
               if base.non_options.has_key?(name)
                 return base.non_options[name]
               end
@@ -61,7 +61,7 @@ module RProgram
           name = name.to_sym
 
           ancestors.each do |base|
-            if base.include?(Options)
+            if base.include?(RProgram::Options)
               return true if base.options.has_key?(name)
             end
           end
@@ -77,7 +77,7 @@ module RProgram
           name = name.to_sym
 
           ancestors.each do |base|
-            if base.include?(Options)
+            if base.include?(RProgram::Options)
               return base.options[name] if base.options.has_key?(name)
             end
           end

data/lib/rprogram/program.rb

@@ -4,8 +4,6 @@ require 'rprogram/task'
 require 'rprogram/nameable'
 require 'rprogram/exceptions/program_not_found'
 
-require 'open3'
-
 module RProgram
   class Program
 
@@ -39,29 +37,29 @@ module RProgram
 
     #
     # Creates a new program object with the specified _path_, if _path_
-    # is a valid file. Any given _args_ or a given _block_ will be used
+    # is a valid file. Any given _arguments_ or a given _block_ will be used
     # in creating the new program.
     #
     #   Program.find_with_path('/bin/cd') # => Program
     #
     #   Program.find_with_path('/obviously/fake') # => nil
     #
-    def self.find_with_path(path,*args,&block)
-      return self.new(path,*args,&block) if File.file?(path)
+    def self.find_with_path(path,*arguments,&block)
+      return self.new(path,*arguments,&block) if File.file?(path)
     end
 
     #
     # Creates a new program object with the specified _paths_,
-    # if a path within _paths_ is a valid file. Any given _args_ or
+    # if a path within _paths_ is a valid file. Any given _arguments_ or
     # a given _block_ will be used in creating the new program.
     #
     #   Program.find_with_paths(['/bin/cd','/usr/bin/cd']) # => Program
     #
     #   Program.find_with_paths(['/obviously/fake','/bla']) # => nil
     #
-    def self.find_with_paths(paths,*args,&block)
+    def self.find_with_paths(paths,*arguments,&block)
       paths.each do |path|
-        return self.new(path,*args,&block) if File.file?(path)
+        return self.new(path,*arguments,&block) if File.file?(path)
       end
     end
 
@@ -69,7 +67,7 @@ module RProgram
     # Finds and creates the program using it's +program_names+ and returns
     # a new Program object. If the program cannot be found by any of it's
     # +program_names+, a ProramNotFound exception will be raised. Any given
-    # _args_ or a given _block_ will be used in creating the new program.
+    # _arguments_ or a given _block_ will be used in creating the new program.
     #
     #   Program.find # => Program
     #
@@ -77,19 +75,20 @@ module RProgram
     #     ...
     #   end
     #
-    def self.find(*args,&block)
-      path = Compat.find_program_by_names(program_names)
+    def self.find(*arguments,&block)
+      path = Compat.find_program_by_names(*self.program_names)
+
       unless path
-        names = program_names.map { |name| name.dump }.join(', ')
+        names = self.program_names.map { |name| name.dump }.join(', ')
 
         raise(ProgramNotFound,"programs #{names} were not found",caller)
       end
 
-      return self.new(path,*args,&block)
+      return self.new(path,*arguments,&block)
     end
 
     #
-    # Runs the program with the specified _args_ and returns
+    # Runs the program with the specified _arguments_ and returns
     # either +true+ or +false+, depending on the exit status of the
     # program.
     #