rprogram 0.1.8 → 0.2.0

data/lib/rprogram/options/options.rb

@@ -0,0 +1,39 @@
+require 'rprogram/options/class_methods'
+require 'rprogram/non_option'
+require 'rprogram/option'
+
+module RProgram
+  module Options
+    def self.included(base)
+      base.send :extend, ClassMethods
+    end
+
+    #
+    # @see self.has_non_option?
+    #
+    def has_non_option?(name)
+      self.class.has_non_option?(name)
+    end
+
+    #
+    # @see self.get_non_option
+    #
+    def get_non_option(name)
+      self.class.get_non_option(name)
+    end
+
+    #
+    # @see self.has_option?
+    #
+    def has_option?(name)
+      self.class.has_option?(name)
+    end
+
+    #
+    # @see self.get_option
+    #
+    def get_option(name)
+      self.class.get_option(name)
+    end
+  end
+end

data/lib/rprogram/options.rb

@@ -1,146 +1,2 @@
-require 'rprogram/extensions/meta'
-require 'rprogram/non_option'
-require 'rprogram/option'
-
-module RProgram
-  module Options
-    def self.included(base)
-      base.metaclass_eval do
-        #
-        # @return [Hash]
-        #   All defined non-options of the class.
-        #
-        def non_options
-          @non_options ||= {}
-        end
-
-        #
-        # Searches for the non-option with the matching name in the class
-        # and it's ancestors.
-        #
-        # @param [Symbol, String] name
-        #   The name to search for.
-        #
-        # @return [true, false]
-        #   Specifies whether the non-option with the matching name was
-        #   defined.
-        #
-        def has_non_option?(name)
-          name = name.to_sym
-
-          ancestors.each do |base|
-            if base.include?(RProgram::Options)
-              return true if base.non_options.include?(name)
-            end
-          end
-
-          return false
-        end
-
-        #
-        # Searches for the non-option with the matching name in the class
-        # and it's ancestors.
-        #
-        # @param [Symbol, String] name
-        #   The name to search for.
-        #
-        # @return [NonOption]
-        #   The non-option with the matching name.
-        #
-        def get_non_option(name)
-          name = name.to_sym
-
-          ancestors.each do |base|
-            if base.include?(RProgram::Options)
-              if base.non_options.has_key?(name)
-                return base.non_options[name]
-              end
-            end
-          end
-
-          return nil
-        end
-
-        #
-        # @return [Hash]
-        #   All defined options for the class.
-        #
-        def options
-          @options ||= {}
-        end
-
-        #
-        # Searches for the option with the matching name in the class and
-        # it's ancestors.
-        #
-        # @param [Symbol, String] name
-        #   The name to search for.
-        #
-        # @return [true, false]
-        #   Specifies whether the option with the matching name was defined.
-        #
-        def has_option?(name)
-          name = name.to_sym
-
-          ancestors.each do |base|
-            if base.include?(RProgram::Options)
-              return true if base.options.has_key?(name)
-            end
-          end
-
-          return false
-        end
-
-        #
-        # Searches for the option with the matching name in the class and
-        # it's ancestors.
-        #
-        # @param [Symbol, String] name
-        #   The name to search for.
-        #
-        # @return [Option]
-        #   The option with the matching name.
-        #
-        def get_option(name)
-          name = name.to_sym
-
-          ancestors.each do |base|
-            if base.include?(RProgram::Options)
-              return base.options[name] if base.options.has_key?(name)
-            end
-          end
-
-          return nil
-        end
-      end
-    end
-
-    #
-    # @see self.has_non_option?
-    #
-    def has_non_option?(name)
-      self.class.has_non_option?(name)
-    end
-
-    #
-    # @see self.get_non_option
-    #
-    def get_non_option(name)
-      self.class.get_non_option(name)
-    end
-
-    #
-    # @see self.has_option?
-    #
-    def has_option?(name)
-      self.class.has_option?(name)
-    end
-
-    #
-    # @see self.get_option
-    #
-    def get_option(name)
-      self.class.get_option(name)
-    end
-  end
-end
+require 'rprogram/options/class_methods'
+require 'rprogram/options/options'

data/lib/rprogram/program.rb

@@ -65,7 +65,7 @@ module RProgram
     #
     # @return [Program, nil]
     #   Returns the newly created Program object. If the given path was
-    #   not a valid file, +nil+ will be returned.
+    #   not a valid file, `nil` will be returned.
     #
     # @example
     #   Program.find_with_path('/bin/cd')
@@ -99,7 +99,7 @@ module RProgram
     #
     # @return [Program, nil]
     #   Returns the newly created Program object. If none of the given
-    #   paths were valid files, +nil+ will be returned.
+    #   paths were valid files, `nil` will be returned.
     #
     # @example
     #   Program.find_with_paths(['/bin/cd','/usr/bin/cd'])
@@ -116,7 +116,7 @@ module RProgram
     end
 
     #
-    # Finds and creates the program using it's +program_names+.
+    # Finds and creates the program using it's `program_names`.
     #
     # @param [Array] arguments
     #   Additional arguments to initialize the program object with.
@@ -132,7 +132,7 @@ module RProgram
     #   The newly created program object.
     #
     # @raise [ProgramNotFound]
-    #   Non of the +program_names+ represented valid programs on the system.
+    #   Non of the `program_names` represented valid programs on the system.
     #
     # @example
     #   Program.find
@@ -144,7 +144,8 @@ module RProgram
     #   end
     #
     def self.find(*arguments,&block)
-      path = Compat.find_program_by_names(*self.program_names)
+      path = self.path
+      path ||= Compat.find_program_by_names(*self.program_names)
 
       unless path
         names = self.program_names.map { |name| name.dump }.join(', ')
@@ -186,7 +187,7 @@ module RProgram
     #   Specifies whether the program exited successfully.
     #
     # @raise [ProgramNotFound]
-    #   Indicates that the +sudo+ program could not be located.
+    #   Indicates that the `sudo` program could not be located.
     #
     # @since 0.1.8
     #

data/lib/rprogram/task.rb

@@ -72,7 +72,7 @@ module RProgram
     # Specifies whether the task will be ran under sudo.
     #
     # @return [Boolean]
-    #   Returns +true+ if sudo is enabled, returns +false+ otherwise.
+    #   Returns `true` if sudo is enabled, returns `false` otherwise.
     #
     # @since 0.1.8
     #
@@ -230,7 +230,7 @@ module RProgram
 
       self.non_options[name] = NonOption.new(options)
 
-      class_def(name) do
+      define_method(name) do
         if options[:multiple]
           @options[name] ||= []
         else
@@ -238,7 +238,7 @@ module RProgram
         end
       end
 
-      class_def("#{name}=") do |value|
+      define_method("#{name}=") do |value|
         @options[name] = value
       end
     end
@@ -254,7 +254,7 @@ module RProgram
     #
     # @option options [Symbol] :name
     #   The name of the option. Defaults to the flag_namify'ed form of
-    #   <tt>options[:flag]</tt>, if not given.
+    #   `options[:flag]`, if not given.
     #
     # @option options [true, false] :multiply (false)
     #   Specifies that the option may appear multiple times in the
@@ -327,7 +327,7 @@ module RProgram
 
       self.options[method_name] = Option.new(options,&block)
 
-      class_def(method_name) do
+      define_method(method_name) do
         if options[:sub_options]
           @options[method_name] ||= OptionList.new
         elsif options[:multiple]
@@ -337,7 +337,7 @@ module RProgram
         end
       end
 
-      class_def("#{method_name}=") do |value|
+      define_method("#{method_name}=") do |value|
         if options[:sub_options]
           @options[method_name] = OptionList.new(value)
         else

data/lib/rprogram/version.rb

@@ -1,4 +1,4 @@
 module RProgram
   # Version of RProgram
-  VERSION = '0.1.8'
+  VERSION = '0.2.0'
 end

data/rprogram.gemspec

@@ -0,0 +1,104 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rprogram}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Postmodern"]
+  s.date = %q{2010-10-03}
+  s.description = %q{RProgram is a library for creating wrappers around command-line programs. RProgram provides a Rubyful interface to programs and all their options or non-options. RProgram can also search for programs installed on a system.}
+  s.email = %q{postmodern.mod3@gmail.com}
+  s.extra_rdoc_files = [
+    "ChangeLog.md",
+     "LICENSE.txt",
+     "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     ".specopts",
+     ".yardopts",
+     "ChangeLog.md",
+     "LICENSE.txt",
+     "README.md",
+     "Rakefile",
+     "lib/rprogram.rb",
+     "lib/rprogram/compat.rb",
+     "lib/rprogram/exceptions.rb",
+     "lib/rprogram/exceptions/program_not_found.rb",
+     "lib/rprogram/extensions.rb",
+     "lib/rprogram/nameable.rb",
+     "lib/rprogram/nameable/class_methods.rb",
+     "lib/rprogram/nameable/nameable.rb",
+     "lib/rprogram/non_option.rb",
+     "lib/rprogram/option.rb",
+     "lib/rprogram/option_list.rb",
+     "lib/rprogram/options.rb",
+     "lib/rprogram/options/class_methods.rb",
+     "lib/rprogram/options/options.rb",
+     "lib/rprogram/program.rb",
+     "lib/rprogram/rprogram.rb",
+     "lib/rprogram/task.rb",
+     "lib/rprogram/version.rb",
+     "lib/rprogram/yard.rb",
+     "rprogram.gemspec",
+     "spec/classes/aliased_program.rb",
+     "spec/classes/ls_program.rb",
+     "spec/classes/ls_selinux_task.rb",
+     "spec/classes/ls_task.rb",
+     "spec/classes/named_program.rb",
+     "spec/compat_spec.rb",
+     "spec/nameable_spec.rb",
+     "spec/non_option_spec.rb",
+     "spec/option_examples.rb",
+     "spec/option_list_spec.rb",
+     "spec/option_spec.rb",
+     "spec/program_spec.rb",
+     "spec/rprogram_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/task_spec.rb"
+  ]
+  s.has_rdoc = %q{yard}
+  s.homepage = %q{http://github.com/postmodern/rprogram}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A library for creating wrappers around command-line programs.}
+  s.test_files = [
+    "spec/classes/ls_program.rb",
+     "spec/classes/named_program.rb",
+     "spec/classes/ls_selinux_task.rb",
+     "spec/classes/aliased_program.rb",
+     "spec/classes/ls_task.rb",
+     "spec/nameable_spec.rb",
+     "spec/program_spec.rb",
+     "spec/rprogram_spec.rb",
+     "spec/option_examples.rb",
+     "spec/non_option_spec.rb",
+     "spec/compat_spec.rb",
+     "spec/option_list_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/option_spec.rb",
+     "spec/task_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<yard>, [">= 0.5.3"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<yard>, [">= 0.5.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<yard>, [">= 0.5.3"])
+  end
+end
+

data/spec/nameable_spec.rb

@@ -52,4 +52,32 @@ describe Nameable do
       obj.program_names.should == ['ls', 'dir']
     end
   end
+
+  describe "path" do
+    subject { NamedProgram }
+    after(:all) { NamedProgram.path = nil }
+
+    it "should not have a path by default" do
+      subject.path.should be_nil
+    end
+
+    it "should allow setting the path" do
+      new_path = '/usr/bin/ls'
+
+      subject.path = new_path
+      subject.path.should == new_path
+    end
+
+    it "should expand paths" do
+      subject.path = '/usr/../bin/ls'
+
+      subject.path.should == '/bin/ls'
+    end
+
+    it "should allow setting the path to nil" do
+      subject.path = nil
+
+      subject.path.should be_nil
+    end
+  end
 end

data/spec/program_spec.rb

@@ -4,22 +4,19 @@ require 'spec_helper'
 require 'classes/ls_program'
 
 describe Program do
-  it "should create a Program from a path" do
-    prog = Program.new('/usr/bin/ruby')
+  subject { Program.new('/usr/bin/cc') }
+  after(:all) { LS.path = nil }
 
-    prog.should_not be_nil
+  it "should create a Program from a path" do
+    subject.should_not be_nil
   end
 
   it "should derive the program name from a path" do
-    prog = Program.new('/usr/bin/ruby')
-
-    prog.name.should == 'ruby'
+    subject.name.should == 'cc'
   end
 
   it "should return the program path when converted to a String" do
-    prog = Program.new('/usr/bin/ruby')
-
-    prog.to_s.should == '/usr/bin/ruby'
+    subject.to_s.should == '/usr/bin/cc'
   end
 
   it "should raise an exception for invalid paths" do
@@ -29,7 +26,7 @@ describe Program do
   end
 
   it "should find a program from a path" do
-    prog = Program.find_with_path('/usr/bin/dir')
+    prog = Program.find_with_path('/usr/bin/cc')
 
     prog.should_not be_nil
   end
@@ -41,12 +38,20 @@ describe Program do
   end
 
   it "should be able to find a program based on the program names" do
-    ls = nil
+    ls = LS.find
+
+    File.executable?(ls.path).should == true
+  end
 
+  it "should raise a ProgramNotFound exception if no path/name is valid" do
     lambda {
-      ls = LS.find
-    }.should_not raise_error(ProgramNotFound)
+      Program.find
+    }.should raise_error(ProgramNotFound)
+  end
 
-    File.executable?(ls.path).should == true
+  it "should allow using a default path" do
+    LS.path = '/usr/bin/dir'
+
+    LS.find.path.should == LS.path
   end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-gem 'rspec', '>=1.2.8'
+gem 'rspec', '>=1.3.0'
 require 'spec'
 
 require 'rprogram/version'