mince_data_model 0.0.1 → 0.0.2

data/README.md

@@ -1,27 +1,44 @@
-# What is this?
 
-Provides a very lightweight interface to store and retrieve data in MongoDB in Ruby.
+# What Iz Mince Data Model?
 
-# Why would you want this?
+Some niceties and defines an implementation to swap out different data persistance strategies.  Currently there are 2 supported data persistance strategies: Mince (MongoDB), and HashyDB (in memory hash). If using this gem, all you need to do in order to change the data persistence strategy is to implement the methods outlined by this gem.  Check out the [Mince Data Store](https://github.com/asynchrony/mince/blob/master/lib/mince/data_store.rb) and the [HashyDB Data Store](https://github.com/asynchrony/HashyDB/blob/master/lib/hashy_db/data_store.rb) for a list of methods to implement.
 
-- To build a non-active-record implementation application using MongoDB.
-- Allows interchanging data persistence with HashyDb
+# Why?
 
-# Todos
+A little background perhaps...
 
-- Remove rails dependency
-- Add a better readme
+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.
 
-# Contribute
+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.
 
-- fork into a topic branch, write specs, make a pull request.
+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.
 
-# Owners
+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!
 
-Matt Simpson - [@railsgrammer](https://twitter.com/railsgrammer)
-<br />
-Jason Mayer - [@farkerhaiku](https://twitter.com/farkerhaiku)
+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.
 
-# Contributors
-- Your name here!
+Form more info about the inspiration behind Mince Data Store:
 
+- [Uncle Bob Martin's Ruby Midwest 2011 talk](http://confreaks.com/videos/759-rubymidwest2011-keynote-architecture-the-lost-years)
+- [Avdi Grimm's Objects On Rails book](http://devblog.avdi.org/2011/11/15/early-access-beta-of-objects-on-rails-now-available-2/)
+- [Working with guys at Asynchrony](http://asynchrony.com)
+
+# Rails Implementation Example
+
+[This mince rails example application](https://github.com/coffeencoke/mince_rails_example) is available to reveal A way to implement the use of the Mince Data Store, [Mince](https://github.com/asynchrony/mince), and [Hashy Db](https://github.com/asynchrony/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](https://github.com/asynchrony/mince)
+[@rubygems](https://rubygems.org/gems/mince)
+
+# 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](https://github.com/asynchrony/hashy_db)
+[@rubygems](https://rubygems.org/gems/hashy_db)

data/lib/mince_data_model/version.rb

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

data/lib/mince_data_model.rb

@@ -67,7 +67,11 @@ module MinceDataModel
 
     def find_by_fields(hash)
       translate_from_data_store all_by_fields(hash).first
-    end
+    end                 
+
+    def find_by_field(field, value)
+      translate_from_data_store data_store.instance.get_for_key_with_value(data_collection, field, value)
+    end                 
 
     def containing_any(field, values)
       translate_each_from_data_store data_store.instance.containing_any(data_collection, field, values)

data/spec/support/shared_examples/mince_data_model_examples.rb

@@ -95,12 +95,11 @@ shared_examples_for 'a data model' do
     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)
+      mock_data_store.should_receive(:get_all_for_key_with_value).with(collection_name, :field2, 'not nil').and_return(mock_data_models)
 
-      described_class.all_by_fields(sample_hash).should == expected_data_models
+      described_class.all_by_field(:field2, 'not nil').should == expected_data_models
     end
   end
 
@@ -131,6 +130,17 @@ shared_examples_for 'a data model' do
     end
   end
 
+  describe "getting a record by a key and value" do
+    let(:mock_data_model) { {primary_key => 'some id'} }
+    let(:expected_data_model) { {:id => 'some id', primary_key => 'some id'} }
+
+    it 'returns the correct data model' do
+      mock_data_store.should_receive(:get_for_key_with_value).with(collection_name, :field2, 'not nil').and_return(mock_data_model)
+
+      described_class.find_by_field(:field2, 'not nil').should == HashWithIndifferentAccess.new(expected_data_model)
+    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'})] }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mince_data_model
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-02 00:00:00.000000000 Z
+date: 2012-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &16308420 !ruby/object:Gem::Requirement
+  requirement: &70291511198100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16308420
+  version_requirements: *70291511198100
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &16307660 !ruby/object:Gem::Requirement
+  requirement: &70291511197560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *16307660
+  version_requirements: *70291511197560
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &16305880 !ruby/object:Gem::Requirement
+  requirement: &70291511196880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,7 +45,7 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *16305880
+  version_requirements: *70291511196880
 description: Interface for interchanging which type of data store to persist data
   to
 email:
@@ -94,4 +94,7 @@ 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: []
+test_files:
+- spec/guitar_data_model_spec.rb
+- spec/guitar_spec.rb
+- spec/support/shared_examples/mince_data_model_examples.rb