cutting_edge 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 374d8036819a980b91ba6a3ca1ed76afac1432c44533544d4f5f8d5ab8abb721
-  data.tar.gz: 38a4d5f3b19c65929e26477a9b093029e75ded17ef577dfcf5059d33ced8c197
+  metadata.gz: 9345fa39664217f3d25636af4855abfa9f4e684237c0038fbeb4fa57e83ec40d
+  data.tar.gz: de6eaa52e75463fed82b1aae4723e6685a80522086ed28cc3a8ded7e6b3189cb
 SHA512:
-  metadata.gz: 6961bd941782441ad05e4462ef3b20053800a2612490e8cadc2f2fcdafe06904fe64b03f00b36471b921ef62ef1b235c698c685a7bac71730776fd854102babe
-  data.tar.gz: efaeb201b0558e759abb93003ebadc4793622f6a327563f9517355d05bcdb9ea13cc7664a29eb2baebf085ceffae1ca5a6e65dccdf84800575996463923c8796
+  metadata.gz: c866cf8788242847e16b65f0b8a21481b5b57df936241d9bdf68044d62d55083d12dc827f6eeedd4978716ad131a2ac7993ea2ad0f6b6a23a150dc35f4ca6359
+  data.tar.gz: afcee66340cc2f542d45ab6bb4f5a5427d57c69ec7d925f49f22909cf2c0de2f767b8ecf8ab4b295dba6f514177309607ad1a185455f257a35ff40884b802652

data/Gemfile

@@ -2,8 +2,6 @@ source 'https://rubygems.org'
 
 gem 'redis', require: false
 
-gem 'hashdiff'
-
 group :development do
   gem 'rspec', '~> 3.9'
   gem 'simplecov'

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    cutting_edge (0.1)
+    cutting_edge (0.2)
       gemnasium-parser (~> 0.1.9)
+      hashdiff (~> 1.0)
       http (~> 4.3)
       mail (~> 2.7)
       moneta (~> 1.2)
@@ -120,7 +121,6 @@ PLATFORMS
 DEPENDENCIES
   coveralls (~> 0.8.23)
   cutting_edge!
-  hashdiff
   rack-test
   redis
   rspec (~> 3.9)

data/config.rb

@@ -19,7 +19,8 @@ module CuttingEdge
     Of course, you can also File.read it from a separate template file.
     See lib/cutting_edge/templates/mail.html.erb for the default template, and the available variables.
 EOF
-
+  ALWAYS_MAIL = true # Send e-mail notifications even on a first run (when no information on *changes* in dependency status is available). Default: false
+  
   SECRET_TOKEN = 'mysecrettoken' # Global administrative secret
 
   LAST_VERSION_TIMEOUT = 5 # Number of seconds after which to fail when trying to determine the latest version for a dependency.

data/cutting_edge.gemspec

@@ -5,8 +5,8 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.4'
 
   s.name              = 'cutting_edge'
-  s.version           = '0.1'
-  s.date              = '2020-11-02'
+  s.version           = '0.2'
+  s.date              = '2020-12-05'
   s.license           = 'GPL-3.0-only'
 
   s.summary     = 'Self-hosted dependency monitoring, including shiny badges.'
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.executables = ['cutting_edge']
 
   s.add_dependency 'gemnasium-parser', '~> 0.1.9'
+  s.add_dependency 'hashdiff', '~> 1.0'
   s.add_dependency 'http', '~> 4.3'
   s.add_dependency 'sucker_punch', '~> 2.1'
   s.add_dependency 'sinatra', '~> 2.0'
@@ -81,6 +82,7 @@ Gem::Specification.new do |s|
     spec/langs/rust_spec.rb
     spec/repo_spec.rb
     spec/spec_helper.rb
+    spec/worker_helper_spec.rb
   ]
   # = MANIFEST =
 end

data/lib/cutting_edge.rb

@@ -1,3 +1,3 @@
 module CuttingEdge
-  VERSION = '0.1'
-end
+  VERSION = '0.2'
+end

data/lib/cutting_edge/app.rb

@@ -55,6 +55,7 @@ module CuttingEdge
   SERVER_URL = "http://#{SERVER_HOST}" unless defined?(SERVER_URL)
   MAIL_TO = false unless defined?(MAIL_TO) # Default address to send email to. If set to false, don't send any e-mails except for repositories that have their 'email' attribute set.
   MAIL_FROM = "cutting_edge@#{SERVER_HOST}" unless defined?(MAIL_FROM)
+  ALWAYS_MAIL = false unless defined?(ALWAYS_MAIL)
    
   class App < Sinatra::Base
     include CuttingEdgeHelpers
@@ -105,7 +106,9 @@ module CuttingEdge
       @name = name
       @svg = url("/#{source}/#{org}/#{name}/svg")
       @svg = "#{@svg}?token=#{@repo.hidden_token}" if @repo.hidden?
-      @md = "[![Cutting Edge Dependency Status](#{@svg} 'Cutting Edge Dependency Status')](#{url("/#{source}/#{org}/#{name}/info")})"
+      info = url("/#{source}/#{org}/#{name}/info")
+      info = "#{info}?token=#{@repo.hidden_token}" if @repo.hidden?
+      @md = "[![Cutting Edge Dependency Status](#{@svg} 'Cutting Edge Dependency Status')](#{info})"
       @colors = {ok: 'green', outdated_patch: 'yellow', outdated_minor: 'orange', outdated_major: 'red', unknown: 'gray'}
       @specs = @store[@repo.identifier]
       @project_url = @repo.url_for_project

data/lib/cutting_edge/templates/mail.html.erb

@@ -133,7 +133,7 @@
                               <b><%= type.to_s.split('_').collect(&:capitalize).join(' ') %></b>:
                                 <ul>
                                 <% dependencies.each do |dependency| %>
-                                    <li><%= dependency[:name] %> <%= dependency[:required] %> (latest: <%= dependency[:latest] %>)</li>
+                                    <li<% if color = diff[dependency[:name]] %> style="color:<%= color %>;"<% end %>><%= dependency[:name] %> <%= dependency[:required] %> (latest: <%= dependency[:latest] %>)</li>
                                 <% end %>
                                 </ul>
                             </ul>

data/lib/cutting_edge/workers/dependency.rb

@@ -3,6 +3,7 @@ require 'http'
 require File.expand_path('../../versions.rb', __FILE__)
 require File.expand_path('../../langs.rb', __FILE__)
 require File.expand_path('../helpers.rb', __FILE__)
+require 'hashdiff'
 
 class DependencyWorker < GenericWorker
   include VersionRequirementComparator
@@ -10,13 +11,14 @@ class DependencyWorker < GenericWorker
   # Order is significant for purposes of calculating results[:outdated]
   STATUS_TYPES = [:outdated_major, :outdated_minor, :outdated_patch, :ok, :no_requirement, :unknown]
   OUTDATED_TYPES = STATUS_TYPES[0..-4] # Which types indicate an outdated dependency. Used to calculate the total number of out-of-date dependencies.
-
+  EMPTY_STATUS_HASH = STATUS_TYPES.inject({}){|result, type| result[type] = []; result}
+  
   def perform(identifier, lang, locations, dependency_types, to_addr, auth_token = nil)
     log_info 'Running Worker!'
     @lang = get_lang(lang)
     @provider = get_provider(identifier)
     @auth_token = auth_token
-    old_dependencies = get_from_store(identifier)
+    old_dependencies = get_from_store(identifier) || {}
     begin
       dependencies = {:locations => {}}
       locations.each do |name, url|
@@ -25,21 +27,60 @@ class DependencyWorker < GenericWorker
       end
       dependencies.merge!(generate_stats(dependencies[:locations]))
       @nothing_changed = dependencies == old_dependencies
-      add_to_store(identifier, dependencies) unless @nothing_changed
+      unless @nothing_changed
+        add_to_store(identifier, dependencies)
+        add_to_store("diff-#{identifier}", diff_dependencies(old_dependencies[:locations], dependencies[:locations]))
+      end
     ensure
       unless @nothing_changed
         badge_worker(identifier)
-        mail_worker(identifier, to_addr) if to_addr
+        mail_worker(identifier, to_addr) if to_addr && (!old_dependencies.empty? || ::CuttingEdge::ALWAYS_MAIL)
       end
       GC.start
     end
   end
 
   private
-
+  
+  def diff_dependencies(old, new)
+    base = old ? old : new.transform_values {|_v| empty_status_hash }
+    diff = Hashdiff.diff(base, new)
+    additions = diff.select {|x| x.first == '+'}
+    deletions = diff.select {|x| x.first == '-'}
+    result = {}
+    
+    additions.each do |addition|
+      status = parse_diff_status(addition[1])
+      name = addition.last[:name]
+      old_status = deletions.find {|x| x.last[:name] == name}
+      old_status = parse_diff_status(old_status[1]) if old_status
+      result[name] = change_type(old_status, status)
+    end
+    result
+  end
+  
+  def parse_diff_status(str)
+    # Hashdiff generates strings of the form "gemfile.ok[1]" to indicate this is the first change to the Hash under the :ok key
+    str.split('.').last.split('[').first.to_sym
+  end
+  
+  def change_type(old_status, new_status)
+    case
+    when new_status == :ok
+      :good_change
+    when outdated_type?(new_status) && old_status && STATUS_TYPES.find_index(new_status) > STATUS_TYPES.find_index(old_status)
+      :good_change
+    else
+      :bad_change
+    end
+  end
+  
+  def empty_status_hash
+    STATUS_TYPES.inject({}) {|result, type| result[type] = []; result }
+  end
+  
   def get_results(dependencies, dependency_types)
-    results = {}
-    STATUS_TYPES.each {|type| results[type] = []}
+    results = empty_status_hash
     if dependencies
       dependencies.select! {|dep| dependency_types.include?(dep.first.type)}
       dependencies.each do |dep, latest_version|

data/lib/cutting_edge/workers/helpers.rb

@@ -7,14 +7,18 @@ module WorkerHelpers
     logger.info(message) if ::CuttingEdge::App.enable_logging
   end
 
-  def add_to_store(identifier, dependencies)
-    ::CuttingEdge::App.store[identifier] = dependencies
+  def add_to_store(identifier, data)
+    ::CuttingEdge::App.store[identifier] = data
   end
 
   def get_from_store(identifier)
     ::CuttingEdge::App.store[identifier]
   end
   
+  def delete_from_store(identifier)
+    ::CuttingEdge::App.store.delete(identifier)
+  end
+  
   def badge_worker(identifier)
     BadgeWorker.perform_async(identifier)
   end
@@ -22,7 +26,7 @@ module WorkerHelpers
   def mail_worker(identifier, to_address)
     MailWorker.perform_async(identifier, to_address)
   end
-
+  
 end
 
 class GenericWorker

data/lib/cutting_edge/workers/mail.rb

@@ -15,6 +15,12 @@ class MailWorker < GenericWorker
       log_info("Failed to execute email job for #{identifier}: #{dependencies ? dependencies : 'No dependencies found.'} #{'No e-mail address set.' if to_addr.nil?}")
       return nil
     end
+    
+    if diff = delete_from_store("diff-#{identifier}")
+      diff.transform_values! {|v| v == :good_change ? 'green' : 'red' }
+    else
+      diff = {}
+    end
 
     Mail.deliver do
       from     "CuttingEdge <#{CuttingEdge::MAIL_FROM}>"
@@ -30,6 +36,7 @@ class MailWorker < GenericWorker
         body  ERB.new(CuttingEdge::MAIL_TEMPLATE).result_with_hash(
           project: identifier,
           url: CuttingEdge::SERVER_URL,
+          diff: diff,
           specs: dependencies
         )
       end

data/spec/dependency_worker_spec.rb

@@ -29,7 +29,7 @@ describe DependencyWorker do
   let(:new_dependencies) {
     mock_dependencies('gollum-updated')
   }
-  
+
   context 'http fetching files' do
     let(:response_ok) { MockResponse.new(200, 'body') }
     let(:response_not_found) { MockResponse.new(404, 'Not found') }
@@ -91,10 +91,11 @@ describe DependencyWorker do
     }
     
     context 'when the dependencies have changed' do
+      let(:dependency_diff) {  {'foobar' => :bad_change, 'gollum-lib' => :bad_change, 'kramdown-parser-gfm' => :good_change} }
     
       before(:each) {
         locations.each_key do |loc|
-          expect(RubyLang).to receive(:parse_file).with(loc, 'fake').and_return(mock_fetched_requirements('gollum', loc, true))
+          expect(RubyLang).to receive(:parse_file).with(loc, 'fake').and_return(mock_fetched_requirements('gollum-updated', loc))
         end
         expect(worker).to receive(:badge_worker).with(identifier).and_return(true)
         expect(worker).to receive(:mail_worker).with(identifier, test_email).and_return(true)
@@ -102,6 +103,7 @@ describe DependencyWorker do
     
       it 'updates the store with newest dependencies' do
         expect(worker).to receive(:add_to_store).with(identifier, new_dependencies).and_return(true)
+        expect(worker).to receive(:add_to_store).with("diff-#{identifier}", dependency_diff).and_return(true)
         expect(worker.instance_variable_get(:@nothing_changed)).to be_nil
         worker.perform(identifier, lang, locations, dependency_types, test_email)
         expect(worker.instance_variable_get(:@nothing_changed)).to be false
@@ -113,7 +115,7 @@ describe DependencyWorker do
     
       before(:each) {
         locations.each_key do |loc|
-          expect(RubyLang).to receive(:parse_file).with(loc, 'fake').and_return(mock_fetched_requirements('gollum', loc, false))
+          expect(RubyLang).to receive(:parse_file).with(loc, 'fake').and_return(mock_fetched_requirements('gollum', loc))
         end
         expect(worker).not_to receive(:badge_worker)
         expect(worker).not_to receive(:mail_worker)

data/spec/email_worker_spec.rb

@@ -7,37 +7,73 @@ describe MailWorker do
   let(:worker) { MailWorker.new }
   let(:identifier) { 'github/repotag/cutting_edge' }
   let(:test_email) { 'cutting_edge@localhost' }
+  let(:diff) { {'foobar' => :good_change, 'gollum-lib' => :good_change, 'kramdown-parser-gfm' => :bad_change} }
   let(:dependencies) {
     mock_dependencies('gollum')
   }
   
-  before(:each) {
-    expect(worker).to receive(:get_from_store).with(identifier).and_return(dependencies)
-  }
-  
-  it 'returns nil when to address is nil ' do  
-    expect(worker.perform(identifier, nil)).to eq nil
-  end
+  context 'without dependencies' do
+    before(:each) {
+      expect(worker).to receive(:get_from_store).with(identifier).and_return(nil)
+    }
+    
+    it 'returns nil' do
+      expect(worker.perform(identifier, test_email)).to eq nil
+    end
+  end 
   
-  it 'sends an update mail' do
-    expect(Mail::TestMailer.deliveries).to be_empty
-    worker.perform(identifier, test_email)
-    expect(Mail::TestMailer.deliveries).to_not be_empty
+  context 'with valid dependencies' do
+    before(:each) {
+      expect(worker).to receive(:get_from_store).with(identifier).and_return(dependencies)
+    }
+    
+    after(:each) {
+      Mail::TestMailer.deliveries.clear
+    }
     
-    mail = Mail::TestMailer.deliveries.first
-    expect(mail.from.first).to eq 'cutting_edge@localhost'
-    expect(mail.to.first).to eq test_email
-    expect(mail.subject).to eq  "Dependency Status Changed For #{identifier}"
+    it 'returns nil for invalid email' do
+      expect(worker.perform(identifier, nil)).to eq nil
+    end
     
-    body = mail.body
-    expect(body.parts.length).to eq 2
+    it 'handles nil for diff' do
+      params = {
+        project: identifier,
+        url: CuttingEdge::SERVER_URL,
+        diff: {},
+        specs: dependencies
+      }
+      expect(worker).to receive(:delete_from_store).with("diff-#{identifier}").and_return(nil)
+      expect_any_instance_of(ERB).to receive(:result_with_hash).with(params).and_call_original
+      worker.perform(identifier, test_email)
+    end
     
-    html_body = body.parts.last.to_s
-    expect(html_body).to start_with('Content-Type: text/html')
-    expect(html_body).to include('This is <a href="http://localhost">CuttingEdge</a> informing you')
-    expect(html_body).to include("<a href=\"http://localhost/#{identifier}/info\">#{identifier}</a>")
-    expect(html_body).to include('In <b>gollum.gemspec</b>:')
-    expect(html_body).to include('<b>Outdated Major</b>:')
-    expect(html_body).to include('<li>rake ~> 12.3, >= 12.3.3 (latest: 13.0.1)</li>')
+    context 'with valid diff' do
+      before(:each) {
+        expect(worker).to receive(:delete_from_store).with("diff-#{identifier}").and_return(diff)
+      }
+  
+      it 'sends an update mail' do
+        expect(Mail::TestMailer.deliveries).to be_empty
+        worker.perform(identifier, test_email)
+        expect(Mail::TestMailer.deliveries).to_not be_empty
+        
+        mail = Mail::TestMailer.deliveries.first
+        expect(mail.from.first).to eq 'cutting_edge@localhost'
+        expect(mail.to.first).to eq test_email
+        expect(mail.subject).to eq  "Dependency Status Changed For #{identifier}"
+        
+        body = mail.body
+        expect(body.parts.length).to eq 2
+        
+        html_body = body.parts.last.to_s
+        expect(html_body).to start_with('Content-Type: text/html')
+        expect(html_body).to include('This is <a href="http://localhost">CuttingEdge</a> informing you')
+        expect(html_body).to include("<a href=\"http://localhost/#{identifier}/info\">#{identifier}</a>")
+        expect(html_body).to include('In <b>gollum.gemspec</b>:')
+        expect(html_body).to include('<b>Outdated Major</b>:')
+        expect(html_body).to include('<li>rake ~> 12.3, >= 12.3.3 (latest: 13.0.1)</li>')
+        expect(html_body).to include('<li style="color:green;">foobar = 1.0 (latest: 1.0)</li>')
+      end
+    end
   end
 end

data/spec/fixtures.rb

@@ -106,11 +106,6 @@ def mock_dependencies(name)
                 :latest=>'10.6.0',
                 :type=>:runtime,
                 :url=>'https://rubygems.org/gems/octicons'},
-               {:name=>'kramdown-parser-gfm',
-                :required=>'~> 1.0.0',
-                :latest=>'2.1.0',
-                :type=>:runtime,
-                :url=>'https://rubygems.org/gems/kramdown-parser-gfm'},
                {:name=>'gollum-lib',
                 :required=>'~> 5.0',
                 :latest=>'6.0.3',
@@ -123,7 +118,12 @@ def mock_dependencies(name)
                 :url=>'https://rubygems.org/gems/foobar'}],
              :outdated_minor=>[],
              :outdated_patch=>[],
-             :ok=>[],
+             :ok=>
+               [{:name=>'kramdown-parser-gfm',
+                 :required=>'~> 2.1.0',
+                 :latest=>'2.1.0',
+                 :type=>:runtime,
+                 :url=>'https://rubygems.org/gems/kramdown-parser-gfm'}],
              :no_requirement=>[],
              :unknown=>[]},
            'Gemfile'=>
@@ -144,12 +144,12 @@ def mock_dependencies(name)
              :no_requirement=>[],
              :unknown=>[]}},
          :no_requirement=>0,
-         :ok=>1,
+         :ok=>2,
          :outdated=>:outdated_major,
-         :outdated_major=>6,
+         :outdated_major=>5,
          :outdated_minor=>0,
          :outdated_patch=>0,
-         :outdated_total=>6,
+         :outdated_total=>5,
          :unknown=>0,
          :no_requirement => 0
       }

data/spec/worker_helper_spec.rb

@@ -0,0 +1,31 @@
+describe WorkerHelpers do
+  include WorkerHelpers
+  let(:id) { 'foo' }
+  let(:data) {'bar'}
+  let(:address) {'test@test.com'}
+  
+  it 'gets from store' do
+    expect(::CuttingEdge::App.store).to receive(:[]).with(id).and_return(true)
+    expect(get_from_store(id)).to be true
+  end
+  
+  it 'deletes from store' do
+    expect(::CuttingEdge::App.store).to receive(:delete).with(id).and_return(true)
+    expect(delete_from_store(id)).to eq true
+  end
+  
+  it 'adds to store' do
+    expect(::CuttingEdge::App.store).to receive(:[]=).with(id, data).and_return(data)
+    expect(add_to_store(id, data)).to eq data
+  end
+  
+  it 'runs BadgeWorker' do
+    expect(BadgeWorker).to receive(:perform_async).with(id).and_return(true)
+    expect(badge_worker(id)).to eq true
+  end
+  
+  it 'runs MailWorker' do
+    expect(MailWorker).to receive(:perform_async).with(id, address).and_return(true)
+    expect(mail_worker(id, address)).to eq true
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cutting_edge
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Dawa Ometto
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-02 00:00:00.000000000 Z
+date: 2020-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemnasium-parser
@@ -25,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.9
+- !ruby/object:Gem::Dependency
+  name: hashdiff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +207,7 @@ files:
 - spec/langs/rust_spec.rb
 - spec/repo_spec.rb
 - spec/spec_helper.rb
+- spec/worker_helper_spec.rb
 homepage: http://github.com/repotag/cutting_edge
 licenses:
 - GPL-3.0-only