minitest-metz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 765abed06e6131561c6fe86e6707efb7d6f954e5
+  data.tar.gz: 301ff1aa8dd6f203f71f2dbe271cd2151ac2f97c
+SHA512:
+  metadata.gz: 5d3a0314b9bde3e44bac776e106dfb47a26e5b38e5ffff5e6412978369a614d70a69cdfe729fa7af24eb4808ca38b537fc2ed196a9b6b5b8c8fe731c0ada76ba
+  data.tar.gz: 912f0756dfb7c1f691e889fe5cdfd870c0ce5bea73875ff106205a92baaf8eb3630610af12882140b7ae6229ed6ca528e386126628cd577600093ee2b2afef4f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/README.md

@@ -0,0 +1,86 @@
+# Minitest::Metz
+
+Minitest::Metz is a Minitest plugin that under it's hood hides the [SandiMeter](https://github.com/makaroni4/sandi_meter).
+It allows you to easily apply Sandi Metz's [four rules for developers](https://robots.thoughtbot.com/sandi-metz-rules-for-developers)
+on your tests.
+
+## Why?
+
+Because tests are code. Especially in Minitest, where each test file is a subclass
+of `Minitest::Test`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minitest-metz'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minitest-metz
+
+## Usage
+
+There two ways that you can use this plugin:
+
+### `--metz`
+
+You can apply the `--metz` flag when you are running your tests. If present, the
+plugin will run the `sandi_meter` for the test that ran.
+
+### `assert_obey_metz`
+
+If you are willing of writing tests around the four rules, you can assert on
+them. The assertions works on basically any type of class, whether it is a test
+class or a production class. If you want to test the test class for the four
+rules:
+
+```ruby
+class PersonTest < Minitest::Test
+  def test_sandi_four_rules
+    assert_obey_metz(self.class)
+    # Or..
+    assert_obey_metz(PersonTest)
+  end
+end
+```
+
+If you want to test another class:
+
+```ruby
+class PersonTest < Minitest::Test
+  def test_sandi_four_rules
+    assert_obey_metz(Person)
+  end
+end
+```
+
+Also, there's the option on asserting on a file path:
+
+```ruby
+class PersonTest < Minitest::Test
+  def test_sandi_four_rules
+    assert_obey_metz("lib/person/person.rb")
+  end
+end
+```
+
+And, of course, you can use `refute_obey_metz`, although I have no idea why
+would you. But anyway, it's available for use. Have fun.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fteem/minitest-metz.
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "minitest/metz"
+
+# 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/metz.rb

@@ -0,0 +1,11 @@
+require 'minitest/metz/version'
+require 'minitest/metz/stats_reporter'
+require 'minitest/metz/scanner'
+require 'minitest/metz/scan_results'
+require 'minitest/metz/assertions'
+
+module Minitest
+  module Metz
+    # Your code goes here...
+  end
+end

data/lib/minitest/metz/assertions.rb

@@ -0,0 +1,29 @@
+require "minitest/assertions"
+
+module Minitest::Assertions
+  def assert_obey_metz(str)
+    file_path = full_file_path(str)
+    res = Minitest::Metz::Scanner.scan(file_path)
+    assert(res.all_valid?, "The class does not obey Sandi Metz' four rules.")
+  end
+
+  def refute_obey_metz(str)
+    file_path = full_file_path(str)
+    res = Minitest::Metz::Scanner.scan(file_path)
+    refute(res.all_valid?, "The class obeys Sandi Metz' four rules.")
+  end
+
+  private
+
+  def full_file_path(s)
+    if s.is_a?(Class)
+      where_is(s).first
+    else
+      s
+    end
+  end
+
+  def where_is(klass)
+    Minitest::Metz::Where.is_class_primarily(klass)
+  end
+end

data/lib/minitest/metz/scan_results.rb

@@ -0,0 +1,36 @@
+module Minitest
+  module Metz
+
+    class ScanResults
+      attr_reader :first_rule, :misindentation, :second_rule, :third_rule
+
+      def initialize(results)
+        @first_rule = results[:first_rule][:total_classes_amount] - results[:first_rule][:small_classes_amount]
+        @misindentation = results[:first_rule][:misindented_classes_amount]
+        @second_rule =  results[:second_rule][:total_methods_amount] - results[:second_rule][:small_methods_amount]
+        @third_rule = results[:third_rule][:total_method_calls] - results[:third_rule][:proper_method_calls]
+      end
+
+      def all_valid?
+        first_rule_valid? && misidentation_valid? && second_rule_valid? && third_rule_valid?
+      end
+
+      def first_rule_valid?
+        first_rule.zero?
+      end
+
+      def misidentation_valid?
+        misindentation.zero?
+      end
+
+      def second_rule_valid?
+        second_rule.zero?
+      end
+
+      def third_rule_valid?
+        third_rule.zero?
+      end
+    end
+
+  end
+end

data/lib/minitest/metz/scanner.rb

@@ -0,0 +1,21 @@
+require "sandi_meter/file_scanner"
+
+module Minitest
+  module Metz
+    class Scanner
+      def self.scan(file_path)
+        new.scan(file_path)
+      end
+
+      def initialize
+        @scanner = SandiMeter::FileScanner.new
+      end
+
+      def scan(file_path)
+        r = @scanner.scan(file_path)
+        Minitest::Metz::ScanResults.new(r)
+      end
+
+    end
+  end
+end

data/lib/minitest/metz/stats_reporter.rb

@@ -0,0 +1,45 @@
+require "minitest"
+
+module Minitest
+  module Metz
+
+    class StatsReporter < Minitest::Reporter
+      def initialize
+        @scanner = Minitest::Metz::Scanner.new
+        @results = {}
+      end
+
+      def record(result)
+        file_path, = result.class.instance_method(result.name).source_location
+        unless @results[file_path]
+          scan_result = Minitest::Metz::Scanner.scan(file_path)
+          @results[file_path] = build_results_string(file_path, scan_result)
+        end
+      end
+
+      def report
+        @results.each do |key, output|
+          puts output
+        end
+      end
+
+      private
+
+      def build_results_string(file_path, result)
+        str = "\nSandi Meter Rules results:"
+        if result.all_valid?
+          str << " All valid."
+        else
+          str << "\n#{file_path}"
+          str << "\n  #{result.first_rule} class(es) over 100 lines." unless result.first_rule_valid?
+          str << "\n  #{result.misidentation} misindented class(es)." unless result.misidentation_valid?
+          str << "\n  #{result.second_rule} method(s) over 5 lines." unless result.second_rule_valid?
+          str << "\n  #{result.third_rule} method call(s) accepted are more than 4 parameters." unless result.third_rule_valid?
+        end
+
+        str
+      end
+
+    end
+  end
+end

data/lib/minitest/metz/version.rb

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

data/lib/minitest/metz/where.rb

@@ -0,0 +1,53 @@
+module Minitest
+  module Metz
+    module Where
+      class << self
+        def is_class(klass)
+          methods = defined_methods(klass)
+          file_groups = methods.group_by{|sl| sl[0]}
+          file_counts = file_groups.map do |file, sls|
+            lines = sls.map{|sl| sl[1]}
+            count = lines.size
+            line = lines.min
+            {file: file, count: count, line: line}
+          end
+          file_counts.sort_by!{|fc| fc[:count]}
+          source_locations = file_counts.map{|fc| [fc[:file], fc[:line]]}
+          source_locations
+        end
+
+        # Raises ArgumentError if klass does not have any Ruby methods defined in it.
+        def is_class_primarily(klass)
+          source_locations = is_class(klass)
+          if source_locations.empty?
+            methods = defined_methods(klass)
+            raise ArgumentError, (methods.empty? ?
+                                  "#{klass} has no methods" :
+                                  "#{klass} only has built-in methods (#{methods.size} in total)"
+                                 )
+          end
+          source_locations[0]
+        end
+
+        private
+
+        def source_location(method)
+          method.source_location || (
+            method.to_s =~ /: (.*)>/
+            $1
+          )
+        end
+
+        def defined_methods(klass)
+          methods = klass.methods(false).map{|m| klass.method(m)} +
+            klass.instance_methods(false).map{|m| klass.instance_method(m)}
+          methods.map!(&:source_location)
+          methods.compact!
+          methods
+        end
+      end
+
+    end
+  end
+end
+

data/lib/minitest/metz_plugin.rb

@@ -0,0 +1,16 @@
+require 'pp'
+require "minitest"
+
+module Minitest
+  def self.plugin_metz_options(opts, options)
+    opts.on "-z", "--metz", "Check if your code obeys Sandi Metz' four rules for developers" do |z|
+      options[:metz] = z
+    end
+  end
+
+  def self.plugin_metz_init(options)
+    if options[:metz]
+      self.reporter << Minitest::Metz::StatsReporter.new
+    end
+  end
+end

data/minitest-metz.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minitest/metz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-metz"
+  spec.version       = Minitest::Metz::VERSION
+  spec.authors       = ["Ile Eftimov"]
+  spec.email         = ["ileeftimov@gmail.com"]
+
+  spec.summary       = %q{Make sure your code (production and tests) obey Sandi
+                          Metz' four rules for developers.}
+  spec.description   = %q{Minitest::Metz is a Minitest plugin that under it's
+                          hood hides the SandiMeter. It allows you to easily
+                          apply Sandi Metz's four rules for developers on your
+                          tests.}
+  spec.homepage      = "https://github.com/fteem/minitest-metz"
+
+  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.8"
+  spec.add_dependency "sandi_meter", "~> 1.2"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end
+

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: minitest-metz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ile Eftimov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: sandi_meter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: |-
+  Minitest::Metz is a Minitest plugin that under it's
+                            hood hides the SandiMeter. It allows you to easily
+                            apply Sandi Metz's four rules for developers on your
+                            tests.
+email:
+- ileeftimov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/minitest/metz.rb
+- lib/minitest/metz/assertions.rb
+- lib/minitest/metz/scan_results.rb
+- lib/minitest/metz/scanner.rb
+- lib/minitest/metz/stats_reporter.rb
+- lib/minitest/metz/version.rb
+- lib/minitest/metz/where.rb
+- lib/minitest/metz_plugin.rb
+- minitest-metz.gemspec
+homepage: https://github.com/fteem/minitest-metz
+licenses: []
+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.8
+signing_key: 
+specification_version: 4
+summary: Make sure your code (production and tests) obey Sandi Metz' four rules for
+  developers.
+test_files: []
+has_rdoc: