activerecord-postgres-hstore 0.4.0 → 0.4.1

data/Gemfile

@@ -12,5 +12,4 @@ group :development, :test do
   gem "jeweler", "~> 1.8.3"
   gem "rdoc"
   gem "rspec"
-  gem "rcov"
 end

data/Gemfile.lock

@@ -1,54 +1,54 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.3)
-      actionpack (= 3.2.3)
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
       mail (~> 2.4.4)
-    actionpack (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
-      journey (~> 1.0.1)
+      journey (~> 1.0.4)
       rack (~> 1.4.0)
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.1.2)
-    activemodel (3.2.3)
-      activesupport (= 3.2.3)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
       builder (~> 3.0.0)
-    activerecord (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.3)
-      activemodel (= 3.2.3)
-      activesupport (= 3.2.3)
-    activesupport (3.2.3)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     arel (3.0.2)
-    builder (3.0.0)
+    builder (3.0.3)
     diff-lcs (1.1.3)
     erubis (2.7.0)
     git (1.2.5)
     hike (1.2.1)
-    i18n (0.6.0)
-    jeweler (1.8.3)
+    i18n (0.6.1)
+    jeweler (1.8.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
       rdoc
-    journey (1.0.3)
-    json (1.7.3)
+    journey (1.0.4)
+    json (1.7.5)
     mail (2.4.4)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.18)
-    multi_json (1.3.5)
-    pg (0.13.2)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    pg (0.14.1)
     polyglot (0.3.3)
     rack (1.4.1)
     rack-cache (1.2)
@@ -57,43 +57,43 @@ GEM
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
-    rails (3.2.3)
-      actionmailer (= 3.2.3)
-      actionpack (= 3.2.3)
-      activerecord (= 3.2.3)
-      activeresource (= 3.2.3)
-      activesupport (= 3.2.3)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
       bundler (~> 1.0)
-      railties (= 3.2.3)
-    railties (3.2.3)
-      actionpack (= 3.2.3)
-      activesupport (= 3.2.3)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
-      thor (~> 0.14.6)
+      thor (>= 0.14.6, < 2.0)
     rake (0.9.2.2)
-    rcov (0.9.11)
     rdoc (3.12)
       json (~> 1.4)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
       diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
-    shoulda (3.0.1)
-      shoulda-context (~> 1.0.0)
-      shoulda-matchers (~> 1.0.0)
+    rspec-mocks (2.11.2)
+    shoulda (3.1.1)
+      shoulda-context (~> 1.0)
+      shoulda-matchers (~> 1.2)
     shoulda-context (1.0.0)
-    shoulda-matchers (1.0.0)
+    shoulda-matchers (1.3.0)
+      activesupport (>= 3.0.0)
     sprockets (2.1.3)
       hike (~> 1.2)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    thor (0.14.6)
+    thor (0.16.0)
     tilt (1.3.3)
     treetop (1.4.10)
       polyglot
@@ -109,7 +109,6 @@ DEPENDENCIES
   pg
   rails
   rake
-  rcov
   rdoc
   rspec
   shoulda

data/README.md

@@ -13,22 +13,22 @@ Requirements
 ------------
 
 Postgresql 8.4+ (also tested with 9.0) with contrib and Rails 3. (It
-might work on 2.3.x with minor patches…)  
+might work on 2.3.x with minor patches…)
 On Ubuntu, this is easy: `sudo apt-get install postgresql-contrib-9.0`
 
-On Mac <del> …you are screwed. Use a VM.  </del> you should use [the binary package kindly provided by EnterpriseDB](http://www.enterprisedb.com/products-services-training/pgdownload#osx)  
+On Mac <del> …you are screwed. Use a VM.  </del> you should use [the binary package kindly provided by EnterpriseDB](http://www.enterprisedb.com/products-services-training/pgdownload#osx)
 [Homebrew’s](https://github.com/mxcl/homebrew) Postgres installation also includes the contrib packages: `brew install postgres`
 
 Notes for Rails 3.1 and above
 -----------------------------
 
-The master branch already support a custom serialization coder.  
+The master branch already support a custom serialization coder.
 If you want to use it just put in your Gemfile:
 
     gem 'activerecord-postgres-hstore', git: 'git://github.com/softa/activerecord-postgres-hstore.git'
 
 If you install them gem from the master branch you also have to insert a
-line in each model that uses hstore.  
+line in each model that uses hstore.
 Assuming a model called **Person**, with a **data** field on it, the
 code should look like:
 
@@ -63,7 +63,7 @@ e.g.:
       database: hstorage_dev
       encoding: unicode
       username: postgres
-      password: 
+      password:
       pool: 5
 
 Now you need to create a migration that adds hstore support for your
@@ -80,11 +80,11 @@ Finally you can create your own tables using hstore type. It’s easy:
     rails g model Person name:string data:hstore
     rake db:migrate
 
-You’re done.  
+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_gist_data ON people USING GIST(data);`
+or
 `CREATE INDEX people_gin_data ON people USING GIN(data);`
 
 To understand the difference between the two types of indexes take a
@@ -94,7 +94,7 @@ Usage
 -----
 
 Once you have it installed, you just need to learn a little bit of new
-sqls for selecting stuff (creating and updating is transparent).  
+sqls for selecting stuff (creating and updating is transparent).
 Find records that contains a key named 'foo’:
 
     Person.where("data ? 'foo'")
@@ -106,10 +106,10 @@ Find records where 'foo’ is equal to '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'")
 
 Find records where 'foo’ is like 'bar’:
@@ -128,7 +128,7 @@ The destroy\_key method returns 'self’, so you can chain it:
 
     person.destroy_key(:data, :foo).destroy_key(:data, :bar).save
 
-But there is a shortcuts for that: 
+But there is a shortcuts for that:
 
    person.destroy_keys(:data, :foo, :bar)
 
@@ -140,6 +140,20 @@ and with many keys:
 
     Person.delete_keys(:data, :foo, :bar)
 
+Caveats
+-------
+
+hstore keys and values have to be strings. This means `true` will become `"true"` and `42` will become `"42"` after you save the record. Only `nil` values are preserved.
+
+It is also confusing when querying:
+
+    Person.where("data -> 'foo' = :value", value: true).to_sql
+    #=> SELECT "people".* FROM "people" WHERE ("data -> 'foo' = 't'") # notice 't'
+
+To avoid the above, make sure all named parameters are strings:
+
+    Person.where("data -> 'foo' = :value", value: some_var.to_s)
+
 Have fun.
 
 Help
@@ -151,10 +165,10 @@ twitter: [@dbiazus](https://twitter.com/#!/dbiazus) or [@joaomilho](https://twit
 Note on Patches/Pull Requests
 -----------------------------
 
-* Fork the project.  
-* Make your feature addition or bug fix.  
-* Add tests for it. This is important so I don’t break it in a future version unintentionally.  
-* Commit, do not mess with rakefile, version, or history.  (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)  
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don’t break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.  (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.
 
 Copyright

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/activerecord-postgres-hstore.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "activerecord-postgres-hstore"
-  s.version = "0.4.0"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Juan Maiz", "Diogo Biazus"]
-  s.date = "2012-06-14"
+  s.date = "2012-09-14"
   s.description = "This gem adds support for the postgres hstore type. It is the _just right_ alternative for storing hashes instead of using seralization or dynamic tables."
   s.email = "juanmaiz@gmail.com"
   s.extra_rdoc_files = [
@@ -110,7 +110,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_development_dependency(%q<rdoc>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
     else
       s.add_dependency(%q<rails>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
@@ -120,7 +119,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_dependency(%q<rdoc>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<rcov>, [">= 0"])
     end
   else
     s.add_dependency(%q<rails>, [">= 0"])
@@ -131,7 +129,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     s.add_dependency(%q<rdoc>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<rcov>, [">= 0"])
   end
 end
 

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

@@ -66,7 +66,7 @@ module ActiveRecord
       destroy_keys(attribute, *keys).save
     end
 
-    if Rails.version < '3.1.0'
+    if defined?(Rails) && Rails.version < '3.1.0'
     # This method is replaced for Rails 3 compatibility.
     # All I do is add the condition when the field is a hash that converts the value
     # to hstore format.
@@ -117,6 +117,22 @@ module ActiveRecord
 
     end
 
+    class Table
+
+      # Adds hstore type for migrations. So you can add columns to a table like:
+      #   change_table :people do |t|
+      #     ...
+      #     t.hstore :info
+      #     ...
+      #   end
+      def hstore(*args)
+        options = args.extract_options!
+        column_names = args
+        column_names.each { |name| column(name, 'hstore', options) }
+      end
+
+    end
+
     class PostgreSQLColumn < Column
       # Does the type casting from hstore columns using String#from_hstore or Hash#from_hstore.
       def type_cast_code_with_hstore(var_name)
@@ -127,7 +143,7 @@ module ActiveRecord
       def simplified_type_with_hstore(field_type)
         field_type == 'hstore' ? :hstore : simplified_type_without_hstore(field_type)
       end
-    
+
       alias_method_chain :type_cast_code, :hstore
       alias_method_chain :simplified_type, :hstore
     end
@@ -140,14 +156,14 @@ module ActiveRecord
       # Quotes correctly a hstore column value.
       def quote_with_hstore(value, column = nil)
         if value && column && column.sql_type == 'hstore'
-          raise HstoreTypeMismatch, "#{column.name} must have a Hash or a valid hstore value (#{value})" unless value.kind_of?(Hash) || value.valid_hstore?          
+          raise HstoreTypeMismatch, "#{column.name} must have a Hash or a valid hstore value (#{value})" unless value.kind_of?(Hash) || value.valid_hstore?
           return quote_without_hstore(value.to_hstore, column)
         end
         quote_without_hstore(value,column)
       end
-      
+
       alias_method_chain :quote, :hstore
-      alias_method_chain :native_database_types, :hstore 
+      alias_method_chain :native_database_types, :hstore
     end
   end
 end

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

@@ -1,24 +1,34 @@
 class Hash
+  HSTORE_ESCAPED = /[,\s=>\\]/
+
+  # Escapes values such that they will work in an hstore string
+  def hstore_escape(str)
+    if str.nil?
+      return 'NULL'
+    end
+    
+    str = str.to_s.dup
+    # backslash is an escape character for strings, and an escape character for gsub, so you need 6 backslashes to get 2 in the output.
+    # see http://stackoverflow.com/questions/1542214/weird-backslash-substitution-in-ruby for the gory details
+    str.gsub!(/\\/, '\\\\\\')
+    # escape backslashes before injecting more backslashes
+    str.gsub!(/"/, '\"')
+    
+    if str =~ HSTORE_ESCAPED or str.empty?
+      str = '"%s"' % str
+    end
+    
+    return str
+  end
 
   # Generates an hstore string format. This is the format used
   # to insert or update stuff in the database.
   def to_hstore
     return "" if empty?
 
-    map { |idx, val| 
-      iv = [idx,val].map { |_| 
-        e = _.to_s.gsub(/"/, '\"')
-        if _.nil?
-          'NULL'
-        elsif e =~ /[,\s=>]/ || e.blank?
-          '"%s"' % e
-        else
-          e
-        end
-      }
-
-      "%s=>%s" % iv
-    } * ","
+    map do |idx, val| 
+      "%s=>%s" % [hstore_escape(idx), hstore_escape(val)]
+    end * ","
   end
 
   # If the method from_hstore is called in a Hash, it just returns self.

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

@@ -24,7 +24,7 @@ class String
       [k,v].map { |t| 
         case t
         when nil then t
-        when /^"(.*)"$/ then $1.gsub(/\\(.)/, '\1')
+        when /\A"(.*)"\Z/m then $1.gsub(/\\(.)/, '\1')
         else t.gsub(/\\(.)/, '\1')
         end
       }

data/spec/activerecord-postgres-hstore_spec.rb

@@ -63,13 +63,29 @@ describe "ActiverecordPostgresHstore" do
   end
 
   it "should quote keys and values correctly with combinations of single and double quotes" do
-    { %q("a') => %q(b "a' b) }.to_hstore.should eq(%q(\"a'=>"b \"a' b"))
+    { %q("a') => %q(b "a' b) }.to_hstore.should eq(%q("\"a'"=>"b \"a' b"))
   end
 
   it "should unquote keys and values correctly with combinations of single and double quotes" do
     %q("\"a'"=>"b \"a' b").from_hstore.should eq({%q("a') => %q(b "a' b)})
   end
 
+  it "should quote keys and values correctly with backslashes" do
+    { %q(\\) => %q(\\) }.to_hstore.should eq(%q("\\\\"=>"\\\\"))
+  end
+  
+  it "should unquote keys and values correctly with backslashes" do
+    %q("\\\\"=>"\\\\").from_hstore.should eq({ %q(\\) => %q(\\) })
+  end
+
+  it "should quote keys and values correctly with combinations of backslashes and quotes" do
+    { %q(' \\ ") => %q(" \\ ') }.to_hstore.should eq(%q("' \\\\ \""=>"\" \\\\ '"))
+  end
+
+  it "should unquote keys and values correctly with combinations of backslashes and quotes" do
+    %q("' \\\\ \""=>"\" \\\\ '").from_hstore.should eq({ %q(' \\ ") => %q(" \\ ') })
+  end
+
   it "should convert empty hash" do
     {}.to_hstore.should eq("")
   end
@@ -78,5 +94,11 @@ describe "ActiverecordPostgresHstore" do
     ''.from_hstore.should eq({})
     '         '.from_hstore.should eq({})
   end
+
+  it "should not change values with line breaks" do
+    input = { "a" => "foo\n\nbar" }
+    output = input.to_hstore
+    output.from_hstore.should eq(input)
+  end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres-hstore
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-14 00:00:00.000000000Z
+date: 2012-09-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2159228940 !ruby/object:Gem::Requirement
+  requirement: &2157171100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2159228940
+  version_requirements: *2157171100
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2159228300 !ruby/object:Gem::Requirement
+  requirement: &2157170000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2159228300
+  version_requirements: *2157170000
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &2159227720 !ruby/object:Gem::Requirement
+  requirement: &2157169120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2159227720
+  version_requirements: *2157169120
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2159227100 !ruby/object:Gem::Requirement
+  requirement: &2157168140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2159227100
+  version_requirements: *2157168140
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2159226380 !ruby/object:Gem::Requirement
+  requirement: &2157166860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +66,10 @@ dependencies:
         version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *2159226380
+  version_requirements: *2157166860
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &2159225720 !ruby/object:Gem::Requirement
+  requirement: &2157165660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *2159225720
+  version_requirements: *2157165660
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &2159224880 !ruby/object:Gem::Requirement
+  requirement: &2157164420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2159224880
+  version_requirements: *2157164420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2159223860 !ruby/object:Gem::Requirement
+  requirement: &2157163540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,18 +99,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2159223860
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &2159223260 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2159223260
+  version_requirements: *2157163540
 description: This gem adds support for the postgres hstore type. It is the _just right_
   alternative for storing hashes instead of using seralization or dynamic tables.
 email: juanmaiz@gmail.com
@@ -209,7 +198,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2838359693870553945
+      hash: 3203326444745733758
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: