update_hints 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2011-05-25
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/update_hints.rb
+test/sample.xml
+test/test_update_hints.rb

data/README.txt

@@ -0,0 +1,48 @@
+= update_hints
+
+* http://github.com/julik/update_hints
+
+== DESCRIPTION:
+
+Quickly checks rubygems.org for a new version o a given gem and advises the user on STDERR to install an update
+
+== FEATURES/PROBLEMS:
+
+* Probably some problems with networking if networking fails
+
+== SYNOPSIS:
+
+  UpdateHints.version_check("my_fabulous_gem", MyFabulousGem::VERSION)
+  
+== REQUIREMENTS:
+
+* Ruby 1.8.6+
+
+== INSTALL:
+
+* sudo gem install update_hints
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Julik Tarkhanov
+
+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/Rakefile

@@ -0,0 +1,11 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'update_hints' do | s |
+  s.developer('Julik Tarkhanov', 'me@julik.nl')
+  s.extra_dev_deps = {"flexmock" => ">=0"}
+end
+
+# vim: syntax=ruby

data/lib/update_hints.rb

@@ -0,0 +1,56 @@
+require "net/http"
+require "open-uri"
+require "timeout"
+require "rexml/document"
+
+module UpdateHints
+  VERSION = '1.0.0'
+  GEMCUTTER_URI = "http://rubygems.org/api/v1/gems/%s.xml"
+  
+  # Checks whether rubygems.org has a new version of this specific gem
+  # and prints how an update can be obtained if need be.
+  # Note: it swallows ANY exception to prevent network-related errors when for some
+  # reason the method is run while the app is offline
+  def self.version_check(gem_name, present_version_str, destination = $stderr)
+    begin
+      latest_version = extract_version_from_xml(open(GEMCUTTER_URI % gem_name))
+      int_present, int_available = Version.new(present_version_str), Version.new(latest_version)
+      if int_available > int_present
+        destination << "Your version of #{gem_name} is probably out of date\n"
+        destination << "(the current version is #{latest_version}, but you have #{present_version_str}).\n"
+        destination << "Please consider updating (run `gem update #{gem_name}`)"
+      end
+    rescue Exception
+    end
+  end
+  
+  private
+  
+  # For stubbing
+  def self.open(*any)
+    super
+  end
+  
+  #:nodoc:
+  class Version
+    include Comparable
+    
+    attr_reader :major, :minor, :tiny
+    def initialize(version_str)
+      @major, @minor, @tiny = version_str.split(".").map{|e| e.to_i }
+    end
+    
+    def <=>(other)
+      [:major, :minor, :tiny].each do | ver_part |
+        mine, theirs = send(ver_part), other.send(ver_part)
+        return mine <=> theirs unless mine == theirs
+      end
+      return 0
+    end
+  end
+  
+  def self.extract_version_from_xml(io)
+    doc = REXML::Document.new(io)
+    version_text = doc.elements["rubygem/version"].text
+  end
+end

data/test/sample.xml

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<rubygem>
+  <dependencies>
+    <runtime type="array">
+      <dependency>
+        <name>progressbar</name>
+        <requirements>&gt;= 0</requirements>
+      </dependency>
+    </runtime>
+    <development type="array">
+      <dependency>
+        <name>hoe</name>
+        <requirements>&gt;= 2.9.1</requirements>
+      </dependency>
+      <dependency>
+        <name>flexmock</name>
+        <requirements>&gt;= 0</requirements>
+      </dependency>
+    </development>
+  </dependencies>
+  <name>tracksperanto</name>
+  <downloads type="integer">14827</downloads>
+  <info>Tracksperanto is a universal 2D-track translator between many apps.</info>
+  <version-downloads type="integer">15</version-downloads>
+  <version>2.4.1</version>
+  <homepage-uri>http://guerilla-di.org/tracksperanto</homepage-uri>
+  <bug-tracker-uri nil="true"></bug-tracker-uri>
+  <source-code-uri nil="true"></source-code-uri>
+  <gem-uri>http://rubygems.org/gems/tracksperanto-2.4.1.gem</gem-uri>
+  <project-uri>http://rubygems.org/gems/tracksperanto</project-uri>
+  <authors>Julik Tarkhanov</authors>
+  <mailing-list-uri nil="true"></mailing-list-uri>
+  <documentation-uri nil="true"></documentation-uri>
+  <wiki-uri nil="true"></wiki-uri>
+</rubygem>

data/test/test_update_hints.rb

@@ -0,0 +1,29 @@
+require "test/unit"
+require "update_hints"
+require 'rubygems'
+require 'flexmock'
+require 'flexmock/test_unit'
+
+class TestUpdateHints < Test::Unit::TestCase
+  def test_nothing_raised_on_nonexisting_gem
+    assert_nothing_raised { UpdateHints.version_check(">>nonexisting<<", "123") }
+  end
+  
+  def test_version_check_properly_output
+    xml = File.open(File.dirname(__FILE__) + "/sample.xml")
+    output = ''
+    flexmock(UpdateHints).should_receive(:open).with("http://rubygems.org/api/v1/gems/tracksperanto.xml").once.and_return(xml)
+    
+    UpdateHints.version_check("tracksperanto", "1.2.3", output)
+    assert_equal "Your version of tracksperanto is probably out of date\n(the current version is 2.4.1, but you have 1.2.3).\nPlease consider updating (run `gem update tracksperanto`)", output
+  end
+  
+  def test_version_check_stays_silent_on_success
+    xml = File.open(File.dirname(__FILE__) + "/sample.xml")
+    output = ''
+    flexmock(UpdateHints).should_receive(:open).with("http://rubygems.org/api/v1/gems/tracksperanto.xml").once.and_return(xml)
+    UpdateHints.version_check("tracksperanto", "2.4.1", output)
+    assert_equal "", output
+  end
+  
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: update_hints
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-25 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: flexmock
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 41
+        segments: 
+        - 2
+        - 9
+        - 1
+        version: 2.9.1
+  type: :development
+  version_requirements: *id002
+description: Quickly checks rubygems.org for a new version o a given gem and advises the user on STDERR to install an update
+email: 
+- me@julik.nl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/update_hints.rb
+- test/sample.xml
+- test/test_update_hints.rb
+- .gemtest
+has_rdoc: true
+homepage: http://github.com/julik/update_hints
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: update_hints
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Quickly checks rubygems.org for a new version o a given gem and advises the user on STDERR to install an update
+test_files: 
+- test/test_update_hints.rb