minitest-ruby_golf_metrics 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thomas Jachmann
+
+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,38 @@
+# Minitest::RubyGolfMetrics
+
+This is a [Minitest](https://github.com/seattlerb/minitest) plugin that can be
+used to play [Ruby Golf](http://www.sitepoint.com/ruby-golf/).
+
+It makes some assumptions which make it unusable for you if you don't play the
+game after its rules:
+
+* your tasks are tested in the minitest class ```RubyGolfTest```
+* the contestants implement their solutions as module methods in the module
+  ```RubyGolf```
+
+That's it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'minitest-ruby_golf_metrics'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Run your minitests and check your results.
+
+You can provide the parameter --nocolor to prevent the metrics output form being
+colorized.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/minitest/ruby_golf_metrics.rb

@@ -0,0 +1,8 @@
+require "minitest/ruby_golf_metrics/version"
+require "minitest/ruby_golf_metrics/reporter"
+
+module Minitest
+  module RubyGolfMetrics
+    # Your code goes here...
+  end
+end

data/lib/minitest/ruby_golf_metrics/character_counter.rb

@@ -0,0 +1,37 @@
+require "sourcify"
+require "minitest/ruby_golf_metrics/method_parser"
+
+module Minitest
+
+  module RubyGolfMetrics
+
+    class CharacterCounter
+
+      def initialize(method_name, previous_method_stack = [])
+        method_stack = previous_method_stack + [method_name]
+        @method_name = method_name
+        source = RubyGolf.method(method_name).to_raw_source(strip_enclosure: true)
+        @size = source.strip.gsub(/\s+/, "").size
+        parser = MethodParser.new(source)
+        @children = (RubyGolf.methods(false) - method_stack).map do |method|
+          CharacterCounter.new(method, method_stack) if parser.is_method_called?(method)
+        end.compact
+      end
+
+      def cumulative_size
+        @size + @children.map(&:cumulative_size).inject(0, &:+)
+      end
+
+      def self_contained?
+        @children.empty?
+      end
+
+      def called_method_sizes
+        ["#{@method_name}: #{@size}", @children.map(&:called_method_sizes)].flatten.compact
+      end
+
+    end
+
+  end
+
+end

data/lib/minitest/ruby_golf_metrics/method_parser.rb

@@ -0,0 +1,46 @@
+# taken from http://stackoverflow.com/questions/16917902/parsing-ruby-code-for-certain-function-calls
+require "ripper"
+
+module Minitest
+
+  module RubyGolfMetrics
+
+    class MethodParser
+
+      def initialize(source)
+        @ast = Ripper.sexp(source)
+      end
+
+      def is_method_called?(method_name)
+        search_ast_for_method(@ast, method_name)
+      end
+
+      private
+
+      def is_top_level_method_call(ast, method_name)
+        # firstly check if possible command block
+        unless ast.is_a?(Array) && ast.length > 1 && ast[1].is_a?(Array)
+          return false
+        end
+        # now check if it is a function call or command, and check the method name
+        if [:command, :fcall].include? ast[0]
+          ast[1].include?(method_name.to_s)
+        elsif ast[0] == :command_call
+          ast[1][0] == :var_ref && ast[1][1].include?("RubyGolf")
+          ast[3].include?(method_name.to_s)
+        else
+          false
+        end
+      end
+
+      def search_ast_for_method(ast, method_name)
+        return true if is_top_level_method_call(ast, method_name)
+        return false unless ast.is_a? Array
+        ast.any? { |e| search_ast_for_method(e, method_name) }
+      end
+
+    end
+
+  end
+
+end

data/lib/minitest/ruby_golf_metrics/reporter.rb

@@ -0,0 +1,47 @@
+require "minitest/ruby_golf_metrics/character_counter"
+
+module Minitest
+
+  module RubyGolfMetrics
+
+    class Reporter < ::Minitest::Reporter
+
+      Erg = Struct.new(:method_name, :passed)
+
+      def start
+        @ergs = []
+      end
+
+      def record(erg)
+        @ergs << Erg.new(erg.location.gsub("RubyGolfTest#test_", "").gsub(/ .*/, ""), erg.passed?)
+      end
+
+      def report
+        io.puts "\nRuby Golf Metrics"
+        @ergs.sort_by(&:method_name).each do |erg|
+          if erg.passed
+            begin
+              counter = CharacterCounter.new(erg.method_name)
+              msg = "  #{colorize(erg.method_name, 32)}: #{counter.cumulative_size} characters"
+              msg << " (#{counter.called_method_sizes.join(", ")})" if !counter.self_contained?
+              io.puts msg
+            rescue NoMethodError
+              io.puts "  #{colorize(erg.method_name, 31)}: UNDEFINED"
+            end
+          else
+            io.puts "  #{colorize(erg.method_name, 31)}: FAILED"
+          end
+        end
+      end
+
+      private
+
+      def colorize(text, color)
+        options[:nocolor] ? text : "\e[#{color}m#{text}\e[0m"
+      end
+
+    end
+
+  end
+
+end

data/lib/minitest/ruby_golf_metrics/version.rb

@@ -0,0 +1,5 @@
+module Minitest
+  module RubyGolfMetrics
+    VERSION = "0.0.1"
+  end
+end

data/lib/minitest/ruby_golf_metrics_plugin.rb

@@ -0,0 +1,15 @@
+require "minitest/ruby_golf_metrics"
+
+module Minitest
+
+  def self.plugin_ruby_golf_metrics_options(opts, options)
+    opts.on "--nocolor", "Report metrics without color" do
+      options[:nocolor] = true
+    end
+  end
+
+  def self.plugin_ruby_golf_metrics_init(options)
+    self.reporter << RubyGolfMetrics::Reporter.new(options[:io], options)
+  end
+
+end

data/minitest-ruby_golf_metrics.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'minitest/ruby_golf_metrics/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-ruby_golf_metrics"
+  spec.version       = Minitest::RubyGolfMetrics::VERSION
+  spec.authors       = ["Thomas Jachmann"]
+  spec.email         = ["self@thomasjachmann.com"]
+  spec.description   = %q{Provide metrics for evaluating ruby golf solutions concerning code length when running minitests.}
+  spec.summary       = %q{Ruby Golf Metrics Plugin for Minitest}
+  spec.homepage      = "https://github.com/thomasjachmann/minitest-ruby_golf_metrics"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "sourcify", "0.6.0.rc4"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: minitest-ruby_golf_metrics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Jachmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sourcify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0.rc4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.0.rc4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provide metrics for evaluating ruby golf solutions concerning code length
+  when running minitests.
+email:
+- self@thomasjachmann.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/minitest/ruby_golf_metrics.rb
+- lib/minitest/ruby_golf_metrics/character_counter.rb
+- lib/minitest/ruby_golf_metrics/method_parser.rb
+- lib/minitest/ruby_golf_metrics/reporter.rb
+- lib/minitest/ruby_golf_metrics/version.rb
+- lib/minitest/ruby_golf_metrics_plugin.rb
+- minitest-ruby_golf_metrics.gemspec
+homepage: https://github.com/thomasjachmann/minitest-ruby_golf_metrics
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3528417271052105563
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3528417271052105563
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby Golf Metrics Plugin for Minitest
+test_files: []