oj-pstore 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 259be089b510ae49af0def9ed027c86dee736be25b87d5cb4a35d6d2ce0f4a2c
-  data.tar.gz: 641e5b5e4602f016a45d749975d4f6b794c70505bb1df407ac7bd0291e6e0903
+  metadata.gz: 4abfd6c5d996ef1381a92d01e6b53e2bdc5a2089ab23a2337271e4bc50aee493
+  data.tar.gz: 1359111aef09dcc79e8ac6db736257b1a333ef0a8bc29fe7a56d895d712347eb
 SHA512:
-  metadata.gz: aa1649fd8446f1f39296bf8e64cdd4075ce474c906ceab12a9d61d23df5fb593c08b8ba83a1dd93f5f998ed83f415a6e471b8ebd6b43a2ce143b0cc2fac3f8f2
-  data.tar.gz: ac8b820b6edb8d8cf22c324572d7c7bc46e62a57492aa35c57c5efc8621f520207c6df55c493c01903f7757f28bc70ed73338c3942f657d1bed588dfe30861f9
+  metadata.gz: 423c94d01ecd47e12d0e7e9fca06328181b52b50f29ed5c381d6485a4bb11c322a3e3fa53734c06375ffe39f9ebf6c97cd423badc5cd1248005e764bf2d41780
+  data.tar.gz: b1a9acac1ad4f23cfef828ffde518559d10d3d090f63a6dc4af625ff1aa24f3eb9b47338b654da474c1c11a269aa51963d5d1157650f885777f5433e6f508629

data/README.md

@@ -2,11 +2,44 @@
 
 This gem implements a [PStore](http://ruby-doc.org/stdlib-2.0/libdoc/pstore/rdoc/PStore.html) alternative using the fast [Oj](https://github.com/ohler55/oj#readme) gem.
 
-## Installation
+- Gem: [rubygems.org](https://rubygems.org/gems/oj-pstore)
+- Source: [github.com](https://github.com/mblumtritt/oj-pstore)
 
-    gem install oj-pstore
+Use [Bundler](http://gembundler.com/) to add TCPClient in your own project:
 
+Include in your `Gemfile`:
+
+```ruby
+gem 'oj-pstore'
+```
+
+and install it by running Bundler:
+
+```bash
+bundle
+```
+
+To install the gem globally use:
+
+```bash
+gem install oj-pstore
+```
+
+After that you need only a single line of code in your project to have it on board:
+
+```ruby
+require 'oj/store'
+```
 ## Documentation
 
-The gem supports the [PStore](http://ruby-doc.org/stdlib-2.0/libdoc/pstore/rdoc/PStore.html) API.
+The gem supports the [PStore](https://ruby-doc.org/stdlib-2.7.0/libdoc/pstore/rdoc/index.html) API.
+
+## Sample
+
+```ruby
+# change a configuration value
+require 'oj/store'
 
+config = Oj::Store.new('config.json')
+config.transaction{ config[:last_used] = Time.now }
+```

data/lib/oj/store.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'pstore'
 require 'oj'
 
 class Oj::Store < PStore
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.5'
 
   attr_reader :obtions
 
@@ -31,8 +33,8 @@ class Oj::Store < PStore
     EMPTY_MARSHAL_CHECKSUM
   end
 
-  private
-
   EMPTY_MARSHAL_DATA = Oj.dump({}).freeze
   EMPTY_MARSHAL_CHECKSUM = Digest::MD5.digest(EMPTY_MARSHAL_DATA)
+
+  private_constant(:EMPTY_MARSHAL_DATA, :EMPTY_MARSHAL_CHECKSUM)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oj-pstore
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Mike Blumtritt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-26 00:00:00.000000000 Z
+date: 2022-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -24,53 +24,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  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'
 description: This gem implements a PStore alternative using the very fast Oj gem.
-email: mike.blumtritt@invision.de
+email:
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- ".gitignore"
 - README.md
-- gems.rb
 - lib/oj/store.rb
-- oj-pstore.gemspec
-- rakefile.rb
-- test/oj_store_test.rb
 homepage: https://github.com/mblumtritt/oj-pstore
 licenses: []
 metadata:
-  issue_tracker: https://github.com/mblumtritt/tcp-client/issues
-post_install_message: 
+  source_code_uri: https://github.com/mblumtritt/oj-pstore
+  bug_tracker_uri: https://github.com/mblumtritt/oj-pstore/issues
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,11 +51,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: PStore based on fast JSON parser/marshaller Oj.
-test_files:
-- test/oj_store_test.rb
+test_files: []

data/.gitignore

@@ -1,2 +0,0 @@
-*.locked
-tmp/

data/gems.rb

@@ -1 +0,0 @@
-source('https://rubygems.org'){ gemspec }

data/oj-pstore.gemspec

@@ -1,32 +0,0 @@
-require_relative 'lib/oj/store'
-
-GemSpec = Gem::Specification.new do |spec|
-  spec.name = 'oj-pstore'
-  spec.version = Oj::Store::VERSION
-  spec.summary = 'PStore based on fast JSON parser/marshaller Oj.'
-  spec.description =
-    'This gem implements a PStore alternative using the very fast Oj gem.'
-  spec.author = 'Mike Blumtritt'
-  spec.email = 'mike.blumtritt@invision.de'
-  spec.homepage = 'https://github.com/mblumtritt/oj-pstore'
-  spec.metadata = {
-    'issue_tracker' => 'https://github.com/mblumtritt/tcp-client/issues'
-  }
-  spec.rubyforge_project = spec.name
-
-  spec.add_dependency 'oj'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'rake'
-
-  spec.platform = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.0.0'
-  spec.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
-
-  spec.require_paths = %w[lib]
-
-  all_files = %x(git ls-files -z).split(0.chr)
-  spec.test_files = all_files.grep(%r{^(spec|test)/})
-  spec.files = all_files - spec.test_files
-
-  spec.extra_rdoc_files = %w[README.md]
-end

data/rakefile.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require 'rake/clean'
-require 'rake/testtask'
-require 'bundler/gem_tasks'
-
-STDOUT.sync = STDERR.sync = true
-
-CLOBBER << 'prj'
-
-Rake::TestTask.new(:test) do |t|
-  t.ruby_opts = %w[-w]
-  t.verbose = true
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-task :default do
-  exec("#{$PROGRAM_NAME} --tasks")
-end

data/test/oj_store_test.rb

@@ -1,149 +0,0 @@
-require 'minitest/autorun'
-require_relative '../lib/oj/store'
-
-class OjStoreTest < Minitest::Test
-
-  class SampleData
-    attr_accessor :name, :number
-  end
-
-  def setup
-    @store_file = "oj-store.tmp.#{Process.pid}"
-    @store_file2 = "oj-store.2.tmp.#{Process.pid}"
-    @store = Oj::Store.new(@store_file)
-  end
-
-  def teardown
-    File.file?(@store_file) and File.unlink(@store_file) rescue nil
-    File.file?(@store_file2) and File.unlink(@store_file2) rescue nil
-  end
-
-  def test_opening_new_file_in_readonly_mode_should_result_in_empty_values
-    @store.transaction(true) do
-      assert_nil @store[:foo]
-      assert_nil @store[:bar]
-    end
-  end
-
-  def test_opening_new_file_in_readwrite_mode_should_result_in_empty_values
-    @store.transaction do
-      assert_nil @store[:foo]
-      assert_nil @store[:bar]
-    end
-  end
-
-  def test_data_should_be_loaded_correctly_when_in_readonly_mode
-    @store.transaction do
-      @store[:foo] = 'bar'
-    end
-    @store.transaction(true) do
-      assert_equal 'bar', @store[:foo]
-    end
-  end
-
-  def test_data_should_be_loaded_correctly_when_in_readwrite_mode
-    @store.transaction do
-      @store[:foo] = 'bar'
-    end
-    @store.transaction do
-      assert_equal 'bar', @store[:foo]
-    end
-  end
-
-  def test_changes_after_commit_are_discarded
-    @store.transaction do
-      @store[:foo] = 'bar'
-      @store.commit
-      @store[:foo] = 'baz'
-    end
-    @store.transaction(true) do
-      assert_equal 'bar', @store[:foo]
-    end
-  end
-
-  def test_changes_are_not_written_on_abort
-    @store.transaction do
-      @store[:not_written] = 'just a value'
-      @store.abort
-    end
-    @store.transaction(true) do
-      assert_nil @store[:not_written]
-    end
-  end
-
-  def test_writing_inside_readonly_transaction_raises_error
-    assert_raises(PStore::Error) do
-      @store.transaction(true) do
-        @store[:foo] = 'bar'
-      end
-    end
-  end
-
-  def test_thread_safe
-    assert_raises(PStore::Error) do
-      flag = false
-      Thread.new do
-        @store.transaction do
-          @store[:foo] = 'bar'
-          flag = true
-          sleep 1
-        end
-      end
-      until flag
-        # nop
-      end
-      @store.transaction {}
-    end
-    begin
-      pstore = PStore.new(@store_file2,true)
-      flag = false
-      Thread.new do
-        pstore.transaction do
-          pstore[:foo] = 'bar'
-          flag = true
-          sleep 1
-        end
-      end
-      until flag
-        # nop
-      end
-      pstore.transaction do
-        assert(pstore[:foo] == 'bar')
-      end
-    end
-  end
-
-  def test_nested_transaction_raises_error
-    assert_raises(PStore::Error) do
-      @store.transaction { @store.transaction { } }
-    end
-    pstore = PStore.new(@store_file2, true)
-    assert_raises(PStore::Error) do
-      pstore.transaction { pstore.transaction { } }
-    end
-  end
-
-  def test_extended_data
-    array= [1,2,3,4,'a','b','c']
-    hash= {a: 42, b: :c, d: 'e', 'f' => 4711}
-    s= SampleData.new
-    s.name = 'a name'
-    s.number = 12345678
-    @store.transaction do
-      @store[:string] = 'a simple string'
-      @store[:number] = 42.21
-      @store[:array] = array
-      @store[:hash] = hash
-      @store[:sample] = s
-    end
-    @store.transaction(true) do
-      assert_equal 'a simple string', @store[:string]
-      assert_equal 42.21, @store[:number]
-      assert_equal array, @store[:array]
-      assert_equal hash, @store[:hash]
-      assert_equal s.class, @store[:sample].class
-      assert_equal s.name, @store[:sample].name
-      assert_equal s.number, @store[:sample].number
-    end
-  end
-end