hashy_db 0.0.5 → 0.0.6

data/README.md

@@ -1,21 +1,54 @@
-# What is this?
+# What is hashy db?
 
 Light weight ORM to persist data to a hash. 
 
+Provides an interface for storing and retreiving information to a Hash.
+
+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/HashyDB)
+[@rubygems](https://rubygems.org/gems/hashy_db)
+
+# How to use
+
+view the [example mince rails app](https://github.com/coffeencoke/mince_rails_example) to see how to use this.
+
+Basic usage is to create a constant called DB_HASH and set it to an empty hash in an initializer file, or whenever your application gets loaded (if you're not running rails).
+
+<pre>
+# initializers/datastore.rb
+::DB_HASH = {}
+</pre>
+
+From there you can use Hashy Db to add and retrieve data.
+
+<pre>
+# Add a book to the books collection
+HashyDb::DataStore.add 'books', title: 'The World In Photographs', publisher: 'National Geographic'
+
+# Retrieve all records from the books collection
+HashyDb::DataStore.find_all 'books'
+
+# Update a field with a value for a specific record
+HashyDb::DataStore.update_field_with_value 'books', 'primary_id_123', :field_name, 'value to update with'
+
+# Replace a specific book
+HashyDb::DataStore.replace 'books', id: 1, title: 'A World In Photographs', publisher: 'National Geographic'
+</pre>
+
+View the [data_store.rb](https://github.com/asynchrony/hashy_db/blob/master/lib/hashy_db/data_store.rb) file for all methods available.
+
+Use with [mince data model](https://github.com/asynchrony/mince_data_model) to make it easy to change from one data storage to another, like [Mince](https://github.com/asynchrony/mince), a MongoDB implementation.
+
+
 # Why would you want this?
 
 - To defer choosing your database until you know most about your application.
 - Provides assitance in designing a database agnostic architecture.
+- Offers very little technical dependencies.  In order to develop or run the tests for your application you just need ruby installed, run bundle install and you're good to go.  No need to install and start your database, migrate, etc.
 
 The hash can be loaded in memory and be used as your data store.  
 
-Example in a rails app:
-
-initializers/datastore.rb
-
-`
-::DB_HASH = {}
-`
 # Contribute
 
 - fork into a topic branch, write specs, make a pull request.
@@ -23,9 +56,10 @@ initializers/datastore.rb
 # Owners
 
 Matt Simpson - [@railsgrammer](https://twitter.com/railsgrammer)
-<br />
+
 Jason Mayer - [@farkerhaiku](https://twitter.com/farkerhaiku)
 
 # Contributors
 
 David Czarnecki - [@czarneckid](https://twitter.com/czarneckid)
+Amos King - [@adkron](https://twitter.com/adkron)

data/lib/hashy_db/data_store.rb

@@ -25,6 +25,10 @@ module HashyDb
       collection[index] =  hash
     end
 
+    def update_field_with_value(collection_name, primary_key_value, field_name, new_value)
+      find(collection_name, :id, primary_key_value)[field_name] = new_value
+    end
+
     def get_all_for_key_with_value(collection_name, key, value)
       find_all(collection_name).select { |a| a[key] == value }
     end
@@ -96,4 +100,4 @@ module HashyDb
       @data_store ||= ::DB_HASH
     end
   end
-end
+end

data/lib/hashy_db/version.rb

@@ -1,3 +1,3 @@
 module HashyDb
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/spec/lib/data_store_spec.rb

@@ -50,6 +50,12 @@ describe HashyDb::DataStore do
     subject.find(:some_collection, :id, 2)[:field_1].should == 'value modified'
   end
 
+  it 'can update a field with a value on a specific record' do
+    subject.update_field_with_value(:some_collection, 3, :field_2, '10')
+    
+    subject.find(:some_collection, :id, 3)[:field_2].should == '10'
+  end
+
   it 'can get one document' do
     subject.find(:some_collection, :field_1, 'value 1').should == data1
     subject.find(:some_collection, :field_2, 6).should == data2
@@ -100,4 +106,4 @@ describe HashyDb::DataStore do
   it 'can get a record for a specific key and value' do
     subject.get_for_key_with_value(:some_collection, :field_1, 'value 1').should == data1
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashy_db
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   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: activesupport
-  requirement: &70323341342760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -23,10 +23,15 @@ dependencies:
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70323341342760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70323341342040 !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: *70323341342040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70323341340960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,7 +55,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70323341340960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Provides an interface to store and retrieve data in a Hash.
 email:
 - matt@railsgrammer.com
@@ -56,7 +71,6 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
-- .rvmrc
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -86,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: hashy_db
-rubygems_version: 1.8.10
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Provides an interface to store and retrieve data in a Hash.

data/.rvmrc

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