rims-qdbm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3348e7c899dbf6c80c802f4a370ba67b38a9914b02a23dfb1c22bbd7ad76ab98
+  data.tar.gz: 6b652d2eac805df84993a5c4ba8d7b624c5176f80ece73ad076abe63275c6ab2
+SHA512:
+  metadata.gz: e0a8cb0f55fd23c17ea696b41d48ec3498215343fe9202c106335768bfbce54a918b9016a711a9f3ed8ef712de06caf066a689fcee1470e3c415335a89b4c42e
+  data.tar.gz: 2cfedf3fc2d3a4ed28cfb30398451601efdea43e4104badfe733b4eee8f27f4cd66f5de96eb8c24619f5d9b71b85e275ba9085c6791173549c996c619e27f360

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*~
+README.html

data/Gemfile

@@ -0,0 +1,11 @@
+# -*- coding: utf-8 -*-
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rims-qdbm.gemspec
+gemspec
+
+# Local Variables:
+# mode: Ruby
+# indent-tabs-mode: nil
+# End:

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 TOKI Yoshinori
+
+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,55 @@
+RIMS::QDBM
+==========
+
+RIMS key-value store plug-in for QDBM.
+By introducing this plug-in, RIMS IMAP server will be able to store
+mailboxes and messages in QDBM.  QDBM is Quick Database Manager of
+https://fallabs.com/qdbm/.
+
+This gem provides 2 plug-ins (`qdbm_depot` and `qdbm_curia`).
+
+Installation
+------------
+
+Add this line to your application's Gemfile that includes RIMS:
+
+```ruby
+gem 'rims-qdbm'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rims-qdbm
+
+Usage
+-----
+
+Add these lines to your config.yml of RIMS:
+
+```yaml
+load_libraries:
+  - rims/qdbm
+meta_key_value_store:
+  plug_in: qdbm_depot
+  configuration:
+    bnum: 1200000
+text_key_value_store:
+  plug_in: qdbm_curia
+  configuration:
+    bnum: 50000
+    dnum: 8
+```
+
+Contributing
+------------
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/y10k/rims-qdbm.
+
+License
+-------
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :spec
+
+Rake::TestTask.new do |task|
+  if ((ENV.key? 'RUBY_DEBUG') && (! ENV['RUBY_DEBUG'].empty?)) then
+    task.ruby_opts << '-d'
+  end
+end
+
+desc 'Build README.html from markdown source.'
+task :readme => %w[ README.html ]
+
+file 'README.html' => [ 'README.md' ] do
+  sh "pandoc --from=markdown --to=html5 --standalone --self-contained --css=$HOME/.pandoc/github.css --output=README.html README.md"
+end
+CLOBBER.include 'README.html'
+
+# Local Variables:
+# mode: Ruby
+# indent-tabs-mode: nil
+# End:

data/lib/rims/qdbm.rb

@@ -0,0 +1,196 @@
+# -*- coding: utf-8 -*-
+
+require 'curia'
+require 'depot'
+require 'fileutils'
+require 'rims'
+require 'rims/qdbm/version'
+
+module RIMS
+  module QDBM
+    class Depot_KeyValueStore < KeyValueStore
+      def initialize(depot, path)
+        @db = depot
+        @path = path
+        @closed = false
+      end
+
+      class << self
+        def exist?(path)
+          depot_path = path + '.qdbm_depot'
+          File.exist? depot_path
+        end
+
+        def depot_open(path, *optional)
+          depot = Depot.new(path, Depot::OWRITER | Depot::OCREAT, *optional)
+          depot.silent = true
+          depot
+        end
+
+        def open(name, *optional)
+          depot_path = name + '.qdbm_depot'
+          new(depot_open(depot_path, *optional), depot_path)
+        end
+
+        def open_with_conf(name, config)
+          bnum = config['bnum']
+          args = []
+          args << bnum if bnum
+          open(name, *args)
+        end
+      end
+
+      def [](key)
+        @closed and raise 'closed'
+        @db[key]
+      end
+
+      def []=(key, value)
+        @closed and raise 'closed'
+        @db[key] = value
+      end
+
+      def delete(key)
+        @closed and raise 'closed'
+        ret_val = @db[key]
+        @db.out(key)
+        ret_val
+      end
+
+      def key?(key)
+        @closed and raise 'closed'
+        ! @db[key].nil?
+      end
+
+      def each_key
+        @closed and raise 'closed'
+        return enum_for(:each_key) unless block_given?
+        @db.each_key do |key|
+          yield(key)
+        end
+        self
+      end
+
+      def sync
+        @closed and raise 'closed'
+        @db.sync
+        self
+      end
+
+      def close
+        @closed and raise 'closed'
+        @db.close
+        @closed = true
+        self
+      end
+
+      def destroy
+        unless (@closed) then
+          raise "failed to destroy qdbm-depot that isn't closed: #{@path}"
+        end
+        File.delete(@path)
+        nil
+      end
+    end
+    KeyValueStore::FactoryBuilder.add_plug_in('qdbm_depot', Depot_KeyValueStore)
+
+    class Curia_KeyValueStore < KeyValueStore
+      def initialize(curia, path)
+        @db = curia
+        @path = path
+        @closed = false
+      end
+
+      class << self
+        def exist?(path)
+          curia_path = path + '.qdbm_curia'
+          File.exist? curia_path
+        end
+
+        def curia_open(path, *optional)
+          curia = Curia.new(path, Curia::OWRITER | Curia::OCREAT, *optional)
+          curia.silent = true
+          curia
+        end
+
+        def open(name, *optional)
+          curia_path = name + '.qdbm_curia'
+          new(curia_open(curia_path, *optional), curia_path)
+        end
+
+        def open_with_conf(name, config)
+          bnum = config['bnum']
+          dnum = config['dnum']
+
+          args = []
+          unless (dnum) then
+            args << bnum if bnum
+          else
+            args << bnum || -1
+            args << dnum
+          end
+
+          open(name, *args)
+        end
+      end
+
+      def [](key)
+        @closed and raise 'closed'
+        @db[key]
+      end
+
+      def []=(key, value)
+        @closed and raise 'closed'
+        @db[key] = value
+      end
+
+      def delete(key)
+        @closed and raise 'closed'
+        ret_val = @db[key]
+        @db.out(key)
+        ret_val
+      end
+
+      def key?(key)
+        @closed and raise 'closed'
+        ! @db[key].nil?
+      end
+
+      def each_key
+        @closed and raise 'closed'
+        return enum_for(:each_key) unless block_given?
+        @db.each_key do |key|
+          yield(key)
+        end
+        self
+      end
+
+      def sync
+        @closed and raise 'closed'
+        @db.sync
+        self
+      end
+
+      def close
+        @closed and raise 'closed'
+        @db.close
+        @closed = true
+        self
+      end
+
+      def destroy
+        unless (@closed) then
+          raise "failed to destroy qdbm-curia that isn't closed: #{@path}"
+        end
+        FileUtils.rm_rf(@path)
+        nil
+      end
+    end
+    KeyValueStore::FactoryBuilder.add_plug_in('qdbm_curia', Curia_KeyValueStore)
+  end
+end
+
+# Local Variables:
+# mode: Ruby
+# indent-tabs-mode: nil
+# End:

data/lib/rims/qdbm/version.rb

@@ -0,0 +1,5 @@
+module RIMS
+  module QDBM
+    VERSION = '0.1.0'
+  end
+end

data/rims-qdbm.gemspec

@@ -0,0 +1,43 @@
+#-*-  coding: utf-8 -*-
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rims/qdbm/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rims-qdbm"
+  spec.version       = RIMS::QDBM::VERSION
+  spec.authors       = ["TOKI Yoshinori"]
+  spec.email         = ["toki@freedom.ne.jp"]
+
+  spec.summary       = %q{RIMS key-value store plug-in for QDBM}
+  spec.description   = <<-'EOF'
+    RIMS key-value store plug-in for QDBM.  By introducing this
+    plug-in, RIMS IMAP server will be able to store mailboxes and
+    messages in QDBM.  QDBM is Quick Database Manager of
+    https://fallabs.com/qdbm/.
+  EOF
+  spec.homepage      = "https://github.com/y10k/rims-qdbm"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "bin"
+  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 "rims", ">= 0.2.0"
+  spec.add_runtime_dependency "ruby-qdbm"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "test-unit"
+end
+
+# Local Variables:
+# mode: Ruby
+# indent-tabs-mode: nil
+# End:

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: rims-qdbm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TOKI Yoshinori
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rims
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: ruby-qdbm
+  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: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  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: |2
+      RIMS key-value store plug-in for QDBM.  By introducing this
+      plug-in, RIMS IMAP server will be able to store mailboxes and
+      messages in QDBM.  QDBM is Quick Database Manager of
+      https://fallabs.com/qdbm/.
+email:
+- toki@freedom.ne.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rims/qdbm.rb
+- lib/rims/qdbm/version.rb
+- rims-qdbm.gemspec
+homepage: https://github.com/y10k/rims-qdbm
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: RIMS key-value store plug-in for QDBM
+test_files: []