ramdo 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cec4df65cd2840f109a7205163af45c47a64df4b
+  data.tar.gz: 5e19b6915b85392c75a7868058952a8a0db75c6e
+SHA512:
+  metadata.gz: 39ddd3e6dca71a664eaffd8224571bbd07878d57dd719d45ecbb859661b1387cf7397a06590e61efafb988bb7a48dea73f2433cc0431b3e54daeb070f1154376
+  data.tar.gz: 1d3e76937dfa7c108c56cfd8f5e7093f641358a5aba78bdf18d3f930a5a49aed3ea34b8626e7f1aea318b44705f48ff95d60c5f841ac019a8101b5d61249a2e1

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    ramdo (0.0.2)
+      cocaine
+      filesize
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.2)
+    climate_control (0.0.3)
+      activesupport (>= 3.0)
+    cocaine (0.5.8)
+      climate_control (>= 0.0.3, < 1.0)
+    concurrent-ruby (1.0.2)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    filesize (0.1.1)
+    geminabox (0.12.4)
+      builder
+      faraday
+      httpclient (>= 2.2.7)
+      nesty
+      sinatra (>= 1.2.7)
+    httpclient (2.7.0.1)
+    i18n (0.7.0)
+    minitest (5.9.0)
+    multipart-post (2.0.0)
+    nesty (1.0.2)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    thread_safe (0.3.5)
+    tilt (1.4.1)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  geminabox
+  rake
+  ramdo!
+  rspec
+  yard
+
+BUNDLED WITH
+   1.12.4

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Patrick Franken
+
+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,47 @@
+# Ramdo
+
+Fast temporary store supported by RAM disks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ramdo'
+```
+
+And then execute:
+
+    $ bundle
+
+## How to use
+
+Acutally quite simple
+
+```ruby
+require 'ramdo'
+store = Ramdo::Store.new
+store.data = 'Some Data'
+
+puts `cat #{store.file}`
+# Some Data
+
+puts store.data
+# Some Data
+
+```
+
+
+## Low-level API usage
+### Create a new RAM disk
+
+```ruby
+require 'ramdo'
+wrapper = Ramdo::Ramdisk::Factory.get
+disk = wrapper.create('100 mb')
+
+IO.write(disk.path + '/test_file', 'some important data')
+```
+
+
+by Patrick Franken, created through Tamyca FunFriday 29.07.2016

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/ramdo/ramdisk/darwin_wrapper.rb

@@ -0,0 +1,64 @@
+module Ramdo
+  module Ramdisk
+    class DarwinWrapper
+      def initialize
+      end
+
+      def list
+        disks = []
+
+        line = Cocaine::CommandLine.new("hdiutil", "info")
+        line.run.each_line do |line|
+          if line =~ /^[=]+$/
+            disks << {}
+          elsif line =~ /^image-path[\s]+:[\s]+(ram:\/\/[0-9]+)/
+            disks.last[:is_ram_disk] = true
+          elsif line =~ /^(\/dev\/disk[0-9]+)[\s]+(\/Volumes\/[A-Za-z0-9_-]+)/
+            disks.last[:path] = Regexp.last_match[2].strip
+            disks.last[:device] = Regexp.last_match[1].strip
+          elsif line =~ /^blockcount[\s]+:[\s]+([0-9]+)/
+            size_in_mb = Regexp.last_match[1].to_i / 2048
+            disks.last[:size] = Filesize.from("#{size_in_mb} MB")
+          end
+        end
+
+        disks.map { |d| Instance.new(d) if d.has_key? :is_ram_disk }.compact
+      end
+
+      def create(size)
+        size = Filesize.from(size) if size.is_a? String
+        raise NotEnoughFreeRamException.new unless enough_ram? size
+
+        # Allocate new RAM space
+        line = Cocaine::CommandLine.new("hdiutil", "attach -nomount ram://#{(size.to('MB') * 2048).to_i}")
+        device = line.run
+        device.strip!
+
+        # Format RAM disk
+        line = Cocaine::CommandLine.new("diskutil", "erasevolume HFS+ '#{Instance.generate_name}' #{device}")
+        line.run
+
+        # Receive all disk and select just created one
+        list().select { |disk| disk.device == device }.first
+      end
+
+      private
+      def enough_ram?(size)
+        size = Filesize.from(size) if size.is_a? String
+        pages_free = 0
+        page_size = 0
+
+        line = Cocaine::CommandLine.new("vm_stat")
+        line.run.each_line do |line|
+          if line =~ /^Pages free:[\s]+([0-9]+)./
+            pages_free = Regexp.last_match[1].to_i
+          elsif line =~ /^Mach Virtual Memory Statistics: +\(page size of ([0-9]+) bytes\)/
+            page_size = Regexp.last_match[1].to_i
+          end
+        end
+
+        Filesize.new(pages_free * page_size) > size
+      end
+    end
+  end
+end

data/lib/ramdo/ramdisk/exceptions.rb

@@ -0,0 +1,6 @@
+module Ramdo
+  module Ramdisk
+    class OSNotSupportedException < StandardError; end
+    class NotEnoughFreeRamException < StandardError; end
+  end
+end

data/lib/ramdo/ramdisk/factory.rb

@@ -0,0 +1,16 @@
+module Ramdo
+  module Ramdisk
+    class Factory
+      def self.get
+        if RUBY_PLATFORM =~ /linux_not_implemented_yet/
+          LinuxWrapper.new
+        elsif RUBY_PLATFORM =~ /darwin/
+          DarwinWrapper.new
+        else
+          raise OSNotSupportedException.new("Could not find Ramdisk wrapper for #{RUBY_PLATFORM}")
+        end
+      end
+    end
+
+  end
+end

data/lib/ramdo/ramdisk/instance.rb

@@ -0,0 +1,24 @@
+module Ramdo
+  module Ramdisk
+    class Instance
+      def self.generate_name
+        "ramdo_#{SecureRandom.uuid}"
+      end
+
+      attr_accessor :device, :path, :size
+
+      def initialize(info = {})
+        @device = info[:device]
+        @path = info[:path]
+        @size = info[:size]
+      end
+
+      def destroy!
+        return false unless File.exist? @device
+
+        line = Cocaine::CommandLine.new("hdiutil", "detach :device")
+        line.run(device: @device)
+      end
+    end
+  end
+end

data/lib/ramdo/ramdisk/linux_wrapper.rb

@@ -0,0 +1,7 @@
+module Ramdo
+  module Ramdisk
+    class LinuxWrapper
+
+    end
+  end
+end

data/lib/ramdo/store.rb

@@ -0,0 +1,34 @@
+module Ramdo
+  class Store
+    attr_reader :file, :uuid
+
+    def initialize
+      wrapper = Ramdisk::Factory.get
+      list = wrapper.list
+      if list.length <= 0
+        # Create a new Ramdisk
+        @disk = wrapper.create(DEFAULT_RAMDISK_SIZE)
+      else
+        # Use one which is large enough
+        list.each { |disk| @disk = disk if disk.size >= Filesize.from(DEFAULT_RAMDISK_SIZE) }
+        @disk = wrapper.create(DEFAULT_RAMDISK_SIZE) if @disk.nil?
+      end
+
+      @uuid = SecureRandom.uuid
+      @filename = 'ramdo_' + @uuid
+      @file = [@disk.path, @filename].join('/') # No Windows support!
+    end
+
+    def data=(data)
+      IO.write(@file, data)
+    end
+
+    def data
+      IO.read(@file)
+    end
+
+    def truncate
+      File.delete(@file)
+    end
+  end
+end

data/lib/ramdo/version.rb

@@ -0,0 +1,3 @@
+module Ramdo
+  VERSION = '0.1.1'
+end

data/lib/ramdo.rb

@@ -0,0 +1,16 @@
+require 'cocaine'
+require 'pp'
+require 'filesize'
+require 'securerandom'
+
+require 'ramdo/version'
+require 'ramdo/ramdisk/exceptions'
+require 'ramdo/ramdisk/factory'
+require 'ramdo/ramdisk/instance'
+require 'ramdo/ramdisk/darwin_wrapper'
+require 'ramdo/ramdisk/linux_wrapper'
+require 'ramdo/store'
+
+module Ramdo
+  DEFAULT_RAMDISK_SIZE = '100mb'
+end

data/ramdo.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ramdo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ramdo"
+  spec.version       = Ramdo::VERSION
+  spec.authors       = ["Patrick Franken"]
+  spec.email         = ["p.franken@aisler.net"]
+  spec.summary       = "Fast temporary store supported by RAM disks"
+  spec.description   = spec.summary
+  spec.homepage      = "http://aisler.net"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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"]
+
+  spec.add_runtime_dependency 'cocaine'
+  spec.add_runtime_dependency 'filesize'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "geminabox"
+  spec.add_development_dependency "yard"
+end

data/spec/ramdisk_factory_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+include Ramdo
+describe Ramdisk::Factory do
+  after(:each) do
+    wrapper = Ramdisk::Factory.get
+    wrapper.list.each do |disk|
+      disk.destroy!
+    end
+  end
+
+
+  it 'should check if a ramdisk already exists' do
+    wrapper = Ramdisk::Factory.get
+    disks = wrapper.list
+    expect(disks).to be_an(Array)
+    expect(disks.length).to be(0)
+  end
+
+  it 'should check if enough RAM space is free' do
+    wrapper = Ramdisk::Factory.get
+    expect(wrapper.send(:enough_ram?, '100 MB')).to be_truthy
+    expect(wrapper.send(:enough_ram?, '100 GB')).to be_falsey
+  end
+
+  it 'should create a new RAM disk and save a file to it' do
+    size = '100 MB'
+
+    wrapper = Ramdisk::Factory.get
+    disk = wrapper.create(size)
+
+    expect(disk).to be_an(Ramdisk::Instance)
+    expect { IO.write("#{disk.path}/test.bin", IO.read('/dev/urandom', 100000)) }.not_to raise_error
+    expect(disk.size).to eq(Filesize.from(size))
+  end
+
+  it 'should remove a RAM disk' do
+    wrapper = Ramdisk::Factory.get
+    disk = wrapper.create('100 MB')
+
+    count = wrapper.list.length
+    expect(disk.destroy!).to be_truthy
+    expect(disk.destroy!).to be_falsey # Should not work another time
+
+    expect(wrapper.list.length).to be(count - 1)
+  end
+
+  it 'should list all available RAM disks' do
+    wrapper = Ramdisk::Factory.get
+    disk = wrapper.create('100 MB')
+
+    list = wrapper.list
+    expect(list.length).to eq(1)
+    expect(list.first.device).not_to be_empty
+    expect(File.exist?(list.first.device)).to be_truthy
+    expect(Dir.exist?(list.first.path)).to be_truthy
+    expect(list.first.size).to eq(Filesize.from('100 MB'))
+
+    disk = wrapper.create('200 MB')
+
+    list = wrapper.list
+    expect(list.length).to eq(2)
+    expect(list.last.device).not_to be_empty
+    expect(File.exist?(list.last.device)).to be_truthy
+    expect(Dir.exist?(list.last.path)).to be_truthy
+    expect(list.last.size).to eq(Filesize.from('200 MB'))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'ramdo'

data/spec/store_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+include Ramdo
+describe Store do
+  after(:all) do
+    wrapper = Ramdisk::Factory.get
+    wrapper.list.each do |disk|
+      disk.destroy!
+    end
+  end
+
+  it 'should create a new store and append data to it' do
+    test_data = 'make me sexy'
+
+    store = Store.new
+    store.data = test_data
+
+    expect(IO.read(store.file)).to eq(test_data)
+    expect(store.data).to eq(test_data)
+  end
+
+  it 'should create a new store and write data to it' do
+    test_data = 'make me sexy'
+
+    store = Store.new
+    IO.write(store.file, test_data)
+
+    expect(IO.read(store.file)).to eq(test_data)
+    expect(store.data).to eq(test_data)
+  end
+
+  it 'should be able to truncate any data' do
+    store = Store.new
+    store.data = 'Test'
+    store.truncate
+    expect(File.exist?(store.file)).to be_falsey
+  end
+
+  it 'should use existing RAM disk if available' do
+    wrapper = Ramdisk::Factory.get
+
+    wrapper.list.each { |disk| disk.destroy! }
+    expect(wrapper.list.length).to eq(0)
+    store_1 = Store.new
+    expect(wrapper.list.length).to eq(1)
+    store_2 = Store.new
+    expect(wrapper.list.length).to eq(1)
+  end
+
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: ramdo
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Patrick Franken
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocaine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: filesize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: geminabox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fast temporary store supported by RAM disks
+email:
+- p.franken@aisler.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ramdo.rb
+- lib/ramdo/ramdisk/darwin_wrapper.rb
+- lib/ramdo/ramdisk/exceptions.rb
+- lib/ramdo/ramdisk/factory.rb
+- lib/ramdo/ramdisk/instance.rb
+- lib/ramdo/ramdisk/linux_wrapper.rb
+- lib/ramdo/store.rb
+- lib/ramdo/version.rb
+- ramdo.gemspec
+- spec/ramdisk_factory_spec.rb
+- spec/spec_helper.rb
+- spec/store_spec.rb
+- tmp/.gitkeep
+homepage: http://aisler.net
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Fast temporary store supported by RAM disks
+test_files:
+- spec/ramdisk_factory_spec.rb
+- spec/spec_helper.rb
+- spec/store_spec.rb
+has_rdoc: