runfile-tasks 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcc349ca21afd53c294174a39680782d34ecac53d380e624ccf1da31b836600d
-  data.tar.gz: 2cf17d48577138d6c0e12f898afdc85755220d9d25002c47d638f7e02eaed692
+  metadata.gz: 34ce3da6faaa2115da6a60aef9d21d2e2f7b9ab0ffd83450f618bb90931bb2a2
+  data.tar.gz: a83f6488be48514933b7d24e8b5b1c8c1743b62dc17627176432e572a2913486
 SHA512:
-  metadata.gz: 4f9c7ecd0762dff45b63c62f997a495bc8d8b374d7ce0d4ad4fd8a8a161db06812f3cf2a1c58721074e41c3ecb56f969180df1aa3a951fc8a39edd7872a46d9c
-  data.tar.gz: 7f62fc7fb9bbdcd504476a5cbab74d720a933e933f025209d13f2f9a9adfaa1c70970ddf743cae06f315db9c8d61a3c9eecf9c0f8845ac532dc62e565982a151
+  metadata.gz: 75245b3e4dc36ee84bd65ad5c4c8c56e24366fe51bcdeeb7bdf9b4f2a277c5e463d6e71fd96f8d044c72433fd739b6b5fe85e6691324604edb7cb70569b99b44
+  data.tar.gz: f1fdafb4231b39e03d66bd5017d8f1e3d6c05adb75dbaae5f82aa33580be938953312848f426fb7153c05414e1e580afb1d67419048f309d044eb8ee7f310125

data/README.md

@@ -1,202 +1,213 @@
-Runfile Tasks
-==================================================
-
-A library of tasks ready to be included in your [Runfile]
-
-Install
---------------------------------------------------
-
-Install the gem or require it in your Gemfile:
-
-```ruby
-gem 'runfile-tasks'
-```
-
-In your Runfile, you can include either all tasks:
-
-```ruby
-require 'runfile-tasks'
-```
-
-Or pick and choose from the various task categories:
-
-```ruby
-require 'runfile-tasks/testing'
-```
-
-
-Requiring the task packs does not make them available in your Runfile 
-immediately. You need to activate any of the tasks you want as described 
-below.
-
-
-Usage
---------------------------------------------------
-
-
-Include any of the tasks you need in your Runfile like this:
-
-```ruby
-require 'runfile-tasks'
-
-name    "Greeter"
-summary "A sample Runfile"
-version "0.1.0"
-
-# Include rdoc tasks and rspec tasks
-RunfileTasks::Docs.rdoc
-RunfileTasks::Testing.rspec
-
-# The rest of your Runfile goes here
-action :hello do
-  puts "world"
-end
-
-```
-
-
-Task Index
---------------------------------------------------
-
-### Testing Tasks
-
-Require all testing tasks:
-
-```ruby
-require 'runfile-tasks/testing'
-```
-
-#### Testing with RSpec
-
-Commands Added:
-
-- `run spec [NAME] [TAG]` - Run all specs, a single spec file, or all specs 
-  matching a tag.
-
-```ruby
-# Only require the rspec tasks
-require 'runfile-tasks/testing/rspec'
-
-# Include the rspec tasks with default configuration
-RunfileTasks::Testing.rspec
-
-# Set the Runfile action to 'test' instead of the default 'spec'
-RunfileTasks::Testing.rspec 'test'
-
-# Change the default options with a hash (these are the defaults)
-RunfileTasks::rspec action: 'spec', 
-  pattern: './spec/**/*_spec.rb', command: 'rspec'
-
-```
-
-
-#### Testing with Minitest
-
-Commands Added:
-
-- `test [NAME]` - Run all tests or a single test file.
-
-```ruby
-# Only require the minitest tasks
-require 'runfile-tasks/testing/minitest'
-
-# Include the minitest tasks with default configuration
-RunfileTasks::Testing.minitest
-
-# Set the file pattern to look for (this is the default)
-RunfileTasks::Testing.minitest './test/*_test.rb'
-
-```
-
-#### Testing with Cucumber
-
-Commands Added:
-
-- `(feature|features) [<tag_or_file> --list --fast]` - Run cucumber feature 
-  tests or show list of available features.
-- `stepdefs` - Generate a markdown document from the step definitions
-
-```ruby
-# Only require the cucumber tasks
-require 'runfile-tasks/testing/cucumber'
-
-# Include the cucumber tasks with default configuration
-RunfileTasks::Testing.cucumber
-
-# Include the step definitions markdown generator
-RunfileTasks::Testing.cucumber_stepdefs
-```
-
-
-### Gem Authoring Tasks
-
-Commands Added:
-
-- `build [--install]` - Build gem from gemspec and move it to 'gems' folder. 
-   Use --install to also install it.
-- `install [--remote]` - Install gem from local gem file or from rubygems 
-   (--remote).
-- `publish` - Publish gem to rubygems. Make sure to 'run gem build' before 
-   you publish.
-- `yank [VERSION]` - Yank gem from rubygems.
-
-
-```ruby
-require 'runfile-tasks/rubygems'
-
-# Include the tasks with default configuration. Pass in your gem name.
-RunfileTasks::RubyGems.all 'my-gem'
-
-# Set the folder where gems are copied after they are built (default)
-RunfileTasks::RubyGems.all 'my-gem', 'gems'
-
-# Include only the `build` and `install` tasks
-RunfileTasks::RubyGems.build 'my-gem'
-
-# Include only the `publish` and `yank` tasks
-RunfileTasks::RubyGems.publish 'my-gem'
-```
-
-
-### Documentation Tasks
-
-Commands Added:
-
-- `rdoc [-- OPTIONS...]` - Generate documentation using the rdoc command 
-  line tool. To pass arguments to rdoc, place them after '--'.
-
-
-```ruby
-require 'runfile-tasks/docs'
-
-# Include the tasks with default configuration.
-RunfileTasks::Docs.rdoc
-
-# Set the files to be considered (default below)
-RunfileTasks::Docs.rdoc '**/*.{rb,md}'
-
-# Pass any additional option directly to rdoc (defaults below)
-RunfileTasks::Docs.rdoc '**/*.{rb,md}', ["--main README.md", "--all",]
-```
-
-
-### Changelog  Tasks
-
-This command requires that you have [github_changelog_generator] in your Gemfile.
-
-Commands Added:
-
-- `changelog [--commit]` - Generates a changelog and optionally commits it to the git repository.
-
-
-```ruby
-require 'runfile-tasks/changelog'
-
-# Include the task and provide your github user/repo
-RunfileTasks::Changelog.generator "DannyBen/runfile"
-```
-
----
-[Runfile]: https://github.com/DannyBen/runfile
-[random cat]: http://thecatapi.com/api/images/get
-[github_changelog_generator]: https://github.com/github-changelog-generator/github-changelog-generator
+# Runfile Tasks
+
+A library of tasks ready to be included in your [Runfile]
+
+## Install
+
+Install the gem or require it in your Gemfile:
+
+```ruby
+gem 'runfile-tasks'
+```
+
+In your Runfile, you can include either all tasks:
+
+```ruby
+require 'runfile-tasks'
+```
+
+Or pick and choose from the various task categories:
+
+```ruby
+require 'runfile-tasks/testing'
+```
+
+
+Requiring the task packs does not make them available in your Runfile 
+immediately. You need to activate any of the tasks you want as described 
+below.
+
+
+## Usage
+
+Include any of the tasks you need in your Runfile like this:
+
+```ruby
+require 'runfile-tasks'
+
+name    "Greeter"
+summary "A sample Runfile"
+version "0.1.0"
+
+# Include rdoc tasks and rspec tasks
+RunfileTasks::Docs.rdoc
+RunfileTasks::Testing.rspec
+
+# The rest of your Runfile goes here
+action :hello do
+  puts "world"
+end
+
+```
+
+
+## Task Index
+
+### Testing Tasks
+
+Require all testing tasks:
+
+```ruby
+require 'runfile-tasks/testing'
+```
+
+#### Testing with RSpec
+
+Commands Added:
+
+- `run spec [NAME] [TAG]` - Run all specs, a single spec file, or all specs 
+  matching a tag.
+
+```ruby
+# Only require the rspec tasks
+require 'runfile-tasks/testing/rspec'
+
+# Include the rspec tasks with default configuration
+RunfileTasks::Testing.rspec
+
+# Set the Runfile action to 'test' instead of the default 'spec'
+RunfileTasks::Testing.rspec 'test'
+
+# Change the default options with a hash (these are the defaults)
+RunfileTasks::rspec action: 'spec', 
+  pattern: './spec/**/*_spec.rb', command: 'rspec'
+
+```
+
+
+#### Testing with Minitest
+
+Commands Added:
+
+- `test [NAME]` - Run all tests or a single test file.
+
+```ruby
+# Only require the minitest tasks
+require 'runfile-tasks/testing/minitest'
+
+# Include the minitest tasks with default configuration
+RunfileTasks::Testing.minitest
+
+# Set the file pattern to look for (this is the default)
+RunfileTasks::Testing.minitest './test/*_test.rb'
+
+```
+
+#### Testing with Cucumber
+
+Commands Added:
+
+- `(feature|features) [<tag_or_file> --list --fast]` - Run cucumber feature 
+  tests or show list of available features.
+- `stepdefs` - Generate a markdown document from the step definitions
+
+```ruby
+# Only require the cucumber tasks
+require 'runfile-tasks/testing/cucumber'
+
+# Include the cucumber tasks with default configuration
+RunfileTasks::Testing.cucumber
+
+# Include the step definitions markdown generator
+RunfileTasks::Testing.cucumber_stepdefs
+```
+
+
+### Gem Authoring Tasks
+
+Commands Added:
+
+- `build [--install]` - Build gem from gemspec and move it to 'gems' folder. 
+   Use --install to also install it.
+- `install [--remote]` - Install gem from local gem file or from rubygems 
+   (--remote).
+- `publish` - Publish gem to rubygems. Make sure to 'run gem build' before 
+   you publish.
+- `yank [VERSION]` - Yank gem from rubygems.
+
+
+```ruby
+require 'runfile-tasks/rubygems'
+
+# Include the tasks with default configuration. Pass in your gem name.
+RunfileTasks::RubyGems.all 'my-gem'
+
+# Set the folder where gems are copied after they are built (default)
+RunfileTasks::RubyGems.all 'my-gem', 'gems'
+
+# Include only the `build` and `install` tasks
+RunfileTasks::RubyGems.build 'my-gem'
+
+# Include only the `publish` and `yank` tasks
+RunfileTasks::RubyGems.publish 'my-gem'
+```
+
+
+### Documentation Tasks
+
+Commands Added:
+
+- `rdoc [-- OPTIONS...]` - Generate documentation using the rdoc command 
+  line tool. To pass arguments to rdoc, place them after '--'.
+
+
+```ruby
+require 'runfile-tasks/docs'
+
+# Include the tasks with default configuration.
+RunfileTasks::Docs.rdoc
+
+# Set the files to be considered (default below)
+RunfileTasks::Docs.rdoc '**/*.{rb,md}'
+
+# Pass any additional option directly to rdoc (defaults below)
+RunfileTasks::Docs.rdoc '**/*.{rb,md}', ["--main README.md", "--all",]
+```
+
+
+### Docker Tasks
+
+Commands Added:
+
+- `docker build`
+- `docker test`
+- `docker push`
+
+```ruby
+require 'runfile-tasks/docker'
+
+# Provide an image name and version
+RunfileTasks::Docker.all "dannyben/runfile", "0.1.0"
+```
+
+
+### Changelog Tasks
+
+This command requires that you have [github_changelog_generator] in your Gemfile.
+
+Commands Added:
+
+- `changelog [--commit]` - Generates a changelog and optionally commits it to the git repository.
+
+
+```ruby
+require 'runfile-tasks/changelog'
+
+# Include the task and provide your github user/repo
+RunfileTasks::Changelog.generator "DannyBen/runfile"
+```
+
+---
+[Runfile]: https://github.com/DannyBen/runfile
+[random cat]: http://thecatapi.com/api/images/get
+[github_changelog_generator]: https://github.com/github-changelog-generator/github-changelog-generator

data/lib/runfile-tasks/all.rb

@@ -1,6 +1,7 @@
-require "runfile-tasks/version"
-
-require "runfile-tasks/rubygems"
-require "runfile-tasks/docs"
-require "runfile-tasks/testing"
-require "runfile-tasks/changelog"
+require "runfile-tasks/version"
+
+require "runfile-tasks/rubygems"
+require "runfile-tasks/docs"
+require "runfile-tasks/testing"
+require "runfile-tasks/changelog"
+require "runfile-tasks/docker"

data/lib/runfile-tasks/docker/all.rb

@@ -0,0 +1 @@
+require 'runfile-tasks/docker/docker'

data/lib/runfile-tasks/docker/docker.rb

@@ -0,0 +1,61 @@
+require 'runfile-tasks/refinements'
+
+module RunfileTasks
+  module Docker
+    extend self
+    using Refinements
+
+    def all(image_name, image_version)
+      build image_name, image_version
+      test image_name, image_version
+      push image_name, image_version
+    end
+
+    def build(image_name, image_version)
+      command "docker"
+
+      help   "Build the docker image"
+      action :build, :b do |args|
+        puts "g`Building docker image #{image_name}`".in_color
+        system "docker build -t #{image_name} ."
+        system "docker tag #{image_name} #{image_name}:#{image_version}"
+        system "docker images | grep #{image_name}"
+      end
+
+      endcommand
+    end
+
+    def test(image_name, image_version)
+      command "docker"
+
+      help   "Test the --version flag in the dockerized version"
+      action :test, :t do |args|
+        docker_version = `docker run --rm #{image_name} --version`.chomp
+        if docker_version != image_version
+          puts "r`FAIL: docker version is #{docker_version}, expected #{image_version}`".in_color
+          exit 1
+        else
+          puts "g`PASS: docker version is #{docker_version}`"
+        end
+      end
+
+      endcommand
+    end
+
+    def push(image_name, image_version)
+      command "docker"
+
+      help   "Build the docker image"
+      action :push, :p do |args|
+        puts "g`Pushing docker image #{image_name}`".in_color
+        system "docker push #{image_name}"
+        system "docker push #{image_name}:#{image_version}"
+      end
+
+      endcommand
+    end
+
+
+  end
+
+end

data/lib/runfile-tasks/docker.rb

@@ -0,0 +1 @@
+require 'runfile-tasks/docker/all'

data/lib/runfile-tasks/version.rb

@@ -1,3 +1,3 @@
 module RunfileTasks
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runfile-tasks
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-28 00:00:00.000000000 Z
+date: 2022-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: runfile
@@ -34,6 +34,9 @@ files:
 - lib/runfile-tasks.rb
 - lib/runfile-tasks/all.rb
 - lib/runfile-tasks/changelog.rb
+- lib/runfile-tasks/docker.rb
+- lib/runfile-tasks/docker/all.rb
+- lib/runfile-tasks/docker/docker.rb
 - lib/runfile-tasks/docs.rb
 - lib/runfile-tasks/docs/all.rb
 - lib/runfile-tasks/docs/rdoc.rb
@@ -66,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Runfile tasks collection