mince_data_model 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.idea
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@mince_data_model --create

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mince_data_model.gemspec
+gemspec

data/README.md

@@ -0,0 +1,27 @@
+# What is this?
+
+Provides a very lightweight interface to store and retrieve data in MongoDB in Ruby.
+
+# Why would you want this?
+
+- To build a non-active-record implementation application using MongoDB.
+- Allows interchanging data persistence with HashyDb
+
+# Todos
+
+- Remove rails dependency
+- Add a better readme
+
+# Contribute
+
+- fork into a topic branch, write specs, make a pull request.
+
+# Owners
+
+Matt Simpson - [@railsgrammer](https://twitter.com/railsgrammer)
+<br />
+Jason Mayer - [@farkerhaiku](https://twitter.com/farkerhaiku)
+
+# Contributors
+- Your name here!
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/examples/guitar.rb

@@ -0,0 +1,16 @@
+require_relative 'guitar_data_model'
+
+class Guitar
+  attr_reader :brand, :price, :type, :color, :id
+
+  def initialize(attrs)
+    @brand = attrs[:brand]
+    @price = attrs[:price]
+    @type = attrs[:type]
+    @color = attrs[:color]
+  end
+
+  def store
+    @id = GuitarDataModel.store(self)
+  end
+end

data/examples/guitar_data_model.rb

@@ -0,0 +1,8 @@
+require_relative '../lib/mince_data_model'
+
+class GuitarDataModel
+  include MinceDataModel
+
+  data_collection :guitars
+  data_fields :brand, :price, :type, :color
+end

data/lib/data_store_config.rb

@@ -0,0 +1,7 @@
+require 'rails/application'
+
+module DataStoreConfig
+  def self.data_store
+    Rails.application.config.data_store.to_s.camelize.constantize
+  end
+end

data/lib/mince_data_model/version.rb

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

data/lib/mince_data_model.rb

@@ -0,0 +1,166 @@
+require "mince_data_model/version"
+# SRP: Interface to read and write to and from the data store class for a specific collection
+
+require 'active_support/hash_with_indifferent_access'
+require 'active_support/core_ext/hash/slice'
+require 'active_support/concern'
+
+require_relative 'data_store_config'
+
+module MinceDataModel
+  extend ActiveSupport::Concern
+
+  included do
+    attr_reader :id, :model
+  end
+
+  module ClassMethods
+    def data_store
+      DataStoreConfig.data_store
+    end
+
+    def data_fields(*fields)
+      create_data_fields(*fields) if fields.any?
+      @data_fields
+    end
+
+    def data_collection(collection_name = nil)
+      set_data_collection(collection_name) if collection_name
+      @data_collection
+    end
+
+    def store(model)
+      new(model).tap do |p|
+        p.add_to_data_store
+      end.id
+    end
+
+    def update(model)
+      new(model).tap do |p|
+        p.replace_in_data_store
+      end
+    end
+
+    def remove_from_array(id, field, value)
+      data_store.instance.remove_from_array(data_collection, data_store.primary_key_identifier, id, field, value)
+    end
+
+    def push_to_array(id, field, value)
+      data_store.instance.push_to_array(data_collection, data_store.primary_key_identifier, id, field, value)
+    end
+
+    def find(id)
+      translate_from_data_store data_store.instance.find(data_collection, data_store.primary_key_identifier, id)
+    end
+
+    def all
+      translate_each_from_data_store data_store.instance.find_all(data_collection)
+    end
+
+    def all_by_field(field, value)
+      translate_each_from_data_store data_store.instance.get_all_for_key_with_value(data_collection, field, value)
+    end
+
+    def all_by_fields(hash)
+      translate_each_from_data_store data_store.instance.get_by_params(data_collection, hash)
+    end
+
+    def find_by_fields(hash)
+      translate_from_data_store all_by_fields(hash).first
+    end
+
+    def containing_any(field, values)
+      translate_each_from_data_store data_store.instance.containing_any(data_collection, field, values)
+    end
+
+    def array_contains(field, value)
+      translate_each_from_data_store data_store.instance.array_contains(data_collection, field, value)
+    end
+
+    def translate_from_data_store(hash)
+      if hash
+        hash["id"] = hash[data_store.primary_key_identifier] if hash[data_store.primary_key_identifier]
+        HashWithIndifferentAccess.new hash
+      end
+    end
+
+    def translate_each_from_data_store(data)
+      data.collect {|d| translate_from_data_store(d) }
+    end
+
+    private
+
+    def set_data_collection(collection_name)
+      @data_collection = collection_name
+    end
+
+    def create_data_fields(*fields)
+      attr_accessor *fields
+      @data_fields = fields
+    end
+  end
+
+  def initialize(model)
+    @model = model
+    set_data_field_values
+    set_id
+  end
+
+  def data_store
+    self.class.data_store
+  end
+
+  def data_fields
+    self.class.data_fields
+  end
+
+  def data_collection
+    self.class.data_collection
+  end
+
+  def add_to_data_store
+    data_store.instance.add(data_collection, attributes)
+  end
+
+  def replace_in_data_store
+    data_store.instance.replace(data_collection, attributes)
+  end
+
+  private
+
+  def attributes
+    model_instance_values.merge(primary_key_identifier => id)
+  end
+
+  def model_instance_values
+    HashWithIndifferentAccess.new(model.instance_values).slice(*data_fields)
+  end
+
+  def set_id
+    @id = model_has_id? ? model.id : generated_id
+  end
+
+  def generated_id
+    data_store.generate_unique_id(model)
+  end
+
+  def model_has_id?
+    model.respond_to?(:id) && model.id
+  end
+
+  def set_data_field_values
+    data_fields.each { |field| set_data_field_value(field) }
+  end
+
+  def primary_key_identifier
+    data_store.primary_key_identifier
+  end
+
+  def set_data_field_value(field)
+    self.send("#{field}=", model.send(field)) if field_exists?(field)
+  end
+
+  def field_exists?(field)
+    model.respond_to?(field) && !model.send(field).nil?
+  end
+end

data/mince_data_model.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mince_data_model/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mince_data_model"
+  s.version     = MinceDataModel::VERSION
+  s.authors     = ["Jason Mayer", "Matt Simpson", "Asynchrony Solutions"]
+  s.email       = ["matt@railsgrammer.com", "jason.mayer@gmail.com"]
+  s.homepage    = "https://github.com/asynchrony/mince_data_model"
+  s.summary     = %q{Interface for interchanging which type of data store to persist data to}
+  s.description = %q{Interface for interchanging which type of data store to persist data to}
+
+  s.rubyforge_project = "mince_data_model"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
+  s.add_dependency("rails", "~> 3.0")
+end

data/spec/guitar_data_model_spec.rb

@@ -0,0 +1,17 @@
+require_relative '../examples/guitar_data_model'
+
+require_relative 'support/shared_examples/mince_data_model_examples'
+
+describe GuitarDataModel do
+  let(:collection_name) { :guitars }
+  let(:data_field_attributes) do
+    {
+            brand: 'a brand everyone knows',
+            price: 'a price you save up for',
+            type: 'the kind you want',
+            color: 'should be your favorite'
+    }
+  end
+
+  it_behaves_like 'a data model'
+end

data/spec/guitar_spec.rb

@@ -0,0 +1,32 @@
+require_relative '../examples/guitar'
+
+describe Guitar do
+  let(:attrs) { { brand: 'Gibson', price: 3399.99, type: 'Les Paul', color: 'Mahogany' } }
+
+  subject { described_class.new(attrs)}
+
+  its(:brand){ should == attrs[:brand] }
+  its(:price){ should == attrs[:price] }
+  its(:type){ should == attrs[:type] }
+  its(:color){ should == attrs[:color] }
+
+  describe "storing the guitar" do
+    let(:mock_id) { mock 'unique id for the guitar' }
+
+    before do
+      GuitarDataModel.stub(store: mock_id)
+    end
+
+    it 'uses the guitar document to store it' do
+      GuitarDataModel.should_receive(:store).with(subject).and_return(mock_id)
+
+      subject.store
+    end
+
+    it 'sets the id received from the document to the guitar so we can find it later' do
+      subject.store
+
+      subject.id.should == mock_id
+    end
+  end
+end

data/spec/support/shared_examples/mince_data_model_examples.rb

@@ -0,0 +1,155 @@
+require 'digest'
+
+shared_examples_for 'a data model' do
+  let(:mock_data_store) { mock 'data store data model' }
+  let(:mock_data_store_class) { mock 'data store data model', :instance => mock_data_store, :generate_unique_id => unique_id, :primary_key_identifier => primary_key }
+  let(:unique_id) { mock 'id' }
+  let(:primary_key) { "custom_id" }
+
+  before do
+    DataStoreConfig.stub(:data_store => mock_data_store_class)
+  end
+
+  describe "storing a data model" do
+    let(:mock_model) { mock 'a model', instance_values: data_field_attributes }
+
+    before do
+      mock_data_store.stub(:add)
+    end
+
+    it 'generates a unique id using the model as a salt' do
+      mock_data_store_class.should_receive(:generate_unique_id).with(mock_model).and_return(unique_id)
+
+      described_class.store(mock_model)
+    end
+
+    it 'adds the data model to the db store' do
+      mock_data_store.should_receive(:add).with(collection_name, HashWithIndifferentAccess.new({primary_key => unique_id}).merge(data_field_attributes))
+
+      described_class.store(mock_model)
+    end
+  end
+
+  describe "updating a data model" do
+    let(:data_model_id) { '1234567' }
+    let(:mock_model) { mock 'a model', id: data_model_id, instance_values: data_field_attributes }
+
+    before do
+      mock_data_store.stub(:replace)
+    end
+
+    it 'replaces the data model in the db store' do
+      mock_data_store.should_receive(:replace).with(collection_name, HashWithIndifferentAccess.new({primary_key => data_model_id}).merge(data_field_attributes))
+
+      described_class.update(mock_model)
+    end
+  end
+
+  describe "pushing a value to an array for a data model" do
+    let(:data_model_id) { '1234567' }
+
+    it 'replaces the data model in the db store' do
+      mock_data_store.should_receive(:push_to_array).with(collection_name, primary_key, data_model_id, :array_field, 'some value')
+
+      described_class.push_to_array(data_model_id, :array_field, 'some value')
+    end
+  end
+
+  describe "getting all data models with a specific value for a field" do
+    let(:mock_data_model) { {primary_key => 'some id'} }
+    let(:expected_data_models) { [HashWithIndifferentAccess.new({:id => 'some id', primary_key => 'some id'})] }
+    let(:mock_data_models) { [mock_data_model] }
+    subject { described_class.array_contains(:some_field, 'some value') }
+
+    it 'returns the stored data models with the requested field / value' do
+      mock_data_store.should_receive(:array_contains).with(collection_name, :some_field, 'some value').and_return(mock_data_models)
+
+      subject.should == expected_data_models
+    end
+  end
+
+  describe "removing a value from an array for a data model" do
+    let(:data_model_id) { '1234567' }
+
+    it 'removes the value from the array' do
+      mock_data_store.should_receive(:remove_from_array).with(collection_name, primary_key, data_model_id, :array_field, 'some value')
+
+      described_class.remove_from_array(data_model_id, :array_field, 'some value')
+    end
+  end
+
+  describe 'getting all of the data models' do
+    let(:mock_data_model) { {primary_key => 'some id'} }
+    let(:expected_data_models) { [HashWithIndifferentAccess.new({:id => 'some id', primary_key => 'some id'})] }
+    let(:mock_data_models) { [mock_data_model] }
+
+    it 'returns the stored data models' do
+      mock_data_store.should_receive(:find_all).with(collection_name).and_return(mock_data_models)
+
+      described_class.all.should == expected_data_models
+    end
+  end
+
+  describe "getting all the data fields by a parameter hash" do
+    let(:mock_data_model) { {primary_key => 'some id'} }
+    let(:expected_data_models) { [{:id => 'some id', primary_key => 'some id'}] }
+    let(:mock_data_models) { [mock_data_model] }
+    let(:expected_data_models) { [HashWithIndifferentAccess.new(mock_data_model)] }
+    let(:sample_hash) { {field1: nil, field2: 'not nil'} }
+
+    it 'passes the hash to the mock_data_store_class' do
+      mock_data_store.should_receive(:get_by_params).with(collection_name, sample_hash).and_return(mock_data_models)
+
+      described_class.all_by_fields(sample_hash).should == expected_data_models
+    end
+  end
+
+  describe "getting a record by a set of key values" do
+    let(:mock_data_model) { {primary_key => 'some id'} }
+    let(:mock_data_models) { [mock_data_model] }
+    let(:expected_data_models) { [{:id => 'some id', primary_key => 'some id'}] }
+
+    let(:sample_hash) { {field1: nil, field2: 'not nil'} }
+
+    it 'passes the hash to the mock_data_store_class' do
+      mock_data_store.should_receive(:get_by_params).with(collection_name, sample_hash).and_return(mock_data_models)
+
+      described_class.find_by_fields(sample_hash).should == HashWithIndifferentAccess.new(expected_data_models.first)
+    end
+  end
+
+  describe "getting all of the data models for a where a field contains any value of a given array of values" do
+    let(:mock_data_models) { [{primary_key => 'some id'}, {primary_key => 'some id 2'}] }
+    let(:expected_data_models) { [{"id" => 'some id', primary_key => 'some id'}, {"id" => 'some id 2', primary_key => 'some id 2'}] }
+
+    subject { described_class.containing_any(:some_field, ['value 1', 'value 2']) }
+
+    it 'returns the stored data models' do
+      mock_data_store.should_receive(:containing_any).with(collection_name, :some_field, ['value 1', 'value 2']).and_return(mock_data_models)
+
+      subject.should == expected_data_models
+    end
+  end
+
+  describe "getting all data models with a specific value for a field" do
+    let(:mock_data_models) { [{primary_key => 'some id'}, {primary_key => 'some id 2'}] }
+    let(:expected_data_models) { [HashWithIndifferentAccess.new({:id => 'some id', primary_key => 'some id'}), HashWithIndifferentAccess.new({id: 'some id 2', primary_key => 'some id 2'})] }
+    subject { described_class.all_by_field(:some_field, 'some value') }
+
+    it 'returns the stored data models with the requested field / value' do
+      mock_data_store.should_receive(:get_all_for_key_with_value).with(collection_name, :some_field, 'some value').and_return(mock_data_models)
+
+      subject.should == expected_data_models
+    end
+  end
+
+  describe 'getting a specific data model' do
+    let(:mock_data_model) { {primary_key => 'id', :id => 'id' } }
+
+    it 'returns the data model from the data store' do
+      mock_data_store.should_receive(:find).with(collection_name, primary_key, 'id').and_return(mock_data_model)
+
+      described_class.find(mock_data_model[:id]).should == HashWithIndifferentAccess.new(mock_data_model)
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: mince_data_model
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jason Mayer
+- Matt Simpson
+- Asynchrony Solutions
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &16308420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16308420
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &16307660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16307660
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &16305880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *16305880
+description: Interface for interchanging which type of data store to persist data
+  to
+email:
+- matt@railsgrammer.com
+- jason.mayer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- Gemfile
+- README.md
+- Rakefile
+- examples/guitar.rb
+- examples/guitar_data_model.rb
+- lib/data_store_config.rb
+- lib/mince_data_model.rb
+- lib/mince_data_model/version.rb
+- mince_data_model.gemspec
+- spec/guitar_data_model_spec.rb
+- spec/guitar_spec.rb
+- spec/support/shared_examples/mince_data_model_examples.rb
+homepage: https://github.com/asynchrony/mince_data_model
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mince_data_model
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Interface for interchanging which type of data store to persist data to
+test_files: []