dm-postgres-types 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e394e2af566007a38dbea5021a14e2671e44c139
+  data.tar.gz: 5d92a8cbf5c4f720ac38acb68db93b5da879b1bb
+SHA512:
+  metadata.gz: bf6481a2fd0a8cc750d0e0a30aa06a2ae85b013d119b3971bba51b687ccdd710e729020287740b4ede733fefeac0f87fb6d6c2928d14fa85a6ac33992bb55d71
+  data.tar.gz: 31d8dcb892a8090d56b7fa677b7836f8166c2dbe03fa561050cae76031930c63ab4d3fd85b7e0331b285abbc8fb5f8705128854325a36d42172597e8f2bd4887

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eric Marden
+
+MIT License
+
+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.md

@@ -0,0 +1,120 @@
+# DataMapper::PostgresTypes
+
+Adds support for native PostgreSQL datatypes, including JSON, HSTORE, and ARRAY to DataMapper.
+
+This gem replaces `dm-pg-types` with a cleaner/faster implementation of the Array and HStore datatypes, and adds support for the PostgreSQL's native JSON datatype (which means it is stored in the database differently than the JSON property offered by `dm-types`.
+
+While `dm-postgres-types` is more or less compatible with the other implemenations, I recommend you create new fields and migrate any existing data instead of just changing the property type of existing models and hoping for the best. YMMV, of course.
+
+On with the show...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dm-postgres-types'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+DataMapper::PostgresTypes defines 4 new `DataMapper::Property` classes that can be used when defining your schema. These properties take advantage of datatypes available in PostgreSQL 8.4+, and in the case of `DataMapper::Property::PgJSON`, PostgreSQL 9.2+. With that said, this gem is recommended for and has only been tested against PostgreSQL 9.3.
+
+### DataMapper::Property::PgArray
+
+Example:
+
+````ruby
+class MyModel
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :elements, PgArray
+end
+
+m = MyModel.new(elements: ['abc', 'def'])
+m.elements
+# => ["abc", "def"]
+````
+
+Use this property when you want to store an array of strings. This property dosn't have any options.
+
+---
+
+### DataMapper::Property::PgNumericArray
+
+Example:
+
+````ruby
+class MyModel
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :decimals, PgNumericArray, scale: 5, precision: 10
+end
+
+m = MyModel.new(decimals: [1.13, 2.19, 5.11])
+m.decimals
+# => [1.13, 2.19, 5.11]
+````
+Use this property when you want to store an array of integers and/or floats.
+
+Precision is the number of digits in your array's value(s). Scale is the number of digits to the right of the decimal point in your array's values. Set these options and PostgreSQL will cooerce your array's value(s) when it stores your array.
+
+The default percision is `10` and the default scale is `0`, which is suitable for integers. Adjust the scale if you want to store float values instead.
+
+---
+
+### DataMapper::Property::PgArray
+
+Example:
+
+````ruby
+class MyModel
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :things, PgHStore
+end
+
+m = MyModel.new(things: { a: 'bcd', e: 'fgh' })
+m.things
+# => { "a" => "bcd", "e" => "fgh" }
+````
+
+Use this property when you want to store simple hash values. This property dosn't have any options. 
+
+Please note: All hash keys will be returned as strings when your hash is loaded from the database, even if you supplied a hash with symbol keys when you saved it. If this is undesired, check out the `Hash#symbolize_keys` method provided by `ActiveSupport` ([link](http://rubygems.org/gems/activesupport)).
+
+---
+
+### DataMapper::Property::PgJSON
+
+Example:
+
+````ruby
+class MyModel
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :data, PgJSON, load_raw_value: true
+end
+
+m = MyModel.new(data: { a: 'bcd', e: 'fgh' })
+m.things
+# => "{"a" => "bcd", "e" => "fgh" }
+````
+
+Use this property when you want to store your value, serialized as JSON. By default, the value will be deserialized back into a ruby datatype (e.g. `Hash` or `Array`) when loaded from the database. Set the `:load_raw_value` to `true`, as shown above, to get the raw JSON value as a string instead.
+
+Please note: JSON de/serializtion is being handled by the `Oj` gem, which is the fastest implementation for ruby that you can find. There are no immediate plans to add the overhead of `MultiJSON` to this library. With that said, there shouldn't be any conflicts with other JSON libraries you maybe using in your project.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/dm-postgres-types/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+
+# environment
+ENV['RACK_ENV'] ||= 'development'
+
+# load path
+lib_path = File.expand_path('../lib', __FILE__)
+($:.unshift lib_path) unless ($:.include? lib_path)
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.pattern = "spec/**/*_spec.rb"
+end
+task :default => [:test]

data/dm-postgres-types.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dm-postgres-types/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "dm-postgres-types"
+  gem.version       = DataMapper::PostgresTypes::VERSION
+  gem.authors       = ["Eric Marden"]
+  gem.email         = ["eric@xentek.net"]
+  gem.summary       = %q{Adds support for native PostgreSQL datatypes to DataMapper}
+  gem.description   = %q{Adds support for native PostgreSQL datatypes, including JSON, HSTORE, and Array to DataMapper}
+  gem.homepage      = ""
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'dm-core', '~> 1.2.0'
+  gem.add_dependency 'dm-migrations', '~> 1.2.0'
+  gem.add_dependency 'dm-types', '~> 1.2.0'
+  gem.add_dependency 'dm-validations', '~> 1.2.0'
+  gem.add_dependency 'dm-postgres-adapter', '~> 1.2.0'
+
+  gem.add_development_dependency 'bundler'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'gem-release'
+end

data/lib/dm-postgres-types.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+# deps
+require 'dm-core'
+require 'dm-migrations'
+require 'dm-types'
+require 'dm-postgres-adapter'
+
+# lib
+require 'dm-postgres-types/property/pg_array'
+require 'dm-postgres-types/property/pg_numeric_array'
+require 'dm-postgres-types/property/pg_hstore'
+require 'dm-postgres-types/property/pg_json'
+require 'dm-postgres-types/version'
+
+# migrations and primitives
+module DataMapper
+  module Migrations
+    module PostgresAdapter
+      def property_schema_hash(property)
+        schema = super
+
+        if property.kind_of?(Property::DecimalArray)
+          schema[:primitive] = "#{schema[:primitive]}(#{property.precision},#{property.scale})[]"
+          schema[:precision] = schema[:scale] = nil
+        elsif property.kind_of?(Property::StringArray)
+          schema[:primitive] = "#{schema[:primitive]}[]"
+          schema[:length] = nil
+        elsif property.kind_of?(Property::PgJSON)
+          schema.delete(:length)
+        end
+
+        schema
+      end
+    end
+  end
+
+  module PostgresTypes
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def type_map
+        postgres_types = { 
+          Property::HStore => { primitive: 'HSTORE' },
+          Property::DecimalArray => { primitive: "NUMERIC" },
+          Property::StringArray => { primitive: "TEXT" },
+          Property::PgJSON => { primitive: 'JSON' }
+        }
+        super.merge(postgres_types).freeze
+      end
+    end
+  end
+end
+
+DataMapper::Adapters::PostgresAdapter.send(:include, DataMapper::PostgresTypes)

data/lib/dm-postgres-types/property/pg_array.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require 'dm-core'
+
+module DataMapper
+  class Property
+    class PgArray < Object
+      def load(value)
+        return [] if value.nil?
+        value.gsub!(/[{}]/,'')
+        CSV.parse_line(value) || []
+      end
+
+      def dump(value)
+        return nil if value.nil?
+        "{#{CSV.generate_line(value, row_sep: '')}}"
+      end
+    end
+  end
+end

data/lib/dm-postgres-types/property/pg_hstore.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+require 'dm-core'
+
+module DataMapper
+  class Property
+    class PgHStore < Object
+      def load(value)
+        return nil unless value
+        values = value.split(",")
+        values.map! { |val| unescape_pg_hash(val) }
+        values.map! { |key, val| [key, unescape_nil(val)] }
+        Hash[*(values.flatten)]
+      end
+
+      def dump(value)
+        return "" unless value
+        value.map! do |idx, val|
+          [escape_double_quote(idx), escape_value(val)].join(",")
+        end
+      end
+
+      private
+
+      def escape_nil(value)
+        (value.nil?) ? 'NULL' : value
+      end
+
+      def unescape_nil(value)
+        (value == 'NULL') ? nil : value
+      end
+
+      def escape_double_quote(value)
+        value.gsub!(/"/, '\"')
+        value
+      end
+
+      def unescape_double_quote(value)
+        value.gsub!('"','')
+        value.strip!
+        value
+      end
+
+      def escape_pg_hash(value)
+        (value =~ /[,\s=>]/ || value.empty?) ? %Q{"#{value}"} : value
+      end
+
+      def unescape_pg_hash(value)
+        values = value.split("=>")
+        values.map! { |val| unescape_double_quote(val) }
+        values
+      end
+
+      def escape_value(value)
+        escape_double_quote(escape_nil(escape_pg_hash(value)))
+      end
+    end
+  end
+end

data/lib/dm-postgres-types/property/pg_json.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+require 'dm-core'
+require 'dm-types/support/dirty_minder'
+
+module DataMapper
+  class Property
+    class PgJSON < Object
+      accept_options :load_raw_value
+      attr_reader :load_raw_value
+      def initialize(model, name, options = {})
+        super
+        @load_raw_value = @options[:load_raw_value] || false
+      end
+
+      def dump(value)
+        case value
+        when ::NilClass, ::String
+          value
+        when ::Hash, ::Array
+          Oj.dump(value, mode: :compat)
+        else
+          '{}'
+        end
+      end
+
+      def load(value)
+        case value
+        when ::Hash, ::Array
+          (load_raw_value) ? Oj.dump(value, mode: :compat) : value
+        when ::String
+          (load_raw_value) ? value : Oj.load(value)
+        else
+          (load_raw_value) ? '{}' : {}
+        end
+      end
+
+      def primitive?(value)
+        value.kind_of?(::String)
+      end
+    end
+  end
+end

data/lib/dm-postgres-types/property/pg_numeric_array.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require 'dm-core'
+require 'dm-postgres-types/property/pg_array'
+
+module DataMapper
+  class Property
+    class PgNumericArray < PgArray
+      accept_options :precision, :scale
+      attr_reader :precision, :scale
+
+      def initialize(model, name, options = {})
+        super
+        @precision = @options[:precision] || 10
+        @scale     = @options[:scale]     || 0
+
+        if precision <= 0
+          raise ArgumentError, "precision must be greater than 0"
+        end
+
+        if scale <= 0
+          raise ArgumentError, "scale must be greater than or equal to 0"
+        end        
+      end
+
+      def load(value)
+        values = super
+        values.map! { |val| (scale > 0) ? val.to_f : val.to_i } if values
+        values
+      end
+    end
+  end
+end

data/lib/dm-postgres-types/version.rb

@@ -0,0 +1,5 @@
+module DataMapper
+  module PostgresTypes
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: dm-postgres-types
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eric Marden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dm-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: dm-migrations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: dm-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: dm-validations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: dm-postgres-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds support for native PostgreSQL datatypes, including JSON, HSTORE,
+  and Array to DataMapper
+email:
+- eric@xentek.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dm-postgres-types.gemspec
+- lib/dm-postgres-types.rb
+- lib/dm-postgres-types/property/pg_array.rb
+- lib/dm-postgres-types/property/pg_hstore.rb
+- lib/dm-postgres-types/property/pg_json.rb
+- lib/dm-postgres-types/property/pg_numeric_array.rb
+- lib/dm-postgres-types/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Adds support for native PostgreSQL datatypes to DataMapper
+test_files: []