mince_data_model 0.0.2 → 0.0.3

data/README.md

@@ -1,7 +1,50 @@
-
 # What Iz Mince Data Model?
 
-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.
+Mince Data Model provides the ability to switch between different databases for different environments.
+
+It supports the following data stores:
+
+- [mince_dynamo_db](https://github.com/coffeencoke/mince_dynamo_db) - Stores and retrieves data from Amazon's DynamoDB
+- [mince](https://github.com/asynchrony/mince) - Stores and retrieves data from MongoDB
+- [hashy_db](https://github.com/asynchrony/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
+
+```ruby
+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
+
+```ruby
+Rails.application.config.data_store = 'mince_dynamo_db/data_store'
+```
+You must have the data store gem installed.
+
+## Start storing and retrieving data
+
+```ruby
+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](https://github.com/asynchrony/mince_data_model/wiki/ways-to-set-the-data-store)
 
 # Why?
 
@@ -42,3 +85,12 @@ The motivation behind this is so you can clone the repository down, have ruby in
 
 [@github](https://github.com/asynchrony/hashy_db)
 [@rubygems](https://rubygems.org/gems/hashy_db)
+
+# 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](https://github.com/coffeencoke/mince_dynamo_db)
+[@rubygems](https://rubygems.org/gems/mince_dynamo_db)

data/lib/mince_data_model/version.rb

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

data/lib/mince_data_model.rb

@@ -41,6 +41,10 @@ module MinceDataModel
       end
     end
 
+    def update_field_with_value(id, field, value)
+      data_store.instance.update_field_with_value(data_collection, id, field, value)
+    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
@@ -167,4 +171,4 @@ module MinceDataModel
   def field_exists?(field)
     model.respond_to?(field) && !model.send(field).nil?
   end
-end
+end

data/spec/support/shared_examples/mince_data_model_examples.rb

@@ -45,6 +45,16 @@ shared_examples_for 'a data model' do
     end
   end
 
+  describe 'updating a specific field for a data model' do
+    let(:data_model_id) { '1234567' }
+    
+    it 'has the data store update the field' do
+      mock_data_store.should_receive(:update_field_with_value).with(collection_name, data_model_id, :some_field, 'some value')
+
+      described_class.update_field_with_value(data_model_id, :some_field, 'some value')
+    end
+  end
+
   describe "pushing a value to an array for a data model" do
     let(:data_model_id) { '1234567' }
 
@@ -162,4 +172,4 @@ shared_examples_for 'a data model' do
       described_class.find(mock_data_model[:id]).should == HashWithIndifferentAccess.new(mock_data_model)
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mince_data_model
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-03 00:00:00.000000000 Z
+date: 2012-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70291511198100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70291511198100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70291511197560 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +39,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70291511197560
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70291511196880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -45,7 +55,12 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70291511196880
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: Interface for interchanging which type of data store to persist data
   to
 email:
@@ -57,7 +72,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .rvmrc
 - Gemfile
 - README.md
 - Rakefile
@@ -90,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mince_data_model
-rubygems_version: 1.8.10
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Interface for interchanging which type of data store to persist data to

data/.rvmrc

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