has_specs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8e4300b0ef1cf4c4ff685d2b49807ab219abf9ae
+  data.tar.gz: 780c7d39f9bad58b41905d4db5dadef11643b366
+SHA512:
+  metadata.gz: ad60197f332cce3f8af8ccb55f9256809b46ec09e32c5d2a8f816b97a5241899a0bf456bea8b651a866d460f0536c6a291711ba9ed209835cb4802c00d421829
+  data.tar.gz: 4551b235fb45623facd7bacd8a4f808c7cc8f1c8fc616d862b90ac688b145c4883e238f3edfd1ed7c739db60e7d18448f5c9d76cee51db6000e67442595f49cd

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+**/.DS_Store
+mkmf.log
+has_specs.sublime-project
+has_specs.sublime-workspace

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in has_specs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Adam Gross
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,51 @@
+# HasSpecs
+
+Very basic gem that allows you to verify that every file in your project has a matching spec file. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'has_specs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install has_specs
+
+## Usage
+
+```
+  # spec_helper.rb
+
+  require 'has_specs'
+  
+  # ...
+
+  HasSpecs.configuration.use_rails_defaults
+  HasSpecs.ignore << 'application_controller.rb'
+  HasSpecs.verify
+```
+
+#### 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'
+configuration.suffix << '_spec'
+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 )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/has_specs.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'has_specs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "has_specs"
+  spec.version       = HasSpecs::VERSION
+  spec.authors       = ["Adam Gross"]
+  spec.email         = ["gross.adamm@gmail.com"]
+  spec.summary       = %q{Validates that each file has a corresponding spec.}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake"
+end

data/lib/has_specs/base.rb

@@ -0,0 +1,17 @@
+module HasSpecs
+  class Base
+    def self.verify(config)
+      config.include.each do |directory|
+        lookat = File.join(config.root, directory,"*"+config.extension)
+        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)
+          unless config.ignore.include?(File.basename file) || File.exist?(spec_file)
+            raise MatchingSpecFileDoesNotExist, "#{spec_file} does not exist for #{file}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/has_specs/configuration.rb

@@ -0,0 +1,66 @@
+module HasSpecs
+  class Configuration
+    def root=(desired_root)
+      @root = desired_root
+    end
+
+    def root
+      @root ||= Dir.pwd
+    end
+
+    def spec_root=(desired_root)
+      @spec_root = desired_root
+    end
+
+    def spec_root
+      @spec_root ||= File.join(Dir.pwd,'spec')
+    end
+
+    def exclude=(exclude_dirs)
+      @exclude = exclude_dirs
+    end
+
+    def exclude
+      @exclude ||= ['spec']
+    end
+
+    def ignore=(ignore_files)
+      @ignore = ignore_files
+    end
+
+    def ignore
+      @ignore ||= []
+    end
+
+    def suffix=(suffix)
+      @suffix = suffix
+    end
+
+    def suffix
+      @suffix ||= '_spec'
+    end
+
+    def extension
+      ".rb"
+    end
+
+    def include
+      Dir.glob(File.join(self.root,'**/*/'))
+        .map!{|d| d.gsub(@root, '').sub(File::SEPARATOR,'').chomp(File::SEPARATOR) }
+        .delete_if do |directory|
+          found = false
+          self.exclude.each do |excluded|
+            continue 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
+    end
+  end
+end

data/lib/has_specs/rails_defaults.rb

@@ -0,0 +1,18 @@
+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/lib/has_specs/version.rb

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

data/lib/has_specs.rb

@@ -0,0 +1,66 @@
+require "has_specs/version"
+require "has_specs/configuration"
+require 'has_specs/rails_defaults'
+require 'has_specs/base'
+
+module HasSpecs
+  class MatchingSpecFileDoesNotExist < StandardError;   end 
+
+  class << self
+    def verify
+      HasSpecs::Base.verify (self.configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def root=(root)
+      self.configuration.root=root
+    end
+
+    def root
+      self.configuration.root
+    end
+
+    def spec_root=(spec_root)
+      self.configuration.spec_root=spec_root
+    end
+
+    def spec_root
+      self.configuration.spec_root
+    end
+
+    def exclude=(exclude)
+      self.configuration.exclude=exclude
+    end
+
+    def exclude
+      self.configuration.exclude
+    end
+
+    def ignore=(ignore)
+      self.configuration.ignore=ignore
+    end
+
+    def ignore
+      self.configuration.ignore
+    end
+
+    def suffix=(suffix)
+      self.configuration.suffix=suffix
+    end
+
+    def suffix
+      self.configuration.suffix
+    end
+
+    def extension
+      self.configuration.extension
+    end
+
+    def included
+      self.configuration.included
+    end
+  end
+end

data/spec/base_spec.rb

@@ -0,0 +1,14 @@
+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
+  end
+
+  it "throws an exception if any files are missing a matching spec" do
+    HasSpecs.root = Dir.pwd
+    expect{HasSpecs.verify}.to raise_error
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,68 @@
+require 'has_specs'
+
+describe HasSpecs::Configuration do
+  before(:each) do
+    @config = HasSpecs::Configuration.new
+  end
+
+  it "defaults the root to the current dir" do
+    expect(@config.root).to eq Dir.pwd
+  end
+
+  it "sets a new root" do
+    @config.root = 'somedir'
+    expect(@config.root).to eq 'somedir'
+  end
+
+  it "defaults the spec root to the current dirs specs dir " do
+    expect(@config.spec_root).to eq File.join(Dir.pwd,'spec')
+  end
+
+  it "sets a new spec root" do
+    @config.spec_root = 'somedir'
+    expect(@config.spec_root).to eq 'somedir'
+  end
+
+  it "defaults to excluding the specs dir" do
+    expect(@config.exclude).to eq ['spec']
+    expect(@config.include).not_to include('spec')
+  end
+
+  it "sets new exclusion dirs" do
+    @config.exclude = ['somedir']
+    expect(@config.exclude).to eq ['somedir']
+  end
+
+  it "defaults to using _spec as the suffix" do
+    expect(@config.suffix).to eq '_spec'
+  end
+
+  it "sets new suffix" do
+    @config.suffix = '_somesuffix'
+    expect(@config.suffix).to eq '_somesuffix'
+  end
+
+  it "has an extension of .rb" do
+    expect(@config.extension).to eq '.rb'
+  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

data/spec/rails_defaults_spec.rb

@@ -0,0 +1,11 @@
+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

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: has_specs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Gross
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- gross.adamm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- has_specs.gemspec
+- 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
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Validates that each file has a corresponding spec.
+test_files:
+- spec/base_spec.rb
+- spec/configuration_spec.rb
+- spec/rails_defaults_spec.rb