recall 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63e153546eaa867df709c3032094c3b94b9fce07
-  data.tar.gz: 9aac8ecd3fe8ea148e08e4d6b181715133bbd42c
+  metadata.gz: f0cd72c43e2ad76cc2fa2d26fb4b631683cd39c9
+  data.tar.gz: 972070255c4cba8f924f0ec3632a5162bd3e9f45
 SHA512:
-  metadata.gz: 65e1263f8bd985db9b1d2aacba23ab12cd84ed0840fc60b2108432e0ee8b4a100c7a01f372fa5fd843ada335c89e164480b2884a40d3a81458b674b2ac3cd245
-  data.tar.gz: 88ebdd5eb4872971de3341df283f4ef3815c6263d160c55ebd8f10e450648b284f59c980ac79624a3317a8dd00aeb235595e3cd9c3841041a2adbe9918250e1c
+  metadata.gz: c1f6f07248093691e2872fffa6aeb3a822186213adec12b10e92aa8c891e378d37735863736ecdddf17c6b9ff9c86c881689dc46f9cc5029fcd68490769cdb2e
+  data.tar.gz: 8c029e0471569e6740f3e3a234cc0e804d3af80ad1eaf4c0ecc28a06c564a85ef89b456f4ec4986bbdcaad295402b6ca27b51a38263eb41571b053ad51981091

data/README.md

@@ -1,6 +1,7 @@
 # Recall
 
-# Recall v. 0.0.1
+[![Gem Version](https://badge.fury.io/rb/recall.png)](http://badge.fury.io/rb/recall)
+
 #### A command line interface that searches for previous examples of Ruby code based on user's query and present results in default Ruby editor.
 
 > [E]ach time the natural laziness which deters us from every difficult enterprise, every work of importance, has urged me to leave the thing alone, to drink my tea and to think merely of the worries of today and of my hopes for tomorrow, which let themselves be pondered over without effort or distress of mind. 
@@ -11,8 +12,17 @@
 
 Ever want to find a piece of code you've written but aren't sure which project or file you wrote it in? 
 
-Recall is a simple Ruby app, run via the command line, to recursively search your the Ruby files in your code folder. It's a little janky at this point-- use at your own risk. 
+Recall is a simple Ruby Gem, run via the command line, to search your the Ruby files in your code folder. 
+
+Huge thanks to [Kevin Curtin](https://twitter.com/kcurtin) for getting the gem working!
  
+## What it Does
+
+The first time users run `Recall`, they'll be prompted to enter the absolute path of their desired search directory (most likely the user's main "code" directory). 
+
+Once the user sets his or her prefered search directory, Recall accepts a search query and will recursively search through all of the .rb files in that directory for mentions of the query. An example of a typcial query would be a semi-exotic Ruby method like `.each_with_object`. 
+
+When it's completed its search, Recall opens a new .rb file in the user's default text editor, presenting all of the search results it found. When the user is finished with the results, he or she can simply close it. The results file is overwritten with each subsequent search.
  
 ## Installation
 
@@ -20,12 +30,16 @@ From your command line, enter:
 
 `gem install recall`
 
+Awesome!
+
 ## Use
 
-Type `recall` into your command line. The first time you call the gem it will ask for the absolute path of a directory for it to search. It will search all of the .rb files in that directory, recursively. 
+To use recall, simply type `recall` into your command line from any directory. The first time you call the gem it will ask for the absolute path of a directory for it to search. Then it will ask for a search query. It will search all of the .rb files in that directory, recursively, and present the results in a new .rb file. 
 
 Your search directory will persist until you change it. To change the search directory, enter `change_dir` into the prompt. 
 
+## Notes
 
+Currently, Recall only searches files with the .rb extension. 
 
 

data/lib/recall/results.rb

@@ -38,7 +38,7 @@ class Recall::Results
 
   def get_grep_results
     format_query #                                   # /Users/samschlinkert/Documents/code/flatiron
-    return `grep -r -n -i --include=*.rb "#{@query}" #{@search_path} | sort -r`
+    return `grep -r -n -i --include=*.rb --include=*.erb "#{@query}" #{@search_path} | sort -r`
   end
 
   Result = Struct.new(:file_path, :line_number, :code_snippet, :full_code) 

data/lib/recall/version.rb

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

data/recall.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["sschlinkert@gmail.com"]
   spec.summary       = "Simple Local Code Search"
   spec.description   = "Search a local directory for a specific query"
-  spec.homepage      = "http://sts10.github.io"
+  spec.homepage      = "https://github.com/sts10/recall"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recall
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Sam Schlinkert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-16 00:00:00.000000000 Z
+date: 2014-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,7 +76,7 @@ files:
 - recall.gemspec
 - spec/lib/results_spec.rb
 - spec/spec_helper.rb
-homepage: http://sts10.github.io
+homepage: https://github.com/sts10/recall
 licenses:
 - MIT
 metadata: {}