hakto 0.0.1

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Moza USANE
+
+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,91 @@
+Hakto Safe SDBM Wrapper
+=======================
+
+## Introduction
+
+Hakto Safe SDBM Wrapper is a safe wrapper of SDBM library. Hakto has compatibility of instance method's interface that is in SDBM class.
+
+Hakto enables to tighten up a code that uses SDBM library like following codes.
+
+**before**
+
+    class Klass
+      def initialize(db_path)
+        @db_path = db_path
+      end
+      
+      def method1
+        SDBM.open(@db_path) do |dbm|
+          dbm["hoge"] = "HOGE"
+        end
+      end
+      
+      def method2
+        SDBM.open(@db_path) do |dbm|
+          dbm["hoge"]
+        end
+      end
+      
+      :
+      
+    end            
+
+**after**
+
+    class Klass
+      def initialize(db_path)
+        @sdb = SafeSDBM.new(db_path)
+      end
+      
+      def method1
+        sdb["hoge"] = "HOGE"
+      end
+      
+      def method2
+        sdb["hoge"]
+      end
+      
+      :
+      
+    end            
+
+
+
+## Operation Environment
+
+We checked good operation within following environment.
+
+- Linux（openSUSE 12.2）・Mac OS X 10.8.2
+- Ruby 1.9.3
+
+## Architectonics
+
+- **bin**
+- **doc** :: Rdoc documents.
+- **lib**
+  - **hakto**
+    - **safe_sdbm.rb** :: Class of SafeSDBM
+- **LICENSE**
+- **Rakefile** :: Rakefile that is used to generate gem file
+- **README.md**
+- **README_jp.md**
+- **test** :: Unit tests
+  - **tb_safe_sdbm.rb** :: Unit test for SafeSDBM
+  
+## Install
+
+Download hakto-x.y.z.gem, then execute following command to install Hakto.
+
+`$ sudo gem install hakto-x.y.z.gem`
+
+Also you can install Hakto without gem. Allocate the safe_sdbm.rb where is ruby interpreter can load Hakto.
+
+## Sample code
+
+See tb_safe_sdbm.rb file. It is an unit test code, and it doubles with sample code.
+
+## About Author
+
+Moza USANE  
+[http://blog.quellencode.org/](http://blog.quellencode.org/ "")  
+mozamimy@quellencode.org

data/README_jp.md

@@ -0,0 +1,92 @@
+Hakto Safe SDBM Wrapper
+=======================
+
+## イントロダクション
+
+Hakto Safe SDBM Wrapper（以下Haktoと省略）は、RubyのSDBMライブラリの安全なラッパーライブラリである。SDBMクラスのほぼ全てのインスタンスメソッドと互換性がある。
+
+SDBMライブラリを使うときにありがちな、以下の様な煩雑なコードをスッキリまとめることができる。
+
+**before**
+
+    class Klass
+      def initialize(db_path)
+        @db_path = db_path
+      end
+      
+      def method1
+        SDBM.open(@db_path) do |dbm|
+          dbm["hoge"] = "HOGE"
+        end
+      end
+      
+      def method2
+        SDBM.open(@db_path) do |dbm|
+          dbm["hoge"]
+        end
+      end
+      
+      :
+      
+    end            
+
+**after**
+
+    class Klass
+      def initialize(db_path)
+        @sdb = SafeSDBM.new(db_path)
+      end
+      
+      def method1
+        sdb["hoge"] = "HOGE"
+      end
+      
+      def method2
+        sdb["hoge"]
+      end
+      
+      :
+      
+    end            
+
+## 動作環境
+
+以下の環境で開発およびテストをしている。
+
+- Linux（openSUSE 12.2）・Mac OS X 10.8.2
+- Ruby 1.9.3
+
+## 構成
+
+- **bin**
+- **doc** :: rdocによるドキュメント
+- **lib**
+  - **hakto**
+    - **safe_sdbm.rb** :: SafeSDBMクラス
+- **LICENSE**
+- **Rakefile** :: gemパッケージ生成用のRakefile
+- **README.md**
+- **README_jp.md**
+- **test** :: ユニットテスト
+  - **tb_safe_sdbm.rb** :: SafeSDBM用ユニットテスト
+
+## インストール
+
+hakto-x.y.z.gemファイル（x、y、zはバージョン番号）をダウンロードし、以下のコマンドを入力してインストールする。
+
+`$ sudo gem install hakto-x.y.z.gem`
+
+または、
+
+gemを使わない場合は、Rubyのパスが通っている適当な場所にsafe_sdbm.rbを置く。
+
+## サンプルコード
+
+tb_safe_sdbm.rbがサンプルコードを兼ねている。
+
+
+## 作者について
+
+Moza USANE  
+[http://blog.quellencode.org/](http://blog.quellencode.org/ "")  
+mozamimy@quellencode.org

data/Rakefile

@@ -0,0 +1,18 @@
+require "rake/gempackagetask"
+
+spec = Gem::Specification.new do |s|
+  s.name         = "hakto"
+  s.summary      = "Hakto Safe SDBM Wrapper is a safe wrapper of SDBM class."
+  s.description  = File.read(File.join(File.dirname(__FILE__), "README.md"))
+  s.version      = "0.0.1"
+  s.author       = "Moza USANE"
+  s.email        = "mozamimy@quellencode.org"
+  s.homepage     = "http://blog.quellencode.org/"
+  s.platform     = Gem::Platform::RUBY
+  s.required_ruby_version = ">=1.9"
+  s.files        = Dir["**/**"]
+  s.test_files   = Dir["test/test*.rb"]
+  s.has_rdoc     = true
+end
+
+Rake::GemPackageTask.new(spec).define

data/doc/Hakto/SafeSDBM.html

@@ -0,0 +1,318 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>class Hakto::SafeSDBM - RDoc Documentation</title>
+
+<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "../";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
+
+
+<body id="top" class="class">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="../index.html">Home</a>
+    <a href="../table_of_contents.html#classes">Classes</a>
+    <a href="../table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>lib/hakto/safe_sdbm.rb
+  </ul>
+</nav>
+
+    
+  </div>
+
+  <div id="class-metadata">
+    
+    <nav id="parent-class-section" class="section">
+  <h3 class="section-header">Parent</h3>
+  
+  <p class="link"><a href="../Object.html">Object</a>
+  
+</nav>
+
+    
+    <!-- Method Quickref -->
+<nav id="method-list-section" class="section">
+  <h3 class="section-header">Methods</h3>
+
+  <ul class="link-list">
+    
+    <li><a href="#method-c-new">::new</a>
+    
+    <li><a href="#method-i-print_each">#print_each</a>
+    
+    <li><a href="#method-i-print_keys">#print_keys</a>
+    
+    <li><a href="#method-i-print_values">#print_values</a>
+    
+  </ul>
+</nav>
+
+  </div>
+
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+
+  <ul>
+  
+    <li class="file"><a href="../Rakefile.html">Rakefile</a>
+  
+  </ul>
+</nav>
+
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="../Hakto.html">Hakto</a>
+  
+    <li><a href="../Hakto/SafeSDBM.html">Hakto::SafeSDBM</a>
+  
+    <li><a href="../Object.html">Object</a>
+  
+    <li><a href="../SafeSDBMTest.html">SafeSDBMTest</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="class">class Hakto::SafeSDBM</h1>
+
+  <div id="description" class="description">
+    
+<p>Wrapper of SDBM class. It provides safe access to SDBM database. You can
+use almost instance methods of SDBM class.</p>
+
+  </div><!-- description -->
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+    <!-- Attributes -->
+    <section id="attribute-method-details" class="method-section section">
+      <h3 class="section-header">Attributes</h3>
+
+      
+      <div id="attribute-i-db_path" class="method-detail">
+        <div class="method-heading attribute-method-heading">
+          <span class="method-name">db_path</span><span
+            class="attribute-access-type">[R]</span>
+        </div>
+
+        <div class="method-description">
+        
+        
+        
+        </div>
+      </div>
+      
+    </section><!-- attribute-method-details -->
+    
+
+    <!-- Methods -->
+    
+     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
+      <h3 class="section-header">Public Class Methods</h3>
+
+    
+      <div id="method-c-new" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">new</span><span
+            class="method-args">(db_path)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Initialize <a href="SafeSDBM.html">SafeSDBM</a>.</p>
+
+<h4 id="method-c-new-label-Args">Args</h4>
+<dl class="rdoc-list note-list"><dt><a href="SafeSDBM.html#attribute-i-db_path">#db_path</a> 
+<dd>
+<p>A filepath of DB file</p>
+</dd></dl>
+          
+
+          
+          <div class="method-source-code" id="new-source">
+            <pre><span class="ruby-comment"># File lib/hakto/safe_sdbm.rb, line 29</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">db_path</span>)
+  <span class="ruby-ivar">@db_path</span> = <span class="ruby-identifier">db_path</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- new-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- new-method -->
+
+    
+    </section><!-- public-class-method-details -->
+  
+     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
+      <h3 class="section-header">Public Instance Methods</h3>
+
+    
+      <div id="method-i-print_each" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">print_each</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Print key-value pair with following format.</p>
+
+<p>[key1]:value1</p>
+
+<p>[key2]:value2</p>
+
+<p>:</p>
+
+<p>:</p>
+          
+
+          
+          <div class="method-source-code" id="print_each-source">
+            <pre><span class="ruby-comment"># File lib/hakto/safe_sdbm.rb, line 48</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">print_each</span>
+  <span class="ruby-identifier">operate</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dbm</span><span class="ruby-operator">|</span>
+    <span class="ruby-identifier">dbm</span>.<span class="ruby-identifier">each_pair</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span> <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;[#{key}]:#{value}&quot;</span>}
+  <span class="ruby-keyword">end</span>
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- print_each-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- print_each-method -->
+
+    
+      <div id="method-i-print_keys" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">print_keys</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Print keys with following format. key1, key2, key3, …</p>
+          
+
+          
+          <div class="method-source-code" id="print_keys-source">
+            <pre><span class="ruby-comment"># File lib/hakto/safe_sdbm.rb, line 35</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">print_keys</span>
+  <span class="ruby-identifier">print_flat</span>(<span class="ruby-string">&quot;keys&quot;</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- print_keys-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- print_keys-method -->
+
+    
+      <div id="method-i-print_values" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">print_values</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Print values with following format. value1, value2, value3, …</p>
+          
+
+          
+          <div class="method-source-code" id="print_values-source">
+            <pre><span class="ruby-comment"># File lib/hakto/safe_sdbm.rb, line 56</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">print_values</span>
+  <span class="ruby-identifier">print_flat</span>(<span class="ruby-string">&quot;values&quot;</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- print_values-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- print_values-method -->
+
+    
+    </section><!-- public-instance-method-details -->
+  
+  </section><!-- 5Buntitled-5D -->
+
+</div><!-- documentation -->
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+

data/doc/Hakto.html

@@ -0,0 +1,139 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+<title>module Hakto - RDoc Documentation</title>
+
+<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+</script>
+
+<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+
+
+<body id="top" class="module">
+<nav id="metadata">
+  <nav id="home-section" class="section">
+  <h3 class="section-header">
+    <a href="./index.html">Home</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </h3>
+</nav>
+
+
+  <nav id="search-section" class="section project-section" class="initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <h3 class="section-header">
+      <input type="text" name="search" placeholder="Search" id="search-field"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </h3>
+  </form>
+
+  <ul id="search-results" class="initially-hidden"></ul>
+</nav>
+
+
+  <div id="file-metadata">
+    <nav id="file-list-section" class="section">
+  <h3 class="section-header">Defined In</h3>
+  <ul>
+    <li>lib/hakto/safe_sdbm.rb
+  </ul>
+</nav>
+
+    
+  </div>
+
+  <div id="class-metadata">
+    
+    
+    
+    
+  </div>
+
+  <div id="project-metadata">
+    <nav id="fileindex-section" class="section project-section">
+  <h3 class="section-header">Pages</h3>
+
+  <ul>
+  
+    <li class="file"><a href="./Rakefile.html">Rakefile</a>
+  
+  </ul>
+</nav>
+
+    <nav id="classindex-section" class="section project-section">
+  <h3 class="section-header">Class and Module Index</h3>
+
+  <ul class="link-list">
+  
+    <li><a href="./Hakto.html">Hakto</a>
+  
+    <li><a href="./Hakto/SafeSDBM.html">Hakto::SafeSDBM</a>
+  
+    <li><a href="./Object.html">Object</a>
+  
+    <li><a href="./SafeSDBMTest.html">SafeSDBMTest</a>
+  
+  </ul>
+</nav>
+
+  </div>
+</nav>
+
+<div id="documentation">
+  <h1 class="module">module Hakto</h1>
+
+  <div id="description" class="description">
+    
+<p><a href="Hakto.html">Hakto</a> Safe SDBM Wrapper is a safe wrapper of SDBM
+class.</p>
+<dl class="rdoc-list note-list"><dt>Author
+<dd>
+<p>Moza USANE (<a
+href="mailto:mozamimy@quellencode.org">mozamimy@quellencode.org</a>)</p>
+</dd><dt>Copyright
+<dd>
+<p>Copyright © 2012 Moza USANE</p>
+</dd><dt>License
+<dd>
+<p>MIT License (see the LICENSE file)</p>
+</dd></dl>
+
+  </div><!-- description -->
+
+  
+  
+  
+  <section id="5Buntitled-5D" class="documentation-section">
+    
+
+    
+
+    
+
+    
+
+    <!-- Methods -->
+    
+  </section><!-- 5Buntitled-5D -->
+
+</div><!-- documentation -->
+
+
+<footer id="validator-badges">
+  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
+  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+</footer>
+