ru.Bee 1.5.3 → 1.6.0

data/lib/tests/example_models/user.rb

@@ -2,4 +2,5 @@ class User < Rubee::SequelObject
   attr_accessor :id, :email, :password
 
   owns_many :accounts, cascade: true
+  owns_one :address, cascade: true
 end

data/lib/tests/logger_test.rb

@@ -0,0 +1,76 @@
+require_relative 'test_helper'
+
+class CustomLogger
+  class << self
+    def warn(message:, **options, &block); end
+
+    def info(message:, **options, &block)
+      puts "CUSTOM INFO #{message}"
+    end
+
+    def error(message:, **options, &block); end
+
+    def critical(message:, **options, &block); end
+
+    def debug(object:, **options, &block); end
+  end
+end
+
+describe 'Rubee::Logger' do
+  describe 'logger' do
+    it 'exists' do
+      _(Rubee::Logger).wont_be_nil
+    end
+  end
+
+  describe '.warn' do
+    it 'output message' do
+      output = capture_stdout { Rubee::Logger.warn(message: 'test') }
+
+      assert_includes(output, "WARN test")
+    end
+  end
+
+  describe '.info' do
+    it 'output message' do
+      output = capture_stdout { Rubee::Logger.info(message: 'test') }
+
+      assert_includes(output, "INFO test")
+    end
+  end
+
+  describe '.error' do
+    it 'output message' do
+      output = capture_stdout { Rubee::Logger.error(message: 'test') }
+
+      assert_includes(output, "ERROR test")
+    end
+  end
+
+  describe '.critical' do
+    it 'output message' do
+      output = capture_stdout { Rubee::Logger.critical(message: 'test') }
+
+      assert_includes(output, "CRITICAL test")
+    end
+  end
+
+  describe '.debug' do
+    it 'output message' do
+      output = capture_stdout { Rubee::Logger.debug(object: User.new(email: 'ok@ok.com', password: 123)) }
+
+      assert_includes(output, "DEBUG #<User:")
+    end
+  end
+
+  describe 'when custom logger defined in the configuration' do
+    it 'uses custom logger' do
+      Rubee::Configuration.setup(env = :test) { _1.logger = { logger: CustomLogger, env: } }
+
+      output = capture_stdout { Rubee::Logger.info(message: 'test') }
+      assert_includes(output, "CUSTOM INFO test")
+
+      Rubee::Configuration.setup(env = :test) { _1.logger = { env: } }
+    end
+  end
+end

data/lib/tests/{account_model_test.rb → models/account_model_test.rb}

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative '../test_helper'
 
 describe 'Account model' do
   describe 'holds :user' do

data/lib/tests/{comment_model_test.rb → models/comment_model_test.rb}

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative '../test_helper'
 
 describe 'Comment model' do
   describe 'owns_many :users, over: :posts' do
@@ -32,4 +32,16 @@ describe 'Comment model' do
       end
     end
   end
+
+  describe 'method' do
+    it 'updates existing model' do
+      comment = Comment.new(text: 'test 1')
+      comment.save
+
+      comment.text = 'test 2'
+      comment.save
+
+      _(Comment.find(comment.id).text).must_equal('test 2')
+    end
+  end
 end

data/lib/tests/models/db_objectable_test.rb

@@ -0,0 +1,21 @@
+require_relative '../test_helper'
+
+class MergBerg
+  include Rubee::DatabaseObjectable
+  attr_accessor :id, :foo, :bar
+end
+
+describe 'Database Objectable' do
+  describe 'class methods' do
+    it 'pluralizes class names' do
+      _(MergBerg.pluralize_class_name).must_equal('mergbergs')
+    end
+
+    it 'retrieves accessor names' do
+      accessors = MergBerg.accessor_names
+      _(accessors).must_include(:id)
+      _(accessors).must_include(:foo)
+      _(accessors).must_include(:bar)
+    end
+  end
+end

data/lib/tests/models/seralizable_test.rb

@@ -0,0 +1,36 @@
+require_relative '../test_helper'
+
+class TestSerialized
+  include Rubee::Serializable
+
+  attr_accessor :id, :towel_color, :name
+end
+
+describe 'Serializable Model' do
+  describe 'attributes' do
+    it 'exists and settable' do
+      cerealed = TestSerialized.new(id: 10, towel_color: 'blue', name: 'Ford Prefect')
+
+      _(cerealed.id).must_equal(10)
+      _(cerealed.towel_color).must_equal('blue')
+      _(cerealed.name).must_equal('Ford Prefect')
+    end
+
+    it 'does not exist not settable' do
+      _ { TestSerialized.new(blue: 'hello') }.must_raise(NoMethodError)
+    end
+  end
+
+  describe 'coverts to' do
+    before do
+      @cerealed = TestSerialized.new(id: 10, towel_color: 'blue', name: 'Ford Prefect')
+    end
+    it 'hash' do
+      _(@cerealed.to_h).must_be_instance_of(Hash)
+    end
+
+    it 'json' do
+      _(@cerealed.to_json).must_be_instance_of(String)
+    end
+  end
+end

data/lib/tests/{user_model_test.rb → models/user_model_test.rb}

@@ -1,4 +1,4 @@
-require_relative 'test_helper'
+require_relative '../test_helper'
 
 describe 'User model' do
   describe '.create' do
@@ -248,4 +248,35 @@ describe 'User model' do
       end
     end
   end
+
+  describe 'owns_one' do
+    after do
+      User.destroy_all(cascade: true)
+    end
+    describe 'when there is one associated account' do
+      it 'cannot add more than one address' do
+        skip "This is an idea that can be implemented later"
+        user = User.new(email: 'bleh@example.com', password: '123')
+        user.save
+
+        address = Address.new(user_id: user.id, street: '1234 ble ave', apt: '', city: 'NY', state: 'NY', zip: '555555')
+        address.save
+
+        address_two = Address.new(user_id: user.id, street: '1234 ble ave', apt: '', city: 'NY', state: 'NY',
+zip: '555555')
+
+        _ { address_two.save }.must_raise(Rubee::OwnsOneError)
+      end
+
+      it 'returns the single address' do
+        user = User.new(email: 'bleh@example.com', password: '123')
+        user.save
+
+        address = Address.new(user_id: user.id, street: '1234 ble ave', apt: '', city: 'NY', state: 'NY', zip: '555555')
+        address.save
+
+        _(user.address.id).must_equal(address.id)
+      end
+    end
+  end
 end

data/lib/tests/rubee_generator_test.rb

@@ -37,92 +37,95 @@ describe 'Rubee::Generator' do
       generator = Rubee::Generator.new(nil, nil, nil, nil)
       generator.call
 
-      _(File.exist?('lib/db/create_apples.rb')).must_equal false
+      _(File.exist?('lib/db/create_apples.rb')).must_equal(false)
     end
 
     it 'with a model only' do
       generator = Rubee::Generator.new('apple', nil, 'apples', nil)
       generator.call
 
-      _(File.exist?('lib/db/create_apples.rb')).must_equal true
+      _(File.exist?('lib/db/create_apples.rb')).must_equal(true)
 
       lines = File.readlines('lib/db/create_apples.rb').map(&:chomp).join("\n")
 
-      _(lines.include?('class CreateApples')).must_equal true
-      _(lines.include?('def call')).must_equal true
-      _(lines.include?('return if Rubee::SequelObject::DB.tables.include?(:apples)')).must_equal true
-      _(lines.include?('Rubee::SequelObject::DB.create_table(:apples) do')).must_equal true
-      _(lines.include?('String')).must_equal false
-      _(lines.include?('end')).must_equal true
+      _(lines.include?('class CreateApples')).must_equal(true)
+      _(lines.include?('def call')).must_equal(true)
+      _(lines.include?('return if Rubee::SequelObject::DB.tables.include?(:apples)')).must_equal(true)
+      _(lines.include?('Rubee::SequelObject::DB.create_table(:apples) do')).must_equal(true)
+      _(lines.include?('String')).must_equal(false)
+      _(lines.include?('end')).must_equal(true)
     end
 
     it 'with a model with attributes' do
-      generator = Rubee::Generator.new('apple', [{ name: 'title', type: :string }, {name: 'content', type: :text }], 'apples', nil)
+      generator = Rubee::Generator.new('apple', [{ name: 'title', type: :string }, { name: 'content', type: :text }],
+'apples', nil)
       generator.call
 
-      _(File.exist?('lib/db/create_apples.rb')).must_equal true
+      _(File.exist?('lib/db/create_apples.rb')).must_equal(true)
 
       lines = File.readlines('lib/db/create_apples.rb').map(&:chomp).join("\n")
 
-      _(lines.include?('class CreateApples')).must_equal true
-      _(lines.include?('def call')).must_equal true
-      _(lines.include?('return if Rubee::SequelObject::DB.tables.include?(:apples)')).must_equal true
-      _(lines.include?('Rubee::SequelObject::DB.create_table(:apples) do')).must_equal true
-      _(lines.include?('String :title')).must_equal true
-      _(lines.include?('String :content, text: true')).must_equal true
-      _(lines.include?('end')).must_equal true
+      _(lines.include?('class CreateApples')).must_equal(true)
+      _(lines.include?('def call')).must_equal(true)
+      _(lines.include?('return if Rubee::SequelObject::DB.tables.include?(:apples)')).must_equal(true)
+      _(lines.include?('Rubee::SequelObject::DB.create_table(:apples) do')).must_equal(true)
+      _(lines.include?('String :title')).must_equal(true)
+      _(lines.include?('String :content, text: true')).must_equal(true)
+      _(lines.include?('end')).must_equal(true)
     end
 
     it 'with a model with different attributes' do
-      generator = Rubee::Generator.new('apple', [{name: 'id', type: :bigint}, {name: 'colour', type: :string }, {name: 'weight', type: :integer }], 'apples', nil)
+      generator = Rubee::Generator.new('apple',
+[{ name: 'id', type: :bigint }, { name: 'colour', type: :string }, { name: 'weight', type: :integer }], 'apples', nil)
       generator.call
 
-      _(File.exist?('lib/db/create_apples.rb')).must_equal true
+      _(File.exist?('lib/db/create_apples.rb')).must_equal(true)
 
       lines = File.readlines('lib/db/create_apples.rb').map(&:chomp).join("\n")
 
-      _(lines.include?('class CreateApples')).must_equal true
-      _(lines.include?('def call')).must_equal true
-      _(lines.include?('return if Rubee::SequelObject::DB.tables.include?(:apples)')).must_equal true
-      _(lines.include?('Rubee::SequelObject::DB.create_table(:apples) do')).must_equal true
-      _(lines.include?('Bignum :id')).must_equal true
-      _(lines.include?('String :colour')).must_equal true
-      _(lines.include?('Integer :weight')).must_equal true
-      _(lines.include?('end')).must_equal true
+      _(lines.include?('class CreateApples')).must_equal(true)
+      _(lines.include?('def call')).must_equal(true)
+      _(lines.include?('return if Rubee::SequelObject::DB.tables.include?(:apples)')).must_equal(true)
+      _(lines.include?('Rubee::SequelObject::DB.create_table(:apples) do')).must_equal(true)
+      _(lines.include?('Bignum :id')).must_equal(true)
+      _(lines.include?('String :colour')).must_equal(true)
+      _(lines.include?('Integer :weight')).must_equal(true)
+      _(lines.include?('end')).must_equal(true)
     end
 
     it 'with a model with an attribute with multiple names' do
-      generator = Rubee::Generator.new('apple', [{ name: ['blue_id', 'shoe_id'], type: :foreign_key, table: 'blue_and_shoe_join_tb' }], 'apples', nil)
+      generator = Rubee::Generator.new('apple',
+[{ name: ['blue_id', 'shoe_id'], type: :foreign_key, table: 'blue_and_shoe_join_tb' }], 'apples', nil)
       generator.call
 
-      _(File.exist?('lib/db/create_apples.rb')).must_equal true
+      _(File.exist?('lib/db/create_apples.rb')).must_equal(true)
 
       lines = File.readlines('lib/db/create_apples.rb').map(&:chomp).join("\n")
 
-      _(lines.include?('class CreateApples')).must_equal true
-      _(lines.include?('def call')).must_equal true
-      _(lines.include?('return if Rubee::SequelObject::DB.tables.include?(:apples)')).must_equal true
-      _(lines.include?('Rubee::SequelObject::DB.create_table(:apples) do')).must_equal true
-      _(lines.include?('foreign_key [:blue_id, :shoe_id]')).must_equal true
-      _(lines.include?(':blue_and_shoe_join_tb')).must_equal true
-      _(lines.include?('end')).must_equal true
+      _(lines.include?('class CreateApples')).must_equal(true)
+      _(lines.include?('def call')).must_equal(true)
+      _(lines.include?('return if Rubee::SequelObject::DB.tables.include?(:apples)')).must_equal(true)
+      _(lines.include?('Rubee::SequelObject::DB.create_table(:apples) do')).must_equal(true)
+      _(lines.include?('foreign_key [:blue_id, :shoe_id]')).must_equal(true)
+      _(lines.include?(':blue_and_shoe_join_tb')).must_equal(true)
+      _(lines.include?('end')).must_equal(true)
     end
 
     it 'with a model with a foreign_key without table' do
       generator = Rubee::Generator.new('apple', [{ name: 'blue_id', type: :foreign_key }], 'apples', nil)
       generator.call
 
-      _(File.exist?('lib/db/create_apples.rb')).must_equal true
+      _(File.exist?('lib/db/create_apples.rb')).must_equal(true)
 
       lines = File.readlines('lib/db/create_apples.rb').map(&:chomp).join("\n")
 
-      _(lines.include?('class CreateApples')).must_equal true
-      _(lines.include?('def call')).must_equal true
-      _(lines.include?('return if Rubee::SequelObject::DB.tables.include?(:apples)')).must_equal true
-      _(lines.include?('Rubee::SequelObject::DB.create_table(:apples) do')).must_equal true
-      _(lines.include?('foreign_key :blue_id')).must_equal true
-      _(lines.include?(':replace_with_table_name')).must_equal true
-      _(lines.include?('end')).must_equal true
+      _(lines.include?('class CreateApples')).must_equal(true)
+      _(lines.include?('def call')).must_equal(true)
+      _(lines.include?('return if Rubee::SequelObject::DB.tables.include?(:apples)')).must_equal(true)
+      _(lines.include?('Rubee::SequelObject::DB.create_table(:apples) do')).must_equal(true)
+      _(lines.include?('foreign_key :blue_id')).must_equal(true)
+      _(lines.include?(':replace_with_table_name')).must_equal(true)
+      _(lines.include?('end')).must_equal(true)
     end
   end
 
@@ -136,53 +139,54 @@ describe 'Rubee::Generator' do
       generator = Rubee::Generator.new(nil, nil, nil, nil)
       generator.call
 
-      _(File.exist?('lib/app/models/apple.rb')).must_equal false
+      _(File.exist?('lib/app/models/apple.rb')).must_equal(false)
     end
 
     it 'with a model only' do
       generator = Rubee::Generator.new('apple', nil, 'apples', nil)
       generator.call
 
-      _(File.exist?('lib/app/models/apple.rb')).must_equal true
+      _(File.exist?('lib/app/models/apple.rb')).must_equal(true)
 
       lines = File.readlines('lib/app/models/apple.rb').map(&:chomp).join("\n")
 
-      _(lines.include?('class Apple < Rubee::SequelObject')).must_equal true
-      _(lines.include?('attr_accessor')).must_equal false
-      _(lines.include?('end')).must_equal true
+      _(lines.include?('class Apple < Rubee::SequelObject')).must_equal(true)
+      _(lines.include?('attr_accessor')).must_equal(false)
+      _(lines.include?('end')).must_equal(true)
     end
 
     it 'with a model with attributes' do
-      generator = Rubee::Generator.new('apple', [{ name: 'title', type: :string }, {name: 'content', type: :text }], 'apples', nil)
+      generator = Rubee::Generator.new('apple', [{ name: 'title', type: :string }, { name: 'content', type: :text }],
+'apples', nil)
       generator.call
 
-      _(File.exist?('lib/app/models/apple.rb')).must_equal true
+      _(File.exist?('lib/app/models/apple.rb')).must_equal(true)
 
       lines = File.readlines('lib/app/models/apple.rb').map(&:chomp).join("\n")
 
-      _(lines.include?('class Apple < Rubee::SequelObject')).must_equal true
-      _(lines.include?('attr_accessor')).must_equal true
-      _(lines.include?(':title, :content')).must_equal true
-      _(lines.include?('end')).must_equal true
+      _(lines.include?('class Apple < Rubee::SequelObject')).must_equal(true)
+      _(lines.include?('attr_accessor')).must_equal(true)
+      _(lines.include?(':title, :content')).must_equal(true)
+      _(lines.include?('end')).must_equal(true)
     end
 
     it 'with a model with different attributes' do
-      generator = Rubee::Generator.new('apple', [{name: 'id', type: :bigInt}, {name: 'colour', type: :string }, {name: 'weight', type: :integer }], 'apples', nil)
+      generator = Rubee::Generator.new('apple',
+[{ name: 'id', type: :bigInt }, { name: 'colour', type: :string }, { name: 'weight', type: :integer }], 'apples', nil)
       generator.call
 
-      _(File.exist?('lib/app/models/apple.rb')).must_equal true
+      _(File.exist?('lib/app/models/apple.rb')).must_equal(true)
 
       lines = File.readlines('lib/app/models/apple.rb').map(&:chomp).join("\n")
 
-      _(lines.include?('class Apple < Rubee::SequelObject')).must_equal true
-      _(lines.include?('attr_accessor')).must_equal true
-      _(lines.include?(':id, :colour, :weight')).must_equal true
-      _(lines.include?('end')).must_equal true
+      _(lines.include?('class Apple < Rubee::SequelObject')).must_equal(true)
+      _(lines.include?('attr_accessor')).must_equal(true)
+      _(lines.include?(':id, :colour, :weight')).must_equal(true)
+      _(lines.include?('end')).must_equal(true)
     end
   end
 
   describe 'generates View file' do
-
   end
 
   describe 'generates Controller file' do

data/lib/tests/test_helper.rb

@@ -1,8 +1,17 @@
 require 'bundler/setup'
 Bundler.require(:test)
 
+require 'simplecov'
+SimpleCov.start do
+  add_filter %r{^/lib/db/}
+  add_filter %r{^/lib/inits/}
+  add_filter %r{^/lib/tests/}
+end
+
 require 'minitest/autorun'
 require 'rack/test'
+require 'stringio'
+
 require_relative '../../lib/rubee'
 
 Rubee::Autoload.call
@@ -10,3 +19,22 @@ Rubee::Configuration.setup(env = :test) do |config|
   config.database_url = { url: 'sqlite://lib/tests/test.db', env: }
 end
 Rubee::SequelObject.reconnect!
+
+def assert_difference(expression, difference = 1)
+  before = expression.call
+  yield
+  after = expression.call
+  actual_diff = after - before
+
+  assert_equal(difference, actual_diff,
+    "Expected change of #{difference}, but got #{actual_diff}")
+end
+
+def capture_stdout
+  old_stdout = $stdout
+  $stdout = StringIO.new
+  yield
+  $stdout.string
+ensure
+  $stdout = old_stdout
+end

data/readme.md

@@ -18,6 +18,25 @@ Want to get a quick API server up and runing? You can do it for real quick!
 
 All greaet features are yet to come!
 
+## Content:
+
+- [Installation](#Installation)
+- [Run tests](#Run tests)
+- [Draw contract](#Draw contract)
+- [Model](#Model)
+- [Routing](#Routing)
+- [Database](#Database)
+- [Views](#Views)
+- [Hooks](#Hooks)
+- [JWT based authentification](#JWT based authentification)
+- [Rubee commands](#Rubee commands)
+- [Generate commands](#Generate commands)
+- [Migration commands](#Migration commands)
+- [Rubee console](#Rubee console)
+- [Testing](#Testing)
+- [Background jobs](#Background jobs)
+- [Logger](#Logger)
+
 ## Features
 
 - **Lightweight**: A minimal footprint that focuses on serving Ruby applications efficiently.
@@ -33,6 +52,8 @@ All greaet features are yet to come!
 - **Hooks** Addlogic before, after and around any action.
 - **Test** Run all or selected tests witin minitest.
 - **Asyncable** Add async adapter and pick any popular background job queue enginee
+- **Console** Start the interactive console and reload it on the fly
+- **Background jobs** Add async adapter and pick any popular background job queue engine
 
 ## Installation
 
@@ -65,12 +86,12 @@ rubee start
 
 5. Open your browser and go to http://localhost:7000
 
-## Run the tests
+## Run tests
 ```bash
 rubee test
 ```
 
-## Create API contract and generate files from the routes
+## Draw contract
 1. Add the routes to the routes.rb
     ```ruby
     Rubee::Router.draw do |router|
@@ -88,21 +109,21 @@ rubee test
     end
     ```
 2. generate the files
-    ```bash
+```bash
     rubee generate get /apples
-    ```
-- This will generate the following files
-  ```bash
+```
+This will generate the following files
+```bash
   ./app/controllers/apples_controller.rb # Controller with respective action
   ./app/views/apples_index.erb # ERB view that is rendered by the controller right away
   ./app/models/apple.rb # Model that acts as ORM
   ./db/create_apples.rb # Database migration file needed for creating repsective table
-  ```
+```
 
 3. Run the initial db migration
     ```bash
     rubee db run:all
-    ``` 
+    ```
 
 5. Fill the generated files with the logic you need and run the server again!
 
@@ -395,9 +416,9 @@ Example 3:
 Rubee::Router.draw do |router|
   ...
   # draw the contract
-  router.get "/apples", to: "apples#index", 
-    model: { 
-      name: 'apple', 
+  router.get "/apples", to: "apples#index",
+    model: {
+      name: 'apple',
       attributes: [
         { name: 'id', type: :primary },
         { name: 'colour', type: :string },
@@ -755,6 +776,51 @@ end
 
 TestAsyncRunnner.new.perform_async(options: {"email"=> "new@new.com", "password"=> "123"})
 ```
+### Logger
+
+You can use your own logger by setting it in the /config/base_configuration.rb.
+
+```ruby
+# config/base_configuration.rb
+Rubee::Configuration.setup(env=:development) do |config|
+  config.database_url = { url: "sqlite://db/development.db", env: }
+  config.logger = { logger: MyLogger, env: }
+end
+```
+
+Or you can use the default logger.
+Let's consider example with welcome controller and around hook:
+```ruby
+# app/controllers/welcome_controller.rb
+class WelcomeController < Rubee::BaseController
+  around :show, ->(&target_method) do
+    start = Time.now
+    Rubee::Logger.warn(message: 'This is a warning message', method: :show, class_name: 'WelcomeController')
+    Rubee::Logger.error(message: 'This is a warning message', class_name: 'WelcomeController')
+    Rubee::Logger.critical(message: 'We are on fire!')
+    target_method.call
+    Rubee::Logger.info(
+      message: "Execution Time: #{Time.now - start} seconds",
+      method: :show,
+      class_name: 'WelcomeController'
+    )
+    Rubee::Logger.debug(object: User.last, method: :show, class_name: 'WelcomeController')
+  end
+
+  def show
+    response_with
+  end
+end
+```
+When you trigger the controller action, the logs will look like this:
+
+```bash
+[2025-04-26 12:32:33] WARN [method: show][class_name: WelcomeController] This is a warning message
+[2025-04-26 12:32:33] ERROR [class_name: WelcomeController] This is a warning message
+[2025-04-26 12:32:33] CRITICAL We are on fire!
+[2025-04-26 12:32:33] INFO [method: show][class_name: WelcomeController] Execution Time: 0.000655 seconds
+[2025-04-26 12:32:33] DEBUG [method: show][class_name: WelcomeController] #<User:0x000000012c5c63e0 @id=4545, @email="ok@op.com", @password="123">
+```
 
 ### Contributing