boom 0.2.0 → 0.2.1

data/CHANGELOG.markdown

@@ -2,7 +2,16 @@
 
 ## head
 
-## 0.2.0
+## 0.2.1 (July 16, 2011)
+- boom displays colors thanks to [@dandorman](https://github.com/dandorman).
+- Windows support, brah. [@tombell](https://github.com/tombell).
+- boom accepts piped-in data (like `cat admins.txt | boom groups admins`).
+  Thanks [@brettbuddin](https://github.com/brettbuddin) and
+  [@antonlindstrom](https://github.com/antonlindstrom). Tag-team action.
+- `boom <newlist> <item> <value>` will actually create the list and item now.
+  [@jmazzi](https://github.com/jmazzi).
+
+## 0.2.0 (April 12, 2011)
 - Add Keychain storage to store Boom data securely in OS X's Keychain.app.
   Thanks, [@davidtrogers](https://github.com/davidtrogers)!
 - Switch from yajl-ruby because [OS X isn't for

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    boom (0.1.2)
+    boom (0.2.0)
       json_pure (~> 1.5.1)
 
 GEM

data/README.markdown

@@ -30,7 +30,9 @@ commands](https://github.com/holman/boom/wiki/Commands).
 
 ## Contribute
 
-I'd love to include your contributions, friend.
+Want to join the [Pantheon of
+Boom'ers](https://github.com/holman/boom/contributors)? I'd love to include
+your contributions, friend.
 
 Clone this repository, then run `bundle install`. That'll install all the gem
 dependencies. Make sure your methods are [TomDoc](http://tomdoc.org)'d

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.2.0'
-  s.date              = '2011-04-11'
+  s.version           = '0.2.1'
+  s.date              = '2011-07-16'
   s.rubyforge_project = 'boom'
 
   ## Make sure your summary is short. The description may be as long
@@ -77,6 +77,7 @@ Gem::Specification.new do |s|
     completion/boom.bash
     completion/boom.zsh
     lib/boom.rb
+    lib/boom/color.rb
     lib/boom/command.rb
     lib/boom/config.rb
     lib/boom/core_ext/symbol.rb
@@ -93,10 +94,12 @@ Gem::Specification.new do |s|
     test/examples/test_json.json
     test/examples/urls.json
     test/helper.rb
+    test/test_color.rb
     test/test_command.rb
     test/test_config.rb
     test/test_item.rb
     test/test_list.rb
+    test/test_platform.rb
   ]
   # = MANIFEST =
 

data/lib/boom/color.rb

@@ -0,0 +1,46 @@
+module Boom
+  # Color collects some methods for colorizing terminal output.
+  module Color
+    extend self
+
+    CODES = {
+      :reset   => "\e[0m",
+
+      :cyan    => "\e[36m",
+      :magenta => "\e[35m",
+      :red     => "\e[31m",
+      :yellow  => "\e[33m"
+    }
+
+    # Tries to enable Windows support if on that platform.
+    #
+    # Returns nothing.
+    def self.included(other)
+      if RUBY_PLATFORM =~ /win32/ || RUBY_PLATFORM =~ /mingw32/
+        require 'Win32/Console/ANSI'
+      end
+    rescue LoadError
+      # Oh well, we tried.
+    end
+
+    # Wraps the given string in ANSI color codes
+    #
+    # string     - The String to wrap.
+    # color_code - The String representing he ANSI color code
+    #
+    # Examples
+    #
+    #   colorize("Boom!", :magenta)
+    #   # => "\e[35mBoom!\e[0m"
+    #
+    # Returns the wrapped String.
+    def colorize(string, color_code)
+      "#{CODES[color_code] || color_code}#{string}#{CODES[:reset]}"
+    end
+
+    # Set up shortcut methods to all the codes define in CODES.
+    self.class_eval(CODES.keys.reject {|color| color == :reset }.map do |color|
+      "def #{color}(string); colorize(string, :#{color}); end"
+    end.join("\n"))
+  end
+end

data/lib/boom/command.rb

@@ -11,6 +11,7 @@
 module Boom
   class Command
     class << self
+      include Boom::Color
 
       # Public: accesses the in-memory JSON representation.
       #
@@ -42,6 +43,14 @@ module Boom
         puts(s)
       end
 
+      # Public: gets $stdin.
+      #
+      # Returns the $stdin object. This method exists to help with easy mocking
+      # or overriding.
+      def stdin
+        $stdin
+      end
+
       # Public: prints a tidy overview of your Lists in descending order of
       # number of Items.
       #
@@ -93,6 +102,7 @@ module Boom
           return detail_list(command) unless major
           unless minor == 'delete'
             return add_item(command,major,minor) if minor
+            return add_item(command,major,stdin.read) if stdin.stat.size > 0
             return search_list_for_item(command, major)
           end
         end
@@ -103,7 +113,7 @@ module Boom
           return delete_item(command, major)
         end
 
-        return create_list(command)
+        return create_list(command, major, minor)
       end
 
       # Public: shows the current user's storage.
@@ -144,10 +154,10 @@ module Boom
         if storage.list_exists?(major)
           list = List.find(major)
           list.items.each { |item| Platform.open(item) }
-          output "Boom! We just opened all of \"#{major}\" for you."
+          output "#{cyan("Boom!")} We just opened all of #{yellow(major)} for you."
         else
           item = storage.items.detect { |item| item.name == major }
-          output Platform.open(item)
+          output "#{cyan("Boom!")} We just opened #{yellow(Platform.open(item))} for you."
         end
       end
       
@@ -161,29 +171,33 @@ module Boom
           item = storage.items.detect do |item|
             item.name == major
           end
-          return output "\"#{major}\" not found" unless item
+          return output "#{yellow(major)} #{red("not found")}" unless item
         else
           list = List.find(major)
           item = list.find_item(minor)
-          return output "\"#{minor}\" not found in \"#{major}\"" unless item
+          return output "#{yellow(minor)} #{red("not found in")} #{yellow(major)}" unless item
         end
         output item.value
       end
 
       # Public: add a new List.
       #
-      # name - the String name of the List.
+      # name  - the String name of the List.
+      # item  - the String name of the Item
+      # value - the String value of Item
       #
       # Example
       #
       #   Commands.list_create("snippets")
+      #   Commands.list_create("hotness", "item", "value")
       #
-      # Returns the newly created List.
-      def create_list(name)
+      # Returns the newly created List and creates an item when asked.
+      def create_list(name, item = nil, value = nil)
         lists = (storage.lists << List.new(name))
         storage.lists = lists
-        output "Boom! Created a new list called \"#{name}\"."
+        output "#{cyan("Boom!")} Created a new list called #{yellow(name)}."
         save
+        add_item(name, item, value) unless value.nil?
       end
 
       # Public: remove a named List.
@@ -196,10 +210,10 @@ module Boom
       #
       # Returns nothing.
       def delete_list(name)
-        output "You sure you want to delete everything in \"#{name}\"? (y/n):"
+        output "You sure you want to delete everything in #{yellow(name)}? (y/n):"
         if $stdin.gets.chomp == 'y'
           List.delete(name)
-          output "Boom! Deleted all your #{name}."
+          output "#{cyan("Boom!")} Deleted all your #{yellow(name)}."
           save
         else
           output "Just kidding then."
@@ -220,7 +234,7 @@ module Boom
       def add_item(list,name,value)
         list = List.find(list)
         list.add_item(Item.new(name,value))
-        output "Boom! \"#{name}\" in \"#{list.name}\" is \"#{value}\". Got it."
+        output "#{cyan("Boom!")} #{yellow(name)} in #{yellow(list.name)} is #{yellow(value)}. Got it."
         save
       end
 
@@ -237,7 +251,7 @@ module Boom
       def delete_item(list_name,name)
         list = List.find(list_name)
         list.delete_item(name)
-        output "Boom! \"#{name}\" is gone forever."
+        output "#{cyan("Boom!")} #{yellow(name)} is gone forever."
         save
       end
 
@@ -252,7 +266,7 @@ module Boom
           item.name == name
         end
 
-        output Platform.copy(item)
+        output "#{cyan("Boom!")} We just copied #{yellow(Platform.copy(item))} to your clipboard."
       end
 
       # Public: search for an Item in a particular list by name. Drops the 
@@ -267,9 +281,9 @@ module Boom
         item = list.find_item(item_name)
 
         if item
-          output Platform.copy(item)
+          output "#{cyan("Boom!")} We just copied #{yellow(Platform.copy(item))} to your clipboard."
         else
-          output "\"#{item_name}\" not found in \"#{list_name}\""
+          output "#{yellow(item_name)} #{red("not found in")} #{yellow(list_name)}"
         end
       end
 
@@ -287,13 +301,11 @@ module Boom
         output "You're running boom #{Boom::VERSION}. Congratulations!"
       end
 
-      # Public: launches JSON file in an editor for you to edit manually. Uses
-      # the $EDITOR environment variable for editing.
+      # Public: launches JSON file in an editor for you to edit manually.
       #
       # Returns nothing.
       def edit
-        system "`echo $EDITOR` #{storage.json_file} &"
-        output "Boom! Make your edits, and do be sure to save."
+        output "#{cyan("Boom!")} #{Platform.edit(storage.json_file)}"
       end
 
       # Public: prints all the commands of boom.

data/lib/boom/platform.rb

@@ -10,7 +10,6 @@
 module Boom
   class Platform
     class << self
-
       # Public: tests if currently running on darwin.
       #
       # Returns true if running on darwin (MacOS X), else false
@@ -18,6 +17,15 @@ module Boom
         !!(RUBY_PLATFORM =~ /darwin/)
       end
 
+      # Public: tests if currently running on windows.
+      #
+      # Apparently Windows RUBY_PLATFORM can be 'win32' or 'mingw32'
+      #
+      # Returns true if running on windows (win32/mingw32), else false
+      def windows?
+        !!(RUBY_PLATFORM =~ /win|mingw/)
+      end
+
       # Public: returns the command used to open a file or URL
       # for the current platform.
       #
@@ -25,29 +33,70 @@ module Boom
       #
       # Returns a String with the bin
       def open_command
-        darwin? ? 'open' : 'xdg-open'
+        if darwin?
+          'open'
+        elsif windows? 
+          'start'
+        else
+          'xdg-open'
+        end
       end
 
       # Public: opens a given Item's value in the browser. This
       # method is designed to handle multiple platforms.
       #
-      # Returns a String explaining what was done
+      # Returns a String of the Item value.
       def open(item)
-        `#{open_command} '#{item.url.gsub("\'","\\'")}'`
+        unless windows?
+          system("#{open_command} '#{item.url.gsub("\'","\\'")}'")
+        else
+          system("#{open_command} #{item.url.gsub("\'","\\'")}")
+        end
 
-        "Boom! We just opened #{item.value} for you."
+        item.value
       end
 
+      # Public: returns the command used to copy a given Item's value to the
+      # clipboard for the current platform.
+      #
+      # Returns a String with the bin
+      def copy_command
+        if darwin?
+          'pbcopy'
+        elsif windows?
+          'clip'
+        else
+          'xclip -selection clipboard'
+        end
+      end
+      
       # Public: copies a given Item's value to the clipboard. This method is
       # designed to handle multiple platforms.
       #
-      # Returns a String explaining what was done
+      # Returns the String value of the Item.
       def copy(item)
-        copy_command = darwin? ? "pbcopy" : "xclip -selection clipboard"
+        unless windows?
+          system("printf '#{item.value.gsub("\'","\\'")}' | #{copy_command}")
+        else
+          system("echo #{item.value.gsub("\'","\\'")} | #{copy_command}")
+        end
 
-        Kernel.system("echo '#{item.value.gsub("\'","\\'")}' | tr -d \"\n\" | #{copy_command}")
+        item.value
+      end
+
+      # Public: opens the JSON file in an editor for you to edit. Uses the
+      # $EDITOR environment variable, or %EDITOR% on Windows for editing.
+      # This method is designed to handle multiple platforms.
+      #
+      # Returns a String with a helpful message.
+      def edit(json_file)
+        unless windows?
+          system("`echo $EDITOR` #{json_file} &")
+        else
+          system("start %EDITOR% #{json_file}")
+        end
 
-        "Boom! We just copied #{item.value} to your clipboard."
+        "Make your edits, and do be sure to save."
       end
     end
   end

data/lib/boom.rb

@@ -10,6 +10,7 @@ require 'json/pure'
 
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
+require 'boom/color'
 require 'boom/platform'
 require 'boom/command'
 require 'boom/config'
@@ -26,7 +27,7 @@ require 'boom/storage/keychain'
 require 'boom/core_ext/symbol'
 
 module Boom
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 
   extend self
 

data/test/test_color.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+
+require 'helper'
+
+class TestColor < Test::Unit::TestCase
+
+  def test_colorize
+    assert_equal "\e[35mBoom!\e[0m",
+      Boom::Color.colorize("Boom!", :magenta)
+  end
+
+  def test_magenta
+    assert_equal "\e[35mMagenta!\e[0m",
+      Boom::Color.magenta("Magenta!")
+  end
+
+  def test_red
+    assert_equal "\e[31mRed!\e[0m",
+      Boom::Color.red("Red!")
+  end
+
+  def test_yellow
+    assert_equal "\e[33mYellow!\e[0m",
+      Boom::Color.yellow("Yellow!")
+  end
+end

data/test/test_command.rb

@@ -33,7 +33,8 @@ class TestCommand < Test::Unit::TestCase
     cmd = cmd.split(' ') if cmd
     Boom::Command.capture_output
     Boom::Command.execute(*cmd)
-    Boom::Command.captured_output
+    output = Boom::Command.captured_output
+    output.gsub(/\e\[\d\d?m/, '')
   end
 
   def test_overview_for_empty
@@ -58,7 +59,11 @@ class TestCommand < Test::Unit::TestCase
   end
 
   def test_list_creation
-    assert_match /a new list called "newlist"/, command('newlist')
+    assert_match /a new list called newlist/, command('newlist')
+  end
+
+  def test_list_creation_with_item
+    assert_match /a new list called newlist.* item in newlist/, command('newlist item blah')
   end
 
   def test_item_access
@@ -72,24 +77,22 @@ class TestCommand < Test::Unit::TestCase
   end
   
   def test_item_open_url
-    Boom::Platform.stubs(:open_command).returns("echo")
-    assert_match /opened https:\/\/github\.com for you/,
-      command('open github')
+    Boom::Platform.stubs(:system).returns('')
+    assert_match /opened https:\/\/github\.com for you/, command('open github')
   end
 
   def test_item_open_lists
-    Boom::Platform.stubs(:open_command).returns("echo")
-    assert_match /opened all of \"urls\" for you/,
-      command('open urls')
+    Boom::Platform.stubs(:system).returns('')
+    assert_match /opened all of urls for you/, command('open urls')
   end
 
   def test_item_creation
-    assert_match /"twitter" in "urls"/,
+    assert_match /twitter in urls/,
       command('urls twitter http://twitter.com/holman')
   end
 
   def test_item_creation_long_value
-    assert_match /is "tanqueray hendricks bombay"/,
+    assert_match /is tanqueray hendricks bombay/,
       command('urls gins tanqueray hendricks bombay')
   end
 
@@ -104,11 +107,11 @@ class TestCommand < Test::Unit::TestCase
   end
 
   def test_item_deletion
-    assert_match /"github" is gone forever/, command('urls github delete')
+    assert_match /github is gone forever/, command('urls github delete')
   end
 
   def test_edit
-    Boom::Command.stubs(:system).returns('')
+    Boom::Platform.stubs(:system).returns('')
     assert_match 'Make your edits', command('edit')
   end
 
@@ -124,7 +127,7 @@ class TestCommand < Test::Unit::TestCase
   end
 
   def test_nonexistent_item_access_scoped_by_list
-    assert_match /"twitter" not found in "urls"/, command('urls twitter')
+    assert_match /twitter not found in urls/, command('urls twitter')
   end
   
   def test_echo_item
@@ -136,7 +139,7 @@ class TestCommand < Test::Unit::TestCase
   end
   
   def test_echo_item_does_not_exist
-    assert_match /"wrong" not found/, command('echo wrong')
+    assert_match /wrong not found/, command('echo wrong')
   end
   
   def test_echo_list_item
@@ -144,10 +147,11 @@ class TestCommand < Test::Unit::TestCase
   end
   
   def test_echo_list_item_does_not_exist
-    assert_match /"wrong" not found in "urls"/, command('echo urls wrong')
+    assert_match /wrong not found in urls/, command('echo urls wrong')
   end
 
   def test_show_storage
+    Boom::Config.any_instance.stubs(:attributes).returns('backend' => 'json')
     assert_match /You're currently using json/, command('storage')
   end
   
@@ -168,4 +172,12 @@ class TestCommand < Test::Unit::TestCase
   def test_version_long
     assert_match /#{Boom::VERSION}/, command('--version')
   end
+
+  def test_stdin_pipes
+    stub = Object.new
+    stub.stubs(:stat).returns([1,2])
+    stub.stubs(:read).returns("http://twitter.com")
+    Boom::Command.stubs(:stdin).returns(stub)
+    assert_match /twitter in urls/, command('urls twitter')
+  end
 end

data/test/test_platform.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+class TestPlatform < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def test_darwin
+    assert_equal Boom::Platform.darwin?, RUBY_PLATFORM.include?('darwin')
+  end
+
+  def test_windows
+    assert_equal Boom::Platform.windows?, true if RUBY_PLATFORM =~ /win|mingw/ 
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: boom
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Zach Holman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-11 00:00:00 -07:00
+date: 2011-07-16 00:00:00 +09:00
 default_executable: boom
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,6 +79,7 @@ files:
 - completion/boom.bash
 - completion/boom.zsh
 - lib/boom.rb
+- lib/boom/color.rb
 - lib/boom/command.rb
 - lib/boom/config.rb
 - lib/boom/core_ext/symbol.rb
@@ -95,10 +96,12 @@ files:
 - test/examples/test_json.json
 - test/examples/urls.json
 - test/helper.rb
+- test/test_color.rb
 - test/test_command.rb
 - test/test_config.rb
 - test/test_item.rb
 - test/test_list.rb
+- test/test_platform.rb
 has_rdoc: true
 homepage: https://github.com/holman/boom
 licenses: []
@@ -134,7 +137,9 @@ signing_key:
 specification_version: 2
 summary: boom lets you access text snippets over your command line.
 test_files: 
+- test/test_color.rb
 - test/test_command.rb
 - test/test_config.rb
 - test/test_item.rb
 - test/test_list.rb
+- test/test_platform.rb