version-check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82c9098875cd2f462c21ecdbbf7bd0271cd755a9
+  data.tar.gz: bb6c366865fb20255cf7892c71169d30c2a3c37c
+SHA512:
+  metadata.gz: 707d9b5a42b7a28bbaede44a53fd511c7f05bfeabfdf0bbc1c7ef5c7f04641095fbbb86fedcee25664aed794c579b582dad4d72dc7754867cdec199c08302472
+  data.tar.gz: 205c185befb544077cd32f659a9a60a3c740d928b58fdf7406035a02cb43df15fa99f553ce6ef0eb13b3c26c09ba50e57b20c79a7254c8aff522ce767936d4fa

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+### 0.0.1 / 2020-02-24
+
+* Everything is new. First release.
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/version/check.rb
+lib/version/check/version.rb
+test/helper.rb
+test/test_check.rb

data/README.md

@@ -0,0 +1,111 @@
+# version-check gem - up-to-date? - helpers for checking for / reporting outdated gem / library versions
+
+* home  :: [github.com/feedreader/pluto](https://github.com/feedreader/pluto)
+* bugs  :: [github.com/feedreader/pluto/issues](https://github.com/feedreader/pluto/issues)
+* gem   :: [rubygems.org/gems/version-check](https://rubygems.org/gems/version-check)
+* rdoc  :: [rubydoc.info/gems/version-check](http://rubydoc.info/gems/version-check)
+* forum :: [groups.google.com/group/wwwmake](http://groups.google.com/group/wwwmake)
+
+
+## Usage 
+
+Up-to-date? Version check all your libraries / gems on start-up at runtime.
+
+Let's say you have a script
+that depends on many libraries / gems.
+How can you make sure the minimum version requirements
+are fulfilled?
+
+
+Use the (global) `version_check` method in your script.
+Example:
+
+``` ruby
+outdated = version_check(
+  ['pakman',        '1.1.0',  Pakman::VERSION],
+  ['fetcher',       '0.4.5',  Fetcher::VERSION],
+  ['feedparser',    '2.1.2',  FeedParser::VERSION],
+  ['feedfilter',    '1.1.1',  FeedFilter::VERSION],
+  ['textutils',     '1.4.0',  TextUtils::VERSION],
+  ['logutils',      '0.6.1',  LogKernel::VERSION],
+  ['props',         '1.2.0',  Props::VERSION],
+
+  ['pluto-models',  '1.5.4',  Pluto::VERSION],
+  ['pluto-update',  '1.6.3',  PlutoUpdate::VERSION],
+  ['pluto-merge',   '1.1.0',  PlutoMerge::VERSION] )
+
+pp outdated
+```
+
+Pass along the version check records where the record items are 1) the name of the library / gem, 2) the minimum version requirement and 3) the "live" used version - for example, 
+`Pluto::VERSION` will become at runtime `1.5.3` or something - depending
+on the installation / setup.
+
+If all libraries / gems are up-to-date
+this will result in an empty outdated list / array:
+
+``` ruby
+[]
+```
+
+And if some libraries / gems are NOT matching the minimum version requirement
+the version record will get returned in the outdated list / array
+resulting in, for example:
+
+``` ruby
+[['pluto-models',  '1.5.4', '1.5.3'],
+ ['pluto-update',  '1.6.3', '1.4.1']]
+```
+
+Note: For now the version in use MUST always be greater or equal
+to the minimum version requirement.
+
+And the minimum requirement might be just a major (e.g. `2` same as `2.x.x`)
+or a major plus minor (e.g. `2.1` same as  `2.1.x`) version.
+
+
+
+### Bonus:  Sorry - Cannot continue; please update the outdated gem(s)
+
+Use the (global) `version_check!` method (with a bang `!`) in your script
+to automatically 1) check all versions, 2) report all outdated libraries / gems, 3) ask for an update and 4) exit. Example:
+
+``` ruby
+version_check!(
+  ['pakman',        '1.1.0', Pakman::VERSION],
+  ['fetcher',       '0.4.5', Fetcher::VERSION],
+  ['feedparser',    '2.1.2', FeedParser::VERSION],
+  ['feedfilter',    '1.1.1', FeedFilter::VERSION],
+  ['textutils',     '1.4.0', TextUtils::VERSION],
+  ['logutils',      '0.6.1', LogKernel::VERSION],
+  ['props',         '1.2.0', Props::VERSION],
+
+  ['pluto-models',  '1.5.4', Pluto::VERSION],
+  ['pluto-update',  '1.6.3', PlutoUpdate::VERSION],
+  ['pluto-merge',   '1.1.0', PlutoMerge::VERSION] )
+```
+
+Case 1: If all libraries / gems are up-to-date nothing happens.
+
+Case 2: If some libraries / gems are NOT matching the minimum version requirement
+this will result in, for example:
+
+```
+!!! ERROR: version check failed - 2 outdated gem(s):"
+  pluto-models - min version required 1.5.4 > used/installed version 1.5.3
+  pluto-update - min version required 1.6.3 > used/installed version 1.4.1     
+
+sorry - cannot continue; please update the outdated gem(s)
+```
+
+
+
+## License
+
+The `version-check` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+## Questions? Comments?
+
+Send them along to the [wwwmake Forum/Mailing List](http://groups.google.com/group/wwwmake).
+Thanks!

data/Rakefile

@@ -0,0 +1,29 @@
+require 'hoe'
+require './lib/version/check/version.rb'
+
+Hoe.spec 'version-check' do
+
+  self.version = VersionCheck::VERSION
+
+  self.summary = "version-check - up-to-date? - helpers for checking for / reporting outdated gem / library versions"
+  self.description = summary
+
+  self.urls    = ['https://github.com/feedreader/pluto']
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = []
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   required_ruby_version: '>= 2.2.2'
+  }
+
+end

data/lib/version/check.rb

@@ -0,0 +1,67 @@
+require 'pp'
+
+# our own code
+require 'version/check/version'   # note: let version always go first
+
+
+
+#####
+#  simple version check
+#      used version MUST always be greater or equal than minimum requirement
+
+def version_check( *versions )
+ 
+    outdated = []   ## list of outdated entries
+
+    versions.each do |rec|
+        name         = rec[0]
+        ##  convert "2.0.17" to  [2,0,17] or
+        ##          "2.1"    to  [2,1]     
+        ## note: use Integer and NOT to_i; will through exception if version is not a number
+        min_version  = rec[1].split( '.' ).map { |part| Integer(part) }
+        used_version = rec[2].split( '.' ).map { |part| Integer(part) }
+
+        ## check for minimum version requirement 
+        min_version.zip( used_version ) do |part|
+            min_num  = part[0]
+            used_num = part[1] || 0    ## support unlikley edge case (used_version has less version parts than min_version)
+            if used_num > min_num 
+                ## used version is greater; stop comparing 
+                break   
+            elsif used_num == min_num
+                ## continue compare with next version number part
+                next  
+            else
+                ## used version is smaller; add and report outdated (!!) entry; stop comparing  
+                outdated << rec
+                break
+            end
+        end
+    end
+
+    outdated
+end
+
+
+def version_check!( *versions )
+  outdated = version_check( *versions )
+      
+  if outdated.size > 0   ## any outdated gems/libraries
+      puts "!!! error: version check failed - #{outdated.size} outdated gem(s):"
+      outdated.each do |rec|
+          name         = rec[0]
+          min_version  = rec[1]
+          used_version = rec[2]
+          puts "   #{name} - min version required #{min_version} > used/installed version #{used_version}"
+      end
+      puts
+      puts "sorry - cannot continue; please update the outdated gem(s)"
+      
+      exit 1
+  end   
+end
+
+
+
+# say hello
+puts VersionCheck.banner   if $DEBUG || (defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG)

data/lib/version/check/version.rb

@@ -0,0 +1,20 @@
+
+module VersionCheck
+  MAJOR = 0    ## todo: namespace inside version or something - why? why not??
+  MINOR = 1
+  PATCH = 0
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "version-check/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
+  end
+end # module VersionCheck
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+
+## minitest setup
+require 'minitest/autorun'
+
+
+$RUBYLIBS_DEBUG = true
+
+## our own code
+require 'version/check'
+

data/test/test_check.rb

@@ -0,0 +1,55 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_check.rb
+
+
+require 'helper'
+
+
+class TestCheck < MiniTest::Test
+
+
+  def test_update_to_date
+
+    versions_a =
+    [['pakman',            '1.1.0', '1.1.1'],
+     ['fetcher',           '0.4.5', '0.5.4'],
+     ['feedparser',        '2.1.2', '2.2.1'],
+     ['feedfilter',        '1.1',   '1.1.14'],
+     ['textutils',         '2',     '2.0.5'],
+     ['logutils',          '0.6',   '0.6.0'],
+     ['props',             '1.2.1', '1.3.0'],
+
+     ['pluto-models',      '1.5.4', '1.5.7'],
+     ['pluto-update',      '1.6',   '2.0.0'],
+     ['pluto-merge',       '1.1.0', '1.2.0']]
+
+    versions_a_outdated = []
+
+    assert_equal versions_a_outdated, version_check( *versions_a )
+  end
+
+  def test_outdated
+    versions_b =
+    [['pakman',            '1.1.0', '1.0.1'],
+     ['fetcher',           '0.4.5', '0.5.4'],
+     ['feedparser',        '2.1.2', '2.2.1'],
+     ['feedfilter',        '1.1',   '1.1.1'],
+     ['textutils',         '2',     '1.2.7'],
+     ['logutils',          '0.6',   '0.6.0'],
+     ['props',             '1.2.1', '1.3.0'],
+
+     ['pluto-models',      '1.5.4', '1.5.7'],
+     ['pluto-update',      '1.6',   '1.5.11'],
+     ['pluto-merge',       '1.1.0', '1.2.0']]
+
+     versions_b_outdated =
+     [['pakman',            '1.1.0', '1.0.1'],
+      ['textutils',         '2',     '1.2.7'],
+      ['pluto-update',      '1.6',   '1.5.11']]
+
+
+      assert_equal versions_b_outdated, version_check( *versions_b )  
+  end
+
+end # class TestCheck

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: version-check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: version-check - up-to-date? - helpers for checking for / reporting outdated
+  gem / library versions
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/version/check.rb
+- lib/version/check/version.rb
+- test/helper.rb
+- test/test_check.rb
+homepage: https://github.com/feedreader/pluto
+licenses:
+- Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: version-check - up-to-date? - helpers for checking for / reporting outdated
+  gem / library versions
+test_files: []