persistent_hash 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8015f93dc2bd0290f4a1fbe5b3b08528993e571a
+  data.tar.gz: 180e92e79cc5c5f98647f40858ce609a1f7ba8ed
+SHA512:
+  metadata.gz: e8fcf4a150150491958841a3f3ab0deafaf3e9b4828d6aa3dc59cee56248ca9507e105ee6310e767d62b9fa8ae8c04e3e38a301766f66aa706d77b64ac34eff2
+  data.tar.gz: 8833ab36db95c372b7530fa1da83b36b55a7ecb94fa23b184ec49746269a48f09aee07e8854319b7375fd2337a6b3a70fefb5f57cd000010a2f99c30c9eb7471

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Alex Dean
+
+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/Rakefile

@@ -0,0 +1,20 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/models/persistent_hash/formatter.rb

@@ -0,0 +1,48 @@
+module PersistentHash
+
+  # Formatters are used to create the readable_value attribute for values
+  # stored in the Hash.
+  class Formatter
+
+    @formatters = {}
+
+    # specify how the human-readable version of the item should be generated
+    #
+    # @example
+    #   PersistentHash::Formatter.add(
+    #     Time,
+    #     ->(val) { val.iso8601 }
+    #   )
+    #
+    # @param [Class] clazz The formatter will receive instances of this class.
+    # @param [Proc]  proc  A proc which receives an instance of clazz and
+    #                      returns a string representation of that instance.
+    def self.add(clazz, proc)
+      @formatters[clazz] = proc
+      true
+    end
+
+    # create a human-readable version of value for storage in the db
+    #
+    # If a specific formattation proc has been supplied for the value's
+    # class via `add`, that proc will be invoked. Otherwise, the result of
+    # the value's `to_s` method will be returned.
+    #
+    # @return [String] A string representation of value.
+    def self.format(value)
+      formatter = @formatters[value.class]
+      if formatter
+        formatted = formatter.call(value)
+      else
+        formatted = value.to_s
+      end
+    end
+
+    # forget all current formatters
+    def self.reset!
+      @formatters = {}
+      true
+    end
+
+  end
+end

data/app/models/persistent_hash/hash.rb

@@ -0,0 +1,35 @@
+module PersistentHash
+  class Hash < ActiveRecord::Base
+
+    self.table_name = 'persistent_hash'
+
+    # save a value in the hash
+    def self.[]=(key_name, value)
+      where(key_name: key_name).delete_all
+
+      if ! value.nil?
+        formatted = PersistentHash::Formatter.format(value)
+
+        create!(
+          key_name: key_name,
+          readable_value: formatted,
+          marshalled: Base64.encode64(Marshal.dump(value))
+        )
+      end
+    end
+
+    # fetch a value from the hash.
+    #
+    # @return The requested value, or nil if the requested key does not exist.
+    def self.[](key_name)
+      value = nil
+      item = select(:marshalled).where(key_name: key_name).first
+      if item
+        value = Marshal.load(Base64.decode64(item.marshalled))
+      end
+
+      value
+    end
+
+  end
+end

data/db/migrate/20150518213536_create_persistent_hash.rb

@@ -0,0 +1,12 @@
+class CreatePersistentHash < ActiveRecord::Migration
+  def change
+    create_table :persistent_hash do |t|
+      t.string   :key_name, null: false
+      t.string   :readable_value, null: false
+      t.text     :marshalled, null: false
+      t.datetime :updated_at, null: false
+    end
+
+    add_index :persistent_hash, :key_name, unique: true
+  end
+end

data/lib/persistent_hash/engine.rb

@@ -0,0 +1,5 @@
+module PersistentHash
+  class Engine < ::Rails::Engine
+    isolate_namespace PersistentHash
+  end
+end

data/lib/persistent_hash/version.rb

@@ -0,0 +1,3 @@
+module PersistentHash
+  VERSION = "0.0.1"
+end

data/lib/persistent_hash.rb

@@ -0,0 +1,10 @@
+require "persistent_hash/engine"
+
+module PersistentHash
+  def self.[]=(key_name, value)
+    PersistentHash::Hash[key_name] = value
+  end
+  def self.[](key_name)
+    PersistentHash::Hash[key_name]
+  end
+end

data/lib/tasks/persistent_hash_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :persistent_hash do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: persistent_hash
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alex Dean
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: rspec-rails
+  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: timecop
+  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: Handy place to stick small bits of persistent data. Like redis if you
+  don't want to install redis.
+email:
+- alex@crackpot.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/models/persistent_hash/formatter.rb
+- app/models/persistent_hash/hash.rb
+- db/migrate/20150518213536_create_persistent_hash.rb
+- lib/persistent_hash.rb
+- lib/persistent_hash/engine.rb
+- lib/persistent_hash/version.rb
+- lib/tasks/persistent_hash_tasks.rake
+homepage: https://github.com/alexdean/persistent_hash
+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.3
+signing_key: 
+specification_version: 4
+summary: ActiveRecord-based key/value store for Rails applications.
+test_files: []