wdi 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d1ec1fcc001ba09d964a62821fabb66ecb3074fb
-  data.tar.gz: 101bf5ed65caacf9a209449c5c87ddad98d26801
+  metadata.gz: 072e4d21629eadc99678fe270a358e9314472052
+  data.tar.gz: 92f8aa139b8714d8f24fb7450f4965bb64bfea85
 SHA512:
-  metadata.gz: a0cc12ec82b6348c56c9a451174a530782ceccdc77f1680f94f5ff41e1cb6b0eb6bd926ae3272df487fd970e095ce0df96d079a740f96de868fd09a9fb6863bb
-  data.tar.gz: 5d871cef7d679f85f77cea08204b8c553d63394aba4345c7ae2074cd315d9a1a1a205f7a94f6d86fde5b2a4a4b07864d620d4b5893b3ec1b64aeae302d9e9d39
+  metadata.gz: ee5fa06b3dab7bc021c052e34a0cd4b9dcd9f7317453df1c252834d71a158ca682e959d0b80400e4f0c98f953e0e14b9dd1a0da1fe848ec94eeffb01235964a5
+  data.tar.gz: 37e8829b0ed20141daf877ef632685d3f86f9eeacfde723175cd64a88b6f61886d8993e262348fd673677148e7382c433fa5f8793fef5a3552be6dac0389c82a

data/LICENSE.txt

@@ -1,22 +1,27 @@
-Copyright (c) 2014 h4w5
+Copyright (c) 2014, General Assembly
+All rights reserved.
 
-MIT License
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+* Neither the name of General Assembly nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -1,29 +1,26 @@
-# Wdi
+# The WDI Tool
 
-TODO: Write a gem description
+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.
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'wdi'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
+## Usage
 
-    $ gem install wdi
+```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`
+```
 
-## Usage
+```bash
+wdi config set <key(.key...)> <value>
+wdi config get <key(.key...)>
 
-TODO: Write usage instructions here
+wdi config add <key(.key...)> <value>
+wdi config remove <key(.key...)> (--force)
 
-## Contributing
+wdi config keys (<key>)
 
-1. Fork it ( http://github.com/<my-github-username>/wdi/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+# wdi get-base
+# wdi get-repo class.current
+```

data/bin/wdi

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "wdi/cli"
+WDI::CLI::Wdi.start(ARGV)

data/data/default-config.json

@@ -0,0 +1,8 @@
+{
+  "base": "`echo $HOME`/dev/wdi",
+  "repos": {
+    "classes": {
+      "current": "`echo $HOME`/dev/wdi/class_name"
+    }
+  }
+}

data/lib/wdi/cli.rb

@@ -0,0 +1,75 @@
+require "wdi"
+require "wdi/folder"
+require "wdi/config"
+require "thor"
+
+module WDI
+  module CLI
+    class Config < Thor
+      desc "set", "set a value in the WDI config file"
+      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
+        rescue WDI::ConfigError => e
+          say e.message, :red
+        end
+      end
+
+      desc "get", "get a value from the WDI config file"
+      def get(key)
+        begin
+          say WDI::Config::get(WDI::Config::translate(key), key)
+        rescue WDI::ConfigError => e
+          say e.message, :red
+        end
+      end
+
+      # desc "add", "an alias for set that appends values to a key's list (if the values are in an array)"
+      # def add(key, *values)
+
+      # end
+
+      # desc "remove", "deletes a key from the config file"
+      # method_option :force,
+      #               aliases: ["-f"],
+      #               default: false,
+      #               desc:    "Force key's removal, if it exists, without prompting the user for confirmation."
+      # def remove(key)
+
+      # end
+
+      desc "keys", "list the keys in the WDI config file"
+      def keys(key=nil)
+        begin
+          say WDI::Config::keys(WDI::Config::translate(key), key).join("\n")
+        rescue WDI::ConfigError => e
+          say e.message, :red
+        end
+      end
+    end
+
+    class Wdi < Thor
+      desc "init", "initialize a new WDI directory at ~/.wdi"
+      method_option :load, 
+                    aliases: ["-l"],
+                    default: WDI::DEFAULT_CONFIG_FILE, 
+                    desc:    "Load the WDI config(.json) from a local file or URI path."
+      method_option :force,
+                    aliases: ["-f"],
+                    default: false,
+                    desc:    "Force overwrite of the current WDI directory, if it exists."
+      def init
+        begin
+          WDI::Folder::create_with_config(options[:force], options[:load])
+          say "The .wdi folder and config file have been created.", :green
+        rescue WDI::ConfigError, WDI::FolderError => e
+          say e.message, :red
+        end
+      end
+
+      desc "config SUBCOMMAND ...ARGS", "interact with the WDI config file"
+      subcommand "config", WDI::CLI::Config
+    end
+  end
+end

data/lib/wdi/config.rb

@@ -0,0 +1,131 @@
+require "open-uri"
+require "json"
+require "thor"
+
+require "pry"
+
+module WDI
+  module Config
+    KEY_REGEX = /^[a-z.]*$/ # only lowercase words separated by periods
+
+    def self.path
+      File.expand_path("config.json", WDI::Folder::path)
+    end
+
+    def self.exists?
+      File.exists?(self.path)
+    end
+
+    def self.file
+      @@config ||= self.load
+    end
+
+    def self.load
+      @@config = JSON.parse(IO.read(self.path), symbolize_names: true)
+    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)
+      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))
+        self.save
+
+      rescue Errno::ENOENT => e
+        raise WDI::ConfigError, "No file at this path. Use 'http://' prefix if URI."
+      rescue URI::InvalidURIError => e
+        raise WDI::ConfigError, "Malformed URI. Could not find file at this path."
+      rescue OpenURI::HTTPError => e
+        raise WDI::ConfigError, "Provided URI can not be found. Ensure that the link is active."
+      rescue JSON::ParserError => e
+        raise WDI::ConfigError, "Provided file is not correctly formatted JSON."
+      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)
+      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
+
+      return key_list
+    end
+
+    ############################################
+
+    def self.append_keys(parent, child)
+      parent = (parent.nil? || parent == "") ? "" : parent.to_s + "."
+      child  = (child.nil? || child == "")  ? "" : child.to_s
+      parent + child
+    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?
+
+      return (child.nil? ? value : self.translate(child, value))
+    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

@@ -0,0 +1,34 @@
+require "wdi/config"
+require "fileutils"
+require "json"
+
+module WDI
+  module Folder
+    def self.path
+      File.expand_path(".wdi", "~")
+    end
+
+    def self.exists?
+      File.exists?(self.path)
+    end
+
+    def self.create(remove_current_directory)
+      self.remove! if remove_current_directory
+
+      raise WDI::FolderError, \
+        "The .wdi folder already exists. Either remove it to initialize anew, " + \
+        "or use `wdi config` to edit the config file."  if self.exists?
+
+      Dir.mkdir self.path
+    end
+
+    def self.create_with_config(remove_current_directory, file)
+      self.create(remove_current_directory)
+      WDI::Config::load_file(file)
+    end
+
+    def self.remove!
+      FileUtils.rm_rf(self.path) if self.exists?
+    end
+  end
+end

data/lib/wdi/version.rb

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

data/lib/wdi.rb

@@ -1,5 +1,11 @@
 require "wdi/version"
 
-module Wdi
-  # Your code goes here...
+module WDI
+  DEFAULT_CONFIG_FILE = File.expand_path("../../data/default-config.json", __FILE__)
+
+  class ConfigError < Exception
+  end
+
+  class FolderError < Exception
+  end
 end

data/wdi.gemspec

@@ -6,11 +6,11 @@ require 'wdi/version'
 Gem::Specification.new do |spec|
   spec.name          = "wdi"
   spec.version       = Wdi::VERSION
-  spec.authors       = ["h4w5"]
-  spec.email         = ["philip@h4w5.com"]
-  spec.summary       = %q{A utility tool for dealing with and configuring WDI command line tools.}
+  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.homepage      = "https://github.com/ga-instructors/wdi-gem"
-  spec.license       = "MIT"
+  spec.license       = "BSD 3-Clause"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -18,5 +18,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rake", ">= 0.0"
+  spec.add_development_dependency "pry", ">= 0.0"
+
+  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.1
+  version: 0.0.2
 platform: ruby
 authors:
-- h4w5
+- Philip Hughes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,18 +30,47 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
 description: 
 email:
-- philip@h4w5.com
-executables: []
+- pj@ga.co
+executables:
+- wdi
 extensions: []
 extra_rdoc_files: []
 files:
@@ -50,12 +79,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/wdi
+- data/default-config.json
 - lib/wdi.rb
+- lib/wdi/cli.rb
+- lib/wdi/config.rb
+- lib/wdi/folder.rb
 - lib/wdi/version.rb
 - wdi.gemspec
 homepage: https://github.com/ga-instructors/wdi-gem
 licenses:
-- MIT
+- BSD 3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -76,5 +110,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A utility tool for dealing with and configuring WDI command line tools.
+summary: A utility for dealing with and configuring the WDI folder and command line
+  tools.
 test_files: []