boom 0.0.2 → 0.0.3

data/Readme.markdown

@@ -81,6 +81,13 @@ can have multiple lists.
         blog:   http://zachholman.com
         github: https://github.com
 
+** 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:

data/bin/boom

@@ -4,5 +4,4 @@ $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'boom'
 
-storage = Boom::Storage.new
-Boom::Command.execute(storage,*ARGV)
+Boom::Command.execute(*ARGV)

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.2'
-  s.date              = '2010-11-24'
+  s.version           = '0.0.3'
+  s.date              = '2010-11-28'
   s.rubyforge_project = 'boom'
 
   ## Make sure your summary is short. The description may be as long

data/lib/boom.rb

@@ -15,5 +15,9 @@ require 'boom/list'
 require 'boom/storage'
 
 module Boom
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
+
+  def self.storage
+    @storage ||= Boom::Storage.new
+  end
 end

data/lib/boom/command.rb

@@ -10,18 +10,18 @@ module Boom
   class Command
     class << self
 
-      attr_accessor :storage
+      # Public: accesses the in-memory JSON representation.
+      #
+      # Returns a Storage instance.
+      def storage
+        Boom.storage
+      end
 
       # Public: executes a command.
       #
-      # storage - The Storage instance off which to run commands. This is
-      #           likely just Boom::Storage.new, since Boom::Storage should 
-      #           pick up the appropriate JSON file paths on its own.
       # args    - The actual commands to operate on. Can be as few as zero
       #           arguments or as many as three.
-      def execute(storage,*args)
-        @storage = storage
-
+      def execute(*args)
         command = args[0]
         major   = args[1]
         minor   = args[2]
@@ -67,7 +67,8 @@ module Boom
       #
       # Returns output based on method calls.
       def delegate(command, major, minor)
-        return all if command == 'all'
+        return all  if command == 'all'
+        return edit if command == 'edit'
 
         # if we're operating on a List
         if storage.list_exists?(command)
@@ -90,11 +91,11 @@ module Boom
 
       # Public: prints all Items over a List.
       #
-      # list - the List object to iterate over
+      # name - the List object to iterate over
       #
       # Returns nothing.
-      def list_detail(list_name)
-        list = storage.lists.find { |list| list.name == list_name } 
+      def list_detail(name)
+        list = List.find(name)
         list.items.sort{ |x,y| x.name <=> y.name }.each do |item|
           output "    #{item.name}: #{item.value}"
         end
@@ -126,10 +127,9 @@ module Boom
       #
       # Returns nothing.
       def list_delete(name)
-        lists = storage.lists.reverse.reject { |list| list.name == name }
         output "You sure you want to delete everything in \"#{name}\"? (y/n):"
         if $stdin.gets.chomp == 'y'
-          storage.lists = lists
+          List.delete(name)
           output "Boom! Deleted all your #{name}."
           save!
         else
@@ -149,7 +149,7 @@ module Boom
       #
       # Returns the newly created Item.
       def add_item(list,name,value)
-        list = storage.lists.find{|storage_list| storage_list.name == list}
+        list = List.find(list)
         list.add_item(Item.new(name,value))
         output "Boom! \"#{name}\" in \"#{list.name}\" is \"#{value}\". Got it."
         save!
@@ -194,7 +194,7 @@ module Boom
       #
       # Returns the matching Item.
       def search_list_for_item(list_name, item_name)
-        list = storage.lists.first { |list| list.name == list_name }
+        list = List.find(list_name)
         item = list.items.first { |item| item.name == item_name }
 
         output Clipboard.copy(item)
@@ -207,6 +207,15 @@ module Boom
         storage.save!
       end
 
+      # Public: launches JSON file in an editor for you to edit manually. Uses
+      # the $EDITOR environment variable for editing.
+      #
+      # Returns nothing.
+      def edit
+        system "`echo $EDITOR` #{storage.json_file} &"
+        output "Boom! Make your edits, and do be sure to save."
+      end
+
     end
   end
 end

data/lib/boom/list.rb

@@ -2,7 +2,8 @@
 # individual Items. The relationship is maintained in a simple array on the
 # List-level.
 #
-module Boom class List
+module Boom
+  class List
     
     # Public: creates a new List instance in-memory.
     #
@@ -14,6 +15,13 @@ module Boom class List
       @name  = name
     end
 
+    # Public: accesses the in-memory JSON representation.
+    #
+    # Returns a Storage instance.
+    def self.storage
+      Boom.storage
+    end
+
     # Public: lets you access the array of items contained within this List.
     #
     # Returns an Array of Items.
@@ -33,6 +41,26 @@ module Boom class List
       @items << item
     end
 
+    # Public: finds any given List by name.
+    #
+    # name - String name of the list to search for
+    #
+    # Returns the first instance of List that it finds.
+    def self.find(name)
+      storage.lists.find { |list| list.name == name } 
+    end
+
+    # Public: deletes a List by name.
+    #
+    # name - String name of the list to delete
+    #
+    # Returns whether one or more lists were removed.
+    def self.delete(name)
+      previous = storage.lists.size
+      storage.lists = storage.lists.reject { |list| list.name == name }
+      previous != storage.lists.size
+    end
+
     # Public: a Hash representation of this List.
     #
     # Returns a Hash of its own data and its child Items.

data/lib/boom/storage.rb

@@ -75,7 +75,7 @@ module Boom
     #
     # Returns a String JSON representation of its Lists and their Items.
     def to_json
-      Yajl::Encoder.encode(to_hash)
+      Yajl::Encoder.encode(to_hash, :pretty => true)
     end
 
     # Public: creates a Hash of the representation of the in-memory data

data/test/helper.rb

@@ -13,21 +13,8 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'boom'
 
-# test/spec/mini 3
-# http://gist.github.com/25455
-# chris@ozmm.org
-# file:lib/test/spec/mini.rb
-def context(*args, &block)
-  return super unless (name = args.first) && block
-  require 'test/unit'
-  klass = Class.new(defined?(ActiveSupport::TestCase) ? ActiveSupport::TestCase : Test::Unit::TestCase) do
-    def self.test(name, &block)
-      define_method("test_#{name.gsub(/\W/,'_')}", &block) if block
-    end
-    def self.xtest(*args) end
-    def self.setup(&block) define_method(:setup, &block) end
-    def self.teardown(&block) define_method(:teardown, &block) end
-  end
-  (class << klass; self end).send(:define_method, :name) { name.gsub(/\W/,'_') }
-  klass.class_eval &block
+def boom_json(name)
+  Boom::Storage.any_instance.stubs(:json_file).
+    returns("test/examples/#{name}.json")
+  Boom.stubs(:storage).returns(Boom::Storage.new)
 end

data/test/test_command.rb

@@ -24,15 +24,13 @@ end
 class TestCommand < Test::Unit::TestCase
 
   def setup
-    Boom::Storage.any_instance.stubs(:json_file).
-      returns('test/examples/urls.json')
-    @storage = Boom::Storage.new
+    boom_json :urls
   end
 
   def command(cmd)
     cmd = cmd.split(' ') if cmd
     Boom::Command.capture_output
-    Boom::Command.execute(@storage,*cmd)
+    Boom::Command.execute(*cmd)
     Boom::Command.captured_output
   end
 
@@ -82,4 +80,9 @@ class TestCommand < Test::Unit::TestCase
   def test_item_deletion
     assert_match /"github" is gone forever/, command('urls github delete')
   end
+
+  def test_edit
+    Boom::Command.stubs(:system).returns('')
+    assert_match 'Make your edits', command('edit')
+  end
 end

data/test/test_list.rb

@@ -5,6 +5,7 @@ class TestList < Test::Unit::TestCase
   def setup
     @list = Boom::List.new('urls')
     @item = Boom::Item.new('github','https://github.com')
+    boom_json :urls
   end
 
   def test_name
@@ -23,4 +24,20 @@ class TestList < Test::Unit::TestCase
     assert_equal 1, @list.to_hash[@list.name].size
   end
 
+  def test_find
+    assert_equal 'urls', Boom::List.find('urls').name
+  end
+
+  def test_delete_success
+    assert_equal 1, Boom.storage.lists.size
+    assert Boom::List.delete('urls')
+    assert_equal 0, Boom.storage.lists.size
+  end
+
+  def test_delete_fail
+    assert_equal 1, Boom.storage.lists.size
+    assert !Boom::List.delete('robocop')
+    assert_equal 1, Boom.storage.lists.size
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: boom
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Zach Holman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-24 00:00:00 -08:00
+date: 2010-11-28 00:00:00 -08:00
 default_executable: boom
 dependencies: 
 - !ruby/object:Gem::Dependency