m-spec 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6420629e2b27b246efaca92e6ad572603eaaf05bfaf716b0d386cadebafab8f9
-  data.tar.gz: 33e8d052ef1d6513a06e9048ac12ce95c51b1597c3ef7246b4d360619b304cab
+  metadata.gz: 1dcf77e4015cb8bb7c3a1e9c0bdba696607e9b5e1c194498cb260373e7038921
+  data.tar.gz: 81821b568580532c5b5c4cf18b457f947185a83932d4b9359b57b3e85c211502
 SHA512:
-  metadata.gz: f9484c58fa989d6dea4c2a94abed38d2d769b04c663c3206588961d41858f3ae1c2afda4cfac94b515c9364191131b96913d335d1379765f8af495ec6da9ddba
-  data.tar.gz: 21ba3b262a018015878cac2b140acbde0e46ad6e916cb17de44e1a25ea4861d49478d67cd05050d354c96ac180647110b3a9937e452c86319cc3098c5ab24255
+  metadata.gz: 4638a25c2f039e6bbb4a550db34a1b228414e30037209b50ea273e7173717eed1e931f5bc58bffd888041e0f6a84b54d46fc770bcd970f8ca98c9a150f7af72b
+  data.tar.gz: f1ede96eae952c17fb581b02741cadf44ea619bb0dade5a69f0b27133f482a1642cf8c3e22fee17c2ff8fac7cc7b4aa3172e8b3d0060d6ab3e036d3eefd9012f

data/.rubocop.yml

@@ -0,0 +1,12 @@
+#    _____               ____ ____        __     _         __
+#   / ___/ _____ ____ _ / __// __/____   / /    (_)____   / /_
+#   \__ \ / ___// __ `// /_ / /_ / __ \ / /    / // __ \ / __/
+#  ___/ // /__ / /_/ // __// __// /_/ // /___ / // / / // /_
+# /____/ \___/ \__,_//_/  /_/ 1 \____//_____//_//_/ /_/ \__/
+#
+# The linter file that doesn't lead junior developers to bad habits.
+# https://github.com/makersacademy/scaffolint
+#
+# Configure Rubocop to use the config file in the Scaffolint GitHub repo
+inherit_from:
+  - https://raw.githubusercontent.com/makersacademy/scaffolint/v1.1.0/.rubocop.yml

data/README.md

@@ -73,6 +73,17 @@ It's got simple one-level indentation, simple colour coding for test passes and
 
 Remember - you'll have to manage yourself: test setup and teardown, keeping test code dry, each test running in isolation, and loading source code properly.
 
+## Rubocop
+
+M-spec comes with rubocop by default, using this [set of rules](https://github.com/makersacademy/scaffolint). To configure your test suite to disable rubocop or to only run rubcop, add an optional configuration file named `.m-spec` to your project root where you run your specs from. You don't need the configuration file - by default your specs will run first, followed by rubocop.
+
+You can add either of two options
+- `--no-rubocop` which will ignore running rubocop
+- `--only-rubocop` which will ignore running your tests
+
+See [rubocop documentation](https://docs.rubocop.org/rubocop/index.html) for more info - you might be interested in reading about rubocop's autocorrect command.
+
+
 ## Extending
 
 After checking out the repo

data/exe/m-spec

@@ -1,5 +1,29 @@
 #!/usr/bin/env ruby
 require 'm-spec'
 
-spec_file = ARGV[0]
-require spec_file
+def run_rubocop!
+  config = "$GEM_HOME/gems/m-spec-#{Mspec::VERSION}/.rubocop.yml"
+  system("bundle exec rubocop --config #{config}")
+end
+
+def run_specs!
+  spec_file = ARGV[0]
+  require spec_file
+end
+
+if File.exists?('./.m-spec')
+  File.open('./.m-spec', 'r') do |file|
+    options = file.read.split
+    if options.include?('--only-rubocop')
+      run_rubocop!
+    elsif options.include?('--no-rubocop')
+      run_specs!
+    else
+      run_specs!
+      run_rubocop!
+    end
+  end
+else
+  run_specs!
+  run_rubocop!
+end

data/lib/m-spec/version.rb

@@ -1,3 +1,3 @@
 module Mspec
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/m-spec.gemspec

@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "rubocop", "~> 0.79.0"
+
   spec.add_development_dependency "bundler", "~> 2.1"
   spec.add_development_dependency "rake", ">= 12.3.3"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: m-spec
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Edward Withers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-29 00:00:00.000000000 Z
+date: 2020-08-05 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -48,6 +62,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt