raketeer 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b99e3161b005655aae395358e6b77cd6639d8ba23772a7b8ff046fe5417e9b3
-  data.tar.gz: 60dace11dd408a067de2fb802cd270c46153382a7b10e7ac9f71f5b0b3a755bf
+  metadata.gz: 5d024ad7fff342f32aa3d07ed4eafdb0b42996e6812bc7b5c083bd7251aebef8
+  data.tar.gz: 1daff5b05304afc6ec8e3a8eeca34a3bb107e3fef435d65a8c057c6a4289a3e9
 SHA512:
-  metadata.gz: 4e451e5c7f240195de491672510f05ac95a8e09ef633019ad138a918c7352863d64a54a440ebe1bad939b26deaf90c28c26fa960e65ff4f8bdeba71efb5992eb
-  data.tar.gz: '09963f9e20f3307bd19310f7cdc3b592913bc8d788d3f465d025c7e030553697602d6d545be78af4e0d5c46c3efa5d3eb45df198611b98c302d8a54006d89124'
+  metadata.gz: 7f9e8d44767109f49cc8ef9edc0150200d00819c33845ff6876bd8b0fdb5622caaf298b6727fba1ca5672a59dc539cdafc5b87c15447f0a40fb9c4975aa32a74
+  data.tar.gz: 26a662ef27360ea9eb158254acb7687d765b6bc6f5933414d88b3dd5ddf8b68783850680cdea18cd4c8e75e2644b279a0076d94a759faa407dde260f6e0443f8

data/CHANGELOG.md

@@ -2,7 +2,18 @@
 
 Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [[Unreleased]](https://github.com/esotericpig/raketeer/compare/v0.2.6...master)
+## [[Unreleased]](https://github.com/esotericpig/raketeer/compare/v0.2.7...master)
+
+## [v0.2.7] - 2019-12-18
+### Added
+- Add more info to README
+- Add default dirs to Util methods
+- Add Util.get_env_bool() method
+- Add more TODOs and skeletons for future
+- Add strict as an env var to bump task
+
+### Fixed
+- Check env vars for bundle task in bump task
 
 ## [v0.2.6] - 2019-08-03
 ### Changed

data/README.md

@@ -8,6 +8,8 @@
 
 Extra Ruby Rake Tasks.
 
+A [CLI app](https://github.com/esotericpig/raketary) is also available that uses these tasks, which is useful for tasks like *bump* (which bumps the version for your RubyGem project) so that you don't have to include this Gem as a development dependency for every project.
+
 ## Contents
 
 - [Setup](#setup)
@@ -49,6 +51,103 @@ $ bundle exec rake install:local
 
 ## [Using](#contents)
 
+**TODO:** flesh out Using section
+
+**Rakefile**
+
+In your *Rakefile*, you can either include all tasks...
+
+```Ruby
+require 'raketeer/all'
+```
+
+Or, include the specific tasks that you need:
+
+```Ruby
+require 'raketeer/bump'
+require 'raketeer/irb'
+require 'raketeer/nokogiri_installs'
+require 'raketeer/run'
+```
+
+If you have conflicting tasks and/or you want to see what tasks have been included, you can put them in a namespace:
+
+```Ruby
+namespace :rt do
+  require 'raketeer/all'
+end
+```
+
+**Included Tasks**
+
+```
+rake bump[version]      # Show/Set/Bump the version
+rake bump:build[build]  # Set/Erase the build metadata
+rake bump:bundle        # Bump the Gemfile.lock version
+rake bump:help          # Show the help/usage for bump tasks
+rake bump:major[major]  # Bump/Set the major version
+rake bump:minor[minor]  # Bump/Set the minor version
+rake bump:patch[patch]  # Bump/Set the patch version
+rake bump:pre[pre]      # Set/Erase the pre-release version
+rake irb                # Open an irb session loaded with this library
+rake nokogiri_apt       # Install Nokogiri libs for Ubuntu/Debian
+rake nokogiri_dnf       # Install Nokogiri libs for Fedora/CentOS/Red Hat
+rake nokogiri_other     # Install Nokogiri libs for other OSes
+rake run                # Run this project's main file: "rake run -- --version"
+```
+
+**bump:help**
+
+```
+$ rake bump:help
+rake bump  # Print the current version
+
+# You can run a dry run for any task (will not write to files)
+rake bump dryrun=true
+
+rake bump[1.2.3-alpha.4-beta.5]       # Set the version manually
+rake bump major=1 minor=2 patch=3     # Set the version numbers
+rake bump pre=alpha.4 build=beta.5    # Set the version extensions
+rake bump major=+1 minor=+1 patch=+1  # Bump the version numbers by 1
+rake bump major=+2 minor=+3 patch=+4  # Bump the version numbers by X
+
+rake bump:major          # Bump the major version by 1
+rake bump:major[1]       # Set the major version to 1
+rake bump:major[+2]      # Bump the major version by 2
+rake bump:minor          # Bump the minor version by 1
+rake bump:minor[2]       # Set the minor version to 2
+rake bump:minor[+3]      # Bump the minor version by 3
+rake bump:patch          # Bump the patch version by 1
+rake bump:patch[3]       # Set the patch version to 3
+rake bump:patch[+4]      # Bump the patch version by 4
+rake bump:pre            # Erase the pre-release version
+rake bump:pre[alpha.4]   # Set the pre-release version
+rake bump:build          # Erase the build metadata
+rake bump:build[beta.5]  # Set the build metadata
+rake bump:bundle         # Bump the Gemfile.lock version
+```
+
+**Modifying Tasks**
+
+If you need more control, for now, please look at the accessors of each task (better documentation is planned for v1.0.0):
+
+- [BumpTask](lib/raketeer/bump_task.rb)
+- [IRBTask](lib/raketeer/irb_task.rb)
+- [NokogiriAPTTask](lib/raketeer/nokogiri_install_tasks.rb)
+- [NokogiriDNFTask](lib/raketeer/nokogiri_install_tasks.rb)
+- [NokogiriOtherTask](lib/raketeer/nokogiri_install_tasks.rb)
+- [RunTask](lib/raketeer/run_task.rb)
+
+For example, in your *Rakefile*:
+
+```Ruby
+require 'raketeer/bump_task'
+
+Raketeer::BumpTask.new() do |task|
+  task.strict = true
+end
+```
+
 ## [Hacking](#contents)
 
 ```

data/Rakefile

@@ -34,3 +34,15 @@ CLOBBER.include('doc/')
 namespace :rt do
   require 'raketeer/all'
 end
+
+namespace :todo do
+  # TODO: make this into a task class
+  # TODO: do 'gem:files'? and also 'gem:info' for all other methods?
+  desc 'Output dat gemspec bootyliciousness'
+  task :gem do |task,args|
+    # TODO: if this doesn't work, read *.gemspec somehow? probably not...
+    gem = Gem::Specification.find_by_name('raketeer')
+    puts gem.files
+    #puts gem.methods.sort - Object.methods
+  end
+end

data/lib/raketeer/bump_task.rb

@@ -23,9 +23,7 @@
 
 require 'date'
 require 'rake'
-
 require 'rake/tasklib'
-
 require 'raketeer/bump_ver'
 require 'raketeer/files_bumper'
 require 'raketeer/sem_ver'
@@ -128,6 +126,7 @@ module Raketeer
         
         desc 'Bump the Gemfile.lock version'
         task :bundle do
+          check_env()
           bump_bundle_file()
         end
         
@@ -318,11 +317,8 @@ module Raketeer
     end
     
     def check_env()
-      env_dryrun = ENV['dryrun']
-      
-      if !env_dryrun.nil?() && !(env_dryrun = env_dryrun.to_s().strip()).empty?()
-        @dry_run = Util.to_bool(env_dryrun)
-      end
+      @dry_run = Util.get_env_bool('dryrun',@dry_run)
+      @strict = Util.get_env_bool('strict',@strict)
     end
     
     def print_help()

data/lib/raketeer/util.rb

@@ -30,7 +30,7 @@ module Raketeer
     # @since 0.2.4
     TRUE_BOOLS = ['1','on','t','true','y','yes'].freeze()
     
-    def self.find_main_executable(bin_dir)
+    def self.find_main_executable(bin_dir='bin')
       # Try the bin/ dir
       main_exe = Dir.glob(File.join(bin_dir,'*'))
       
@@ -48,9 +48,9 @@ module Raketeer
       return nil
     end
     
-    def self.find_main_module()
+    def self.find_main_module(lib_dir='lib')
       # Try the lib/ dir
-      main_file = Dir.glob(File.join('lib','*.rb'))
+      main_file = Dir.glob(File.join(lib_dir,'*.rb'))
       
       return File.basename(main_file[0],'.*') if main_file.length == 1
       
@@ -62,6 +62,17 @@ module Raketeer
       return nil
     end
     
+    # @since 0.2.7
+    def self.get_env_bool(env_name,def_value=nil)
+      value = ENV[env_name]
+      
+      if value.nil?() || (value = value.to_s().strip()).empty?()
+        return def_value
+      end
+      
+      return to_bool(value)
+    end
+    
     # @since 0.2.4
     def self.to_bool(obj)
       return TRUE_BOOLS.include?(obj.to_s().downcase())

data/lib/raketeer/version.rb

@@ -22,7 +22,7 @@
 
 
 module Raketeer
-  VERSION = '0.2.6'
+  VERSION = '0.2.7'
   
   # @since 0.2.4
   DEP_VERSIONS = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raketeer
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Jonathan Bradley Whited (@esotericpig)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-03 00:00:00.000000000 Z
+date: 2019-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake