minitest-flog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 47f3bbf4f167da612be5dd39f6bff7ccdff80435
+  data.tar.gz: 43716da3ccac152b7b010078a09a9619801862d5
+SHA512:
+  metadata.gz: 97a926d9693c36d87142039608038a8399e3d64d3e16767a6b0bae85eb3a65d673e96a7ab868780a42057e3bf9a07c8f32b70a31646424b58787db1fa8f53cf4
+  data.tar.gz: 67ea644b62ffcf6fdcb8d4cc1d38e9c4b98559df8d752d4f298484d873d94efc159d004b5ea397e5ce0adef0b062cc27613f9fd1c2e30cc88736bbab1358f9b9

data/.gitignore

@@ -0,0 +1,11 @@
+*~
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/bundle/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Kottom
+
+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,94 @@
+# minitest-flog
+
+Beat your code, see where it bleeds.
+
+Flog analyzes Ruby code for signs of complexity and produces a numeric score
+for each method and class in every file it scans.  A higher score is indicative
+of more complex constructs and therefore refactoring opportunities.
+
+This gem integrates Flog directly into your project's test suite so that you're
+automatically alerted to any additions or updates that will lead to pain down
+the line.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minitest-flog'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-flog
+
+You'll need to require the library in your test helper:
+
+```ruby
+require "minitest/flog"
+```
+
+## Usage
+
+minitest-flog introduces a new Minitest::Flog::Test class that you'll
+use to make any assertions about complexity in your project.
+
+Create a new test by subclassing Minitest::Flog::Test.  You can then make
+assertions about the Flog scoring you expect to calculate for code in selected
+directories in your project.  The example below has two assertions:
+
+* No method should have a score over 100.0.
+* 95% of all methods should have scores less than or equal to 40.0.
+
+```ruby
+class MyProjectFlogger < Minitest::Test
+  def flog_lib
+    assert_method_score("lib", score: 100.0)
+	assert_method_score("lib", score: 40.0, ratio: 0.95)
+  end
+end
+```
+
+Invoking your tests with the `-f` or `--flog` option will turn on extended
+Flog-like reporting in case of a failure.
+
+## To-Dos
+
+* Implement Minitest::Spec compatibility
+* Threadsafe access to class variables
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/minitest-flog/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
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Chris Kottom
+
+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/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "minitest/flog"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/minitest/flog.rb

@@ -0,0 +1,12 @@
+require "minitest/flog/assertions"
+require "minitest/flog/reporter"
+require "minitest/flog/test"
+require "minitest/flog/version"
+
+module Minitest
+  module Flog
+    def self.flogs
+      @flogs ||= {}
+    end
+  end
+end

data/lib/minitest/flog/assertions.rb

@@ -0,0 +1,57 @@
+require "flog_cli"
+
+module Minitest
+  module Flog
+    module Assertions
+      DEFAULT_FLOG_OPTIONS   = { all: true, continue: true }
+      DEFAULT_METHOD_OPTIONS = { score: 40.0, ratio: 1.0 }
+
+      attr_accessor   :filtered, :dir, :threshold
+
+      def assert_method_score(dir, options = {})
+        options = DEFAULT_METHOD_OPTIONS.merge options
+        self.dir = dir
+        self.threshold = options[:score]
+
+        scores = _flog_scores_for_directory(dir)
+        self.filtered = scores.select { |method, score| score > options[:score] }
+
+        score_count = scores.count.to_f.round(2)
+        filtered_count = self.filtered.count.to_f.round(2)
+        msg = options[:msg] || message(options[:score], options[:ratio],
+                                       1.0 - (filtered_count / score_count))
+        assert (filtered_count / score_count) <= (1.0 - options[:ratio]), msg
+      end
+
+      def _flog_scores_for_directory(dir)
+        flog = flog_for(dir)
+        scores = {}
+        flog.each_by_score do |method, score, list|
+          scores[method] = score
+        end
+        scores
+      end
+
+      private
+
+      def flog_for(dir)
+        hash = FlogCLI.expand_dirs_to_files(dir).hash
+
+        unless flog = Minitest::Flog.flogs[hash]
+          flog = FlogCLI.new DEFAULT_FLOG_OPTIONS
+          result = flog.flog dir
+          Minitest::Flog.flogs[hash] = flog
+          self.flog = flog
+        end
+        flog
+      end
+
+      def message(score, expected_ratio, actual_ratio)
+        expected_percent = sprintf("%.1f", expected_ratio * 100)
+        actual_percent = sprintf("%.1f", actual_ratio * 100)
+        "Expected #{ expected_percent }% of flogged methods to have " +
+          "score < #{ score } (actual: #{ actual_percent }%)"
+      end
+    end
+  end
+end

data/lib/minitest/flog/reporter.rb

@@ -0,0 +1,30 @@
+require "minitest"
+
+module Minitest
+  module Flog
+    class Reporter < Minitest::Reporter
+      attr_accessor  :failed_flogs
+
+      def initialize(io = $stdout, options = {})
+        super
+        self.failed_flogs = []
+      end
+
+      def record(result)
+        if result.is_a?(Minitest::Flog::Test) && result.failure
+          self.failed_flogs << result
+        end
+      end
+
+      def report
+        return unless self.options[:flog] && self.failed_flogs.any?
+
+        result = "\nFlog reporting"
+        failed_flogs.each do |f|
+          result << f.detail_report
+        end
+        self.io.print result
+      end
+    end
+  end
+end

data/lib/minitest/flog/test.rb

@@ -0,0 +1,23 @@
+module Minitest
+  module Flog
+    class Test < ::Minitest::Test
+      include Assertions
+
+      attr_accessor  :flog
+
+      def self.runnable_methods
+        methods_matching(/^flog_/)
+      end
+
+      def detail_report
+        path = File.expand_path(self.dir)
+        result = "\n  #{ path }:\n"
+        flog.each_by_score do |method, score, list|
+          break if score < self.threshold
+          result << sprintf("  %8.1f  %s\n", score, method)
+        end
+        result
+      end
+    end
+  end
+end

data/lib/minitest/flog/version.rb

@@ -0,0 +1,5 @@
+module Minitest
+  module Flog
+    VERSION = "0.1.0"
+  end
+end

data/lib/minitest/flog_plugin.rb

@@ -0,0 +1,16 @@
+require "minitest"
+require "flog"
+
+module Minitest
+  def self.plugin_flog_options(opts, options)
+    opts.on "-f", "--flog", "Display a detailed Flog report output" do |f|
+      options[:flog] = true
+    end
+  end
+
+  def self.plugin_flog_init(options)
+    if options[:flog]
+      self.reporter << Minitest::Flog::Reporter.new(options[:io], options)
+    end
+  end
+end

data/minitest-flog.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minitest/flog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-flog"
+  spec.version       = Minitest::Flog::VERSION
+  spec.authors       = ["Chris Kottom"]
+  spec.email         = ["chris@chriskottom.com"]
+
+  spec.summary       = %q{Flog integration for Minitest}
+  spec.description   = %q{Uses Flog to test code complexity during testing}
+  spec.homepage      = "https://github.com/chriskottom/minitest-flog"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "minitest", "~> 5.5"
+  spec.add_dependency "flog", "~> 4.3"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: minitest-flog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Kottom
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Uses Flog to test code complexity during testing
+email:
+- chris@chriskottom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/minitest/flog.rb
+- lib/minitest/flog/assertions.rb
+- lib/minitest/flog/reporter.rb
+- lib/minitest/flog/test.rb
+- lib/minitest/flog/version.rb
+- lib/minitest/flog_plugin.rb
+- minitest-flog.gemspec
+homepage: https://github.com/chriskottom/minitest-flog
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Flog integration for Minitest
+test_files: []