grepg 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5768dab30082e58dce3e5b49cdb76a29b8fa9da
-  data.tar.gz: ddf1a091efc9ad7eee32d37e3d65ef40696b1127
+  metadata.gz: cee82c12d92813e766763700c3fea73eb1d20f3a
+  data.tar.gz: bc0ed894ffecec938bebf35369bdfc97438e2195
 SHA512:
-  metadata.gz: f2bfe0fa4f80d0c1a6baa4cbd25d2bdc5bff1e5c59f1effaeda4a38bb4a1e8818e642192d13bd15f4d09ea1d3a7f00c0171a3908ee5e858602e993b1e7ca3135
-  data.tar.gz: 73da667814bd9860af347e465933ed7eacc04d376690d832cee8595097c354b529036e0bd2d3486c8cd841e18d6247637d15cdb93ab54c9851267dd778eb69c6
+  metadata.gz: 82fe6a2c37ebcf1e40ec3d3543d0e36aa7534e070900042eb19aef525af5ddeedeb90f61d45f0ef89ff25e4a87d1a5ef32d8e3d4f884d9bcbf9391a8b43cf3f4
+  data.tar.gz: 227627ba0b54bb55b037df46a2e9e86328b70e2d01a3aa45cbff76f3809cbf7fa09c9761c34472522c8369c02690eb0009c3c161416d6609fb732ab7d856b151

data/README.md

@@ -3,15 +3,23 @@ grepg
 
 `grepg` (pronounced Grep G) is a ruby client for [GrepPage](https://www.greppage.com).  It allows you to access your cheat sheets without leaving the terminal.
 
+![grepg screenshot](https://github.com/evidanary/grepg/raw/master/img/screenshot.png)
+
 #Installation
-To install `grepg` run 
+To install `grepg` run
 
 ```
 gem install grepg
 ```
 
+#Requirements
+- ruby (tested on 2.1.2)
+
+
 #Usage
 
+Enter user and topic name followed by an optional search string.
+
 ```
 $ grepg --help
 Usage:
@@ -21,7 +29,7 @@ Options:
   -u, --user=<s>                   username
   -t, --topic=<s>                  topic
   -s, --search=<s>                 text to search
-  -c, --colorize, --no-colorize    colorize output (default: true)
+  -c, --colorize    colorize output (default: true)
   -v, --version                    Print version and exit
   -h, --help                       Show this message
 
@@ -56,15 +64,10 @@ $ grepg -u kdavis -t git -s stash
 User: kdavis, Topic: git, Search-Term: stash
 TO apply your changes
 git stash --apply
-
-To list the stash
-git stash list
-
-Git stash
-git stash
+...
 ```
 
-#Defaults File
+#Configuration
 Setup defaults in `~/.grepg.yml`
 
 ```
@@ -72,7 +75,7 @@ user: evidanary
 colorize: true
 ```
 
-Now, you can access client with
+Now, you can do
 
 ```
 $ grepg -t bootstrap
@@ -80,8 +83,8 @@ User: evidanary, Topic: bootstrap
 ...
 ```
 
-##Development
+#Development
 To execute tests run ```bundle exec rake spec```. To install the gem locally, first build it using ```bundle exec rake build```. Then install the gem ```gem install pkg/grepg-0.0.1.gem```
 
-##License
+#License
 grepg is under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/grepg/parser.rb

@@ -47,7 +47,12 @@ Defaults:
       end
 
       @opts = Trollop::with_standard_exception_handling parser do
-        parser.parse args
+        opts = parser.parse args
+        # User is a required field, manually handling validation because
+        # we fallback on defaults from the file
+        raise Trollop::CommandlineError,
+          "Missing --user parameter. e.g. --user evidanary" unless opts[:user]
+        opts
       end
 
       @user = @opts[:user]

data/lib/grepg/version.rb

@@ -1,3 +1,3 @@
 module GrepPage
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/grepg/parser_spec.rb

@@ -34,6 +34,17 @@ describe GrepPage::Parser do
         parser = GrepPage::Parser.new('-t css'.split(' '))
         expect(parser.instance_variable_get(:@opts)[:user]).to eq('kdavis')
       end
+
+      # Test if we get an error when no user is specified. We should tell the user
+      # a sample username they can use if they want to try the client out without
+      # creating an account
+      it "errors when no user is specified" do
+        expect(File).to receive(:exist?).and_return(false)
+        expect do
+          output = GrepPage::Parser.new('-t css'.split(' '))
+          expect(output).to match(/Missing --user parameter.*--user.*"/)
+        end.to raise_error(SystemExit)
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grepg
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Yash Ranadive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-16 00:00:00.000000000 Z
+date: 2016-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -109,6 +109,7 @@ files:
 - Rakefile
 - bin/grepg
 - grepg.gemspec
+- img/screenshot.png
 - lib/grepg.rb
 - lib/grepg/api.rb
 - lib/grepg/formatter.rb