tokyocafe 0.0.2

data/README.rdoc

@@ -0,0 +1,61 @@
+= tokyocafe
+
+== DESCRIPTION:
+
+   TokyoCafe is a set of classes to help you talk
+   to TokyoCabinet ( http://1978th.net/tokyocabinet/ ) with Ruby
+
+== SYNOPSIS:
+
+  require 'tokyocafe'
+
+  class MyClassTest
+    include TokyoCafe::Persistable
+    database 'db.tct'
+    add_timestamp_for :on_create, :on_update
+
+    attr_accessor :name
+
+    def before_delete
+      puts self.to_h.inspect
+    end
+  end
+
+* See test/test_tokyocafe.rb for more info
+
+== REQUIREMENTS:
+
+* libtokyocabinet-ruby, '>= 1.21'
+
+== INSTALL:
+
+  gem install tokyocafe
+
+== CREDITS:
+
+* Grately inspired from http://couchobject.rubyforge.org/
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 spk
+
+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,75 @@
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/rdoctask'
+require 'rake'
+require 'find'
+
+# Globals
+
+PKG_NAME = 'tokyocafe'
+PKG_VERSION = '0.0.2'
+
+PKG_FILES = ['README.rdoc', 'Rakefile']
+Find.find('lib/', 'test/') do |f|
+  if FileTest.directory?(f) and f =~ /\.svn|\.git/
+    Find.prune
+  else
+    PKG_FILES << f
+  end
+end
+
+# Tasks
+
+task :default => [:clean, :repackage]
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test_*.rb']
+end
+
+Rake::RDocTask.new do |rd|
+  f = []
+  require 'find'
+  Find.find('lib/') do |file|
+    # Skip hidden files (.svn/ directories and Vim swapfiles)
+    if file.split(/\//).last =~ /^\./
+      Find.prune
+    else
+      f << file if not FileTest.directory?(file)
+    end
+  end
+  rd.rdoc_files.include(f)
+  rd.options << '--all'
+end
+
+Rake::PackageTask.new(PKG_NAME, PKG_VERSION) do |p|
+  p.need_tar = true
+  p.package_files = PKG_FILES
+end
+
+# "Gem" part of the Rakefile
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.author = 'spk'
+  s.email = 'spk@tuxfamily.org'
+  s.platform = Gem::Platform::RUBY
+  s.homepage = 'http://github.com/spk/tokyocafe'
+  s.summary = <<-DESC.strip.gsub(/\n\s+/, " ")
+   TokyoCafe is a set of classes to help you talk to TokyoCabinet
+  DESC
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.requirements << 'libtokyocabinet-ruby'
+  s.require_path = 'lib'
+  s.files = PKG_FILES
+  s.description = <<-DESC.strip.gsub(/\n\s+/, " ")
+   TokyoCafe is a set of classes to help you talk
+   to TokyoCabinet (http://1978th.net/tokyocabinet/) with Ruby
+  DESC
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end

data/lib/tokyocafe.rb

@@ -0,0 +1,7 @@
+require 'tokyocabinet'
+
+require 'tokyocafe/persistable'
+require 'tokyocafe/version'
+
+module TokyoCafe
+end

data/lib/tokyocafe/persistable.rb

@@ -0,0 +1,218 @@
+require 'tokyocafe/persistable/meta_classes'
+
+module TokyoCafe
+  module Persistable
+    # this method will be added to the class as an instance method
+
+    include TokyoCabinet
+    attr_accessor :id, :created_at, :updated_at
+
+    @@tdb = TDB::new
+
+    def initialize(args={})
+      args.keys.each { |name| instance_variable_set "@" + name.to_s, args[name] }
+    end
+
+    def new?
+      self.id.nil?
+    end
+
+    def save(db_uri = location)
+      perform_callback(:before_save)
+      tokyo_open
+      @location = db_uri
+      if new?
+        performed = tokyo_create
+      else
+        performed = tokyo_update
+      end
+      tokyo_close
+      perform_callback(:after_save)
+      performed
+    end
+
+    def delete
+      performed = false
+      unless new?
+        perform_callback(:before_delete)
+        tokyo_open
+        performed = @@tdb.out(self.id)
+        tokyo_close
+        perform_callback(:after_delete)
+      end
+      performed
+    end
+    alias destroy delete
+
+    def to_s
+      self.id
+    end
+
+    def to_h
+      parameters = {}
+      parameters['class'] = self.class.to_s
+
+      if RUBY_VERSION.to_f > 1.8
+        excluded_instance_variables = [:@location, :@created_at,
+                                       :@updated_at]
+      else
+        excluded_instance_variables = ['@location', '@created_at',
+                                       '@updated_at']
+      end
+      instance_variables = self.instance_variables - excluded_instance_variables
+      instance_variables.each do |k|
+        key = k[1..-1]
+        value = self.instance_variable_get(k)
+        parameters[key] = value
+      end
+
+      if self.class::tokyo_cafe_timestamp_on_update?
+        parameters['updated_at'] = Time.now.to_s
+      end
+
+      unless new?
+        # update
+        parameters['id'] = id
+        if self.class::tokyo_cafe_timestamp_on_create?
+          parameters['created_at'] = created_at
+        end
+      else
+        # create
+        if self.class::tokyo_cafe_timestamp_on_create?
+          parameters['created_at'] = Time.now.to_s
+        end
+      end
+      parameters
+    end
+
+    def to_json
+      parameters = self.to_h
+      begin
+        parameters.to_json
+      rescue JSON::GeneratorError
+        TokyoCafe::Utils::decode_strings(parameters).to_json
+      end
+    end
+
+    protected
+    def tokyo_open
+      unless @@tdb.open(location, TDB::OWRITER | TDB::OCREAT)
+        ecode = @@tdb.ecode
+        STDERR.printf("open error: %s\n", @@tdb.errmsg(ecode))
+      end
+    end
+
+    def tokyo_close
+      @@tdb.close
+    end
+
+    def tokyo_create
+      perform_callback(:before_create)
+
+      hash_value = self.to_h
+
+      pkey = @@tdb.genuid
+      doc_hash = hash_value.merge({'id' => pkey})
+
+      if @@tdb.put(pkey, doc_hash)
+        @id = pkey
+        if self.class::tokyo_cafe_timestamp_on_create?
+          @created_at = Time.now.to_s
+        end
+        performed = true
+      else
+        ecode = @@tdb.ecode
+        STDERR.printf("put error: %s\n", @@tdb.errmsg(ecode))
+        performed = false
+      end
+      perform_callback(:after_create)
+      performed
+    end
+
+    def tokyo_update
+      perform_callback(:before_update)
+      if self.class::tokyo_cafe_timestamp_on_update?
+        @updated_at = Time.now.to_s
+      end
+
+      doc_value = self.to_h
+      if @@tdb.put(id, doc_value)
+        @id = id
+        if self.class::tokyo_cafe_timestamp_on_create?
+          @created_at = created_at
+        end
+        performed = true
+      else
+        ecode = @@tdb.ecode
+        STDERR.printf("put error: %s\n", @@tdb.errmsg(ecode))
+        performed = false
+      end
+      perform_callback(:after_update)
+      performed
+    end
+
+    #
+    # Performs callbacks before and after these events:
+    # * create
+    # * update
+    # * save
+    # * delete
+    #
+    def perform_callback(the_callback)
+      self.send(the_callback) if self.respond_to?(the_callback)
+    end
+
+    module ClassMethods
+      # this method will be added to the class as a class method
+      include TokyoCabinet
+
+      def get_by_id(id, db_uri = self.location)
+        @@tdb = TDB::new
+        unless @@tdb.open(db_uri, TDB::OREADER)
+          ecode = @@tdb.ecode
+          STDERR.printf("open error: %s\n", @@tdb.errmsg(ecode))
+        end
+        if id && @@tdb.get(id)
+          h = @@tdb.get(id)
+          res = self.new(h)
+        else
+          res = nil
+        end
+        @@tdb.close
+        return res
+      end
+      alias get get_by_id
+
+      # :conditions => {:name => 'tokyo'}, :limit => 3, :order => { :name => :ASC }
+      def search(options = {}, db_uri = self.location)
+        @@tdb = TDB::new
+        unless @@tdb.open(db_uri, TDB::OREADER)
+          ecode = @@tdb.ecode
+          STDERR.printf("open error: %s\n", @@tdb.errmsg(ecode))
+        end
+        qry = TDBQRY::new(@@tdb)
+        if options.include?(:conditions)
+          options[:conditions].each do |k,v|
+            qry.addcond(k.to_s, TDBQRY::QCSTREQ, v.to_s)
+          end
+        end
+        if options.include?(:limit) && options[:limit].to_i > 0
+          qry.setlimit(options[:limit])
+        end
+        if options.include?(:order)
+          options[:order].each do |k,v|
+            qry.setorder(k.to_s, TDBQRY.const_get("QOSTR#{v.to_s.upcase}"))
+          end
+        end
+        res = qry.search
+        @@tdb.close
+        return res
+      end
+
+      def set_location=(db_uri)
+        @location = db_uri == "" ? nil : db_uri
+      end
+
+    end
+  end
+end

data/lib/tokyocafe/persistable/meta_classes.rb

@@ -0,0 +1,80 @@
+module TokyoCafe
+  module Persistable
+    def self.included(klass)
+      klass.extend(TokyoCafe::Persistable::ClassMethods)
+
+      klass.class_eval do
+
+        ##
+        # Timestamps
+        ##
+
+        # Timestamps are false by default
+        def self.tokyo_cafe_timestamp_on_update?; false; end
+        def self.tokyo_cafe_timestamp_on_create?; false; end
+
+        #
+        # Adds timestamps to the class.
+        #
+        # Example:
+        #
+        #   class Vacation
+        #     include TokyoCafe::Persistable
+        #     add_timestamp_for :on_create, :on_update
+        #   end
+        #
+        #   my_vacation = Vacation.new
+        #   my_vacation.save(db_address)
+        #   my_vacation.created_at => Somedate
+        #   my_vacation.updated_at => Somedate
+        #
+        def self.add_timestamp_for(*timestamp_actions)
+          timestamp_actions.each do |action|
+            case action
+            when :on_create
+              self.class_eval do
+                def self.tokyo_cafe_timestamp_on_create?; true; end
+              end
+            when :on_update
+              self.class_eval do
+                def self.tokyo_cafe_timestamp_on_update?; true; end
+              end
+            end
+          end
+        end
+
+        # Location methods are added both as instance methods and
+        # as class level methods. The class level methods are needed
+        # when loading new objects from the database and the instance
+        # methods are used throughout the class
+        def self.location; @tokyo_cafe_class_storage_location ||= nil; end
+        def location; @location; end
+        alias storage_location location
+
+        #
+        # Sets the location of the database to use by default
+        #
+        # Example:
+        #
+        #   class AppleTree
+        #     include TokyoCafe::Persistable
+        #     database 'db/db.tct'
+        #   end
+        #
+        #   apple_tree = AppleTree.new
+        #   apple_tree.save # saves automatically to the predefined
+        #                   # database location
+        #
+        def self.database(db_uri)
+          @tokyo_cafe_class_storage_location = db_uri
+          self.instance_eval do
+            define_method("location") do
+              @location ||= db_uri
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/tokyocafe/version.rb

@@ -0,0 +1,9 @@
+module TokyoCafe #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/test/test_tokyocafe.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+require 'test/unit'
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'tokyocafe'
+
+class MyClassTest
+  include TokyoCafe::Persistable
+  database 'db.tct'
+  add_timestamp_for :on_create, :on_update
+
+  attr_accessor :name
+
+  def after_save
+    puts self.inspect
+    puts self.to_h.inspect
+  end
+
+  def before_delete
+    puts self.to_h.inspect
+  end
+end
+
+class TokyoCafeTest < Test::Unit::TestCase
+
+  def default_test
+    save_test
+    get_test
+    search_test
+    delete_test
+  end
+
+  def save_test
+    t = MyClassTest.new
+    t.name = 'tokyo'
+    assert t.new?
+    assert t.save
+    t.id
+  end
+
+  def get_test
+    id = save_test
+    a = MyClassTest.get(id)
+    assert !a.new?
+    a.name = 'tokyooo'
+    assert a.save
+    a.id
+  end
+
+  def delete_test
+    id = get_test
+    b = MyClassTest.get(id)
+    assert b.delete
+  end
+
+  def search_test
+    t = MyClassTest.new
+    t.name = 'tokyo'
+    t.save
+    res = MyClassTest.search(:conditions => {:name => "tokyo"}, :limit => 3, :order => {:name => :ASC})
+    assert !res.empty?
+    assert (res.size < 4)
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: tokyocafe
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- spk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-11 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: TokyoCafe is a set of classes to help you talk to TokyoCabinet (http://1978th.net/tokyocabinet/) with Ruby
+email: spk@tuxfamily.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.rdoc
+- Rakefile
+- lib/tokyocafe/version.rb
+- lib/tokyocafe/persistable.rb
+- lib/tokyocafe/persistable/meta_classes.rb
+- lib/tokyocafe.rb
+- test/test_tokyocafe.rb
+has_rdoc: true
+homepage: http://github.com/spk/tokyocafe
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- libtokyocabinet-ruby
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: TokyoCafe is a set of classes to help you talk to TokyoCabinet
+test_files: []
+