mirah_model 0.0.1-java

data/README.md

@@ -0,0 +1,35 @@
+Mirah Model
+================
+
+Mirah Model is a Mirah ORM library for using AppEngine's datastore. It is inspired by ActiveRecord and DataMapper--particularly DataMapper. It's used by Dubious, a Rails-ish web framework.
+
+Code Examples
+------
+
+If you are familar with DataMapper's property methods this should look pretty familiar. You can define properties using #property, passing the property name and a type.
+
+    import com.google.appengine.api.datastore.* 
+
+    class Shout < Model
+      property 'title', String
+      property 'body',  Text
+    end
+
+You can set instances by updating their attrs individually,
+
+    shout = Shout.new
+    shout.title = 'foo'
+    shout.body  = 'bar'
+    shout.save
+
+or by using the update method and passing a hash
+
+    shout = Shout.new.update title: 'foo', body: 'bar'
+    shout.save
+
+Development
+------------
+
+You can build the jar by running:
+
+   rake jar

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'rubygems/package_task'
+require 'ant'
+require 'appengine-sdk'
+require 'mirah_task'
+
+
+Gem::PackageTask.new Gem::Specification.load('mirah_model.gemspec') do |pkg|
+  pkg.need_zip = true
+  pkg.need_tar = true
+end
+
+task :gem => :jar
+#require 'maven/junit/junit'
+# -- will work after maven support --JUNIT_JAR = Gem.find_files('maven/junit/junit.jar').first
+JUNIT_JAR = 'javalib/junit.jar'
+TESTING_JARS = [AppEngine::SDK::API_JAR, AppEngine::SDK::LABS_JAR, JUNIT_JAR
+] +
+  AppEngine::SDK::RUNTIME_JARS.reject {|j| j =~ /appengine-local-runtime/}
+TESTING_JARS.each {|jar| $CLASSPATH << jar}
+
+# Mirah.compiler_options = ['-V']
+
+task :default => :test
+
+task :init do
+  mkdir_p 'dist'
+  mkdir_p 'build'
+end
+
+task :clean do
+  ant.delete :quiet => true, :dir => 'build'
+  ant.delete :quiet => true, :dir => 'dist'
+end
+
+task :compile => :init do
+  # build the Duby sources
+  puts "Compiling Duby sources"
+  mirahc '.', :dir => 'src', :dest => 'build'
+end
+
+desc "run tests"
+task :compile_test => :jar do
+  puts "Compiling Duby tests"
+  mirahc '.', :dir => 'test', :dest => 'test',
+         :options => ['--classpath', Dir.pwd + "/dist/dubydatastore.jar"]
+end
+
+desc "build jar"
+task :jar => :compile do
+  ant.jar :jarfile => 'dist/dubydatastore.jar' do
+    fileset :dir => 'lib'
+    fileset :dir => 'build'
+  end
+end
+
+task :test => :compile_test do
+  ant.junit :haltonfailure => 'true', :fork => 'true' do
+    classpath :path => (TESTING_JARS + ['build', 'test']).join(":")
+    batchtest do
+      fileset :dir => "test" do
+        include :name => '**/*Test.class'
+      end
+      formatter :type => 'plain', :usefile => 'false'
+    end
+  end
+end

data/lib/mirah_model/datastore.rb

@@ -0,0 +1,375 @@
+module AppEngine
+  class DubyDatastorePlugin
+    @models = {}
+
+    TypeMap = {
+      'Category' => 'String',
+      'Email' => 'String',
+      'Link' => 'String',
+      'PhoneNumber' => 'String',
+      'PostalAddress' => 'String',
+      'Text' => 'String',
+      'Blob' => 'byte[]',
+      'ShortBlob' => 'byte[]',
+      'Rating' => 'int',
+      'Long' => 'long',
+      'Double' => 'double',
+      'Boolean' => 'boolean'
+    }
+
+    Primitives = ['Long', 'Double', 'Boolean', 'Rating']
+
+    Boxes = {
+      'int' => 'Integer',
+      'boolean' => 'Boolean',
+      'long' => 'Long',
+      'double' => 'Double',
+    }
+
+    Defaults = {
+      'Rating' => '0',
+      'Long' => 'long(0)',
+      'Double' => '0.0',
+      'Boolean' => 'false',
+      'Blob' => 'byte[].cast(nil)',
+      'ShortBlob' => 'byte[].cast(nil)',
+    }
+
+    Conversions = {
+      'Category' => 'getCategory',
+      'Email' => 'getEmail',
+      'Link' => 'getValue',
+      'PhoneNumber' => 'getNumber',
+      'PostalAddress' => 'getAddress',
+      'Text' => 'getValue',
+      'Blob' => 'getBytes',
+      'ShortBlob' => 'getBytes',
+      'Long' => 'longValue',
+      'Double' => 'doubleValue',
+      'Boolean' => 'booleanValue',
+      'Rating' => 'getRating',
+    }
+
+    class ModelState
+      include Duby::AST
+      attr_reader :kind, :query, :read, :save, :transformer
+
+      def initialize(transformer, klass, parent, position, ast)
+        @transformer = transformer
+        @kind = klass.name.split('.')[-1]
+        init_query(klass.name, parent, position, ast)
+        init_static(parent, ast)
+        init_read(parent, position, ast)
+        init_save(parent, position, ast)
+      end
+
+      def init_query(classname, parent, position, ast)
+        name = "#{classname}$Query"
+        @query = ClassDefinition.new(parent, position, name) do |classdef|
+          queryinit = <<-EOF
+            def initialize; end
+
+            def kind
+              "#{kind}"
+            end
+
+            def first
+              it = _prepare.asIterator
+              if it.hasNext
+                e = Entity(it.next)
+                m = #{kind}.new
+                m._read_from(e)
+                m
+              else
+                #{kind}(nil)
+              end
+            end
+
+            def run
+              entities = _prepare.asList(_options)
+              models = #{kind}[entities.size]
+              it = entities.iterator
+              i = 0
+              while (it.hasNext)
+                e = Entity(it.next)
+                m = #{kind}.new
+                m._read_from(e)
+                models[i] = m
+                i += 1
+              end
+              models
+            end
+
+            def sort(name:String)
+              sort(name, false)
+            end
+
+            def sort(name:String, descending:boolean)
+              _sort(name, descending)
+              self
+            end
+          EOF
+          [Duby::AST.type(nil, 'com.google.appengine.ext.duby.db.DQuery'),
+           eval(classdef, queryinit)]
+        end
+        ast << @query
+      end
+
+      def init_read(parent, position, ast)
+        @read = eval(parent, <<-EOF)
+          def _read_from(e:Entity)
+            self.entity = e
+            nil
+          end
+        EOF
+        ast << @read
+        get_properties = eval(parent, <<-EOF)
+          def properties
+            result = super()
+            nil
+            result
+          end
+        EOF
+        @get_properties = get_properties.body.children[1] =
+            Duby::AST::Body.new(get_properties.body, position)
+        ast << get_properties
+        update = eval(parent, <<-EOF)
+          def update(properties:Map)
+            nil
+            self
+          end
+        EOF
+        @update = update.body.children[0] = Body.new(update.body, position) {[]}
+        ast << update
+      end
+
+      def init_save(parent, position, ast)
+        @save = eval(parent, <<-EOF)
+          def _save_to(e:Entity)
+          end
+        EOF
+        @save.body = Body.new(@save, position) {[]}
+        ast << @save
+      end
+
+      def init_static(parent, ast)
+        # TODO These imports don't work any more.  Figure out how to fix that.
+        scope = ast.static_scope
+        package = "#{scope.package}." unless scope.package.empty?
+        scope.import('java.util.Map', 'Map')
+        scope.import("#{package}#{kind}$Query", "#{kind}__Query__")
+        %w( Entity Blob Category Email GeoPt IMHandle Key
+            Link PhoneNumber PostalAddress Rating ShortBlob
+            Text KeyFactory EntityNotFoundException ).each do |name|
+          scope.import("com.google.appengine.api.datastore.#{name}", name)
+        end
+        ast << eval(parent, <<-EOF)
+          def initialize
+            super
+          end
+
+          def initialize(key_name:String)
+            super
+          end
+          
+          def initialize(parent:Model)
+            super
+          end
+          
+          def initialize(parent:Key)
+            super
+          end
+          
+          def initialize(parent:Model, key_name:String)
+            super
+          end
+          
+          def initialize(parent:Key, key_name:String)
+            super
+          end
+
+          def self.get(key:Key)
+            begin
+              m = #{kind}.new
+              m._read_from(Model._datastore.get(key))
+              m
+            rescue EntityNotFoundException
+              nil
+            end
+          end
+
+          def self.get(key_name:String)
+            get(KeyFactory.createKey("#{kind}", key_name))
+          end
+
+          def self.get(id:long)
+            get(KeyFactory.createKey("#{kind}", id))
+          end
+
+          def self.get(parent:Key, key_name:String)
+            get(KeyFactory.createKey(parent, "#{kind}", key_name))
+          end
+
+          def self.get(parent:Key, id:long)
+            get(KeyFactory.createKey(parent, "#{kind}", id))
+          end
+
+          def self.get(parent:Model, key_name:String)
+            get(KeyFactory.createKey(parent.key, "#{kind}", key_name))
+          end
+
+          def self.get(parent:Model, id:long)
+            get(KeyFactory.createKey(parent.key, "#{kind}", id))
+          end
+
+          def self.all
+            #{kind}__Query__.new
+          end
+        EOF
+      end
+
+      def eval(parent, src)
+        transformer.eval(src, __FILE__, parent)
+      end
+
+      def extend_query(code)
+        query.body << eval(query.body, code)
+      end
+
+      def extend_update(code)
+        @update << eval(@update, code)
+      end
+
+      def extend_get_properties(code)
+        @get_properties << eval(@get_properties, code)
+      end
+
+      def extend_read(code)
+        code = 'e=nil;' + code
+        eval(read.body, code).children[1..-1].each do |node|
+          read.body << node
+        end
+      end
+
+      def extend_save(code)
+        code = 'e=nil;' + code
+        eval(save.body, code).children[1..-1].each do |node|
+          save.body << node
+        end
+      end
+    end
+
+    def self.find_class(node)
+      node = node.parent until Duby::AST::ClassDefinition === node
+      node
+    end
+
+    def self.to_datastore(type, value)
+      if Primitives.include?(type)
+        "#{type}.new(#{value})"
+      elsif TypeMap.include?(type)
+        "(#{value} ? #{type}.new(#{value}) : nil)"
+      else
+        value
+      end
+    end
+
+    def self.from_datastore(type, value)
+      duby_type = TypeMap[type]
+      if duby_type
+        default = Defaults.fetch(type, "#{duby_type}(nil)")
+        conversion = Conversions[type]
+        "(#{value} ? #{type}(#{value}).#{conversion} : #{default})"
+      else
+        "#{type}(#{value})"
+      end
+    end
+
+
+    def self.add_property(name, type, transformer, fcall)
+      if transformer.state != @state
+        reset
+        @state = transformer.state
+      end
+      parent = fcall.parent
+      name = name.literal
+      type = type.name
+      type = 'Long' if type == 'Integer'
+
+      result = Duby::AST::ScopedBody.new(parent, fcall.position) {[]}
+      result.static_scope = fcall.scope.static_scope
+      klass = find_class(parent)
+      unless @models[klass]
+        @models[klass] = ModelState.new(
+            transformer, klass, parent, fcall.position, result)
+      end
+      model = @models[klass]
+
+      duby_type = TypeMap.fetch(type, type)
+      coercion = "coerce_" + duby_type.downcase.sub("[]", "s")
+
+      if duby_type == 'List'
+        model.extend_query(<<-EOF)
+          def #{name}(value:Object)
+            returns :void
+            _query.addFilter("#{name}", _eq_op, value)
+          end
+        EOF
+      else
+        model.extend_query(<<-EOF)
+          def #{name}(value:#{duby_type})
+            returns :void
+            _query.addFilter("#{name}", _eq_op, #{to_datastore(type, 'value')})
+          end
+        EOF
+      end
+      temp = transformer.tmp
+
+      model.extend_read(<<-EOF)
+        #{temp} = e.getProperty("#{name}")
+        @#{name} = #{from_datastore(type, temp)}
+      EOF
+
+      model.extend_save(<<-EOF)
+        e.setProperty("#{name}", #{to_datastore(type, '@' + name)})
+      EOF
+
+      model.extend_update(<<-EOF)
+        self.#{name} = properties.get("#{name}") if properties.containsKey("#{name}")
+      EOF
+
+      model.extend_get_properties(<<-EOF)
+        result.put("#{name}", #{maybe_box(duby_type, 'self.' + name)})
+      EOF
+
+      result << model.eval(parent, <<-EOF)
+        def #{name}
+          @#{name}
+        end
+
+        def #{name}=(value:#{duby_type})
+          @#{name} = value
+        end
+
+        def #{name}=(value:Object)
+          self.#{name} = #{coercion}(value)
+        end
+      EOF
+
+      result
+    end
+
+    def self.maybe_box(duby_type, value)
+      if Boxes.include?(duby_type)
+        "#{Boxes[duby_type]}.valueOf(#{value})"
+      else
+        value
+      end
+    end
+
+    def self.reset
+      @models = {}
+    end
+  end
+  ::Duby.plugins << DubyDatastorePlugin
+end

data/test/model_test.mirah

@@ -0,0 +1,115 @@
+package com.google.appengine.ext.duby.db
+
+import com.google.appengine.tools.development.testing.LocalDatastoreServiceTestConfig
+import com.google.appengine.tools.development.testing.LocalServiceTestConfig
+import com.google.appengine.tools.development.testing.LocalServiceTestHelper
+
+import org.junit.After
+import org.junit.Before
+import org.junit.Test
+import org.junit.Assert
+
+import com.google.appengine.api.datastore.Blob
+import com.google.appengine.api.datastore.Category
+import com.google.appengine.api.datastore.Email
+import com.google.appengine.api.datastore.GeoPt
+import com.google.appengine.api.datastore.IMHandle
+import com.google.appengine.api.datastore.Key
+import com.google.appengine.api.datastore.Link
+import com.google.appengine.api.datastore.PhoneNumber
+import com.google.appengine.api.datastore.PostalAddress
+import com.google.appengine.api.datastore.Rating
+import com.google.appengine.api.datastore.ShortBlob
+import com.google.appengine.api.datastore.Text
+import java.util.Date
+import java.util.HashMap
+import java.util.List
+import java.util.ArrayList
+import com.google.appengine.api.users.User
+
+class TestModel < Model
+  property 'date', Date
+  property 'akey', Key
+  property 'blob', Blob
+  property 'shortblob', ShortBlob
+  property 'category', Category
+  property 'email', Email
+  property 'geopt', GeoPt
+  property 'imhandle', IMHandle
+  property 'link', Link
+  property 'phonenumber', PhoneNumber
+  property 'address', PostalAddress
+  property 'rating', Rating
+  property 'text', Text
+  property 'string', String
+  property 'integer', Long
+  property 'afloat', Double
+  property 'user', User
+  property 'list', List
+end
+
+class ModelTest
+  include Assert
+
+  def helper
+    @helper ||= begin
+      configs = LocalServiceTestConfig[1]
+      configs[0] = LocalDatastoreServiceTestConfig.new
+      LocalServiceTestHelper.new(configs)
+    end
+  end
+
+  $Before
+  def setup
+    returns void
+    helper.setUp
+  end
+
+  $After
+  def teardown
+    returns void
+    helper.tearDown
+  end
+
+  $Test
+  def test_get_and_put
+    returns void
+    e = TestModel.new
+    e.string = "Hello"
+    e.save
+    e2 = TestModel.get(e.key)
+    assertEquals("Hello", e2.string)
+    assertEquals(e.key, e2.key)
+  end
+
+  $Test
+  def test_sort
+    returns void
+    # just make sure it compiles
+    TestModel.all.sort('link').run
+  end
+
+  $Test
+  def test_properties
+    returns void
+    e = TestModel.new
+    e.string = "Hi"
+    e.rating = 10
+    properties = e.properties
+    assertEquals("Hi", properties.get("string"))
+    assertEquals(Integer.valueOf(10), properties.get("rating"))
+    assertTrue(properties.containsKey("blob"))
+    assertEquals(nil, properties.get("blob"))
+  end
+
+  $Test
+  def test_query_list
+    returns void
+    e = TestModel.new
+    e.list = ["a", "b", "c"]
+    e.save
+    e2 = TestModel.all.list("b").first
+    assertEquals(e.key, e2.key)
+  end
+  # TODO more tests.
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: mirah_model
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+    - 0
+    - 0
+    - 1
+  version: 0.0.1
+platform: java
+authors: 
+  - Ryan Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-15 08:47:11.863000 -07:00
+default_executable: 
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: mirah
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 0
+              - 0
+              - 4
+            version: 0.0.4
+    type: :runtime
+    version_requirements: *id001
+  - !ruby/object:Gem::Dependency 
+    name: appengine-sdk
+    prerelease: false
+    requirement: &id002 !ruby/object:Gem::Requirement 
+      requirements: 
+        - - ~>
+          - !ruby/object:Gem::Version 
+            segments: 
+              - 1
+              - 4
+              - 0
+            version: 1.4.0
+    type: :runtime
+    version_requirements: *id002
+description: Mirah Model is a ORM library for App Engine's datastore. It is inspired by ActiveRecord and DataMapper. It's used by Dubious, a Rails-ish web framework.
+email: 
+  - ribrdb@google.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+  - README.md
+files: 
+  - lib/mirah_model/datastore.rb
+  - test/model_test.mirah
+  - test/com/google/appengine/ext/duby/db/ModelTest.class
+  - test/com/google/appengine/ext/duby/db/TestModel$Query.class
+  - test/com/google/appengine/ext/duby/db/TestModel.class
+  - README.md
+  - Rakefile
+has_rdoc: true
+homepage: http://www.mirah.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+  - --main
+  - README.md
+require_paths: 
+  - lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+          - 0
+        version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Mirah Model is a ORM library for App Engine's datastore.
+test_files: []
+