iseshima_store 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 438924eba446e1d4dc32b6aafa50e06b72d9f8fe
-  data.tar.gz: 951f35188f1b536c4adf93508d23c5a25a86d0ab
+  metadata.gz: ad2a0c29f44f30df8ffc1b1bf676a9370731e13f
+  data.tar.gz: afa1dfa84d0ed4c3c6e8a3e2f816b2bc58ce971f
 SHA512:
-  metadata.gz: 22e6b0c06186a3c1dd5f94b3a553c75305a944b587c28787b137299837ff6eed2f3fa1415028a2c4e423894dc90006400e8308a5128212c6fa454f729ccf1f60
-  data.tar.gz: fa1824a8d2d212b156f6d77baa579c13ba587faa71d11e553c515e6b258a69253b44e513efb9cab22c0333efbe678f4e6523a298ee478823fb7576d9a21a178d
+  metadata.gz: ddfe993d85bb0aca3dc33d3eececd4bff23a710b670bee4a1c4e7550deef7cc726bea1395de39302cd0a31827ddefc6c364f552aa987d891434a4581e386788b
+  data.tar.gz: f84ce3880a1891d91fe213d72b38d7164849c488bc593eacf340e124c79b4278820287c8bb75f8fab21a22ec343b7b9c10d0f91ed853b34d2e93bbd6068aa4af

data/README.md

@@ -1,4 +1,4 @@
-# IseshimaStore
+# IseshimaStore :dolls:
 
 Simple ruby ORM for Google Cloud Datastore.
 
@@ -20,6 +20,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Setup
+
 You need to set project_id.
 
 ```
@@ -28,17 +30,53 @@ IseshimaStore::Connection.configure do |config|
 end
 ```
 
-Iseshima Store depends on `gcloud-ruby` which uses ENV variables.
+Iseshima Store depends on `gcloud-ruby` which uses ENV variables, you can set your variables through ENV.
+
+### Model
+
+```
+class User
+  include IseshimaStore::Base
+  attr_accessor :name, :email
+end
+```
+
+The only thing you have to do is just include `IseshimaStore::Base` in your model class.
+Any class is ok to use.
+
+### Create
+
+```
+user = User.new
+user.email = 'test@test.com'
+user.name = 'hoge@fuga.com'
+user.save!
+```
+
+IseshimaStore does not have validations. 
+Another gem like `ActiveModel` is recommended to combine.
 
-## Development
+### Finder
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+users = User.where(email: 'test@test.com')
+user = User.find_by(email: 'test@test.com')
+user = User.find(12345) # id
+```
+
+### Low level search
+
+```
+query = Gcloud::Datastore::Query.new
+query.kind('User')
+query.where('email', '=', 'test@test.com')
+res = User.search(query: query)
+users = res[:records]
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+If you need `limit` & `cursor`, use this API.
 
-## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/iseshima_store. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/iseshima_store/base.rb

@@ -1,18 +1,49 @@
+require 'forwardable'
 require 'gcloud/datastore'
+require 'iseshima_store/relation'
+
+#http://googlecloudplatform.github.io/gcloud-ruby/docs/master/Gcloud/Datastore.html
 
 module IseshimaStore
   module Base
+
     def self.included(klass)
+      klass.extend SingleForwardable
       klass.extend ClassMethods
+      klass.def_delegators :scoping, :where, :all, :to_a
+
+      klass.instance_eval do
+        attr_accessor :created_at, :description
+      end
     end
 
     module ClassMethods
       attr_reader :properties
 
+      def scoping
+        IseshimaStore::Relation.new(self)
+      end
+
+      def find(_id)
+        datastore = IseshimaStore::Connection.current
+        key = datastore.key(self.to_s, _id.to_i)
+        entity = datastore.find(key)
+        from_entity(entity)
+      end
+
       def attr_properties(*args)
         @properties = args
       end
 
+      def find_by(hash)
+        key, value = hash.keys.first.to_s, hash.values.first.to_s
+        query = Gcloud::Datastore::Query.new
+        query.kind(self.to_s)
+        query.where(key, '=', value)
+        results = IseshimaStore::Connection.current.run(query)
+        results.map { |entity| from_entity(entity) }.first
+      end
+
       def from_entity(entity)
         instance = self.new
         instance.id = entity.key.id
@@ -22,11 +53,17 @@ module IseshimaStore
         instance
       end
 
-      def query(options = {})
-        query = Gcloud::Datastore::Query.new
-        query.kind(self.to_s)
-        query.limit options[:limit]   if options[:limit]
-        query.cursor options[:cursor] if options[:cursor]
+      def search(options = {})
+        query =
+          if options[:query]
+            options[:query]
+          else
+            query = Gcloud::Datastore::Query.new
+            query.kind(self.to_s)
+            query.limit(options[:limit]) if options[:limit]
+            query.cursor(options[:cursor]) if options[:cursor]
+            query
+          end
 
         results = IseshimaStore::Connection.current.run(query)
         records = results.map { |entity| from_entity(entity) }
@@ -46,10 +83,16 @@ module IseshimaStore
       self
     end
 
+    def destroy
+      entity = to_entity
+      IseshimaStore::Connection.current.delete(entity)
+    end
+
     def to_entity
       entity = Gcloud::Datastore::Entity.new
       entity.key = Gcloud::Datastore::Key.new(self.class.to_s, id)
       self.class.properties.each do |property|
+        property = property.to_s
         entity[property] = send(property)
       end
       entity

data/lib/iseshima_store/query_methods.rb

@@ -0,0 +1,31 @@
+module IseshimaStore
+  module QueryMethods
+    def where(condition)
+      spawn.where!(condition)
+    end
+
+    def where!(condition)
+      @where_clause += condition
+      self
+    end
+
+    def all
+      to_a
+    end
+
+    def to_a
+      query = Gcloud::Datastore::Query.new
+      query.kind(@klass.to_s)
+      @where_clause.conditions.each do |condition|
+        query.where(*condition)
+      end
+
+      results = IseshimaStore::Connection.current.run(query)
+      results.map { |entity| @klass.from_entity(entity) }
+    end
+
+    def inspect
+      to_a.inspect
+    end
+  end
+end

data/lib/iseshima_store/relation.rb

@@ -0,0 +1,23 @@
+require 'iseshima_store/query_methods'
+require 'iseshima_store/where_clause'
+
+module IseshimaStore
+  class Relation
+    include Enumerable
+    include IseshimaStore::QueryMethods
+    attr_accessor :where_clause
+
+    def initialize(klass)
+      @klass = klass
+      @where_clause = IseshimaStore::WhereClause.new
+    end
+
+    def spawn
+      clone
+    end
+
+    def each
+      to_a.each { |obj| yield obj }
+    end
+  end
+end

data/lib/iseshima_store/version.rb

@@ -1,3 +1,3 @@
 module IseshimaStore
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/iseshima_store/where_clause.rb

@@ -0,0 +1,27 @@
+module IseshimaStore
+  class WhereClause
+    attr_reader :conditions
+
+    def initialize
+      @conditions = []
+    end
+
+    def +(condition)
+
+      # conditions like where(name: 'taro', email: 'taro@gmail.com')
+      if condition.is_a?(Hash)
+        condition.each do |key, value|
+          @conditions << [key.to_s, '=', value]
+        end
+      # condisions like where('age', '>=', 16)
+      elsif condition.is_a?(Array) && condition.length == 3
+        @conditions << condition
+      # Other
+      else
+        raise ArgumentError.new("wrong format of arguments")
+      end
+
+      self
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iseshima_store
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - kotohata
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-08 00:00:00.000000000 Z
+date: 2016-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,7 +86,10 @@ files:
 - lib/iseshima_store.rb
 - lib/iseshima_store/base.rb
 - lib/iseshima_store/connection.rb
+- lib/iseshima_store/query_methods.rb
+- lib/iseshima_store/relation.rb
 - lib/iseshima_store/version.rb
+- lib/iseshima_store/where_clause.rb
 homepage: https://github.com/attracie/iseshima_store
 licenses:
 - MIT