mkompanets / light_store

A gem for storing flat (spreadsheet-like) data about an object

LightStore

A library for storing data about an object in spreadsheet-like format (array of hashes).

This library aims to provide an easy way to store data about objects. Data that is typically generated with complex queries could be stored in a flat format. This is meant to be a general purpose library, but it was created to improve performance of dynamic report generators. This comes from an idea that each 'row' of report data could be identified by the object id and a date constraint relevant to the report.

Data format example: [{account_id: 1, month: '2014-11', revenue: 987.65}, {account_id: 1, month: '2014-12', revenue: 1234.56}]

In the above example account_id: is a primary key and month: is a date constraint field.

Installation

This gem relies on redis for storage. This gem depends on redis-rb gem. Please be sure that it's installed and working correctly.

Add this line to your application's Gemfile:

gem 'light_store'

And then execute:

$ bundle install

In rails

Add an initializer:

LightStore.configure do |config|
  config.redis = Redis.new
end

Define a class:

class RevenueReport < LightStore::Data
 primary_field :id
 date_constraint_field :month  # required
end

Adding data:

data = [
  {id: 1, month: '2012-01', revenue: 1234.56, number_of_orders: 10},
  {id: 1, month: '2012-02', revenue: 2345.56, number_of_orders: 20},
  {id: 1, month: '2012-03', revenue: 3245.56, number_of_orders: 30},
  {id: 1, month: '2012-04', revenue: 2435.56, number_of_orders: 20},
  {id: 2, month: '2012-01', revenue: 1234.56, number_of_orders: 10},
  {id: 2, month: '2012-02', revenue: 2234.56, number_of_orders: 20},
  {id: 2, month: '2012-03', revenue: 3234.56, number_of_orders: 30},
  {id: 2, month: '2012-04', revenue: 2234.56, number_of_orders: 20},
]
RevenueReport.add_data(data)

Getting all data:

data = RevenueReport.get_data()

Getting data for a given id:

data = RevenueReport.get_data(primary_key: 2)

Getting data for a given id within range:

data = RevenueReport.get_sorted_data(primary_key: 2, date_range: ['2012-02', '2012-04'])

Running RevenueReport.add_data(data) for the same data will not result in duplication. The dataset passed to light_store instance could be the same or slightly different, it doesn't matter. All records will be handled correctly. LightStore will generate a key that combines primary key and date constraint field. Data corresponding to that record will be either created or updated.

Contributing

1. Fork it
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