mire 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 361606807951fe02817f5a4f71a2810c914f79c7
+  data.tar.gz: bfd3d06e0f857abb7709c5992bb647c1493486e2
+SHA512:
+  metadata.gz: 5b1c3198a31536633dd44ec35d1f89cdb4f36011b6bdf5071b8d43b1d296f85597eb6d3b3b02f63e1972cd08aee3b47f1aa65970a4cb366df7db5be732544971
+  data.tar.gz: 7759ff2bd79fd0ace1be9375c7058604ec0e2a278134fa059673d393ba1110d07c80539cea7d3d963fdbb17221bb51e7f6650a6f1af3329d79f13c02d8a8fbc3

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,2 @@
+require: rubocop-rspec
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,15 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-04-15 12:03:43 +0200 using RuboCop version 0.23.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Style/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 2
+# Configuration parameters: CountComments.
+Style/MethodLength:
+  Max: 22

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Change log
+
+## master (unreleased)
+
+## 0.1.1
+
+* Add configuration option to exclude files / folders from analyzing
+* Add configuration initializer option
+* Switch from OptionParser to Slop as option parser
+* Extend analyzer to handle modifier ifs and special blocks
+
+## 0.1.0
+
+Initial version. This version is not stable yet, but feel free to test
+it and feedback or (even better) pull requests are highly welcome.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 XING EVENTS GmbH
+
+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,134 @@
+# mire [ˈmɪʀɛ]
+
+mire analyzes a Ruby project and helps you to find dependencies, call
+stacks and unused methods. It parses Ruby and Haml files and collects
+all method definitions and invocations.
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [Configuration](#configuration)
+* [Dependencies](#dependencies)
+* [TODO](#todo)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mire'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install mire
+```
+
+## Usage
+
+First you need to analyze the code and create a `.mire_analysis.yml`
+file.
+
+```bash
+bundle exec mire -a
+```
+
+A Ruby code like
+
+```ruby
+class Foo
+  def bar
+    buz
+  end
+end
+```
+
+will lead to this `.mire_analysis.yml` file.
+
+```yaml
+:bar:
+  :definitions:
+  - :class: Foo
+    :method: :bar
+    :file: foo.rb
+    :line: 2
+  :invocations: []
+:buz:
+  :definition: []
+  :invocations:
+  - :class: Foo
+    :method: :bar
+    :file: foo.rb
+    :line: 3
+```
+
+After this the `.mire_analysis.yml` file can be used to find unused
+methods for example.
+
+```bash
+bundle exec mire -u
+
+Checking for unused methods
+foo.rb:2 Foo.bar
+```
+
+This result can only be taken as a hint for unused methods. For example ERB files are
+not being analysed yet. Also dynamic method definitions or invocations are not
+considered.  So mire can't find every usage of a method.
+
+## Configuration
+
+mire can be configured with a `.mire.yml` file in your project folder.
+With `mire -i` a initial configuration file is created.
+
+You can configure which files or folders should be excluded while
+analyzing the code or when displaying the unused methods.
+
+```yaml
+excluded_files:
+  - vendor/**/*
+
+output:
+  unused:
+    excluded_files:
+      - db/migrate/**/*
+      - spec/**/*
+      - script/**/*
+      - lib/**/*
+```
+
+## Dependencies
+
+Why is [HAML-Lint](https://github.com/brigade/haml-lint) needed?
+
+HAML-Lint did a great job to write a Ruby code extractor for Haml files.
+mire is using this extractor.
+
+## TODO
+
+The current implementation of mire is really basic. It needs to become
+more robust and the parsed file types (e.g. `.erb`) needs to be
+extended.
+
+## Contributing
+
+1. Fork it ( https://github.com/xing/mire/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
+
+## Authors
+
+[Nils Gemeinhardt](https://github.com/geniou) and [Marcus Lankenau](https://github.com/mlankenau)
+
+Copyright (c) 2015 [XING EVENTS GmbH](http://de.amiando.com/)
+
+Released under the MIT license. For full details see LICENSE included in this distribution.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/bin/mire

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require 'mire'
+
+Mire::CLI.parse

data/lib/mire.rb

@@ -0,0 +1,14 @@
+require 'parser/current'
+require 'yaml'
+require 'slop'
+require 'ruby-progressbar'
+require 'haml_lint'
+
+require 'mire/configuration'
+require 'mire/configuration_methods'
+require 'mire/analyzer'
+require 'mire/cli'
+
+require 'mire/output/base'
+require 'mire/output/occurrence'
+require 'mire/output/unused'

data/lib/mire/analyzer.rb

@@ -0,0 +1,160 @@
+module Mire
+  # analyze all ruby files in a folder and find there usage
+  class Analyzer
+    include ConfigurationMethods
+
+    attr_reader :methods
+
+    BLACKLIST = %i(lambda new inspect to_i to_a [] []= * | ! != !~ % & + -@ / <
+                   << <= <=> == === =~ > >= - __callee__ __send__ initialize
+                   method_missing)
+
+    CALLBACKS = %i(after_commit after_create after_destroy after_save
+                   after_update after_validation before_commit before_create
+                   before_destroy before_save before_update before_validation)
+
+    BLOCKS = %i(task)
+
+    FILE = '.mire_analysis.yml'
+
+    def initialize(files: nil)
+      @namespace = []
+      @methods = {}
+      @files = files || Dir['**/*.{rb,haml}']
+    end
+
+    def run
+      progress_bar = ProgressBar.create(total: @files.count)
+      @files.each do |file|
+        @method = nil
+        next if excluded_file?(file)
+        @filename = file
+        case file_type(file)
+        when :haml
+          parse_haml_file(file)
+        when :rb
+          parse_file(file)
+        end
+        @filename = nil
+        progress_bar.increment
+      end
+      self
+    end
+
+    def save
+      IO.write(FILE, @methods.to_yaml)
+    end
+
+    private
+
+    def file_type(filename)
+      filename.split('.').last.to_sym
+    end
+
+    def excluded_files
+      @excluded_files ||= configuration.read(:excluded_files) || []
+    end
+
+    def parse_file(filename)
+      file_content = IO.read(filename)
+      ast = Parser::CurrentRuby.parse(file_content)
+      parse(ast)
+    rescue
+      nil
+    end
+
+    def parse_haml_file(filename)
+      file_content = IO.read(filename)
+      parser = HamlLint::Parser.new(file_content)
+      extractor = HamlLint::ScriptExtractor.new(parser)
+      ast = Parser::CurrentRuby.parse(extractor.extract.strip)
+      parse_method(ast)
+    rescue
+      nil
+    end
+
+    def location(ast)
+      {
+        class: @namespace.join('::'),
+        method: @method,
+        file: @filename,
+        line: ast.loc.line
+      }
+    end
+
+    def add_method(to, definition: nil, invocation: nil)
+      # TODO: this class check should not be necessary - it looks like the code
+      # is still messing up by determine the method
+      return unless [String, Symbol, NilClass].include?(@method.class)
+      return if BLACKLIST.include?(to.to_sym)
+
+      @methods[to] ||= { definitions: [], invocations: [] }
+      @methods[to][:definitions] << location(definition) if definition
+      @methods[to][:invocations] << location(invocation) if invocation
+    end
+
+    def get_const(ast)
+      fail "#{ast} is not a constant" unless ast.type == :const
+      ast.children.last.to_s
+    end
+
+    def parse_method(ast)
+      return unless ast.respond_to?(:type) && ast.respond_to?(:children)
+      if ast.type == :send
+        add_method(ast.children[1], invocation: ast)
+      elsif ast.type == :sym
+        add_method(ast.children[0], invocation: ast)
+      end
+      parse_children(ast, :parse_method)
+    end
+
+    def parse(ast)
+      return unless ast.respond_to?(:type) && ast.respond_to?(:children)
+      parse_method = "parse_#{ast.type}_node"
+      return send(parse_method, ast) if respond_to?(parse_method, true)
+      parse_children(ast)
+    rescue
+      raise "Error while parsing #{@filename}:#{ast.loc.line}"
+    end
+
+    def parse_children(ast, method = :parse)
+      ast.children.each { |c| send(method, c) }
+    end
+
+    def parse_class_node(ast)
+      @namespace.push(get_const(ast.children.first))
+      parse_children(ast)
+      @namespace.pop
+    end
+    alias_method :parse_module_node, :parse_class_node
+
+    def parse_def_node(ast)
+      @method = ast.children[ast.type == :defs ? 1 : 0]
+      add_method(@method, definition: ast)
+      parse_children(ast, :parse_method)
+    end
+    alias_method :parse_defs_node, :parse_def_node
+
+    def parse_send_node(ast)
+      unless (CALLBACKS + %i(scope validate)).include?(ast.children[1])
+        return parse_children(ast)
+      end
+      return unless ast.children[2]
+
+      @method = ast.children[2].children.last
+      parse_children(ast, :parse_method)
+    end
+
+    def parse_block_node(ast)
+      unless BLOCKS.include?(ast.children.first.children[1])
+        return parse_children(ast)
+      end
+      parse_method(ast.children[2])
+    end
+
+    def parse_if_node(ast)
+      parse_method(ast.children[0])
+      parse_children(ast)
+    end
+  end
+end

data/lib/mire/cli.rb

@@ -0,0 +1,63 @@
+module Mire
+  # Command line interface for mire
+  class CLI
+    class << self
+      def parse # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        slop = Slop.parse do |opts|
+          opts.on('-h', '--help', 'Show this help') do
+            puts opts
+            exit
+          end
+          opts.on('-a', '--analyze', 'Analyze ruby project') do
+            analyze
+            exit
+          end
+          opts.on('-c', '--check TERM', 'Check term and find usages') do |f|
+            check(f)
+            exit
+          end
+          opts.on('-u', '--unused', 'Check for unused methods') do
+            unused
+            exit
+          end
+          opts.on('-i', '--initialize', 'Create initial configuration file') do
+            init
+            exit
+          end
+        end
+
+        puts slop
+      rescue Slop::UnknownOption
+        puts 'Unknown option - use --help to see all options'
+      end
+
+      private
+
+      def init
+        Mire::Configuration.copy_example
+        puts "Configuration file #{Mire::Configuration::FILE} created"
+      rescue Mire::Configuration::ExistingFile
+        puts "Existing #{Mire::Configuration::FILE} file found - nothing done"
+      end
+
+      def analyze
+        analyzer = Analyzer.new
+        puts 'Analyzing project'
+        analyzer.run
+        analyzer.save
+      end
+
+      def check(f)
+        puts "Checking term #{f}"
+        occurrence = Output::Occurrence.new
+        puts occurrence.check(f)
+      end
+
+      def unused
+        puts 'Checking for unused methods'
+        occurrence = Output::Unused.new
+        puts occurrence.check
+      end
+    end
+  end
+end

data/lib/mire/configuration.rb

@@ -0,0 +1,44 @@
+module Mire
+  # load configuration
+  class Configuration
+    FILE = '.mire.yml'
+
+    class << self
+      def copy_example
+        fail ExistingFile if File.exist?(FILE)
+        FileUtils.cp(example_file, FILE)
+      end
+
+      private
+
+      def example_file
+        File.join(File.dirname(__FILE__), 'configuration_example.yml')
+      end
+    end
+
+    def initialize
+      @config = if File.exist?(FILE)
+                  symbolize_keys(YAML.load_file(FILE))
+                else
+                  {}
+                end
+    end
+
+    def read(*args)
+      args.reduce(@config) do |c, key|
+        return nil unless c
+        c[key]
+      end
+    end
+
+    private
+
+    def symbolize_keys(hash)
+      hash.each_with_object({}) do |(key, value), result|
+        result[key.to_sym] = value.is_a?(Hash) ? symbolize_keys(value) : value
+      end
+    end
+
+    class ExistingFile < StandardError; end
+  end
+end

data/lib/mire/configuration_example.yml

@@ -0,0 +1,12 @@
+excluded_files:
+  - vendor/**/*
+
+output:
+  unused:
+    excluded_files:
+      - app/controllers/**/*
+      - config/**/*
+      - db/migrate/**/*
+      - lib/**/*
+      - script/**/*
+      - spec/**/*

data/lib/mire/configuration_methods.rb

@@ -0,0 +1,12 @@
+module Mire
+  module ConfigurationMethods
+
+    def configuration
+      @configuration ||= Mire::Configuration.new
+    end
+
+    def excluded_file?(file)
+      excluded_files.any? { |e| File.fnmatch(e, file, File::FNM_PATHNAME) }
+    end
+  end
+end

data/lib/mire/output/base.rb

@@ -0,0 +1,34 @@
+module Mire
+  module Output
+    # base class of output classes
+    class Base
+      include ConfigurationMethods
+
+      protected
+
+      def methods
+        @methods ||= YAML.load_file(Mire::Analyzer::FILE)
+      end
+
+      def location(location)
+        [location_file(location), location_method(location)]
+          .reject { |s| s.to_s.empty? }
+          .join(' ')
+      end
+
+      private
+
+      def location_method(location)
+        [location[:class], location[:method]]
+          .reject { |s| s.to_s.empty? }
+          .join('.')
+      end
+
+      def location_file(location)
+        [location[:file], location[:line]]
+          .reject { |s| s.to_s.empty? }
+          .join(':')
+      end
+    end
+  end
+end

data/lib/mire/output/occurrence.rb

@@ -0,0 +1,21 @@
+module Mire
+  module Output
+    # checks for a term and print out the occurrences and the occurrences of
+    # this and so on
+    class Occurrence < Base
+      def check(term, levels: 2, indenting: 0, output: [])
+        term = term.to_sym if term
+        return unless methods[term]
+        methods[term][:invocations].each_with_object(output) do |method, o|
+          o << "#{' ' * indenting * 2}#{location(method)}"
+
+          next unless levels > 0
+          check(method[:method], levels: levels - 1,
+                                 indenting: indenting + 1,
+                                 output: o)
+        end
+        output
+      end
+    end
+  end
+end

data/lib/mire/output/unused.rb

@@ -0,0 +1,32 @@
+module Mire
+  module Output
+    # Check for unused methods
+    class Unused < Base
+      def check
+        methods
+          .select { |_, m| m[:invocations].empty? }
+          .map { |_, m| definitions(m[:definitions]) }
+          .flatten
+          .compact
+          .sort
+      end
+
+      private
+
+      def definitions(definitions)
+        definitions.map do |d|
+          location(d) unless excluded_file?(d[:file])
+        end
+      end
+
+      def excluded_file?(file)
+        excluded_files.any? { |e| File.fnmatch(e, file, File::FNM_PATHNAME) }
+      end
+
+      def excluded_files
+        @excluded_files ||=
+          configuration.read(:output, :unused, :excluded_files) || []
+      end
+    end
+  end
+end

data/lib/mire/version.rb

@@ -0,0 +1,3 @@
+module Mire
+  VERSION = '0.1.1'
+end

data/mire.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mire/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mire'
+  spec.version       = Mire::VERSION
+  spec.authors       = ['Nils Gemeinhardt', 'Marcus Lankenau']
+  spec.email         = ['nils.gemeinhardt@xing.com', 'marcus.lankenau@xing.com']
+  spec.summary       = 'Analyzes a Ruby project.'
+  spec.description   = <<-TEXT
+    Analyzes a Ruby project and helps you to find dependencies, call stacks and
+    unused methods.
+  TEXT
+  spec.homepage      = 'https://github.com/xing/mire'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(/bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'parser'
+  spec.add_runtime_dependency 'slop', '~> 4.0'
+  spec.add_runtime_dependency 'ruby-progressbar'
+  spec.add_runtime_dependency 'haml-lint'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~>  3.0'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+end

data/spec/mire/analyzer_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe Mire::Analyzer, type: :class do
+  subject { analyzer.run.save }
+  let(:analyzer) { described_class.new(files: Dir[@file]) }
+  let(:methods) { YAML.load_file(Mire::Analyzer::FILE) }
+  def file(content, extension = :rb)
+    @file = Tempfile.new(['mire', ".#{extension}"]).tap do |file|
+      file << content
+      file.close
+    end
+  end
+  let(:found_methods) { methods.map { |k, _v| k } }
+
+  it 'finds method calls inside method' do
+    file <<-RUBY
+      class Foo
+        def bar
+          buz
+        end
+      end
+    RUBY
+    subject
+    expect(methods[:buz]).not_to be_nil
+    expect(methods[:buz][:invocations]).not_to be_empty
+    expect(methods[:buz][:invocations].first[:class]).to eq('Foo')
+    expect(methods[:buz][:invocations].first[:method]).to eq(:bar)
+    expect(methods[:buz][:invocations].first[:line]).to eq(3)
+    expect(methods[:bar][:definitions]).not_to be_empty
+    expect(methods[:bar][:definitions].first[:class]).to eq('Foo')
+    expect(methods[:bar][:definitions].first[:method]).to eq(:bar)
+    expect(methods[:bar][:definitions].first[:line]).to eq(2)
+  end
+
+  it 'ignores excluded files' do
+    file <<-RUBY
+      class Foo
+        def bar
+          buz
+        end
+      end
+    RUBY
+    configuration = Tempfile.new('mire_configuration')
+    configuration << {
+      excluded_files: [
+        @file.path
+      ]
+    }.to_yaml
+    configuration.close
+    stub_const('Mire::Configuration::FILE', configuration.path)
+
+    subject
+    expect(methods[:buz]).to be_nil
+  end
+
+  it 'finds method calls inside class.method' do
+    file <<-RUBY
+      class Foo
+        def self.bar
+          buz
+        end
+      end
+    RUBY
+    subject
+    expect(found_methods).to match_array(%i(bar buz))
+  end
+
+  it 'finds callbacks' do
+    file <<-RUBY
+      class Foo
+        before_destroy :bar
+        def bar
+          true
+        end
+      end
+    RUBY
+    subject
+    expect(found_methods).to match_array(%i(bar))
+  end
+
+  it 'finds validation calls' do
+    file <<-RUBY
+      class Foo
+        validate :bar
+      end
+    RUBY
+    subject
+    expect(found_methods).to match_array(%i(bar))
+  end
+
+  it 'finds method calls inside blocks - e.g. rake tasks' do
+    file <<-RUBY
+      namespace :foo do
+        task bar: :environment do
+          Foo.bar
+          Foo.bax
+        end
+        task bax: :environment do
+          Foo.bur
+        end
+      end
+    RUBY
+    subject
+    expect(found_methods).to match_array(%i(bar bax bur))
+  end
+
+  it 'finds method calls in modifier ifs' do
+    file <<-RUBY
+      class Foo
+        validate :bar unless bux
+        validate :bar if buy
+        def bax
+          foo if bur
+        end
+      end
+    RUBY
+    subject
+    expect(found_methods).to match_array(%i(bar bux buy bax bur foo))
+  end
+
+  it 'adds also not called methods' do
+    file <<-RUBY
+      class Foo
+        def self.bar
+          true
+        end
+        def baz
+          self.bar
+        end
+      end
+    RUBY
+    subject
+    expect(found_methods).to match_array(%i(bar baz))
+  end
+
+  context 'haml files' do
+    it 'parses haml files' do
+      file(['- if bar', '  %b= foo'].join("\n"), :haml)
+      subject
+      expect(methods[:bar]).not_to be_nil
+      expect(methods[:bar][:invocations]).not_to be_empty
+      expect(methods[:bar][:invocations].first[:file]).to eq(@file.path)
+      expect(methods[:foo]).not_to be_nil
+    end
+  end
+end

data/spec/mire/configuration_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe Mire::Configuration, type: :model do
+  before do
+    file = Tempfile.new('mire_configuration')
+    file << configuration.to_yaml
+    file.close
+
+    stub_const('Mire::Configuration::FILE', file.path)
+  end
+
+  let(:configuration) do
+    {
+      output: {
+        unused: {
+          excluded_files: [
+            'boo/**/*'
+          ]
+        }
+      }
+    }
+  end
+
+  it 'fetches values' do
+    expect(subject.read(:output, :unused, :excluded_files)).to eq(['boo/**/*'])
+  end
+
+  it 'returns nil for not existing keys' do
+    expect(subject.read(:not, :known, :attribute)).to be_nil
+  end
+end

data/spec/mire/output/occurrence_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+describe Mire::Output::Occurrence, type: :model do
+  it 'returns occurrences of a given method' do
+    methods = {
+      foo: {
+        definitions: [
+          {
+            class: 'Foo',
+            method: 'bar',
+            file: 'foo.rb',
+            line: '123'
+          }
+        ],
+        invocations: [
+          {
+            class: 'Foo',
+            method: 'baz',
+            file: 'foo.rb',
+            line: '10'
+          },
+          {
+            class: 'Foo',
+            method: 'buz',
+            file: 'foo.rb',
+            line: '20'
+          }
+        ]
+      },
+      buz: {
+        definitions: [
+          {
+            class: 'Foo',
+            method: 'buz',
+            file: 'foo.rb',
+            line: '1234'
+          }
+        ],
+        invocations: [
+          {
+            class: 'Foo',
+            method: 'biz',
+            file: 'foo.rb',
+            line: '30'
+          }
+        ]
+      }
+    }
+    allow(subject).to receive(:methods).and_return(methods)
+    expect(subject.check(:foo)).to eq [
+      'foo.rb:10 Foo.baz',
+      'foo.rb:20 Foo.buz',
+      '  foo.rb:30 Foo.biz'
+    ]
+  end
+end

data/spec/mire/output/unused_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe Mire::Output::Unused, class: :model do
+  before do
+    methods = {
+      foo: {
+        definitions: [
+          {
+            class: 'Foo',
+            method: 'bar',
+            file: 'foo/bar.rb',
+            line: '123'
+          },
+          {
+            class: 'Boo',
+            method: 'bar',
+            file: 'boo/bar.rb',
+            line: '12'
+          }
+        ],
+        invocations: []
+      }
+    }
+    allow(subject).to receive(:methods).and_return(methods)
+  end
+
+  it 'returns methods that are unused' do
+    expect(subject.check).to match_array([
+      'foo/bar.rb:123 Foo.bar',
+      'boo/bar.rb:12 Boo.bar'
+    ])
+  end
+
+  it 'ignores files when given in the configuration' do
+    configuration = Tempfile.new('mire_configuration')
+    configuration << {
+      output: {
+        unused: {
+          excluded_files: [
+            'boo/**/*'
+          ]
+        }
+      }
+    }.to_yaml
+    configuration.close
+
+    stub_const('Mire::Configuration::FILE', configuration.path)
+    expect(subject.check).to eq(['foo/bar.rb:123 Foo.bar'])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'mire'

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: mire
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Nils Gemeinhardt
+- Marcus Lankenau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  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'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  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'
+- !ruby/object:Gem::Dependency
+  name: haml-lint
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Analyzes a Ruby project and helps you to find dependencies, call stacks and
+      unused methods.
+email:
+- nils.gemeinhardt@xing.com
+- marcus.lankenau@xing.com
+executables:
+- mire
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/mire
+- lib/mire.rb
+- lib/mire/analyzer.rb
+- lib/mire/cli.rb
+- lib/mire/configuration.rb
+- lib/mire/configuration_example.yml
+- lib/mire/configuration_methods.rb
+- lib/mire/output/base.rb
+- lib/mire/output/occurrence.rb
+- lib/mire/output/unused.rb
+- lib/mire/version.rb
+- mire.gemspec
+- spec/mire/analyzer_spec.rb
+- spec/mire/configuration_spec.rb
+- spec/mire/output/occurrence_spec.rb
+- spec/mire/output/unused_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/xing/mire
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Analyzes a Ruby project.
+test_files:
+- spec/mire/analyzer_spec.rb
+- spec/mire/configuration_spec.rb
+- spec/mire/output/occurrence_spec.rb
+- spec/mire/output/unused_spec.rb
+- spec/spec_helper.rb