oct 0.2.0 → 0.3.1

data/features/support/env.rb

@@ -1,5 +1,8 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'rubygems'
 require 'oct'
-require 'aruba'
-require 'spec/expectations'
+require 'aruba/cucumber'
+require 'rspec/expectations'
+require File.expand_path(File.dirname(__FILE__) + '/../../spec/aruba_helper')
+
+Before do
+  @aruba_timeout_seconds = 10
+end

data/lib/oct/app.rb

@@ -1,4 +1,3 @@
-require 'configatron'
 require 'term/ansicolor'
 
 class String
@@ -11,21 +10,26 @@ module Oct
 
   class App
 
-    def initialize(base_dir, options={})
-      @base_dir = base_dir
+    def initialize(working_dir, argv=[], options={})
+      @working_dir = working_dir
       @options = options
+      @argv = argv
       if @options[:verbose]
-        puts "base_dir: #{@base_dir}".cyan
+        puts "working_dir: #{@working_dir}".cyan
         puts "options: #{@options.inspect}".cyan
+        puts "base_dir: #{@options[:base_dir]}".cyan if @options[:base_dir]
+        puts "config file: #{@options[:config]}".cyan if @options[:config]
       end
-      configure(options)
+      $stdout.sync = true
     end
 
-    def run
+    def execute
       begin
 
         if action_argument_required?
-          action = ARGV.shift
+          action = @argv.shift
+          args = @argv
+
           unless AVAILABLE_ACTIONS.include?(action)
             if action.nil?
               puts "oct action required"
@@ -35,9 +39,9 @@ module Oct
             puts "oct --help for more information"
             exit 1
           end
-          puts "oct run action: #{action}".cyan if @options[:verbose]
+          puts "oct run action: #{action} #{args.join(' ')}".cyan if @options[:verbose]
           raise "action #{action} not implemented" unless respond_to?(action)
-          result = send(action)
+          result = send(action, args)
         else
           #
           # default action if action_argument_required? is false
@@ -46,7 +50,12 @@ module Oct
           result = Oct::FileStat.new.mode(files, @options)
         end
 
-        exit(result ? 0 : 1)
+        if result.is_a?(Numeric)
+          exit(result)
+        else
+          # handle all other return types
+          exit(result ? 0 : 1)
+        end
 
       rescue SystemExit => e
         # This is the normal exit point, exit code from the send result
@@ -56,6 +65,7 @@ module Oct
       rescue Exception => e
         STDERR.puts("oct command failed, error(s) follow:")
         STDERR.puts("#{e.message}".red)
+        STDERR.puts("Use '--verbose' for backtrace.") unless @options[:verbose]
         STDERR.puts(e.backtrace.join("\n")) if @options[:verbose]
         exit(1)
       end
@@ -65,7 +75,7 @@ module Oct
     # app commands start
     #
 
-    
+
     #
     # app commands end
     #
@@ -77,26 +87,5 @@ module Oct
       !AVAILABLE_ACTIONS.empty?
     end
 
-    # read options for YAML config with ERB processing and initialize configatron
-    def configure(options)
-      config = @options[:config]
-      config = File.join(@base_dir, 'oct.conf') unless config
-      if File.exists?(config)
-        # load configatron options from the config file
-        puts "loading config file: #{config}".cyan if @options[:verbose]
-        configatron.configure_from_yaml(config)
-      else
-        # user specified a config file?
-        raise "config file not found" if @options[:config]
-        # no error if user did not specify config file
-        puts "#{config} not found".yellow if @options[:verbose]
-      end
-      
-      # 
-      # set defaults, these will NOT override setting read from YAML
-      #
-
-    end
-
   end
 end

data/lib/oct/core/array.rb

@@ -0,0 +1,11 @@
+class Array
+  def recursively_symbolize_keys!
+    self.each do |item|
+      if item.is_a? Hash
+        item.recursively_symbolize_keys!
+      elsif item.is_a? Array
+        item.recursively_symbolize_keys!
+      end
+    end
+  end
+end

data/lib/oct/core/hash.rb

@@ -0,0 +1,45 @@
+class Hash
+
+  # sorted yaml
+  def to_yaml( opts = {} )
+    YAML::quick_emit( object_id, opts ) do |out|
+      out.map( taguri, to_yaml_style ) do |map|
+        sorted_keys = keys
+        sorted_keys = begin
+          sorted_keys.sort
+        rescue
+          sorted_keys.sort_by {|k| k.to_s} rescue sorted_keys
+        end
+
+        sorted_keys.each do |k|
+          map.add( k, fetch(k) )
+        end
+      end
+    end
+  end
+
+  # active_support hash key functions
+  def symbolize_keys!
+    self.replace(self.symbolize_keys)
+  end
+
+  def symbolize_keys
+    inject({}) do |options, (key, value)|
+      options[(key.to_sym rescue key) || key] = value
+      options
+    end
+  end
+
+  def recursively_symbolize_keys!
+    self.symbolize_keys!
+    self.values.each do |v|
+      if v.is_a? Hash
+        v.recursively_symbolize_keys!
+      elsif v.is_a? Array
+        v.recursively_symbolize_keys!
+      end
+    end
+    self
+  end
+
+end

data/lib/oct/oct.rb

@@ -9,7 +9,7 @@ module Oct
       puts "oct mode files: #{files.inspect}".cyan if options[:verbose]
       files.sort.each do |file|
         stat = File.stat(file)
-        printf("%04o ", stat.mode & 07777)        
+        printf("%04o ", stat.mode & 07777)
         if stat.directory?
           puts file.blue
         elsif stat.executable?
@@ -19,7 +19,7 @@ module Oct
         else
           puts file
         end
-      end 
+      end
     end
 
   end

data/lib/oct/settings.rb

@@ -0,0 +1,60 @@
+require 'yaml'
+
+module Oct
+
+  class Settings
+
+    def initialize(working_dir, options={})
+      @working_dir = working_dir
+      @options = options
+      configure
+    end
+
+    def options
+      @options
+    end
+
+  private
+
+    # read options from YAML config
+    def configure
+
+      # config file default options
+      configuration = {
+                        :options => {
+                          :verbose => false,
+                          :color => 'AUTO'
+                        }
+                      }
+
+      # set default config if not given on command line
+      config = @options[:config]
+      unless config
+        config = [
+                   File.join(@working_dir, "oct.conf"),
+                   File.join(@working_dir, ".oct.conf"),
+                   File.join(@working_dir, "config", "oct.conf"),
+                   File.expand_path(File.join("~", ".oct.conf"))
+                 ].detect { |filename| File.exists?(filename) }
+      end
+
+      if config && File.exists?(config)
+        # rewrite options full path for config for later use
+        @options[:config] = config
+
+        # load options from the config file, overwriting hard-coded defaults
+        config_contents = YAML::load(File.open(config))
+        configuration.merge!(config_contents.symbolize_keys!) if config_contents && config_contents.is_a?(Hash)
+      else
+        # user specified a config file?, no error if user did not specify config file
+        raise "config file not found" if @options[:config]
+      end
+
+      # the command line options override options read from the config file
+      @options = configuration[:options].symbolize_keys!.merge!(@options)
+
+    end
+
+  end
+
+end

data/lib/oct.rb

@@ -1,6 +1,9 @@
 # require all files here
 require 'rbconfig'
+require 'oct/core/hash'
+require 'oct/core/array'
 require 'oct/app'
+require 'oct/settings'
 require 'oct/oct'
 
 # Master namespace
@@ -20,8 +23,8 @@ module Oct
 
   # Platform constants
   unless defined?(BasicGem::WINDOWS)
-    WINDOWS = Config::CONFIG['host_os'] =~ /mswin|mingw/i
-    CYGWIN = Config::CONFIG['host_os'] =~ /cygwin/i
+    WINDOWS = RbConfig::CONFIG['host_os'] =~ /mswin|mingw/i
+    CYGWIN = RbConfig::CONFIG['host_os'] =~ /cygwin/i
   end
 
 end

data/oct.gemspec

@@ -1,30 +1,25 @@
 # -*- encoding: utf-8 -*-
 #
 #
-
 Gem::Specification.new do |s|
-  # wrap 'git' so we can get gem files even on systems without 'git'
+
+  # avoid shelling out to run git every time the gemspec is evaluated
   #
   # @see spec/gemspec_spec.rb
   #
-  @gemfiles ||= begin
-    filename  = File.join(File.dirname(__FILE__), '.gemfiles')
-    # backticks blows up on Windows w/o valid binary, use system instead
-    if File.directory?('.git') && system('git ls-files bogus-filename')
-      files = `git ls-files`
-      cached_files = File.exists?(filename) ? File.open(filename, "r") {|f| f.read} : nil
-      # maintain EOL
-      files.gsub!(/\n/, "\r\n") if cached_files && cached_files.match("\r\n")
-      File.open(filename, 'wb') {|f| f.write(files)} if cached_files != files
-    else
-      files = File.open(filename, "r") {|f| f.read}
-    end
-    raise "unable to process gemfiles" unless files
-    files.gsub(/\r\n/, "\n") 
+  gemfiles_cache = File.join(File.dirname(__FILE__), '.gemfiles')
+  if File.exists?(gemfiles_cache)
+    gemfiles = File.open(gemfiles_cache, "r") {|f| f.read}
+    # normalize EOL
+    gemfiles.gsub!(/\r\n/, "\n")
+  else
+    # .gemfiles missing, run 'rake gemfiles' to create it
+    # falling back to 'git ls-files'"
+    gemfiles = `git ls-files`
   end
 
   s.name        = "oct"
-  s.version     = File.open(File.join(File.dirname(__FILE__), 'VERSION'), "r") { |f| f.read } 
+  s.version     = File.open(File.join(File.dirname(__FILE__), 'VERSION'), "r") { |f| f.read }
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Robert Wahler"]
   s.email       = ["robert@gearheadforhire.com"]
@@ -36,31 +31,25 @@ Gem::Specification.new do |s|
   s.rubyforge_project         = "oct"
 
   s.add_dependency 'term-ansicolor', '>= 1.0.4'
-  s.add_dependency 'configatron', '>= 2.5.1'
 
-  s.add_development_dependency "bundler", ">= 1.0.7"
-  s.add_development_dependency "rspec", "= 1.3.1"
-  s.add_development_dependency "cucumber", ">= 0.9.4"
-  s.add_development_dependency "aruba", ">= 0.2.2"
+  s.add_development_dependency "bundler", ">= 1.0.14"
+  s.add_development_dependency "rspec", ">= 2.6.0"
+  s.add_development_dependency "cucumber", "~> 1.0"
+  s.add_development_dependency "aruba", "~> 0.4.3"
   s.add_development_dependency "rake", ">= 0.8.7"
-  s.add_development_dependency "yard", ">= 0.6.2"
-
-  # Specify a markdown gem for rake doc:generate
-  #
-  # Without the development dependency, running yard rake
-  # tasks will fail.  Kramdown chosen to provide a pure Ruby solution.
-  s.add_development_dependency "kramdown", ">= 0.12.0"
 
-  s.files        = @gemfiles.split("\n")
-  s.executables  = @gemfiles.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  # doc generation
+  s.add_development_dependency "yard", ">= 0.7.2"
+  s.add_development_dependency "redcarpet", ">= 1.17.2"
 
-  s.require_path = 'lib'
+  s.files        = gemfiles.split("\n")
+  s.executables  = gemfiles.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_paths = ["lib"]
 
-  s.has_rdoc = 'yard'
-  s.rdoc_options     = [ 
-                         '--title', 'Oct Documentation', 
-                         '--main', 'README.markdown', 
+  s.rdoc_options     = [
+                         '--title', 'Oct Documentation',
+                         '--main', 'README.markdown',
                          '--line-numbers',
-                         '--inline-source' 
+                         '--inline-source'
                        ]
 end

data/spec/aruba_helper.rb

@@ -0,0 +1,25 @@
+module Aruba
+  module Api
+
+    # @return full path to files in the aruba tmp folder
+    def fullpath(filename)
+      path = File.expand_path(File.join(current_dir, filename))
+      if path.match(/^\/cygdrive/)
+        # match /cygdrive/c/path/to and return c:\\path\\to
+        path = `cygpath -w #{path}`.chomp
+      elsif path.match(/.\:/)
+        # match c:/path/to and return c:\\path\\to
+        path = path.gsub(/\//, '\\')
+      end
+      path
+    end
+
+    # @return the contents of "filename" in the aruba tmp folder
+    def get_file_contents(filename)
+      in_current_dir do
+        IO.read(filename)
+      end
+    end
+
+  end
+end

data/spec/basic_app/array_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe Array do
+
+  describe 'recursively_symbolize_keys!' do
+
+    it "should recursively convert a hash with string keys to a hash with symbol keys" do
+      hash_symbols = {
+                        :options => {
+                          :verbose => false,
+                        },
+                          :repos => {
+                             :repo1 => {:path => "something"}
+                        }
+                      }
+
+      hash_strings = {
+                        'options' => {
+                          'verbose' => false,
+                        },
+                          'repos' => {
+                             'repo1' => {'path' => "something"}
+                        }
+                      }
+
+      hash_symbols.should == hash_strings.recursively_symbolize_keys!
+    end
+
+    it "should should handle hashes that are already symbolized" do
+      hash_symbols = {
+                        :options => {
+                          :verbose => false,
+                        },
+                          :repos => {
+                             :repo1 => {:path => "something"}
+                        }
+                      }
+
+      hash_copy = hash_symbols.dup
+
+      hash_copy.should == hash_symbols.recursively_symbolize_keys!
+      hash_symbols[:repos][:repo1].should == {:path => "something"}
+    end
+
+  end
+
+end
+

data/spec/basic_gem/aruba_helper_spec.rb

@@ -1,10 +1,10 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe Oct  do
-  
+
   before(:each) do
     @filename = 'input.txt'
-    create_file(@filename, "the quick brown fox")
+    write_file(@filename, "the quick brown fox")
   end
 
   describe 'Aruba::API.current_dir' do

data/spec/basic_gem/basic_gem_spec.rb

@@ -1,7 +1,7 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe Oct do
-  
+
   describe 'version' do
 
     it "should return a string formatted '#.#.#'" do
@@ -10,4 +10,75 @@ describe Oct do
 
   end
 
+  # VIM autocmd to remove trailing whitespace
+  # autocmd BufWritePre * :%s/\s\+$//e
+  #
+  describe "code" do
+
+    before(:each) do
+      @gemfiles_filename = File.expand_path(File.dirname(__FILE__) + '/../../.gemfiles')
+      raise ".gemfiles not found.  Please run 'rake gemfiles'" unless File.exists?(@gemfiles_filename)
+      @gemfiles = File.open(@gemfiles_filename, "rb") {|f| f.read}
+      @eol = @gemfiles.match("\r\n") ? "\r\n" : "\n"
+    end
+
+    def binary?(filename)
+      open filename do |f|
+        f.each_byte { |x|
+          x.nonzero? or return true
+        }
+      end
+      false
+    end
+
+    def check_for_tab_characters(filename)
+      failing_lines = []
+      File.readlines(filename).each_with_index do |line,number|
+        failing_lines << number + 1 if line =~ /\t/
+      end
+
+      unless failing_lines.empty?
+        "#{filename} has tab characters on lines #{failing_lines.join(', ')}"
+      end
+    end
+
+    def check_for_extra_spaces(filename)
+      failing_lines = []
+      File.readlines(filename).each_with_index do |line,number|
+        next if line =~ /^\s+#.*\s+#{@eol}$/
+        failing_lines << number + 1 if line =~ /\s+#{@eol}$/
+      end
+
+      unless failing_lines.empty?
+        "#{filename} has spaces on the EOL on lines #{failing_lines.join(', ')}"
+      end
+    end
+
+    RSpec::Matchers.define :be_well_formed do
+      failure_message_for_should do |actual|
+        actual.join("\n")
+      end
+
+      match do |actual|
+        actual.empty?
+      end
+    end
+
+    it "has no malformed whitespace" do
+      error_messages = []
+      @gemfiles.split(@eol).each do |filename|
+        filename = File.expand_path(File.join(File.dirname(__FILE__), ["..", "..", filename]))
+        unless File.exists?(filename)
+          puts "WARNING: .gemfiles out-of-date, #{filename} not found.  Edit .gemfiles or run 'rake gemfiles' after committing changes."
+          next
+        end
+        next if filename =~ /\.gitmodules/
+        next if binary?(filename)
+        error_messages << check_for_tab_characters(filename)
+        error_messages << check_for_extra_spaces(filename)
+      end
+      error_messages.compact.should be_well_formed
+    end
+
+  end
 end

data/spec/basic_gem/gemspec_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe Oct do
 
@@ -6,7 +6,7 @@ describe Oct do
     filename = File.expand_path('../../../oct.gemspec', __FILE__)
     eval(File.read(filename), nil, filename)
   end
-  
+
   describe 'gemspec' do
 
     it "should return the gem VERSION" do
@@ -27,31 +27,19 @@ describe Oct do
         @gemspec.executables.is_a?(Array).should == true
       end
 
-      describe 'without an existing cache' do
+      describe 'without .gemfiles cache' do
         before(:each) do
           File.stub!('exists?').and_return false
           @gemspec = load_gemspec
         end
 
-        it "should not blow up" do
-          @gemspec.files.is_a?(Array).should == true
-          @gemspec.files.include?('VERSION').should == true
-        end
-      end
-
-      describe 'without a git repo' do
-        before(:each) do
-          File.stub!('directory?').and_return false
-          @gemspec = load_gemspec
-        end
-
-        it "should return 'files' from cache" do
-          File.directory?(File.expand_path('../../../.git', __FILE__)).should == false
+        it "should return 'files' from using 'git ls-files" do
+          File.exists?(File.expand_path('../../../.gemfiles', __FILE__)).should == false
           @gemspec.files.is_a?(Array).should == true
           @gemspec.files.include?('VERSION').should == true
         end
-        it "should return 'executables' from cache"  do
-          File.directory?(File.expand_path('../../../.git', __FILE__)).should == false
+        it "should return 'executables' from 'git ls-files"  do
+          File.exists?(File.expand_path('../../../.gemfiles', __FILE__)).should == false
           @gemspec.executables.is_a?(Array).should == true
         end
       end
@@ -64,12 +52,12 @@ describe Oct do
         end
 
         it "should return 'files' from cache" do
-          system('git --version').should == false 
+          system('git --version').should == false
           @gemspec.files.is_a?(Array).should == true
           @gemspec.files.include?('VERSION').should == true
         end
         it "should return 'executables' from cache"  do
-          system('git --version').should == false 
+          system('git --version').should == false
           @gemspec.executables.is_a?(Array).should == true
         end
 

data/spec/spec_helper.rb

@@ -1,35 +1,11 @@
-$LOAD_PATH.unshift File.expand_path('..', __FILE__) unless
-  $LOAD_PATH.include? File.expand_path('..', __FILE__)
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__) unless
-  $LOAD_PATH.include? File.expand_path('../../lib', __FILE__)
-
-require 'rubygems'
 require 'oct'
-require 'spec'
-require 'spec/autorun'
+require 'rspec/core'
 require 'aruba/api'
+require 'aruba_helper'
 
-# aruba helpers
-#
-# @return full path to files in the aruba tmp folder
-def fullpath(filename)
-  path = File.expand_path(File.join(current_dir, filename))
-  if path.match(/^\/cygdrive/)
-    # match /cygdrive/c/path/to and return c:\\path\\to
-    path = `cygpath -w #{path}`.chomp
-  elsif path.match(/.\:/)
-    # match c:/path/to and return c:\\path\\to
-    path = path.gsub(/\//, '\\')
-  end
-  path
-end
-# @return the contents of "filename" in the aruba tmp folder
-def get_file_contents(filename)
-  in_current_dir do
-    IO.read(filename)
-  end
-end
-
-Spec::Runner.configure do |config|
-   config.include Aruba::Api
+RSpec.configure do |config|
+  config.include Aruba::Api
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  config.treat_symbols_as_metadata_keys_with_true_values = true
 end

data/spec/watchr.rb

@@ -44,13 +44,15 @@ end
 
 def run(cmd)
 
+  cmd = 'bundle exec ' + cmd unless cmd.match(/^bundle exec/)
+
   pid = fork do
 
     puts "\n"
     if $c
       print $c.cyan, cmd, $c.clear, "\n"
     else
-      puts cmd 
+      puts cmd
     end
 
     exec(cmd)