act_as_fire_record_beta 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edeacaf31ef73ecb88185915a483712a188f66fc05c7ecdd54432ed4ceb2cfda
-  data.tar.gz: 54937813b56125aa196af5c9b8abba535ba0abf95cc3eb2ee32ad677fe8b8d12
+  metadata.gz: 81eb3576251a5e99a7250637ee9b906a5b7c345338b7947db43dd1241e79d8b9
+  data.tar.gz: 15a2f9251f19d01d5a8e1ea58dcb45c0888440075e9ea827d585e7a5447c41c4
 SHA512:
-  metadata.gz: d1b0f6e6bc7bdc58db9488d273634e8a6f417c3222d3a1c900ffb4caedbe690b7f41907e7487a581d4ec9087da2c787ceb9b08a9f12fa90928763de06ab72174
-  data.tar.gz: 29be871e1061cc0e426fbd54877c640db94e549577f7f2a281c48b9315a321fa6f62f20dec1116c97dd651386e121ce0dd0a79901881300fbd1544a940575d57
+  metadata.gz: 993a8bd4c0a4a032f1560954fb76eb5d03208e18a14c0fa2e35245d5199eebb3ed56d64ebf972dde770f37bfb6aed514c35df5b0d9cb29acfbcd18f6ee7073d3
+  data.tar.gz: 53ce442fff0fb9dd9c32c8e6edbf0994d105c60ed4e7476bb713c4e2508b4b98c2e88dcb2fe48308aa29cc6957aad1f0102f7258b386af02b4aa31d6825c996b

data/README.md

@@ -1,8 +1,7 @@
 # ActAsFireRecordBeta
-Short description and motivation.
 
-## Usage
-How to use my plugin.
+- Provides Rails applications with an ActiveRecord-like interface to manipulate Firestore.
+- Works as a wrapper for the [google-cloud-firestore](https://rubygems.org/gems/google-cloud-firestore) gem.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,6 +20,78 @@ Or install it yourself as:
 $ gem install act_as_fire_record_beta
 ```
 
+## Overview 
+
+Model example:
+
+```ruby
+class Book
+  include ActAsFireRecordBeta
+
+  firestore_attribute :title, :string
+  firestore_attribute :published_on, :date
+  firestore_attribute :page, :integer
+
+  validates :title, presence: true
+
+  before_validation :titleize_title
+
+  private
+
+  def titleize_title
+    self.title = title.to_s.titleize
+  end
+end
+```
+
+CRUD example:
+
+```ruby 
+# Create
+book = Book.new(title: 'An Awesome Book', published_on: '2022-12-01'.to_date, page: 200)
+book.save
+bool.id #=> IdG0ZWT0I5DucEQuRgoP
+
+# Read
+id = 'IdG0ZWT0I5DucEQuRgoP'
+book = Book.find(id)
+
+# Update
+book.update(page: 210)
+
+# Delete
+book.destroy
+```
+
+Finder examples:
+
+```ruby
+book = Book.find_by(title: 'An Awesome Book')
+
+books = Book.all
+
+books = Book.order(:title)
+books = Book.order(:title, :desc)
+
+books = Book.where(:page, :>=, 200)
+books = Book.where(:page, :>=, 200).order(:page)
+```
+
+Please refer test codes for other APIs.
+
+- https://github.com/JunichiIto/act_as_fire_record_beta/blob/main/test/act_as_fire_record_beta_test.rb
+- https://github.com/JunichiIto/act_as_fire_record_beta/blob/main/test/google/cloud/firestore/query_test.rb
+
+## Setup, usage and etc.
+
+As of now, Japanese document is only available.
+
+[README-ja.md](https://github.com/JunichiIto/act_as_fire_record_beta/blob/main/README-ja.md)
+
+Google translate might help you.
+
+[Auto-translated README-ja.md](https://github-com.translate.goog/JunichiIto/act_as_fire_record_beta/blob/main/README-ja.md?_x_tr_sl=ja&_x_tr_tl=en&_x_tr_hl=ja&_x_tr_pto=wapp)
+
 ## Contributing
 Contribution directions go here.
 

data/lib/act_as_fire_record_beta/google/cloud/firestore/query.rb

@@ -2,20 +2,36 @@ module Google
   module Cloud
     module Firestore
       class Query
-        def get_records(limit: nil)
-          scope = limit ? limit(limit) : self
-          scope.get.map do |data|
-            fire_record_class.to_instance(data)
+        include Enumerable
+
+        def method_missing(sym, *args)
+          if respond_to_missing?(sym, false)
+            self.to_a.send(sym, *args)
+          else
+            super
+          end
+        end
+
+        def respond_to_missing?(sym, _include_private)
+          [].respond_to?(sym) ? true : super
+        end
+
+        def each(&b)
+          records = get.map do |data|
+            record = fire_record_class.to_instance(data)
+            b.call(record) if b
+            record
           end
+          b ? records : records.each
         end
 
         def destroy_all
-          doc_refs = get_records.map(&:doc_ref)
+          doc_refs = self.map(&:doc_ref)
           fire_record_class.delete_in_batch(doc_refs)
         end
 
         def first(limit = 1)
-          records = get_records(limit: limit)
+          records = limit(limit)
           limit == 1 ? records[0] : records
         end
 

data/lib/act_as_fire_record_beta/version.rb

@@ -1,3 +1,3 @@
 module ActAsFireRecordBeta
-  VERSION = "0.0.7"
+  VERSION = "0.0.9"
 end

data/lib/act_as_fire_record_beta.rb

@@ -48,15 +48,12 @@ module ActAsFireRecordBeta
     def col
       @_col ||= client.col(collection_name_with_env)
     end
+    alias all col
 
     def doc(id)
       client.doc("#{collection_name_with_env}/#{id}")
     end
 
-    def all
-      col.get_records
-    end
-
     def find(id)
       data = doc(id).get
       raise ActAsFireRecordBeta::RecordNotFound, "Couldn't find record with #{self} with 'id'='#{id}'" if data.missing?
@@ -84,8 +81,11 @@ module ActAsFireRecordBeta
     end
 
     def first(limit = 1)
-      records = col.get_records(limit: limit)
-      limit == 1 ? records[0] : records
+      all.first(limit)
+    end
+
+    def count
+      all.count
     end
 
     def create(params)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: act_as_fire_record_beta
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Junichi Ito
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-23 00:00:00.000000000 Z
+date: 2022-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails