burp 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,28 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rcov
+  rspec (~> 2.3.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Dave Martin
+
+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.rdoc

@@ -0,0 +1,59 @@
+= burp
+
+Oh yum, look at this collection of hashes I have to manage. Each with a unique id to represent it:
+  
+yummy = [
+          {:id => :a, :data => "A"},
+          {:id => :b, :data => "B"},
+          {:id => :c, :data => "C"}
+        ]
+
+I feel like checking out :b today:
+
+Yes, you could just select what you need the boring, ugly way
+b_data = yummy.select{|node| node[:id] == :b}.first
+That's not hard, but rather than manually select it, let's just let out a hearty burp
+
+burped = Burp.new(yummy, :id)
+
+and get good old fashioned hash in return
+
+#=> { :a => {:id => :a, :data => "A" },
+      :b => {:id => :b, :data => "B" },
+      :c => {:id => :c, :data => "C" }
+
+meaning that
+b_data = burped[:b]
+
+As a special side-dish, Burp can handle things that are a bit messier as well
+
+fly_in_my_soup = [
+                   {:id => :a, :data => "A"},
+                   {:id => :b, :data => "B"},
+                   {:id => :c, :data => "C"},
+                   {:fly => :d, :data => "D"}
+        ] 
+
+yummy_soup = Burped.new(fly_in_my_soup)
+#=> { :a => {:id => :a, :data => "A" },
+      :b => {:id => :b, :data => "B" },
+      :c => {:id => :c, :data => "C" }
+
+fly = yummy_soup.left_overs
+#=> [{:fly => :d, :data => "D"}]
+
+== Contributing to burp
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Dave Martin. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "burp"
+  gem.homepage = "http://github.com/forforf/burp"
+  gem.license = "MIT"
+  gem.summary = %Q{Turns an array of hashes into a hash of hashes}
+  gem.description = %Q{Tell it which hash key in the array of hashes to use as the hash id, and voila a hash is made from your array}
+  gem.email = "dmarti21@gmail.com"
+  gem.authors = ["Dave M"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "burp #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/burp.rb

@@ -0,0 +1,31 @@
+class Burp < Hash
+  attr_reader :left_overs
+  #Converts an array of hashes into a hash
+  #It takes as arguments,the array of hashes (each hash representing node data)
+  #and a field in the hash (node data) to use as the key for the returned hash
+  def initialize(node_list, id)
+    @left_overs = []
+    node_list.map do |node|
+      #better error information and eliminate nil keys
+      node = validate(node, id) 
+      #it's left over if the primary hash key doesn't exist in the node
+      add_leftovers(self, @left_overs, node) unless ( node[id] && node.keys.include?(id) )
+    end
+  end
+  
+  def validate(node, id)
+    begin
+      self[node[id]] = node 
+    rescue TypeError  #replacing an unhelpful error with something more helpful
+      raise ArgumentError, "Can't use #{id.inspect} as a valid key in #{node.inspect}. "\
+        "Maybe array elements are not hashes?" 
+    end
+  end
+
+  def add_leftovers(main_hash, left_overs, node)
+    #remove nil hash from main_hash
+    main_hash.delete(nil)
+    #add data to left overs (excluding nil data)
+    left_overs << node if node
+  end
+end

data/spec/burp_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+describe "Burp" do
+  before(:each) do
+    @nice_array = [{:id => :a, :data => "A"},
+                   {:id => :b, :data => "B"},
+                   {:id => :c, :data => "C"}]
+    @nice_burped = {:a => {:id => :a, :data => "A"},
+                    :b => {:id => :b, :data => "B"},
+                    :c => {:id => :c, :data => "C"}}
+
+    @not_an_array = @nice_burped #its a hash now
+
+    #notice the last id typo
+    @dirty_array = [{:id => :a, :data => "A"},
+                   {:id => :b, :data => "B"},
+                   {:id => :c, :data => "C"},
+                   {:iidd => :d, :data => "D"}]
+
+    @dirty_burped = @nice_burped
+
+    @dirty_left_overs = [{:iidd => :d, :data => "D"}]
+  end
+
+  it "makes a hash out of a nicely formed array" do
+    my_burp = Burp.new(@nice_array, :id)
+    my_burp.should == @nice_burped
+  end
+
+  it "raises an informative error message when it panics" do
+    expect { Burp.new(@not_an_array) }.to raise_error(ArgumentError)
+  end
+
+  it "handles a dirty hash" do
+    my_dirty_burp = Burp.new(@dirty_array, :id)
+    my_dirty_burp.should == @dirty_burped
+    my_dirty_burp.left_overs.should == @dirty_left_overs
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'burp'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: burp
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Dave M
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-12 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+description: Tell it which hash key in the array of hashes to use as the hash id, and voila a hash is made from your array
+email: dmarti21@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/burp.rb
+- spec/burp_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/forforf/burp
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 771572209
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Turns an array of hashes into a hash of hashes
+test_files: 
+- spec/burp_spec.rb
+- spec/spec_helper.rb