stewfinder 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7568eef5a5a01727b1d544b6d62ccc2ac54228c
-  data.tar.gz: cdd6bb1ae7576d98a7d219e4c2ac2c3037685342
+  metadata.gz: 0a5e78e27f1e4a329755bceef065da6b53ff4665
+  data.tar.gz: 2011b0b615358b6c6d974f1d7715d943e55ec921
 SHA512:
-  metadata.gz: 6f21aed6cd835cf1c35dd754188a44fbdefd87c7bb2e92807c693dbd132a0491c947c971c1c70a13b0999c09aadac9f21004b6eafb28848a09000a3abfe03521
-  data.tar.gz: ad3360ad32eed9cec6301d8da37bffeeca2c1622b80d6b79a5822b076b7b70fba03d49b32466ecab86b67d186b147956568f12a8b85aa7ef83db93ff19c6a4a6
+  metadata.gz: 12467cbff214c1f0b0bde5f61a582e27f308c67324c436bf78306bae80e86333d7ff3c29141c3ca7bf21e36670366ba96d69fc420a02d4ad306d4494626b9673
+  data.tar.gz: b81f738cfacd95bb84d3d88faced22d2e64b9da67b4e2d4e9cf90303bf4bb50957588333baacc86649c369f78501ecbc357120b1a0ac5a085ffc26f07c3b719e

data/.rubocop.yml

@@ -29,5 +29,8 @@ Style/NumericLiterals:
 Style/RaiseArgs:
   Enabled: false
 
+Style/NegatedIf:
+  Enabled: false
+
 Style/SignalException:
   EnforcedStyle: only_raise

data/Gemfile

@@ -4,5 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  gem 'rubocop'
+  # This provides some basic reporting on tests for CircleCI
+  gem 'minitest-ci', git: 'git@github.com:circleci/minitest-ci.git'
 end
+
+gem 'simplecov', require: false, group: :test

data/README.md

@@ -1,7 +1,9 @@
-# Stewfinder
+# Stewfinder 
 
 This gem provides command line utilities for working locally with [Ladle](https://github.com/appfolio/ladle) style stewards files.
 
+[![Circle CI](https://circleci.com/gh/appfolio/stewfinder/tree/master.svg?style=svg)](https://circleci.com/gh/appfolio/stewfinder/tree/master)
+
 ## Installation
 
 Install via the command line:

data/Rakefile

@@ -1 +1,8 @@
 require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  sh 'rubocop'
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+end

data/exe/stewfinder

@@ -1,6 +1,3 @@
 #!/usr/bin/env ruby
 require 'stewfinder'
-
-filename = ARGV[0] ? File.absolute_path(ARGV[0]) : Dir.pwd
-
-Stewfinder.new(filename).find
+exit Stewfinder::Command.new.run

data/lib/stewfinder.rb

@@ -1,62 +1,2 @@
+require 'stewfinder/module'
 require 'stewfinder/version'
-require 'yaml'
-
-class Stewfinder
-  def initialize(filename)
-    @name = filename
-  end
-
-  def find
-    stewards = get_stewards
-
-    puts 'Stewards for this file:'
-    if stewards.empty?
-      puts 'None'
-    else
-      puts ' - ' + stewards.uniq.sort.join("\n - ")
-    end
-  end
-
-  private
-
-  def get_stewfiles
-    stewfiles = []
-    cur_path = Pathname(@name)
-    while cur_path
-      stewfiles << File.join(cur_path, 'stewards.yml') if File.exist?(File.join(cur_path, 'stewards.yml'))
-      prev_path = cur_path
-      cur_path = cur_path.split.first
-      break if cur_path == prev_path
-    end
-    stewfiles
-  end
-
-  def get_stewards
-    stewards = []
-    stewfiles = get_stewfiles
-    stewfiles.each do |file|
-      steward_hash = YAML.load_file(file)
-      next unless steward_hash
-
-      steward_hash['stewards'].each do |s|
-        case s
-        when String
-          stewards << s
-        when Hash
-          begin
-            if [s['include']].flatten.any? { |i| File.fnmatch?(i.to_s, @name) } &&
-               [s['exclude']].flatten.none? { |i| File.fnmatch?(i.to_s, @name) }
-              stewards << s['github_username']
-            end
-          rescue
-            puts "Invalid Format: #{s.inspect} in file #{file}"
-          end
-        else
-          puts "Invalid Format: #{s.inspect} in file #{file}"
-        end
-      end
-    end
-
-    stewards
-  end
-end

data/lib/stewfinder/command.rb

@@ -0,0 +1,49 @@
+require 'docopt'
+require_relative 'finder'
+require_relative 'version'
+
+module Stewfinder
+  # Provides the command line interface to Stewfinder
+  class Command
+    DOC = <<-DOC
+stewfinder: A tool to help discover code stewards.
+
+Usage:
+  stewfinder [options] [PATH]
+  stewfinder -h | --help
+  stewfinder --version
+
+Options:
+  --sort  Sort the output list.
+
+When PATH isn't provided stewfinder will use the present working directory.
+    DOC
+          .freeze
+
+    def initialize
+      @exit_status = 0
+    end
+
+    def run
+      options = Docopt.docopt(DOC, argv: argv, version: VERSION)
+      finder = Finder.new(File.absolute_path(options['PATH'] || Dir.pwd))
+      finder.print_stewards(options['--sort'])
+      @exit_status
+    rescue Docopt::Exit => exc
+      exit_with_status(exc.message, exc.class.usage != '')
+    rescue StandardError => exc
+      exit_with_status(exc.message)
+    end
+
+    private
+
+    def argv
+      ARGV
+    end
+
+    def exit_with_status(message, condition = true)
+      puts message
+      @exit_status = condition ? 1 : @exit_status
+    end
+  end
+end

data/lib/stewfinder/finder.rb

@@ -0,0 +1,71 @@
+require 'yaml'
+
+module Stewfinder
+  class Finder
+    def initialize(filename)
+      raise StandardError, "Invalid file #{filename}" unless File.exist?(filename)
+      @name = filename
+    end
+
+    def find
+      get_stewards.uniq
+    end
+
+    def print_stewards(sort)
+      stewards = find
+
+      str = "Stewards for #{@name}:\n"
+      if stewards.empty?
+        str += 'None'
+      else
+        stewards = stewards.sort! if sort
+        str += ' - ' + stewards.join("\n - ")
+      end
+
+      puts str
+    end
+
+    private
+
+    def get_stewfiles
+      stewfiles = []
+      cur_path = Pathname(@name)
+      prev_path = nil
+      while cur_path != prev_path
+        stewfiles << File.join(cur_path, 'stewards.yml') if File.exist?(File.join(cur_path, 'stewards.yml'))
+        prev_path = cur_path
+        cur_path = cur_path.split.first
+      end
+      stewfiles
+    end
+
+    def get_stewards
+      stewards = []
+      stewfiles = get_stewfiles
+      stewfiles.each do |file|
+        steward_hash = YAML.load_file(file)
+        next unless steward_hash
+
+        steward_hash['stewards'].each do |s|
+          case s
+          when String
+            stewards << s
+          when Hash
+            begin
+              if [s['include']].flatten.any? { |i| File.fnmatch?(i.to_s, @name) } &&
+                 [s['exclude']].flatten.none? { |i| File.fnmatch?(i.to_s, @name) }
+                stewards << s['github_username']
+              end
+            rescue
+              puts "Invalid Format: #{s.inspect} in file #{file}"
+            end
+          else
+            puts "Invalid Format: #{s.inspect} in file #{file}"
+          end
+        end
+      end
+
+      stewards
+    end
+  end
+end

data/lib/stewfinder/module.rb

@@ -0,0 +1,2 @@
+require_relative 'command'
+require_relative 'finder'

data/lib/stewfinder/version.rb

@@ -1,3 +1,3 @@
-class Stewfinder
-  VERSION = '0.0.1'
+module Stewfinder
+  VERSION = '0.0.2'.freeze
 end

data/stewards.yml

@@ -0,0 +1,3 @@
+stewards:
+  - XanderStrike
+  - bboe

data/stewfinder.gemspec

@@ -19,6 +19,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.add_runtime_dependency 'docopt', '~> 0.5'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.8'
+  spec.add_development_dependency 'rubocop', '~> 0.38'
+  spec.add_development_dependency 'mocha', '~> 1.1'
 end

data/test/command_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+module Stewfinder
+  class CommandTest < MiniTest::Test
+    def test_run
+      finder_mock = mock
+      Finder.expects(:new).with('/home/test').returns(finder_mock)
+      finder_mock.expects(:print_stewards).with(false)
+      cmd = Command.new
+      cmd.expects(:argv).returns(['/home/test'])
+
+      assert_equal 0, cmd.run
+    end
+
+    def test_run__sort
+      finder_mock = mock
+      Finder.expects(:new).with('/home/test').returns(finder_mock)
+      finder_mock.expects(:print_stewards).with(true)
+      cmd = Command.new
+      cmd.expects(:argv).returns(['/home/test', '--sort'])
+
+      assert_equal 0, cmd.run
+    end
+
+    def test_run__defaults_to_pwd
+      Dir.expects(:pwd).returns('/current/dir')
+      finder_mock = mock
+      Finder.expects(:new).with('/current/dir').returns(finder_mock)
+      finder_mock.expects(:print_stewards).with(false)
+      cmd = Command.new
+      cmd.expects(:argv).returns([])
+
+      assert_equal 0, cmd.run
+    end
+
+    def test_run__invalid_option
+      cmd = Command.new
+      cmd.expects(:argv).returns(['--bryce'])
+      STDOUT.expects(:puts).with("--bryce is not recognized\nUsage:\n  stewfinder [options] [PATH]\n  stewfinder -h | --help\n  stewfinder --version")
+
+      assert_equal 1, cmd.run
+    end
+
+    def test_run__help
+      cmd = Command.new
+      cmd.expects(:argv).returns(['-h'])
+      STDOUT.expects(:puts).with(Command::DOC)
+
+      assert_equal 0, cmd.run
+    end
+
+    def test_run__raises
+      Docopt.expects(:docopt).raises(StandardError, 'error message')
+      STDOUT.expects(:puts).with('error message')
+
+      assert_equal 1, Command.new.run
+    end
+  end
+end

data/test/finder_test.rb

@@ -0,0 +1,117 @@
+require 'test_helper'
+
+module Stewfinder
+  class FinderTest < MiniTest::Test
+    def test_initialize__file_does_not_exist
+      File.expects(:exist?).returns(false)
+
+      assert_raises StandardError do
+        Finder.new('not a file lol')
+      end
+    end
+
+    def test_find
+      File.stubs(:exist?).returns(true)
+      YAML.stubs(:load_file).returns(loaded_stewfile)
+
+      finder = Finder.new('/home/test/git/stewfinder')
+
+      assert_equal %w(test2 test1), finder.find
+    end
+
+    def test_find__with_regex
+      File.stubs(:exist?).returns(true)
+      YAML.stubs(:load_file).returns(loaded_stewfile)
+
+      finder = Finder.new('/home/test/git/stewfinder/regex.rb')
+
+      assert_equal %w(test2 test1 test_regex1 test_regex2), finder.find
+    end
+
+    def test_find__handles_bad_syntax
+      File.stubs(:exist?).returns(true)
+      YAML.stubs(:load_file).returns('stewards' => ['test1', 1])
+      STDOUT.expects(:puts).with('Invalid Format: 1 in file /stewards.yml')
+
+      finder = Finder.new('/')
+
+      assert_equal %w(test1), finder.find
+    end
+
+    def test_find__does_not_load_nonexistant_files
+      File.stubs(:exist?).returns(false)
+      File.expects(:exist?)
+          .with(any_of('/home/test/stewards.yml', '/home/test/git/stewfinder/test/finder_test.rb'))
+          .returns(true).twice
+      YAML.expects(:load_file).returns('stewards' => ['test1'])
+
+      finder = Finder.new('/home/test/git/stewfinder/test/finder_test.rb')
+
+      assert_equal ['test1'], finder.find
+    end
+
+    def test_find__no_stewards
+      File.stubs(:exist?).returns(true)
+      YAML.stubs(:load_file).returns('stewards' => [])
+
+      finder = Finder.new('/home/test/git/stewfinder')
+
+      assert_equal [], finder.find
+    end
+
+    def test_find__fnmatch_raises_error
+      File.stubs(:exist?).returns(true)
+      YAML.stubs(:load_file).returns('stewards' => [{ 'github_username' => 'test_regex2', 'include' => '*regex*' }])
+      STDOUT.expects(:puts).with do |*args|
+        args.first.include?('Invalid Format')
+      end
+
+      File.expects(:fnmatch?).raises(StandardError)
+
+      finder = Finder.new('/')
+
+      finder.find
+    end
+
+    def test_print_stewards__unsorted
+      File.stubs(:exist?).returns(true)
+      YAML.stubs(:load_file).returns(loaded_stewfile)
+      STDOUT.expects(:puts).with("Stewards for /home/test/git/stewfinder:\n - test2\n - test1")
+
+      finder = Finder.new('/home/test/git/stewfinder')
+
+      finder.print_stewards(false)
+    end
+
+    def test_print_stewards__sorted
+      File.stubs(:exist?).returns(true)
+      YAML.stubs(:load_file).returns(loaded_stewfile)
+      STDOUT.expects(:puts).with("Stewards for /home/test/git/stewfinder:\n - test1\n - test2")
+
+      finder = Finder.new('/home/test/git/stewfinder')
+
+      finder.print_stewards(true)
+    end
+
+    def test_print_stewards__no_stewards
+      File.stubs(:exist?).returns(true)
+      YAML.stubs(:load_file).returns('stewards' => [])
+      STDOUT.expects(:puts).with("Stewards for /home/test/git/stewfinder:\nNone")
+
+      finder = Finder.new('/home/test/git/stewfinder')
+
+      finder.print_stewards(false)
+    end
+
+    private
+
+    def loaded_stewfile
+      { 'stewards' => [
+        'test2',
+        'test1',
+        { 'github_username' => 'test_regex1', 'include' => ['*regex*'] },
+        { 'github_username' => 'test_regex2', 'include' => '*regex*' }
+      ] }
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'simplecov'
+
+# save to CircleCI's artifacts directory if we're on CircleCI
+if ENV['CIRCLE_ARTIFACTS']
+  dir = File.join(ENV['CIRCLE_ARTIFACTS'], 'coverage')
+  SimpleCov.coverage_dir(dir)
+end
+
+SimpleCov.minimum_coverage(100)
+SimpleCov.start
+
+require 'stewfinder'
+require 'minitest/autorun'
+require 'mocha/mini_test'
+require 'pathname'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: stewfinder
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alexander Standke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-22 00:00:00.000000000 Z
+date: 2016-03-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: docopt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: Finds stewards for a given file.
 email:
 - alexander.standke@appfolio.com
@@ -54,8 +110,15 @@ files:
 - Rakefile
 - exe/stewfinder
 - lib/stewfinder.rb
+- lib/stewfinder/command.rb
+- lib/stewfinder/finder.rb
+- lib/stewfinder/module.rb
 - lib/stewfinder/version.rb
+- stewards.yml
 - stewfinder.gemspec
+- test/command_test.rb
+- test/finder_test.rb
+- test/test_helper.rb
 homepage: https://github.com/appfolio/stewfinder
 licenses:
 - MIT
@@ -80,5 +143,8 @@ rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Get it while it's hot!
-test_files: []
+test_files:
+- test/command_test.rb
+- test/finder_test.rb
+- test/test_helper.rb
 has_rdoc: