robin-chit 0.0.1 → 0.0.2

data/README.txt

@@ -4,29 +4,39 @@ http://github.com/robin/chit
 
 == DESCRIPTION:
 
-Chit is A command line tool for cheat sheet utility based on git.
+Chit is a command line cheat sheet utility based on git.
 
 == FEATURES:
 
-Chit was inspired by 'cheat' (http://cheat.errtheblog.com/) by Chris Wanstrath. You can use chit to access and manage your cheat sheets easily. 
+Chit was inspired by 'cheat' (http://cheat.errtheblog.com/) by Chris Wanstrath. You can use chit to access and manage cheat sheets easily. 
 
-There are several differences between 'cheat' and 'chit'. By using chit, besides the wonderful features of 'cheat', you get:
+There are several differences between ‘cheat’ and ‘chit’. By using chit, besides the wonderful features of ‘cheat’, you get:
 
-1. Git powered cheat sheet repository. You can specify where you get the sheets and where to share them. 
-2. Your own private cheat sheet. Everybody has some project related or smoe cheat sheets which are not mean to public. You can also put them into chit
+1. Git powered cheat sheet repository. You can specify where you get the sheets and where to share them.
+2. Your own private cheat sheets. Everybody has some project related or smoe cheat sheets which are not mean to public. You can also put them into chit
 3. Directory support. You can group cheat sheets by directory now.
-4. one less letter to type.
+4. One less letter to type.
 
 == SYNOPSIS:
 
-To get your cheat sheet:
+To initialize chit repositories
+
+$ chit --init
+
+This will be run automatically when you run chit for the first time. 
+
+To get a cheat sheet:
+
 $ chit [cheatsheet]
-If it does not exist, a new one will be created and waiting for your editing. Leave it blank and quit the editor if you don't want to add a new one.
+
+If it does not exist, a new one will be created and waiting for editing. Leave it blank and quit the editor if you don't want to add a new one.
 
 To edit a cheat sheet, use the --edit switch.
+
 $ cheat [cheatsheet] --edit
 
 To add a cheat sheet, use the --add switch.
+
 $ cheat [cheatsheet] --add
 
 During editing a cheat sheet, empty the content will get the cheat sheet removed.
@@ -34,17 +44,30 @@ During editing a cheat sheet, empty the content will get the cheat sheet removed
 A prefix '@' indicates the cheat sheet is in private mode. A private cheat sheet is kept in another repository.
 
 To get your private cheat sheet:
+
 $ chit @[cheatsheet]
 
 The prefix '@' works the same for both --edit and --add.
 
 The cheat sheet can be in a path. For example:
+
 $ chit mysql/select
-will get your the cheat sheet 'select' under mysql.
+
+will get the cheat sheet 'select' under mysql.
+
+To show all the cheat sheets:
+
+$ chit [all|show]
+
+To show all the private cheat sheets:
+
+$ chit @[all|show]
 
 == INSTALL:
 
-sudo gem install chit
+sudo gem install robin-chit -s http://gems.github.com
+
+chit --init
 
 == CONFIGURATION:
 
@@ -52,9 +75,9 @@ Before run 'chit', you may want to config ~/.chitrc which is a YAML file.
 
 * root: local path to store the cheat sheet. By default, it is ~/.chit
 * main: 
-** clone-from: where to get the public cheat sheets. You can use git://github.com/robin/chitsheet.git, which is a snap shoot of http://cheat.errtheblog.com/.
+* clone-from: where to get the public cheat sheets. You can use git://github.com/robin/chitsheet.git, which is a snap shoot of http://cheat.errtheblog.com/.
 * private:
-** clone-from: where to get the private cheat sheets. If not specified, a new git repository will be init for private cheat sheets.
+* clone-from: where to get the private cheat sheets. If not specified, a new git repository will be init for private cheat sheets.
 
 == REQUIREMENTS:
 
@@ -65,7 +88,7 @@ Before run 'chit', you may want to config ~/.chitrc which is a YAML file.
 
 This software is shared by MIT License
 
-Copyright (c) 2008 FIX
+Copyright (c) 2008 Robin Lu
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -87,6 +110,9 @@ TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 == BY:
+
 Robin Lu
+
 http://www.robinlu.com
+
 iamawalrus[at]gmail[dot]com

data/lib/chit.rb

@@ -3,18 +3,29 @@ $:.unshift File.dirname(__FILE__)
 
 module Chit
   extend self
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
   
   defaults = {
     'root'  => "#{ENV['HOME']}/.chit"
   }
   
-  CONFIG = defaults.merge(YAML.load_file("#{ENV['HOME']}/.chitrc"))
+  CHITRC = "#{ENV['HOME']}/.chitrc"
+  
+  FileUtils.cp(File.join(File.dirname(__FILE__), "../resources/chitrc"), CHITRC) unless File.exist?(CHITRC)
+  
+  CONFIG = defaults.merge(YAML.load_file(CHITRC))
   
   def run(args)
+    unless File.exist?(main_path) && File.exist?(private_path)
+      return unless init_chit
+    end
     args = args.dup
     
     return unless parse_args(args)
+
+    if %w[sheets all].include? @sheet
+      return list_all()
+    end
     
     unless File.exist?(sheet_file)
       update
@@ -34,15 +45,23 @@ module Chit
     @sheet = args.shift || 'chit'
     is_private = (@sheet =~ /^@(.*)/)
     @sheet = is_private ? $1 : @sheet
+
     working_dir = is_private ? private_path : main_path
-    @fullpath = File.join(working_dir, "#{@sheet}.yml")
     @git = Git.open(working_dir)
+
+    @fullpath = File.join(working_dir, "#{@sheet}.yml")
     
     add(sheet_file) and return if args.delete('--add')
     edit(sheet_file) and return if args.delete('--edit')
     true
   end
   
+  def list_all
+    files = @git.ls_files.to_a.map {|f| 
+      f[0][0..((f[0].rindex('.')||0) - 1)]}
+    puts files.sort.join("\n")
+  end
+  
   def sheet_file
     @fullpath
   end
@@ -80,9 +99,6 @@ module Chit
   end
   
   def update
-    unless File.exist?(main_path)
-      return unless init_chit
-    end
     if CONFIG['main']['clone-from']
       g = Git.open(main_path)
       g.pull

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: robin-chit
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Robin Lu