jefferies_tube 1.5.4 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ddb970be7c5d3d44e2df2171455ce27685435dd61330cb692002097271496d1
-  data.tar.gz: 6b8a796088c566761a11a8b1f2ec5214884eed1d9c51159d0aca7f11a55b872d
+  metadata.gz: 716c0ff79c3d49dc0a798f652893f52f2da6b8db643b21b84c76dbe1e56c765f
+  data.tar.gz: 79f241ab6a97ebfc27fa2c4fbf070927fb4a2f960317532e11fbf80b1128e350
 SHA512:
-  metadata.gz: fa431cb07c4d1abf50390ac2e65879c1e6a8cb57dfa711bc02f46ba389d7e7d58631faebb217c5ca919db5136d63e0ba0ae0ff115f90760ae46cc4f0c0243fb4
-  data.tar.gz: 313293998aaaecaf4e0d94f0c1437ae50f3369ee8a3db6d2220a8cc7c0aeb80040bf38bf5aeb055e5530ea5fa2ba2b40443b399138671238f5161da6d039cd20
+  metadata.gz: 84f5131653cd0887fe715cdd4d9f113468aa3c4da74b37b3b3bd127ad56b34dbb88ebd09421034cbc3f066578dbdbdc14af9c9a9646418b79fdf45e8d1162611
+  data.tar.gz: 103babd618aa140b2f6dfd1c7e21f30e42ea4b9613d5dc2d9db4f4d693b0e4e15a501c0cb742a57e45ae07d9b8aa4596406efc501c5320b4535a1ea56c1940a9

data/.ruby-version

@@ -1 +1 @@
-3.1.0
+3.1.1

data/CHANGELOG.md

@@ -6,6 +6,8 @@ This project attempts to follow [semantic versioning](https://semver.org/)
 
 ## Unreleased
 
+## 1.6.0
+  Default rake task that runs rspec with simlecov and rubocop!
 ## 1.5.4
   Fix a bug in the prompt if Pry is present.
 ## 1.5.3

data/README.md

@@ -26,7 +26,7 @@ Or install it yourself as:
 
 JefferiesTube by default installs a catchall route that will render 404 for you and supress the rollbar error.  This also allows you to create super easy custom error pages.
 
-Simple put a template in the parent app in `app/views/errors/404.haml` (or html or erb, etc) and it will be rendered instead of the default Jefferies tube error.
+Simple put a template in the parent app in `app/views/errors/404.haml` (or html or erb, etc) and it will be rendered instead of the default JefferiesTube error.
 
 #### 500 handling
 
@@ -182,6 +182,47 @@ JefferiesTube.configure do |config|
 end
 ```
 
+### Default Rake Tasks
+JefferiesTube sets up the default rake task to run rspec with simplecov, then rubocop. Everything should be configued to the default automatically. All you need to do is run `rake`!
+
+### Simplecov
+JefferiesTube configures Simplecov to check for coverage based solely on groups, not on the overall project. This is to ensure that important/easy files are covered and unimportant files can be untested without causing the total percentage to go down. If you override the required test coverage, warnings will show if you do not match the JefferiesTube default. The default required test coverage is as follows:
+
+```
+'Controllers' => 10,
+'API Controllers' => 100,
+'Models' => 100,
+'Services' => 100,
+'Helpers' => 10,
+'Policies' => 100,
+'Jobs' => 100,
+'Mailers' => 0,
+'Libraries' => 0,
+'Plugins' => 0,
+'Ungrouped' => 10
+```
+
+and can be overrided by setting `JefferiesTube::Coverage.required_coverage` in an initializer.
+
+```
+JefferiesTube::Coverage.required_coverage = {
+  'Controllers' => 0,
+  'API Controllers' => 0,
+  'Models' => 0,
+  'Services' => 0,
+  'Helpers' => 0,
+  'Policies' => 0,
+  'Jobs' => 0,
+  'Mailers' => 0,
+  'Libraries' => 0,
+  'Plugins' => 0,
+  'Ungrouped' => 0
+}
+```
+
+## Rubocop
+Our Rubocop rules are built from the ground up to ensure the rules are all "actually good"! The first time you run `rake` JT will create a .rubocop.yml configuration file that inherits all the rules from JT. You can add/modify that file if you need to customize the rules for your project.
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/jefferies_tube/fork )

data/default.yml

@@ -0,0 +1,5 @@
+AllCops:
+  DisabledByDefault: true
+  SuggestExtensions: false
+Layout/LineLength:
+  Max: 200

data/jefferies_tube.gemspec

@@ -26,4 +26,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "bundler-audit", '~> 0.9.0'
   spec.add_dependency "pry", '~> 0.13'
+  spec.add_dependency 'rubocop', '~> 1.26'
+  spec.add_dependency 'simplecov'
 end

data/lib/jefferies_tube/config/rubocop_default.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  jefferies_tube:
+    - default.yml

data/lib/jefferies_tube/config/simplecov.rb

@@ -0,0 +1,68 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/test/'
+  add_filter '/config/'
+
+  add_group 'Controllers' do |src_file|
+    src_file.filename.include?('app/controllers') && !src_file.filename.include?('api')
+  end
+  add_group 'API Controllers' do |src_file|
+    src_file.filename.include?('app/controllers') && src_file.filename.include?('api')
+  end
+  add_group 'Models', 'app/models'
+  add_group 'Services', 'app/services'
+  add_group 'Helpers', 'app/helpers'
+  add_group 'Policies', 'app/policies'
+  add_group 'Jobs', 'app/jobs'
+  add_group 'Mailers', 'app/mailers'
+  add_group 'Libraries', 'lib'
+  add_group 'Plugins', 'vendor/plugins'
+end
+SimpleCov.at_exit do
+  ideal_coverage = {
+    'Controllers' => 10,
+    'API Controllers' => 100,
+    'Models' => 100,
+    'Services' => 100,
+    'Helpers' => 10,
+    'Policies' => 100,
+    'Jobs' => 100,
+    'Mailers' => 0,
+    'Libraries' => 0,
+    'Plugins' => 0,
+    'Ungrouped' => 10
+  }
+  required_coverage = JefferiesTube::Coverage.required_coverage
+  overall_failed = false
+  output = "=====================Test Coverage=====================\n"
+  output << "Group            Files       Current / Required (Ideal)\n"
+  SimpleCov.result.groups.each do |name, group|
+    next if group.size.zero?
+    failed = false
+    warning = false
+    if group.covered_percent.round(2) < ideal_coverage[name]
+      warning = true
+    end
+    if group.covered_percent.round(2) < required_coverage[name]
+      warning = false
+      failed = true
+      overall_failed = true
+    end
+    color = if failed
+      "\e[31m"
+    elsif warning
+      "\e[33m"
+    else
+      "\e[32m"
+    end
+    files = "Files: #{group.size}".ljust(11)
+    current = "#{group.covered_percent.round(2)}%".ljust(7)
+    required = "#{required_coverage[name]}%".ljust(8)
+    output << "#{color}#{name.ljust(16)} #{files} #{current} / #{required} (#{ideal_coverage[name]}%)\e[0m\n"
+  end
+  output += "\n"
+  puts output
+  if overall_failed
+    exit(SimpleCov::ExitCodes::MINIMUM_COVERAGE)
+  end
+end

data/lib/jefferies_tube/coverage.rb

@@ -0,0 +1,25 @@
+module JefferiesTube::Coverage
+  def self.default_converage
+    {
+      'Controllers' => 10,
+      'API Controllers' => 100,
+      'Models' => 100,
+      'Services' => 100,
+      'Helpers' => 10,
+      'Policies' => 100,
+      'Jobs' => 100,
+      'Mailers' => 0,
+      'Libraries' => 0,
+      'Plugins' => 0,
+      'Ungrouped' => 10
+    }
+  end
+
+  def self.required_coverage=(hash)
+    @required_coverage = hash
+  end
+
+  def self.required_coverage
+    self.default_converage.merge(@required_coverage || {})
+  end
+end

data/lib/jefferies_tube/railtie.rb

@@ -1,5 +1,6 @@
 require 'jefferies_tube'
 require 'jefferies_tube/console'
+require 'jefferies_tube/coverage'
 require 'rails'
 
 module JefferiesTube
@@ -67,5 +68,29 @@ module JefferiesTube
         end
       end
     end
+
+    initializer "create default rubocop config if missing" do |config|
+      default_rubocop = File.join(File.dirname(__FILE__), "config", "rubocop_default.yml")
+      rubocop_path = ::Rails.root.join ".rubocop.yml"
+      if !File.file?(rubocop_path)
+        FileUtils::cp(default_rubocop, rubocop_path)
+      end
+    end
+
+    initializer 'load simplecov for tests' do |config|
+      if ::Rails.env.test?
+        simplecov_config = 'config/simplecov.rb'
+        require_relative simplecov_config
+      end
+    end
+
+    rake_tasks do
+      Rake.application['default'].clear
+      task default: :spec
+      require 'rubocop/rake_task'
+
+      RuboCop::RakeTask.new(:rubocop)
+      task default: :rubocop
+    end
   end
 end

data/lib/jefferies_tube/version.rb

@@ -1,7 +1,7 @@
 require 'open-uri'
 
 module JefferiesTube
-  VERSION = "1.5.4"
+  VERSION = "1.6.0"
 
   def self.latest_rubygems_version
     JSON.parse(URI.parse("https://rubygems.org/api/v1/versions/jefferies_tube/latest.json").read)["version"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jefferies_tube
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.6.0
 platform: ruby
 authors:
 - Brian Samson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -108,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.26'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Useful tools for Rails.
 email:
 - brian@tenforwardconsulting.com
@@ -132,6 +160,7 @@ files:
 - app/views/errors/404.json.jbuilder
 - app/views/errors/404.xml
 - app/views/errors/500.haml
+- default.yml
 - jefferies_tube.gemspec
 - lib/jefferies_tube.rb
 - lib/jefferies_tube/access_token.rb
@@ -143,7 +172,10 @@ files:
 - lib/jefferies_tube/capistrano/rails.rb
 - lib/jefferies_tube/capistrano/s3_assets.rb
 - lib/jefferies_tube/capistrano/ssh.rb
+- lib/jefferies_tube/config/rubocop_default.yml
+- lib/jefferies_tube/config/simplecov.rb
 - lib/jefferies_tube/console.rb
+- lib/jefferies_tube/coverage.rb
 - lib/jefferies_tube/custom_prompts.irbrc.rb
 - lib/jefferies_tube/database_backup.rb
 - lib/jefferies_tube/database_backup_adapter.rb
@@ -176,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: Ten Forward Consulting useful tools.