Superstore

Superstore is a PostgreSQL JSONB document store which uses ActiveModel to mimic much of the behavior in ActiveRecord.

Requirements

Superstore requires PostgreSQL 9.5 or above.

Installation

Add the following to the Gemfile:

gem 'pg'
gem 'superstore'

Add a config/superstore.yml:

development:
  adapter: jsonb

Superstore will share the existing ActiveRecord database connection.

Defining Models

class Widget < Superstore::Base
  string :name
  string :description
  integer :price
  array :colors, unique: true

  validates :name, presence: :true

  before_create do
    self.description = "#{name} is the best product ever"
  end
end

The table name defaults to the case-sensitive, pluralized name of the model class. To specify a custom name, set the table_name attribute on the class:

class MyWidget < Superstore::Base
  table_name = 'my_widgets'
end

Creating and updating records

Superstore has equivalent methods to ActiveRecord:

widget = Widget.new
widget.valid?
widget = Widget.create(name: 'Acme', price: 100)
widget.update_attribute(:price, 1200)
widget.update(price: 1200, name: 'Acme Corporation')
widget.attributes = {price: 300}
widget.price_was
widget.save
widget.save!

Finding records

widget = Widget.find(uuid)
widget = Widget.first
widgets = Widget.all
Widget.find_each do |widget|
  # Codez
end

Scoping

Some lightweight scoping features are available:

Widget.where('color' => 'red')
Widget.select(['name', 'color'])
Widget.limit(10)