ru.Bee 1.6.0 → 1.8.0

data/readme.md

@@ -8,52 +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 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)
+[![Watch the demo](https://img.youtube.com/vi/ko7H70s7qq0/hqdefault.jpg)](https://www.youtube.com/watch?v=ko7H70s7qq0)
+## 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](#modualar-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.
-- **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** 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
+🐝 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
 
@@ -65,14 +80,17 @@ gem install ru.Bee
 2. Create your first project
 ```bash
 rubee project my_project
+
 cd my_project
 ```
 
+[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
@@ -81,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
@@ -89,9 +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)
 
 ## Draw contract
+
 1. Add the routes to the routes.rb
     ```ruby
     Rubee::Router.draw do |router|
@@ -108,6 +130,7 @@ rubee test
         }
     end
     ```
+
 2. generate the files
 ```bash
     rubee generate get /apples
@@ -121,16 +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)
 
 ## 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
@@ -152,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
@@ -175,7 +200,9 @@ So in the controller you would need to query your target object now.
   end
 ```
 
-#### Rubee::SequelObject base methods:
+[Back to content](#content)
+
+#### Rubee::SequelObject base methods
 
 Initiate new record in memory
 ```Ruby
@@ -305,8 +332,12 @@ 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`
+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
@@ -324,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|
@@ -345,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
@@ -403,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
@@ -436,6 +483,83 @@ 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 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.
+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.
 
@@ -483,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
@@ -516,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
 ```
@@ -570,6 +695,7 @@ function Users() {
 }
 
 ```
+[Back to content](#content)
 
 ## Object hooks
 
@@ -613,7 +739,10 @@ 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.
 include AuthTokenable module to your controller and authentificate any action you need.
 
@@ -662,6 +791,8 @@ class UsersController < Rubee::BaseController
 end
 ```
 
+[Back to content](#content)
+
 ## Rubee commands
 ```bash
 rubee start # start the server
@@ -696,6 +827,9 @@ 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
 
@@ -760,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.
@@ -776,6 +911,9 @@ 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.
@@ -822,6 +960,8 @@ When you trigger the controller action, the logs will look like this:
 [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
 
 If you are interested in contributing to ruBee,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ru.Bee
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Oleg Saltykov
@@ -43,7 +43,7 @@ files:
 - lib/Dockerfile
 - lib/app/controllers/welcome_controller.rb
 - lib/app/models/user.rb
-- lib/app/views/app.tsx
+- lib/app/views/App.tsx
 - lib/app/views/index.html
 - lib/app/views/layout.erb
 - lib/app/views/utils/redirectToBackend.tsx
@@ -61,6 +61,7 @@ files:
 - 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
@@ -233,6 +234,17 @@ files:
 - 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
@@ -246,6 +258,7 @@ files:
 - lib/rubee/models/sequel_object.rb
 - lib/rubee/router.rb
 - lib/tests/async/thread_async_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
@@ -261,6 +274,7 @@ files:
 - 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/test.db
 - lib/tests/test_helper.rb
@@ -276,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:
   - - ">="