gdatastore_mapper 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '08925d9b889ae9123bcfe862754d0899f5dfda6d'
-  data.tar.gz: 553c4eba288b3bfff9ce405484714a579f2439a1
+  metadata.gz: db5faa3582a78e8bec1ae7f512679a6d1de51d0d
+  data.tar.gz: cc263821fbf1d347fb3c99b18ddfb773d7c14fae
 SHA512:
-  metadata.gz: 24e75353e1f4a497866994f9efd52bce06b77f53753addb2f240185977ecc8ee550f79400bf2025882341664adc1aacb63effc5a9c5111872fca51be1cc77924
-  data.tar.gz: 2872a7308d7aa365c371891ceaeefc77ea4d336b463da479fba01378fd2b80fcbbebb37077c9fee5302f41faa074e0a71987a780e4fcb7a1c032b440592539d8
+  metadata.gz: a9f83649f684855ab56c328416dde0831463afc7dfd85e0e7469f4c1e2f5a2e625f983ec2158acf5c7a29f5e221723485b061b3cf65c4757d00cb228b5f0c47c
+  data.tar.gz: 1bf9a85f642d1dc1301027d0ec7ce786d1d6b2badbb5005053e11750a382d8a9231fba8efcf8ca326534321aa720ecca574365616f8de4c2f78acf34207339df

data/README.md

@@ -3,11 +3,36 @@
 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.
 
+## Table of Contents
+- [Requirements](#requirements)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Model Setting](#model-setting)
+- [Persistence Methods](#persistence-methods)
+- [Scoping Methods](#scoping-methods)
+- [Timestamp](#timestamp)
+- [Associations](#associations)
+  - [One to Many](#one-to-many)
+- [Development](#development)
+
+## Requirements
+
+GdatastoreMapper requires Rails version >= 4.2 (of course it's working for Rails 5)
+
+google-cloud >= 0.27
+
+
 ## Installation
 
+Execute rails new with --skip-active-record
+```
+$ rails new your_project --skip-active-record
+```
+
 Add this line to your application's Gemfile:
 
 ```ruby
+gem 'google-cloud'
 gem 'gdatastore_mapper'
 ```
 
@@ -40,14 +65,14 @@ test:
   emulator_host: localhost:8444
 ```
 
-## Usage
+## Model Setting
 
 Only 2 things you need to do.
 
 1. To include GdatastoreMapper
 2. To set attr_accessor as column
 
-That's it!
+That's it! No need to db:migrate.
 
 ```ruby
 class Book
@@ -122,6 +147,8 @@ All records have created_at and updated_at. They will be updated automatically.
 
 ## Associations
 
+### One to Many
+
 example of one to many relationship
 
 ```ruby

data/lib/gdatastore_mapper/associations.rb

@@ -27,6 +27,11 @@ module GdatastoreMapper
     end
 
     def belongs_to model
+      if @belongs_to_models.nil?
+        @belongs_to_models = [model.to_s]
+      else
+        @belongs_to_models << model.to_s
+      end
       self.class_eval("attr_accessor :#{model.to_s + '_id'}")
 
       define_method model do
@@ -36,5 +41,9 @@ module GdatastoreMapper
       end
     end
 
+    def belongs_to_models
+      @belongs_to_models
+    end
+
   end
 end

data/lib/gdatastore_mapper/persistence.rb

@@ -8,6 +8,7 @@ module GdatastoreMapper
       entity = to_entity
       GdatastoreMapper::Session.dataset.save(entity)
       self.id = entity.key.id
+      update_owner(self, :add)
       true
     end
 
@@ -19,17 +20,41 @@ module GdatastoreMapper
     end
 
     def destroy
+      update_owner(self, :delete)
       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
+      destroy
     end
 
     def persisted?
       id.present?
     end
+
+    private
+
+    def update_owner belonging, flg = :add
+      return if self.class.belongs_to_models.nil?
+      belongings_id = belonging.class.to_s.pluralize.underscore + '_id'
+      self.class.belongs_to_models.each do |owner|
+        owner_record = belonging.send(owner)
+        existing_ids = owner_record.send(belongings_id) || []
+        owner_record.update(owner_attr(belongings_id, existing_ids, flg))
+      end
+    end
+
+    def owner_attr belongings_id, existing_ids, flg
+      owner_attr = {}
+      if flg == :add
+        existing_ids << self.id
+      elsif flg == :delete
+        existing_ids.delete(self.id)
+      end
+      owner_attr[belongings_id] = (existing_ids.uniq)
+      owner_attr
+    end
+
   end
 end

data/lib/gdatastore_mapper/relation.rb

@@ -5,6 +5,11 @@ module GdatastoreMapper
       @association = association
     end
 
+    def new attributes
+      belonging_attr = attributes.merge(@association.owner_attributes)
+      @association.belonging_klass.new(belonging_attr)
+    end
+
     def create attributes
       belonging = create_belonging attributes
       update_owner belonging

data/lib/gdatastore_mapper/scoping.rb

@@ -10,7 +10,6 @@ module GdatastoreMapper
     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?

data/lib/gdatastore_mapper/version.rb

@@ -1,3 +1,3 @@
 module GdatastoreMapper
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/rails_example/.gitignore

@@ -0,0 +1,17 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history

data/rails_example/Gemfile

@@ -0,0 +1,33 @@
+source 'https://rubygems.org'
+
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+gem 'rails', '~> 5.0.2'
+
+gem 'google-cloud'
+gem 'gdatastore_mapper', path: '../../gems/gdatastore_mapper'
+
+gem 'puma', '~> 3.0'
+gem 'sass-rails', '~> 5.0'
+gem 'uglifier', '>= 1.3.0'
+gem 'coffee-rails', '~> 4.2'
+
+gem 'jquery-rails'
+gem 'turbolinks', '~> 5'
+gem 'jbuilder', '~> 2.5'
+
+group :development, :test do
+  gem 'byebug', platform: :mri
+end
+
+group :development do
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '~> 3.0.5'
+  gem 'spring'
+  gem 'spring-watcher-listen', '~> 2.0.0'
+end
+
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/rails_example/Gemfile.lock

@@ -0,0 +1,327 @@
+PATH
+  remote: ../../gems/gdatastore_mapper
+  specs:
+    gdatastore_mapper (0.1.2bata)
+      google-cloud (~> 0.27)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.0.2)
+      actionpack (= 5.0.2)
+      nio4r (>= 1.2, < 3.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.2)
+      activesupport (= 5.0.2)
+      globalid (>= 0.3.6)
+    activemodel (5.0.2)
+      activesupport (= 5.0.2)
+    activerecord (5.0.2)
+      activemodel (= 5.0.2)
+      activesupport (= 5.0.2)
+      arel (~> 7.0)
+    activesupport (5.0.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
+    arel (7.1.4)
+    bindex (0.5.0)
+    builder (3.2.3)
+    byebug (9.0.6)
+    coderay (1.1.1)
+    coffee-rails (4.2.1)
+      coffee-script (>= 2.2.0)
+      railties (>= 4.0.0, < 5.2.x)
+    coffee-script (2.4.1)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.12.2)
+    concurrent-ruby (1.0.5)
+    declarative (0.0.9)
+    declarative-option (0.1.0)
+    digest-crc (0.4.1)
+    erubis (2.7.0)
+    execjs (2.7.0)
+    faraday (0.12.0.1)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.18)
+    globalid (0.3.7)
+      activesupport (>= 4.1.0)
+    google-api-client (0.11.1)
+      addressable (>= 2.5.1)
+      googleauth (~> 0.5)
+      httpclient (>= 2.8.1, < 3.0)
+      mime-types (>= 3.0)
+      representable (~> 3.0)
+      retriable (>= 2.0, < 4.0)
+    google-cloud (0.28.0)
+      google-cloud-bigquery (~> 0.26.0)
+      google-cloud-datastore (~> 1.0)
+      google-cloud-dns (~> 0.24.0)
+      google-cloud-error_reporting (~> 0.24.0)
+      google-cloud-language (~> 0.26.0)
+      google-cloud-logging (~> 1.0)
+      google-cloud-monitoring (~> 0.24.0)
+      google-cloud-pubsub (~> 0.24.0)
+      google-cloud-resource_manager (~> 0.24.0)
+      google-cloud-speech (~> 0.24.0)
+      google-cloud-storage (~> 1.0)
+      google-cloud-trace (~> 0.24.0)
+      google-cloud-translate (~> 0.23.0)
+      google-cloud-vision (~> 0.24.0)
+    google-cloud-bigquery (0.26.0)
+      google-api-client (~> 0.11.0)
+      google-cloud-core (~> 1.0)
+    google-cloud-core (1.0.0)
+      google-cloud-env (~> 1.0)
+      googleauth (~> 0.5.1)
+    google-cloud-datastore (1.0.0)
+      google-cloud-core (~> 1.0)
+      google-gax (~> 0.8.0)
+    google-cloud-dns (0.24.0)
+      google-api-client (~> 0.11.0)
+      google-cloud-core (~> 1.0)
+      zonefile (~> 1.04)
+    google-cloud-env (1.0.0)
+      faraday (~> 0.11)
+    google-cloud-error_reporting (0.24.0)
+      google-cloud-core (~> 1.0)
+      google-gax (~> 0.8.0)
+    google-cloud-language (0.26.2)
+      google-cloud-core (~> 1.0)
+      google-gax (~> 0.8.2)
+    google-cloud-logging (1.0.0)
+      google-cloud-core (~> 1.0)
+      google-gax (~> 0.8.0)
+      stackdriver-core (~> 1.0)
+    google-cloud-monitoring (0.24.0)
+      google-gax (~> 0.8.0)
+    google-cloud-pubsub (0.24.0)
+      google-cloud-core (~> 1.0)
+      google-gax (~> 0.8.0)
+      grpc-google-iam-v1 (~> 0.6.8)
+    google-cloud-resource_manager (0.24.1)
+      google-api-client (~> 0.11.0)
+      google-cloud-core (~> 1.0)
+    google-cloud-speech (0.24.0)
+      google-cloud-core (~> 1.0)
+      google-gax (~> 0.8.2)
+    google-cloud-storage (1.0.1)
+      digest-crc (~> 0.4)
+      google-api-client (~> 0.11.0)
+      google-cloud-core (~> 1.0)
+    google-cloud-trace (0.24.0)
+      google-cloud-core (~> 1.0)
+      google-gax (~> 0.8.0)
+      stackdriver-core (~> 1.0)
+    google-cloud-translate (0.23.0)
+      google-cloud-core (~> 1.0)
+      googleauth (~> 0.5.1)
+    google-cloud-vision (0.24.0)
+      google-cloud-core (~> 1.0)
+      google-gax (~> 0.8.0)
+    google-gax (0.8.2)
+      google-protobuf (~> 3.2)
+      googleapis-common-protos (~> 1.3.5)
+      googleauth (~> 0.5.1)
+      grpc (~> 1.0)
+      rly (~> 0.2.3)
+    google-protobuf (3.2.0.2-universal-darwin)
+    googleapis-common-protos (1.3.5)
+      google-protobuf (~> 3.2)
+      grpc (~> 1.0)
+    googleauth (0.5.1)
+      faraday (~> 0.9)
+      jwt (~> 1.4)
+      logging (~> 2.0)
+      memoist (~> 0.12)
+      multi_json (~> 1.11)
+      os (~> 0.9)
+      signet (~> 0.7)
+    grpc (1.2.2-universal-darwin)
+      google-protobuf (~> 3.1)
+      googleauth (~> 0.5.1)
+    grpc-google-iam-v1 (0.6.8)
+      googleapis-common-protos (~> 1.3.1)
+      googleauth (~> 0.5.1)
+      grpc (~> 1.0)
+    httpclient (2.8.3)
+    i18n (0.8.1)
+    jbuilder (2.6.3)
+      activesupport (>= 3.0.0, < 5.2)
+      multi_json (~> 1.2)
+    jquery-rails (4.3.1)
+      rails-dom-testing (>= 1, < 3)
+      railties (>= 4.2.0)
+      thor (>= 0.14, < 2.0)
+    jwt (1.5.6)
+    listen (3.0.8)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    little-plugger (1.1.4)
+    logging (2.2.2)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mail (2.6.4)
+      mime-types (>= 1.16, < 4)
+    memoist (0.15.0)
+    method_source (0.8.2)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.1.0)
+    minitest (5.10.1)
+    multi_json (1.12.1)
+    multipart-post (2.0.0)
+    nio4r (2.0.0)
+    nokogiri (1.7.1)
+      mini_portile2 (~> 2.1.0)
+    os (0.9.6)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.2)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    pry-doc (0.10.0)
+      pry (~> 0.9)
+      yard (~> 0.9)
+    pry-rails (0.3.6)
+      pry (>= 0.10.4)
+    public_suffix (2.0.5)
+    puma (3.8.2)
+    rack (2.0.1)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.0.2)
+      actioncable (= 5.0.2)
+      actionmailer (= 5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      activemodel (= 5.0.2)
+      activerecord (= 5.0.2)
+      activesupport (= 5.0.2)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 5.0.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.2)
+      activesupport (>= 4.2.0, < 6.0)
+      nokogiri (~> 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.0.0)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.8)
+      ffi (>= 0.5.0)
+    representable (3.0.3)
+      declarative (< 0.1.0)
+      declarative-option (< 0.2.0)
+      uber (< 0.2.0)
+    retriable (3.0.1)
+    rly (0.2.3)
+    sass (3.4.23)
+    sass-rails (5.0.6)
+      railties (>= 4.0.0, < 6)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (>= 1.1, < 3)
+    signet (0.7.3)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (~> 1.5)
+      multi_json (~> 1.10)
+    slop (3.6.0)
+    spring (2.0.1)
+      activesupport (>= 4.2)
+    spring-watcher-listen (2.0.1)
+      listen (>= 2.7, < 4.0)
+      spring (>= 1.2, < 3.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.0)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    stackdriver-core (1.0.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tilt (2.0.7)
+    turbolinks (5.0.1)
+      turbolinks-source (~> 5)
+    turbolinks-source (5.0.0)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    uber (0.1.0)
+    uglifier (3.2.0)
+      execjs (>= 0.3.0, < 3)
+    web-console (3.5.0)
+      actionview (>= 5.0)
+      activemodel (>= 5.0)
+      bindex (>= 0.4.0)
+      railties (>= 5.0)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+    yard (0.9.8)
+    zonefile (1.04)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  coffee-rails (~> 4.2)
+  gdatastore_mapper!
+  google-cloud
+  jbuilder (~> 2.5)
+  jquery-rails
+  listen (~> 3.0.5)
+  pry-byebug
+  pry-doc
+  pry-rails
+  puma (~> 3.0)
+  rails (~> 5.0.2)
+  sass-rails (~> 5.0)
+  spring
+  spring-watcher-listen (~> 2.0.0)
+  turbolinks (~> 5)
+  tzinfo-data
+  uglifier (>= 1.3.0)
+  web-console (>= 3.3.0)
+
+BUNDLED WITH
+   1.14.6

data/rails_example/README.md

@@ -0,0 +1,24 @@
+# README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...

data/rails_example/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/rails_example/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/rails_example/app/assets/javascripts/application.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require_tree .

data/rails_example/app/assets/javascripts/authors.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

data/rails_example/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the rails generate channel command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/rails_example/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/rails_example/app/assets/stylesheets/authors.scss

@@ -0,0 +1,3 @@
+// Place all the styles related to the authors controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/

data/rails_example/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end