ru.Bee 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4ecb77e79daf38768a10a5da26f7f1e3013734c864774e128ffb767d5d6d9a1
-  data.tar.gz: 1f9a6de22160db7ac4deb411278f4bb53bb94ee0a58893a9089a5eb99fd061fa
+  metadata.gz: 3a7e2d8462e9cf796796f117503bbc4d51dfebaa8d9923d5e1e6905d522a5af7
+  data.tar.gz: d8eb71da20db0400dc96900f73f53481c835449d4b3f1ee20979dc95e7c083f4
 SHA512:
-  metadata.gz: 312f2143e4244dec12bdd6e40a815eeb9a2cf70af31bea3ef2c5211ae4a491dc8532931ca4d0ef4529979d579f2c17e3ade73fd09c3f9f75a0b79697e3c93200
-  data.tar.gz: d53621c81d31e8b7e48b030762d5f58726756e3946da14a2774fd8c6239f96ccb87a4f8d4c533b862981a792a5c90a0755d22a66d6b5b5428d4df75d46ac8265
+  metadata.gz: 041f294e20e60f29ab5c03833613815fe7c462b7cc248a79aad228fbfe680e5474f6c38695c884d060a9cebfa0c0f2e918a915c102e2476e98d45df39b7a77ab
+  data.tar.gz: b0f0acda20a4de0d3c8bfebc32b9229c9be04f1311d7f2bab5e3d6a5fa7819a7414f05d0902988801a7ed624b681dfbd14ca3e7682a85a5daf094014ee907a0c

data/lib/rubee/cli/server.rb

@@ -17,22 +17,27 @@ LOGO
 
         def start(argv)
           _, port = argv.first&.split(':')
+          jit = argv[1]
 
           port ||= '7000'
           print_logo
           color_puts("Starting takeoff of ruBee server on port #{port}...", color: :yellow)
-          exec("rackup #{ENV['RACKUP_FILE']} -p #{port}")
+          command = "#{jit_prefix(jit)}rackup #{ENV['RACKUP_FILE']} -p #{port}"
+          color_puts(command, color: :gray)
+          exec(command)
         end
 
         def start_dev(argv)
           _, port = argv.first&.split(':')
+          jit = argv[1]
 
           port ||= '7000'
           print_logo
 
           color_puts("Starting takeoff of ruBee server on port #{port} in dev mode...", color: :yellow)
-
-          exec("rerun -- rackup --port #{port} #{ENV['RACKUP_FILE']}")
+          command = "rerun -- #{jit_prefix_dev(jit)}rackup --port #{port} #{ENV['RACKUP_FILE']}"
+          color_puts(command, color: :gray)
+          exec(command)
         end
 
         def stop(_argv)
@@ -46,6 +51,24 @@ LOGO
         def print_logo
           puts "\e[36m#{LOGO % Rubee::VERSION}\e[0m" # Cyan color
         end
+
+        def jit_prefix(key)
+          case key
+          when 'yjit'
+            "ruby --yjit -S "
+          else
+            ""
+          end
+        end
+
+        def jit_prefix_dev(key)
+          case key
+          when 'yjit'
+            "ruby --yjit -S "
+          else
+            ""
+          end
+        end
       end
     end
   end

data/lib/rubee.rb

@@ -16,7 +16,7 @@ module Rubee
   JS_DIR = File.join(APP_ROOT, LIB, 'js') unless defined?(JS_DIR)
   CSS_DIR = File.join(APP_ROOT, LIB, 'css') unless defined?(CSS_DIR)
   ROOT_PATH = File.expand_path(File.join(__dir__, '..')) unless defined?(ROOT_PATH)
-  VERSION = '1.7.0'
+  VERSION = '1.8.0'
 
   require_relative 'rubee/router'
   require_relative 'rubee/logger'

data/readme.md

@@ -8,56 +8,67 @@
 
 # <img src="lib/images/rubee.svg" alt="ruBee" height="40"> ... ruBee
 
-ruBee is a fast and lightweight Ruby application server designed for minimalism and flexibility .
-
-The main philosophy of ruBee is to focus on Ruby language explicit implementation of the MVC web application.
+Rubee is a Ruby-based framework designed to streamline the development of modular monolith applications. \
+It offers a structured approach to building scalable, maintainable, and React-ready projects, \
+making it an ideal choice for developers seeking a balance between monolithic simplicity and modular flexibility.
 
 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 great features are yet to come!
-
-## Content:
+[![Watch the demo](https://img.youtube.com/vi/ko7H70s7qq0/hqdefault.jpg)](https://www.youtube.com/watch?v=ko7H70s7qq0)
+## Content
 
-- [Installation](#Installation)
+- [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)
+- [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](#modualar-application)
+- [Logger](#logger)
 
 ## Features
 
-- **Lightweight**: A minimal footprint that focuses on serving Ruby applications efficiently.
-- **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.
-- **Views**: Json, ERB and plain HTML and ..
-- **React** is supported out of the box as a rubee view
-- **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** 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
+🐝 Lightweight – A minimal footprint focused on serving Ruby applications efficiently.
+<br>
+🧩 Modular – A modular approach to application development. Build modular monoliths with ease by attaching \
+as many subprojects as you need.
+<br>
+📜 Contract-driven – Define your API contracts in a simple, declarative way, then generate all the boilerplate you need.
+<br>
+⚡ Fast – Optimized for speed, providing quick responses. (Everything is relative, we know! 😄)
+<br>
+🧱 Rack-powered – Built on Rack. The full Rack API is available for easy integration.
+<br>
+🗄️ Databases – Supports SQLite3, PostgreSQL, MySQL, and more via the Sequel gem.
+<br>
+🖼️ Views – JSON, ERB, and plain HTML out of the box.
+<br>
+⚛️  React Ready – React is supported as a first-class Rubee view engine.
+<br>
+📦 Bundlable – Charge your Rubee app with any gem you need. Update effortlessly via Bundler.
+<br>
+🧬 ORM-agnostic – Models are native ORM objects, but you can use them as blueprints for any data source.
+<br>
+🔐 Authenticatable – Easily add JWT authentication to any controller action.
+<br>
+🪝 Hooks – Add logic before, after, or around any controller action.
+<br>
+🧪 Testable – Run all or selected tests using fast, beloved Minitest.
+<br>
+👷 Asyncable – Plug in async adapters and use any popular background job engine.
+<br>
+⌨️  Console – Start an interactive console and reload on the fly.
+<br>
+⚙️  Background Jobs – Schedule and process background jobs using your preferred async stack.
 
 ## Installation
 
@@ -69,16 +80,17 @@ gem install ru.Bee
 2. Create your first project
 ```bash
 rubee project my_project
+
 cd my_project
 ```
-- [Back to content](#Content)
 
+[Back to content](#content)
 
 3. Install dependencies
 
 ***Prerequisites***<br />
 Make sure:
-**Ruby** language (3+) is installed
+**Ruby** language (3.1>) is installed
 **Bundler** is installed
 
 ```bash
@@ -87,7 +99,7 @@ bundle install
 
 4. Run ruBee server. Default port is 7000
 ```bash
-rubee start
+rubee start # or rubee start_dev for development
 ```
 
 5. Open your browser and go to http://localhost:7000
@@ -95,10 +107,13 @@ rubee start
 ## Run tests
 ```bash
 rubee test
+# or you can specify specific test file
+rubee test models/user_model_test.rb
 ```
-- [Back to content](#Content)
+[Back to content](#content)
 
 ## Draw contract
+
 1. Add the routes to the routes.rb
     ```ruby
     Rubee::Router.draw do |router|
@@ -115,6 +130,7 @@ rubee test
         }
     end
     ```
+
 2. generate the files
 ```bash
     rubee generate get /apples
@@ -128,17 +144,17 @@ This will generate the following files
 ```
 
 3. Run the initial db migration
-    ```bash
+```bash
     rubee db run:all
-    ```
+```
+
+4. Fill the generated files with the logic you need and run the server again!
 
-5. Fill the generated files with the logic you need and run the server again!
-- [Back to content](#Content)
+[Back to content](#content)
 
 ## Model
 Model in ruBee is just simple ruby object that can be serilalized in the view
 in the way it required (ie json).
-
 Here below is a simple example on how it can be used by rendering json from in memory object
 
 ```ruby
@@ -160,6 +176,7 @@ Just make sure Serializable module included in the target class.
     attr_accessor :id, :colour, :weight
   end
 ```
+
 However, you can simply turn it to ORM object by extending database class Rubee::SequelObject.
 This one is already serializable and charged with hooks.
 ```Ruby
@@ -182,9 +199,10 @@ So in the controller you would need to query your target object now.
     end
   end
 ```
-- [Back to content](#Content)
 
-#### Rubee::SequelObject base methods:
+[Back to content](#content)
+
+#### Rubee::SequelObject base methods
 
 Initiate new record in memory
 ```Ruby
@@ -313,10 +331,13 @@ 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)
+
+[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`
+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`
 
 ### Routing methods
 ``` ruby
@@ -334,10 +355,14 @@ end
 ```
 
 As you see above every route is set up as:\
-`route.http_method path, to: "controller#action", model { ...optional }`
+```ruby
+route.{http_method} {path}, to: "{controller}#{action}",
+  model { ...optional }, namespace { ...optional }, react { ...optional }
+```
 
 ### Defining Model attributes in routes
-One of Rubee's unique traits is where we can define our models for generation. You've seen above one possible way you can set up.
+One of Rubee's unique traits is where we can define our models for generation. \
+You've seen above one possible way you can set up.
 
 ```ruby
 Rubee::Router.draw do |router|
@@ -355,41 +380,52 @@ Rubee::Router.draw do |router|
 end
 ```
 
-There are many other keys supported by us and Sequel to help generate your initial db files. Other supported attribute key types are:
+There are many other types supported by us and Sequel to help generate your initial db files. \
+Other supported attribute key types are:
 ``` ruby
 [
-  { name: 'key1', type: :primary},
-  { name: 'key2', type: :string },
-  { name: 'key3', type: :text },
-  { name: 'key4', type: :integer },
-  { name: 'key5', type: :date },
-  { name: 'key6', type: :datetime },
-  { name: 'key7', type: :time },
-  { name: 'key8', type: :boolean },
-  { name: 'key9', type: :bigint },
-  { name: 'key10', type: :decimal },
-  { name: 'key11', type: :foreign_key },
-  { name: 'key12', type: :index },
-  { name: 'key13', type: :unique }
+  { name: 'id', type: :primary},
+  { name: 'name', type: :string },
+  { name: 'description', type: :text },
+  { name: 'quntity', type: :integer },
+  { name: 'created', type: :date },
+  { name: 'modified', type: :datetime },
+  { name: 'exists', type: :time },
+  { name: 'active', type: :boolean },
+  { name: 'hash', type: :bigint },
+  { name: 'price', type: :decimal },
+  { name: 'item_id', type: :foreign_key },
+  { name: 'item_id_index', type: :index },
+  { name: 'item_id_unique', type: :unique }
 ]
 ```
-Every attribute can have a set of options passed based on their related [Sequel schema definition](https://github.com/jeremyevans/sequel/blob/master/doc/schema_modification.rdoc).
+Every attribute can have a set of options passed based on their related \
+[Sequel schema definition](https://github.com/jeremyevans/sequel/blob/master/doc/schema_modification.rdoc).
 
 An example of this would be for the type string: \
-`{name: 'key', type: :string, options: { size: 50, fixed: true } }`
+```ruby
+{name: 'key', type: :string, options: { size: 50, fixed: true } }
+```
 
 Gets translated to:\
-`String :key, size: 50, fixed: true`
+```
+rubyString :key, size: 50, fixed: true
+```
 
 ### Generation from routes
-As long as you have a `{ model: 'something' }` passed to your given route you can use it to generate your initial model files. If only a `path` and a `to:` are defined will only generate a controller and a corresponding view.
+As long as you have a `{ model: 'something' }` passed to your given route, \
+you can use it to generate your initial model files. If only a `path` and a `to:` are defined will only generate \
+a controller and a corresponding view.
 
 To generate based on a get route for the path /apples:\
-`rubee generate get /apples` or `rubee gen get /apples`\
+```ruby
+rubee generate get /apples # or rubee gen get /apples
+```
 
 To generate base on a patch request for the path /apples/{id}:\
-`rubee generate patch /apples/{id}` or `rubee gen patch /apples/{id}`
-
+```ruby
+rubee generate patch /apples/{id} # or rubee gen patch /apples/{id}
+```
 
 Example:
 ```ruby
@@ -413,6 +449,7 @@ Rubee::Router.draw do |router|
   router.get "/apples", to: "apples#index", model: { name: 'apple' }
 end
 ```
+
 Will generate:
 ```bash
 ./app/controllers/apples_controller.rb # Controller with respective action
@@ -446,15 +483,16 @@ 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.
+share data with the main app. So where to define a border between the 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.
+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
@@ -470,17 +508,18 @@ files will be created there.
 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
+  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
@@ -501,6 +540,7 @@ This will generate the bolierplate files:
 ```bash
 rubee db run:create_cabages
 ```
+
 5. Fill the views and controller with the content
 
 ```ruby
@@ -518,7 +558,7 @@ end
 rubee start # or rubee start_dev for development
 ```
 
-- [Back to content](#Content)
+[Back to content](#content)
 
 ## Views
 View in ruBee is just a plain html/erb/react file that can be rendered from the controller.
@@ -567,6 +607,7 @@ Prerequisites: Node and NPM are required
 ```bash
 rubee react prepare # this will install react related node modules
 ```
+
 2. Make sure you have configured react in the configuration file
 
 ```ruby
@@ -600,7 +641,7 @@ Rubee::Router.draw do |router|
   router.get('/', to: 'welcome#show') # override it for your app
 
   router.get('/api/users', to: 'user#index', react: { view_name: 'users.tsx' })
-  # Please note /api/users is the backend endpoint
+  # Please note /api/users here is the backend endpoint
   # For rendering generated /app/views/users.tsx file, you need to update react routes
 end
 ```
@@ -654,7 +695,7 @@ function Users() {
 }
 
 ```
-- [Back to content](#Content)
+[Back to content](#content)
 
 ## Object hooks
 
@@ -697,10 +738,11 @@ 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)
 
+[Back to content](#content)
 
 ## JWT based authentification
+
 Charge you rpoject with token based authentification system and customize it for your needs.
 include AuthTokenable module to your controller and authentificate any action you need.
 
@@ -748,7 +790,8 @@ class UsersController < Rubee::BaseController
   end
 end
 ```
-- [Back to content](#Content)
+
+[Back to content](#content)
 
 ## Rubee commands
 ```bash
@@ -783,7 +826,8 @@ rubee console # start the console
 rubee test # run all tests
 rubee test auth_tokenable_test.rb # run specific tests
 ```
-- [Back to content](#Content)
+
+[Back to content](#content)
 
 
 If you want to run any ruBee command within a specific ENV make sure you added it before a command.
@@ -850,6 +894,7 @@ end
 ```ruby
 TestAsyncRunnner.new.perform_async(options: {"email"=> "new@new.com", "password"=> "123"})
 ```
+
 ### Default engine is ThreadAsync
 However it is not yet recommended for production. Use it with cautions!
 1. Do not define any adapter in the /config/base_configuration.rb file, so default ThreadAsync will be taken.
@@ -866,7 +911,8 @@ end
 
 TestAsyncRunnner.new.perform_async(options: {"email"=> "new@new.com", "password"=> "123"})
 ```
-- [Back to content](#Content)
+
+[Back to content](#content)
 
 ### Logger
 
@@ -913,7 +959,8 @@ When you trigger the controller action, the logs will look like this:
 [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)
+
+[Back to content](#content)
 
 ### Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ru.Bee
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Oleg Saltykov
@@ -290,7 +290,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.1
+      version: 3.4.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="