boom 0.0.5 → 0.0.6

data/CHANGELOG.markdown

@@ -2,6 +2,13 @@
 
 ## head
 
+## 0.0.6
+- Searching for an item that doesn't exist doesn't murder puppies anymore
+  (thanks [jimmycuadra](https://github.com/jimmycuadra)).
+- Output is a bit cleaner with a constrained `name` column.
+- Adds items from stdin (thanks
+  [MichaelXavier](https://github.com/MichaelXavier)). 
+
 ## 0.0.5
 - Item deletes are now scoped by list rather than GLOBAL DESTRUCTION! (thanks
   [natebean](https://github.com/natebean)).

data/README.markdown

@@ -45,6 +45,9 @@ can have multiple lists.
     $ boom urls github https://github.com
     Boom! "github" in "urls" is "https://github.com". Got it.
 
+    # boom <list> <name> with stdin
+    $ boom journal january < ~/Desktop/01-secret-journal.markdown
+
 ** Copy an item's value to your clipboard **
 
     $ boom github
@@ -110,14 +113,18 @@ important business information (say, a carefully cultivated list of animated
 .gifs), you'd be sitting pretty if you made a backup of `~/.boom` every now and
 then, just in case. We're living on the edge, baby.
 
-Also, don't mistype anything. Everything should be 100% perfect if you type all
-the commands correctly. If you don't, it'll probably ungracefully error out and
-a puppy in Kansas will probably be murdered. You should be fine, though. As
-long as you don't have butter fingers.
-
 Soon enough, though, this'll be stable to the point where I can truthfully tell
 myself that this time baby, `boom` will be, bulletttttttttttttproof ♫.
 
+## Contribute
+
+I'd love to include your contributions, friend. Make sure your methods are
+[TomDoc](http://tomdoc.org)'d properly, that existing tests pass (`rake`), and
+that any new functionality includes appropriate tests. Bonus points if you're
+not updating the gemspec or bumping boom's version.
+
+All good? Cool! Then [send me a pull request](https://github.com/holman/boom/pull/new/master)!
+
 ## I love you
 
 [Zach Holman](http://zachholman.com) made this. Ping me on Twitter —

data/boom.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'boom'
-  s.version           = '0.0.5'
-  s.date              = '2010-12-22'
+  s.version           = '0.0.6'
+  s.date              = '2011-01-05'
   s.rubyforge_project = 'boom'
 
   ## Make sure your summary is short. The description may be as long
@@ -50,7 +50,7 @@ Gem::Specification.new do |s|
   ## Specify any RDoc options here. You'll want to add your README and
   ## LICENSE files to the extra_rdoc_files list.
   s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = %w[readme.markdown license.markdown]
+  s.extra_rdoc_files = %w[README.markdown LICENSE.markdown]
 
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.

data/lib/boom/clipboard.rb

@@ -17,7 +17,7 @@ module Boom
             "xclip -selection clipboard"
           end
 
-        `echo '#{item.value}' | tr -d "\n" | #{copy_command}`
+        `echo '#{item.value.gsub("\'","\\'")}' | tr -d "\n" | #{copy_command}`
 
         "Boom! We just copied #{item.value} to your clipboard."
       end

data/lib/boom/command.rb

@@ -58,7 +58,7 @@ module Boom
         storage.lists.each do |list|
           output "  #{list.name}"
           list.items.each do |item|
-            output "    #{item.name}: #{item.value}"
+            output "    #{item.short_name}:#{item.spacer} #{item.value}"
           end
         end
       end
@@ -77,7 +77,8 @@ module Boom
           return delete_list(command) if major == 'delete'
           return detail_list(command) unless major
           unless minor == 'delete'
-            return add_item(command,major,minor) if minor
+            minor ||= $stdin.read
+            return add_item(command,major,minor) if minor.to_s.length > 0
             return search_list_for_item(command, major)
           end
         end
@@ -99,7 +100,7 @@ module Boom
       def detail_list(name)
         list = List.find(name)
         list.items.sort{ |x,y| x.name <=> y.name }.each do |item|
-          output "    #{item.name}: #{item.value}"
+          output "    #{item.short_name}:#{item.spacer} #{item.value}"
         end
       end
 
@@ -189,17 +190,21 @@ module Boom
       end
 
       # Public: search for an Item in a particular list by name. Drops the 
-      # corresponding entry into your clipboard.
+      # corresponding entry into your clipboard if found.
       #
       # list_name - the String name of the List in which to scope the search
       # item_name - the String term to search for in all Item names
       #
-      # Returns the matching Item.
+      # Returns the matching Item if found.
       def search_list_for_item(list_name, item_name)
         list = List.find(list_name)
-        item = list.items.first { |item| item.name == item_name }
+        item = list.find_item(item_name)
 
-        output Clipboard.copy(item)
+        if item
+          output Clipboard.copy(item)
+        else
+          output "\"#{item_name}\" not found in \"#{list_name}\""
+        end
       end
 
       # Public: save in-memory data to disk.

data/lib/boom/item.rb

@@ -18,7 +18,7 @@ module Boom
     #
     # Examples
     #
-    #   Item.new("github", "http://github.com")
+    #   Item.new("github", "https://github.com")
     #
     # Returns the newly initialized Item.
     def initialize(name,value)
@@ -26,6 +26,31 @@ module Boom
       @value = value
     end
 
+    # Public: the shortened String name of the Item. Truncates with ellipses if
+    # larger.
+    #
+    # Examples
+    #
+    #   item = Item.new("github's home page","https://github.com")
+    #   item.short_name
+    #   # => 'github's home p…'
+    #
+    #   item = Item.new("github","https://github.com")
+    #   item.short_name
+    #   # => 'github'
+    #
+    # Returns the shortened name.
+    def short_name
+      name.length > 15 ? "#{name[0..14]}…" : name[0..14]
+    end
+
+    # Public: the amount of consistent spaces to pad based on Item#short_name.
+    #
+    # Returns a String of spaces.
+    def spacer
+      name.length > 15 ? '' : ' '*(15-name.length+1)
+    end
+
     # Public: creates a Hash for this Item.
     #
     # Returns a Hash of its data.

data/lib/boom/list.rb

@@ -72,6 +72,19 @@ module Boom
       previous != items.size
     end
 
+    # Public: finds an Item by name. If the name is typically truncated, also
+    # allow a search based on that truncated name.
+    #
+    # name - String name of the Item to find
+    #
+    # Returns the found item
+    def find_item(name)
+      items.find do |item|
+        item.name == name ||
+        item.short_name.gsub('…','') == name.gsub('…','')
+      end
+    end
+
     # Public: a Hash representation of this List.
     #
     # Returns a Hash of its own data and its child Items.

data/lib/boom.rb

@@ -15,7 +15,7 @@ require 'boom/list'
 require 'boom/storage'
 
 module Boom
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 
   def self.storage
     @storage ||= Boom::Storage.new

data/test/test_command.rb

@@ -96,4 +96,8 @@ class TestCommand < Test::Unit::TestCase
     assert_match 'boom help', command('--anything')
     assert_match 'boom help', command('-d')
   end
+
+  def test_nonexistent_item_access_scoped_by_list
+    assert_match /"twitter" not found in "urls"/, command('urls twitter')
+  end
 end

data/test/test_item.rb

@@ -14,6 +14,24 @@ class TestItem < Test::Unit::TestCase
     assert_equal 'https://github.com', @item.value
   end
 
+  def test_short_name
+    assert_equal 'github', @item.short_name
+  end
+
+  def test_short_name
+    @item.name = 'github github github lol lol lol'
+    assert_equal 'github github g…', @item.short_name
+  end
+
+  def test_spacer_none
+    @item.name = 'github github github lol lol lol'
+    assert_equal '', @item.spacer
+  end
+
+  def test_spacer_tons
+    assert_equal '          ', @item.spacer
+  end
+
   def test_to_hash
     assert_equal 1, @item.to_hash.size
   end

data/test/test_list.rb

@@ -28,6 +28,18 @@ class TestList < Test::Unit::TestCase
     assert_equal 'urls', Boom::List.find('urls').name
   end
 
+  def test_find_item
+    @list.add_item(@item)
+    assert_equal 'https://github.com', @list.find_item('github').value
+  end
+
+  def test_find_item_long_name
+    @item = Boom::Item.new('long-long-long-name','longname')
+    @list.add_item(@item)
+    assert_equal 'longname', @list.find_item('long-long-long-').value
+    assert_equal 'longname', @list.find_item('long-long-long-…').value
+  end
+
   def test_delete_success
     assert_equal 1, Boom.storage.lists.size
     assert Boom::List.delete('urls')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: boom
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Zach Holman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-22 00:00:00 -06:00
+date: 2011-01-05 00:00:00 -08:00
 default_executable: boom
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,8 +64,8 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- readme.markdown
-- license.markdown
+- README.markdown
+- LICENSE.markdown
 files: 
 - CHANGELOG.markdown
 - LICENSE.markdown
@@ -84,8 +84,6 @@ files:
 - test/test_command.rb
 - test/test_item.rb
 - test/test_list.rb
-- readme.markdown
-- license.markdown
 has_rdoc: true
 homepage: https://github.com/holman/boom
 licenses: []

data/license.markdown

@@ -1,21 +0,0 @@
-The MIT License
-
-Copyright (c) Zach Holman, http://zachholman.com
-
-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.

data/readme.markdown

@@ -1,127 +0,0 @@
-# B O O M
-
-See? Look, a tiny explosion: \*
-
-## What's a boom?
-
-boom lets you access text snippets over your command line. I'm personally
-aiming for exactly two use cases, but I'm almost positive there are thirteen
-more. Here's a couple examples:
-
-- **Your own [del.icio.us](http://delicious.com)-esque URL tracker.** When I
-  make [clever animated
-  gifs](http://github.com/holman/dotfiles/blob/master/bin/gifme) of my
-  coworkers, I tend to lose the URL, which is a total bummer since I want to
-  repeatedly repost these images well past their funny expiration date. boom
-  lets me easily access the good stuff for years to come.
-- **Commonly-used email replies.** Everyone's got those stock replies in their
-  pocket for a few common use cases. Rather than keep some files strewn about
-  with the responses, boom gives me them on my ever-present command line.
-- **Simple todos.** You can super-quickly drop items into lists and remove them
-  when finished. I'm a big fan of simple, straightforward stuff. Plus, it's a
-  Dropbox away from simple cloud syncing. Someone get Cultured Code on the line
-  THIS MAY BE RELEVANT TO THEIR INTERESTS!
-
-We store everything in one JSON file in your home directory: `~/.boom`. The
-structure is simple, too. Each individual item is tossed on a `list`, and you
-can have multiple lists.
-
-## Show me the boom
-
-** Overview **
-
-    $ boom
-    gifs (5)
-    email (4)
-
-** Create a list **
-
-    $ boom urls
-    Boom! Created a new list called "urls".
-
-** Add an item **
-
-    # boom <list> <name> <value>
-    $ boom urls github https://github.com
-    Boom! "github" in "urls" is "https://github.com". Got it.
-
-** Copy an item's value to your clipboard **
-
-    $ boom github
-    Boom! Just copied https://github.com to your clipboard.
-
-    $ boom urls github
-    Boom! Just copied https://github.com to your clipboard.
-
-** List items in a list **
-
-    $ boom urls
-    blog   http://zachholman.com
-    github http://github.com
-
-** Delete a list **
-
-    $ boom urls delete
-    You sure you want to delete everything in "urls"? (y/n): y
-    Boom! Deleted all your urls.
-
-** Delete an item **
-
-    # boom urls github delete
-    Boom! "github" is gone forever.
-
-** List everything **
-
-    $ boom all
-      enemies
-        @kneath:          he's got dreamy eyes. he must die.
-        @rtomayko:        i must murder him for his mac and cheese recipe.
-        @luckiestmonkey:  she hates recycling.
-      urls
-        blog:   http://zachholman.com
-        github: https://github.com
-
-** Help **
-
-    $ boom help
-
-** Manual edit **
-
-If you want to edit the underlying JSON directly, make sure your `$EDITOR`
-environment variable is set, and run:
-
-    $ boom edit
-
-** It's just the command line, silly **
-
-So don't forget all your other favorites are there to help you, too:
-
-    $ boom all | grep @luckiestmonkey
-        @luckiestmonkey:  she hates recycling.
-
-## Install
-
-    gem install boom
-
-## Current Status
-
-Precarious. I'm starting to use this a bunch now, but if you're tossing in
-important business information (say, a carefully cultivated list of animated
-.gifs), you'd be sitting pretty if you made a backup of `~/.boom` every now and
-then, just in case. We're living on the edge, baby.
-
-Also, don't mistype anything. Everything should be 100% perfect if you type all
-the commands correctly. If you don't, it'll probably ungracefully error out and
-a puppy in Kansas will probably be murdered. You should be fine, though. As
-long as you don't have butter fingers.
-
-Soon enough, though, this'll be stable to the point where I can truthfully tell
-myself that this time baby, `boom` will be, bulletttttttttttttproof ♫.
-
-## I love you
-
-[Zach Holman](http://zachholman.com) made this. Ping me on Twitter —
-[@holman](http://twitter.com/holman) — if you're having issues, want me to
-merge in your pull request, or are using boom in a cool way. I'm kind of hoping
-this is generic enough that people do some fun things with it. First one to use
-`boom` to calculate their tax liability wins.