act_as_fire_record_beta 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edeacaf31ef73ecb88185915a483712a188f66fc05c7ecdd54432ed4ceb2cfda
-  data.tar.gz: 54937813b56125aa196af5c9b8abba535ba0abf95cc3eb2ee32ad677fe8b8d12
+  metadata.gz: c76e43b19f1342e88e1b20294590913587ac006c208181fa517c99f1023f1d00
+  data.tar.gz: 14f4ae4b3496befa9569837c0fa99fa902eb4b12d9c720a73ecf846913ef5ad1
 SHA512:
-  metadata.gz: d1b0f6e6bc7bdc58db9488d273634e8a6f417c3222d3a1c900ffb4caedbe690b7f41907e7487a581d4ec9087da2c787ceb9b08a9f12fa90928763de06ab72174
-  data.tar.gz: 29be871e1061cc0e426fbd54877c640db94e549577f7f2a281c48b9315a321fa6f62f20dec1116c97dd651386e121ce0dd0a79901881300fbd1544a940575d57
+  metadata.gz: 888b6e53584137db8793d626f8afd323474cd27473179a95c5253280cbf1ad21ecca33bd166f404821303a98aa6c8b69c4ac49f245e3e4e994d43a1dbbb55342
+  data.tar.gz: 9c0716e6bb104a0a526cd1e56229031a4f472c1ef1b0352a29e7e5e1126ff0b9af7720f09796c704b8f82aac2258d0822c98b45ae842dc31eade33c2a97c8509

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,74 @@ 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.get_records 
+
+books = Book.order(:title).get_records
+books = Book.order(:title, :desc).get_records
+
+books = Book.where(:page, :>=, 200).get_records
+books = Book.where(:page, :>=, 200).order(:page).get_records
+```
+
+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)
+
 ## Contributing
 Contribution directions go here.
 

data/lib/act_as_fire_record_beta/version.rb

@@ -1,3 +1,3 @@
 module ActAsFireRecordBeta
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 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?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: act_as_fire_record_beta
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Junichi Ito