wdi 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 072e4d21629eadc99678fe270a358e9314472052
-  data.tar.gz: 92f8aa139b8714d8f24fb7450f4965bb64bfea85
+  metadata.gz: b84a9822c9a57a90f29324b893f0eedb76f15566
+  data.tar.gz: 1b86197809f81e9a00e10825d179607ddcfba10d
 SHA512:
-  metadata.gz: ee5fa06b3dab7bc021c052e34a0cd4b9dcd9f7317453df1c252834d71a158ca682e959d0b80400e4f0c98f953e0e14b9dd1a0da1fe848ec94eeffb01235964a5
-  data.tar.gz: 37e8829b0ed20141daf877ef632685d3f86f9eeacfde723175cd64a88b6f61886d8993e262348fd673677148e7382c433fa5f8793fef5a3552be6dac0389c82a
+  metadata.gz: e56f28f710f4accc04e1f385ac96188597ca03fb2126576ef580d738ce8481694c01422fef0e4d0bae8ae46e7b14499acd1ac5d6148c692d22b4cc305fc3258b
+  data.tar.gz: 2889d54100b1c7b3f44d160aa0e95afd79b6d2d246642fd81ab7c2df89e32937b681a69c739d1c070de1ff7291204c730369b4756274df3255217d810cf526cc

data/README.md

@@ -1,26 +1,66 @@
 # The WDI Tool
 
-Use this gem to set up the WDI configuration file(s) and make changes to them. These exist in the folder ~/.wdi, and are used by the breadth of WDI command line tools in order to define common constants or development/environmental settings specific to the WDI command line tools.
+Use this gem to set up the WDI configuration file(s) and make changes to them. These exist in the directory ~/.wdi, and are used by the breadth of WDI command line tools in order to define common constants or development/environmental settings specific to the WDI command line tools.
+
+## Installation
+
+```bash
+gem install wdi
+```
+
+It's as easy as that!
+
+**Warning:** the current `.bash_profile` in common use by WDI NYC has aliased `wdi` to the command `cd ~/dev/wdi`. This will override the `wdi` executable loaded in the path by the gem. The alias needs to be removed from the profile and the shell reloaded for the tool to run.
 
 ## Usage
 
+#### Creating a WDI directory and config file
+
 ```bash
-wdi init (--load URI)
-#=> if there is no .wdi folder, it creates one
-#=>   by default it uses the example in data/default-config.json, or if
-#=>   --load is defined (as a URI), then it attempts to use that
-#=> if there is a .wdi folder, this fails and suggests using `wdi config`
+wdi init
 ```
 
+As long as there is no `~/.wdi` directory, this command creates one. By default it uses the template file at `data/default-config.json`. If there is already a directory, you can forcefully overwrite it by using the "-f" switch. You can also specify a "load" file or URL template to copy the `config.json` file from.
+
+#### Editing the WDI directory
+
+```bash
+# wdi add-files <files>
+```
+
+... TBD (adds a file or files to the directory, and requisite keys *files.filename* to the config)...
+
+#### Editing a WDI config file
+
 ```bash
 wdi config set <key(.key...)> <value>
 wdi config get <key(.key...)>
 
-wdi config add <key(.key...)> <value>
-wdi config remove <key(.key...)> (--force)
+# wdi config add <key(.key...)> <value>
+# wdi config remove <key(.key...)> (--force)
 
 wdi config keys (<key>)
 
-# wdi get-base
-# wdi get-repo class.current
-```
+# wdi get-<key>
+# wdi get-<key-parent> <rest.of.key>
+# wdi add-key <key> <value>
+# wdi set-<key> <value>
+```
+
+... TBD ...
+
+#### Navigating WDI repos
+
+```bash
+# wdi go [:go.repo] [:go.pattern] <args>
+```
+
+... TBD ...
+
+## Development
+
+#### Testing
+
+Use **Aruba** (Cucumber) for CLI acceptance testing, and **Rspec** for unit testing the non-CLI modules and classes. Aruba is run with the `rake test` command, and tests are in the `/features` directory, while Rspec with the `bundle exec rspec` command (test in `/specs`, as per usual).
+
+> Note: I'm tempted to add 'active_support/core_ext/string/inflections' as a requirement... I imagine it's insanely heavy, but should be on systems already if Rails is there... But we should try to be slim if this tool is going to be required in every WDI command line tool, right?

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+require "cucumber/rake/task"
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = ['features', '-x', '--format progress']
+end
+
+desc "Run all test suites"
+task :test => [:features]

data/data/default-config.json

@@ -1,8 +1,13 @@
 {
+  "name": "`whoami`",
   "base": "`echo $HOME`/dev/wdi",
   "repos": {
     "classes": {
       "current": "`echo $HOME`/dev/wdi/class_name"
     }
+  },
+  "go": {
+    "repo": ":repos.classes.current",
+    "pattern": "/$1/$2/:name"
   }
 }

data/features/support/env.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'aruba/cucumber'

data/features/version.feature

@@ -0,0 +1,6 @@
+Feature: Version
+    The WDI command line tool should be able to print its version
+
+  Scenario:
+    When I run `wdi version`
+    Then the output should contain "0.0.3"

data/lib/wdi/cli.rb

@@ -10,7 +10,7 @@ module WDI
       def set(key, value)
         begin
           WDI::Config::set(key, value)
-          say "The key '#{key}' in the WDI config file has been set to '#{value}'.", :green
+          say "The property '#{key}' in the WDI config file has been set to '#{value}'.", :green
         rescue WDI::ConfigError => e
           say e.message, :red
         end
@@ -19,7 +19,7 @@ module WDI
       desc "get", "get a value from the WDI config file"
       def get(key)
         begin
-          say WDI::Config::get(WDI::Config::translate(key), key)
+          say WDI::Config::get(key)
         rescue WDI::ConfigError => e
           say e.message, :red
         end
@@ -39,10 +39,10 @@ module WDI
 
       # end
 
-      desc "keys", "list the keys in the WDI config file"
+      desc "keys", "list the properties in the WDI config file"
       def keys(key=nil)
         begin
-          say WDI::Config::keys(WDI::Config::translate(key), key).join("\n")
+          say WDI::Config::properties(key).join("\n")
         rescue WDI::ConfigError => e
           say e.message, :red
         end
@@ -50,6 +50,13 @@ module WDI
     end
 
     class Wdi < Thor
+      #class_option :version, alias: "-v", type: :boolean
+
+      desc "version", "get current WDI tool version"
+      def version
+        say WDI::VERSION
+      end
+
       desc "init", "initialize a new WDI directory at ~/.wdi"
       method_option :load, 
                     aliases: ["-l"],

data/lib/wdi/config.rb

@@ -6,7 +6,197 @@ require "pry"
 
 module WDI
   module Config
-    KEY_REGEX = /^[a-z.]*$/ # only lowercase words separated by periods
+    KEY_REGEX          = /^[a-z.]*$/ # only lowercase words separated by periods
+    VALUE_AS_KEY_REGEX = /:[a-z._]+/ # a value containing at least one word prefixed by ':'
+    ALLOWED_BASH_REGEX = /(`(echo|pwd|ls|whoami)[^\|;&]*`)/
+
+    ##############################################################
+    class ConfigFile
+      attr_reader :pairs
+
+      def initialize(json_configuration)
+        config = JSON.parse(json_configuration, symbolize_names: true)
+
+        @pairs = {}
+        recursive_build_pairs_from config
+        ensure_format_of_pairs
+      end
+
+      def has_key?(key)
+        key = translate_incoming(key)
+        @pairs.key?(key)
+      end
+
+      def value_at(key)
+        key = translate_incoming(key)
+        
+        if @pairs.key?(key)
+          if @pairs[key].is_a? Array
+            return @pairs[key].map {|value| retrieve_value_with_references(value) }
+          else
+            return retrieve_value_with_references(@pairs[key])
+          end
+        elsif keys_with_prefix(key)
+          raise WDI::ConfigError, 
+            "This key doesn't represent a property in the WDI config file. " +
+            "Try `wdi config keys #{key}`."
+        else
+          return false
+        end
+      end
+
+      def keys_with_value(value)
+        key_list = @pairs.select {|k,v| v == value}.keys
+        key_list.count == 0 ? false : key_list.map{|k| translate_outgoing(k)}
+      end
+
+      def set_key_value(key, value)
+        key = translate_incoming(key)
+
+        raise WDI::ConfigError,
+            "This key is not in the WDI config file." unless @pairs.key?(key)
+        raise WDI::ConfigError,
+            "This value is not formatted correctly for the WDI config file." unless value.is_a?(String)
+        disallow_bad_references_in value
+        @pairs[key] = value
+      end
+
+      def add_key_value(key, value)
+        key = translate_incoming(key)
+        disallow_bad_references_in value
+
+        if has_key?(key)
+          if @pairs[key].is_a? Array
+            @pairs[key] << value
+          else
+            @pairs[key] = [@pairs[key],value]
+          end
+        else
+          @pairs[key] = value
+        end
+        return @pairs[key]
+      end
+
+      def keys
+        @pairs.keys.map{|k| translate_outgoing(k)}
+      end
+
+      def keys_with_prefix(prefix=nil)
+        return keys if prefix.nil?
+        prefix = translate_outgoing(translate_incoming(prefix)) # force correct string format
+        key_list = keys.select{|k| (k =~ Regexp.new(prefix)) == 0 }
+        key_list.count == 0 ? false : key_list
+      end
+
+      def to_h
+        result = {}
+
+        keys.each do |key|
+          add_child_node(result, key, @pairs[translate_incoming(key)])
+        end
+
+        return result
+      end
+
+      def to_json
+        JSON.pretty_generate(self.to_h)
+      end
+
+      def to_s
+        @pairs.to_s
+      end
+
+    private
+      def translate_incoming(key)
+        if key.is_a? String
+          key.gsub(/\./, "_").to_sym
+        elsif key.is_a? Symbol
+          key
+        else
+          raise WDI::ConfigError, 
+            "This property is not formatted correctly for the WDI config file."
+        end
+      end
+
+      def interpolate_commands_in(value)
+        value.gsub(ALLOWED_BASH_REGEX) do |command|
+          eval(command).chomp
+        end
+      end
+
+      def translate_outgoing(key)
+        key.to_s.gsub(/_/,".")
+      end
+
+      def retrieve_value_with_references(value)
+        value = interpolate_commands_in value
+        check_value = disallow_bad_references_in value
+        
+        return value if (check_value =~ VALUE_AS_KEY_REGEX).nil?
+        check_value.gsub(VALUE_AS_KEY_REGEX) {|reference| value_at(reference[1..-1])}
+      end
+
+      def ensure_format_of_pairs
+        pairs.each_pair do |key, value|
+          key = translate_outgoing(key)
+
+          if (key =~ KEY_REGEX).nil? || key[0] == "." || key[-1] == "."
+            raise WDI::ConfigError, 
+              "This property is not formatted correctly for the WDI config file."
+          end
+          
+          if !(value.is_a?(String) || value.is_a?(Array))
+            raise WDI::ConfigError,
+              "This value is not formatted correctly for the WDI config file " + \
+              "(must be a string or an array of strings)."
+          else
+            disallow_bad_references_in value
+          end
+        end
+      end
+
+      def disallow_bad_references_in(value)
+        check_value = value.gsub(VALUE_AS_KEY_REGEX) do |reference|
+          translate_outgoing(reference) # only translate to dots if matches reference
+        end
+
+        check_value.scan(VALUE_AS_KEY_REGEX) do |reference|
+          unless has_key?(reference[1..-1])
+            raise WDI::ConfigError,
+              "This value is not formatted correctly for the WDI config file " + \
+              "(malformed reference)."
+          end
+        end
+      end
+
+      def recursive_build_pairs_from(tree, parent_key="")
+        tree.each_pair do |child_key, value|
+          if value.is_a?(Hash)
+            recursive_build_pairs_from(value, append_keys(parent_key, child_key))
+          else
+            @pairs[append_keys(parent_key, child_key).to_sym] = value
+          end
+        end
+      end
+
+      def add_child_node(node, key, value)
+        parent, child = key.split(".", 2)
+
+        if child.nil?
+          node[parent.to_sym] = value
+        else
+          node[parent.to_sym] = {} if node[parent.to_sym].nil?
+          add_child_node(node[parent.to_sym], child, value)
+        end
+      end
+
+      def append_keys(parent, child)
+        parent = (parent.nil? || parent == "") ? "" : parent.to_s + "_"
+        child  = (child.nil? || child == "")  ? "" : child.to_s
+        parent + child
+      end
+    end
+    ###############################################################
 
     def self.path
       File.expand_path("config.json", WDI::Folder::path)
@@ -16,25 +206,19 @@ module WDI
       File.exists?(self.path)
     end
 
-    def self.file
-      @@config ||= self.load
+    def self.config
+      @@config ||= self.load_local_configuration
     end
 
-    def self.load
-      @@config = JSON.parse(IO.read(self.path), symbolize_names: true)
+    def self.load_local_configuration
+      @@config = WDI::Config::ConfigFile.new(IO.read(self.path))
     end
 
-    def self.save
-      File.open(File.expand_path("config.json", WDI::Folder::path), "w+") do |f|
-        f.write JSON.pretty_generate(self.file)
-      end
-    end
-
-    def self.load_file(config_uri)
+    def self.load_configuration_from(config_uri)
       begin
         uri = URI(config_uri)
         config_file = ["http", "https"].include?(uri.scheme) ? uri.open.read : IO.read(config_uri)
-        @@config = self.safe_replace(JSON.parse(config_file, symbolize_names: true))
+        @@config = WDI::Config::ConfigFile.new config_file
         self.save
 
       rescue Errno::ENOENT => e
@@ -48,84 +232,32 @@ module WDI
       end
     end
 
-    ############################################
-
-    def self.get(key, key_name)
-      raise WDI::ConfigError, "This key is not in the WDI config file." if key.nil?
-      raise WDI::ConfigError, 
-        "This key doesn't represent a property in the WDI config file. " +
-        "Try `wdi config keys #{key_name}`." if key.is_a?(Hash)
-      return key
-    end
-
-    def self.set(key_name, new_value)
-      current_value = WDI::Config::translate(key_name)
-      raise WDI::ConfigError, 
-        "This key doesn't represent a property in the WDI config file. " +
-        "Try `wdi config keys #{key_name}`." if current_value.is_a?(Hash)
-      
-
-      self.set_child(self.file, key_name, new_value)
-      self.save
-    end
-
-    def self.set_child(key, key_name, value)
-      parent, child = key_name.split(".", 2)
-      if child.nil?
-        key[parent.to_sym] = value
-      else
-        self.set_child(key[parent.to_sym], child, value)
+    def self.save
+      File.open(File.expand_path("config.json", WDI::Folder::path), "w+") do |f|
+        f.write self.config.to_json
       end
     end
 
-    def self.keys(tree, parent_key="", key_list=[])
-      raise WDI::ConfigError,
-        "There are no (sub-)keys in the WDI config file that fit this criteria." unless tree.is_a?(Hash)
-
-      tree.each_pair do |child_key, value|
-        if value.is_a?(Hash)
-          self.keys(value, self.append_keys(parent_key, child_key), key_list)
-        else
-          key_list << self.append_keys(parent_key, child_key)
-        end
-      end
+    ###############################################################
+    ## WRAPPER MODULE METHODS
 
-      return key_list
+    def self.create(config_uri)
+      config_uri.nil? ? self.load_local_configuration : self.load_configuration_from(config_uri)
     end
 
-    ############################################
-
-    def self.append_keys(parent, child)
-      parent = (parent.nil? || parent == "") ? "" : parent.to_s + "."
-      child  = (child.nil? || child == "")  ? "" : child.to_s
-      parent + child
+    def self.get(property)
+      self.config.value_at property
     end
 
-    def self.translate(key, tree=self.file)
-      # assume we are talking about the config tree as a whole if nil
-      return tree if key.nil? 
-
-      raise WDI::ConfigError, 
-        "This key is not formatted correctly for the WDI config file." unless key =~ KEY_REGEX       
-      parent, child = key.split(".", 2)
-      value = tree[parent.to_sym]
-      raise WDI::ConfigError, "This key is not in the WDI config file." if value.nil?
+    def self.set(property, value)
+      self.config.set_key_value property, value
+      self.save
+    end
 
-      return (child.nil? ? value : self.translate(child, value))
+    def self.properties(prefix=nil)
+      self.config.keys_with_prefix prefix
     end
 
-    def self.safe_replace(config)
-      JSON.recurse_proc(config) do |line|
-        if line.is_a?(String)
-          # so this is not REALLY safe, but should be safe enough... maybe even too restrictive
-          allowed_bash_regex = /(`(echo|pwd|ls)[^\|;&]*`)/
-          
-          result = eval( line[allowed_bash_regex] )
-          line.gsub!( allowed_bash_regex, result.chomp ) unless result.nil?
-        end
-      end
 
-      return config
-    end
   end
 end

data/lib/wdi/folder.rb

@@ -24,7 +24,7 @@ module WDI
 
     def self.create_with_config(remove_current_directory, file)
       self.create(remove_current_directory)
-      WDI::Config::load_file(file)
+      WDI::Config::create(file)
     end
 
     def self.remove!

data/lib/wdi/version.rb

@@ -1,3 +1,3 @@
-module Wdi
-  VERSION = "0.0.2"
+module WDI
+  VERSION = "0.0.3"
 end

data/spec/config_spec.rb

@@ -0,0 +1,315 @@
+require "spec_helper"
+
+describe WDI::Config do
+  describe WDI::Config::ConfigFile do # namespacing weirdness...
+    config_json_contents_with_interpolation = <<-JSON_CONTENTS
+    {
+      "name": "`whoami`",
+      "base": "`echo $HOME`/dev/wdi",
+      "repos": {
+        "classes": {
+          "current": "`echo $HOME`/dev/wdi/class_name"
+        }
+      },
+      "go": {
+        "repo": ":repos.classes.current",
+        "pattern": "/$1/$2/:name"
+      }
+    }
+    JSON_CONTENTS
+
+    config_json_contents = <<-JSON_CONTENTS
+    {
+      "name": "philip",
+      "base": "/Users/philip/dev/wdi",
+      "repos": {
+        "classes": {
+          "current": "/Users/philip/dev/wdi/class_name"
+        }
+      },
+      "go": {
+        "repo": ":repos.classes.current",
+        "pattern": "/$1/$2/:name"
+      }
+    }
+    JSON_CONTENTS
+
+    describe "#initialize" do
+      it "raises an error if properties aren't formatted for the config to work" do
+        expect {WDI::Config::ConfigFile.new('{"name1":"pj"}')}.to raise_error
+        expect {WDI::Config::ConfigFile.new('{"name_":"pj"}')}.to raise_error
+        expect {WDI::Config::ConfigFile.new('{"name.":"pj"}')}.to raise_error
+        expect {WDI::Config::ConfigFile.new('{".name":"pj"}')}.to raise_error
+      end
+      
+      it "allows bash commands in the values" do
+        keys_values = {
+          name: "`whoami`",
+          base: "`echo $HOME`/dev/wdi",
+          repos_classes_current: "`echo $HOME`/dev/wdi/class_name",
+          go_repo: ":repos.classes.current",
+          go_pattern: "/$1/$2/:name"
+        }
+        expect(WDI::Config::ConfigFile.new(config_json_contents_with_interpolation).pairs).to \
+          eql(keys_values)
+      end
+    
+      it "does not allow string values to have colon-prefixed words unless they reference properties" do
+        expect {WDI::Config::ConfigFile.new('{"name":":not_name"}')}.to raise_error
+      end
+    end
+
+    let!(:config) {WDI::Config::ConfigFile.new(config_json_contents)}
+
+    describe "#value_at" do
+      it "returns the value at the given key (as a symbol)" do
+        expect(config.value_at(:name)).to eql("philip")
+      end
+
+      it "returns the value at the given key (as a string)" do
+        expect(config.value_at("name")).to eql("philip")
+      end
+
+      it "works with dotted key strings appropriately" do
+        expect(config.value_at("repos.classes.current")).to \
+          eql("/Users/philip/dev/wdi/class_name")
+      end
+
+      it "works with underscored key symbols appropriately" do
+        expect(config.value_at(:repos_classes_current)).to \
+          eql("/Users/philip/dev/wdi/class_name")
+      end
+
+      it "raises an error when the key exists but is not a leaf node" do
+        expect {config.value_at("repos.classes")}.to raise_error
+        expect {config.value_at(:repos_classes)}.to raise_error
+      end
+
+      it "returns false when the key is not in the config file" do
+        expect(config.value_at(:not_a_key)).to be_false
+      end
+
+      context "the value is a property reference, ie starts with a colon" do
+        it "returns the referenced property value" do
+          expect(config.value_at("go.repo")).to \
+            eql("/Users/philip/dev/wdi/class_name")
+        end
+
+        it "works with either format for the reference" do
+          config.set_key_value "go.repo", ":repos_classes_current"
+          expect(config.value_at("go.repo")).to \
+            eql("/Users/philip/dev/wdi/class_name")
+        end
+
+        it "interpolates if the reference is in the value" do
+          expect(config.value_at("go.pattern")).to eql("/$1/$2/philip")
+        end
+
+        it "raises an error when the referenced property does not exist", :broken => true do
+          allow(config).to receive(:disallow_bad_references_in) # not totally secure in this working...
+          config.set_key_value "go.repo", ":not_a_value"
+
+          expect {config.value_at("go.repo")}.to raise_error
+        end
+      end
+
+      context "the value contains an allowed bash command" do
+        let!(:config) {WDI::Config::ConfigFile.new(config_json_contents_with_interpolation)}
+        
+        it "returns the value with the command result interpolated" do
+          expect(config.value_at("base")).to eql((`echo $HOME`).chomp + "/dev/wdi")
+        end
+
+        it "works even when it was referenced" do
+          expect(config.value_at("go.repo")).to eql((`echo $HOME`).chomp + "/dev/wdi/class_name")
+        end
+      end
+    end
+
+    describe "#set_key_value" do
+      it "updates the value at the given key" do
+        config.set_key_value "name", "pj"
+        expect(config.value_at("name")).to eql("pj")
+      end
+
+      it "works when key is given in symbol format" do
+        config.set_key_value :repos_classes_current, "/"
+        expect(config.value_at("repos.classes.current")).to eql("/")
+      end
+
+      it "raises an error if the key doesn't exist" do
+        expect {config.set_key_value "nom", "pj"}.to raise_error
+      end
+
+      it "raises an error if the value isn't a string" do
+        expect {config.set_key_value "name", :pj}.to raise_error
+      end
+
+      context "with string values that have colon-prefixed words" do
+        it "does not allow them unless they reference properties" do
+          expect {config.set_key_value "name", "hello i am :not_name"}.to raise_error
+        end
+
+        it "allows them when they reference properties" do
+          expect {config.set_key_value "name", "hello i am :name"}.not_to raise_error
+        end
+      end
+    end
+
+    describe "#has_key?" do
+      it "returns true if the key exists" do
+        expect(config.has_key?("name")).to be_true
+      end
+
+      it "works when key is given in symbol format" do
+        expect(config.has_key?(:repos_classes_current)).to be_true
+      end
+
+      it "returns false if the key doesn't exist" do
+        expect(config.has_key?("nom")).to be_false
+      end
+    end
+
+    describe "#keys_with_value" do
+      it "returns the keys at the given value (as a symbol)" do
+        expect(config.keys_with_value("philip")).to eql(["name"])
+      end
+
+      it "returns the keys with dots replaced by underscores" do
+        expect(config.keys_with_value("/Users/philip/dev/wdi/class_name")).to \
+          eql(["repos.classes.current"])
+      end
+
+      it "returns multiple keys if necessary" do
+        config.add_key_value("repos.instructors.current", "/Users/philip/dev/wdi/class_name")
+        expect(config.keys_with_value("/Users/philip/dev/wdi/class_name")).to \
+          eql(["repos.classes.current","repos.instructors.current"])
+      end
+
+      it "returns false if the value is not present" do
+        expect(config.keys_with_value("not_a_value")).to be_false
+      end
+    end
+
+    describe "#keys_with_prefix" do
+      it "returns the keys with the given prefix" do
+        expect(config.keys_with_prefix("go")).to eql(["go.repo","go.pattern"])
+      end
+
+      it "returns the key itself if the prefix is a key" do
+        expect(config.keys_with_prefix("go.repo")).to eql(["go.repo"])
+      end
+
+      it "returns false when the key is not present" do
+        expect(config.keys_with_prefix("not_a_key")).to be_false
+      end
+
+      it "returns all keys when given no prefix" do
+        keys = ["name","base","repos.classes.current","go.repo","go.pattern"]
+        expect(config.keys_with_prefix).to match_array(keys)
+      end
+    end
+
+    describe "#add_key_value" do
+      it "adds a new key with the given value" do
+        config.add_key_value("repos.instructors.current", "/Users/philip/dev/wdi/class_name")
+        expect(config.value_at("repos.instructors.current")).to eql("/Users/philip/dev/wdi/class_name")
+      end
+
+      context "when the given key already exists and is not an array" do
+        it "turns the property into an array and pushes the new value on to it" do
+          config.add_key_value("name", "pj")
+          expect(config.value_at("name")).to match_array(["philip","pj"])
+        end
+      end
+
+      context "when the given key already exists and is an array" do
+        it "pushes the new value on to it" do
+          config.add_key_value("name", "pj")
+          config.add_key_value("name", "felipe")
+          expect(config.value_at("name")).to match_array(["philip","pj","felipe"])
+        end
+      end
+
+      context "with string values that have colon-prefixed words" do
+        it "does not allow them unless they reference properties" do
+          expect {config.add_key_value("name", "hello i am :not_name")}.to raise_error
+        end
+
+        it "allows them when they reference properties" do
+          expect {config.add_key_value("name", "hello i am :name")}.not_to raise_error
+        end
+      end
+    end
+
+    describe "#pairs", :unnecessary => true do
+      it "returns all of the key-value pairs" do
+        keys_values = {
+          name: "philip",
+          base: "/Users/philip/dev/wdi",
+          repos_classes_current: "/Users/philip/dev/wdi/class_name",
+          go_repo: ":repos.classes.current",
+          go_pattern: "/$1/$2/:name"
+        }
+        expect(config.pairs).to eql(keys_values)
+      end
+    end
+
+    describe "#keys", :unnecessary => true do
+      it "returns all of the keys" do
+        keys = ["name","base","repos.classes.current","go.repo","go.pattern"]
+        expect(config.keys).to match_array(keys)
+      end
+    end
+
+    describe "#to_h" do
+      it "returns the config's pairs as a hash-tree" do
+        config = WDI::Config::ConfigFile.new(config_json_contents_with_interpolation)
+        hash_tree = {
+          name: "`whoami`",
+          base: "`echo $HOME`/dev/wdi",
+          repos: {
+            classes: {
+              current: "`echo $HOME`/dev/wdi/class_name"
+            }
+          },
+          go: {
+            repo: ":repos.classes.current",
+            pattern: "/$1/$2/:name"
+          }
+        }
+
+        expect(config.to_h).to eql(hash_tree)
+      end
+    end
+
+    describe "#to_json" do
+      it "returns the config's pairs as a JSON string representing the hash-tree" do
+        config = WDI::Config::ConfigFile.new(config_json_contents_with_interpolation)
+        hash_tree = {
+          name: "`whoami`",
+          base: "`echo $HOME`/dev/wdi",
+          repos: {
+            classes: {
+              current: "`echo $HOME`/dev/wdi/class_name"
+            }
+          },
+          go: {
+            repo: ":repos.classes.current",
+            pattern: "/$1/$2/:name"
+          }
+        }
+        
+        expect(config.to_json).to eql(JSON.pretty_generate(hash_tree)) #
+      end
+    end
+
+    describe "#to_s" do
+      it "returns a string version of the contents (not the correct json, but key-val pairs)" do
+        expect(config.to_s).to eql(config.pairs.to_s)
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler"
+require "pry"
+
+Bundler.setup
+
+Dir[File.expand_path('../../lib/wdi/*.rb', __FILE__)].each {|file| require file }
+
+RSpec.configure do |config|
+  config.filter_run_excluding unnecessary: true
+  config.filter_run_excluding broken: true
+
+  config.color = true
+  config.formatter = "documentation"
+end

data/wdi.gemspec

@@ -5,10 +5,11 @@ require 'wdi/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "wdi"
-  spec.version       = Wdi::VERSION
+  spec.version       = WDI::VERSION
   spec.authors       = ["Philip Hughes"]
   spec.email         = ["pj@ga.co"]
-  spec.summary       = %q{A utility for dealing with and configuring the WDI folder and command line tools.}
+  spec.summary       = %q{A utility for working with (and configuring) the WDI directory and WDI command line tools.}
+  spec.description   = %q{TBC}
   spec.homepage      = "https://github.com/ga-instructors/wdi-gem"
   spec.license       = "BSD 3-Clause"
 
@@ -18,8 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake", ">= 0.0"
-  spec.add_development_dependency "pry", ">= 0.0"
+  spec.add_development_dependency "rake",    "~> 10.2"
+  spec.add_development_dependency "rspec",   '~> 2.14', '>= 2.14.1'
+  spec.add_development_dependency "aruba",   '~> 0.5',  '>= 0.5.4'
+  spec.add_development_dependency "pry",     '~> 0.9',  '>= 0.9.12'
 
   spec.add_runtime_dependency "thor", "~> 0.19"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wdi
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Philip Hughes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-30 00:00:00.000000000 Z
+date: 2014-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,30 +28,76 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.5.4
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.9.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 0.9.12
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +112,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.19'
-description: 
+description: TBC
 email:
 - pj@ga.co
 executables:
@@ -81,11 +127,15 @@ files:
 - Rakefile
 - bin/wdi
 - data/default-config.json
+- features/support/env.rb
+- features/version.feature
 - lib/wdi.rb
 - lib/wdi/cli.rb
 - lib/wdi/config.rb
 - lib/wdi/folder.rb
 - lib/wdi/version.rb
+- spec/config_spec.rb
+- spec/spec_helper.rb
 - wdi.gemspec
 homepage: https://github.com/ga-instructors/wdi-gem
 licenses:
@@ -110,6 +160,10 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A utility for dealing with and configuring the WDI folder and command line
-  tools.
-test_files: []
+summary: A utility for working with (and configuring) the WDI directory and WDI command
+  line tools.
+test_files:
+- features/support/env.rb
+- features/version.feature
+- spec/config_spec.rb
+- spec/spec_helper.rb