firestore-odm 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46f4499f36b15866c173936a87f131a1dcd577a910ae756e639e8bb813f40d37
-  data.tar.gz: aa51288692a8f243edaef885845094f432430a235d76f3e099adbd4da2042894
+  metadata.gz: 94b90e6ec000daec07e84a3772c145ff8e6db882205e0f384c022ac51bc8d520
+  data.tar.gz: b8b2a75bac4d646ef6dace0502bf9dc80a160b5f6892e5c226aa20a9e6ba130f
 SHA512:
-  metadata.gz: e0357329bb07784d50c21c314c6060bd3aef22b6d09021c18e321fb7322274de2f6f945d65a199df80765207109ddbefec3ade2c21e1781b8fb204497519d731
-  data.tar.gz: 3092565a2150f89088e53ab8b081f797da1c2c99937170f798d8b472a9fa459af79ac46a9c20bbd347713c7572ca436a2f4d41278601cd0d40d5db5dd3ce48bc
+  metadata.gz: a0f9405724131206b7d0c2e379a0473bd846ec28ed4edcab94bfe7811cc7d9bf052118707779e4ee4537667b777b22a69188fde0ba28d1ca4d66262dd27b33e1
+  data.tar.gz: 20777dcbd8f983af757e9e487ecea5684775aa4722e805998a9cb012a45b0dc01c660e0c7bb7e7a1c297cee7d6334d4e4f4420d8959cb8d2665bf727567a4871

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+
+*.json
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,118 @@
+PATH
+  remote: .
+  specs:
+    firestore-odm (0.1.4)
+      google-cloud-firestore (~> 1.4, >= 1.4.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    backport (1.1.2)
+    benchmark (0.1.0)
+    concurrent-ruby (1.1.6)
+    e2mmap (0.1.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    google-cloud-core (1.5.0)
+      google-cloud-env (~> 1.0)
+      google-cloud-errors (~> 1.0)
+    google-cloud-env (1.3.2)
+      faraday (>= 0.17.3, < 2.0)
+    google-cloud-errors (1.0.1)
+    google-cloud-firestore (1.4.4)
+      concurrent-ruby (~> 1.0)
+      google-cloud-core (~> 1.2)
+      google-gax (~> 1.8)
+      googleapis-common-protos (>= 1.3.9, < 2.0)
+      googleapis-common-protos-types (>= 1.0.4, < 2.0)
+      rbtree (~> 0.4.2)
+    google-gax (1.8.1)
+      google-protobuf (~> 3.9)
+      googleapis-common-protos (>= 1.3.9, < 2.0)
+      googleauth (~> 0.9)
+      grpc (~> 1.24)
+      rly (~> 0.2.3)
+    google-protobuf (3.12.2)
+    googleapis-common-protos (1.3.10)
+      google-protobuf (~> 3.11)
+      googleapis-common-protos-types (>= 1.0.5, < 2.0)
+      grpc (~> 1.27)
+    googleapis-common-protos-types (1.0.5)
+      google-protobuf (~> 3.11)
+    googleauth (0.13.0)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.14)
+    grpc (1.28.0)
+      google-protobuf (~> 3.11)
+      googleapis-common-protos-types (~> 1.0)
+    jaro_winkler (1.5.4)
+    jwt (2.2.1)
+    maruku (0.7.3)
+    memoist (0.16.2)
+    mini_portile2 (2.4.0)
+    multi_json (1.14.1)
+    multipart-post (2.1.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    os (1.1.0)
+    parallel (1.19.1)
+    parser (2.7.1.2)
+      ast (~> 2.4.0)
+    public_suffix (4.0.5)
+    rainbow (3.0.0)
+    rbtree (0.4.2)
+    reverse_markdown (1.4.0)
+      nokogiri
+    rexml (3.2.4)
+    rly (0.2.3)
+    rubocop (0.84.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    signet (0.14.0)
+      addressable (~> 2.3)
+      faraday (>= 0.17.3, < 2.0)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    solargraph (0.39.8)
+      backport (~> 1.1)
+      benchmark
+      bundler (>= 1.17.2)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      maruku (~> 0.7, >= 0.7.3)
+      nokogiri (~> 1.9, >= 1.9.1)
+      parser (~> 2.3)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (~> 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.0.1)
+    tilt (2.0.10)
+    unicode-display_width (1.7.0)
+    yard (0.9.25)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  firestore-odm!
+  solargraph
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2020, Felipe Cabrera
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,33 @@
+# Firestore ODM
+
+## Configure
+Add `gem 'firestore-odm'` to your Gemfile, or from the terminal
+```
+gem install firestore-odm
+```
+
+Then type
+```
+export GOOGLE_CLOUD_CREDENTIALS=<path_to_google_cloud_credentials>
+```
+
+## How to use
+
+```ruby
+require 'firestore-odm'
+
+class Account < FirestoreODM::Model
+  path :accounts
+
+  field :name, String
+  field :email, String
+end
+
+account = Account.create do |doc|
+  doc.name = 'John Smith'
+  doc.email = 'john.smith@example.com'
+end
+
+puts account.path     #=> accounts/<document_id>
+puts account.to_json  #=> {"name": "John Smith", "email": "john.smith@example.com"}
+```

data/firestore-odm.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |spec|
+  spec.name         = 'firestore-odm'
+  spec.version      = '0.1.5'
+  spec.licenses     = 'BSD-2-Clause'
+  spec.summary      = 'ODM for Firestore in Ruby'
+  spec.description  = ''
+  spec.author       = 'Felipe Cabrera'
+  spec.email        = 'fecabrera0@outlook.com'
+  spec.files        = `git ls-files`.split("\n")
+  spec.homepage     = 'https://github.com/fecabrera/firestore-odm'
+  spec.metadata     = {"source_code_uri" => "https://github.com/fecabrera/firestore-odm"}
+
+  spec.add_dependency 'google-cloud-firestore', '~> 1.4', '>= 1.4.0'
+end

data/lib/firestore-odm.rb

@@ -14,4 +14,80 @@ class Module
   def define_setter_method name, &block
     define_method("#{name}=", &block)
   end
+end
+
+module FirestoreODM
+  attr_reader :conversions, :options
+
+  @conversions = {
+    String => :to_s,
+    Integer => :to_i,
+    Float => :to_f,
+    Date => :to_date,
+    DateTime => :to_datetime,
+    Time => :to_time
+  }
+
+  @options = {}
+
+  # Sets a conversion rule for a certain type.
+  # @param type [Class]
+  # @param target [Symbol, Proc]
+  def add_conversion type, target
+    @conversions[type] = target
+    return
+  end
+
+  # Gets a conversion.
+  # @param type [Class]
+  # @return [Proc]
+  def get_conversion type
+    case rule = conversions[type]
+    when Symbol
+      Proc.new { |value| value.method(rule).call }
+    when Proc
+      rule
+    else
+      raise "Conversion not found for type `#{type}`"
+    end
+  end
+
+  # @param name [Symbol]
+  def add_option name, &block
+    @options[name] = block
+  end
+
+  def get_option name, option
+    method = @options[name]
+
+    case option
+    when Proc
+      get_option name, option.call
+    else
+      method.call option
+    end
+  end
+
+  extend self
+end
+
+
+FirestoreODM.add_option :more_than do |value|
+  Proc.new { |o| value < o }
+end
+
+FirestoreODM.add_option :min do |value|
+  Proc.new { |o| value <= o }
+end
+
+FirestoreODM.add_option :max do |value|
+  Proc.new { |o| o <= value }
+end
+
+FirestoreODM.add_option :less_than do |value|
+  Proc.new { |o| o < value }
+end
+
+FirestoreODM.add_option :in do |list|
+  Proc.new { |o| list.include? o }
 end

data/lib/firestore-odm/collection.rb

@@ -17,28 +17,33 @@ module FirestoreODM
     end
 
     # Creates a document.
-    # @return [FirestoreODM::Model] the document.
+    # @param opts [Hash] a hash with options.
+    # @yield [doc] 
+    # @return [FirestoreODM::Document] 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.
+    # Creates a document with an specific id.
     # @param id [String] the document id.
-    # @param root [Google::Cloud::Firestore::DocumentReference]
-    # @return [FirestoreODM::Model] the document.
+    # @param opts [Hash]
+    # @yield [doc] 
+    # @return [FirestoreODM::Document] 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
+      self.from_id id, opts
     end
 
     # Gets a document.
     # @param id [String] 
-    # @return [FirestoreODM::Model] the document.
+    # @param opts [Hash]
+    # @return [FirestoreODM::Document] the document.
     def from_id id, opts = {}
       doc = collection(opts[:relative_to]).doc id
       self.new doc

data/lib/firestore-odm/schema.rb

@@ -5,8 +5,28 @@ module FirestoreODM
     # @param type [Class] the field's type.
     # @param opts [Hash] the field's options.
     def field name, type, opts = {}
+      conversion = FirestoreODM.get_conversion type
+
+      list = []
+      
+      list << FirestoreODM.get_option(:min, opts[:min]) if opts[:min]
+      list << FirestoreODM.get_option(:max, opts[:max]) if opts[:max]
+      list << FirestoreODM.get_option(:less_than, opts[:less_than]) if opts[:less_than]
+      list << FirestoreODM.get_option(:more_than, opts[:more_than]) if opts[:more_than]
+      list << FirestoreODM.get_option(:in, opts[:in]) if opts[:in]
+
+      define_singleton_method("parse_#{name}") do |value|
+        list.reduce(true) { |result, o| result and o.call(value) }
+      end
+
       define_method(name) { self[name] }
-      define_setter_method(name) { |value| self[name] = value }
+      
+      define_method("#{name}=") do |value|
+        value = conversion.call value
+        raise "#{value} is not a valid value for field #{name}" unless self.class.method("parse_#{name}").call value
+        self[name] = value
+      end
+
       return
     end
 
@@ -16,26 +36,30 @@ module FirestoreODM
     # @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 }
+      define_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)
+    # 
+    # @param models [Database::Model] 
+    def contains *models
+      models.each do |model|
+        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

data/test.rb

@@ -0,0 +1,76 @@
+$:.unshift File.join(Dir.pwd, 'lib')
+
+require 'date'
+require 'firestore-odm'
+
+class Post < FirestoreODM::Model
+  path :posts
+
+  field :content, String
+  field :privacy, String, :in => ['public', 'hidden', 'private']
+  field :created_at, DateTime
+end
+
+class Account < FirestoreODM::Model
+  path :info
+
+  field :first_name, String
+  field :last_name, String
+  field :birthday, Date, :max => Proc.new { Date.today.prev_year(18) }
+  field :updated_at, DateTime
+end
+
+class User < FirestoreODM::Model
+  path :users
+
+  field :name, String
+  field :created_at, DateTime
+
+  contains Post, Account
+end
+
+puts Account.parse_birthday(Date.parse('2001-12-02'))
+puts Account.parse_birthday(Date.parse('2002-12-02'))
+puts Account.parse_birthday(Date.parse('2003-12-02'))
+puts Post.parse_privacy('public')
+puts Post.parse_privacy('none')
+
+begin
+  user = User.create_with_id 'john.smith' do |doc|
+    doc.name = 'John Smith'
+    doc.created_at = DateTime.now
+  end
+
+  puts "#{user.path}: #{user.to_json}"
+
+  begin
+    user.create_account_with_id 'account' do |doc|
+      doc.first_name = 'John'
+      doc.last_name = 'Smith'
+      doc.birthday = Date.parse('1981-06-25')
+      doc.updated_at = DateTime.now
+    end
+
+    begin
+      account = user.account_from_id 'account'
+
+      puts "#{account.path}: #{account.to_json}"
+    ensure
+      account.delete
+    end
+
+    post = user.create_post do |doc|
+      doc.content = 'Hello world!'
+      doc.privacy = 'public'
+      doc.created_at = DateTime.now
+    end
+
+    begin
+      puts "#{post.path}: #{post.to_json}"
+    ensure
+      post.delete
+    end
+  ensure
+    user.delete
+  end
+end

metadata

@@ -1,31 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: firestore-odm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Felipe Cabrera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-31 00:00:00.000000000 Z
-dependencies: []
+date: 2020-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-cloud-firestore
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 description: ''
 email: fecabrera0@outlook.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- firestore-odm.gemspec
 - 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: 
+- test.rb
+homepage: https://github.com/fecabrera/firestore-odm
 licenses:
 - BSD-2-Clause
 metadata:
-  source_code_uri: https://github.org/fecabrera/firestore-odm
+  source_code_uri: https://github.com/fecabrera/firestore-odm
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -41,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: ODM for Firestore in Ruby