ru.Bee 1.6.0 → 1.7.0

data/lib/rubee/generator.rb

@@ -2,6 +2,7 @@ module Rubee
   class Generator
     require_relative '../inits/charged_string'
     using ChargedString
+
     def initialize(model_name, model_attributes, controller_name, action_name, **options)
       @model_name = model_name&.downcase
       @model_attributes = model_attributes || []
@@ -10,6 +11,8 @@ module Rubee
       @plural_name = @base_name.plural? ? @base_name : @base_name.pluralize
       @action_name = action_name
       @react = options[:react] || {}
+      @app_name = options[:app_name] || :app
+      @namespace = @app_name == :app ? '' : "#{@app_name.camelize}::"
     end
 
     def call
@@ -22,14 +25,14 @@ module Rubee
     private
 
     def generate_model
-      model_file = File.join(Rubee::APP_ROOT, Rubee::LIB, "app/models/#{@model_name}.rb")
+      model_file = File.join(Rubee::APP_ROOT, Rubee::LIB, "#{@app_name.to_s.snakeize}/models/#{@model_name}.rb")
       if File.exist?(model_file)
         puts "Model #{@model_name} already exists. Remove it if you want to regenerate"
         return
       end
 
       content = <<~RUBY
-        class #{@model_name.capitalize} < Rubee::SequelObject
+        class #{@namespace}#{@model_name.camelize} < Rubee::SequelObject
           #{'attr_accessor ' + @model_attributes.map { |hash| ":#{hash[:name]}" }.join(', ') unless @model_attributes.empty?}
         end
       RUBY
@@ -39,14 +42,14 @@ module Rubee
     end
 
     def generate_controller
-      controller_file = File.join(Rubee::APP_ROOT, Rubee::LIB, "app/controllers/#{@base_name}_controller.rb")
+      controller_file = File.join(Rubee::APP_ROOT, Rubee::LIB, "#{@app_name}/controllers/#{@base_name}_controller.rb")
       if File.exist?(controller_file)
         puts "Controller #{@base_name} already exists. Remove it if you want to regenerate"
         return
       end
 
       content = <<~RUBY
-        class #{@base_name.capitalize}Controller < Rubee::BaseController
+        class #{@namespace}#{@base_name.camelize}Controller < Rubee::BaseController
           def #{@action_name}
             response_with
           end
@@ -58,29 +61,33 @@ module Rubee
     end
 
     def generate_view
+      prefix = @namespace == "" ? "" : "#{@app_name.snakeize}_"
       if @react[:view_name]
-        view_file = File.join(Rubee::APP_ROOT, Rubee::LIB, "app/views/#{@react[:view_name]}")
+        view_file = File.join(Rubee::APP_ROOT, Rubee::LIB, "#{@app_name}/views/#{@react[:view_name]}")
         content = <<~JS
           import React, { useEffect, useState } from "react";
           // 1. Add your logic that fetches data
           // 2. Do not forget to add respective react route
-          export function #{@react[:view_name].gsub(/\.(.*)+$/, '').capitalize}() {
+          export function #{@react[:view_name].gsub(/\.(.*)+$/, '').camelize}() {
 
             return (
               <div>
-                <h2>#{@react[:view_name]} view</h2>
+                <h2>#{@react[:view_name].gsub(/\.(.*)+$/, '').camelize} view</h2>
               </div>
             );
           }
         JS
-      else
-        view_file = File.join(Rubee::APP_ROOT, Rubee::LIB, "app/views/#{@plural_name}_#{@action_name}.erb")
+      else # erb
+        view_file = File.join(
+          Rubee::APP_ROOT, Rubee::LIB,
+          "#{@app_name}/views/#{prefix}#{@plural_name}_#{@action_name}.erb"
+        )
         content = <<~ERB
-          <h1>#{@plural_name}_#{@action_name} View</h1>
+          <h1>#{prefix}#{@plural_name}_#{@action_name} View</h1>
         ERB
       end
 
-      name = @react[:view_name] || "#{@plural_name}_#{@action_name}"
+      name = @react[:view_name] || "#{prefix}#{@plural_name}_#{@action_name}"
 
       if File.exist?(view_file)
         puts "View #{name} already exists. Remove it if you want to regenerate"
@@ -92,18 +99,19 @@ module Rubee
     end
 
     def generate_db_file
-      db_file = File.join(Rubee::APP_ROOT, Rubee::LIB, "db/create_#{@plural_name}.rb")
+      table_name = @namespace == "" ? @plural_name : "#{@namespace.snakeize}_#{@plural_name}"
+      db_file = File.join(Rubee::APP_ROOT, Rubee::LIB, "db/create_#{table_name}.rb")
       if File.exist?(db_file)
-        puts "DB file for #{@plural_name} already exists. Remove it if you want to regenerate"
+        puts "DB file for #{table_name} already exists. Remove it if you want to regenerate"
         return
       end
 
       content = <<~RUBY
-        class Create#{@plural_name.capitalize}
+        class Create#{table_name.camelize}
           def call
-            return if Rubee::SequelObject::DB.tables.include?(:#{@plural_name})
+            return if Rubee::SequelObject::DB.tables.include?(:#{table_name})
 
-            Rubee::SequelObject::DB.create_table(:#{@plural_name}) do
+            Rubee::SequelObject::DB.create_table(:#{table_name}) do
               #{@model_attributes.map { |attribute| generate_sequel_schema(attribute) }.join("\n\t\t\t")}
             end
           end
@@ -111,7 +119,7 @@ module Rubee
       RUBY
 
       File.open(db_file, 'w') { |file| file.write(content) }
-      color_puts("DB file for #{@plural_name} created", color: :green)
+      color_puts("DB file for #{table_name} created", color: :green)
     end
 
     def generate_sequel_schema(attribute)
@@ -149,4 +157,4 @@ module Rubee
       statement
     end
   end
-end
+end

data/lib/rubee/models/database_objectable.rb

@@ -12,7 +12,7 @@ module Rubee
 
     module ClassMethods
       def pluralize_class_name
-        name.pluralize.downcase
+        name.pluralize.downcase.snakeize
       end
 
       def accessor_names

data/lib/rubee/models/sequel_object.rb

@@ -2,6 +2,7 @@ module Rubee
   class SequelObject
     include Rubee::DatabaseObjectable
     using ChargedString
+    using ChargedHash
 
     def destroy(cascade: false, **_options)
       if cascade
@@ -179,7 +180,7 @@ module Rubee
       def serialize(suquel_dataset, klass = nil)
         klass ||= self
         suquel_dataset.map do |record_hash|
-          target_klass_fields = DB[klass.name.pluralize.downcase.to_sym].columns
+          target_klass_fields = DB[klass.name.pluralize.downcase.camelize.to_sym].columns
           klass_attributes = record_hash.filter { target_klass_fields.include?(_1) }
           klass.new(**klass_attributes)
         end

data/lib/rubee/router.rb

@@ -2,7 +2,7 @@ module Rubee
   class Router
     include Singleton
 
-    HTTP_METHODS = %i[get post put patch delete head connect options trace].freeze
+    HTTP_METHODS = %i[get post put patch delete head connect options trace].freeze unless defined?(HTTP_METHODS)
 
     attr_reader :request, :routes
 
@@ -14,7 +14,6 @@ module Rubee
       end
 
       def route_for(request)
-        puts request.request_method
         method = (request.params['_method'] || request.request_method).downcase.to_sym
         @routes.find do |route|
           return route if request.path == route[:path] && request.request_method&.downcase&.to_sym == route[:method]
@@ -38,4 +37,4 @@ module Rubee
       end
     end
   end
-end
+end

data/lib/rubee.rb

@@ -15,7 +15,8 @@ module Rubee
   IMAGE_DIR = File.join(APP_ROOT, LIB, 'images') unless defined?(IMAGE_DIR)
   JS_DIR = File.join(APP_ROOT, LIB, 'js') unless defined?(JS_DIR)
   CSS_DIR = File.join(APP_ROOT, LIB, 'css') unless defined?(CSS_DIR)
-  VERSION = '1.6.0'
+  ROOT_PATH = File.expand_path(File.join(__dir__, '..')) unless defined?(ROOT_PATH)
+  VERSION = '1.7.0'
 
   require_relative 'rubee/router'
   require_relative 'rubee/logger'
@@ -25,13 +26,15 @@ module Rubee
 
   class Application
     include Singleton
+    using(ChargedString)
 
     def call(env)
       # autoload rb files
       Autoload.call
+
       # register images paths
       request = Rack::Request.new(env)
-      # Add default path for images
+      # Add default path for assets
       Router.draw do |route|
         route.get('/images/{path}', to: 'base#image', namespace: 'Rubee')
         route.get('/js/{path}', to: 'base#js', namespace: 'Rubee')
@@ -48,9 +51,9 @@ module Rubee
       return [404, { 'content-type' => 'text/plain' }, ['Route not found']] unless route
       # init controller class
       controller_class = if route[:namespace]
-        "#{route[:namespace]}::#{route[:controller].capitalize}Controller"
+        "#{route[:namespace].to_s.camelize}::#{route[:controller].camelize}Controller"
       else
-        "#{route[:controller].capitalize}Controller"
+        "#{route[:controller].camelize}Controller"
       end
       # instantiate controller
       controller = Object.const_get(controller_class).new(request, route)

data/lib/tests/cli/attach_test.rb

@@ -0,0 +1,36 @@
+require_relative '../test_helper'
+
+describe 'Rubee::CLI::Attach' do
+  describe 'when run attach command over cli' do
+    it 'calls Rubee::CLI::Attach.call' do
+      called = false
+
+      Rubee::CLI::Attach.stub(:call, ->(*_args) { called = true }) do
+        Rubee::CLI::Command.new(['attach', 'carrot']).call
+      end
+
+      assert called, "Expected Rubee::CLI::Attach.run to be called"
+    end
+  end
+
+  describe 'when attach executed' do
+    it 'creates new folder carrot' do
+      Rubee::CLI::Command.new(['attach', 'carrot']).call unless Dir.exist?('carrot')
+      assert Dir.exist?('carrot'), "Expected 'carrot' folder to be created"
+      FileUtils.rm_rf('carrot')
+    end
+
+    it 'creates inside of the project folder expected content' do
+      Rubee::CLI::Command.new(['attach', 'carrot']).call unless Dir.exist?('carrot')
+      %w[controllers models views].each do |dir|
+        assert Dir.exist?("carrot/#{dir}"), "Expected 'carrot/#{dir}' folder to be created"
+      end
+
+      %w[carrot_configuration carrot_routes carrot_namespace].each do |file|
+        assert File.exist?("carrot/#{file}.rb"), "Expected 'carrot/#{file}.rb' file to be created"
+      end
+
+      FileUtils.rm_rf('carrot')
+    end
+  end
+end

data/lib/tests/controllers/rubeeapp_test.rb

@@ -27,7 +27,7 @@ class RubeeAppTest < Minitest::Test
     get('/home')
 
     assert_equal(200, last_response.status)
-    assert_includes(last_response.body, '<div id="app">')
+    assert_includes(last_response.body, '<div id="App">')
     assert_includes(last_response.body, 'bundle.js')
 
     Rubee::Configuration.setup(env = :test) { _1.react = { on: false, env: } }

data/lib/tests/test_helper.rb

@@ -38,3 +38,4 @@ def capture_stdout
 ensure
   $stdout = old_stdout
 end
+

data/readme.md

@@ -16,31 +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)
+- [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)
+- [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)
+- [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.
@@ -49,8 +53,8 @@ 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
@@ -67,6 +71,8 @@ gem install ru.Bee
 rubee project my_project
 cd my_project
 ```
+- [Back to content](#Content)
+
 
 3. Install dependencies
 
@@ -90,6 +96,7 @@ rubee start
 ```bash
 rubee test
 ```
+- [Back to content](#Content)
 
 ## Draw contract
 1. Add the routes to the routes.rb
@@ -126,6 +133,7 @@ This will generate the following files
     ```
 
 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
@@ -174,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:
 
@@ -304,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`
@@ -436,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.
 
@@ -570,6 +654,7 @@ function Users() {
 }
 
 ```
+- [Back to content](#Content)
 
 ## Object hooks
 
@@ -612,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.
@@ -661,6 +748,7 @@ class UsersController < Rubee::BaseController
   end
 end
 ```
+- [Back to content](#Content)
 
 ## Rubee commands
 ```bash
@@ -695,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
@@ -776,6 +866,8 @@ 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.
@@ -821,6 +913,7 @@ 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)
 
 ### Contributing
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ru.Bee
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.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