raketeer 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c640a3f432fd8fe95e94d5eaef3c1a23d53a0aa10c00f753cf3f8dc9cfb01a2
-  data.tar.gz: c4070047815d4a852f7583534658995152c04c7323193184ad67cfc15746cfee
+  metadata.gz: e0fe188ca361d90c09d8cf7222b553aab685af3237b8e1ed6c7ffcc98376d5eb
+  data.tar.gz: 000acde7b85235e3972207ebc8de75725d2d3b63de1df18325509d486762fdc7
 SHA512:
-  metadata.gz: 9e531f26bbe0158fedbff069663b968dc88990c23ab31d5985a138894241b9517ef4547e4788daf3799cc6e27282ee64d28e634b9c5d32cebe6c5a5bd4da57ee
-  data.tar.gz: 8fac28b33535152c48be164060c9b63379ffb03df9f1bfc4667184ed98a9fdc1979eb36dd45c0fc48121c6dceafa7df18786b844d5bcb24839fb8965ed85a16e
+  metadata.gz: 2ea1eb2f31032fcb5b676645805c0c2805c4f9d08fa5f20776b3a141998f79913e3515d0271ca06aff428a76d15f09f8288b86b5e0c80fba67cf503f765f74c1
+  data.tar.gz: f056934701cff50e1b3aa278c63441825a3d543a5f388cbe3acb60061736a2ee9032ab488d0c9251090d044c721690ae853ca85d2eae73c6b0606f687b640cc7

data/CHANGELOG.md

@@ -2,7 +2,21 @@
 
 Format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-## [[Unreleased]](https://github.com/esotericpig/raketeer/compare/v0.2.0...master)
+## [[Unreleased]](https://github.com/esotericpig/raketeer/compare/v0.2.2...master)
+
+## [v0.2.2] - 2019-07-29
+### Changed
+- Refactored some code (minor)
+- Changed some documentation (minor)
+
+### Added
+- RunTask & 'raketeer/run'
+- Util
+- bin/raketeer (for testing purposes only, not included in the Gem package)
+
+## [v0.2.1] - 2019-07-24
+### Changed
+- Fixed minor/cosmetic typo
 
 ## [v0.2.0] - 2019-07-24
 ### Added

data/README.md

@@ -8,8 +8,6 @@
 
 Extra Ruby Rake Tasks.
 
-Name comes from Rocketeer.
-
 ## Contents
 
 - [Setup](#setup)

data/Rakefile

@@ -24,9 +24,11 @@ require 'bundler/gem_tasks'
 
 require 'rake/clean'
 
-require 'raketeer/all'
-
 task default: []
 
 CLEAN.exclude('.git/','stock/')
 CLOBBER.include('doc/')
+
+namespace :rt do
+  require 'raketeer/all'
+end

data/lib/raketeer/all.rb

@@ -23,6 +23,7 @@
 
 require 'raketeer/irb' # @since 0.2.0
 require 'raketeer/nokogiri_installs' # @since 0.1.0
+require 'raketeer/run' # @since 0.2.2
 
 module Raketeer
   ###

data/lib/raketeer/irb_task.rb

@@ -25,6 +25,8 @@ require 'rake'
 
 require 'rake/tasklib'
 
+require 'raketeer/util'
+
 module Raketeer
   ###
   # @author Jonathan Bradley Whited (@esotericpig)
@@ -43,7 +45,7 @@ module Raketeer
       super()
       
       @description = 'Open an irb session loaded with this library'
-      @main_module = find_main_module()
+      @main_module = Util.find_main_module()
       @name = name
       @warning = true
       
@@ -66,28 +68,5 @@ module Raketeer
         sh(*@irb_cmd)
       end
     end
-    
-    def find_main_module()
-      # First, try the lib/ dir
-      main_file = Dir.glob(File.join('lib','*.rb'))
-      
-      if main_file.length == 1
-        basename = File.basename(main_file[0],'.*')
-        
-        return basename
-      end
-      
-      # Next, try the Gemspec
-      main_file = Dir.glob('*.gemspec')
-      
-      if main_file.length == 1
-        basename = File.basename(main_file[0],'.*')
-        main_file = File.join('lib',"#{basename}.rb")
-        
-        return basename if File.exist?(main_file)
-      end
-      
-      return nil
-    end
   end
 end

data/lib/raketeer/run.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of Raketeer.
+# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
+# 
+# Raketeer is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Raketeer is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Raketeer.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+require 'raketeer/run_task'
+
+module Raketeer
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.2.2
+  ###
+  module Run
+  end
+end
+
+Raketeer::RunTask.new() # @since 0.2.2

data/lib/raketeer/run_task.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of Raketeer.
+# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
+# 
+# Raketeer is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Raketeer is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Raketeer.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+require 'rake'
+
+require 'rake/tasklib'
+
+require 'raketeer/util'
+
+module Raketeer
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.2.2
+  ###
+  class RunTask < Rake::TaskLib
+    attr_accessor :bin_dir
+    attr_accessor :description
+    attr_accessor :executable
+    attr_accessor :name
+    attr_accessor :run_cmd
+    attr_accessor :warning
+    
+    alias_method :warning?,:warning
+    
+    def initialize(name=:run)
+      super()
+      
+      @bin_dir = 'bin'
+      @description = %Q(Run this project's main file: "rake #{name} -- --version")
+      @executable = nil
+      @name = name
+      @warning = true
+      
+      @run_cmd = ['ruby']
+      @run_cmd += ['-r','rubygems']
+      @run_cmd += ['-r','bundler/setup']
+      
+      # Yield before using changeable vars
+      yielf self if block_given?()
+      
+      @executable = Util.find_main_executable(@bin_dir) if @executable.nil?()
+      
+      @run_cmd << '-w' if @warning
+      @run_cmd << File.join(@bin_dir,@executable)
+      
+      define()
+    end
+    
+    def define()
+      desc @description
+      task @name do |task,args|
+        first_arg_index = -1
+        name_s = @name.to_s()
+        
+        # Cut out "--silent" for "rake --silent rt:run -- --version",
+        # else "--silent" will be sent to the executable.
+        ARGV.each_with_index do |arg,i|
+          # There could be a namespace and/or args, like "rt:run[true]".
+          # Rake task names are case-sensitive.
+          if arg.include?(name_s)
+            first_arg_index = i + 1
+            
+            break
+          end
+        end
+        
+        # Are there args for the run command?
+        if first_arg_index >= 0 && first_arg_index < ARGV.length
+          run_args = ARGV.slice!(first_arg_index..-1)
+          
+          # Cut out "--" for "rake run -- --version".
+          # For older versions of rake, you didn't need "--", so check for it.
+          run_args.slice!(0) if run_args[0] == '--'
+          
+          @run_cmd += run_args
+        end
+        
+        sh(*@run_cmd)
+      end
+    end
+  end
+end

data/lib/raketeer/util.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of Raketeer.
+# Copyright (c) 2019 Jonathan Bradley Whited (@esotericpig)
+# 
+# Raketeer is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+# 
+# Raketeer is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+# 
+# You should have received a copy of the GNU Lesser General Public License
+# along with Raketeer.  If not, see <https://www.gnu.org/licenses/>.
+#++
+
+
+module Raketeer
+  ###
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.2.2
+  ###
+  module Util
+    def self.find_main_executable(bin_dir)
+      # Try any file
+      main_exe = Dir.glob(File.join(bin_dir,'*'))
+      
+      return File.basename(main_exe[0]) if main_exe.length == 1
+      
+      # Try only .rb files
+      main_exe = Dir.glob(File.join(bin_dir,'*.rb'))
+      
+      return File.basename(main_exe[0]) if main_exe.length == 1
+      
+      # Try using the main module
+      main_mod = find_main_module()
+      
+      if !main_mod.nil?()
+        main_exe = File.join(bin_dir,main_mod)
+        
+        return main_mod if File.exist?(main_exe)
+      end
+      
+      return nil
+    end
+    
+    def self.find_main_module()
+      # Try the lib/ dir
+      main_file = Dir.glob(File.join('lib','*.rb'))
+      
+      return File.basename(main_file[0],'.*') if main_file.length == 1
+      
+      # Try the Gemspec
+      main_file = Dir.glob('*.gemspec')
+      
+      return File.basename(main_file[0],'.*') if main_file.length == 1
+      
+      return nil
+    end
+  end
+end

data/lib/raketeer/version.rb

@@ -22,5 +22,5 @@
 
 
 module Raketeer
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/lib/raketeer.rb

@@ -23,6 +23,7 @@
 
 require 'raketeer/irb_task'
 require 'raketeer/nokogiri_install_tasks'
+require 'raketeer/run_task'
 require 'raketeer/version'
 
 ###

data/raketeer.gemspec

@@ -20,7 +20,7 @@
 #++
 
 
-lib = File.expand_path('../lib',__FILE__)
+lib = File.expand_path(File.join('..','lib'),__FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'raketeer/version'
@@ -33,7 +33,7 @@ Gem::Specification.new() do |spec|
   spec.licenses    = ['LGPL-3.0-or-later']
   spec.homepage    = 'https://github.com/esotericpig/raketeer'
   spec.summary     = 'Extra Ruby Rake Tasks.'
-  spec.description = "#{spec.summary} Tasks for IRB, Nokogiri, etc."
+  spec.description = 'Extra Ruby Rake Tasks for IRB, Nokogiri, running, etc.'
   
   spec.metadata = {
     'bug_tracker_uri' => 'https://github.com/esotericpig/raketeer/issues',
@@ -51,8 +51,21 @@ Gem::Specification.new() do |spec|
   
   spec.required_ruby_version = '>= 2.1.10'
   
+  # TODO: also add the below comment to the README & reword for user
+  # If it is a dependency specific to a task, then it should probably be added
+  # as a dev dependency (not a runtime dependency) so that a bunch of
+  # non-essential dependencies (to the user) are not added.
+  # 
+  # For example, if the user only uses the Nokogiri tasks, then they don't need
+  # the IRB dependency.
+  # 
+  # Therefore, it is up to the user to add the dependencies they need.
+  # If the user uses the IRB task, then they will have to add 'irb' as a
+  # development dependency in their own project's Gemspec.
+  
   spec.add_runtime_dependency 'rake' #,'~> 12.3'
   
   spec.add_development_dependency 'bundler','~> 1.17'
+  spec.add_development_dependency 'irb'    ,'~> 1.0'  # For IRBTask
   spec.add_development_dependency 'yard'   ,'~> 0.9'  # For doc
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raketeer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Jonathan Bradley Whited (@esotericpig)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Extra Ruby Rake Tasks. Tasks for IRB, Nokogiri, etc.
+description: Extra Ruby Rake Tasks for IRB, Nokogiri, running, etc.
 email:
 - bradley@esotericpig.com
 executables: []
@@ -70,6 +84,9 @@ files:
 - lib/raketeer/irb_task.rb
 - lib/raketeer/nokogiri_install_tasks.rb
 - lib/raketeer/nokogiri_installs.rb
+- lib/raketeer/run.rb
+- lib/raketeer/run_task.rb
+- lib/raketeer/util.rb
 - lib/raketeer/version.rb
 - raketeer.gemspec
 homepage: https://github.com/esotericpig/raketeer