rprogram 0.3.1 → 0.3.2

data/ChangeLog.md

@@ -1,3 +1,11 @@
+### 0.3.2 / 2012-07-15
+
+* Require Ruby >= 1.8.7.
+* Removed env as a dependency.
+* Added {RProgram::Argument}.
+* Removed orphaned `rprogram/yard.rb` file.
+* Style improvements.
+
 ### 0.3.1 / 2012-05-27
 
 * Replaced ore-tasks with
@@ -76,7 +84,7 @@
 * Renamed `PRogram::Compat.PATHS` to `RProgram::Compat.paths`.
 * Refactored {RProgram::Option#arguments}.
 * Removed `RProgram::Option#format`.
-* Refactored {RProgram::NonOption#arguments}.
+* Refactored `RProgram::NonOption#arguments`.
 * Renamed `RProgram::NonOption#leading` to {RProgram::NonOption#leading?}.
 * Removed `RProgram::NonOption#tailing`.
 * Added {RProgram::NonOption#tailing?}.

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2011 Hal Brodigan
+Copyright (c) 2007-2012 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -49,8 +49,8 @@ First, create the class to represent the options of the program, using
       long_option :flag => '--includes', :multiple => true
 
       # options with multiple values can have a custom separator character
-      long_option :flag => '--ops',
-                  :multiple => true,
+      long_option :flag      => '--ops',
+                  :multiple  => true,
                   :separator => ','
 
       # define any non-options (aka additional arguments)
@@ -89,23 +89,19 @@ Finally, run your program with options or a block:
 
     MyProgram.my_run do |my_prog|
       my_prog.includes = ['one', 'two', 'three']
-      my_prog.mode == :safe
+      my_prog.mode     = :safe
 
       my_prog.output = 'output.txt'
-      my_prog.files = ['test1.txt', 'test2.txt']
+      my_prog.files  = ['test1.txt', 'test2.txt']
     end
     # => true
 
-## Requirements
-
-* [env](https://github.com/postmodern/env) ~> 0.1, >= 0.1.2
-
 ## Install
 
-    $ sudo gem install rprogram
+    $ gem install rprogram
 
 ## License
 
-Copyright (c) 2007-2011 Hal Brodigan
+Copyright (c) 2007-2012 Hal Brodigan
 
 See {file:LICENSE.txt} for license information.

data/gemspec.yml

@@ -13,8 +13,7 @@ email: postmodern.mod3@gmail.com
 homepage: https://github.com/postmodern/rprogram#readme
 has_yard: true
 
-dependencies:
-  env: ~> 0.1, >= 0.1.2
+required_ruby_version: ">= 1.8.7"
 
 development_dependencies:
   rubygems-tasks: ~> 0.1

data/lib/rprogram/argument.rb

@@ -0,0 +1,31 @@
+module RProgram
+  class Argument
+
+    #
+    # Formats a value into an Array of arguments.
+    #
+    # @param [Hash, Array, String] value
+    #   The value to format.
+    #
+    # @return [Array]
+    #   The formatted arguments.
+    #
+    def arguments(value)
+      value = case value
+              when Hash
+                value.map do |key,sub_value|
+                  if    sub_value == true then key.to_s
+                  elsif sub_value         then "#{key}=#{sub_value}"
+                  end
+                end
+              when false, nil
+                []
+              else
+                Array(value)
+              end
+
+      return value.compact
+    end
+
+  end
+end

data/lib/rprogram/non_option.rb

@@ -1,5 +1,7 @@
+require 'rprogram/argument'
+
 module RProgram
-  class NonOption
+  class NonOption < Argument
 
     # Name of the argument(s)
     attr_reader :name
@@ -28,12 +30,9 @@ module RProgram
     def initialize(options={})
       @name = options[:name]
 
-      @tailing = if options[:leading]
-                   !(options[:leading])
-                 elsif options[:tailing]
-                   options[:tailing]
-                 else
-                   true
+      @tailing = if    options[:leading] then !options[:leading]
+                 elsif options[:tailing] then options[:tailing]
+                 else                         true
                  end
 
       @multiple = (options[:multiple] || false)
@@ -59,34 +58,5 @@ module RProgram
       !(@tailing)
     end
 
-    #
-    # Formats the arguments for the non-option.
-    #
-    # @param [Hash, Array, String, nil] value
-    #   The value to use for the arguments of the non-option.
-    #                                   
-    # @return [Array]
-    #   The arguments for the non-option.
-    #
-    def arguments(value)
-      return [] unless value
-
-      if value.kind_of?(Hash)
-        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
-        value = [value]
-      end
-
-      return value.compact
-    end
-
   end
 end

data/lib/rprogram/option.rb

@@ -1,5 +1,7 @@
+require 'rprogram/argument'
+
 module RProgram
-  class Option
+  class Option < Argument
 
     # Flag of the option
     attr_reader :flag
@@ -54,26 +56,24 @@ module RProgram
     def initialize(options={},&block)
       @flag = options[:flag]
 
-      @equals = (options[:equals] || false)
-      @multiple = (options[:multiple] || false)
-      @separator = if options[:separator]
-                     options[:separator]
-                   elsif options[:equals]
-                     ' '
+      @equals    = (options[:equals] || false)
+      @multiple  = (options[:multiple] || false)
+      @separator = if options[:separator] then options[:separator]
+                   elsif options[:equals] then ' '
                    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
+                     block
+                   else
+                     Proc.new do |opt,value|
+                       if opt.equals
+                         ["#{opt.flag}=#{value.first}"]
+                       else
+                         [opt.flag] + value
+                       end
+                     end
+                   end
     end
 
     #
@@ -86,38 +86,27 @@ module RProgram
     #   The formatted arguments of the option.
     #
     def arguments(value)
-      return [@flag] if value == true
-      return [] unless value
+      case value
+      when true
+        [@flag]
+      when false, nil
+        []
+      else
+        value = super(value)
 
-      value = value.arguments if value.respond_to?(:arguments)
+        if @multiple
+          args = []
 
-      if value.kind_of?(Hash)
-        value = value.map { |key,sub_value|
-          if sub_value == true
-            key.to_s
-          elsif sub_value
-            "#{key}=#{sub_value}"
+          value.each do |arg|
+            args += Array(@formatter.call(self,[arg]))
           end
-        }
-      elsif value.kind_of?(Array)
-        value.flatten!
-      else
-        value = [value]
-      end
 
-      value.compact!
+          return args
+        else
+          value = [value.join(@separator)] if @separator
 
-      if @multiple
-        return value.inject([]) do |args,value|
-          arg = @formatter.call(self,[value])
-
-          args += arg if arg
-          args
+          return Array(@formatter.call(self,value))
         end
-      else
-        value = [value.join(@separator)] if @separator
-
-        return (@formatter.call(self,value) || [])
       end
     end
 

data/lib/rprogram/program.rb

@@ -32,17 +32,17 @@ module RProgram
     # @example
     #   Program.new('/usr/bin/ls')
     #
-    def initialize(path,&block)
+    def initialize(path)
       path = File.expand_path(path)
 
       unless File.file?(path)
-        raise(ProgramNotFound,"program #{path.dump} does not exist",caller)
+        raise(ProgramNotFound,"program #{path.dump} does not exist")
       end
 
       @path = path
       @name = File.basename(path)
 
-      block.call(self) if block
+      yield self if block_given?
     end
 
     #
@@ -94,7 +94,7 @@ module RProgram
     #   alias_program 'vim', 'vi'
     #
     def self.alias_program(*aliases)
-      @program_aliases = aliases.map { |name| name.to_s }
+      @program_aliases = aliases.map(&:to_s)
     end
 
     #
@@ -229,9 +229,9 @@ module RProgram
       path ||= System.find_program_by_names(*self.program_names)
 
       unless path
-        names = self.program_names.map { |name| name.dump }.join(', ')
+        names = self.program_names.map(&:dump).join(', ')
 
-        raise(ProgramNotFound,"programs #{names} were not found",caller)
+        raise(ProgramNotFound,"programs #{names} were not found")
       end
 
       return self.new(path,*arguments,&block)
@@ -339,10 +339,9 @@ module RProgram
     #   For valid `:sudo` options.
     #
     def sudo(*arguments)
-      options = if arguments.last.kind_of?(Hash)
-                  arguments.pop
-                else
-                  {}
+      options = case arguments.last
+                when Hash then arguments.pop
+                else           {}
                 end
 
       task = SudoTask.new(options.delete(:sudo) || {})

data/lib/rprogram/rprogram.rb

@@ -1,11 +1,13 @@
 module RProgram
+  @debug = false
+
   #
   # @return [true, false]
   #   Specifies whether debugging messages are enabled for RProgram.
   #   Defaults to false, if not set.
   #
-  def RProgram.debug
-    @@rprogram_debug ||= false
+  def self.debug
+    @debug
   end
 
   #
@@ -17,7 +19,7 @@ module RProgram
   # @return [true, false]
   #   The new value of RProgram.debug.
   #
-  def RProgram.debug=(value)
-    @@rprogram_debug = value
+  def self.debug=(value)
+    @debug = value
   end
 end

data/lib/rprogram/system.rb

@@ -1,14 +1,13 @@
 require 'rprogram/exceptions/program_not_found'
 require 'rprogram/rprogram'
 
-require 'env/variables'
+require 'pathname'
 
 module RProgram
   #
   # @since 0.3.0
   #
   module System
-    extend Env::Variables
 
     @arch, @platform = RUBY_PLATFORM.split('-',2)
     @platform ||= @arch
@@ -25,7 +24,7 @@ module RProgram
     #
     # @since 0.3.0
     #
-    def System.arch
+    def self.arch
       @arch
     end
 
@@ -39,7 +38,7 @@ module RProgram
     #   System.platform
     #   # => "linux"
     #
-    def System.platform
+    def self.platform
       @platform
     end
 
@@ -51,7 +50,7 @@ module RProgram
     #
     # @since 0.3.0
     #
-    def System.windows?
+    def self.windows?
       if @platform
         @platform.include?('mingw') || @platform.include?('mswin')
       else
@@ -67,8 +66,8 @@ module RProgram
     #
     # @since 0.3.0
     #  
-    def System.ruby_1_8?
-      RUBY_VERSION[0,4] == '1.8.'
+    def self.ruby_1_8?
+      RUBY_VERSION.start_with?('1.8.')
     end
 
     #
@@ -79,9 +78,20 @@ module RProgram
     #
     # @since 0.3.0
     #
-    def System.jruby?
-      Object.const_defined?(:RUBY_ENGINE) && \
-        Object.const_get(:RUBY_ENGINE) == 'jruby'
+    def self.jruby?
+      const_defined?(:RUBY_ENGINE) && const_get(:RUBY_ENGINE) == 'jruby'
+    end
+
+    #
+    # The directories to search for programs.
+    #
+    # @return [Array<Pathname>]
+    #   The directories containing programs.
+    #
+    def self.paths
+      @paths ||= ENV['PATH'].split(File::PATH_SEPARATOR).map do |dir|
+        Pathname.new(dir)
+      end
     end
 
     #
@@ -97,11 +107,9 @@ module RProgram
     #   System.find_program('as')
     #   #=> #<Pathname:/usr/bin/as>
     #
-    def System.find_program(name)
+    def self.find_program(name)
       # add the `.exe` suffix to the name, if running on Windows
-      if windows?
-        name = "#{name}.exe"
-      end
+      name = "#{name}.exe" if windows?
 
       paths.each do |dir|
         full_path = dir.join(name).expand_path
@@ -125,7 +133,7 @@ module RProgram
     #   System.find_program_by_names("gas","as")
     #   # => #<Pathname:/usr/bin/as>
     #
-    def System.find_program_by_names(*names)
+    def self.find_program_by_names(*names)
       names.each do |name|
         if (path = find_program(name))
           return path
@@ -171,24 +179,25 @@ module RProgram
     #
     # @raise [RuntimeError]
     #   Passing `:popen`, `:env` or exec options is not supported
-    #   before Ruby 1.9.1.
+    #   on Ruby 1.8.x.
     #
     # @see http://rubydoc.info/stdlib/core/1.9.2/Kernel#spawn-instance_method
     #   For acceptable options.
     #
-    def System.run(*arguments)
+    def self.run(*arguments)
       # extra tailing options and ENV variables from arguments
-      if arguments.last.kind_of?(Hash)
+      case arguments.last
+      when Hash
         options = arguments.pop
-        env = (options.delete(:env) || {})
-        popen = options.delete(:popen)
+        env     = (options.delete(:env) || {})
+        popen   = options.delete(:popen)
       else
         options = {}
-        env = {}
+        env     = {}
       end
 
       # all arguments must be Strings
-      arguments = arguments.map { |arg| arg.to_s }
+      arguments = arguments.map(&:to_s)
 
       # print debugging information
       if RProgram.debug
@@ -222,13 +231,11 @@ module RProgram
       end
 
       # re-add ENV variables and exec options
-      arguments.unshift(env) unless env.empty?
+      arguments.unshift(env)  unless env.empty?
       arguments.push(options) unless options.empty?
 
-      if popen
-        IO.popen(arguments,popen)
-      else
-        Kernel.system(*arguments)
+      if popen then IO.popen(arguments,popen)
+      else          Kernel.system(*arguments)
       end
     end
 
@@ -240,7 +247,7 @@ module RProgram
     #
     # @since 0.3.0
     #
-    def System.sudo_path
+    def self.sudo_path
       @sudo ||= find_program('sudo')
     end
 
@@ -255,7 +262,7 @@ module RProgram
     #
     # @since 0.3.0
     #
-    def System.sudo_path=(path)
+    def self.sudo_path=(path)
       @sudo = Pathname.new(path)
     end
 
@@ -267,7 +274,7 @@ module RProgram
     #
     # @since 0.3.0
     #
-    def System.sudo?
+    def self.sudo?
       !sudo_path.nil?
     end
 
@@ -305,7 +312,7 @@ module RProgram
     #
     # @see run
     #
-    def System.sudo(*arguments)
+    def self.sudo(*arguments)
       unless sudo?
         raise(ProgramNotFound,'could not find the "sudo" program')
       end