boom 0.2.4 → 0.3.0

data/{CHANGELOG.markdown → CHANGELOG.md}

@@ -1,5 +1,14 @@
 # boom changes
 ## head
+
+## 0.3.0
+- 0.3 removes all the Storage nonsense in favor of clean and easy JSON. Less
+  code is best code.
+- It also removes all the Ruby tests and instead does them in shell with roundup.
+- It also changes delete to use `--delete` so there's conceptually less of a
+  problem.
+
+## 0.2.4
 - [@Dlom](https://github.com/Dlom) fixed some troubles in #49.
 - Some additional test coverage added by
   [@nickhammond](https://github.com/nickhammond).
@@ -66,8 +75,8 @@
   scripts and junk! Thanks [bschaeffer](https://github.com/bschaeffer).
 
 ## 0.0.9
-- Backport `Symbol#to_proc` for 1.8.6 support (thanks 
-  [kastner](https://github.com/kastner) and 
+- Backport `Symbol#to_proc` for 1.8.6 support (thanks
+  [kastner](https://github.com/kastner) and
   [DeMarko](https://github.com/DeMarko)).
 
 ## 0.0.8
@@ -81,7 +90,7 @@
   (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)). 
+  [MichaelXavier](https://github.com/MichaelXavier)).
 
 ## 0.0.5
 - Item deletes are now scoped by list rather than GLOBAL DESTRUCTION! (thanks

data/Gemfile.lock

@@ -1,17 +1,15 @@
 PATH
   remote: .
   specs:
-    boom (0.2.3)
-      json_pure (~> 1.5.3)
-      multi_json (~> 1.0.3)
+    boom (0.2.4)
+      yajl-ruby (~> 1.1.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    json_pure (1.5.3)
     mocha (0.9.12)
-    multi_json (1.0.3)
     rake (0.9.2)
+    yajl-ruby (1.1.0)
 
 PLATFORMS
   ruby

data/{README.markdown → README.md}

@@ -2,12 +2,12 @@
 
 ## About
 
-boom manages your text snippets. On the command line. I just blew your mind.
+boom manages your text snippets on your command line. You can stash away text
+like URLs, canned responses, and important notes and then quickly copy them
+onto your clipboard, ready for pasting.
 
 For more details about what boom is and how it works, check out
-[boom's website](http://holman.github.com/boom). For full usage details
-(including a complete list of commands), check out
-[boom's wiki](https://github.com/holman/boom/wiki).
+[boom's website](http://holman.github.com/boom).
 
 ## Install
 
@@ -18,11 +18,11 @@ For more details about what boom is and how it works, check out
     $ boom gifs
     Boom! Created a new list called "gifs".
 
-    $ boom gifs melissa http://cl.ly/3pAn/animated.gif
-    Boom! "melissa" in "gifs" is "http://cl.ly/3pAn/animated.gif". Got it.
+    $ boom gifs shirt http://cl.ly/NwCS/shirt.gif
+    Boom! "shirt" in "gifs" is "http://cl.ly/NwCS/shirt.gif". Got it.
 
-    $ boom melissa
-    Boom! Just copied http://cl.ly/3pAn/animated.gif to your clipboard.
+    $ boom shirt
+    Boom! Just copied http://cl.ly/NwCS/shirt.gif to your clipboard.
 
 And that's just a taste! I know, you're salivating, I can hear you from here.
 (Why your saliva is noisy is beyond me.) Check out the [full list of
@@ -37,8 +37,11 @@ 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
 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.
+includes appropriate tests.
+
+The tests are written in shell for
+[roundup](https://github.com/bmizerany/roundup), since boom is basically just
+Ruby pretending to be shell. `rake` should run them all for you just fine.
 
 All good? Cool! Then [send me a pull request](https://github.com/holman/boom/pull/new/master)!
 
@@ -48,4 +51,4 @@ All good? Cool! Then [send me a pull request](https://github.com/holman/boom/pul
 [@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.
+`boom` to calculate their tax liability wins.

data/Rakefile

@@ -45,11 +45,9 @@ end
 
 task :default => :test
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+desc "Run tests for boom"
+task :test do
+  exec "test/run"
 end
 
 desc "Open an irb session preloaded with this library"

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.4'
-  s.date              = '2013-03-15'
+  s.version           = '0.3.0'
+  s.date              = '2013-03-29'
   s.rubyforge_project = 'boom'
 
   ## Make sure your summary is short. The description may be as long
@@ -32,7 +32,7 @@ Gem::Specification.new do |s|
   ## better to set the email to an email list or something. If you don't have
   ## a custom homepage, consider using your GitHub URL or the like.
   s.authors  = ["Zach Holman"]
-  s.email    = 'github.com@zachholman.com'
+  s.email    = 'zach@zachholman.com'
   s.homepage = 'https://github.com/holman/boom'
 
   ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
@@ -50,12 +50,11 @@ 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.md LICENSE.md]
 
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.
-  s.add_dependency('multi_json', "~> 1.0.3")
-  s.add_dependency('json_pure', "~> 1.5.3")
+  s.add_dependency('yajl-ruby', "~> 1.1.0")
 
   ## List your development dependencies here. Development dependencies are
   ## those that are only needed during development
@@ -67,11 +66,11 @@ Gem::Specification.new do |s|
   ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
   # = MANIFEST =
   s.files = %w[
-    CHANGELOG.markdown
+    CHANGELOG.md
     Gemfile
     Gemfile.lock
-    LICENSE.markdown
-    README.markdown
+    LICENSE.md
+    README.md
     Rakefile
     bin/boom
     boom.gemspec
@@ -81,28 +80,17 @@ Gem::Specification.new do |s|
     lib/boom.rb
     lib/boom/color.rb
     lib/boom/command.rb
-    lib/boom/config.rb
     lib/boom/core_ext/symbol.rb
     lib/boom/item.rb
     lib/boom/list.rb
     lib/boom/platform.rb
     lib/boom/storage.rb
-    lib/boom/storage/base.rb
-    lib/boom/storage/gist.rb
-    lib/boom/storage/json.rb
-    lib/boom/storage/keychain.rb
-    lib/boom/storage/mongodb.rb
-    lib/boom/storage/redis.rb
-    test/examples/config_json.json
-    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
+    test/cli.sh
+    test/examples/data.json
+    test/item.sh
+    test/list.sh
+    test/roundup
+    test/run
   ]
   # = MANIFEST =
 

data/lib/boom/command.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 # Command is the main point of entry for boom commands; shell arguments are
-# passd through to Command, which then filters and parses through individual
+# passed through to Command, which then filters and parses through individual
 # commands and reroutes them to constituent object classes.
 #
 # Command also keeps track of one connection to Storage, which is how new data
@@ -87,8 +87,6 @@ module Boom
       def delegate(command, major, minor)
         return all               if command == 'all'
         return edit              if command == 'edit'
-        return switch(major)     if command == 'switch'
-        return show_storage      if command == 'storage'
         return version           if command == "-v"
         return version           if command == "--version"
         return help              if command == 'help'
@@ -99,16 +97,16 @@ module Boom
 
         # if we're operating on a List
         if storage.list_exists?(command)
-          return delete_list(command) if major == 'delete'
+          return delete_list(command) if major == '--delete'
           return detail_list(command) unless major
-          unless minor == 'delete'
+          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
 
-        if minor == 'delete' and storage.item_exists?(major)
+        if minor == '--delete' and storage.item_exists?(major)
           return delete_item(command, major)
         end
 
@@ -118,25 +116,6 @@ module Boom
         return create_list(command, major, minor)
       end
 
-      # Public: shows the current user's storage.
-      #
-      # Returns nothing.
-      def show_storage
-        output "You're currently using #{Boom.config.attributes['backend']}."
-      end
-
-      # Public: switch to a new backend.
-      #
-      # backend - the String of the backend desired
-      #
-      # Returns nothing.
-      def switch(backend)
-        Storage.backend = backend
-        output "We've switched you over to #{backend}."
-      rescue NameError
-        output "We couldn't find that storage engine. Check the name and try again."
-      end
-
       # Public: prints all Items over a List.
       #
       # name - the List object to iterate over
@@ -234,7 +213,7 @@ module Boom
       #
       # Returns nothing.
       def delete_list(name)
-        output "You sure you want to delete everything in #{yellow(name)}? (y/n):"
+        printf "You sure you want to delete everything in #{yellow(name)}? (y/n): "
         if $stdin.gets.chomp == 'y'
           List.delete(name)
           output "#{cyan("Boom!")} Deleted all your #{yellow(name)}."
@@ -336,11 +315,7 @@ module Boom
       #
       # Returns nothing.
       def edit
-        if storage.respond_to?("json_file")
-          output "#{cyan("Boom!")} #{Platform.edit(storage.json_file)}"
-        else
-          output "This storage backend does not store #{cyan("Boom!")} data on your computer"
-        end
+        output "#{cyan("Boom!")} #{Platform.edit(storage.json_file)}"
       end
 
       # Public: prints all the commands of boom.
@@ -354,12 +329,10 @@ module Boom
           boom all                      show all items in all lists
           boom edit                     edit the boom JSON file in $EDITOR
           boom help                     this help text
-          boom storage                  shows which storage backend you're using
-          boom switch <storage>         switches to a different storage backend
           
           boom <list>                   create a new list
           boom <list>                   show items for a list
-          boom <list> delete            deletes a list
+          boom <list> --delete          deletes a list
 
           boom <list> <name> <value>    create a new list item
           boom <name>                   copy item's value to clipboard
@@ -370,7 +343,7 @@ module Boom
           boom random <list>            open a random item's url for a list in browser
           boom echo <name>              echo the item's value without copying
           boom echo <list> <name>       echo the item's value without copying
-          boom <list> <name> delete     deletes an item
+          boom <list> <name> --delete   deletes an item
 
           all other documentation is located at:
             https://github.com/holman/boom

data/lib/boom/item.rb

@@ -6,7 +6,6 @@
 #
 module Boom
   class Item
-    
     # Public: the String name of the Item
     attr_accessor :name
 
@@ -54,7 +53,7 @@ module Boom
     end
 
     # Public: only return url part of value - if no url has been
-    # detected returns value.
+    # detected it'll return the value.
     #
     # Returns a String which preferably is a URL.
     def url
@@ -67,6 +66,5 @@ module Boom
     def to_hash
       { @name => @value }
     end
-
   end
-end
+end

data/lib/boom/list.rb

@@ -81,7 +81,7 @@ module Boom
     #
     # name - String name of the Item to find
     #
-    # Returns the found item
+    # Returns the found item.
     def find_item(name)
       items.find do |item|
         item.name == name ||

data/lib/boom/storage.rb

@@ -1,22 +1,124 @@
-# coding: utf-8
-
 #
 # Storage is the interface between multiple Backends. You can use Storage
 # directly without having to worry about which Backend is in use.
 #
 module Boom
-  module Storage
-    
-    def self.backend=(backend)
-      backend = backend.capitalize
-      Boom::Storage.const_get(backend)
-      Boom.config.attributes['backend'] = backend.downcase
-      Boom.config.save
+  class Storage
+    JSON_FILE = "#{ENV['HOME']}/.boom"
+
+    # Public: the path to the Json file used by boom.
+    #
+    # Returns the String path of boom's Json representation.
+    def json_file
+      ENV['BOOMFILE'] || JSON_FILE
+    end
+
+    # Public: initializes a Storage instance by loading in your persisted data from adapter.
+    #
+    # Returns the Storage instance.
+    def initialize
+      @lists = []
+      bootstrap
+      populate
+    end
+
+    # Public: the in-memory collection of all Lists attached to this Storage
+    # instance.
+    #
+    # lists - an Array of individual List items
+    #
+    # Returns nothing.
+    attr_writer :lists
+
+    # Public: the list of Lists in your JSON data, sorted by number of items
+    # descending.
+    #
+    # Returns an Array of List objects.
+    def lists
+      @lists.sort_by { |list| -list.items.size }
+    end
+
+    # Public: tests whether a named List exists.
+    #
+    # name - the String name of a List
+    #
+    # Returns true if found, false if not.
+    def list_exists?(name)
+      @lists.detect { |list| list.name == name }
+    end
+
+    # Public: all Items in storage.
+    #
+    # Returns an Array of all Items.
+    def items
+      @lists.collect(&:items).flatten
     end
 
-    def self.backend
-      Boom::Storage.const_get(Boom.config.attributes['backend'].capitalize).new
+    # Public: tests whether a named Item exists.
+    #
+    # name - the String name of an Item
+    #
+    # Returns true if found, false if not.
+    def item_exists?(name)
+      items.detect { |item| item.name == name }
     end
 
+    # Public: creates a Hash of the representation of the in-memory data
+    # structure. This percolates down to Items by calling to_hash on the List,
+    # which in tern calls to_hash on individual Items.
+    #
+    # Returns a Hash of the entire data set.
+    def to_hash
+      { :lists => lists.collect(&:to_hash) }
+    end
+
+    # Takes care of bootstrapping the Json file, both in terms of creating the
+    # file and in terms of creating a skeleton Json schema.
+    #
+    # Return true if successfully saved.
+    def bootstrap
+      return if File.exist?(json_file)
+      FileUtils.touch json_file
+      File.open(json_file, 'w') {|f| f.write(to_json) }
+      save
+    end
+
+    # Take a JSON representation of data and explode it out into the consituent
+    # Lists and Items for the given Storage instance.
+    #
+    # Returns nothing.
+    def populate
+      file = File.new(json_file, 'r')
+      storage = Yajl::Parser.parse(file)
+
+      storage['lists'].each do |lists|
+        lists.each do |list_name, items|
+          @lists << list = List.new(list_name)
+
+          items.each do |item|
+            item.each do |name,value|
+              list.add_item(Item.new(name,value))
+            end
+          end
+        end
+      end
+    end
+
+    # Public: persists your in-memory objects to disk in Json format.
+    #
+    # lists_Json - list in Json format
+    #
+    # Returns true if successful, false if unsuccessful.
+    def save
+      File.open(json_file, 'w') {|f| f.write(to_json) }
+    end
+
+    # Public: the Json representation of the current List and Item assortment
+    # attached to the Storage instance.
+    #
+    # Returns a String Json representation of its Lists and their Items.
+    def to_json
+      Yajl::Encoder.encode(to_hash, :pretty => true)
+    end
   end
-end
+end

data/lib/boom.rb

@@ -6,38 +6,23 @@ rescue LoadError
 end
 
 require 'fileutils'
-require 'multi_json'
+require 'yajl'
 
 $:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
 require 'boom/color'
 require 'boom/platform'
 require 'boom/command'
-require 'boom/config'
 require 'boom/item'
 require 'boom/list'
-
 require 'boom/storage'
-require 'boom/storage/base'
-require 'boom/storage/json'
-require 'boom/storage/redis'
-require 'boom/storage/mongodb'
-require 'boom/storage/keychain'
-require 'boom/storage/gist'
 
 require 'boom/core_ext/symbol'
 
 module Boom
-  VERSION = '0.2.4'
-
-  extend self
-
-  def storage
-    @storage ||= Boom::Storage.backend
-  end
+  VERSION = '0.3.0'
 
-  def config
-    @config ||= Boom::Config.new
+  def self.storage
+    @storage ||= Storage.new
   end
-
-end
+end

data/test/cli.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env roundup
+export BOOMFILE=test/examples/data.json
+boom="./bin/boom"
+
+describe "cli"
+
+it_shows_help() {
+  $boom help | grep "boom: help"
+}
+
+it_shows_a_version() {
+  $boom --version | grep "running boom"
+}

data/test/examples/data.json

@@ -0,0 +1,17 @@
+{
+  "lists": [
+    {
+      "urls": [
+        { "blog":    "https://github.com/holman" },
+        { "twitter": "https://twitter.com/holman"},
+        { "site":    "http://zachholman.com"}
+      ]
+    },
+    {
+      "jokes": [
+        { "none":  "What do you call a cow with no legs? Ground beef." },
+        { "three": "What do you call a cow with three legs? Lean beef." }
+      ]
+    }
+  ]
+}

data/test/item.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env roundup
+export BOOMFILE=test/examples/data.json
+boom="./bin/boom"
+
+describe "items"
+
+it_adds_an_item() {
+  $boom urls google 'http://google.com'
+  $boom urls | grep google.com
+}
+
+it_deletes_an_item() {
+  yes | $boom urls google --delete | grep 'gone forever'
+  $boom urls google | grep 'not found'
+}
+
+it_echos_an_item() {
+  $boom echo site | grep 'zachholman.com'
+}

data/test/list.sh

@@ -0,0 +1,30 @@
+#!/usr/bin/env roundup
+export BOOMFILE=test/examples/data.json
+boom="./bin/boom"
+
+describe "lists"
+
+it_shows_all_lists_by_default() {
+  $boom | grep "urls"
+  $boom | grep "jokes"
+}
+
+it_adds_a_list() {
+  $boom enemies | grep "Created a new list"
+  $boom | grep "enemies (0)"
+}
+
+it_adds_a_list_with_a_duplicate_name() {
+  $boom urls github 'http://github.com/about'
+  $boom github | grep '/about'
+}
+
+it_shows_a_list() {
+  $boom urls | grep 'zachholman'
+}
+
+it_deletes_a_list() {
+  $boom | grep "enemies"
+  yes | $boom enemies --delete | grep "Deleted"
+  ! $boom | grep "enemies"
+}