dead_gems 0.0.2

data/lib/dead_gems.rb

@@ -0,0 +1,81 @@
+require "dead_gems/version"
+require "logger"
+require "bundler"
+
+module DeadGems
+  GemInstance = Struct.new(:name, :path)
+
+  class << self
+    def find(project_root, exerciser)
+      begin_dir = Dir.pwd
+      logger = Logger.new($stdout)
+      change_directory_to project_root
+      gems = find_all_gems.map do |name|
+        path = find_gem_path(name)
+        GemInstance.new(name, path)
+      end
+      apply_environment_patch(gems) do
+        run(exerciser, gems)
+      end
+    ensure
+      change_directory_to begin_dir
+    end
+
+    private
+
+    def change_directory_to(dir)
+      Dir.chdir(dir)
+    end
+
+    def find_all_gems
+      Bundler.with_clean_env do
+        gem_lines = File.read('Gemfile.lock').split("DEPENDENCIES\n").last
+        arr = []
+        gem_lines.each_line { |line| arr << line.match(/\s*([^\s!]+)/).captures.first }
+        arr
+      end
+    end
+
+    def find_gem_path(gem)
+      Bundler.with_clean_env do
+        `bundle list #{gem}`.chomp
+      end
+    end
+
+    def apply_environment_patch(gems)
+      file = 'test/test_helper.rb'
+      prepatch = File.read(file)
+      patch = <<-END
+gem_paths = #{gems.map(&:path)}
+trace = TracePoint.new(:call) do |tp|
+  # Gem is used
+  # Print to file
+  if path = gem_paths.detect {|p| tp.path.include?(p)}
+    puts "Gem used: \#{tp.defined_class} called with \#{tp.method_id} in \#{tp.path}"
+    File.open('dead_gems.out', 'a') {|f| f.puts path}
+    gem_paths.delete(path)
+  end
+end
+trace.enable
+      END
+      File.open(file, 'w') { |f| f.write([prepatch, patch].join("\n")) }
+      yield
+    ensure
+      File.open(file, 'w') { |f| f.write(prepatch) }
+      File.delete('dead_gems.out') if File.exists?('dead_gems.out')
+    end
+
+    def run(exerciser, gems)
+      Bundler.with_clean_env do
+        # If all tests pass then the gem is unused.
+        # Otherwise it would've have exited on-call.
+        system exerciser
+        File.read('dead_gems.out').each_line do |line|
+          path = line.chomp
+          gems.delete_if {|g| g.path == path}
+        end
+        gems.map(&:name)
+      end
+    end
+  end
+end

data/spec/dead_gems_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+class DeadGemsSpec < Minitest::Spec
+  describe '.find' do
+    describe 'given the dummy app and the test shell command' do
+      before do
+        @project_path = File.expand_path('../../dummy', __FILE__)
+        @exerciser_command = 'bundle exec rake &> /dev/null'
+      end
+
+      it 'outputs factory_girl in the list of unused gems' do
+        assert DeadGems.find(@project_path, @exerciser_command).include?('factory_girl')
+      end
+
+      it 'doesnt output timecop in the list of unused gems' do
+        r = DeadGems.find(@project_path, @exerciser_command)
+        assert !r.include?('timecop')
+      end
+    end
+  end
+
+  describe '.find_all_gems' do
+    it 'correctly parses outs bangs' do
+      begin
+        str = <<-FILE
+DEPENDENCIES
+  test!
+FILE
+
+        original = File.method(:read)
+        File.define_singleton_method(:read, -> (f) { str })
+        assert DeadGems.send(:find_all_gems).any? {|g| g == 'test'}
+      ensure
+        File.define_singleton_method(:read, original)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dead_gems'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/spec'

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: dead_gems
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Josh Bodah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-04 00:00:00.000000000 Z
+dependencies:
+- !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: minitest
+  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: guard
+  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: guard-minitest
+  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: thor
+  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: spy_rb
+  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: dead_gems works by analyzing your gem dependencies and running an exerciser
+  script to see if any of them were used
+email:
+- jb3689@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dead_gems.gemspec
+- dummy/.gitignore
+- dummy/Gemfile
+- dummy/Gemfile.lock
+- dummy/README.rdoc
+- dummy/Rakefile
+- dummy/app/assets/images/.keep
+- dummy/app/assets/javascripts/application.js
+- dummy/app/assets/stylesheets/application.css
+- dummy/app/controllers/application_controller.rb
+- dummy/app/controllers/concerns/.keep
+- dummy/app/helpers/application_helper.rb
+- dummy/app/mailers/.keep
+- dummy/app/models/.keep
+- dummy/app/models/concerns/.keep
+- dummy/app/models/user.rb
+- dummy/app/views/layouts/application.html.erb
+- dummy/bin/bundle
+- dummy/bin/rails
+- dummy/bin/rake
+- dummy/bin/spring
+- dummy/config.ru
+- dummy/config/application.rb
+- dummy/config/boot.rb
+- dummy/config/database.yml
+- dummy/config/environment.rb
+- dummy/config/environments/development.rb
+- dummy/config/environments/production.rb
+- dummy/config/environments/test.rb
+- dummy/config/initializers/assets.rb
+- dummy/config/initializers/backtrace_silencers.rb
+- dummy/config/initializers/cookies_serializer.rb
+- dummy/config/initializers/filter_parameter_logging.rb
+- dummy/config/initializers/inflections.rb
+- dummy/config/initializers/mime_types.rb
+- dummy/config/initializers/session_store.rb
+- dummy/config/initializers/wrap_parameters.rb
+- dummy/config/locales/en.yml
+- dummy/config/routes.rb
+- dummy/config/secrets.yml
+- dummy/db/seeds.rb
+- dummy/lib/assets/.keep
+- dummy/lib/tasks/.keep
+- dummy/log/.keep
+- dummy/public/404.html
+- dummy/public/422.html
+- dummy/public/500.html
+- dummy/public/favicon.ico
+- dummy/public/robots.txt
+- dummy/test/controllers/.keep
+- dummy/test/fixtures/.keep
+- dummy/test/helpers/.keep
+- dummy/test/integration/.keep
+- dummy/test/mailers/.keep
+- dummy/test/models/.keep
+- dummy/test/models/user_test.rb
+- dummy/test/test_helper.rb
+- dummy/vendor/assets/javascripts/.keep
+- dummy/vendor/assets/stylesheets/.keep
+- lib/dead_gems.rb
+- lib/dead_gems/version.rb
+- spec/dead_gems_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2
+signing_key: 
+specification_version: 4
+summary: a gem for finding unused gems in your project
+test_files:
+- spec/dead_gems_spec.rb
+- spec/spec_helper.rb
+has_rdoc: