has_specs 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e4300b0ef1cf4c4ff685d2b49807ab219abf9ae
-  data.tar.gz: 780c7d39f9bad58b41905d4db5dadef11643b366
+  metadata.gz: b7244d52d20052ab4d49023602e6901fc565bc68
+  data.tar.gz: b1653f3a9cb6a735fe46a6dabb52da5a581e74bc
 SHA512:
-  metadata.gz: ad60197f332cce3f8af8ccb55f9256809b46ec09e32c5d2a8f816b97a5241899a0bf456bea8b651a866d460f0536c6a291711ba9ed209835cb4802c00d421829
-  data.tar.gz: 4551b235fb45623facd7bacd8a4f808c7cc8f1c8fc616d862b90ac688b145c4883e238f3edfd1ed7c739db60e7d18448f5c9d76cee51db6000e67442595f49cd
+  metadata.gz: 3c402f08a49c4eba71b74a07fba2bc2543c854f7b2b44068623936f7faafd63eb55eefe0d26867543e47f1e60929dfc2ec508202cd282febcbe31a7222d10689
+  data.tar.gz: 1fd07a9c48ceec0bfd5b5bb72cbbcf0239913ab9da891767345bd66151319dbd43ce4b9f80c9b9f0204fb981cc23908429cfbece035f99ee8e40f3bf7294da27

data/.travis.yml

@@ -0,0 +1,7 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - 2.1.2
+install: bundle
+script: "bundle exec rspec"

data/README.md

@@ -1,6 +1,12 @@
 # HasSpecs
 
-Very basic gem that allows you to verify that every file in your project has a matching spec file. 
+[![Build Status](https://travis-ci.org/grossadamm/has_specs.svg?branch=master)](https://travis-ci.org/grossadamm/has_specs)
+
+Very basic gem that allows you to verify that every file in your project has a matching spec or test file.
+
+It expects that the folder structure of the root directory and spec directory be identical, so it's fairly limited in the fact that it doesn't look at rails route or lib tests.
+
+It was built with rspec in mind, but I don't see why it couldn't be repurposed for other test harnesses.
 
 ## Installation
 
@@ -19,13 +25,12 @@ Or install it yourself as:
 ## Usage
 
 ```
-  # spec_helper.rb
+  # spec_helper.rb (or rails_helper.rb)
 
   require 'has_specs'
-  
-  # ...
 
-  HasSpecs.configuration.use_rails_defaults
+  # ... in the config block
+
   HasSpecs.ignore << 'application_controller.rb'
   HasSpecs.verify
 ```
@@ -33,7 +38,6 @@ Or install it yourself as:
 #### Configuration
 
 ```
-configuration.use_rails_defaults # sets up to use app/ as the root amoungst other things
 configuration.ignore << 'some_file_to_ignore.rb'
 configuration.exclude << 'some/whole/dir/to/exclude.rb'
 configuration.include << 'some/whole/dir/to/optionally/include'
@@ -42,6 +46,7 @@ configuration.root = 'some/other/root/for/source/files'
 configuration.spec_root = 'some/other/root/for/tests'
 ```
 
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/has_specs/fork )

data/lib/has_specs/base.rb

@@ -1,17 +1,21 @@
 module HasSpecs
   class Base
     def self.verify(config)
+      missing = []
       config.include.each do |directory|
-        lookat = File.join(config.root, directory,"*"+config.extension)
+        lookat = File.join(config.root, directory,"*[("+config.extension.join(')(')+')]')
         Dir.glob(lookat).each do |file|
           spec_dir = File.dirname(file).gsub(config.root, config.spec_root)
-          basename =  File.basename file, config.extension
-          spec_file = File.join(spec_dir,basename+config.suffix+config.extension)
+          extension = File.extname(file)
+          basename =  File.basename(file).chomp(extension)
+          spec = config.to_spec_filename(file)
+          spec_file = File.join(spec_dir,spec)
           unless config.ignore.include?(File.basename file) || File.exist?(spec_file)
-            raise MatchingSpecFileDoesNotExist, "#{spec_file} does not exist for #{file}"
+            missing.push(spec)
           end
         end
       end
+      return missing
     end
   end
-end
+end

data/lib/has_specs/configuration.rb

@@ -5,7 +5,11 @@ module HasSpecs
     end
 
     def root
-      @root ||= Dir.pwd
+      if defined? Rails
+        @root ||= File.join(::Rails.root,'app')
+      else
+       @root ||= Dir.pwd
+     end
     end
 
     def spec_root=(desired_root)
@@ -16,12 +20,12 @@ module HasSpecs
       @spec_root ||= File.join(Dir.pwd,'spec')
     end
 
-    def exclude=(exclude_dirs)
-      @exclude = exclude_dirs
+    def exclude
+      @exclude ||= ['spec', 'assets']
     end
 
-    def exclude
-      @exclude ||= ['spec']
+    def exclude=(exclude_dirs)
+      @exclude = exclude_dirs
     end
 
     def ignore=(ignore_files)
@@ -41,7 +45,7 @@ module HasSpecs
     end
 
     def extension
-      ".rb"
+      [".rb", ".erb", ".jbuilder"]
     end
 
     def include
@@ -50,17 +54,21 @@ module HasSpecs
         .delete_if do |directory|
           found = false
           self.exclude.each do |excluded|
-            continue if found
+            next if found
             found = directory.start_with?(excluded)
           end
           found
         end
     end
 
-    def use_rails_defaults
-      self.exclude.concat(HasSpecs::RailsDefaults.exclude)
-      self.root = HasSpecs::RailsDefaults.root
-      self.suffix = HasSpecs::RailsDefaults.suffix
+    def to_spec_filename(filename)
+      if File.extname(filename) != '.rb' 
+        filename = filename + suffix + ".rb"
+      else
+        extension = File.extname(filename)
+        basename = File.basename(filename, extension)
+        filename = basename + suffix + extension
+      end
     end
   end
 end

data/lib/has_specs/version.rb

@@ -1,3 +1,3 @@
 module HasSpecs
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/has_specs.rb

@@ -1,14 +1,18 @@
 require "has_specs/version"
 require "has_specs/configuration"
-require 'has_specs/rails_defaults'
 require 'has_specs/base'
 
 module HasSpecs
-  class MatchingSpecFileDoesNotExist < StandardError;   end 
+  class MatchingSpecFileDoesNotExist < StandardError;   end
 
   class << self
     def verify
-      HasSpecs::Base.verify (self.configuration)
+      missing = HasSpecs::Base.verify(self.configuration)
+      if missing != [] 
+        puts "\n######################\nHasSpecs Missing Specs:\n"
+        puts missing.join("\n")
+        puts "\n######################\n\n"
+      end
     end
 
     def configuration

data/spec/base_spec.rb

@@ -1,14 +1,16 @@
 require 'has_specs'
 
 describe HasSpecs do
-  it "throws no exceptions if all files have a matching spec" do
-    HasSpecs.root = File.join(Dir.pwd,'lib','has_specs')
-    HasSpecs.ignore << "version.rb"
-    HasSpecs.verify
+  it "returns an empty array if all files have a matching spec" do
+    config = HasSpecs::Configuration.new
+    config.root = File.join(Dir.pwd,'lib','has_specs')
+    config.ignore << "version.rb"
+    expect(HasSpecs::Base.verify(config)).to eq []
   end
 
-  it "throws an exception if any files are missing a matching spec" do
-    HasSpecs.root = Dir.pwd
-    expect{HasSpecs.verify}.to raise_error
+  it "prints messages if any files are missing a matching spec" do
+    config = HasSpecs::Configuration.new
+    config.root = Dir.pwd
+    expect(HasSpecs::Base.verify(config)).to include 'base_spec.rb'
   end
 end

data/spec/configuration_spec.rb

@@ -24,7 +24,7 @@ describe HasSpecs::Configuration do
   end
 
   it "defaults to excluding the specs dir" do
-    expect(@config.exclude).to eq ['spec']
+    expect(@config.exclude).to eq ['spec', 'assets']
     expect(@config.include).not_to include('spec')
   end
 
@@ -43,26 +43,11 @@ describe HasSpecs::Configuration do
   end
 
   it "has an extension of .rb" do
-    expect(@config.extension).to eq '.rb'
+    expect(@config.extension).to eq ['.rb', '.erb', '.jbuilder']
   end
 
   it "lists included directories" do
     @config.root = Dir.pwd
     expect(@config.include).to include('lib')
   end
-
-  it "can use the rails defaults" do
-    fake_rails_class = Class.new do
-      def self.root
-        'fake_rails_root'
-      end
-    end
-    stub_const("Rails",fake_rails_class)
-
-    @config.use_rails_defaults
-   
-    expect(@config.exclude).to include File.join('assets')
-    expect(@config.root).to include 'app'
-    expect(@config.suffix).to eq '_spec'
-  end    
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: has_specs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Adam Gross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-14 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -68,11 +69,9 @@ files:
 - lib/has_specs.rb
 - lib/has_specs/base.rb
 - lib/has_specs/configuration.rb
-- lib/has_specs/rails_defaults.rb
 - lib/has_specs/version.rb
 - spec/base_spec.rb
 - spec/configuration_spec.rb
-- spec/rails_defaults_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -100,4 +99,3 @@ summary: Validates that each file has a corresponding spec.
 test_files:
 - spec/base_spec.rb
 - spec/configuration_spec.rb
-- spec/rails_defaults_spec.rb

data/lib/has_specs/rails_defaults.rb

@@ -1,18 +0,0 @@
-module HasSpecs
-  class RailsDefaults
-    def self.exclude
-      (@exclude ||= []) << 'assets'
-    end
-
-    def self.root
-      unless defined? Rails
-        raise ArgumentError, "Rails not defined"
-      end
-      File.join(::Rails.root,'app')
-    end
-
-    def self.suffix
-      "_spec"
-    end
-  end
-end

data/spec/rails_defaults_spec.rb

@@ -1,11 +0,0 @@
-require 'has_specs'
-
-describe HasSpecs::RailsDefaults do
-  it "defaults to excluding the assets dir" do
-    expect(HasSpecs::RailsDefaults.exclude).to include 'assets'
-  end
-
-  it "defaults to using _spec as the suffix" do
-    expect(HasSpecs::RailsDefaults.suffix).to eq '_spec'
-  end
-end