firestore-odm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 46f4499f36b15866c173936a87f131a1dcd577a910ae756e639e8bb813f40d37
+  data.tar.gz: aa51288692a8f243edaef885845094f432430a235d76f3e099adbd4da2042894
+SHA512:
+  metadata.gz: e0357329bb07784d50c21c314c6060bd3aef22b6d09021c18e321fb7322274de2f6f945d65a199df80765207109ddbefec3ade2c21e1781b8fb204497519d731
+  data.tar.gz: 3092565a2150f89088e53ab8b081f797da1c2c99937170f798d8b472a9fa459af79ac46a9c20bbd347713c7572ca436a2f4d41278601cd0d40d5db5dd3ce48bc

data/lib/firestore-odm.rb

@@ -0,0 +1,17 @@
+require_relative 'firestore-odm/document'
+require_relative 'firestore-odm/model'
+
+class Google::Cloud::Firestore::DocumentReference
+  def to_s
+    document_id
+  end
+end
+
+class Module
+  # Defines a setter method.
+  # @param name [String, Symbol]
+  # @param block
+  def define_setter_method name, &block
+    define_method("#{name}=", &block)
+  end
+end

data/lib/firestore-odm/collection.rb

@@ -0,0 +1,47 @@
+require 'google/cloud/firestore'
+
+module FirestoreODM
+  module Collection
+    # Returns the collection used by the model.
+    # @param root [Google::Cloud::Firestore::DocumentReference]
+    # @return [Google::Cloud::Firestore::CollectionReference] the collection.
+    def collection root = nil
+      (root or Google::Cloud::Firestore.new).collection @path
+    end
+
+    # Sets the collection name.
+    # @param name [String, Symbol] the collection name.
+    def path name
+      @path = name
+      return
+    end
+
+    # Creates a document.
+    # @return [FirestoreODM::Model] the document.
+    def create opts = {}, &block
+      block.call o = self.new
+      doc = collection(opts[:relative_to]).add o.changes
+      self.new doc
+    end
+
+    # Creates a document.
+    # @param id [String] the document id.
+    # @param root [Google::Cloud::Firestore::DocumentReference]
+    # @return [FirestoreODM::Model] the document.
+    def create_with_id id, opts = {}, &block
+      block.call o = self.new
+
+      doc = collection(opts[:relative_to]).doc id
+      doc.create o.changes
+      self.from_id id
+    end
+
+    # Gets a document.
+    # @param id [String] 
+    # @return [FirestoreODM::Model] the document.
+    def from_id id, opts = {}
+      doc = collection(opts[:relative_to]).doc id
+      self.new doc
+    end
+  end
+end

data/lib/firestore-odm/document.rb

@@ -0,0 +1,75 @@
+require 'json'
+
+module FirestoreODM
+  class Document
+    attr_accessor :document
+    attr_reader :data, :changes
+
+    # Constructor.
+    # @param document [Google::Cloud::Firestore::DocumentReference] the document reference.
+    def initialize document = nil
+      unless document.nil?
+        @document = document
+        @data     = document.get.data
+      end
+
+      discard_changes
+    end
+
+    # Gets the document id.
+    # @return [String] the document id.
+    def id
+      document.document_id
+    end
+
+    # Gets the document path
+    # @return [String] the document path.
+    def path
+      document.document_path
+    end
+
+    # Saves any changes made to the document.
+    def save
+      document.update changes
+      @data = document.get.data
+      discard_changes
+      return
+    end
+
+    # Discards any changes made to the document.
+    def discard_changes
+      @changes = {}
+      return
+    end
+
+    # Deletes the document.
+    def delete
+      document.delete
+    end
+
+    # Gets a field.
+    # @param key [String, Symbol] the field's name.
+    # @return the field's value.
+    def get key
+      changes[key] or data[key]
+    end
+
+    # Sets a field.
+    # @param key [String, Symbol] the field's name.
+    # @param value the field's value.
+    def set key, value
+      changes[key] = value
+      return
+    end
+
+    # Converts the document to a JSON string.
+    # @param opts options to be passed to {JSON#generate}.
+    # @return [String] a JSON string.
+    def to_json opts = nil
+      data.merge(changes).to_json(opts)
+    end
+
+    alias :[] :get
+    alias :[]= :set
+  end
+end

data/lib/firestore-odm/model.rb

@@ -0,0 +1,10 @@
+require_relative 'document'
+require_relative 'schema'
+require_relative 'collection'
+
+module FirestoreODM
+  class Model < Document
+    extend Schema
+    extend Collection
+  end
+end

data/lib/firestore-odm/schema.rb

@@ -0,0 +1,42 @@
+module FirestoreODM
+  module Schema
+    # Defines a field.
+    # @param name [String, Symbol] the field's name.
+    # @param type [Class] the field's type.
+    # @param opts [Hash] the field's options.
+    def field name, type, opts = {}
+      define_method(name) { self[name] }
+      define_setter_method(name) { |value| self[name] = value }
+      return
+    end
+
+    # Defines a reference field.
+    # @param name [String, Symbol] the reference's name.
+    # @param model [Database::Model] the reference's model.
+    # @param opts [Hash] the reference's options.
+    def reference name, model, opts = {}
+      define_method(name) { model.new self[name] }
+      define_setter_method(name) { |value| self[name] = value.document }
+      return
+    end
+
+    # @param model [Database::Model] 
+    def contains model, opts = {}
+      name = model.name.downcase
+      define_method("create_#{name}") do |opts = {}, &block|
+        opts = {:relative_to => document}.merge opts
+        model.create(opts, &block)
+      end
+      
+      define_method("create_#{name}_with_id") do |id, opts = {}, &block|
+        opts = {:relative_to => document}.merge opts
+        model.create_with_id(id, opts, &block)
+      end
+      
+      define_method("#{name}_from_id") do |id, opts = {}|
+        opts = {:relative_to => document}.merge opts
+        model.from_id(id, opts)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: firestore-odm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Felipe Cabrera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-31 00:00:00.000000000 Z
+dependencies: []
+description: ''
+email: fecabrera0@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/firestore-odm.rb
+- lib/firestore-odm/collection.rb
+- lib/firestore-odm/document.rb
+- lib/firestore-odm/model.rb
+- lib/firestore-odm/schema.rb
+homepage: 
+licenses:
+- BSD-2-Clause
+metadata:
+  source_code_uri: https://github.org/fecabrera/firestore-odm
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: ODM for Firestore in Ruby
+test_files: []