abcing 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45e899cf0ef2f320559a335f595b930645c907fb
-  data.tar.gz: 6a8ec6dc306953b4c4f3a2953a5fc9446aafa978
+  metadata.gz: 44e2acf631192f7e19859f1eceef233fe3a6d89c
+  data.tar.gz: ed85447226cc1a8fc749f8320a9ee47707b44e96
 SHA512:
-  metadata.gz: 9f5f80cec5d7a39ff0a4d28d15afda88da2c266502fcb6b6fc508e97cc9286a0f55649c69f8bc1b4199da91589692c8ea03cdb2e2e2f01020ec412f56d700131
-  data.tar.gz: b07b409904e7f4cea6f5f2471ad2db8631b5b431674abda1806840610dde5770a2840312c5b30d8fd18408190c22aa9997f9e6bd21e3cdaa447900dd7a03d3aa
+  metadata.gz: 99d392ca8b0d58ecb0d9298ced3a084bc524e26c2555ef9c89a3c0c29d713d05b259fde6d57bbf64eee9a134f6740979661a5874673408601424d901328cebeb
+  data.tar.gz: 42c2b29d3f429522ce7bb20876cbfc71df2627c46826aeedf441462822a0b57b993b7983f1ee54c386f7e69e42ffd98c6c09ffc261a41c03e79d75e5a59ace02

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: "bundle exec rspec"
+rvm:
+- 1.9.2
+- 1.9.3
+- 2.0

data/README.md

@@ -1,6 +1,9 @@
 # ABCing
 
- ![alt tag](https://s3-eu-west-1.amazonaws.com/abcing/coverage.png)
+[![ABCing Gem Version](https://badge.fury.io/rb/abcing.svg)](http://badge.fury.io/rb/abcing)
+[![ABCing Travis build](https://travis-ci.org/emileswarts/ABCing.svg?branch=master)](https://travis-ci.org/emileswarts/ABCing.svg)
+![](http://ruby-gem-downloads-badge.herokuapp.com/abcing/0.0.2?type=total&color=brightgreen)
+![abcing gem](https://s3-eu-west-1.amazonaws.com/abcing/coverage.png)
 
 Dumbed down automated test coverage metrics.
 Checks your working directory for class names, and tries to match them in the test directories.
@@ -11,6 +14,13 @@ If it finds a matching class name in one of your test directories, you get a gre
 If it finds a class name in the working directory but not in the test directory, it is printed in red.
 Other letters (not present in your working directory or test directories) are printed in yellow.
 
+## Usage
+
+    $ abcing /path/to/project/root
+
+Right now this will check /path/to/project/root/spec and /path/to/project/root/features to find test files.
+It will use app/ and lib/ to find classes that should be tested.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,12 +37,6 @@ Or install it yourself as:
 
     $ gem install abcing
 
-## Usage
-
-abcing /path/to/project/root
-
-Currently this only considers app/ and lib/ for the scan.
-It will check spec/ and features/ for matching class names found in the working directory.
 
 ## Contributing
 
@@ -44,4 +48,7 @@ It will check spec/ and features/ for matching class names found in the working
 
 ## TODO
 
-1. check for presence of config file for scan params
+1. Check for presence of config file for scan params
+2. Add verbose mode that mentions the class names scanned for results
+3. Add score results
+4. Improve performance

data/abcing.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Abcing::VERSION
   spec.authors       = ["Emile"]
   spec.email         = ["emile.swarts123@gmail.com"]
-  spec.summary       = %q{Dumb code metrics}
-  spec.description   = %q{See coverage by alphabet}
-  spec.homepage      = ""
+  spec.summary       = %q{Idiot code metrics}
+  spec.description   = %q{Find classes mentioned in your application but not in your test suite.}
+  spec.homepage      = "https://github.com/emileswarts/ABCing"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/abcing.rb

@@ -13,15 +13,21 @@ module ABCing
     end
 
     def run
-      app_directories = ["#{@working_dir}/app", "#{@working_dir}/lib"]
-      test_directories = ["#{@working_dir}/spec", "#{@working_dir}/features"]
+      app_directories = [
+        "#{@working_dir}/app",
+        "#{@working_dir}/lib"
+      ]
+
+      test_directories = [
+        "#{@working_dir}/spec",
+        "#{@working_dir}/features"
+      ]
 
       params = {
         app_directories: app_directories,
         test_directories: test_directories }
 
       scan_results = ABCing::Scanner.new(params).results
-
       ABCing::Renderer.new(scan_results).render
     end
   end

data/lib/abcing/class_file_finder.rb

@@ -5,23 +5,11 @@ module ABCing
     end
 
     def find
-      @target_directories.collect do |dir|
-        matching_files(dir)
-      end.flatten
+      @target_directories.collect { |d| files_for_directory(d) }.flatten.sort
     end
 
     private
 
-    def matching_files(directory)
-      files_for_directory(directory).select do |f|
-        is_class_file? f
-      end
-    end
-
-    def is_class_file?(file)
-      File.read(file).include?('class ')
-    end
-
     def files_for_directory(directory)
       Dir["#{directory}/**/*.rb"]
     end

data/lib/abcing/colour_alphabet_result.rb

@@ -10,7 +10,7 @@ module ABCing
       results = {}
 
       @alphabet.each do |a|
-        results[a.to_sym] = colour(a)
+        results[a] = colour(a)
       end
 
       results

data/lib/abcing/renderer.rb

@@ -13,7 +13,7 @@ module ABCing
 
     def report
       coloured_letters.map do |coloured_letter, colour|
-        coloured_letter.to_s.send(colour)
+        coloured_letter.send(colour)
       end.join(' ')
     end
 

data/lib/abcing/version.rb

@@ -1,3 +1,3 @@
 module Abcing
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/alphabet_match_spec.rb

@@ -2,34 +2,18 @@
 require_relative '../lib/abcing/alphabet_match'
 
 describe ABCing::AlphabetMatch do
-  before(:each) do
-    Dir.mkdir 'dummy'
-  end
-
-  after(:each) do
-    FileUtils.rm_rf 'dummy'
-  end
-
   it 'collects 2 letters' do
-    class_names = ['Bar', 'Foo']
-    matcher = ABCing::AlphabetMatch.new(class_names)
-
+    matcher = ABCing::AlphabetMatch.new ['Bar', 'Foo']
     expect(matcher.letters).to eq(['B', 'F'])
   end
 
   it 'Only collects unique letters' do
-    class_names = ['Zoo', 'Zebra']
-
-    matcher = ABCing::AlphabetMatch.new(class_names)
-
+    matcher = ABCing::AlphabetMatch.new(['Zoo', 'Zebra'])
     expect(matcher.letters).to eq(['Z'])
   end
 
   it 'Orders letter results alphabetically' do
-    class_names = ['Cobra', 'Acid', 'Bee']
-
-    matcher = ABCing::AlphabetMatch.new(class_names)
-
+    matcher = ABCing::AlphabetMatch.new(['Cobra', 'Acid', 'Bee'])
     expect(matcher.letters).to eq(['A', 'B', 'C'])
   end
 end

data/spec/class_file_finder_spec.rb

@@ -4,26 +4,20 @@ require 'abcing/class_file_finder'
 describe ABCing::ClassFileFinder do
   before(:each) do
     Dir.mkdir 'dummy'
-    out_file = File.new("dummy/foo.rb", "w")
-    out_file.puts("class Foo; end;")
-    out_file.close
 
-    out_file = File.new("dummy/bar.rb", "w")
-    out_file.puts("class Foo; end;")
-    out_file.close
+    ['foo', 'bar'].each do |name|
+      File.write("dummy/#{ name }.rb", '')
+    end
   end
 
+  let(:expected_results) { ['dummy/bar.rb', 'dummy/foo.rb'] }
+
   after(:each) do
     FileUtils.rm_rf 'dummy'
   end
 
   context 'Included files' do
     it 'Finds files with class defined in them' do
-      expected_results = [
-        'dummy/bar.rb',
-        'dummy/foo.rb',
-      ]
-
       finder = ABCing::ClassFileFinder.new(['dummy'])
       expect(finder.find).to eq(expected_results)
     end
@@ -31,14 +25,7 @@ describe ABCing::ClassFileFinder do
 
   context 'Excluded files' do
     it 'that do not have a .rb extension' do
-      out_file = File.new("dummy/foo_config.txt", "w")
-      out_file.puts("class FooConfig; end;")
-      out_file.close
-
-      expected_results = [
-        'dummy/bar.rb',
-        'dummy/foo.rb',
-      ]
+      File.write('dummy/foo_config.txt', '')
 
       finder = ABCing::ClassFileFinder.new(['dummy'])
       expect(finder.find).to eq(expected_results)

data/spec/colour_alphabet_result_spec.rb

@@ -8,7 +8,7 @@ describe ABCing::ColourAlphabetResult do
     }
 
     result = ABCing::ColourAlphabetResult.new(params).calculate
-    expect(result).to include(A: :green, B: :green)
+    expect(result).to include('A' => :green, 'B' => :green)
   end
 
   it 'does not find a test for a class letter' do
@@ -18,7 +18,7 @@ describe ABCing::ColourAlphabetResult do
     }
 
     result = ABCing::ColourAlphabetResult.new(params).calculate
-    expect(result).to include(A: :green, B: :red)
+    expect(result).to include('A' => :green, 'B' => :red)
   end
 
   it 'does not find an application class or test class from the letter of the alphabet' do
@@ -28,7 +28,7 @@ describe ABCing::ColourAlphabetResult do
     }
 
     result = ABCing::ColourAlphabetResult.new(params).calculate
-    expect(result).to include(A: :yellow, B: :yellow)
+    expect(result).to include('A' => :yellow, 'B' => :yellow)
   end
 
 

data/spec/{scan_result_spec.rb → scanner_spec.rb}

@@ -5,4 +5,10 @@ describe ABCing::Scanner do
     params = { app_directories: [], test_directories: [] }
     scanner = ABCing::Scanner.new(params)
   end
+
+  context 'Raises an error' do
+    it 'when supplied with nil params' do
+      expect { ABCing::Scanner.new(nil) }.to raise_error()
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abcing
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Emile
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-22 00:00:00.000000000 Z
+date: 2015-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
-description: See coverage by alphabet
+description: Find classes mentioned in your application but not in your test suite.
 email:
 - emile.swarts123@gmail.com
 executables:
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -82,8 +83,8 @@ files:
 - spec/class_name_finder_spec.rb
 - spec/colour_alphabet_result_spec.rb
 - spec/renderer_spec.rb
-- spec/scan_result_spec.rb
-homepage: ''
+- spec/scanner_spec.rb
+homepage: https://github.com/emileswarts/ABCing
 licenses:
 - MIT
 metadata: {}
@@ -106,11 +107,11 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Dumb code metrics
+summary: Idiot code metrics
 test_files:
 - spec/alphabet_match_spec.rb
 - spec/class_file_finder_spec.rb
 - spec/class_name_finder_spec.rb
 - spec/colour_alphabet_result_spec.rb
 - spec/renderer_spec.rb
-- spec/scan_result_spec.rb
+- spec/scanner_spec.rb