ztk 1.17.1 → 1.17.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. checksums.yaml +8 -8
  2. data/README.md +49 -5
  3. data/lib/ztk/version.rb +1 -1
  4. data/ztk.gemspec +2 -2
  5. metadata +11 -5
checksums.yaml CHANGED
@@ -1,15 +1,15 @@
1
1
  ---
2
2
  !binary "U0hBMQ==":
3
3
  metadata.gz: !binary |-
4
- ZTkwNDIzYzQ5OTUwMjFmZDc3ZGRjMTRlZWMyYzkxMjMzZWJjNTg5Mw==
4
+ NGE1OTcyNThmN2M1ODY3Y2MxMjlhZjdmMjZiZTRlMGViZDViOTJhMg==
5
5
  data.tar.gz: !binary |-
6
- OTgzM2JhMmIxOTNkZjE1ZTRlYzU2ODI2OTVjZjM4YjdmZjg1NmU4Yw==
6
+ YmYxZTU0M2M0MmRkZThiZWE5ZjE4ZDAzYzgxMTU3OWJmNTNlODU5YQ==
7
7
  SHA512:
8
8
  metadata.gz: !binary |-
9
- OTY3YmVkOWEyNzA2ZDJhODk1ZTA0ZjE5YzU4M2U1YTE2NzYxMTBjMzcxMGMx
10
- OTA5YWIwOTk5MzAxNDExYWJmOWQxYTJiYTc0ZGY4YzgwMGYyMDdmYThhMGNj
11
- MmJkZDQ4N2NjZDFkOWNkZWY4ZGNhZjBhMmViOTJmYzMwODc3NTg=
9
+ YmQ4MzFlMzU3MzkxZmYzOGY1MDI1NjJlMmFmNjNhZmI0NjRmZjgyOWZjODY3
10
+ MmUwOTdlNmM3ODM1ZmNhN2U1ODhhODBmMzI2OTI2OWIyMzViNmQ5NzY2Mzdl
11
+ ZmJlYWNlMzZlODhkZDE2NDcxOGQ4OTcwZDcwOGUwMDY0Y2U1Y2U=
12
12
  data.tar.gz: !binary |-
13
- MDQxN2U5MGY4NjU3NjY3ZGFhOTQ0N2U5Yjg0YTQ0ZGQ1MGI4MDkyOWZlYjg3
14
- ZWZkNWE2M2Y4YzIxNmRmNDNiZTA1MzY3YjkwMWFkOGQ1YThjMWNhMDY3YWVh
15
- MzdiMzMyZTZiZGMxNGFkYTY0ZGE0MGFiMzlmMDFmMDg3MzU2YmQ=
13
+ MzRmNTUwODEyOGFhYjcyNGM2M2M1MDc2ZjEzMzBmNjJhOGQxYTNjYzI5OTQ0
14
+ NzE5ZTc4ZmVjMDAyN2VkN2JhNWYxNjE0NTQzN2Y4MzdiNzAxYzZlOTQ3Njg3
15
+ NmY1MWUxY2Y0NGRkM2M4NzNhYjA5Njg2ODFjNjlhNmQ3MWNiMzk=
data/README.md CHANGED
@@ -6,27 +6,71 @@
6
6
 
7
7
  # ZTK
8
8
 
9
- Zachary's Tool Kit is a general purpose utility gem, featuring a collection of classes meant to simplify development of complex systems in Ruby.
9
+ Zachary's Tool Kit contains a collection of reusable classes meant to simplify development of complex systems in Ruby, especially devops tooling. These classes provide functionality I often find myself needing from project to project. Instead of reinventing the wheel each time, I've started building a collection of reusable classes. Easy-bake DSLs, parallel processing, complex logging, templating and many other useful design patterns, for example are all contained in simple, reusable classes with a common interface and configuration style.
10
10
 
11
- - **ZTK::DSL**
11
+ - **ZTK::ANSI**
12
12
 
13
- Create your own DSL in seconds by inheriting this DSL class. Featuring ActiveRecord style associations where DSL objects can `belong_to` or `has_many` other DSL objects.
13
+ This mixin module gives you the ability to easily add ANSI colors to strings. It also has a method for stripping all ANSI codes out of a string. Read more at the [ZTK::ANSI](http://zpatten.github.io/ztk/ZTK/ANSI.html) documentation.
14
14
 
15
15
  - **ZTK::Background**
16
16
 
17
17
  Easily run a processes in the background. Read more at the [ZTK::Background](http://zpatten.github.io/ztk/ZTK/Background.html) documentation.
18
18
 
19
+ - **ZTK::Benchmark**
20
+
21
+ Benchmark your code and optionally display messages and/or an "activity" indicator (i.e. spinning cursor). Read more at the [ZTK::Benchmark](http://zpatten.github.io/ztk/ZTK/Benchmark.html) documentation.
22
+
23
+ - **ZTK::Command**
24
+
25
+ Execute local commands controlling STDOUT, STDERR and STDIN as needed plus enhanced Logger support. Read more at the [ZTK::Command](http://zpatten.github.io/ztk/ZTK/Command.html) documentation.
26
+
27
+ - **ZTK::Config**
28
+
29
+ Use Ruby based configuration files with easy. Inspired by Chef's mixlib-config. Read more at the [ZTK::Config](http://zpatten.github.io/ztk/ZTK/Config.html) documentation.
30
+
31
+ - **ZTK::DSL**
32
+
33
+ Create your own DSL in seconds by inheriting this DSL class. Featuring ActiveRecord style associations where DSL objects can `belong_to` or `has_many` other DSL objects. Read more at the [ZTK::DSL::Base](http://zpatten.github.io/ztk/ZTK/DSL/Base.html) documentation.
34
+
35
+ - **ZTK::Locator**
36
+
37
+ Search for files or directories backwards up the present working directory tree. Read more at the [ZTK::Locator](http://zpatten.github.io/ztk/ZTK/Locator.html) documentation.
38
+
19
39
  - **ZTK::Logger**
20
40
 
21
41
  Based off the core Ruby logger, this is meant to be a drop in replacement. Features added logging information, including PID, uSec time resolution, method and line numbers of logging statements (i.e. the caller). One can seamlessly chain Ruby loggers using ZTK:Logger, for example to output logs to both STDOUT and a log file on disk at the same time; all while maintaining compatibility with the core Ruby logger. Read more at the [ZTK::Logger](http://zpatten.github.io/ztk/ZTK/Logger.html) documentation.
22
42
 
23
43
  - **ZTK::Parallel**
24
44
 
25
- Easily turn most iterative tasks into a parallel processes and easily leverage multiple cores to speed up processing large sets of data. Read more at the [ZTK::Parallel](http://zpatten.github.io/ztk/ZTK/Parallel.html) documentation.
45
+ Easily turn linear iterative tasks into parallel tasks and leverage multiple cores to speed up processing of your large sets of data. Read more at the [ZTK::Parallel](http://zpatten.github.io/ztk/ZTK/Parallel.html) documentation.
46
+
47
+ - **ZTK::Report**
48
+
49
+ Console based reporting class which allows you to easily output either list or spreadsheet based reports from sets of data. Read more at the [ZTK::Report](http://zpatten.github.io/ztk/ZTK/Report.html) documentation.
50
+
51
+ - **ZTK::RescueRetry**
52
+
53
+ Certain cases warrant retries when exceptions occur. With this class you can wrap code allowing retries in certain scenarios. The class allows for full customization so you can fit it easily to your needs. Read more at the [ZTK::RescueRetry](http://zpatten.github.io/ztk/ZTK/RescueRetry.html) documentation.
54
+
55
+ - **ZTK::Spinner**
56
+
57
+ The spinner `ZTK::Benchmark` relies on. With this class you can bend it to YOUR will! Read more at [ZTK::Spinner](http://zpatten.github.io/ztk/ZTK/Spinner.html) documentation.
26
58
 
27
59
  - **ZTK::SSH**
28
60
 
29
- An SSH class that nicely wraps up all of the SSH gems into a nice uniform interface, complete with transfer progress callbacks. It is meant to function as a drop in replacement, but I admit this has not been heavily tested like in the case of the ZTK::Logger class. It provides the ability to switch between SCP and SFTP for file transfers seamlessly. Full SSH proxy support as well, plus methods to spawn up interactive SSH consoles via `Kernel.exec`. Read more at the [ZTK::SSH](http://zpatten.github.io/ztk/ZTK/SSH.html) documentation.
61
+ An SSH class that nicely wraps up all of the SSH gems into a nice uniform interface, complete with transfer progress callbacks and enhanced Logger support. It is meant to function as a drop in replacement, but I admit this has not been heavily tested like in the case of the ZTK::Logger class. It provides the ability to switch between SCP and SFTP for file transfers seamlessly. Full SSH proxy support as well, plus methods to spawn up interactive SSH consoles via `Kernel.exec`. Read more at the [ZTK::SSH](http://zpatten.github.io/ztk/ZTK/SSH.html) documentation.
62
+
63
+ - **ZTK::TCPSocketCheck**
64
+
65
+ This class provides a convient way to test if something is listening on a TCP port. One can test a varity of scenarios, including sending data across the socket and waiting for a response. Read more at the [ZTK::TCPSocketCheck](http://zpatten.github.io/ztk/ZTK/TCPSocketCheck.html) documentation.
66
+
67
+ - **ZTK::Template**
68
+
69
+ Easily create Erubis based content with this class. Read more at the [ZTK::Template](http://zpatten.github.io/ztk/ZTK/Template.html) documentation.
70
+
71
+ - **ZTK::UI**
72
+
73
+ UI management; this class encapsulates STDOUT, STDERR, STDIN and a Ruby logger; as well as some other helpful flags. This allows you to easily present a unified UI interface and allows for easy redirection of that interface (really helpful when using StringIO's with rspec to test program output for example). Read more at the [ZTK::UI](http://zpatten.github.io/ztk/ZTK/UI.html) documentation.
30
74
 
31
75
  # RUBIES TESTED AGAINST
32
76
 
data/lib/ztk/version.rb CHANGED
@@ -1,6 +1,6 @@
1
1
  module ZTK
2
2
 
3
3
  # ZTK Version String
4
- VERSION = "1.17.1"
4
+ VERSION = "1.17.2"
5
5
 
6
6
  end
data/ztk.gemspec CHANGED
@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
26
26
  spec.version = ZTK::VERSION
27
27
  spec.authors = ["Zachary Patten"]
28
28
  spec.email = ["zachary AT jovelabs DOT com"]
29
- spec.description = %(Zachary's Tool Kit is a general purpose utility gem, featuring a collection of classes meant to simplify development of complex systems in Ruby.)
30
- spec.summary = %(Zachary's Tool Kit)
29
+ spec.description = %(Zachary's Tool Kit contains a collection of reusable classes meant to simplify development of complex systems in Ruby, especially devops tooling. These classes provide functionality I often find myself needing from project to project. Instead of reinventing the wheel each time, I've started building a collection of reusable classes. Easy-bake DSLs, parallel processing, complex logging, templating and many other useful design patterns, for example are all contained in simple, reusable classes with a common interface and configuration style.)
30
+ spec.summary = %(Zachary's Tool Kit contains a collection of reusable classes meant to simplify development of complex systems in Ruby, especially devops tooling.)
31
31
  spec.homepage = "https://github.com/zpatten/ztk"
32
32
  spec.license = "Apache 2.0"
33
33
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ztk
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.17.1
4
+ version: 1.17.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Zachary Patten
@@ -234,8 +234,13 @@ dependencies:
234
234
  - - ! '>='
235
235
  - !ruby/object:Gem::Version
236
236
  version: '0'
237
- description: Zachary's Tool Kit is a general purpose utility gem, featuring a collection
238
- of classes meant to simplify development of complex systems in Ruby.
237
+ description: Zachary's Tool Kit contains a collection of reusable classes meant to
238
+ simplify development of complex systems in Ruby, especially devops tooling. These
239
+ classes provide functionality I often find myself needing from project to project. Instead
240
+ of reinventing the wheel each time, I've started building a collection of reusable
241
+ classes. Easy-bake DSLs, parallel processing, complex logging, templating and many
242
+ other useful design patterns, for example are all contained in simple, reusable
243
+ classes with a common interface and configuration style.
239
244
  email:
240
245
  - zachary AT jovelabs DOT com
241
246
  executables:
@@ -345,10 +350,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
345
350
  version: '0'
346
351
  requirements: []
347
352
  rubyforge_project:
348
- rubygems_version: 2.2.1
353
+ rubygems_version: 2.1.11
349
354
  signing_key:
350
355
  specification_version: 4
351
- summary: Zachary's Tool Kit
356
+ summary: Zachary's Tool Kit contains a collection of reusable classes meant to simplify
357
+ development of complex systems in Ruby, especially devops tooling.
352
358
  test_files:
353
359
  - spec/spec_helper.rb
354
360
  - spec/support/before_install.sh