confinicky 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53f1baf258a65df2bcf011c06047e10b3cbbab80
-  data.tar.gz: 55b8320db2def454e6fd80bc9432e26bcef04788
+  metadata.gz: 810dc913005260bb414ed9c84763ddcf8e561007
+  data.tar.gz: 4484a749864bcd14c413268cf145fd86c8b816f4
 SHA512:
-  metadata.gz: bbeccd3fda8048b6e9d2797e7fbefccc4e6f817c6c6748d6e85034f5628fd51339e53dd189ca8a4c41aa77530e8e0086d85015dc9a245cbf7c1be1ca55e9bfb6
-  data.tar.gz: 0c07f1a3af6b25078b7e705d0f297af9147afc1f70dc604ee52c47554f67b60e2784da4695224278a20bebac7793d115b8f996bd9a66913007b7695bc8f659f7
+  metadata.gz: c4c68cf8114e165ebe6c694e5c2faa4077396dbbc26fa64f3369b034cbb61dcd3c678e540c24b21d3910fa47e1a6165c4190a19bf2b87e9d756c6538da35a3c9
+  data.tar.gz: bde297945fc154d22f1b51661bde4946417f3f25531899f5384f9e8be9de309421976fb17c1e524d2b9ce05348f08131ef3e5c1467073fc30943567841fdb90b

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0

data/Gemfile

@@ -1,4 +1,3 @@
-ruby '2.1.2'
 source "http://rubygems.org"
 # Add dependencies required to use your gem here.
 # Example:

data/README.md

@@ -0,0 +1,103 @@
+# Confinicky [![Build Status](https://travis-ci.org/jimjeffers/confinicky.png)](https://travis-ci.org/jimjeffers/confinicky) [![Code Climate](https://codeclimate.com/github/jimjeffers/confinicky.png)](https://codeclimate.com/github/jimjeffers/confinicky) [![Inline docs](http://inch-ci.org/github/jimjeffers/confinicky.png)](http://inch-ci.org/github/jimjeffers/confinicky)
+
+A simple CLI to manage your environment variables.
+
+Run `conficky --help` for a current list of useable commands.
+
+## Setup Confinicky
+
+First, install the gem: 
+
+```
+→ gem install confinicky
+```
+
+Next, setup confinicky to use your `.bashrc`, `.bash_profile`, or my personal favorite, an external file just for environment variables that you source in your bash_profile. For example I keep mine in a file called `env` and then run `source env` in my `.bash_profile`.
+
+```
+→ cfy use /Users/jim/bin/dotfiles/bash/env
+Set CONFINICKY_FILE_PATH to /Users/jim/bin/dotfiles/bash/env
+```
+
+## Listing Environment Variables
+
+You can easily see all of your environment variables using `cfy list` or `cfy ls`.
+
+```
+→ cfy ls
++-----------------------+---------------------------------------------------------------------------------------------------------+
+| CONFINICKY_FILE_PATH  | /Users/jim/bin/dotfiles/bash/env                                                                        |
+| DOCKER_HOST           | tcp://192.168.59.103:2375                                                                               |
+| EDITOR                | "subl -w"                                                                                               |
+| GEM_CERTIFICATE_CHAIN | '~/bin/dotfiles/gem/gem-public_cert.pem'                                                                |
+| GEM_PRIVATE_KEY       | '~/bin/dotfiles/gem/gem-private_key.pem'                                                                |
+| INFOPATH              | $INFOPATH:/opt/local/share/info                                                                         |
+| MANPATH               | $MANPATH:/opt/local/share/man:/usr/local/git/man                                                        |
+| NODE_PATH             | /usr/local/lib/node:/usr/local/lib/node_modules                                                         |
+| PATH                  | /Users/jim/.rvm/gems/ruby-2.1.2/bin:/Users/jim/.rvm/gems/ruby-2.1.2@global/bin:/Users/jim/.rvm/rubie... |
+| PGDATA                | /usr/local/var/postgres                                                                                 |
+| PYTHONPATH            | /usr/local/lib/python2.7/site-packages:$PYTHONPATH                                                      |
+| VCPROMPT_FORMAT       | "[%n:%b](%m%u)"                                                                                         |
++-----------------------+---------------------------------------------------------------------------------------------------------+
+```
+
+## Creating / Setting an Environment Variable
+
+You can easily add or adjust an environment variable using `cfy set` which expects a parameter such as `MY_VAR=value`.
+
+```
+→ cfy set DOCKER_HOST=tcp://192.168.59.103:2375
+Successfully set 'DOCKER_HOST=tcp://192.168.59.103:2375'.
+Run 'source /Users/jim/bin/dotfiles/bash/env' or open a new terminal/shell window.
+```
+
+## Removing an Environment Variable 
+
+You can easily add or adjust an environment variable using `cfy remove` or `cfy rm`.
+
+```
+→ cfy remove MY_VAR
+Successfully removed 'MY_VAR'.
+Run 'source /Users/jim/bin/dotfiles/bash/env' or open a new terminal/shell window.
+```
+
+## Detecting Duplicate Exports
+
+If your environment files have turned into a junk drawer with PATH getting defined multiple times throughout the file or otherwise, you can get a summary by running `cfy duplicates`.
+
+```
+→ cfy duplicates
++----------+---+
+| PATH     | 7 |
+| MANPATH  | 3 |
+| INFOPATH | 3 |
++----------+---+
+Identified 3 variables with multiple 'export' statements in /Users/jim/bin/dotfiles/bash/env
+Run 'cfy clean' to reduce these statements.
+```
+
+## Cleaning Duplicate Exports
+
+You can run `cfy clean` which replaces multiple export declarations with the actual value of the environment variable.
+
+```
+→ cfy clean
+Backup your existing file before continuuing? (y/n)
+y
+Backup saved to: /Users/jim/bin/dotfiles/bash/env1407782855.bak.tmp
+Your file is clean. 3 duplicate statements have been reduced.
+```
+
+## Contributing to confinicky
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2014 Jim Jeffers. See LICENSE.txt for further details.

data/confinicky.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: confinicky 0.1.5 ruby lib
+# stub: confinicky 0.1.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "confinicky"
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
@@ -17,14 +17,15 @@ Gem::Specification.new do |s|
   s.executables = ["cfy"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "bin/cfy",
     "confinicky.gemspec",

data/lib/confinicky/commands/clean.rb

@@ -1,13 +1,13 @@
 command :clean do |c|
-  c.syntax = 'confinicky clean'
+  c.syntax = 'cfy clean'
   c.summary = 'Removes all duplicate export statements in the configuration file.'
   c.description = ''
-  c.example 'description', 'confinicky clean'
+  c.example 'description', 'cfy clean'
 
   c.action do |args, options|
     if Confinicky::ShellFile.has_path?
       say_error "Please set '#{Confinicky::FILE_PATH_VAR}' to point to your local configuration file."
-      puts "Try running 'confinicky use' for more info."
+      puts "Try running 'cfy use' for more info."
       abort
     end
     shell_file = Confinicky::ShellFile.new

data/lib/confinicky/commands/duplicates.rb

@@ -1,15 +1,17 @@
 command :duplicates do |c|
-  c.syntax = 'confinicky duplicates'
+  c.syntax = 'cfy duplicates'
   c.summary = 'Generates a list of all variables that have multiple export statements.'
   c.description = ''
-  c.example 'description', 'confinicky duplicates'
+  c.example 'description', 'cfy duplicates'
 
   c.action do |args, options|
+
     if Confinicky::ShellFile.has_path?
       say_error "Please set '#{Confinicky::FILE_PATH_VAR}' to point to your local configuration file."
-      puts "Try running 'confinicky use' for more info."
+      puts "Try running 'cfy use' for more info."
       abort
     end
+
     shell_file = Confinicky::ShellFile.new
     duplicates = shell_file.find_duplicates.map{|key, value| [key, value]}
     table = Terminal::Table.new :rows => duplicates

data/lib/confinicky/commands/list.rb

@@ -1,14 +1,14 @@
 command :list do |c|
-  c.syntax = 'confinicky list'
+  c.syntax = 'cfy list'
   c.summary = 'Generates a list of all environment variables set in your configuration file.'
   c.description = ''
-  c.example 'description', 'confinicky list'
+  c.example 'description', 'cfy list'
 
   c.action do |args, options|
 
     if Confinicky::ShellFile.has_path?
       say_error "Please set '#{Confinicky::FILE_PATH_VAR}' to point to your local configuration file."
-      puts "Try running 'confinicky use' for more info."
+      puts "Try running 'cfy use' for more info."
       abort
     end
 

data/lib/confinicky/commands/remove.rb

@@ -1,13 +1,13 @@
 command :remove do |c|
-  c.syntax = 'confinicky remove'
+  c.syntax = 'cfy remove'
   c.summary = 'Removes an environment variable in your configuration file.'
   c.description = ''
-  c.example 'description', 'confinicky remove MY_VAR'
+  c.example 'description', 'cfy remove MY_VAR'
 
   c.action do |args, options|
     if Confinicky::ShellFile.has_path?
       say_error "Please set '#{Confinicky::FILE_PATH_VAR}' to point to your local configuration file."
-      puts "Try running 'confinicky use' for more info."
+      puts "Try running 'cfy use' for more info."
       abort
     end
 
@@ -16,13 +16,13 @@ command :remove do |c|
     duplicate_count = shell_file.find_duplicates.length
     if duplicate_count > 0
       say_error "Your configuration cannot be managed because it currently has duplicate export statements."
-      puts "You must run 'confinicky clean' before you can manage your configuration."
+      puts "You must run 'cfy clean' before you can manage your configuration."
       abort
     end
 
     if shell_file.remove!(args.first)
       say_ok "Successfully removed '#{args.first}'."
-      puts "Run 'source #{Confinicky::ShellFile.file_path}' or open a new terminal/shell window."
+      puts "Open a new terminal/shell window for this change to take affect."
       shell_file.write!
     else
       say_error "Could not remove '#{args.first}' please double check to ensure you used the appropriate syntax."

data/lib/confinicky/commands/set.rb

@@ -1,13 +1,13 @@
 command :set do |c|
-  c.syntax = 'confinicky set'
+  c.syntax = 'cfy set'
   c.summary = 'Sets an environment variable in your configuration file.'
   c.description = ''
-  c.example 'description', 'confinicky set MY_VAR="some value"'
+  c.example 'description', 'cfy set MY_VAR="some value"'
 
   c.action do |args, options|
     if Confinicky::ShellFile.has_path?
       say_error "Please set '#{Confinicky::FILE_PATH_VAR}' to point to your local configuration file."
-      puts "Try running 'confinicky use' for more info."
+      puts "Try running 'cfy use' for more info."
       abort
     end
 
@@ -16,10 +16,12 @@ command :set do |c|
     duplicate_count = shell_file.find_duplicates.length
     if duplicate_count > 0
       say_error "Your configuration cannot be managed because it currently has duplicate export statements."
-      puts "You must run 'confinicky clean' before you can manage your configuration."
+      puts "You must run 'cfy clean' before you can manage your configuration."
       abort
     end
 
+    say_error "You must supply an expression such as: MY_VAR=\"some value\"" and about if args.first.nil?
+
     if shell_file.set!(args.first)
       shell_file.write!
       say_ok "Successfully set '#{args.first}'."

data/lib/confinicky/commands/use.rb

@@ -2,14 +2,14 @@ command :use do |c|
   c.syntax = 'confinicky use'
   c.summary = 'Appends the confinicky file path shell variable to your configuration.'
   c.description = ''
-  c.example 'description', 'confinicky use /User/[YOUR_USER_NAME]/.bashrc'
+  c.example 'description', 'cfy use /User/[YOUR_USER_NAME]/.bashrc'
 
   c.action do |args, options|
     @file_path = args.first
 
     if @file_path.nil?
       say_error "You must specify a path. See example:"
-      puts 'confinicky use /User/[YOUR_USER_NAME]/.bashrc'
+      puts 'cfy use /User/[YOUR_USER_NAME]/.bashrc'
       abort
     end
 

data/lib/confinicky/shell_file.rb

@@ -1,9 +1,15 @@
 require 'fileutils'
 
 module Confinicky
+  ##
+  # A model that loads and represents a shell file.
   class ShellFile
 
+    ##
+    # The preserved lines of code from the shell file which confinicky
+    # will write back to the new shell file in the order they were received.
     attr_reader :lines
+
     attr_reader :exports
     ##
     # References the actual file path from the shell configuration.

data/lib/confinicky/version.rb

@@ -1,8 +1,11 @@
 module Confinicky
+  ##
+  # Defines the version of the gem in an internal manner so that
+  # users of the gem can query it at run time.
   module Version
     MAJOR = 0
     MINOR = 1
-    PATCH = 5
+    PATCH = 6
     BUILD = ''
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: confinicky
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Jim Jeffers
@@ -116,13 +116,14 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - ".document"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - bin/cfy
 - confinicky.gemspec

data/README.rdoc

@@ -1,21 +0,0 @@
-= confinicky
-
-A simple CLI to manage your environment variables.
-
-Run 'conficky --help' for a current list of useable commands.
-
-== Contributing to confinicky
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2014 Jim Jeffers. See LICENSE.txt for
-further details.
-