rbcli 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0eefbfff220d04c6c6093ea0d3ec5cdd8fe93a6f02568c720ed04baddf05a25b
-  data.tar.gz: b7d18d8c85c131cd57c7cc78d63656687896bd02f0bb4d84c8e65a0bc332a7f1
+  metadata.gz: 6e1fdf57f967275989d85da3af7efe4be4548c19355a38ad413b5a3eda93df29
+  data.tar.gz: 021efa89a89181c7ec705250824a8c6c3fc1009d9dcbcf5b3480d66f1996d47d
 SHA512:
-  metadata.gz: 28893fa34a3e02a1f67b1279b88fb52812f07601ec9dc20662f15351d55ea06c2a4bc401a7fce9c2877b7eccfc4165183b7a6770c171084114eac2228cb49288
-  data.tar.gz: 96cb8d64eabc9d48e511d1923e174b31c3f1d3f4fd9f74345c3cf19209ff21c3837bc6166ed97ea4b962a089cdfb9efcffea54efa923e9b3f60786e91cb0e249
+  metadata.gz: f35c7c37d74f54d15ca6393e5a6f9f73b34bbc957a63ff5cd5b0d5e62fdf8643e19a23ec70adab4088b2816c45329b31c309346939726c22f89de491e33b022e
+  data.tar.gz: deb5e7bb66af850aa3278f40826ff506302bf4ae9817cf63f8dac23a6bd0fd9db924ea684aa7ea10ef628b7fbcb6ee6893480639c3f995648423d1c05069569d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbcli (0.1.5)
+    rbcli (0.1.6)
       aws-sdk-dynamodb (~> 1.6)
       colorize (~> 0.8)
       deep_merge (~> 1.2)

data/README.md

@@ -82,8 +82,8 @@ Rbcli::Configurate.me do
 
 	option :name, 'Give me your name', type: :string, default: 'Foo', required: false, permitted: ['Jack', 'Jill']  # (Optional, Multiple) Add a global CLI parameter. Supported types are :string, :boolean, :integer, :float, :date, and :io. Can be called multiple times.
 
-	autoupdate github_repo: 'akhoury6/rbcli', access_token: nil, enterprise_hostname: nil, this_version: Rbcli::VERSION, force_update: false    # (Optional) Check for updates to this application at a GitHub repo. The repo must use version number tags in accordance to best practices: https://help.github.com/articles/creating-releases/
-	autoupdate gem: 'rbcli', this_version: Rbcli::VERSION, force_update: false                                                                  # (Optional) Check for updates to this application through RubyGems.org.
+	autoupdate github_repo: 'akhoury6/rbcli', access_token: nil, enterprise_hostname: nil, force_update: false    # (Optional) Check for updates to this application at a GitHub repo. The repo must use version number tags in accordance to best practices: https://help.github.com/articles/creating-releases/
+	autoupdate gem: 'rbcli', force_update: false                                                                  # (Optional) Check for updates to this application through RubyGems.org.
 
 	default_action do |opts|                                               # (Optional) The default code to execute when no subcommand is given. If not present, the help is shown (same as -h)
 		puts "Hello, #{opts[:name]}."
@@ -374,10 +374,10 @@ Two sources are currently supported: Github (including Enterprise) and RubyGems.
 
 The GitHub update check works best when paired with GitHub's best practices on releases. See here: https://help.github.com/articles/creating-releases/
 
-RBCli will check your github repo's tags and compare that version number with one embedded into your code. In this example, we are leveraging the version number that we also use for RBCli's gemspec:
+RBCli will check your github repo's tags and compare that version number with one you configured Rbcli with.
 
 ```ruby
-autoupdate github_repo: 'akhoury6/rbcli', access_token: nil, enterprise_hostname: nil, this_version: Rbcli::VERSION, force_update: false    # (Optional) Check for updates to this application at a GitHub repo. The repo must use version number tags in accordance to best practices: https://help.github.com/articles/creating-releases/
+autoupdate github_repo: 'akhoury6/rbcli', access_token: nil, enterprise_hostname: nil, force_update: false    # (Optional) Check for updates to this application at a GitHub repo. The repo must use version number tags in accordance to best practices: https://help.github.com/articles/creating-releases/
 ``` 
 The `github_repo` should point to the repo using the `user/repo` syntax. 
 
@@ -385,21 +385,17 @@ The `access_token` can be overridden by the user via their configuration file, s
 
 The `enterprise_hostname` setting allows you to point RBCli at a local GitHub Enterprise server.
 
-The `this_version` parameter should be set to the current version of the tool that the user is running. Here we leverage the default version location that is used for the RBCli gem itself. In your tool, you should replace this with your own version number.
-
 Setting `force_update: true` will halt execution if an update is available, forcing the user to update.
 
 ### Rubygems.org Update Check
 
-The Rubygems update check will check if there is a new published version of the gem on Rubygems.org.
+The Rubygems update check will check if there is a new published version of the gem on Rubygems.org. The latest published version is compared to the version number you configured RBCli with.
 
 ```ruby
-autoupdate gem: 'rbcli', this_version: Rbcli::VERSION, force_update: false   # (Optional) Check for updates to this application through RubyGems.org.
+autoupdate gem: 'rbcli', force_update: false   # (Optional) Check for updates to this application through RubyGems.org.
 ```
 
 The `gem` parameter should simply state the name of the gem.
-
-The `this_version` parameter should be set to the current version of the tool that the user is running. Here we leverage the default version location that is used for the RBCli gem itself. In your tool, you should replace this with your own version number.
  
 Setting `force_update: true` will halt execution if an update is available, forcing the user to update.
 

data/examples/mytool

@@ -22,8 +22,8 @@ Rbcli::Configurate.me do
 
 	option :name, 'Give me your name', type: :string, default: 'Foo', required: false, permitted: ['Jack', 'Jill']  # (Optional, Multiple) Add a global CLI parameter. Supported types are :string, :boolean, :integer, :float, :date, and :io. Can be called multiple times.
 
-	autoupdate github_repo: 'akhoury6/rbcli', access_token: nil, enterprise_hostname: nil, this_version: Rbcli::VERSION, force_update: false    # (Optional) Check for updates to this application at a GitHub repo. The repo must use version number tags in accordance to best practices: https://help.github.com/articles/creating-releases/
-	autoupdate gem: 'rbcli', this_version: Rbcli::VERSION, force_update: false                                                                  # (Optional) Check for updates to this application through RubyGems.org.
+	autoupdate github_repo: 'akhoury6/rbcli', access_token: nil, enterprise_hostname: nil, force_update: false    # (Optional) Check for updates to this application at a GitHub repo. The repo must use version number tags in accordance to best practices: https://help.github.com/articles/creating-releases/
+	autoupdate gem: 'rbcli', force_update: false                                                                  # (Optional) Check for updates to this application through RubyGems.org.
 
 	default_action do |opts|                                               # (Optional) The default code to execute when no subcommand is given. If not present, the help is shown (same as -h)
 		puts "Hello, #{opts[:name]}."

data/lib/rbcli/autoupdate/autoupdate.rb

@@ -1,13 +1,13 @@
 module Rbcli::Configurate
-	def self.autoupdate gem: nil, github_repo: nil, access_token: nil, enterprise_hostname: nil, this_version: nil, force_update: false
+	def self.autoupdate gem: nil, github_repo: nil, access_token: nil, enterprise_hostname: nil, force_update: false
 		raise StandardError.new "Autoupdater can not have both a gem and git target defined. Please pick one." if gem and giturl
 		raise StandardError.new "Only one autoupdater can be defined." if @data[:autoupdater]
 		if gem
 			#Rbcli::Autoupdate::GemUpdater.save_defaults
-			@data[:autoupdater] = Rbcli::Autoupdate::GemUpdater.new gem, this_version, force_update
+			@data[:autoupdater] = Rbcli::Autoupdate::GemUpdater.new gem, force_update
 		else
 			Rbcli::Autoupdate::GithubUpdater.save_defaults
-			@data[:autoupdater] = Rbcli::Autoupdate::GithubUpdater.new github_repo, access_token, enterprise_hostname, this_version, force_update
+			@data[:autoupdater] = Rbcli::Autoupdate::GithubUpdater.new github_repo, access_token, enterprise_hostname, force_update
 		end
 		@data[:autoupdater].show_message if @data[:autoupdater].update_available?
 	end
@@ -27,11 +27,11 @@ module Rbcli::Autoupdate
 
 		def update_available?
 			@latest_version = get_latest_version
-			Gem::Version.new(@latest_version) > Gem::Version.new(@this_version)
+			Gem::Version.new(@latest_version) > Gem::Version.new(Rbcli.configuration[:version])
 		end
 
 		def show_message
-			puts "WARNING: An update is available to #{Rbcli::Configurate::configuration[:scriptname]}. You are currently running version #{@this_version}; the latest is #{@latest_version || get_latest_version}."
+			puts "WARNING: An update is available to #{Rbcli::Configurate::configuration[:scriptname]}. You are currently running version #{Rbcli.configuration[:version]}; the latest is #{@latest_version || get_latest_version}."
 			puts update_message
 			puts "\n"
 			if @force_update

data/lib/rbcli/autoupdate/gem_updater.rb

@@ -5,10 +5,9 @@ module Rbcli::Autoupdate
 	class GemUpdater
 		include Common
 
-		def initialize gemname, this_version, force_update
+		def initialize gemname, force_update
 			@gemname = gemname
 			@uri = URI.parse "https://rubygems.org/api/v1/versions/#{gemname}/latest.json"
-			@this_version = this_version
 			@force_update = force_update
 		end
 

data/lib/rbcli/autoupdate/github_updater.rb

@@ -4,9 +4,8 @@ module Rbcli::Autoupdate
 	class GithubUpdater
 		include Common
 
-		def initialize reponame, access_token, enterprise_hostname, this_version, force_update
+		def initialize reponame, access_token, enterprise_hostname, force_update
 			@reponame = reponame
-			@this_version = this_version
 			@force_update = force_update
 
 			access_token = Rbcli.config.key?(:github_updatecheck) ? (Rbcli.config[:github_updatecheck][:access_token] || access_token) : access_token

data/lib/rbcli/version.rb

@@ -1,3 +1,3 @@
 module Rbcli
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbcli
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Andrew Khoury