grepg 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 331496fd951ec8ae351b57bcb1ec44a55579e19b
-  data.tar.gz: 21b1d330d1f9220711f7c5b73f3c8ed1531042f4
+  metadata.gz: e5768dab30082e58dce3e5b49cdb76a29b8fa9da
+  data.tar.gz: ddf1a091efc9ad7eee32d37e3d65ef40696b1127
 SHA512:
-  metadata.gz: e2a482f0a77a804c65998efe3650a56e068b402adcfb97c34bc7bfb8127104f68105ff0593c45c8b1d7b1b0a4cda5152ad76690448d349f4f98d6747c1fe641b
-  data.tar.gz: 4ce5ba2f7daee0ea9cc311b83a4d421b56f4868cae45371e65f9118035246f23bb40cf26d05f936e61bdcb81441a58ea5212d6a5976b014989b7fdba796fb177
+  metadata.gz: f2bfe0fa4f80d0c1a6baa4cbd25d2bdc5bff1e5c59f1effaeda4a38bb4a1e8818e642192d13bd15f4d09ea1d3a7f00c0171a3908ee5e858602e993b1e7ca3135
+  data.tar.gz: 73da667814bd9860af347e465933ed7eacc04d376690d832cee8595097c354b529036e0bd2d3486c8cd841e18d6247637d15cdb93ab54c9851267dd778eb69c6

data/README.md

@@ -1,33 +1,50 @@
-#grepg
-###The ruby client for greppage
+grepg
+===
 
-`grepg` (pronounced Grep G) is a ruby client for [GrepPage](https://www.greppage.com).  It is packaged as a gem.
+`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.
 
-###Install
-To install `grepg` run ```gem install grepg```
+#Installation
+To install `grepg` run 
 
-###Examples
 ```
+gem install grepg
+```
+
+#Usage
+
+```
+$ grepg --help
 Usage:
-grepg user_name topic_name [-s search_term]
+  grepg -u user_name -t topic_name [-s search_term]
+
+Options:
+  -u, --user=<s>                   username
+  -t, --topic=<s>                  topic
+  -s, --search=<s>                 text to search
+  -c, --colorize, --no-colorize    colorize output (default: true)
+  -v, --version                    Print version and exit
+  -h, --help                       Show this message
+
+Examples:
+  grepg -u evidanary -t css
+  greppg -u evidanary -t css -s color
+
+Defaults:
+  To set default user, create a file in ~/.grepg.yml with
+  default_user: test
 ```
 
-Get all items/microdoc for a topic on any collection.
+
+For example, to get all cheats for the `git` topic for user `kdavis`
 
 ```
-$ grepg kdavis git
-User: kdavis, Topic: git
+$ grepg -u evidanary -t git
+User: evidanary, Topic: git
 push tags to remote / Github
 git push --tags
 
 remove delete tag
 git tag -d v0.0.8
-
-list branches that have not been merged
-git branch --no-merged
-
-list branches merged into master
-git branch --merged master
 ...
 
 ```
@@ -35,7 +52,7 @@ git branch --merged master
 Search for a specific string
 
 ```
-$ grepg kdavis git -s stash
+$ grepg -u kdavis -t git -s stash
 User: kdavis, Topic: git, Search-Term: stash
 TO apply your changes
 git stash --apply
@@ -47,8 +64,24 @@ Git stash
 git stash
 ```
 
+#Defaults File
+Setup defaults in `~/.grepg.yml`
+
+```
+user: evidanary
+colorize: true
+```
+
+Now, you can access client with
+
+```
+$ grepg -t bootstrap
+User: evidanary, Topic: bootstrap
+...
+```
+
 ##Development
-To run 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```
+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
 grepg is under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/grepg/formatter.rb

@@ -3,10 +3,18 @@ module GrepPage
   class Formatter
     # Displays an array of cheats
     # TODO: Highlight search term
-    def self.cheat_rows(cheats, search_term)
+    DESCRIPTION_COLOR= :green
+    COMMAND_COLOR= :blue
+    def self.cheat_rows(cheats, search_term, colorize)
       cheats.map do |cheat|
-        puts cheat[:description].colorize(:green)
-        puts cheat[:command].colorize(:blue)
+        description = cheat[:description]
+        command = cheat[:command]
+        if colorize
+          description = description.colorize(DESCRIPTION_COLOR)
+          command = command.colorize(COMMAND_COLOR)
+        end
+        puts description
+        puts command
         puts
       end
     end

data/lib/grepg/parser.rb

@@ -1,36 +1,69 @@
 require 'trollop'
 require 'rest-client'
+require 'yaml'
+require_relative 'version'
 
 # This class parses commandline arguments
 module GrepPage
   class Parser
     def initialize(args)
+      default_config = self.class.get_default_config
       parser = Trollop::Parser.new do
+        opt :user,
+          "username",
+          :type => :string,
+          :default => default_config['user'],
+          :short => "-u"
+        opt :topic,
+          "topic",
+          :type => :string,
+          :required => true,
+          :short => "-t"
         opt :search,
           "text to search",
           :type => :string,
           :required => false,
           :short => "-s"
+        opt :colorize,
+          "colorize output",
+          :type => :boolean,
+          :default => default_config['colorize'],
+          :short => "-c"
+        version "grepg version #{GrepPage::VERSION}"
         banner <<-EOS
 
 Usage:
-  grepg user_name topic_name [-s search_term]
+  grepg -u user_name -t topic_name [-s search_term]
 
 Examples:
-  grepg kdavis css
-  greppg kdavis css -s color
+  grepg -u evidanary -t css
+  greppg -u evidanary -t css -s color
+
+Defaults:
+  To set defaults, create a file in ~/.grepg.yml with
+  user: test
+  colorize: true
         EOS
       end
 
       @opts = Trollop::with_standard_exception_handling parser do
-        raise Trollop::HelpNeeded if args.size < 2 # show help screen
         parser.parse args
       end
 
-      leftovers = parser.leftovers
-      @user = leftovers.shift
-      @topic = leftovers.shift
+      @user = @opts[:user]
+      @topic = @opts[:topic]
       @search_term = @opts[:search]
+      @colorize = @opts[:colorize]
+    end
+
+    def self.get_default_config
+      file = self.default_file_name
+      file ? YAML.load(IO.read(file)) : {}
+    end
+
+    def self.default_file_name
+      file = ENV['HOME'] + '/.grepg.yml'
+      File.exist?(file) ? file : nil
     end
 
     def get_all_topics(user)
@@ -54,29 +87,33 @@ Examples:
       end
     end
 
-    def run!
-      headers = ["User: #{@user}", "Topic: #{@topic}"]
-      headers << "Search-Term: #{@search_term}" if @search_term
+    def process_args(user, topic, search_term, colorize)
+      headers = ["User: #{user}", "Topic: #{topic}"]
+      headers << "Search-Term: #{search_term}" if search_term
       puts headers.join(", ")
 
       begin
-        topics = get_all_topics(@user)
+        topics = get_all_topics(user)
       rescue RestClient::ResourceNotFound
         puts "That username does not exist"
-        exit 1
+        raise "Unable to find user"
       end
 
-      topic = filter_topics(topics, @topic)
+      topic = filter_topics(topics, topic)
       if topic.nil? || topic.empty?
         puts "Can't find that topic. Choose one of the following"
         puts topics.map{|t| t[:name]}
-        exit 1
+        raise "Unable to find topic"
       end
 
-      cheats = get_cheats(@user, topic[:id])
-      cheats = filter_cheats(cheats, @search_term) if @search_term
+      cheats = get_cheats(user, topic[:id])
+      cheats = filter_cheats(cheats, search_term) if search_term
 
-      GrepPage::Formatter.cheat_rows(cheats, @search_term)
+      GrepPage::Formatter.cheat_rows(cheats, search_term, colorize)
+    end
+
+    def run!
+      process_args(@user, @topic, @search_term, @colorize)
     end
   end
 end

data/lib/grepg/version.rb

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

data/spec/grepg/parser_spec.rb

@@ -1,20 +1,67 @@
 require 'json'
+require 'yaml'
 require_relative '../../lib/grepg.rb'
 
 describe GrepPage::Parser do
   describe '.initialize' do
     context "expected behavior" do
       it "returns a set of cheats when username and topic are given" do
-        parser = GrepPage::Parser.new(['kdavis', 'css'])
+        parser = GrepPage::Parser.new('-u kdavis -t css'.split(' '))
         output = capture_stdout { parser.run! }
         expect(output).to match(/colors/)
       end
 
       it "returns a set of cheats when username, topic and search term are given" do
-        parser = GrepPage::Parser.new(['kdavis', 'css', '-s', 'colors'])
+        parser = GrepPage::Parser.new('-u kdavis -t css -s colors'.split(' '))
         output = capture_stdout { parser.run! }
         expect(output).to match(/colors/)
       end
+
+      # Test if we are seeing colors in the output
+      # This is blue - "\e[0;34;49mThis is blue\e[0m"
+      it "colorizes output of the result" do
+        parser = GrepPage::Parser.new('-u kdavis -t css -c'.split(' '))
+        output = capture_stdout { parser.run! }
+        expect(output.inspect).to include("\\e[0;34;49m")
+      end
+
+      # Test if defaut file gets read
+      it "reads username from the defaults file" do
+        expect(File).to receive(:exist?).and_return(true)
+        expect(IO).to receive(:read).with(ENV['HOME'] + '/.grepg.yml').and_return({
+          "user" => "kdavis"
+        }.to_yaml)
+        parser = GrepPage::Parser.new('-t css'.split(' '))
+        expect(parser.instance_variable_get(:@opts)[:user]).to eq('kdavis')
+      end
+    end
+  end
+
+  describe '#default_file_name' do
+    it('returns nil if ~/.grepg.yml doesnt exist') do
+      expect(File).to receive(:exist?).and_return(false)
+      expect(GrepPage::Parser.default_file_name).to be(nil)
+    end
+
+    it('returns filename if ~/.grepg.yml exists') do
+      expect(File).to receive(:exist?).and_return(true)
+      expect(GrepPage::Parser.default_file_name).to eq(ENV['HOME'] + '/.grepg.yml')
+    end
+  end
+
+  describe '#get_default_config' do
+    it('returns empty hash if ~/.grepg.yml doesnt exist') do
+      expect(File).to receive(:exist?).and_return(false)
+      expect(GrepPage::Parser.get_default_config).to eq({})
+    end
+
+    it('returns parses YML if ~/.grepg.yml exists') do
+      default_contents = {
+        "user" => "test"
+      }
+      expect(File).to receive(:exist?).and_return(true)
+      expect(IO).to receive(:read).and_return(default_contents.to_yaml)
+      expect(GrepPage::Parser.get_default_config).to eq(default_contents)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grepg
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Yash Ranadive
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-07 00:00:00.000000000 Z
+date: 2016-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -136,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A ruby client to access greppage.com from the commandline