https://github.com/quadule/activerecord-postgresql-cube
ActiveRecord support for the PostgreSQL cube data type.
https://github.com/quadule/activerecord-postgresql-cube
Last synced: about 1 year ago
JSON representation
ActiveRecord support for the PostgreSQL cube data type.
- Host: GitHub
- URL: https://github.com/quadule/activerecord-postgresql-cube
- Owner: quadule
- License: mit
- Created: 2016-07-17T09:39:11.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2021-03-22T05:33:22.000Z (about 5 years ago)
- Last Synced: 2024-04-24T07:23:02.569Z (about 2 years ago)
- Language: Ruby
- Homepage:
- Size: 12.7 KB
- Stars: 8
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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
# => #
my_favorite_thing.distance # => 0.284478455665301
# Or by distance from an existing record:
recommended_thing = my_favorite_thing.similar_by_cube_distance(:features).first
# => #
```
## 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).