gem_fresh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 563e8d2d986b8d974e4fcbfb1fb3c09e9a0cc125
+  data.tar.gz: 310303c1f1d099669050b7d619c43681577e2da8
+SHA512:
+  metadata.gz: ef9184f6a7ef14df71c550eb9f9a738f33a64074f4b2c655dbb054d32e5a02fdf1a2c3fcfd62b10167a55862384491a42d40a80802cf88e768037005202c8d39
+  data.tar.gz: 3aee268d62e854ac6ec8db896933894ee0c2c8efbcbb5150801da95a56dafb2eab8597ff3cb0a66366e8d1ea3de12e23e67a6ee8cae97cba21e8c9a3658af784

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Anne Geiersbach
+
+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,69 @@
+# GemFresh
+
+The purpose of GemFresh is to expose useful information about how outdated your application gems are.
+
+## Setup
+
+Create a file called GemFresh.rb in the root directory of your application.  Fill it out like this:
+
+    # Any gems that you put in the Gemfile should also be listed here.
+    # The rake metrics:outdated_gems task calculates which gems are
+    # outdated and then combines that information with the information
+    # listed here about a particular gem's reach in the application code.
+    #
+    GemFresh::Config.configure do |gems|
+
+      # Updating these gems could require you to make large, system-wide changes
+      # to the application code.
+      gems.with_system_wide_impact %w(
+        resque
+        rspec
+        ...
+      )
+
+      # Updating these gems could require you to make some changes to small
+      # sections of the application.
+      gems.with_local_impact %w(
+        fog
+        tabulous
+        ...
+      )
+
+      # When updating these gems, you barely have to touch any code at all.
+      gems.with_minimal_impact %w(
+        airbrake
+        bullet
+        ...
+      )
+
+      # We ignore these since we are in complete control of their update cycles.
+      gems.that_are_private %w(
+        dmc_server_admin
+        job_state
+        ...
+      )
+
+    end
+
+Then create a rake task like this:
+
+    namespace :metrics do
+      desc "display outdated gem version metrics"
+      task :outdated_gems do
+        GemFresh::Reporter.new.report
+      end
+    end
+
+
+## Usage
+
+See information on your outdated gems by running the rake task:
+
+    rake metrics:outdated_gems
+
+This combines information from `bundle outdated` with the information in GemFresh.rb to give a weighted view as to how outdated your third-party Ruby code is and how much it matters.
+
+Whenever you add a gem to your Gemfile, add it to GemFresh.rb so that the rake task knows how important the gem is.
+
+Gems are assigned points.  The more central a gem is, and the more outdated it is, the higher the points.  You can think of the points as a "bounty" on the gem, telling you how badly it needs to be updated.
+

data/Rakefile

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

data/gemfresh.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gem_fresh/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gem_fresh"
+  spec.version       = GemFresh::VERSION
+  spec.authors       = ["Anne Geiersbach"]
+  spec.email         = ["annasazi@gmail.com"]
+
+  spec.summary       = %q{Quantifying the freshness of your gems.}
+  spec.homepage      = "https://github.com/dmcouncil/gem_fresh"
+  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_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/gem_fresh/calculator.rb

@@ -0,0 +1,67 @@
+module GemFresh
+  class Calculator
+
+    # If a gem is behind by a major version, it's worth more points
+    # than a minor version.
+    POINTS_FOR_MAJOR = 100
+    POINTS_FOR_MINOR = 10
+    POINTS_FOR_PATCH = 1
+
+    # Point multipliers based on how central the gem is to the application code.
+    MINIMAL_MULTIPLIER = 0.1
+    LOCAL_MULTIPLIER  = 1
+    SYSTEM_MULTIPLIER = 10
+    FRAMEWORK_MULTIPLIER = 100
+
+    def initialize
+      @freshness_scores = {}
+    end
+
+    def calculate!
+      @gem_freshness_info = GemFresh::Outdated.new.gem_info
+      calculate_freshness_scores_for_each_gem
+    end
+
+    def total_score
+      @freshness_scores.values.sum.round(1)
+    end
+
+    def all_scores
+      @freshness_scores
+    end
+
+  private
+
+    def calculate_freshness_scores_for_each_gem
+      calculate_for_gems(['rails'], FRAMEWORK_MULTIPLIER)
+      calculate_for_gems(Config.config.system_wide_gems, SYSTEM_MULTIPLIER)
+      calculate_for_gems(Config.config.local_gems, LOCAL_MULTIPLIER)
+      calculate_for_gems(Config.config.minimal_gems, MINIMAL_MULTIPLIER)
+    end
+
+    def calculate_for_gems(gems, multiplier)
+      gems.each do |gem_name|
+        @freshness_scores[gem_name] =
+         (calculate_freshness_score_for(gem_name) * multiplier).round(1)
+      end
+    end
+
+    def calculate_freshness_score_for(gem_name)
+      info = @gem_freshness_info[gem_name]
+      return 0 if info.nil?  # no outdated info means it's fresh
+      major_diff = (info[:available_version].major - info[:current_version].major)
+      minor_diff = (info[:available_version].minor - info[:current_version].minor)
+      patch_diff = (info[:available_version].patch - info[:current_version].patch)
+      score = 0
+      if major_diff > 0
+        score += major_diff * POINTS_FOR_MAJOR
+      elsif minor_diff > 0
+        score += minor_diff * POINTS_FOR_MINOR
+      elsif patch_diff > 0
+        score += patch_diff * POINTS_FOR_PATCH
+      end
+      score
+    end
+
+  end
+end

data/lib/gem_fresh/config.rb

@@ -0,0 +1,52 @@
+module GemFresh
+  class Config
+
+    attr_reader :system_wide_gems, :local_gems, :minimal_gems, :private_gems
+
+    def self.configure(&block)
+      @@config ||= Config.new
+      block.call(@@config)
+    end
+
+    def self.config
+      @@config ||= begin
+        config = Config.new
+        config.with_system_wide_impact([])
+        config.with_local_impact([])
+        config.with_minimal_impact([])
+        config.that_are_private([])
+        config
+      end
+    end
+
+    def with_system_wide_impact(gems)
+      @system_wide_gems = clean_gems(gems)
+    end
+
+    def with_local_impact(gems)
+      @local_gems = clean_gems(gems)
+    end
+
+    def with_minimal_impact(gems)
+      @minimal_gems = clean_gems(gems)
+    end
+
+    def that_are_private(gems)
+      @private_gems = clean_gems(gems)
+    end
+
+    def all_gems
+      @system_wide_gems + @local_gems + @minimal_gems + @private_gems
+    end
+
+  private
+
+    def clean_gems(gems)
+      if gems.include?('rails')
+        raise "Do not explicitly specify the rails gem in Gemfresh.rb." #TODO: why not?
+      end
+      gems
+    end
+
+  end
+end

data/lib/gem_fresh/gem_version.rb

@@ -0,0 +1,13 @@
+module GemFresh
+  class GemVersion
+    attr_reader :major, :minor, :patch
+
+    # version_string is usually formatted like 7.6.2, but could be
+    # 7.6.2.11, 7.6, or even 7.6.2.beta. We just care about the first
+    # three numbers
+    def initialize(version_string)
+      @major, @minor, @patch = version_string.split('.').map(&:to_i)
+      @patch ||= 0
+    end
+  end
+end

data/lib/gem_fresh/missing.rb

@@ -0,0 +1,48 @@
+module GemFresh
+  class Missing
+
+    def initialize
+      parse_gemfile
+    end
+
+    def check_for_missing_gems!
+      if missing_gems.any?
+        message = "The following gems are in your Gemfile but not in your Gemfresh.rb file:\n"
+        missing_gems.each do |gem_name|
+          message << "  #{gem_name}\n"
+        end
+        raise message
+      end
+    end
+
+  private
+
+    def missing_gems
+      missing_gems = []
+      gems_from_gemfresh = gemfresh.all_gems
+      gem_names.each do |gem_from_gemfile|
+        if not gems_from_gemfresh.include?(gem_from_gemfile)
+          missing_gems << gem_from_gemfile
+        end
+      end
+      missing_gems.reject!{|g| g == 'rails'}
+      missing_gems
+    end
+
+    def gem_names
+      @gem_lines.map do |gem_line|
+        gem_line.split.second.gsub(/[^A-Za-z0-9\-_]/, '')
+      end
+    end
+
+    #TODO: we shouldn't be so tied to Rails in future
+    def parse_gemfile
+      gemfile = File.join(Rails.root, 'Gemfile')
+      @gem_lines = IO.readlines(gemfile).select{|line| line =~ /\A\s*gem/ }
+    end
+
+    def gemfresh
+      GemFresh::Config.config
+    end
+  end
+end

data/lib/gem_fresh/outdated.rb

@@ -0,0 +1,48 @@
+module GemFresh
+  class Outdated
+
+    attr_reader :gem_info
+
+    def initialize
+      figure_out_outdated_gems
+    end
+
+  private
+
+    def figure_out_outdated_gems
+      @gem_info ={}
+      raw_gem_info_from_bundler.each do |line|
+        #
+        # Sample lines from `bundle outdated` look like this:
+        #
+        #   * airbrake (4.1.0 > 3.1.3)
+        #   * annotate (2.6.5 > 2.6.0.beta2) Gemfile specifies "= 2.6.0.beta2"
+        #   * bootstrap-multiselect-rails (0.9.5 > 0.0.4)
+        #   * byebug (3.5.1 > 2.5.0)
+        #   * enum_field (0.2.0 bff7873 > 0.2.0)
+        # or this:
+        #   * responders (newest 2.1.0, installed 1.1.2) in group "default"
+        #   * resque-retry (newest 1.4.0, installed 1.3.2) in group "default"
+        #   * resque-status (newest 0.5.0, installed 0.4.1, requested = 0.4.1) in group "default"
+        #   * rspec (newest 3.3.0, installed 3.2.0, requested ~> 3.2.0) in groups "development, test"
+        #
+        words = line.split
+        words_that_contain_version_numbers = words.select {|word| word =~ /\d+\.\d+/ }
+        version_numbers = words_that_contain_version_numbers.map {|word| word.gsub(/[\(\),]/, '') }
+        line =~ /\A\s*\*\s+(\S+)/
+        gem_name = $1
+        @gem_info[gem_name] = { available_version: GemVersion.new(version_numbers[0]),
+                                current_version: GemVersion.new(version_numbers[1]) }
+     end
+    end
+
+    def raw_gem_info_from_bundler
+      output = %x{ bundle outdated }
+      just_the_gem_lines = output.split("\n").map(&:strip).select do |line|
+        line =~ /\A\s*\*\s+\w/
+      end
+      just_the_gem_lines
+    end
+
+  end
+end

data/lib/gem_fresh/railtie.rb

@@ -0,0 +1,21 @@
+require 'gem_fresh'
+require 'rails'
+
+module GemFresh
+  class Railtie < Rails::Railtie
+    railtie_name :gem_fresh
+
+    puts "Woohoo, a GemFresh Railtie"
+    puts "env? #{Rails.env}"
+    puts GemFresh::Config.config
+
+    rake_tasks do
+      namespace :gem_fresh do
+        desc "outdated"
+        task :outdated => :environment do
+          GemFresh::Reporter.new.report
+        end
+      end
+    end
+  end
+end

data/lib/gem_fresh/reporter.rb

@@ -0,0 +1,36 @@
+module GemFresh
+  class Reporter
+
+    def initialize
+      Missing.new.check_for_missing_gems!
+      @calculator = Calculator.new
+      @calculator.calculate!
+    end
+
+    def report
+      puts
+      puts "A bounty is calculated for each gem based on how outdated the gem"
+      puts "is and the impact the gem has on the application code.  Foundational"
+      puts "gems like RSpec get a higher bounty, simple add-on tools like bullet"
+      puts "get a lower bounty.  See Gemfresh.rb for details."
+      puts
+      puts "The total bounty is #{@calculator.total_score} points."
+      puts
+      puts "These are the outdated gems, sorted by highest bounty:"
+      puts
+      sorted_scores = @calculator.all_scores.sort_by{|gem_name, score| [-score, gem_name]}
+      sorted_scores.each do |gem_name, score|
+        name = "  #{gem_name.ljust(25)[0..24]} "
+        if score >= 1000
+          puts "#{name} #{score}"
+        elsif score > 0
+          puts "#{name} #{score}"
+        else
+          puts "#{name} up to date"
+        end
+      end
+      puts
+    end
+
+  end
+end

data/lib/gem_fresh/version.rb

@@ -0,0 +1,3 @@
+module GemFresh
+  VERSION = "0.1.0"
+end

data/lib/gem_fresh.rb

@@ -0,0 +1,8 @@
+require "gem_fresh/version"
+require "gem_fresh/calculator"
+require "gem_fresh/config"
+require "gem_fresh/gem_version"
+require "gem_fresh/missing"
+require "gem_fresh/outdated"
+require "gem_fresh/railtie" if defined?(Rails)
+require "gem_fresh/reporter"

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: gem_fresh
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anne Geiersbach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: 
+email:
+- annasazi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfresh.gemspec
+- lib/gem_fresh.rb
+- lib/gem_fresh/calculator.rb
+- lib/gem_fresh/config.rb
+- lib/gem_fresh/gem_version.rb
+- lib/gem_fresh/missing.rb
+- lib/gem_fresh/outdated.rb
+- lib/gem_fresh/railtie.rb
+- lib/gem_fresh/reporter.rb
+- lib/gem_fresh/version.rb
+homepage: https://github.com/dmcouncil/gem_fresh
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Quantifying the freshness of your gems.
+test_files: []