ru.Bee 1.5.4 → 1.7.0

data/lib/tests/example_models/address.rb

@@ -0,0 +1,5 @@
+class Address < Rubee::SequelObject
+  attr_accessor :id, :street, :apt, :city, :state, :zip, :user_id
+
+  holds :user
+end

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/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
@@ -17,7 +26,16 @@ def assert_difference(expression, difference = 1)
   after = expression.call
   actual_diff = after - before
 
-  assert_equal difference, actual_diff,
-    "Expected change of #{difference}, but got #{actual_diff}"
+  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

@@ -16,12 +16,35 @@ Want to get a quick API server up and runing? You can do it for real quick!
 <br />
 [![Video Title](https://img.youtube.com/vi/ko7H70s7qq0/0.jpg)](https://www.youtube.com/watch?v=ko7H70s7qq0)
 
-All greaet features are yet to come!
+All great 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)
+- [Modular](#Modular application)
+- [Logger](#Logger)
 
 ## Features
 
 - **Lightweight**: A minimal footprint that focuses on serving Ruby applications efficiently.
-- **Contract driven**: Define your API contracts in a simple, declarative manner. And generate the files for you.
+- **Moduled** A modular approach to application development. Build modular monolith applications with ease by \
+attaching as many subprojects you need.
+- **Contract driven**: Define your API contracts in a simple, declarative manner.\
+Then generate the biolerplate files you need.
 - **Fast**: Optimized for speed, providing a quick response to requests. Everything is relative, I know!
 - **Rack**: Rack backed. All Rack api is available for integration.
 - **Databases**: Sqlite3, Postgres, Mysql and many more supported by sequel gem.
@@ -30,9 +53,11 @@ All greaet features are yet to come!
 - **Bundlable** Charge your ruBee with any gem you need and update your project with bundle.
 - **ORM** All models are natively ORM objects, however you can use it as a blueurpint for any datasources.
 - **Authentificatable** Add JWT authentification easily to any controller action.
-- **Hooks** Addlogic before, after and around any action.
-- **Test** Run all or selected tests witin minitest.
+- **Hooks** Add logic before, after and around any action.
+- **Test** Run all or selected tests witin fast and beloved 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
 
@@ -46,6 +71,8 @@ gem install ru.Bee
 rubee project my_project
 cd my_project
 ```
+- [Back to content](#Content)
+
 
 3. Install dependencies
 
@@ -65,12 +92,13 @@ rubee start
 
 5. Open your browser and go to http://localhost:7000
 
-## Run the tests
+## Run tests
 ```bash
 rubee test
 ```
+- [Back to content](#Content)
 
-## 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,23 +116,24 @@ 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!
+- [Back to content](#Content)
 
 ## Model
 Model in ruBee is just simple ruby object that can be serilalized in the view
@@ -153,6 +182,7 @@ So in the controller you would need to query your target object now.
     end
   end
 ```
+- [Back to content](#Content)
 
 #### Rubee::SequelObject base methods:
 
@@ -283,6 +313,7 @@ irb(main):010>  .then { |dataset| Comment.serialize(dataset) }
 ```
 This is recommended when you want to run one query and serialize it back to Rubee object only once.
 So it may safe some resources.
+- [Back to content](#Content)
 
 ## Routing
 Rubee uses explicit routes. In the routes.rb yout can define routes for any of the main HTTP methods. You can also add any matched parameter denoted by a pair of `{ }` in the path of the route. Eg. `/path/to/{a_key}/somewhere`
@@ -395,9 +426,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 },
@@ -415,6 +446,80 @@ Will generate:
 ./db/create_apples.rb # Database migration file needed for creating repsective table
 ```
 
+### Modualar application
+
+You can also use ruBee to create modular applications.\
+And attach as many subprojects you need.
+Main philosophy of attach functinality is to keep the main project clean and easy to maintain. It will still\
+share data with the main app. So where to define a border between main app and subprojects is up to developer.
+Howerver by attching new subproject you will get a new folder and files configured and namespaced respectively.
+
+So if you need to extend your main app with a separate project you can do it easily in ruBee.
+1. Attach new subrpoject
+
+```bash
+rubee attach admin
+```
+This will create a dedicated folder in the project root called admin and all the MVC setup, route and configuraion \
+files will be created there.
+
+2. Add routes
+
+```ruby
+# admin_routes.rb
+Rubee::Router.draw do |router|
+  ...
+  # draw the contract
+    router.get '/admin/cabages', to: 'cabages#index',
+                                   model: {
+                                     name: 'cabage',
+                                     attributes: [
+                                       { name: 'id', type: :primary },
+                                       { name: 'name', type: :string }
+                                     ]
+                                   },
+                                   namespace: :admin # mandatory option for supporting namespacing
+end
+```
+3. Run gen command
+
+```bash
+rubee gen get /admin/cabages app:admin
+```
+
+This will generate the bolierplate files:
+
+```bash
+./admin/controllers/cabages_controller.rb
+./admin/views/cabages_index.erb
+./admin/models/cabage.rb
+./db/create_cabages.rb
+```
+
+4. Perform migrations
+
+```bash
+rubee db run:create_cabages
+```
+5. Fill the views and controller with the content
+
+```ruby
+# ./admin/controllers/cabages_controller.rb
+class Admin::CabagesController < Rubee::BaseController
+  def index
+    response_with object: Cabage.all, type: :json
+  end
+end
+```
+
+6. Run the rubee server
+
+```bash
+rubee start # or rubee start_dev for development
+```
+
+- [Back to content](#Content)
+
 ## Views
 View in ruBee is just a plain html/erb/react file that can be rendered from the controller.
 
@@ -549,6 +654,7 @@ function Users() {
 }
 
 ```
+- [Back to content](#Content)
 
 ## Object hooks
 
@@ -591,6 +697,8 @@ after index2
 after log around
 127.0.0.1 - - [17/Feb/2025:11:42:14 -0500] "GET /apples HTTP/1.1" 401 - 0.0359
 ```
+- [Back to content](#Content)
+
 
 ## JWT based authentification
 Charge you rpoject with token based authentification system and customize it for your needs.
@@ -640,6 +748,7 @@ class UsersController < Rubee::BaseController
   end
 end
 ```
+- [Back to content](#Content)
 
 ## Rubee commands
 ```bash
@@ -674,6 +783,8 @@ rubee console # start the console
 rubee test # run all tests
 rubee test auth_tokenable_test.rb # run specific tests
 ```
+- [Back to content](#Content)
+
 
 If you want to run any ruBee command within a specific ENV make sure you added it before a command.
 For instance if you want to run console in test environment you need to run the following command
@@ -755,6 +866,54 @@ end
 
 TestAsyncRunnner.new.perform_async(options: {"email"=> "new@new.com", "password"=> "123"})
 ```
+- [Back to content](#Content)
+
+### 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">
+```
+- [Back to content](#Content)
 
 ### Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ru.Bee
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.7.0
 platform: ruby
 authors:
 - Oleg Saltykov
@@ -43,11 +43,9 @@ files:
 - lib/Dockerfile
 - lib/app/controllers/welcome_controller.rb
 - lib/app/models/user.rb
-- lib/app/views/app.tsx
-- lib/app/views/apples_.erb
+- lib/app/views/App.tsx
 - lib/app/views/index.html
 - lib/app/views/layout.erb
-- lib/app/views/s_.erb
 - lib/app/views/utils/redirectToBackend.tsx
 - lib/app/views/welcome_header.erb
 - lib/app/views/welcome_show.erb
@@ -56,12 +54,14 @@ files:
 - lib/config/routes.rb
 - lib/css/app.css
 - lib/db/create_accounts.rb
+- lib/db/create_addresses.rb
 - lib/db/create_comments.rb
 - lib/db/create_posts.rb
 - lib/db/create_users.rb
 - lib/db/structure.rb
 - lib/esbuild.config.js
 - lib/images/rubee.svg
+- lib/inits/charged_hash.rb
 - lib/inits/charged_string.rb
 - lib/inits/print_colors.rb
 - lib/js/app.js
@@ -229,30 +229,55 @@ files:
 - lib/package.json
 - lib/rubee.rb
 - lib/rubee/async/asyncable.rb
+- lib/rubee/async/fiber_queue.rb
 - lib/rubee/async/sidekiq_async.rb
 - lib/rubee/async/thread_async.rb
 - lib/rubee/async/thread_pool.rb
+- lib/rubee/autoload.rb
+- lib/rubee/cli/attach.rb
+- lib/rubee/cli/command.rb
+- lib/rubee/cli/console.rb
+- lib/rubee/cli/db.rb
+- lib/rubee/cli/generate.rb
+- lib/rubee/cli/project.rb
+- lib/rubee/cli/react.rb
+- lib/rubee/cli/routes.rb
+- lib/rubee/cli/server.rb
+- lib/rubee/cli/test.rb
+- lib/rubee/cli/version.rb
+- lib/rubee/configuration.rb
 - lib/rubee/controllers/base_controller.rb
 - lib/rubee/controllers/extensions/auth_tokenable.rb
 - lib/rubee/controllers/extensions/middlewarable.rb
 - lib/rubee/controllers/middlewares/auth_token_middleware.rb
 - lib/rubee/extensions/hookable.rb
 - lib/rubee/extensions/serializable.rb
+- lib/rubee/generator.rb
+- lib/rubee/logger.rb
 - lib/rubee/models/database_objectable.rb
 - lib/rubee/models/sequel_object.rb
-- lib/tests/account_model_test.rb
+- lib/rubee/router.rb
 - lib/tests/async/thread_async_test.rb
-- lib/tests/auth_tokenable_test.rb
-- lib/tests/comment_model_test.rb
+- lib/tests/cli/attach_test.rb
+- lib/tests/controllers/auth_tokenable_test.rb
+- lib/tests/controllers/base_controller_test.rb
+- lib/tests/controllers/hookable_test.rb
+- lib/tests/controllers/rubeeapp_test.rb
 - lib/tests/example_models/account.rb
+- lib/tests/example_models/address.rb
 - lib/tests/example_models/comment.rb
 - lib/tests/example_models/post.rb
 - lib/tests/example_models/user.rb
+- lib/tests/logger_test.rb
+- lib/tests/models/account_model_test.rb
+- lib/tests/models/comment_model_test.rb
+- lib/tests/models/db_objectable_test.rb
+- lib/tests/models/seralizable_test.rb
+- lib/tests/models/user_model_test.rb
+- lib/tests/rubee_attach_test.rb
 - lib/tests/rubee_generator_test.rb
-- lib/tests/rubeeapp_test.rb
 - lib/tests/test.db
 - lib/tests/test_helper.rb
-- lib/tests/user_model_test.rb
 - readme.md
 homepage: https://github.com/nucleom42/rubee
 licenses:

data/lib/app/views/apples_.erb

@@ -1 +0,0 @@
-<h1>apples_ View</h1>

data/lib/app/views/s_.erb

@@ -1 +0,0 @@
-<h1>s_ View</h1>