activerecord-postgresql-cube 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0ba35fb4d432a8cf1fb8694d0bcf0aac9edaab76
+  data.tar.gz: 8d967d3d61ac94226b60fb9717ba0c352eb8a6ab
+SHA512:
+  metadata.gz: 56cdcb1fb3d8b0f6a67d9e87acabe29410211c1e7f52ef68f07c1ed475973320c8555aa3e9e8cd660f871c919c4d5aed4ff23e5539fc7d65e76deccd8c21882f
+  data.tar.gz: b92849cfa5425d38689db97e995682e655ae32397d5787959bfce92a7158e8eff99405fc036d94e8488072e45a356c3c71b8253348ddd03d39f3371d495e9eec

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-postgresql-cube.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Milo Winningham
+
+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,71 @@
+# activerecord-postgresql-cube
+
+Adds support to ActiveRecord for the PostgreSQL cube data type.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-postgresql-cube'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-postgresql-cube
+
+## Usage
+
+Make sure you have the cube extension enabled on your database, then add and index a column with a `cube` type:
+
+```ruby
+enable_extension "cube"
+add_column :things, :features, :cube
+add_index :things, :features, using: "gist"
+```
+
+Define optional accessor methods:
+
+```ruby
+class Thing < ActiveRecord::Base
+  cube_attributes :features, :fluffiness, :crunchiness, :hotness, :dryness
+end
+
+# These are equivalent:
+Thing.new(features: [1.0, 0.0, 0.5, 0.2])
+Thing.new(fluffiness: 1.0, crunchiness: 0.0, hotness: 0.5, dryness: 0.2)
+```
+
+Query ordered by cube distance to find similar results.
+
+```ruby
+# Seed with some random values:
+100.times { Thing.create(features: Array.new(4) { rand }) }
+
+# Query directly:
+my_favorite_thing = Thing.by_cube_distance(:features, [1.0, 0.0, 0.5, 0.2]).first
+# => #<Thing id: 39, features: [0.832089176888876, 0.192166292526192, 0.56526526018018, 0.0925453162946783]>
+my_favorite_thing.distance # => 0.284478455665301
+
+# Or by distance from an existing record:
+recommended_thing = my_favorite_thing.similar_by_cube_distance(:features).first
+# => #<Thing id: 691, features: [0.61796879992257, 0.249908423662009, 0.593267501286819, 0.0877211312590144]>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/quadule/activerecord-postgresql-cube.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activerecord-postgresql-cube.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "activerecord-postgresql-cube/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-postgresql-cube"
+  spec.version       = ActiveRecordPostgreSQLCube::VERSION
+  spec.authors       = ["Milo Winningham"]
+  spec.email         = ["milo@winningham.net"]
+
+  spec.summary       = %q{ActiveRecord support for the PostgreSQL cube data type.}
+  spec.homepage      = "https://github.com/quadule/activerecord-postgresql-cube"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", "~> 5.0.0"
+  spec.add_dependency "pg", "~> 0.18.4"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord-postgresql-cube"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activerecord-postgresql-cube.rb

@@ -0,0 +1,3 @@
+require "activerecord-postgresql-cube/model"
+require "activerecord-postgresql-cube/type"
+require "activerecord-postgresql-cube/version"

data/lib/activerecord-postgresql-cube/model.rb

@@ -0,0 +1,43 @@
+require "active_record"
+
+module ActiveRecordPostgreSQLCube
+  module Model
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def by_cube_distance(column_name, cube)
+        column = arel_table[column_name]
+        cube_values = Arel.sql("'(#{cube.to_a.map(&method(:Float)).join(",")})'")
+        distance_operation = Arel::Nodes::InfixOperation.new("<->", column, cube_values)
+        distance_column_name = %{"#{column_name}_distance"}
+        distance = Arel::Nodes::As.new(distance_operation, Arel.sql(distance_column_name))
+        select_values = all.select_values.presence || [arel_table[Arel.star]]
+        select(*select_values, distance).order(distance_column_name)
+      end
+
+      private def cube_attributes(column_name, *attributes)
+        unless Thing.type_for_attribute(column_name.to_s).type == :cube
+          raise ArgumentError, "#{column_name} is not a cube column"
+        end
+
+        attributes.each_with_index do |name, i|
+          define_method "#{name}" do
+            self[column_name][i]
+          end
+
+          define_method "#{name}=" do |value|
+            self[column_name] ||= Array.new(attributes.size, 0)
+            self[column_name][i] = value
+          end
+        end
+      end
+    end
+
+    def similar_by_cube_distance(column_name)
+      similar = self.class.by_cube_distance(column_name, send(column_name))
+      similar.where.not(self.class.primary_key => send(self.class.primary_key))
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecordPostgreSQLCube::Model

data/lib/activerecord-postgresql-cube/type.rb

@@ -0,0 +1,62 @@
+require "active_record/connection_adapters/postgresql_adapter"
+
+module ActiveRecord
+  module ConnectionAdapters
+    module PostgreSQL
+      module OID
+        class Cube < Point
+          def type
+            :cube
+          end
+
+          def cast(value)
+            case value
+            when ::String
+              dimensions = value.scan(/\(([^)]+)\)/).flatten.map { |dimension| dimension.split(/ *, */) }
+              cast(dimensions.many? ? dimensions : dimensions[0])
+            when ::Array
+              value.map { |v| v.is_a?(::Array) ? cast(v) : Float(v) }
+            else
+              value
+            end
+          end
+
+          def serialize(value)
+            if value.is_a?(::Array)
+              values = value.map { |v| v.is_a?(::Array) ? serialize(v) : Float(v) }
+              values = values.join(",")
+              values = "(#{values})" unless values[0] == "(" && values[-1] == ")"
+              values
+            else
+              super
+            end
+          end
+        end
+
+        class TypeMapInitializer
+          module CubeRegistration
+            def run(records)
+              if cube = records.find { |r| r["typname"] == "cube" }
+                register cube["oid"], OID::Cube.new
+              end
+              super
+            end
+          end
+          prepend CubeRegistration
+        end
+
+        ActiveRecord::Type.register(:cube, Cube, adapter: :postgresql)
+      end
+    end
+
+    class PostgreSQLAdapter
+      NATIVE_DATABASE_TYPES[:cube] = { name: "cube" }
+    end
+
+    class TableDefinition
+      def cube(name, options = {})
+        column(name, "cube", options)
+      end
+    end
+  end
+end

data/lib/activerecord-postgresql-cube/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordPostgreSQLCube
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-postgresql-cube
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Milo Winningham
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- milo@winningham.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-postgresql-cube.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord-postgresql-cube.rb
+- lib/activerecord-postgresql-cube/model.rb
+- lib/activerecord-postgresql-cube/type.rb
+- lib/activerecord-postgresql-cube/version.rb
+homepage: https://github.com/quadule/activerecord-postgresql-cube
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveRecord support for the PostgreSQL cube data type.
+test_files: []