runcom 6.0.0 → 6.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data.tar.gz.sig +2 -1
- data/{LICENSE.md → LICENSE.adoc} +29 -30
- data/README.adoc +232 -0
- data/lib/runcom/identity.rb +4 -15
- metadata +67 -38
- metadata.gz.sig +1 -1
- data/README.md +0 -193
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9cbe2be085880968f8a6e889ada8f3832401a0aa54f7fa5c03c9a02e201b4230
|
4
|
+
data.tar.gz: c7129bd4399edca15c5e78bb899ba0cc03d01e44c411d3ed1311dca59188dd58
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7f22faed6b991412426481a308fa333c64be38559d53ab5bd7c3816d1ba15cdd892f05a4e2c1258c522ce982860848d135d23d40c5b934bfb3ec6c4f18e187a1
|
7
|
+
data.tar.gz: 769288373c5eb246eba7a375e02035df0be2280fdd51c92c9fc5b023dcc3a30da30c907fd1fb4ff633e47356684909d732d425d3c105f64e5db29e0ee0711cdb
|
checksums.yaml.gz.sig
CHANGED
Binary file
|
data.tar.gz.sig
CHANGED
@@ -1 +1,2 @@
|
|
1
|
-
|
1
|
+
Z�iG�ōO �0R�����"��.~�>X��SW�>���6�I`B�,BT!���`?�.����'�R�'�n��U�����U�̽[c�k�+�)?I� %P\0����y9�9���#y�G��F��p�8fVA��Y+����q�s���o��k�Gq��,��-��WFޣ�Ӟؿ��
|
2
|
+
�1�,M:������]�J�3j�{��h���8�ߏշFY+�[j�/|�F�c������\s\
|
data/{LICENSE.md → LICENSE.adoc}
RENAMED
@@ -1,4 +1,4 @@
|
|
1
|
-
|
1
|
+
= Apache License
|
2
2
|
|
3
3
|
Version 2.0, January 2004
|
4
4
|
|
@@ -6,7 +6,7 @@ http://www.apache.org/licenses
|
|
6
6
|
|
7
7
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
8
8
|
|
9
|
-
|
9
|
+
== 1. Definitions
|
10
10
|
|
11
11
|
"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
|
12
12
|
Sections 1 through 9 of this document.
|
@@ -54,14 +54,14 @@ Contribution."
|
|
54
54
|
"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
|
55
55
|
Contribution has been received by Licensor and subsequently incorporated within the Work.
|
56
56
|
|
57
|
-
|
57
|
+
== 2. Grant of Copyright License
|
58
58
|
|
59
59
|
Subject to the terms and conditions of this License, each Contributor hereby grants to You a
|
60
60
|
perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
|
61
61
|
reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
|
62
62
|
distribute the Work and such Derivative Works in Source or Object form.
|
63
63
|
|
64
|
-
|
64
|
+
== 3. Grant of Patent License
|
65
65
|
|
66
66
|
Subject to the terms and conditions of this License, each Contributor hereby grants to You a
|
67
67
|
perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
|
@@ -74,39 +74,38 @@ a Contribution incorporated within the Work constitutes direct or contributory p
|
|
74
74
|
then any patent licenses granted to You under this License for that Work shall terminate as of the
|
75
75
|
date such litigation is filed.
|
76
76
|
|
77
|
-
|
77
|
+
== 4. Redistribution
|
78
78
|
|
79
79
|
You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
|
80
80
|
or without modifications, and in Source or Object form, provided that You meet the following
|
81
81
|
conditions:
|
82
82
|
|
83
|
-
|
83
|
+
. You must give any other recipients of the Work or Derivative Works a copy of this License; and
|
84
84
|
|
85
|
-
|
86
|
-
|
85
|
+
. You must cause any modified files to carry prominent notices stating that You changed the files;
|
86
|
+
and
|
87
87
|
|
88
|
-
|
89
|
-
|
90
|
-
|
88
|
+
. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
|
89
|
+
patent, trademark, and attribution notices from the Source form of the Work, excluding those
|
90
|
+
notices that do not pertain to any part of the Derivative Works; and
|
91
91
|
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
construed as modifying the License.
|
92
|
+
. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
|
93
|
+
that You distribute must include a readable copy of the attribution notices contained within such
|
94
|
+
NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
|
95
|
+
at least one of the following places: within a NOTICE text file distributed as part of the
|
96
|
+
Derivative Works; within the Source form or documentation, if provided along with the Derivative
|
97
|
+
Works; or, within a display generated by the Derivative Works, if and wherever such third-party
|
98
|
+
notices normally appear. The contents of the NOTICE file are for informational purposes only and
|
99
|
+
do not modify the License. You may add Your own attribution notices within Derivative Works that
|
100
|
+
You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
|
101
|
+
additional attribution notices cannot be construed as modifying the License.
|
103
102
|
|
104
103
|
You may add Your own copyright statement to Your modifications and may provide additional or
|
105
104
|
different license terms and conditions for use, reproduction, or distribution of Your modifications,
|
106
105
|
or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
|
107
106
|
the Work otherwise complies with the conditions stated in this License.
|
108
107
|
|
109
|
-
|
108
|
+
== 5. Submission of Contributions
|
110
109
|
|
111
110
|
Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
|
112
111
|
Work by You to the Licensor shall be under the terms and conditions of this License, without any
|
@@ -114,13 +113,13 @@ additional terms or conditions. Notwithstanding the above, nothing herein shall
|
|
114
113
|
the terms of any separate license agreement you may have executed with Licensor regarding such
|
115
114
|
Contributions.
|
116
115
|
|
117
|
-
|
116
|
+
== 6. Trademarks
|
118
117
|
|
119
118
|
This License does not grant permission to use the trade names, trademarks, service marks, or product
|
120
119
|
names of the Licensor, except as required for reasonable and customary use in describing the origin
|
121
120
|
of the Work and reproducing the content of the NOTICE file.
|
122
121
|
|
123
|
-
|
122
|
+
== 7. Disclaimer of Warranty
|
124
123
|
|
125
124
|
Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
|
126
125
|
Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
@@ -129,7 +128,7 @@ TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. Y
|
|
129
128
|
responsible for determining the appropriateness of using or redistributing the Work and assume any
|
130
129
|
risks associated with Your exercise of permissions under this License.
|
131
130
|
|
132
|
-
|
131
|
+
== 8. Limitation of Liability
|
133
132
|
|
134
133
|
In no event and under no legal theory, whether in tort (including negligence), contract, or
|
135
134
|
otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
|
@@ -139,7 +138,7 @@ License or out of the use or inability to use the Work (including but not limite
|
|
139
138
|
loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
|
140
139
|
damages or losses), even if such Contributor has been advised of the possibility of such damages.
|
141
140
|
|
142
|
-
|
141
|
+
== 9. Accepting Warranty or Additional Liability
|
143
142
|
|
144
143
|
While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
|
145
144
|
for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
|
@@ -151,11 +150,11 @@ additional liability.
|
|
151
150
|
|
152
151
|
END OF TERMS AND CONDITIONS
|
153
152
|
|
154
|
-
Copyright 2016
|
153
|
+
Copyright 2016 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
|
155
154
|
|
156
155
|
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
|
157
|
-
compliance with the License. You may obtain a
|
158
|
-
the License.
|
156
|
+
compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]
|
157
|
+
of the License.
|
159
158
|
|
160
159
|
Unless required by applicable law or agreed to in writing, software distributed under the License is
|
161
160
|
distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
data/README.adoc
ADDED
@@ -0,0 +1,232 @@
|
|
1
|
+
:toc: macro
|
2
|
+
:toclevels: 5
|
3
|
+
:figure-caption!:
|
4
|
+
|
5
|
+
= Runcom
|
6
|
+
|
7
|
+
[link=http://badge.fury.io/rb/runcom]
|
8
|
+
image::https://badge.fury.io/rb/runcom.svg[Gem Version]
|
9
|
+
[link=https://circleci.com/gh/bkuhlmann/runcom]
|
10
|
+
image::https://circleci.com/gh/bkuhlmann/runcom.svg?style=svg[Circle CI Status]
|
11
|
+
|
12
|
+
Runcom (short for link:https://en.wikipedia.org/wiki/Run_commands[Run Command]) provides common
|
13
|
+
functionality for Command Line Interfaces (CLIs) in which to manage global, local, or multiple
|
14
|
+
caches, configurations, or data in general. It does this by leveraging the
|
15
|
+
https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html[XDG Base Directory
|
16
|
+
Specification] built atop the link:https://www.alchemists.io/projects/xdg[XDG] implementation.
|
17
|
+
|
18
|
+
toc::[]
|
19
|
+
|
20
|
+
== Features
|
21
|
+
|
22
|
+
* Wraps the link:https://www.alchemists.io/projects/xdg[XDG] implementation which provides access to
|
23
|
+
the following environment variables:
|
24
|
+
** `+$XDG_CACHE_HOME+`
|
25
|
+
** `+$XDG_CONFIG_HOME+`
|
26
|
+
** `+$XDG_CONFIG_DIRS+`
|
27
|
+
** `+$XDG_DATA_HOME+`
|
28
|
+
** `+$XDG_DATA_DIRS+`
|
29
|
+
* Enhances the XDG cache, config, and data implementation. For the config, the following is
|
30
|
+
supported:
|
31
|
+
** Supports loading of CLI-specific http://yaml.org[YAML] configuration file.
|
32
|
+
** Supports loading and merging of nested/complex configurations.
|
33
|
+
** Supports hash representation of configuration.
|
34
|
+
|
35
|
+
== Requirements
|
36
|
+
|
37
|
+
. https://www.ruby-lang.org[Ruby]
|
38
|
+
|
39
|
+
== Setup
|
40
|
+
|
41
|
+
To install, run:
|
42
|
+
|
43
|
+
[source,bash]
|
44
|
+
----
|
45
|
+
gem install runcom
|
46
|
+
----
|
47
|
+
|
48
|
+
Add the following to your Gemfile:
|
49
|
+
|
50
|
+
[source,ruby]
|
51
|
+
----
|
52
|
+
gem "runcom"
|
53
|
+
----
|
54
|
+
|
55
|
+
== Usage
|
56
|
+
|
57
|
+
The following describes the enhancements built atop the
|
58
|
+
link:https://www.alchemists.io/projects/xdg[XDG] implementation.
|
59
|
+
|
60
|
+
=== Overview
|
61
|
+
|
62
|
+
While there isn’t an environment convenience object as found in the `+XDG+` namespace, you can
|
63
|
+
instantiate each object individually:
|
64
|
+
|
65
|
+
[source,ruby]
|
66
|
+
----
|
67
|
+
cache = Runcom::Cache.new "example/data.json"
|
68
|
+
config = Runcom::Config.new "example/configuration.yml"
|
69
|
+
data = Runcom::Data.new "example/store.dat"
|
70
|
+
----
|
71
|
+
|
72
|
+
Each of the above objects share the same API:
|
73
|
+
|
74
|
+
* `#relative` - Answers the relative path from which the object was constructed.
|
75
|
+
* `#namespace` - Answers the relative namespace as a pathname object from which the object was
|
76
|
+
constructed. The namespace must be identical across the cache, config, and data objects as this is
|
77
|
+
what uniquely identifies and organizes all files associated with your program.
|
78
|
+
* `#file_name` - Answers the file name from which the object was constructed.
|
79
|
+
* `#current` - Answers first _existing_ file system path computed by `$XDG_*_HOME` followed by each
|
80
|
+
computed `$XDG_*_DIRS` path in order defined. Otherwise, `nil` is answered back.
|
81
|
+
* `#all` - Answers all file system paths which is the combined `$XDG_*_HOME` and
|
82
|
+
`$XDG_*_DIRS` values in order defined. These paths _may_ or _may not_ exist on the file system.
|
83
|
+
* `#inspect` - Answers a string representation of default XDG home and directory paths for debugging
|
84
|
+
purposes.
|
85
|
+
|
86
|
+
Using the `cache` object (created above) as an example, here is what each method answers back:
|
87
|
+
|
88
|
+
[source,ruby]
|
89
|
+
----
|
90
|
+
cache.relative # => #<Pathname:example/data.json>
|
91
|
+
cache.namespace # #<Pathname:example>
|
92
|
+
cache.file_name # #<Pathname:data.json>
|
93
|
+
cache.current # #<Pathname:/Users/bkuhlmann/.cache/example/data.json>
|
94
|
+
cache.all # [#<Pathname:/Users/bkuhlmann/.cache/example/data.json>]
|
95
|
+
cache.inspect # "XDG_CACHE_HOME=/Users/bkuhlmann/.cache"
|
96
|
+
----
|
97
|
+
|
98
|
+
=== Variable Priority
|
99
|
+
|
100
|
+
Path precedence is determined in the following order (with the first taking highest priority):
|
101
|
+
|
102
|
+
. *Local Configuration* - If a `$XDG_*_HOME` or `$XDG_*_DIRS` path relative to the
|
103
|
+
current working directory is detected, it will take precedence over the global configuration.
|
104
|
+
This is the same behavior as found in Git where the local `.git/config` takes precedence over the
|
105
|
+
global `$HOME/.gitconfig`.
|
106
|
+
. *Global Configuration* - When a local configuration isn’t found, the global configuration is used
|
107
|
+
as defined by the _XDG Base Directory Specification_.
|
108
|
+
|
109
|
+
=== Configuration Specialization
|
110
|
+
|
111
|
+
The `Runcom::Config` deserves additional highlighting as it provides support for loading custom
|
112
|
+
CLI configurations directly from the command line or from custom locations. It is meant to be used
|
113
|
+
within your program(s).
|
114
|
+
|
115
|
+
An object is initialized as follows:
|
116
|
+
|
117
|
+
[source,ruby]
|
118
|
+
----
|
119
|
+
configuration = Runcom::Config.new "example/configuration.yml"
|
120
|
+
----
|
121
|
+
|
122
|
+
Default settings can be initialized as well:
|
123
|
+
|
124
|
+
[source,ruby]
|
125
|
+
----
|
126
|
+
configuration = Runcom::Config.new "example/configuration.yml", defaults: {name: "Example"}
|
127
|
+
----
|
128
|
+
|
129
|
+
Once a configuration has been initialized, a hash representation can be obtained:
|
130
|
+
|
131
|
+
[source,ruby]
|
132
|
+
----
|
133
|
+
configuration.to_h
|
134
|
+
----
|
135
|
+
|
136
|
+
A configuration can be merged with another hash (handy for runtime overrides):
|
137
|
+
|
138
|
+
[source,ruby]
|
139
|
+
----
|
140
|
+
updated_configuration = configuration.merge {name: "Updated Name"}
|
141
|
+
----
|
142
|
+
|
143
|
+
A configuration can also be merged with another configuration:
|
144
|
+
|
145
|
+
[source,ruby]
|
146
|
+
----
|
147
|
+
updated_configuration = configuration.merge Runcom::Config.new("other", defaults: {a: 1})
|
148
|
+
----
|
149
|
+
|
150
|
+
The current path of the configuration can be asked for as well:
|
151
|
+
|
152
|
+
[source,ruby]
|
153
|
+
----
|
154
|
+
configuration.current # "~/.config/example/configuration.yml"
|
155
|
+
----
|
156
|
+
|
157
|
+
For further details, study the public interface as provided by the
|
158
|
+
link:lib/runcom/config.rb[`Runcom::Config`] object.
|
159
|
+
|
160
|
+
=== Examples
|
161
|
+
|
162
|
+
Examples of gems built atop this gem are:
|
163
|
+
|
164
|
+
* link:https://www.alchemists.io/projects/gemsmith[Gemsmith] - A command line interface for smithing
|
165
|
+
new Ruby gems.
|
166
|
+
* link:https://www.alchemists.io/projects/git-cop[Git Cop] - Enforces consistent Git commits.
|
167
|
+
* link:https://www.alchemists.io/projects/milestoner[Milestoner] - A command line interface for
|
168
|
+
releasing Git repository milestones.
|
169
|
+
* link:https://www.alchemists.io/projects/pennyworth[Pennyworth] - A command line interface that
|
170
|
+
enhances and extends link:https://www.alfredapp.com[Alfred] with Ruby support.
|
171
|
+
* link:https://www.alchemists.io/projects/pragmater[Pragmater] - A command line interface for
|
172
|
+
managing/formatting source file pragma comments.
|
173
|
+
* link:https://www.alchemists.io/projects/sublime_text_kit[Sublime Text Kit] - A command line
|
174
|
+
interface for managing Sublime Text metadata.
|
175
|
+
* link:https://www.alchemists.io/projects/tocer[Tocer] - A command line interface for generating
|
176
|
+
table of contents for Markdown files.
|
177
|
+
|
178
|
+
== Development
|
179
|
+
|
180
|
+
To contribute, run:
|
181
|
+
|
182
|
+
[source,bash]
|
183
|
+
----
|
184
|
+
git clone https://github.com/bkuhlmann/runcom.git
|
185
|
+
cd runcom
|
186
|
+
bin/setup
|
187
|
+
----
|
188
|
+
|
189
|
+
You can also use the IRB console for direct access to all objects:
|
190
|
+
|
191
|
+
[source,bash]
|
192
|
+
----
|
193
|
+
bin/console
|
194
|
+
----
|
195
|
+
|
196
|
+
== Tests
|
197
|
+
|
198
|
+
To test, run:
|
199
|
+
|
200
|
+
[source,bash]
|
201
|
+
----
|
202
|
+
bundle exec rake
|
203
|
+
----
|
204
|
+
|
205
|
+
== Versioning
|
206
|
+
|
207
|
+
Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
|
208
|
+
|
209
|
+
* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
|
210
|
+
* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
|
211
|
+
* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
|
212
|
+
|
213
|
+
== Code of Conduct
|
214
|
+
|
215
|
+
Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
|
216
|
+
participating in this project you agree to abide by its terms.
|
217
|
+
|
218
|
+
== Contributions
|
219
|
+
|
220
|
+
Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
|
221
|
+
|
222
|
+
== License
|
223
|
+
|
224
|
+
Read link:LICENSE.adoc[LICENSE] for details.
|
225
|
+
|
226
|
+
== History
|
227
|
+
|
228
|
+
Read link:CHANGES.adoc[CHANGES] for details.
|
229
|
+
|
230
|
+
== Credits
|
231
|
+
|
232
|
+
Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
|
data/lib/runcom/identity.rb
CHANGED
@@ -3,20 +3,9 @@
|
|
3
3
|
module Runcom
|
4
4
|
# Gem identity information.
|
5
5
|
module Identity
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
def self.label
|
11
|
-
"Runcom"
|
12
|
-
end
|
13
|
-
|
14
|
-
def self.version
|
15
|
-
"6.0.0"
|
16
|
-
end
|
17
|
-
|
18
|
-
def self.version_label
|
19
|
-
"#{label} #{version}"
|
20
|
-
end
|
6
|
+
NAME = "runcom"
|
7
|
+
LABEL = "Runcom"
|
8
|
+
VERSION = "6.3.0"
|
9
|
+
VERSION_LABEL = "#{LABEL} #{VERSION}"
|
21
10
|
end
|
22
11
|
end
|
metadata
CHANGED
@@ -1,18 +1,18 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: runcom
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 6.
|
4
|
+
version: 6.3.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Brooke Kuhlmann
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain:
|
11
11
|
- |
|
12
12
|
-----BEGIN CERTIFICATE-----
|
13
|
-
MIIC/
|
14
|
-
|
15
|
-
|
13
|
+
MIIC/jCCAeagAwIBAgIBAzANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
|
14
|
+
a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMDAzMTUxNDQ1MzJaFw0yMTAzMTUx
|
15
|
+
NDQ1MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
|
16
16
|
IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
|
17
17
|
xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
|
18
18
|
brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
|
@@ -20,15 +20,15 @@ cert_chain:
|
|
20
20
|
D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
|
21
21
|
3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
|
22
22
|
AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
|
23
|
-
2CdikiiE3fJhP/
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
23
|
+
2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAIHhAlD3po4sTYqacXaQ
|
24
|
+
XI9jIhrfMy//2PgbHWcETtlJPBeNUbbSNBABcllUHKqYsVDlSvSmss034KSWNR8F
|
25
|
+
bF1GcloicyvcCC4y6IoW4it0COAcdeaaxkxiBSgKdQFpff9REnDlIKK4uQ9lLxIo
|
26
|
+
Y2G5xubiziKZkyfWFuSr67PIjW3Bu673D1JVBArhA1qbgQmYQcy1CkGOjo+iO8Nf
|
27
|
+
7u/QSfBHb+r/bXhKscDgPpnKwbUmvgO2+94zJG9KsrmIydlzYfsD09aXKx0t6Xy4
|
28
|
+
2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
|
29
|
+
QWc=
|
30
30
|
-----END CERTIFICATE-----
|
31
|
-
date: 2020-
|
31
|
+
date: 2020-10-18 00:00:00.000000000 Z
|
32
32
|
dependencies:
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: refinements
|
@@ -36,14 +36,14 @@ dependencies:
|
|
36
36
|
requirements:
|
37
37
|
- - "~>"
|
38
38
|
- !ruby/object:Gem::Version
|
39
|
-
version: '7.
|
39
|
+
version: '7.11'
|
40
40
|
type: :runtime
|
41
41
|
prerelease: false
|
42
42
|
version_requirements: !ruby/object:Gem::Requirement
|
43
43
|
requirements:
|
44
44
|
- - "~>"
|
45
45
|
- !ruby/object:Gem::Version
|
46
|
-
version: '7.
|
46
|
+
version: '7.11'
|
47
47
|
- !ruby/object:Gem::Dependency
|
48
48
|
name: xdg
|
49
49
|
requirement: !ruby/object:Gem::Requirement
|
@@ -72,6 +72,34 @@ dependencies:
|
|
72
72
|
- - "~>"
|
73
73
|
- !ruby/object:Gem::Version
|
74
74
|
version: '0.6'
|
75
|
+
- !ruby/object:Gem::Dependency
|
76
|
+
name: gemsmith
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - "~>"
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: '14.2'
|
82
|
+
type: :development
|
83
|
+
prerelease: false
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - "~>"
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '14.2'
|
89
|
+
- !ruby/object:Gem::Dependency
|
90
|
+
name: git-lint
|
91
|
+
requirement: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - "~>"
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: '1.0'
|
96
|
+
type: :development
|
97
|
+
prerelease: false
|
98
|
+
version_requirements: !ruby/object:Gem::Requirement
|
99
|
+
requirements:
|
100
|
+
- - "~>"
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: '1.0'
|
75
103
|
- !ruby/object:Gem::Dependency
|
76
104
|
name: guard-rspec
|
77
105
|
requirement: !ruby/object:Gem::Requirement
|
@@ -92,28 +120,28 @@ dependencies:
|
|
92
120
|
requirements:
|
93
121
|
- - "~>"
|
94
122
|
- !ruby/object:Gem::Version
|
95
|
-
version: '0.
|
123
|
+
version: '0.13'
|
96
124
|
type: :development
|
97
125
|
prerelease: false
|
98
126
|
version_requirements: !ruby/object:Gem::Requirement
|
99
127
|
requirements:
|
100
128
|
- - "~>"
|
101
129
|
- !ruby/object:Gem::Version
|
102
|
-
version: '0.
|
130
|
+
version: '0.13'
|
103
131
|
- !ruby/object:Gem::Dependency
|
104
132
|
name: pry-byebug
|
105
133
|
requirement: !ruby/object:Gem::Requirement
|
106
134
|
requirements:
|
107
135
|
- - "~>"
|
108
136
|
- !ruby/object:Gem::Version
|
109
|
-
version: '3.
|
137
|
+
version: '3.9'
|
110
138
|
type: :development
|
111
139
|
prerelease: false
|
112
140
|
version_requirements: !ruby/object:Gem::Requirement
|
113
141
|
requirements:
|
114
142
|
- - "~>"
|
115
143
|
- !ruby/object:Gem::Version
|
116
|
-
version: '3.
|
144
|
+
version: '3.9'
|
117
145
|
- !ruby/object:Gem::Dependency
|
118
146
|
name: rake
|
119
147
|
requirement: !ruby/object:Gem::Requirement
|
@@ -134,14 +162,14 @@ dependencies:
|
|
134
162
|
requirements:
|
135
163
|
- - "~>"
|
136
164
|
- !ruby/object:Gem::Version
|
137
|
-
version: '
|
165
|
+
version: '6.0'
|
138
166
|
type: :development
|
139
167
|
prerelease: false
|
140
168
|
version_requirements: !ruby/object:Gem::Requirement
|
141
169
|
requirements:
|
142
170
|
- - "~>"
|
143
171
|
- !ruby/object:Gem::Version
|
144
|
-
version: '
|
172
|
+
version: '6.0'
|
145
173
|
- !ruby/object:Gem::Dependency
|
146
174
|
name: rspec
|
147
175
|
requirement: !ruby/object:Gem::Requirement
|
@@ -162,14 +190,14 @@ dependencies:
|
|
162
190
|
requirements:
|
163
191
|
- - "~>"
|
164
192
|
- !ruby/object:Gem::Version
|
165
|
-
version: '0.
|
193
|
+
version: '0.89'
|
166
194
|
type: :development
|
167
195
|
prerelease: false
|
168
196
|
version_requirements: !ruby/object:Gem::Requirement
|
169
197
|
requirements:
|
170
198
|
- - "~>"
|
171
199
|
- !ruby/object:Gem::Version
|
172
|
-
version: '0.
|
200
|
+
version: '0.89'
|
173
201
|
- !ruby/object:Gem::Dependency
|
174
202
|
name: rubocop-performance
|
175
203
|
requirement: !ruby/object:Gem::Requirement
|
@@ -204,39 +232,39 @@ dependencies:
|
|
204
232
|
requirements:
|
205
233
|
- - "~>"
|
206
234
|
- !ruby/object:Gem::Version
|
207
|
-
version: '1.
|
235
|
+
version: '1.39'
|
208
236
|
type: :development
|
209
237
|
prerelease: false
|
210
238
|
version_requirements: !ruby/object:Gem::Requirement
|
211
239
|
requirements:
|
212
240
|
- - "~>"
|
213
241
|
- !ruby/object:Gem::Version
|
214
|
-
version: '1.
|
242
|
+
version: '1.39'
|
215
243
|
- !ruby/object:Gem::Dependency
|
216
244
|
name: simplecov
|
217
245
|
requirement: !ruby/object:Gem::Requirement
|
218
246
|
requirements:
|
219
247
|
- - "~>"
|
220
248
|
- !ruby/object:Gem::Version
|
221
|
-
version: '0.
|
249
|
+
version: '0.19'
|
222
250
|
type: :development
|
223
251
|
prerelease: false
|
224
252
|
version_requirements: !ruby/object:Gem::Requirement
|
225
253
|
requirements:
|
226
254
|
- - "~>"
|
227
255
|
- !ruby/object:Gem::Version
|
228
|
-
version: '0.
|
229
|
-
description:
|
256
|
+
version: '0.19'
|
257
|
+
description:
|
230
258
|
email:
|
231
259
|
- brooke@alchemists.io
|
232
260
|
executables: []
|
233
261
|
extensions: []
|
234
262
|
extra_rdoc_files:
|
235
|
-
- README.
|
236
|
-
- LICENSE.
|
263
|
+
- README.adoc
|
264
|
+
- LICENSE.adoc
|
237
265
|
files:
|
238
|
-
- LICENSE.
|
239
|
-
- README.
|
266
|
+
- LICENSE.adoc
|
267
|
+
- README.adoc
|
240
268
|
- lib/runcom.rb
|
241
269
|
- lib/runcom/cache.rb
|
242
270
|
- lib/runcom/config.rb
|
@@ -247,14 +275,15 @@ files:
|
|
247
275
|
- lib/runcom/identity.rb
|
248
276
|
- lib/runcom/paths/common.rb
|
249
277
|
- lib/runcom/paths/home.rb
|
250
|
-
homepage: https://
|
278
|
+
homepage: https://www.alchemists.io/projects/runcom
|
251
279
|
licenses:
|
252
280
|
- Apache-2.0
|
253
281
|
metadata:
|
254
|
-
source_code_uri: https://github.com/bkuhlmann/runcom
|
255
|
-
changelog_uri: https://github.com/bkuhlmann/runcom/blob/master/CHANGES.md
|
256
282
|
bug_tracker_uri: https://github.com/bkuhlmann/runcom/issues
|
257
|
-
|
283
|
+
changelog_uri: https://www.alchemists.io/projects/runcom/changes.html
|
284
|
+
documentation_uri: https://www.alchemists.io/projects/runcom
|
285
|
+
source_code_uri: https://github.com/bkuhlmann/runcom
|
286
|
+
post_install_message:
|
258
287
|
rdoc_options: []
|
259
288
|
require_paths:
|
260
289
|
- lib
|
@@ -269,8 +298,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
269
298
|
- !ruby/object:Gem::Version
|
270
299
|
version: '0'
|
271
300
|
requirements: []
|
272
|
-
rubygems_version: 3.1.
|
273
|
-
signing_key:
|
301
|
+
rubygems_version: 3.1.4
|
302
|
+
signing_key:
|
274
303
|
specification_version: 4
|
275
304
|
summary: An XDG enhanced run command manager for command line interfaces.
|
276
305
|
test_files: []
|
metadata.gz.sig
CHANGED
@@ -1 +1 @@
|
|
1
|
-
|
1
|
+
�^f;��u�9�ɓ-��5Z1���|e�7�xӗJ@�e�>�wb��БԗI�7�Xٶ����o@!đrZ�whU(%�wݏ�J\%_�Q|.8%ӗo����N��T��j���o#-���z5�̦+Q�d�u��@VM���A���GVy�Ī.���k�m�����tlX�[]%<7�Tuc?y��%2(�]x�AxL�
|
data/README.md
DELETED
@@ -1,193 +0,0 @@
|
|
1
|
-
<p align="center">
|
2
|
-
<img src="runcom.png" alt="Runcom Icon"/>
|
3
|
-
</p>
|
4
|
-
|
5
|
-
# Runcom
|
6
|
-
|
7
|
-
[![Gem Version](https://badge.fury.io/rb/runcom.svg)](http://badge.fury.io/rb/runcom)
|
8
|
-
[![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/129b7ea524a0f5a6a805/maintainability)](https://codeclimate.com/github/bkuhlmann/runcom/maintainability)
|
9
|
-
[![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/129b7ea524a0f5a6a805/test_coverage)](https://codeclimate.com/github/bkuhlmann/runcom/test_coverage)
|
10
|
-
[![Circle CI Status](https://circleci.com/gh/bkuhlmann/runcom.svg?style=svg)](https://circleci.com/gh/bkuhlmann/runcom)
|
11
|
-
|
12
|
-
Runcom (short for [Run Command](https://en.wikipedia.org/wiki/Run_commands)) provides common
|
13
|
-
functionality for Command Line Interfaces (CLIs) in which to manage global, local, or multiple
|
14
|
-
caches, configurations, or data in general. It does this by leveraging the [XDG Base Directory
|
15
|
-
Specification](https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html) built atop
|
16
|
-
the [XDG](https://github.com/bkuhlmann/xdg) implementation.
|
17
|
-
|
18
|
-
<!-- Tocer[start]: Auto-generated, don't remove. -->
|
19
|
-
|
20
|
-
## Table of Contents
|
21
|
-
|
22
|
-
- [Features](#features)
|
23
|
-
- [Requirements](#requirements)
|
24
|
-
- [Setup](#setup)
|
25
|
-
- [Usage](#usage)
|
26
|
-
- [Overview](#overview)
|
27
|
-
- [Variable Priority](#variable-priority)
|
28
|
-
- [Configuration Specialization](#configuration-specialization)
|
29
|
-
- [Examples](#examples)
|
30
|
-
- [Tests](#tests)
|
31
|
-
- [Versioning](#versioning)
|
32
|
-
- [Code of Conduct](#code-of-conduct)
|
33
|
-
- [Contributions](#contributions)
|
34
|
-
- [License](#license)
|
35
|
-
- [History](#history)
|
36
|
-
- [Credits](#credits)
|
37
|
-
|
38
|
-
<!-- Tocer[finish]: Auto-generated, don't remove. -->
|
39
|
-
|
40
|
-
## Features
|
41
|
-
|
42
|
-
- Wraps the [XDG](https://github.com/bkuhlmann/xdg) implementation which provides access to the
|
43
|
-
following environment variables:
|
44
|
-
- `$XDG_CACHE_HOME`
|
45
|
-
- `$XDG_CONFIG_HOME`
|
46
|
-
- `$XDG_CONFIG_DIRS`
|
47
|
-
- `$XDG_DATA_HOME`
|
48
|
-
- `$XDG_DATA_DIRS`
|
49
|
-
- Enhances the XDG cache, config, and data implementation. For the config, the following is
|
50
|
-
supported:
|
51
|
-
- Supports loading of CLI-specific [YAML](http://yaml.org) configuration file.
|
52
|
-
- Supports loading and merging of nested/complex configurations.
|
53
|
-
- Supports hash representation of configuration.
|
54
|
-
|
55
|
-
## Requirements
|
56
|
-
|
57
|
-
1. [Ruby 2.6.x](https://www.ruby-lang.org).
|
58
|
-
|
59
|
-
## Setup
|
60
|
-
|
61
|
-
Type the following to install:
|
62
|
-
|
63
|
-
gem install runcom
|
64
|
-
|
65
|
-
Add the following to your Gemfile:
|
66
|
-
|
67
|
-
gem "runcom"
|
68
|
-
|
69
|
-
## Usage
|
70
|
-
|
71
|
-
The following describes the enhancements built atop the [XDG](https://github.com/bkuhlmann/xdg)
|
72
|
-
implementation.
|
73
|
-
|
74
|
-
#### Overview
|
75
|
-
|
76
|
-
While there isn't an environment convenience object as found in the `XDG` namespace, you can
|
77
|
-
instantiate each object individually:
|
78
|
-
|
79
|
-
cache = Runcom::Cache.new
|
80
|
-
config = Runcom::Config.new
|
81
|
-
data = Runcom::Data.new
|
82
|
-
|
83
|
-
Each of the above objects share the same basic API:
|
84
|
-
|
85
|
-
- `#path` - Answers first *existing* file system path computed by `$XDG_*_HOME` followed
|
86
|
-
by each computed `$XDG_*_DIRS` path in order defined.
|
87
|
-
- `#paths` - Answers all file system paths which is the combined `$XDG_*_HOME` and `$XDG_*_DIRS`
|
88
|
-
values in order defined. These paths *may* or *may not* exist on the file system.
|
89
|
-
|
90
|
-
#### Variable Priority
|
91
|
-
|
92
|
-
Path precedence is determined in the following order (with the first taking highest priority):
|
93
|
-
|
94
|
-
1. **Local Configuration** - If a `$XDG_*_HOME` or `$XDG_*_DIRS` path relative to the current
|
95
|
-
working directory is detected, it will take precedence over the global configuration. This is the
|
96
|
-
same behavior as found in Git where the local `.git/config` takes precedence over the global
|
97
|
-
`~/.gitconfig`.
|
98
|
-
1. **Global Configuration** - When a local configuration isn't found, the global configuration is
|
99
|
-
used as defined by the *XDG Base Directory Specification*.
|
100
|
-
|
101
|
-
#### Configuration Specialization
|
102
|
-
|
103
|
-
The `Runcom::Config` deserves additional highlighting as it provides support for loading custom CLI
|
104
|
-
configurations directly from the command line or from custom locations. It is meant to be used
|
105
|
-
within your program(s).
|
106
|
-
|
107
|
-
An object can be initialized as follows:
|
108
|
-
|
109
|
-
configuration = Runcom::Config.new "example"
|
110
|
-
|
111
|
-
The default file name for a configuration is `configuration.yml` but a custom name can be used if
|
112
|
-
desired:
|
113
|
-
|
114
|
-
configuration = Runcom::Config.new "example", file_name: "example.yml"
|
115
|
-
|
116
|
-
Default settings can be initialized as well:
|
117
|
-
|
118
|
-
configuration = Runcom::Config.new "example", defaults: {name: "Example"}
|
119
|
-
|
120
|
-
Once a configuration has been initialized, a hash representation can be obtained:
|
121
|
-
|
122
|
-
configuration.to_h
|
123
|
-
|
124
|
-
A configuration can be merged with another hash (handy for runtime overrides):
|
125
|
-
|
126
|
-
updated_configuration = configuration.merge {name: "Updated Name"}
|
127
|
-
|
128
|
-
A configuration can also be merged with another configuration:
|
129
|
-
|
130
|
-
updated_configuration = configuration.merge Runcom::Config.new("other", defaults: {a: 1})
|
131
|
-
|
132
|
-
The computed path of the configuration can be asked for as well:
|
133
|
-
|
134
|
-
configuration.path # "~/.config/example/configuration.yml"
|
135
|
-
|
136
|
-
For further details, study the public interface as provided by the
|
137
|
-
[`Runcom::Config`](lib/runcom/config.rb) object.
|
138
|
-
|
139
|
-
### Examples
|
140
|
-
|
141
|
-
Examples of gems built atop this gem are:
|
142
|
-
|
143
|
-
- [Gemsmith](https://github.com/bkuhlmann/gemsmith) - A command line interface for smithing new Ruby
|
144
|
-
gems.
|
145
|
-
- [Git Cop](https://github.com/bkuhlmann/git-cop) - Enforces consistent Git commits.
|
146
|
-
- [Milestoner](https://github.com/bkuhlmann/milestoner) - A command line interface for releasing Git
|
147
|
-
repository milestones.
|
148
|
-
- [Pennyworth](https://github.com/bkuhlmann/pennyworth) - A command line interface that enhances and
|
149
|
-
extends [Alfred](https://www.alfredapp.com) with Ruby support.
|
150
|
-
- [Pragmater](https://github.com/bkuhlmann/pragmater) - A command line interface for
|
151
|
-
managing/formatting source file pragma comments.
|
152
|
-
- [Sublime Text Kit](https://github.com/bkuhlmann/sublime_text_kit) - A command line interface for
|
153
|
-
managing Sublime Text metadata.
|
154
|
-
- [Tocer](https://github.com/bkuhlmann/tocer) - A command line interface for generating table of
|
155
|
-
contents for Markdown files.
|
156
|
-
|
157
|
-
## Tests
|
158
|
-
|
159
|
-
To test, run:
|
160
|
-
|
161
|
-
bundle exec rake
|
162
|
-
|
163
|
-
## Versioning
|
164
|
-
|
165
|
-
Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
|
166
|
-
|
167
|
-
- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
|
168
|
-
- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
|
169
|
-
- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
|
170
|
-
|
171
|
-
## Code of Conduct
|
172
|
-
|
173
|
-
Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
|
174
|
-
participating in this project you agree to abide by its terms.
|
175
|
-
|
176
|
-
## Contributions
|
177
|
-
|
178
|
-
Read [CONTRIBUTING](CONTRIBUTING.md) for details.
|
179
|
-
|
180
|
-
## License
|
181
|
-
|
182
|
-
Copyright 2016 [Alchemists](https://www.alchemists.io).
|
183
|
-
Read [LICENSE](LICENSE.md) for details.
|
184
|
-
|
185
|
-
## History
|
186
|
-
|
187
|
-
Read [CHANGES](CHANGES.md) for details.
|
188
|
-
Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
|
189
|
-
|
190
|
-
## Credits
|
191
|
-
|
192
|
-
Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
|
193
|
-
[Alchemists](https://www.alchemists.io).
|