rubysouth-tokyo_model 0.0.2 → 0.0.4

data/History.txt

@@ -1,3 +1,13 @@
+== 0.0.4 2009-04-21
+
+* 1 major enhancement:
+  * Connection over TokyoTyrant now working
+
+== 0.0.3 2009-04-20
+
+* 1 major enhancement:
+  * Added beginning of query support.
+
 == 0.0.2 2009-04-17
 
 * 1 major enhancement:

data/Manifest.txt

@@ -7,6 +7,7 @@ lib/tokyo_model/adapters/abstract_adapter.rb
 lib/tokyo_model/adapters/file.rb
 lib/tokyo_model/adapters/tyrant.rb
 lib/tokyo_model/persistable.rb
+lib/tokyo_model/query.rb
 script/console
 script/destroy
 script/generate
@@ -15,4 +16,5 @@ test/fixtures/post.rb
 test/test_basic_model.rb
 test/test_file_adapter.rb
 test/test_helper.rb
-tokyo_model.gemspec
+test/test_query.rb
+tokyo_model.gemspec

data/README.rdoc

@@ -1,8 +1,8 @@
 = TokyoModel
 
-TokyoModel is a lightweight ORM that uses TokyoCabinet's table databases (TDB)
-as a storage backend. TDB has tables but no schemas, which allows for some
-interesting possibilities in an ORM.
+TokyoModel is a small, lightweight ORM that uses TokyoCabinet's table
+databases (TDB) as a storage backend. It is to ActiveRecord or Sequel what
+Sinatra is to Rails or Merb.
 
 Our first public release is planned for some time in late April 2009. At the
 moment almost ALMOST NOTHING is implemented. It wouldn't even be fair to
@@ -12,21 +12,20 @@ describe this as pre-alpha. DO NOT USE THIS.
 
 Copyright (c) 2009 Adrian Mugnolo and Norman Clarke
 
-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:
+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 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.
+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/lib/tokyo_model.rb

@@ -3,10 +3,11 @@ $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) ||
 require 'uri'
 require 'tokyo_model/persistable'
 require 'tokyo_model/adapters/abstract_adapter'
+require 'tokyo_model/query'
 
 module TokyoModel
 
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
   ADAPTERS = [:file, :tyrant].freeze
   DATABASES = []
 
@@ -26,6 +27,10 @@ module TokyoModel
     DATABASES.each { |d| d.close }
   end
 
+  def self.query
+    Query.new(DATABASES.first)
+  end
+
   private
 
   def self.adapter(scheme)

data/lib/tokyo_model/adapters/abstract_adapter.rb

@@ -1,13 +1,19 @@
 module TokyoModel
   module Adapters
 
-    # This class exists almost exclusively to indicate the methods that all
+    class ConnectionError < StandardError ; end
+
+    # This class exists almost exclusively to document the methods that all
     # adapters must implement. The default implementation simply delegates
     # everything to the underlying database file or connection.
     class AbstractAdapter
 
       attr :db
 
+      def connection
+        @db
+      end
+
       # Delete the record identified by +pkey+.
       def out(pkey)
         @db.out(pkey)
@@ -30,11 +36,11 @@ module TokyoModel
       end
 
       # Perform a query.
-      def query(*args)
+      def query
         raise NotImplementedError.new
       end
 
-      # Delegate any unknown method calls to the underlying @db.
+      # Delegate any unknown method calls to the underlying +@db+.
       def method_missing(symbol, *args)
         @db.send(symbol, *args)
       end

data/lib/tokyo_model/adapters/file.rb

@@ -6,7 +6,6 @@ module TokyoModel
     # This adapter provides access to TokyoCabinet TDB files.
     class File < AbstractAdapter
 
-
       # Permitted open modes for accessing TDB files: +:read+, +:write+,
       # +:create+, +:truncate+, +:nolock+, +:lock_noblock+ and +:sync+
       OPEN_MODES = {
@@ -28,6 +27,10 @@ module TokyoModel
         @db.open(uri.path, args.empty? ? File.default_open_mode : File.open_mode(*args))
       end
 
+      def query
+        Query.new(TokyoCabinet::TDBQRY.new(@db))
+      end
+
       class << self
 
         # The default open mode is read/write.

data/lib/tokyo_model/adapters/tyrant.rb

@@ -16,12 +16,16 @@ module TokyoModel
       def initialize(uri, *args)
         @db = TokyoTyrant::RDBTBL::new
         if uri.scheme == "unix"
-          @db.open(uri.path, 0)
+          @db.open(uri.path, 0) || raise(ConnectionError.new(@db.errmsg(@db.ecode)))
         else
-          @db.open(uri.host, uri.port || DEFAULT_PORT)
+          @db.open(uri.host, uri.port || DEFAULT_PORT) || raise(ConnectionError.new(@db.errmsg(@db.ecode)))
         end
       end
 
+      def query
+        Query.new(TokyoTyrant::RDBQRY.new(@db))
+      end
+
     end
   end
 end

data/lib/tokyo_model/persistable.rb

@@ -8,8 +8,13 @@ module TokyoModel
 
     module ClassMethods
 
-      def  connect(uri, *args)
-        @db = TokyoModel.open(uri, *args)
+      def  db=(*args)
+        db_or_uri = args.shift
+        if db_or_uri.respond_to?(:scheme)
+          @db = TokyoModel.open(db_or_uri, *args)
+        else
+          @db = db_or_uri
+        end
       end
 
       def db
@@ -19,7 +24,7 @@ module TokyoModel
       def get(id)
         obj = new
         if record = db.get(id)
-          record.each { |k, v| obj.send("#{k}=".to_sym, v) }
+          record.each { |k, v| obj.send("#{k}=".to_sym, v) if obj.respond_to?("#{k}=".to_sym) }
           obj.id = id
         end
         obj
@@ -27,7 +32,21 @@ module TokyoModel
       alias_method :find, :get
 
       def setter_methods
-        instance_methods.select {|m| m =~ /[^=]$/ && instance_methods.include?("#{m}=") && !%w(taguri).include?(m) }
+        if !@setter_methods
+          im = instance_methods - Object.instance_methods
+          @setter_methods = im.select {|m| im.include?("#{m}=") && m =~ /[^=]$/ }
+        end
+        @setter_methods
+      end
+
+      def find(&block)
+        ids = query.conditions(&block).execute
+        ids.inject([]) { |m, o| m << get(o); m }
+      end
+
+      def query
+        type = self.to_s
+        db.query.conditions { type_is type }
       end
 
     end
@@ -37,11 +56,12 @@ module TokyoModel
     end
 
     def attributes
-      self.class.setter_methods.inject({}) do |m, o|
-        v = send(o.to_sym)
-        m[o] = v if v
-        m
+      hash = {}
+      self.class.setter_methods.each do |s|
+        val = send(s.to_sym)
+        hash[s] = val if val
       end
+      hash
     end
 
     def db
@@ -57,7 +77,7 @@ module TokyoModel
     end
 
     def put
-      db.put(id, attributes)
+      db.put(id, attributes.merge({ "type" => self.class.to_s }))
     end
     alias_method :save, :put
 

data/lib/tokyo_model/query.rb

@@ -0,0 +1,109 @@
+module TokyoModel
+
+  class Query
+
+    attr :conditions, :db_query
+
+    # Query condition: string is equal to
+    QCSTREQ   = 1
+    # Query condition: string is included in
+    QCSTRINC  = 2
+    # Query condition: string begins with
+    QCSTRBW   = 3
+    # Query condition: string ends with
+    QCSTREW   = 4
+    # Query condition: string includes all tokens in
+    QCSTRAND  = 5
+    # Query condition: string includes at least one token in
+    QCSTROR   = 6
+    # Query condition: string is equal to at least one token in
+    QCSTROREQ = 7
+    # Query condition: string matches regular expressions of
+    QCSTRRX   = 8
+    # Query condition: number is equal to
+    QCNUMEQ   = 9
+    # Query condition: number is greater than
+    QCNUMGT   = 10
+    # Query condition: number is greater than or equal to
+    QCNUMGE   = 11
+    # Query condition: number is less than
+    QCNUMLT   = 12
+    # Query condition: number is less than or equal to
+    QCNUMLE   = 13
+    # Query condition: number is between two tokens of
+    QCNUMBT   = 14
+    # Query condition: number is equal to at least one token in
+    QCNUMOREQ = 15
+    # Query condition: negation flag
+    QCNEGATE  = 1 << 24
+    # Query condition: no index flag
+    QCNOIDX   = 1 << 25
+    # Order type: string ascending
+    QOSTRASC  = 1
+    # Order type: string descending
+    QOSTRDESC = 2
+    # Order type: number ascending
+    QONUMASC  = 3
+    # Order type: number descending
+    QONUMDESC = 4
+    # Post treatment: modify the record
+    QPPUT     = 1 << 0
+    # Post treatment: remove the record
+    QPOUT     = 1 << 1
+    # Post treatment: stop the iteration
+    QPSTOP    = 1 << 24
+
+    def initialize(db_query)
+      @db_query = db_query
+      @conditions = []
+    end
+
+    def conditions(&block)
+      @conditions += QueryConditions.new.instance_eval(&block)
+      self
+    end
+
+    def execute
+      @conditions.each { |c| @db_query.addcond(*c) }
+      @db_query.search
+    end
+
+    CONDITIONS = {
+      :is          => QCSTREQ,
+      :like        => QCSTRINC,
+      :has         => QCSTROR,
+      :has_all     => QCSTRAND,
+      :equals_one  => QCSTROREQ,
+      :begins_with => QCSTRBW,
+      :ends_with   => QCSTREW,
+      :matches     => QCSTRRX,
+      :eq          => QCNUMEQ,
+      :gt          => QCNUMGT,
+      :gte         => QCNUMGE,
+      :lt          => QCNUMLT,
+      :lte         => QCNUMLE,
+      :btw         => QCNUMBT,
+      :in          => QCNUMOREQ
+    }
+  end
+
+  class QueryConditions
+
+    attr :conditions
+
+    METHODS = Query::CONDITIONS.keys.inject([]) { |m, o| m << o.to_s }.join("|")
+
+    def initialize
+      @conditions = []
+    end
+
+    def method_missing(symbol, *args)
+      symbol.to_s =~ /([a-z0-9_]+)_(#{METHODS}+)(!)?/
+      name, op, negate = $1, $2.to_sym, $3
+      op = negate ? Query::QCNEGATE | Query::CONDITIONS[op] : Query::CONDITIONS[op]
+      conditions << [name, op] + args
+    end
+
+  end
+
+end

data/test/test_basic_model.rb

@@ -1,27 +1,15 @@
 require 'test_helper'
-require File.dirname(__FILE__) + "/fixtures/post.rb"
 
 class TestBasicModel < Test::Unit::TestCase
 
   setup do
-    TokyoModel.open("file:#{dbpath}", :write, :read, :create, :truncate)
-    @post = Post.new
-    @post.title = "First post!"
-    @post.body = "Lorem ipsum dolor sit amet, consectetur adipisicing elit"
-    @post.author = "John Doe"
-    @post.permalink = "http://example.org/posts/1"
-    @post.put
-  end
-
-  teardown do
-    TokyoModel.close
-    FileUtils.rm_f dbpath
+    load_fixtures
   end
 
   context "a model" do
 
     should "have a db connection" do
-      assert_not_nil Post.db
+      assert Post.db.respond_to?(:get)
     end
 
     should "be gettable" do

data/test/test_helper.rb

@@ -5,13 +5,25 @@ require 'test/unit'
 require 'contest'
 
 require File.dirname(__FILE__) + '/../lib/tokyo_model'
+require File.dirname(__FILE__) + "/fixtures/post.rb"
 
 def tmpdir
   @tmpdir ||= File.join(File.dirname(File.expand_path(__FILE__)), "tmp")
 end
 
 def dbpath
-  "#{tmpdir}/test.tdb"
+  "#{tmpdir}/test.tct"
 end
 
-FileUtils.mkdir_p tmpdir
+def load_fixtures
+  @post = Post.new
+  @post.title = "First post!"
+  @post.body = "Lorem ipsum dolor sit amet, consectetur adipisicing elit"
+  @post.author = "John Doe"
+  @post.permalink = "http://example.org/posts/1"
+  @post.save
+end
+
+FileUtils.mkdir_p tmpdir
+TokyoModel.open("file:#{dbpath}", :write, :read, :create, :truncate)
+# TokyoModel.open("tyrant://127.0.0.1")

data/test/test_query.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class TestQuery < Test::Unit::TestCase
+
+  def setup
+    load_fixtures
+  end
+
+  def test_a_query
+    @posts = Post.find do
+      title_has! "NONE!"
+      author_is "John Doe"
+      body_matches "[a-zA-Z,\.\s]*$"
+    end
+    p @posts
+  end
+
+end

data/tokyo_model.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tokyo_model}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Adrian Mugnolo", "Norman Clarke"]
+  s.date = %q{2009-04-21}
+  s.description = %q{}
+  s.email = ["adrian@mugnolo.com", "norman@randomba.org"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.rdoc"]
+  s.files = ["History.txt", "Manifest.txt", "README.rdoc", "Rakefile", "lib/tokyo_model.rb", "lib/tokyo_model/adapters/abstract_adapter.rb", "lib/tokyo_model/adapters/file.rb", "lib/tokyo_model/adapters/tyrant.rb", "lib/tokyo_model/persistable.rb", "lib/tokyo_model/query.rb", "script/console", "script/destroy", "script/generate", "test/contest.rb", "test/fixtures/post.rb", "test/test_basic_model.rb", "test/test_file_adapter.rb", "test/test_helper.rb", "test/test_query.rb", "tokyo_model.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/rubysouth/tokyo_model}
+  s.rdoc_options = ["--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{tokyo-model}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{}
+  s.test_files = ["test/test_basic_model.rb", "test/test_file_adapter.rb", "test/test_helper.rb", "test/test_query.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.8.0"])
+    else
+      s.add_dependency(%q<newgem>, [">= 1.3.0"])
+      s.add_dependency(%q<hoe>, [">= 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<newgem>, [">= 1.3.0"])
+    s.add_dependency(%q<hoe>, [">= 1.8.0"])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rubysouth-tokyo_model
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors: 
 - Adrian Mugnolo
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-17 00:00:00 -07:00
+date: 2009-04-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,6 +55,7 @@ files:
 - lib/tokyo_model/adapters/file.rb
 - lib/tokyo_model/adapters/tyrant.rb
 - lib/tokyo_model/persistable.rb
+- lib/tokyo_model/query.rb
 - script/console
 - script/destroy
 - script/generate
@@ -63,6 +64,8 @@ files:
 - test/test_basic_model.rb
 - test/test_file_adapter.rb
 - test/test_helper.rb
+- test/test_query.rb
+- tokyo_model.gemspec
 has_rdoc: true
 homepage: http://github.com/rubysouth/tokyo_model
 post_install_message: 
@@ -94,3 +97,4 @@ test_files:
 - test/test_basic_model.rb
 - test/test_file_adapter.rb
 - test/test_helper.rb
+- test/test_query.rb