oct 0.2.0 → 0.3.1

data/.gemfiles

@@ -14,17 +14,22 @@ bin/oct
 config/cucumber.yml
 features/bin.feature
 features/oct.feature
+features/settings.feature
 features/step_definitions/.gitignore
 features/step_definitions/oct_steps.rb
 features/support/aruba.rb
 features/support/env.rb
 lib/oct.rb
 lib/oct/app.rb
+lib/oct/core/array.rb
+lib/oct/core/hash.rb
 lib/oct/oct.rb
+lib/oct/settings.rb
 oct.gemspec
+spec/aruba_helper.rb
+spec/basic_app/array_spec.rb
 spec/basic_gem/aruba_helper_spec.rb
 spec/basic_gem/basic_gem_spec.rb
 spec/basic_gem/gemspec_spec.rb
-spec/spec.opts
 spec/spec_helper.rb
 spec/watchr.rb

data/.gitignore

@@ -1,10 +1,7 @@
-pkg/*
-*.gem
-.bundle
-coverage
-rdoc
-.yardoc
+/pkg/
+/.bundle/
+/rdoc/
+/.yardoc/
 rerun.txt
 tags
-tmp/fixtures
-tmp/aruba
+/tmp/

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source "http://rubygems.org"
 
 # Specify your gem's dependencies in the .gemspec file
 gemspec

data/Gemfile.lock

@@ -1,49 +1,58 @@
 PATH
   remote: .
   specs:
-    oct (0.2.0)
-      configatron (>= 2.5.1)
+    oct (0.3.1)
       term-ansicolor (>= 1.0.4)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    aruba (0.2.3)
-      background_process
-      cucumber (~> 0.9.0)
-    background_process (1.2)
-    builder (2.1.2)
-    configatron (2.6.3)
-      yamler (>= 0.1.0)
-    cucumber (0.9.4)
-      builder (~> 2.1.2)
+    aruba (0.4.6)
+      bcat (>= 0.6.1)
+      childprocess (>= 0.2.0)
+      cucumber (>= 1.0.2)
+      rdiscount (>= 1.6.8)
+      rspec (>= 2.6.0)
+    bcat (0.6.2)
+      rack (~> 1.0)
+    builder (3.0.0)
+    childprocess (0.2.2)
+      ffi (~> 1.0.6)
+    cucumber (1.1.0)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.2)
+      gherkin (~> 2.5.0)
+      json (>= 1.4.6)
+      term-ansicolor (>= 1.0.6)
+    diff-lcs (1.1.3)
+    ffi (1.0.10)
+    gherkin (2.5.4)
+      json (>= 1.4.6)
+    json (1.6.1)
+    rack (1.3.5)
+    rake (0.9.2.2)
+    rdiscount (1.6.8)
+    redcarpet (1.17.2)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
       diff-lcs (~> 1.1.2)
-      gherkin (~> 2.2.9)
-      json (~> 1.4.6)
-      term-ansicolor (~> 1.0.5)
-    diff-lcs (1.1.2)
-    gherkin (2.2.9)
-      json (~> 1.4.6)
-      term-ansicolor (~> 1.0.5)
-    json (1.4.6)
-    kramdown (0.12.0)
-    rake (0.8.7)
-    rspec (1.3.1)
-    term-ansicolor (1.0.5)
-    yamler (0.1.0)
-    yard (0.6.2)
+    rspec-mocks (2.7.0)
+    term-ansicolor (1.0.7)
+    yard (0.7.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba (>= 0.2.2)
-  bundler (>= 1.0.7)
-  configatron (>= 2.5.1)
-  cucumber (>= 0.9.4)
-  kramdown (>= 0.12.0)
+  aruba (~> 0.4.3)
+  bundler (>= 1.0.14)
+  cucumber (~> 1.0)
   oct!
   rake (>= 0.8.7)
-  rspec (= 1.3.1)
-  term-ansicolor (>= 1.0.4)
-  yard (>= 0.6.2)
+  redcarpet (>= 1.17.2)
+  rspec (>= 2.6.0)
+  yard (>= 0.7.2)

data/HISTORY.markdown

@@ -6,6 +6,14 @@ Most recent changes are at the top
 Changes
 -------
 
+### 0.3.1 - 06/11/2013 ###
+
+* Use RbConfig instead of Config for Ruby 1.9
+
+### 0.3.0 - 10/27/2011 ###
+
+* Add configuration files via the BasicApp framework, see features/settings.feature
+
 ### 0.2.0 - 11/24/2010 ###
 
 * ANSI coloring works under Windows with win32console gem

data/LICENSE

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

data/README.markdown

@@ -10,7 +10,7 @@ Why?
 Oct is a sample RubyGem application cloned from BasicApp.
 See <http://github.com/robertwahler/basic_app> for more information.
 
-Oct does scratch an itch.  'Chmod' is easier to drive in octal and I can't 
+Oct does scratch an itch.  'Chmod' is easier to drive in octal and I can't
 convince 'ls -l' to output permissions in octal.
 
 Here is an equivalent bash script
@@ -35,30 +35,29 @@ Here is an equivalent bash script
        fi
 
        stat --format='%a,%U,%G,%t %n' $file
-    done 
+    done
 
 
-Run-time dependencies 
+Run-time dependencies
 ---------------------
 
 * Term-ansicolor for optional color output <http://github.com/flori/term-ansicolor>
-* Configatron for configuration support <http://github.com/markbates/configatron>
 
 
 Development dependencies
 ------------------------
 
 * Bundler for dependency management <http://github.com/carlhuda/bundler>
-* Rspec for unit testing <http://github.com/dchelimsky/rspec>
-* Cucumber for functional testing <http://github.com/aslakhellesoy/cucumber>
-* Aruba for CLI testing <http://github.com/aslakhellesoy/aruba>
-* YARD for documentation generation <http://github.com/lsegal/yard>
-
+* Rspec for unit testing <http://github.com/rspec/rspec>
+* Cucumber for functional testing <http://github.com/cucumber/cucumber>
+* Aruba for CLI testing <http://github.com/cucumber/aruba>
+* Yard for documentation generation <http://github.com/lsegal/yard>
+* Redcarpet for documentation markup processing <http://github.com/tanoku/redcarpet>
 
 Installation
 ------------
 
-This gem has been published on RubyGems.org 
+This gem has been published on RubyGems.org
 
     gem install oct
 
@@ -73,7 +72,7 @@ oct --help
       Usage: oct [options] [FILES]
 
     Options:
-     
+
         -v, --[no-]verbose               Run verbosely
         -c, --[no-]coloring              Ansi color in output
             --version                    Display current version
@@ -98,4 +97,4 @@ oct
 Copyright
 ---------
 
-Copyright (c) 2010 GearheadForHire, LLC. See [LICENSE](LICENSE) for details.
+Copyright (c) 2010-2011 GearheadForHire, LLC. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -1,25 +1,15 @@
 # encoding: utf-8
 
-# bundler/setup is managing $LOAD_PATH, any gem needed by this Rakefile must 
-# be listed as a development dependency in the gemspec
+# Bundler is managing $LOAD_PATH, any gem needed by this Rakefile must be
+# listed as a development dependency in the gemspec
+require 'bundler/setup'
+require 'bundler/gem_tasks'
 
-require 'rubygems'
-require 'bundler/setup' 
-
-Bundler::GemHelper.install_tasks
-
-def gemspec
-  @gemspec ||= begin
-    file = File.expand_path('../oct.gemspec', __FILE__)
-    eval(File.read(file), binding, file)
-  end
-end
-
-require 'spec'
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+require 'rspec/core/rake_task'
+desc "Run RSpec"
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--color', '--format nested']
 end
 
 require 'cucumber'
@@ -34,26 +24,59 @@ task :test => [:spec, :features]
 task :default => :test
 
 namespace :doc do
+
+  doc_version = File.open(File.join(File.dirname(__FILE__), 'VERSION'), "r") { |f| f.read }
   project_root = File.expand_path(File.dirname(__FILE__))
   doc_destination = File.join(project_root, 'rdoc')
 
   require 'yard'
-  require 'yard/rake/yardoc_task'
 
   YARD::Rake::YardocTask.new(:generate) do |yt|
-    yt.options = ['--output-dir', doc_destination
-                 ] +
-                 gemspec.rdoc_options - ['--line-numbers', '--inline-source']
+    yt.options = ['--output-dir', doc_destination,
+                  '--title', "Oct #{doc_version} Documentation",
+                  '--main', "README.markdown"
+                 ]
   end
 
   desc "Remove generated documenation"
   task :clean do
     rm_r doc_destination if File.exists?(doc_destination)
   end
-  
+
   desc "List undocumented objects"
   task :undocumented do
     system('yard stats --list-undoc')
   end
 
 end
+
+# put the gemfiles task in the bundler dependency chain
+task :build => [:gemfiles]
+task :install => [:gemfiles]
+task :release => [:gemfiles]
+
+desc "Generate .gemfiles via 'git ls-files'"
+task :gemfiles do
+  files = `git ls-files`
+
+  filename  = File.join(File.dirname(__FILE__), '.gemfiles')
+  cached_files = nil
+  if File.exists?(filename)
+    puts ".gemfiles exists, reading..."
+    cached_files = File.open(filename, "rb") {|f| f.read}
+  end
+
+  if cached_files && cached_files.match("\r\n")
+    puts ".gemfiles using DOS EOL"
+    files.gsub!(/\n/, "\r\n")
+  end
+
+  if cached_files != files
+    puts ".gemfiles updating"
+    File.open(filename, 'wb') {|f| f.write(files)}
+  else
+    puts ".gemfiles update not required"
+  end
+
+  raise "unable to process .gemfiles" unless files
+end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.1

data/bin/oct

@@ -1,11 +1,9 @@
 #!/usr/bin/env ruby
 
-$:.unshift(File.dirname(__FILE__) + '/../lib')
-
-require 'rubygems'
 require 'oct'
 require 'optparse'
 require 'term/ansicolor'
+require 'fileutils'
 
 available_actions = Oct::AVAILABLE_ACTIONS
 
@@ -20,23 +18,24 @@ help = banner
 help += <<HELP
 
 Options:
- 
+
 HELP
 
 options = {}
 OptionParser.new do |opts|
   opts.banner = help
 
-  # set defaults
-  options[:verbose] = false
-  options[:coloring] = true
-
   opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
     options[:verbose] = v
   end
 
-  opts.on("-c", "--[no-]coloring", "Ansi color in output") do |c|
-    options[:coloring] = c
+  opts.on("-c", "--[no-]coloring [MODE]", "--[no-]color [MODE]", "ANSI color in output. MODE=AUTO (default) or ALWAYS") do |c|
+    options[:color] = c.nil? ? "AUTO" : c
+    options[:color].upcase! if options[:color]
+    unless [nil, false, "AUTO", "ALWAYS"].include?(options[:color])
+      puts "oct, invalid color option: #{options[:color]}"
+      exit 1
+    end
   end
 
   opts.on("--version", "Display current version") do
@@ -44,16 +43,16 @@ OptionParser.new do |opts|
     exit 0
   end
 
-#   opts.on("--config FILE", "Load configuration options from FILE") do |file|
-#     options[:config] = file 
-#   end
+  opts.on("--config FILE", "Load configuration options from FILE") do |file|
+    options[:config] = file
+  end
 
   # no argument, shows at tail.  This will print an options summary.
   opts.on_tail("-h", "--help", "Show this message") do
     puts opts
     exit 0
   end
-  
+
   begin
     opts.parse!
   rescue OptionParser::InvalidOption => e
@@ -64,15 +63,20 @@ OptionParser.new do |opts|
 
 end
 
-if STDOUT.isatty
-  Term::ANSIColor::coloring = options[:coloring]
+# options from config file, if it exists, will not overwrite command line
+options = Oct::Settings.new(FileUtils.pwd, options).options
+
+if STDOUT.isatty || (options[:color] == 'ALWAYS')
+  Term::ANSIColor::coloring = options[:color]
 
-  if options[:coloring] && Oct::WINDOWS
-    begin
-      require 'Win32/Console/ANSI'
-    rescue LoadError
-      Term::ANSIColor::coloring = false
-      STDERR.puts 'WARNING: You must "gem install win32console" (1.2.0 or higher) to get color output on MRI/Windows'
+  if options[:color] && Oct::WINDOWS
+    unless ENV['ANSICON']
+      begin
+        require 'Win32/Console/ANSI'
+      rescue LoadError
+        Term::ANSIColor::coloring = false
+        STDERR.puts 'WARNING: You must "gem install win32console" (1.2.0 or higher) or use the ANSICON driver (https://github.com/adoxa/ansicon) to get color output on MRI/Windows'
+      end
     end
   end
 
@@ -80,5 +84,5 @@ else
   Term::ANSIColor::coloring = false
 end
 
-app = Oct::App.new(FileUtils.pwd, options)
-app.run
+app = Oct::App.new(FileUtils.pwd, ARGV.dup, options)
+app.execute

data/config/cucumber.yml

@@ -1,7 +1,8 @@
 <%
 rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
-rerun_opts = rerun.to_s.strip.empty? ? "--format pretty features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
-std_opts = "#{rerun_opts} --format rerun --out rerun.txt --strict --tags ~@wip"
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
 %>
-default: <%= std_opts %>
-wip: --tags @wip:3 --wip features
+default: <%= std_opts %> -r features
+wip: --tags @wip:3 --wip -r features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip -r features

data/features/bin.feature

@@ -3,18 +3,18 @@ Feature: Options via a command line interface (CLI)
 
   As an interactive user or automated script
   The application should accept options on the command line
-  These options should override hard coded defaults 
+  These options should override hard coded defaults
   In order to configure options
 
   Scenario: Version info
-    When I run "oct --version"
+    When I run `oct --version`
     Then the exit status should be 0
     And the output should match /oct, version ([\d]+\.[\d]+\.[\d]+$)/
 
   Scenario: Help
-    When I run "oct --help"
+    When I run `oct --help`
     Then the exit status should be 0
-    And the output should match: 
+    And the output should match:
       """
       .*
         Usage: .*
@@ -25,9 +25,9 @@ Feature: Options via a command line interface (CLI)
       """
 
   Scenario: Invalid option
-    When I run "oct --non-existing-option"
+    When I run `oct --non-existing-option`
     Then the exit status should be 1
-    And the output should match: 
+    And the output should match:
       """
       ^.* invalid option: --non-existing-option
       ^.* --help for more information

data/features/oct.feature

@@ -13,7 +13,7 @@ Feature: Octal file listing
     And file "file1.txt" is chmod 0644
 
   Scenario: No files on the command line
-    When I run "oct"
+    When I run `oct`
     Then the exit status should be 0
     And the output should contain:
       """
@@ -22,7 +22,7 @@ Feature: Octal file listing
       """
 
   Scenario: Files on the command line
-    When I run "oct file1*"
+    When I run `oct file1.txt`
     Then the exit status should be 0
     And the output should contain:
       """

data/features/settings.feature

@@ -0,0 +1,139 @@
+@announce
+Feature: Configuration via yaml file
+
+  In order to configure options, as an interactive user or automated script,
+  the program should process configuration options via yaml. These options
+  should override hard coded defaults but not command line options.
+
+  Config files are read from multiple locations in order of priority.  Once a
+  config file is found, all other config files are ignored.
+
+  Config file priority:
+
+      oct.conf
+      .oct.conf
+      config/oct.conf
+      ~/.oct.conf
+
+  All command line options can be read from the config file from the "options:"
+  block. The "options" block is optional.
+
+  NOTE: All file system testing is done via the Aruba gem.  The home folder
+  config file is stubbed to prevent testing contamination in case it exists.
+
+
+  Scenario: Specified config file exists
+    Given an empty file named "config.conf"
+    When I run `oct action --verbose --config config.conf`
+    Then the output should contain:
+      """
+      config file: config.conf
+      """
+
+  Scenario: Specified config file option but not given on command line
+    When I run `oct action --verbose --config`
+    Then the exit status should be 1
+    And the output should contain:
+      """
+      missing argument: --config
+      """
+
+  Scenario: Specified config file not found
+    When I run `oct path --verbose --config config.conf`
+    Then the exit status should be 1
+    And the output should contain:
+      """
+      config file not found
+      """
+
+ Scenario: Reading options from specified config file, ignoring the
+    default config file
+    Given a file named "oct.conf" with:
+      """
+      ---
+      options:
+        color: true
+      """
+    And a file named "no_color.conf" with:
+      """
+      ---
+      options:
+        color: false
+      """
+    When I run `oct action --verbose --config no_color.conf`
+    Then the output should contain:
+      """
+      :color=>false
+      """
+    And the output should not contain:
+      """
+      :color=>true
+      """
+
+  Scenario: Reading options from specified config file, ignoring the
+    default config file with override on command line
+    Given a file named "oct.conf" with:
+      """
+      ---
+      options:
+        color: true
+      """
+    And a file named "no_color.conf" with:
+      """
+      ---
+      options:
+        color: false
+      """
+    When I run `oct action --verbose --config no_color.conf --color`
+    Then the output should contain:
+      """
+      :color=>"AUTO"
+      """
+    And the output should not contain:
+      """
+      :color=>false
+      """
+    And the output should not contain:
+      """
+      :color=>true
+      """
+
+ Scenario: Reading options from config file with negative override on command line
+    And a file named "with_color.conf" with:
+      """
+      ---
+      options:
+        color: true
+      """
+    When I run `oct action --verbose --config with_color.conf --no-color`
+    Then the output should contain:
+      """
+      :color=>false
+      """
+
+ Scenario: Negative override on command line with alternative spelling '--no-coloring'
+    And a file named "with_color.conf" with:
+      """
+      ---
+      options:
+        color: true
+      """
+    When I run `oct action --verbose --config with_color.conf --no-coloring`
+    Then the output should contain:
+      """
+      :color=>false
+      """
+
+  Scenario: Reading text options from config file
+    Given a file named "with_always_color.conf" with:
+      """
+      ---
+      options:
+        color: ALWAYS
+      """
+    When I run `oct action --verbose --config with_always_color.conf`
+    Then the output should contain:
+      """
+      :color=>"ALWAYS"
+      """
+

data/features/step_definitions/oct_steps.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 Given /^file "([^"]*)" is chmod (\d+)$/ do |filename, permissions|
   in_current_dir do
     FileUtils.chmod permissions.to_i(8), filename

data/features/support/aruba.rb

@@ -1,21 +1,21 @@
-require 'aruba'
+require 'aruba/api'
 require 'fileutils'
 
-APP_BIN_PATH = File.join(ENV['PWD'], 'bin', 'oct')
+APP_BIN_PATH = File.join(FileUtils.pwd, 'bin', 'oct')
 
 module Aruba
   module Api
 
-   alias_method :old_run, :run
+   alias_method :old_run_simple, :run_simple
+
+    # override aruba
+    def run_simple(cmd, fail_on_error=true)
 
-    # override aruba 
-    def run(cmd, fail_on_error=true)
-      
       # run development version in verbose mode
-      cmd = cmd.gsub(/^oct/, "#{APP_BIN_PATH} --verbose")
+      cmd = cmd.gsub(/^oct/, "ruby -S #{APP_BIN_PATH} --verbose")
 
-      # run original aruba 'run' 
-      old_run(cmd, fail_on_error)
+      # run original aruba 'run'
+      old_run_simple(cmd, fail_on_error)
     end
   end
 end