Skip to content
This repository
branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 examples
Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .rspec
Octocat-spinner-32 .rvmrc
Octocat-spinner-32 Gemfile
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 mince_data_model.gemspec
README.md

This gem has been moved to the mince core gem, and this repo is deprecated

What Iz Mince Data Model?

Mince Data Model provides the ability to switch between different databases for different environments.

It supports the following data stores:

  • mince_dynamo_db - Stores and retrieves data from Amazon's DynamoDB
  • mince - Stores and retrieves data from MongoDB
  • hashy_db - Stores and retrieves data from a hash in-memory.

By creating some niceties and an implementation to swap out different data persistance strategies.

How To Use

Create a data model class

class TronLightCycleDataModel
  include MinceDataModel

  # Name of the collection or table to store the data
  data_collection :light_cycles

  # The fields or columns this data model can have
  data_fields :luminating_color, :rezzed, :jetwall, :grid_locked
end

Set the data store to use

Rails.application.config.data_store = 'mince_dynamo_db/data_store'

You must have the data store gem installed.

Start storing and retrieving data

TronLightCycleDataModel.store(model)
TronLightCycleDataModel.find(1)
TronLightCycleDataModel.all
TronLightCycleDataModel.all_by_field(:grid_locked, true)
TronLightCycleDataModel.update_field_with_value('some_cycle_id_123', :grid_locked, false)
TronLightCycleDataModel.all_by_fields(grid_locked: true, luminating_color: 'red')

There are also other ways to set the data store

Why?

A little background perhaps...

After developing quite a few Rails apps, we started feeling a lot of pain with our models. I'm sure most of us know this pain. We end up having at least one massive model which ends up being the brain model of the application. Generally this model is the User model, or the Project model. Whichever class your application primarily focusses on.

After some time of trying new things and talking to others, reading from others, and evolving our applications, the source of the problem seemed to be the Active Record architecture pattern. Where logic and data are presented as a unified package. The problem with that is that there is a ton of logic that can be associated to a very little bit of data.

The idea behind the mince is to provide the lightest weight ORM possible so that you can build your application's business logic and data logic completely isolated from each other.

One great example is the user model. Every app on the face of the uniwebs has it and we can all relate to it. First, you need to register. Registration has validations. Once you've registered, you need to confirm your email before you can login. Once you login you want to change information about yourself. But since you've already created an account, there are different validations than when you were registering! The validations alone make the User model very complex. You end up with a lot of conditional logic in your user models. After you've implemented registration, your user model has already become over 100 lines long!

What if you could have a separate model for each logical event? A registration model, a password updator model, a user account model? Your validations can become specific to one scenario. With this implementation, every class is less than 100 lines long. Now, number of lines is not our goal, but it is a great indicator to how much that class is doing.

Form more info about the inspiration behind Mince Data Store:

Rails Implementation Example

This mince rails example application is available to reveal A way to implement the use of the Mince Data Store, Mince, and Hashy Db gems.

Mince

Mince is a lightweight MongoDB ORM for Ruby. It frees you from using a huge ORM that forces you into using a specific architecture.

@github @rubygems

Hashy Db

Provides an interface for storing and retreiving information in a Hash in memory.

The motivation behind this is so you can clone the repository down, have ruby installed, run bundle install and be able to run your tests and develop without being dependent on any other setup.

@github @rubygems

Mince DynamoDb

Provides an interface for storing and retreiving information in Amazon's DynamoDB.

It's almost impossible to develop an application using DynamoDB in development and even harder to use DynamoDb in a test environment. This allows you to switch your application to DynamoDB only in production mode.

@github @rubygems

Something went wrong with that request. Please try again.