git-feats 0.0.5 → 0.0.6

data/HISTORY.md

@@ -1,3 +1,12 @@
+# Alpha Releases
+
+## 0.0.6 (2012-12-12)
+
+* adds 'feats help' command
+* changes 'update-feats' to 'feats update'
+* fixes serialization bug
+* adds much better 'feats update' dialogue
+
 ## 0.0.4 (2012-12-11)
 
 * adds `version` command

data/README.md

@@ -12,7 +12,7 @@ See [alias](#alias) for instructions.
 
 ## Usage
 
-#### With Alias
+#### With alias
 
 If you alias `git-feats`, just keep using `git` like you always have. Occasionally, you will complete feats and it will look like this:
 
@@ -36,7 +36,7 @@ no changes added to commit (use "git add" and/or "git commit -a")
 
 ```
 
-#### Without Alias
+#### Without alias
 
 If you don't alias `git` to `git-feats` you can still use `git-feats` in place of `git`:
 
@@ -44,6 +44,21 @@ If you don't alias `git` to `git-feats` you can still use `git-feats` in place o
 $ git-feats status
 ```
 
+#### git-feats commands
+
+git-feats also has commands that git-feats specific and don't mess with git.
+
+
+```
+$ git feats
+
+usage: git feats <command>
+
+commands:
+  update  Update your feats and command history on gitfeats.com
+  help    Display git-feats specific help
+```
+
 ## Alias
 
 Add the following to your `.bash_profile` or other startup script:
@@ -58,6 +73,10 @@ alias git=git-feats
 
 Linking your account is as easy as:
 
+```
+git config --global github.user <your github username>
+```
+
 ```
 git config --global feats.key <your api key>
 ```

data/lib/git-feats/api.rb

@@ -11,12 +11,16 @@ module GitFeats
     def upload_feats
       # Post json to git-feats
       begin
+        puts "Updating feats on gitfeats.com..."
+        # Attempt to update feats
         conn.post do |req|
           req.url '/api/post_feats'
           req.headers['Content-Type'] = 'application/json'
           req.body = upload_feats_body.to_json
         end
+        puts
       rescue
+        puts "Connection failed!\n\n"
       end
     end
 

data/lib/git-feats/config.rb

@@ -18,7 +18,7 @@ module GitFeats
 
     # Check if config exists and is configured properly
     def exists?
-      name && key
+      !name.empty? && !key.empty?
     end
   end
 end

data/lib/git-feats/runner.rb

@@ -15,15 +15,21 @@ module GitFeats
       new(*args).run
     end
 
-    # Execute git command
+    # Run the args as one of the following:
+    # - Pure git-feats command
+    # - Overridden git command
+    # - Pure git command
     def run
-      
-      # Check for git-feats commands
+      # Pure git-feats command
       case @args[0]
-      when "update-feats"
-        update_feats
+      when "feats"
+        run_feats_cmd
+
+      # Overriden git command
       when "version" || "--version"
         version
+
+      # Pure git command
       else
         exec_args
       end
@@ -31,17 +37,44 @@ module GitFeats
 
     private
 
-    def update_feats
+    # Run git-feats specific update command
+    def feats_update
       if Config.exists?
         API.upload_feats
       end
     end
 
+    # Run git-feats specific help command
+    def feats_help
+      puts <<help
+usage: git feats <command>
+
+commands:
+  update  Update your feats and command history on gitfeats.com
+  help    Display git-feats specific help
+help
+    end
+
+    # Override `git version` to output the git-feats version
     def version
       puts "git-feats version #{GitFeats::VERSION}" 
       exec_args
     end
 
+    # Run a git-feats specific command
+    #
+    # Precondition: The first argument is 'feats'
+    # ex: 'git feats update'
+    def run_feats_cmd
+      case @args[1]
+      when "update"
+        feats_update
+      else
+        feats_help
+      end
+    end
+
+    # Exec the args as a git command
     def exec_args
       exec(*@args.to_exec)
     end

data/lib/git-feats/serializer.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'fileutils'
 
 module GitFeats
   module Serializer
@@ -13,8 +14,7 @@ module GitFeats
     # Returns nothing
     def serialize(path, data)
       # Make a path to the data file if one doesn't already exist
-      dir = File.dirname path
-      FileUtils.mkdir(dir) unless File.directory?(dir)
+      mkpath_to path
 
       File.open(path, "w") do |f|
         f.puts data.to_json
@@ -35,5 +35,13 @@ module GitFeats
         end
       end 
     end
+
+    private
+
+    def mkpath_to(path)
+      unless File.exists? path
+        FileUtils.mkpath File.dirname(path)      
+      end
+    end
   end
 end

data/lib/git-feats/version.rb

@@ -1,3 +1,3 @@
 module GitFeats
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-feats
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors: