memory_storage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56311d5feeccda10214e8278a96cd5f59cef2d83
+  data.tar.gz: 081354bddac2a3620662535637b11d17085b9f3d
+SHA512:
+  metadata.gz: d254c7960a4671c86049ae5e05c1979aa828117226620ca58365fb40590aad42d51524b2d6f668d190c3e2694046882b355d6623b10c55439f5bb18036bbb21a
+  data.tar.gz: 927835ff4c49e255afb83d68c9edb687b836876a0bdb37484c48aaa350320dbcaa8026dbb3103c2b1ddd6bd1ebf08ae6f14579570e9994be3b131d64d364c353

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+Gemfile.lock
+InstalledFiles
+coverage
+
+
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fernando Martínez
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# MemoryStorage
+
+A very simple in memory storage utility class.
+
+## Installation
+
+Add the gem to your Gemfile
+
+```ruby
+gem 'memory_storage'
+```
+
+## Usage
+
+The only requirement to store objects with MemoryStorage is that persistent
+objects must respond to `#id`
+
+Examples:
+ 
+```ruby
+class Item
+  attr_accessor :id, :name, :amount
+
+  def initialize(id, name, amount)
+    @id = id
+    @name = name
+    @amount = amount
+  end
+end
+
+item = Item.new(1, 'Item one', 10)
+
+# saving an object
+MemoryStorage.save(item)
+
+# retrieving object by id
+MemoryStorage.find(1) #=> <Item @id: 1 @name: 'Item one' @amount: 10>
+
+# retrieving all stored objects
+MemoryStorage.all #=> [<Item @id: 1 @name: 'Item one'  @amount: 10>]
+```
+
+## Enumerable
+
+MemoryStorage includes Enumerable, so every method defined in Enumerable can be
+used:
+
+```ruby
+MemoryStorage.save(Item.new(1,'one', 1))
+MemoryStorage.save(Item.new(2,'one', 2))
+MemoryStorage.save(Item.new(3,'one', 3))
+
+MemoryStorage.inject(0) {|sum, item| sum + item.amount } #=> 6
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+See the [LICENSE](https://github.com/F-3r/memory_storage/blob/master/LICENSE).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs = ["lib"]
+  t.warning = true
+  t.verbose = true
+  t.test_files = FileList['spec/*_spec.rb']
+end
+
+task default: :test

data/lib/memory_storage.rb

@@ -0,0 +1,31 @@
+class MemoryStorage
+  VERSION = '0.0.1'
+
+  extend Enumerable
+
+  class << self
+    def save(object, identifier_method = :id)
+      storage[object.send identifier_method] = object
+    end
+
+    def find(identifier)
+      storage[identifier]
+    end
+
+    def flush
+      @storage = {}
+    end
+
+    def all
+      storage.values
+    end
+
+    def each(&block)
+      storage.values.each &block
+    end
+
+    def storage
+      @storage ||= {}
+    end
+  end
+end

data/memory_storage.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'memory_storage'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'memory_storage'
+  spec.version       = MemoryStorage::VERSION
+  spec.authors       = ['f-3r']
+  spec.email         = ['']
+  spec.description   = 'Basic in memory persistence for fast prototyping'
+  spec.summary       = 'Basic in memory persistence for fast prototyping'
+  spec.homepage      = 'https://github.com/F-3r/memory_storage'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+end

data/spec/memory_storage_spec.rb

@@ -0,0 +1,61 @@
+require 'minitest/autorun'
+require 'memory_storage'
+
+Item = Struct.new(:id, :name)
+
+describe MemoryStorage do
+  before do
+    MemoryStorage.flush
+  end
+
+  let :item do
+    Item.new 1, 'item name'
+  end
+
+  describe '::save' do
+    before do
+      MemoryStorage.save item
+    end
+
+    it 'stores the object' do
+      MemoryStorage.storage[1].must_equal item
+    end
+
+    it 'overwrites object under the same key' do
+      MemoryStorage.save Item.new(1, 'other item')
+      MemoryStorage.storage[1].name.must_equal 'other item'
+    end
+  end
+
+  describe '::find' do
+    it 'retrieves the object under id' do
+      MemoryStorage.save item
+      MemoryStorage.find(1).must_equal item
+    end
+
+    it 'returns nil if there is no object under such key' do
+      MemoryStorage.find(1).must_be_nil
+    end
+  end
+
+  describe '::all' do
+    it 'returns all stored object in an array' do
+      MemoryStorage.save item
+      MemoryStorage.all.must_equal [item]
+    end
+
+    it 'returns empty array if theres no objects in the store' do
+      MemoryStorage.all.must_equal []
+    end
+  end
+
+  describe 'includes enumerable' do
+    before do
+      MemoryStorage.save item
+    end
+
+    it 'can be injected' do
+      MemoryStorage.inject(0) { |sum, item| sum + item.id }.must_equal 1
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: memory_storage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- f-3r
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-06 00:00:00.000000000 Z
+dependencies: []
+description: Basic in memory persistence for fast prototyping
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/memory_storage.rb
+- memory_storage.gemspec
+- spec/memory_storage_spec.rb
+homepage: https://github.com/F-3r/memory_storage
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Basic in memory persistence for fast prototyping
+test_files:
+- spec/memory_storage_spec.rb