localstore 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75a0f31d41f3a25e79784f76c5801a7805203113
+  data.tar.gz: c707c8a66d4f2501fc3602bf3eebd41c56d1d3d8
+SHA512:
+  metadata.gz: 633d2c10d8b1eb91101e7180c85f13b6d8981a4d5336bce373ca0d8e67c00df377efedf39c3458335b2f8ae40011f770ad9065f8183d7690270374c1d4f00395
+  data.tar.gz: dbff138aa1c5c0f01f58ed7a1ed757ebfc8d1ac40755b3ecf2bf4918732d7de99812edf5fbb5f27175b4a6d0a8337dae64810e5ff739109a2e270c4fcb9a9273

data/Rakefile

@@ -0,0 +1,20 @@
+# File: Rakefile
+# Time-stamp: <2018-12-13 11:06:32>
+# Copyright (C) 2018 Pierre Lecocq
+# Description: LocalStore rake tasks
+
+task default: :spec
+
+# Spec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+# Yard
+
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end

data/lib/localstore.rb

@@ -0,0 +1,119 @@
+# File: localstore.rb
+# Time-stamp: <2018-12-14 08:16:38>
+# Copyright (C) 2018 Pierre Lecocq
+# Description: LocalStore module for classes
+
+# Provides a class level local data store with namespaces support.
+#
+# API:
+#
+# When calling `localstore` at the top of a class definition, class and instance methods are created automatically:
+#
+# - <namespace>_store(key, value) to store data in the local store
+# - <namespace>_fetch(key = nil) to fetch data from the local store
+# - <namespace>_flush to flush data from the local store
+#
+# @example Local storage from class and instance methods
+#
+#     require 'localstore'
+#
+#     class TestLocalStore
+#       extend LocalStore
+#
+#       # Initialize namespace
+#       localstore :test
+#     end
+#
+#     # Class methods#
+#     TestLocalStore.test_store :hello, 'world'
+#     p TestLocalStore.test_fetch :hello
+#     p TestLocalStore.test_fetch
+#     TestLocalStore.test_flush
+#     p TestLocalStore.test_fetch
+#
+#
+#     # Instance methods
+#     obj = TestLocalStore.new
+#     obj.test_store :hello2, 'world2'
+#     p obj.test_fetch :hello2
+#     p obj.test_fetch
+#     obj.test_flush
+#     p obj.test_fetch
+#
+module LocalStore
+  # Library name
+  NAME = 'localstore'.freeze
+
+  # Semantic version number
+  VERSION = [0, 5, 0].join '.'
+
+  # @!visibility private
+  attr_reader :_local_store
+
+  # Create a new namespace in the local store and create dynamic class methods
+  # to interact with the store
+  #
+  # @param namespace [Symbol, String] namespace to create
+  def localstore(namespace)
+    localstores namespace
+  end
+
+  # Create multiple new namespaces in the local store and create dynamic class
+  # methods to interact with the store
+  #
+  # @param namespaces [Array<Symbol>, Array<String>] namespaces to create
+  def localstores(*namespaces)
+    namespaces.each do |namespace|
+      @_local_store ||= {}
+      @_local_store[namespace] ||= {}
+
+      create_class_methods namespace
+      create_instance_methods namespace
+    end
+  end
+
+  # Create class metods according to the namespace
+  #
+  # @api private
+  #
+  # @param namespace [Symbol, String]
+  def create_class_methods(namespace)
+    self.class.send :define_method, "#{namespace}_store" do |key, value|
+      @_local_store[namespace][key] = value
+    end
+
+    self.class.send :define_method, "#{namespace}_fetch" do |key = nil|
+      return @_local_store[namespace] if key.nil?
+
+      @_local_store[namespace].fetch key
+    end
+
+    self.class.send :define_method, "#{namespace}_flush" do
+      @_local_store[namespace] = {}
+    end
+  end
+
+  # Create instance methods according to a namespace.
+  # They are only proxy methods to class methods
+  #
+  # @api private
+  #
+  # @param namespace [Symbol, String]
+  def create_instance_methods(namespace)
+    define_method "#{namespace}_store" do |key, value|
+      self.class.send "#{namespace}_store", key, value
+    end
+
+    define_method "#{namespace}_fetch" do |key = nil|
+      self.class.send "#{namespace}_fetch", key
+    end
+
+    define_method "#{namespace}_flush" do
+      self.class.send "#{namespace}_flush"
+    end
+  end
+end
+
+# https://6ftdan.com/allyourdev/2015/02/24/writing-methods-for-both-class-and-instance-levels/
+# http://railstic.com/2011/06/dynamically-defining-methods-with-define_method/
+# http://paulsturgess.co.uk/blog/2018/01/09/ruby-metaprogramming-define-method-and-instance-exec/

data/spec/localstore_spec.rb

@@ -0,0 +1,58 @@
+# File: localstore_spec.rb
+# Time-stamp: <2018-12-14 08:08:11>
+# Copyright (C) 2018 Pierre Lecocq
+# Description: LocalStore module spec
+
+require_relative '../lib/localstore'
+
+describe LocalStore do
+  before :all do
+    class TestLocalStore
+      extend LocalStore
+
+      localstore :test
+    end
+  end
+
+  it 'checks class methods' do
+    expect(TestLocalStore).to respond_to :test_store
+    expect(TestLocalStore).to respond_to :test_fetch
+    expect(TestLocalStore).to respond_to :test_flush
+  end
+
+  it 'checks instance methods' do
+    obj = TestLocalStore.new
+
+    expect(obj).to respond_to :test_store
+    expect(obj).to respond_to :test_fetch
+    expect(obj).to respond_to :test_flush
+  end
+
+  it 'checks local store from class methods calls' do
+    TestLocalStore.test_store :key_1, '1'
+    TestLocalStore.test_store :key_2, '2'
+
+    expect(TestLocalStore.test_fetch(:key_1)).to be == '1'
+    expect(TestLocalStore.test_fetch(:key_2)).to be == '2'
+    expect(TestLocalStore.test_fetch).to be == { key_1: '1', key_2: '2' }
+
+    TestLocalStore.test_flush
+
+    expect(TestLocalStore.test_fetch).to be == {}
+  end
+
+  it 'checks local store from instance methods calls' do
+    obj = TestLocalStore.new
+
+    obj.test_store :key_3, '3'
+    obj.test_store :key_4, '4'
+
+    expect(obj.test_fetch(:key_3)).to be == '3'
+    expect(obj.test_fetch(:key_4)).to be == '4'
+    expect(obj.test_fetch).to be == { key_3: '3', key_4: '4' }
+
+    obj.test_flush
+
+    expect(obj.test_fetch).to be == {}
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: localstore
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Pierre Lecocq
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-13 00:00:00.000000000 Z
+dependencies: []
+description: Provides a class level local data store with namespaces support
+email: pierre.lecocq@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/localstore.rb
+- spec/localstore_spec.rb
+homepage: https://github.com/pierre-lecocq/localstore
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Local data store
+test_files: []