zsh_dots 0.5.4 → 0.5.5

data/README.md

@@ -1,7 +1,15 @@
 DOTS
 ====
 
-DOTS is a framework for ZSH that helps you manage your dot-files, ZSH sugar functionality, and your general shell experience. It began its life as a fork off the popular [Oh My ZSH framework][omz]. It has similar design philosophies and functionality, but different goals. Where Oh My ZSH is meant for new users to get more acclamated with ZSH, DOTS is meant for the slightly more advanced user who wants the built-in functionality of Oh My ZSH but wants additional customization and functionality, such as the copying and synchronization of "dot-files".
+DOTS is a framework for ZSH that helps you manage your dot-files, ZSH
+sugar functionality, and your general shell experience. It began its
+life as a fork off the popular [Oh My ZSH framework][omz]. It has
+similar design philosophies and functionality, but different goals.
+Where Oh My ZSH is meant for new users to get more acclamated with ZSH,
+DOTS is meant for the slightly more advanced user who wants the built-in
+functionality of Oh My ZSH but wants a bit more additional
+customization. It also includes some extra tools that help with day-to-day
+shell management tasks.
 
 Features
 --------
@@ -9,19 +17,26 @@ Features
 - Modular plugin architecture inspired by [Oh My ZSH][omz], but using Antigen for greater efficiency.
   Only code that's specific to your repo needs to be in your repo.
 - Simplified prompt string themeing in the `lib/dots/prompt.zsh` directory.
-- Configuration persistence via the `persist` command. This copies your dot-files to the **config/** 
-  directory and allows you to optionally store them in Git. Add your persisted configs to your fork's 
-  `.gitignore` if you don't want them synchronized, and `forget` them when you don't want them symlinked 
-  anymore. Keeping your configuration files in a place that's easily accessible with a text editor helps you 
-  keep an eye on your configuration.
+- Configuration persistence via the `persist` command. This copies your
+  dot-files to the **config/** directory and allows you to optionally
+  store them in Git. Add your persisted configs to your fork's
+  `.gitignore` if you don't want them synchronized, and `forget`
+  them when you don't want them symlinked anymore. Keeping your
+  configuration files in a place that's easily accessible with a
+  text editor helps you keep an eye on your configuration.
 - Aliases for common shell functionality like searching for a running
   process, opening your text editor, viewing files with a pager, setting
   the title of the current iTerm tab, [optimizing your OS X environment](osx4h),
   and much more.
+- Environment boostrapping, installs a global gemset and a series of
+  programs through Homebrew (as well as Homebrew itself) that aid in
+  your day-to-day programming tasks.
 
 Installation
 ------------
 
+Unlike Oh My ZSH, DOTS is installed as a gem. 
+
 Just run the following commands:
 
 ```bash
@@ -81,6 +96,13 @@ sensible defaults, for example `o` will open the current directory, but
 `o ~/Code` will open up ~/Code in the Finder. `e` follows suit, but `v`
 throws an error as this should almost never be the case. 
 
+### dots
+
+The DOTS binary is another useful tool in your shell adventures. Invoke
+`dots help` to check out what it does. This binary is most useful for
+updating the DOTS framework from source and bootstrapping the environment
+on new installs.
+
 Hidden Configuration
 --------------------
 
@@ -93,34 +115,52 @@ application's dotfile, insert the following line to load configuration
 from your untracked file:
 
 ```bash
-. $DOTS/config/file.zsh
+hidden_config_for 'file'
 ```
 
-Forking
--------
-
-It's recommended that you fork this project so you can store your own custom settings in **config/**, and get the most use out of this framework.
-
-To do so, click the **Fork** button at the top of this page.
-
-Then, type the following into your Terminal:
-
-    git remote add <your-github-username> git@github.com:<your-github-username>/dots.git
-
-And to make sure it works, type
-
-    git pull <your-github-username> master
-
-We like the follow the convention for fork names set forth in [the hub plugin][hub] by [Chris Wernstrath][cw]. You can feasibly name the fork anything you like.
+This will run the following shell command:
 
-You can either modify **tools/upgrade.sh** to `git pull` from your fork and `git push` to your fork after the upgrade is complete to keep it in sync, or do it manually by setting `DISABLE_AUTO_UPDATE="true"` (which is disabled by default in **config/zshrc**).
-
-Usage
------
-
-Edit `lib/dots/prompt.zsh` to change your prompt string.
+```bash
+$ source $DOTS/config/$1.zsh
+```
 
-Type `persist .vimrc` or `forget .vimrc` to either add or remove your configs to the .dots/ directory, wherein they can then be pushed to your GitHub fork.
+where `$1` is the first argument given to the function.
+
+Environment Bootstrapping
+-------------------------
+
+DOTS installs a number of programs for you:
+
+- **HTTPie** for querying HTTP, and displaying the results in a colorful
+  format.
+- **Vim** for text editing. It fits into the DOTS philosophy very nicely
+  of having each program do one thing really well.
+- The latest version of the **Ruby** programming language. We believe
+  that you should keep your tools up to date, and Homebrew has been
+  very reliable in maintaining the latest version of Ruby, as Homebrew
+  is itself a Ruby project. It's also a great shell scripting language,
+  among other things...
+- **Ruby on Rails**. I'm a Rails developer, so having Rails in the
+  global Gemfile is a must. If this offends you, you may kindly remove
+  the gem as it isn't really necessary for your use. However, this
+  framework is bundled with a number of aliases/plugins for use in Rails
+  projects, so I felt like including Rails makes the whole thing
+  "complete".
+- **AWS Developer Tools** for interfacing with Amazon Web Services. I
+  use AWS to host all of my projects, both at work and at home, and
+  these tools make it very easy to get statistics on your instances
+  quickly.
+- **Git** is my favorite distributed version control system, and I use
+  it on all of my projects, both private and public. DOTS also installs
+  a number of plugins for Git that I find useful: **git_tracker** for
+  automatically including a Pivotal Tracker issue number in commits
+  when your branch follows a specific naming convention, **git-process**
+  for managing a strict feature branch-based workflow, and **hub** for
+  easy interfacing with Github (allowing you to clone with a simple
+  short Github URL: `git clone tubbo/dots`, make pull requests and edit
+  them in Vim, define issues, and fork projects). With the exception of
+  **hub** all of these gems are completely optional, and must be
+  installed explicitly in each new project (as they add Git hooks).
 
 License
 -------
@@ -129,19 +169,33 @@ DOTS is released under **The MIT License**:
 
     Copyright (c) 2012 Tom Scott
 
-    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-Contributors
+    Permission is hereby granted, free of charge, to any person 
+    obtaining a copy of this software and associated documentation files
+    (the "Software"), to deal in the Software without restriction,
+    including without limitation the rights to use, copy, modify, merge,
+    publish, distribute, sublicense, and/or sell copies of the Software,
+    and to permit persons to whom the Software is furnished to do so,
+    subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+    BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+    ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+    CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Contributing
 ------------
 
-Just me, [@tubbo][twt]
+To contribute to the project, fork it and send me a pull request!
+
+I accept either traditional email pulls or Github pull requests.
 
 [omz]: https://github.com/robbyrussell/oh-my-zsh
-[twt]: https://twitter.com/tubbo
 [hub]: https://github.com/defunkt/hub
 [cw]: https://defunkt.io
 [osx4h]: https://gist.github.com/2260182

data/config/vimrc

@@ -59,7 +59,8 @@ let mapleader = ","   " Set leader key to something easier to access
 "" Whitespace
 ""
 
-set nowrap                        " don't wrap lines
+set wrap                          " turn word wrap on
+set textwidth=72                  " attempt to enforce 72 chars
 set tabstop=2                     " a tab is two spaces
 set shiftwidth=2                  " an autoindent (with <<) is two spaces
 set expandtab                     " use spaces, not tabs
@@ -164,17 +165,16 @@ augroup vimrcEx
   " Clear all autocmds in the group
   autocmd!
 
-  " Whenever we're writing text, like comments, make the width mo more
-  " than 72 characters. This is to ensure maximum readability of
-  " documentation with things like CTags.
-  autocmd FileType text setlocal textwidth=72
-
   " Jump to last cursor position unless it's invalid or in an event handler
   autocmd BufReadPost *
     \ if line("'\"") > 0 && line("'\"") <= line("$") |
     \   exe "normal g`\"" |
     \ endif
 
+  " On the contrary, Haml and HTML files can be uber-long sometimes,
+  " so we will ignore wrapping in Haml.
+  autocmd FileType haml,html setlocal nowrap
+
   " In Ruby, autoindent with two spaces, always expand tabs
   autocmd FileType coffee,ruby,haml,eruby,yaml,html,javascript,sass,cucumber set ai sw=2 sts=2 et
 
@@ -192,12 +192,6 @@ augroup vimrcEx
   " Standard two-space indentation in CoffeeScript files
   au BufNewFile,BufReadPost *.coffee setl shiftwidth=2 expandtab
 
-  " Indent <p> tags inherently
-  "autocmd FileType html,eruby if g:html_indent_tags !~ '\\|p\>' | let g:html_indent_tags .= '\|p\|li\|dt\|dd' | endif
-
-  " Open the README file in a project dir (if there is one)
-  "autocmd AuNERDTreeCmd VimEnter * call OpenReadme()
-
   " Strip whitespace in Python
   autocmd BufWritePre *.py :%s/\s\+$//e
 augroup END

data/lib/dots/functions.zsh

@@ -66,10 +66,6 @@ function tmbundle() {
   osascript -e 'tell app \"TextMate\" to reload bundles'
 }
 
-function update_dots() {
-  dots update > /dev/null
-}
-
 # Reload DOTS after a change.
 function reload_dots() {
   source $HOME/.zshenv
@@ -88,3 +84,9 @@ function rhombus() {
   find . -type f -name '._*' -exec rm {} +
   echo "Removed all ._ files"
 }
+
+# Source a hidden configuration file, usually with the same name as
+# the file it's in, but we set it here explicitly.
+function hidden_config_for() {
+  source "$DOTS/config/$1.zsh"
+}

data/lib/ruby/dots/bootstrap.rb

@@ -3,7 +3,8 @@ module Dots
     include Thor::Actions
 
     # These are the programs we are going to download from Homebrew.
-    PROGRAMS = %w(httpie git ruby)
+    PROGRAMS = %w(git ruby python vim pip hub)
+    PACKAGES = %w(httpie aws)
 
     # Install C binaries, Python programs, and other useful tools
     # from Homebrew.
@@ -15,8 +16,9 @@ module Dots
 
         system "brew install #{programs_to_install}" \
           unless programs_to_install.empty?
+        install_packages
       else
-        install_homebrew
+        install_homebrew and install_programs
       end
     end
 
@@ -26,6 +28,11 @@ module Dots
       system "cd #{Dots::HOME} && #{bundle_install}"
     end
 
+    # Install Python packages from pip. Pip!
+    def install_packages
+      system "pip install #{PACKAGES.join(' ')}"
+    end
+
   private
     def installed? command
       `which #{command}` != ""

data/lib/ruby/dots/command.rb

@@ -9,7 +9,7 @@ module Dots
 
     desc :usage, "Show usage information"
     def usage
-      say Dots::USAGE_INFORMATION and help
+      say Dots.usage_information and help
     end
 
     desc :install, "Copies DOTS to your home directory."
@@ -24,7 +24,7 @@ module Dots
 
     desc :version, "Show the current version of DOTS"
     def version
-      say "DOTS version #{Dots::VERSION} - http://tubbo.github.com/dots"
+      say dots_version
     end
 
     desc :link, "Symlink your ~/.dots/config into dotfiles"

data/lib/ruby/dots/version.rb

@@ -1,3 +1,3 @@
 module Dots
-  VERSION = "0.5.4"
+  VERSION = "0.5.5"
 end

data/lib/ruby/dots.rb

@@ -22,18 +22,19 @@ module Dots
     @home_dir ||= File.expand_path "~/.dots"
   end
 
-  # Usage information for the DOTS command line tool.
-  USAGE_INFORMATION = <<-TEXT
+  def self.usage_information
+    path = "#{Dots.root}/lib/ruby/templates/usage.txt.erb"
+    template = ERB.new File.read(path)
 
-  The DOTS Project
-
-  DOTS is a ZSH Framework for managing your dotfiles and other shell configuration.
-  It also gives you some nice, sensible defaults and time-saver aliases to better
-  work with and understand your shell environment.
-
-  The following tasks are meant to help you use the shell more efficiently...
+    template.result(binding)
+  end
 
-  TEXT
+  def self.dots_version
+    "DOTS version #{Dots::VERSION} - http://github.com/tubbo/dots"
+  end
 
+  def dots_version
+    self.dots_version
+  end
 end
 

data/lib/ruby/templates/usage.txt.erb

@@ -0,0 +1,7 @@
+
+<%= dots_version %>
+
+  DOTS is a ZSH Framework for managing your dotfiles and other shell configuration.
+  It also gives you some nice, sensible defaults and time-saver aliases to better
+  work with and understand your shell environment.
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zsh_dots
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.5.5
   prerelease: 
 platform: ruby
 authors:
@@ -142,6 +142,7 @@ files:
 - lib/ruby/dots/installer.rb
 - lib/ruby/dots/persistence.rb
 - lib/ruby/dots/version.rb
+- lib/ruby/templates/usage.txt.erb
 - lib/tasks/.gitkeep
 - spec/integration/command_spec.rb
 - spec/models/dot_file_spec.rb