gdatastore_mapper 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8339e4271469d355d8321d712d6848c6e5c9e88f
-  data.tar.gz: fcfbbce79a36070aa8aaf454045ef5da407c5383
+  metadata.gz: 252614e80440189db611c059b54b585ef35fb463
+  data.tar.gz: 327bfa042abefc8ab140922550911efc6b156806
 SHA512:
-  metadata.gz: 65c1b76fe9def6a043986b51845e390123394548f35847692e4d7dfcc01e478feffe74db900d4ad9a9aca4ab5670df2bb39b51848472d1f54c9772a528874cc2
-  data.tar.gz: 1493d956650d1b67a5190a85c6f927643c5902db011e67520e90badbf802e0af8d24dd81f024cab6756d6c32a3b937eace21a1e33fddcd614ceed133eee924c4
+  metadata.gz: dbd509bfd392f50b11e5bbf1c331932915b8d2984637c20d16788be5bafa1a718493c777a7491ecda8fdea11a3a103c2169866430595a2a9c74fdb345725f221
+  data.tar.gz: ffa79b0e909e5912fad1fbf1d2f3977934b09a75f8148adf652877467fc18ab863cbcde423f8abbd88c738f2daa923256fc416480dc0e77806bd72720c605bbb

data/Gemfile

@@ -3,6 +3,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in gdatastore_mapper.gemspec
 gemspec
 
+gem 'activemodel', '~> 5.0.1'
+gem 'activesupport', '~> 5.0.1'
+gem 'rake'
+
 group :test do
   gem 'byebug', platform: :mri
   gem 'factory_girl_rails', require: false

data/README.md

@@ -1,8 +1,7 @@
 # GdatastoreMapper
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gdatastore_mapper`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+GdatastoreMapper is a mapper framework for Google Cloud Datastore in Ruby / Ruby on Rails
+Once you install GdatastoreMapper you can use Google Cloud Datastore like ActiveRecord.
 
 ## Installation
 
@@ -20,9 +19,80 @@ Or install it yourself as:
 
     $ gem install gdatastore_mapper
 
+## Configuration
+
+GdatastoreMapper configuration can be done through a database.yml. The simplest configuration is as follows, which sets the emulator_host to "localhost:8444" and dataset_id.
+
+```
+# config/database.yml
+production:
+  dataset_id: your-google-cloud-platform-project-id
+
+staging:
+  dataset_id: your-google-cloud-platform-project-id
+
+development:
+  dataset_id: your-google-cloud-platform-project-id
+  emulator_host: localhost:8444
+
+test:
+  dataset_id: your-google-cloud-platform-project-id
+  emulator_host: localhost:8444
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+Only 2 things you need to do.
+
+1 To include GdatastoreMapper
+2 To set attr_accessor as column
+
+That's it!
+
+```ruby
+class Book
+  include GdatastoreMapper::Base
+
+  attr_accessor :title, :author
+end
+```
+
+## Persistence Methods
+
+```
+book = Book.new
+book.title = 'Harry Potter'
+book.save
+```
+```
+book = Book.new(title: 'Harry Potter')
+book.save
+```
+```
+Book.create(title: 'Harry Potter'
+```
+```
+book.update(title: 'Harry Potter 2'
+```
+```
+book.delete
+```
+
+## Scoping Methods
+
+```
+Book.where(title: 'Harry Potter')
+```
+```
+Book.find(12)
+```
+```
+Book.find_by(title: 'Harry Potter')
+```
+```
+Book.order(title: :asc)
+```
+
 
 ## Development
 

data/gdatastore_mapper.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Google Cloud Datastore Mapper in Ruby / Ruby on Rails}
   spec.description   = %q{Google Cloud Datastore ORM/ODM (Mapper) in Ruby and Ruby on Rails}
-  spec.homepage      = "https://github.com/shinyaK14/gcloud_orm_ruby"
+  spec.homepage      = "https://github.com/shinyaK14/gdatastore_mapper"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/gdatastore_mapper/associations.rb

@@ -0,0 +1,20 @@
+require "google/cloud"
+
+module GdatastoreMapper
+  module Associations
+
+    def has_many models
+
+    end
+
+    def belongs_to model
+      # if @belongs_to_mode.defined?
+      @belongs = model
+
+      define_method @belongs do
+        p 'succseed'
+      end
+    end
+
+  end
+end

data/lib/gdatastore_mapper/base.rb

@@ -0,0 +1,70 @@
+require "google/cloud/datastore"
+require "gdatastore_mapper/session"
+require "gdatastore_mapper/scoping"
+require "gdatastore_mapper/associations"
+require "gdatastore_mapper/persistence"
+
+module GdatastoreMapper
+  module Base
+    extend ActiveSupport::Concern
+    include ActiveModel::Model
+    include ActiveModel::Validations
+
+    attr_accessor :id, :created_at, :updated_at
+
+    def self.included(klass)
+      klass.extend Scoping
+      klass.extend Associations
+      klass.include Persistence
+    end
+
+    module ClassMethods
+
+      def attr_accessor(*vars)
+        @attributes ||= []
+        @attributes.concat vars
+        super
+      end
+
+      def attributes
+        @attributes.reject do |attr|
+          [:id, :created_at, :updated_at].include? attr
+        end
+      end
+
+      def from_entity entity
+        record = self.new
+        record.id = entity.key.id
+        entity.properties.to_hash.each do |name, value|
+          record.send "#{name}=", value if record.respond_to? "#{name}="
+        end
+        record
+      end
+
+      def create params
+        record = self.new params
+        record.save
+        record
+      end
+
+    end
+
+    def attributes
+      self.class.attributes
+    end
+
+    def to_entity
+      entity = Google::Cloud::Datastore::Entity.new
+      entity.key = Google::Cloud::Datastore::Key.new self.class.to_s, id
+
+      attributes.each do |attribute|
+        entity[attribute] = self.send attribute if self.send attribute
+      end
+
+      entity['created_at'] = id ? self.created_at : Time.zone.now
+      entity["updated_at"] = Time.zone.now
+      entity
+    end
+
+  end
+end

data/lib/gdatastore_mapper/persistence.rb

@@ -0,0 +1,35 @@
+require "google/cloud"
+
+module GdatastoreMapper
+  module Persistence
+
+    def save
+      return false if !valid?
+      entity = to_entity
+      GdatastoreMapper::Session.dataset.save(entity)
+      self.id = entity.key.id
+      true
+    end
+
+    def update attributes
+      attributes.each do |name, value|
+        send "#{name}=", value if respond_to? "#{name}="
+      end
+      save
+    end
+
+    def destroy
+      GdatastoreMapper::Session.dataset.delete \
+        Google::Cloud::Datastore::Key.new self.class.to_s, id
+    end
+
+    def delete
+      GdatastoreMapper::Session.dataset.delete \
+        Google::Cloud::Datastore::Key.new self.class.to_s, id
+    end
+
+    def persisted?
+      id.present?
+    end
+  end
+end

data/lib/gdatastore_mapper/relation.rb

@@ -0,0 +1,5 @@
+module GdatastoreMapper
+  class Relation
+    include Enumerable
+  end
+end

data/lib/gdatastore_mapper/scoping.rb

@@ -0,0 +1,55 @@
+require "google/cloud"
+
+module GdatastoreMapper
+  module Scoping
+
+    def where condition
+      return nil unless condition.is_a?(Hash)
+      entities = dataset_run(where_query condition)
+    end
+
+    def find id
+      return nil unless id.is_a?(Fixnum)
+      query = Google::Cloud::Datastore::Key.new self.to_s, id.to_i
+      entities = GdatastoreMapper::Session.dataset.lookup query
+      from_entity entities.first if entities.any?
+    end
+
+    def find_by condition
+      return nil unless condition.is_a?(Hash)
+      where(condition)&.first
+    end
+
+    def order condition
+      return nil unless condition.is_a?(Hash)
+      dataset_run(order_query condition)
+    end
+
+    private
+
+    def where_query condition
+      query = Google::Cloud::Datastore::Query.new
+      query.kind self.to_s
+      condition.each do |property, value|
+        query.where(property.to_s, '=', value)
+      end
+      query
+    end
+
+    def order_query condition
+      query = Google::Cloud::Datastore::Query.new
+      query.kind self.to_s
+      condition.each do |property, value|
+        query.order(property.to_s, value)
+      end
+      query
+    end
+
+    def dataset_run query
+      entities = GdatastoreMapper::Session.dataset.run query
+      entities.map do |entity|
+        from_entity entity
+      end
+    end
+  end
+end

data/lib/gdatastore_mapper/session.rb

@@ -0,0 +1,18 @@
+require "google/cloud"
+
+module GdatastoreMapper
+  class Session
+
+    def self.dataset
+      config = Rails.application.config.database_configuration[Rails.env]
+      @dataset ||= Google::Cloud::Datastore.new(
+        project: config['dataset_id'],
+        emulator_host: config['emulator_host']
+      )
+    end
+
+    def self.destroy
+      @dataset = nil
+    end
+  end
+end

data/lib/gdatastore_mapper/version.rb

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

data/lib/gdatastore_mapper.rb

@@ -1,5 +1,8 @@
+require 'active_support/concern'
+require 'active_model'
+
 require "gdatastore_mapper/version"
+require "gdatastore_mapper/session"
+require "gdatastore_mapper/base"
+
 
-module GdatastoreMapper
-  # Your code goes here...
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gdatastore_mapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shinya Kitamura
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-05 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -85,8 +85,14 @@ files:
 - bin/setup
 - gdatastore_mapper.gemspec
 - lib/gdatastore_mapper.rb
+- lib/gdatastore_mapper/associations.rb
+- lib/gdatastore_mapper/base.rb
+- lib/gdatastore_mapper/persistence.rb
+- lib/gdatastore_mapper/relation.rb
+- lib/gdatastore_mapper/scoping.rb
+- lib/gdatastore_mapper/session.rb
 - lib/gdatastore_mapper/version.rb
-homepage: https://github.com/shinyaK14/gcloud_orm_ruby
+homepage: https://github.com/shinyaK14/gdatastore_mapper
 licenses:
 - MIT
 metadata: {}