activerecord-postgres-hstore 0.0.1 → 0.0.2

data/README.textile

@@ -1,4 +1,4 @@
-.h2 Goodbye serialize, hello hstore.
+h2. Goodbye serialize, hello hstore.
 
 You need dynamic columns in your tables. What do you do?
 
@@ -18,83 +18,113 @@ You need dynamic columns in your tables. What do you do?
 |count all with negative condition|18722,149|1677,948|SELECT count(*) FROM foos WHERE data !~ 'another key: 9999990';|SELECT count(*) FROM bars WHERE not data @> '"another key"=>9999990';|
 |find one with condition|17740,307|130,227|SELECT count(*) FROM foos WHERE data ~ 'another key: 9999990';|SELECT * FROM bars WHERE data @> '"another key"=>9999990'|
 
-Benchmarks made in my local machine, time in milliseconds.
+Benchmarks made in my local machine, with a million records. Time is in milliseconds.
 
-.h2 Requirements
+h2. Requirements
 
 Postgresql 8.4 with contrib and Rails 3. (It might work on 2.3.x with minor patches...)
 
-.h2 Install
+In Ubuntu, this is easy:
+
+@sudo apt-get install postgresql-8.4 postgresql-contrib-8.4@
+
+In Mac ...you are screwed. Use a VM.
+
+h2. Install
 
 Hstore is a postgres contrib type. Check it out first:
 
-http://www.postgresql.org/docs/8.4/static/hstore.html
+"http://www.postgresql.org/docs/8.4/static/hstore.html":http://www.postgresql.org/docs/8.4/static/hstore.html
 
 Then, just add this to your Gemfile:
 
-gem 'activerecord-postgres-hstore'
+@gem 'activerecord-postgres-hstore'@
 
 And run your bundler:
 
-bundle install
+@bundle install@
 
 Now you need to create a migration that adds hstore support for your postgresql database:
 
-rails g railtie:hstore
+@rails g railtie:hstore@
 
 Run it:
 
-rake db:migrate
+@rake db:migrate@
 
 Finally you can create your own tables using hstore type. It's easy:
 
-rails g model Person name:string data:hstore
+@rails g model Person name:string data:hstore@
 
 You're done.
 
 Well, not yet. Don't forget to add indexes. Like this:
 
-CREATE INDEX people_gist_data ON people USING GIST(data);
--- or
-CREATE INDEX people_gin_data ON people USING GIN(data);
+@CREATE INDEX people_gist_data ON people USING GIST(data);@
+or
+@CREATE INDEX people_gin_data ON people USING GIN(data);@
 
 To my experience GIN is faster for searching records.
 
-.h2 Usage
+h2. Usage
 
 Once you have it installed, you just need to learn a little bit of new sqls for selecting stuff (creting and updating is transparent).
 
 Find records that contains a key named 'foo':
 
-Person.where("data ? 'foo'")
+@Person.where("data ? 'foo'")@
 
 Find records where 'foo' is equal to 'bar':
 
-Person.where("data -> 'foo' = 'bar'")
+@Person.where("data -> 'foo' = 'bar'")@
 
 This same sql is at least twice as fast (using indexes) if you do it that way:
 
-Person.where("data @> 'foo=>bar'")
+@Person.where("data @> 'foo=>bar'")@
 
 Find records where 'foo' is not equal to 'bar':
 
-Person.where("data -> 'foo' <> 'bar'")
-# or
-Person.where("not data @> 'foo=>bar'")
+@Person.where("data -> 'foo' <> 'bar'")@
+or
+@Person.where("not data @> 'foo=>bar'")@
 
 Find records where 'foo' is like 'bar':
 
-Person.where("data -> 'foo' LIKE '%bar%'")
-# or something like ...
-Person.where("data -> 'foo' ILIKE '%bar%'")
+@Person.where("data -> 'foo' LIKE '%bar%'")@
+or something like ...
+@Person.where("data -> 'foo' ILIKE '%bar%'")@
+
+If you need to delete a key in a record, you can do it that way:
+
+@person.destroy_key(:data, :foo)@
+
+This way you'll also save the record:
+
+@person.destroy_key!(:data, :foo)@
+
+The destroy_key method returns 'self', so you can chain it:
+
+@person.destroy_key(:data, :foo).destroy_key(:data, :bar).save@
+
+But there it a shortcut for that:
+
+@person.destroy_keys(:data, :foo, :bar)@
+
+or...
+
+@person.destroy_keys!(:data, :foo, :bar)@
+
+And finally, if you need to delete keys in many rows, you can:
+
+
 
 Have fun.
 
-.h2 Help
+h2. Help
 
 You can use issues in github for that. Or else you can reach me at twitter: @joaomilho
 
-.h2 Note on Patches/Pull Requests
+h2. Note on Patches/Pull Requests
  
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -104,6 +134,6 @@ You can use issues in github for that. Or else you can reach me at twitter: @joa
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-.h2 Copyright
+h2. Copyright
 
 Copyright (c) 2010 Juan Maiz. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/activerecord-postgres-hstore/activerecord.rb

@@ -1,6 +1,51 @@
 # ActiveRecord::ConnectionAdapters::PostgreSQLColumn.new('data','','hstore').type
 module ActiveRecord
   class Base
+    def self.delete_key attribute, key
+      #UPDATE tab SET h = delete(h, 'k1');
+      unless column_names.include?(attribute.to_s)
+        raise "invalid attribute #{attribute}"
+      end
+      update_all(["#{attribute} = delete(#{attribute},?)",key])
+    end
+    def self.delete_keys attribute, *keys
+      unless column_names.include?(attribute.to_s)
+        raise "invalid attribute #{attribute}"
+      end
+      delete_str = "delete(#{attribute},?)"
+      (keys.count-1).times do
+        delete_str = "delete(#{delete_str},?)"
+      end
+      update_all(["#{attribute} = #{delete_str}", *keys])
+    end
+    
+    def destroy_key attribute, key
+      unless self.class.column_names.include?(attribute.to_s)
+        raise "invalid attribute #{attribute}"
+      end
+      new_value = send(attribute)
+      new_value.delete(key.to_s)
+      send("#{attribute}=", new_value)
+      self
+    end
+    def destroy_key! attribute, key
+      destroy_key(attribute, key).save
+    end
+    def destroy_keys attribute, *keys
+      for key in keys
+        new_value = send(attribute)
+        new_value.delete(key.to_s)
+        send("#{attribute}=", new_value)
+      end
+      self
+    end
+    def destroy_keys! attribute, *keys
+      unless self.class.column_names.include?(attribute.to_s)
+        raise "invalid attribute #{attribute}"
+      end
+      destroy_keys(attribute, *keys).save
+    end
+
     # For Rails 3 compat :D
     #alias :old_arel_attributes_values :arel_attributes_values
     def arel_attributes_values(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)

data/lib/activerecord-postgres-hstore/hash.rb

@@ -1,6 +1,7 @@
 class Hash
 
   def to_hstore
+    return "''" if empty?
     #@todo DIOGO! Check security issues with this quoting pleaz
     map{|idx,val| "('#{idx}'=>'#{val.to_s.gsub(/'/,"''")}')"  }.join(' || ')
   end

data/lib/activerecord-postgres-hstore/string.rb

@@ -5,6 +5,7 @@ class String
   end
 
   def valid_hstore?
+    return true if empty? || self == "''"
     # This is what comes from the database
     dbl_quotes_re = /"([^"]+)"=>"([^"]+)"/
     # TODO

data/spec/activerecord-postgres-hstore_spec.rb

@@ -1,39 +1,24 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "ActiverecordPostgresHstore" do
-  it "should convert hstore string to hash" do
+  it "should convert hash to hstore string" do
     {:a => 1, :b => 2}.to_hstore.should == "('a'=>'1') || ('b'=>'2')"
   end
 
-  it "should convert hash to hstore string" do
+  it "should convert hstore string to hash" do
     '"a"=>"1", "b"=>"2"'.from_hstore.should == {'a' => '1', 'b' => '2'}
   end
  
   it "should quote correctly" do
     {:a => "'a'"}.to_hstore.should == "('a'=>'''a''')"
   end
-  
-end
-
-=begin
 
-  #---
-
-  test "should create contact" do
-    assert Contact.make :dynamic_values => {:a => 1, :b => 2}
-  end
-
-  test "should raise HstoreTypeMismatch" do
-    assert_raises ActiveRecord::HstoreTypeMismatch do
-      assert Contact.make :dynamic_values => "bug"
-    end
+  it "should convert empty hash" do
+    {}.to_hstore.should == "''"
   end
 
-  test "should read values from contact" do
-    contact = Contact.make :dynamic_values => {:a => 1, :b => "Lorem ipsum", 'other stuff' => "'''a'''"}
-    assert_equal({'a' => '1', 'b' => 'Lorem ipsum', 'other stuff' => "'''a'''"}, Contact.find(contact.id).dynamic_values)
+  it "should convert empty string" do
+    ''.from_hstore.should == {}
   end
-
+  
 end
-
-=end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: activerecord-postgres-hstore
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Juan Maiz
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-08 00:00:00 -03:00
+date: 2010-09-09 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
@@ -54,6 +57,7 @@ files:
 - lib/templates/setup_hstore.rb
 - spec/activerecord-postgres-hstore_spec.rb
 - README.textile
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/softa/activerecord-postgres-hstore
 licenses: []
@@ -64,26 +68,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Goodbye serialize, hello hstore
 test_files: 
-- spec/spec_helper.rb
 - spec/activerecord-postgres-hstore_spec.rb
+- spec/spec_helper.rb