Refactor code to use consistent naming conventions

Author: teetangh

docusaurus/docs/tutorial-ruby-couchbase-orm/02-installation.md

@@ -8,7 +8,7 @@ Before installing Couchbase ORM, ensure that you have the following prerequisite
 
 1. **Ruby**: Couchbase ORM requires Ruby version 2.7 or higher. You can check your Ruby version by running the following command in your terminal:
 
-   ```
+   ```sh
    ruby -v
    ```
 
@@ -20,7 +20,7 @@ Before installing Couchbase ORM, ensure that you have the following prerequisite
 
 3. **Bundler** (optional): Bundler is a dependency management tool for Ruby. While not strictly required, it is recommended to use Bundler to manage your Ruby project's dependencies. You can install Bundler by running the following command:
 
-   ```
+   ```sh
    gem install bundler
    ```
 
@@ -75,17 +75,19 @@ To use Couchbase ORM in your Ruby application, you need to configure the connect
      username: my_username
      password: my_password
 
-   production:
-     connection_string: couchbase://localhost
-     bucket: my_app_production
-     username: my_username
-     password: my_password
+    production:
+      connection_string: <%= ENV['COUCHBASE_CONNECTION_STRING'] %>
+      bucket: <%= ENV['COUCHBASE_BUCKET'] %>
+      username: <%= ENV['COUCHBASE_USER'] %>
+      password: <%= ENV['COUCHBASE_PASSWORD'] %>
    ```
 
    Replace the values for `connection_string`, `bucket`, `username`, and `password` with your actual Couchbase Server connection details.
 
    Couchbase ORM will automatically load the configuration based on the current Rails environment.
 
+   You can also set the connection details using environment variables in the production environment to avoid storing sensitive information in the source code.
+
 2. **Non-Rails Applications**:
 
    For non-Rails applications, you can configure the connection settings programmatically. Add the following code to your application's initialization file or before you start using Couchbase ORM:

docusaurus/docs/tutorial-ruby-couchbase-orm/03-defining-models.md

@@ -67,8 +67,6 @@ Here's an example of using attribute options:
 ```ruby
 class User < CouchbaseOrm::Base
   attribute :name, :string, default: 'Unknown'
-  # attribute :email, :string, alias: :contact_email
-  # attribute :age, :integer, readonly: true
 end
 ```
 

docusaurus/docs/tutorial-ruby-couchbase-orm/04-querying.md

@@ -37,54 +37,26 @@ author3.save
 author4.save
 
 # Find authors by ID
-puts "Find by ID:"
 puts Author.find(author1.id).inspect
 
 # Find the first author with a specific name
-puts "\nFind by name:"
 puts Author.find_by(name: 'John Doe').inspect
 
 # Where
-puts "\nWhere:"
 puts Author.where(active: true).to_a.inspect
 ```
 
-Output of the above code:
-```
-Find by ID:
-#<Author id: "author-1-tIqa9xA5k", name: "John Doe", age: 30, active: true>
-
-Find by name:
-#<Author id: "author-1-tIqa9xA5k", name: "John Doe", age: 30, active: true>
-
-Where:
-[#<Author id: "author-1-tIqa9xA5k", name: "John Doe", age: 30, active: true>, #<Author id: "author-1-tIqaAdJC-", name: "Alice Brown", age: 40, active: true>]
-```
-
-
 ## 4.2. Where Clauses
 
 The `where` method allows you to specify conditions to filter the records based on attribute values. You can chain multiple `where` clauses together to build more complex queries.
 
 ```ruby
 # Where
-puts "\nWhere chain:"
 puts Author.where(active: true).where('age >= 30').to_a.inspect
 
-puts "\nWhere with regex:"
 puts Author.where("name like '%John%'").to_a.inspect
 ```
 
-Output
-```
-Where chain:
-[#<Author id: "author-1-tJFHUZcxT", name: "John Doe", age: 30, active: true>, #<Author id: "author-1-tJFHWh88k", name: "Alice Brown", age: 40, active: true>]
-
-Where with regex:
-[#<Author id: "author-1-tJFHUZcxT", name: "John Doe", age: 30, active: true>]
-```
-
-
 CouchbaseOrm supports various comparison operators and placeholders in the `where` clauses, such as `=`, `>`, `<`, `>=`, `<=`, `LIKE`, and more.
 
 ## 4.3. Ordering
@@ -93,23 +65,12 @@ You can specify the order in which the retrieved records should be sorted using
 
 ```ruby
 # Order authors by name
-puts "\nOrder by name:"
 puts Author.order(:name).to_a.inspect
 
 # Order authors by age in descending order
-puts "\nOrder by age (descending):"
 puts Author.order(age: :desc).to_a.inspect
 ```
 
-Output
-```
-Order by name:
-[#<Author id: "author-1-tJFHWh88k", name: "Alice Brown", age: 40, active: true>, #<Author id: "author-1-tJFHW6h7V", name: "Jane Smith", age: 25, active: false>, #<Author id: "author-1-tJFHUZcxT", name: "John Doe", age: 30, active: true>]
-
-Order by age (descending):
-[#<Author id: "author-1-tJFHWh88k", name: "Alice Brown", age: 40, active: true>, #<Author id: "author-1-tJFHUZcxT", name: "John Doe", age: 30, active: true>, #<Author id: "author-1-tJFHW6h7V", name: "Jane Smith", age: 25, active: false>]
-```
-
 You can also chain multiple `order` clauses to sort by multiple attributes.
 
 
@@ -121,39 +82,25 @@ The `pluck` method allows you to retrieve specific attributes from the matched r
 
 ```ruby
 # Pluck names of all authors
-puts "\nPluck names:"
 puts Author.order(:name).pluck(:name).inspect
 ```
 
-Output
-```
-Pluck names:
-["Alice Brown", "Jane Smith", "John Doe"]
-```
-
 ## 4.5. Destroying Records
 
 To delete multiple records that match specific conditions, you can use the `.each(&:destroy)` method. It deletes the records from the database and returns the number of records deleted.
 
+- `:destroy`: Deletes a single record.
+- `delete_all`: Deletes all records that match the specified conditions.
+
 ```ruby
 # Destroy all inactive authors
-puts "\nDestroy all inactive authors:"
-authors = Author.where(active: false).to_a
-puts authors.inspect
 Author.where(active: false).each(&:destroy)
 
-# Check remaining authors
-puts "\nRemaining authors:"
-puts Author.all.to_a.inspect
-```
+# Destroy all authors who are inactive
+Author.where(active: false).delete_all
 
-Output
-```
-Remaining authors:
-[#<Author id: "author-1-tK5S-hJY3", name: "Alice Brown", age: 40, active: true>, #<Author id: "author-1-tK5SzrgQL", name: "John Doe", age: 30, active: true>]
 ```
 
-Be cautious when using `.each(&:destroy)` as it permanently deletes the matched records from the database.
 
 These are just a few examples of the querying capabilities provided by CouchbaseOrm. You can combine these methods in various ways to construct complex and specific queries based on your application's requirements.
 
@@ -205,9 +152,3 @@ comments.each do |comment|
   puts "Title: #{comment.title}, Author: #{comment.author}, Category: #{comment.category}, Ratings: #{comment.ratings}"
 end
 ```
-
-Output
-```
-Title: First Comment, Author: Anne McCaffrey, Category: S-F, Ratings: 5
-Title: Second Comment, Author: Anne McCaffrey, Category: S-F, Ratings: 4
-```

docusaurus/docs/tutorial-ruby-couchbase-orm/05-persistence.md

@@ -13,21 +13,17 @@ class Task < CouchbaseOrm::Base
   attribute :completed, :boolean, default: false
 end
 
-task1 = Task.new(title: 'Task 1', description: 'Description of Task 1')
-task1.save
-puts "Task 1 created with id: #{task1.id}, #{task1.inspect}"
+task = Task.new(title: 'Task 1', description: 'Description of Task 1')
+task.save
 ```
 
 Alternatively, you can use the `create` method to create a new record in a single step:
 
 ```ruby
-task1 = Task.create(title: 'Task 1', description: 'Description of Task 1')
-```
-Output of the above code:
-```
-Task 1 created with id: task-1-tLJM721QY, #<Task id: "task-1-tLJM721QY", title: "Task 1", description: "Description of Task 1", completed: false>
+task = Task.create(title: 'Task 1', description: 'Description of Task 1')
 ```
 
+
 The `create` method instantiates a new instance of the model, sets the attributes, and saves it to the database.
 
 ## 5.2. Saving Records
@@ -36,16 +32,12 @@ The `save` method is used to persist a record to the database, whether it's a ne
 
 ```ruby
 # Update an existing task
-task2 = Task.create(title: 'Task 2', description: 'Description of Task 2')
-task2.description = 'Updated description of Task 2'
-task2.save
-puts "Task 2 updated with id: #{task2.id}, #{task2.inspect}"
+task = Task.create(title: 'Task 2', description: 'Description of Task 2')
+task.description = 'Updated description of Task 2'
+task.save
 ```
 
-Output of the above code:
-```
-Task 2 updated with id: task-1-tLJM895Xq, #<Task id: "task-1-tLJM895Xq", title: "Task 2", description: "Updated description of Task 2", completed: false>
-```
+
 
 If the record is new (i.e., it doesn't have an ID), `save` will create a new document in Couchbase Server. If the record already exists, `save` will update the existing document with the modified attributes.
 
@@ -55,14 +47,8 @@ To update an existing record, you can modify its attributes and then call the `s
 
 ```ruby
 # Update specific fields of a task
-task3 = Task.create(title: 'Task 3', description: 'Description of Task 3')
-task3.update(description: 'Updated description of Task 3', completed: true)
-puts "Task 3 updated with id: #{task3.id}, #{task3.inspect}"
-```
-
-Output of the above code:
-```
-Task 3 updated with id: task-1-tLJMA6cBp, #<Task id: "task-1-tLJMA6cBp", title: "Task 3", description: "Updated description of Task 3", completed: true>
+task = Task.create(title: 'Task 3', description: 'Description of Task 3')
+task.update(description: 'Updated description of Task 3', completed: true)
 ```
 
 CouchbaseOrm automatically tracks the changes made to the attributes and updates only the modified fields in the database.