runcom 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a957c88bd4bd09900d6471688d00d365390837bf00fc04ae417554b9ffb575e
-  data.tar.gz: fdece804569302d90ac3ca35c5775416d180e6e3c499dce81742e8e6611f7051
+  metadata.gz: a98cb95e15551d9c14e28202fdd9523597d57019ae14a08ddb4c67cdee658c15
+  data.tar.gz: 89c481cb06412eeb84b317011e64cbed9a608d12d7f8269defe71c729bdf514c
 SHA512:
-  metadata.gz: cbc1145bc4818734ad328b36d1cc1a153ab2aea703e9f9cace693a2be03a131f03bbed1fbb198824b6ac38dc3addd74fcdde34e93153458aade0afd85cca984a
-  data.tar.gz: 52f0b77a602b49e8f196ef502b2a9e54a03e3a3cf9b0cd9601ec3cdf4a905d3ebc3e0a77f6dd087cc018edc91d595a5e98965776b9a8a2cf3890dff93131b0e6
+  metadata.gz: 72c4cfe15072de9486d048c459c6216e07bca8c61a3408d303ad6d5e5d7675ba65a07d63e9c1aa24e4537253687d7fbdfe8becd5f4b54f11b53a0099fbe1a690
+  data.tar.gz: 4d1a3322b39bc8125228a186cf71b241d7e84bf65e7ff601139f50c0dc63e12285a49778cb123ad94f9e22a87a98febcc5dc6c26c1ad001adfc93c0fced3438f

data/README.md

@@ -17,13 +17,14 @@ Read on for further details.
 
   - [Features](#features)
   - [Requirements](#requirements)
-- [Setup](#setup)
+  - [Setup](#setup)
   - [Usage](#usage)
     - [`Runcom::Configuration`](#runcomconfiguration)
     - [XDG](#xdg)
       - [`$XDG_CONFIG_DIRS`](#xdg_config_dirs)
       - [`$XDG_CONFIG_HOME`](#xdg_config_home)
       - [Variable Priority](#variable-priority)
+    - [Examples](#examples)
   - [Tests](#tests)
   - [Versioning](#versioning)
   - [Code of Conduct](#code-of-conduct)
@@ -50,7 +51,7 @@ Read on for further details.
 
 0. [Ruby 2.5.x](https://www.ruby-lang.org)
 
-# Setup
+## Setup
 
 Type the following to install:
 
@@ -143,6 +144,49 @@ priority):
    (highest priority). It will choose the first directory, in priority, that exists on the file
    system while skipping any that don't exist.
 
+### Examples
+
+One of the best use cases of this gem is when it is combined with an environment switcher like
+[direnv](https://direnv.net) where you can define a custom `XDG_CONFIG_HOME` for your specific
+project.
+
+With `direnv` installed, you could have the following project structure:
+
+    /example
+      /.config/test/configuration.yml
+      /.envrc
+
+The `.envrc` file could then have this setting:
+
+    export XDG_CONFIG_HOME=".config"
+
+This would end up pointing to the `/example/.config` folder of the current project, as shown above,
+instead of `~/.config` (which is the default behavior). While running code within this project, you
+could initialize your configuration object like this:
+
+    configuration = Runcom::Configuration.new "test"
+
+The `configuration` object would have the following path due `direnv` setting your `XDG_CONFIG_HOME`
+to your current project:
+
+    configuration.path # "~/.config/test/configuration.yml"
+
+If you need further examples of gems that use this gem, check out the following:
+
+- [Gemsmith](https://github.com/bkuhlmann/gemsmith) - A command line interface for smithing new Ruby
+  gems.
+- [Milestoner](https://github.com/bkuhlmann/milestoner) - A command line interface for releasing Git
+  repository milestones.
+- [Git Cop](https://github.com/bkuhlmann/git-cop) - Enforces consistent Git commits.
+- [Tocer](https://github.com/bkuhlmann/tocer) - A command line interface for generating table of
+  contents for Markdown files.
+- [Pragmater](https://github.com/bkuhlmann/pragmater) - A command line interface for
+  managing/formatting source file pragma comments.
+- [Sublime Text Kit](https://github.com/bkuhlmann/sublime_text_kit) - A command line interface for
+  managing Sublime Text metadata.
+- [Pennyworth](https://github.com/bkuhlmann/pennyworth) - A command line interface that enhances and
+  extends Alfred with Ruby support.
+
 ## Tests
 
 To test, run:

data/lib/runcom/identity.rb

@@ -12,7 +12,7 @@ module Runcom
     end
 
     def self.version
-      "3.0.0"
+      "3.1.0"
     end
 
     def self.version_label

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runcom
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -29,7 +29,7 @@ cert_chain:
   4Zrsxi713z6sndd9JBAm4G7mJiV93MsuCM5N4ZDY7XaxIhvctNSNhX/Yn8LLdtGI
   b4jw5t40FKyNUvLPPXYAvQALBtk=
   -----END CERTIFICATE-----
-date: 2018-04-01 00:00:00.000000000 Z
+date: 2018-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -37,14 +37,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +87,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: git-cop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement