ru.Bee 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f60bb8f17e35447c9cedd635d719a6b0d988486f9fe04668e0e07763a99cb740
-  data.tar.gz: a56dcac76060f5bb9ec71959ef4d21fa7c3e9b858eb6088e873e3ba50e4684f0
+  metadata.gz: 0bf3fb103ba0d1e81af5f77b6ec12395bf0d9701dac0f67fab585cd2c87ebb38
+  data.tar.gz: 3d8356ee2225e738b94ce1b9338597b1bd49ca103f3e55df3261c7cb2f45b71c
 SHA512:
-  metadata.gz: 03be1679bf032a1f292b4490a41286eb02f3a56984cf8dc7281715db53f880dc3ded8feb445ae41a22d60c2a4c3a5e47f8b8fe1be5f4c8188d26e57d403b746e
-  data.tar.gz: 0ffa4e0cc8c436d2ce7ac784c92465333d12ebaa67172f08bcfc55e59dd6f29472aa70211a3c2b766c234ef089b51d1c47a130cc6c0c8ab35e896f659b1ba43d
+  metadata.gz: 1160be8ac7aa5397c5fe0d33411f4111f47338fab92253eec0d8f566528e6819d1b3fa6dff579cd7b23b201fb671f2119f79fe459eaa131bd23b748a7a88d473
+  data.tar.gz: 0705de64ac2b5a78cb547d41d5386d323d80db13e2acac26d9e84137a1308699c074f60328efe75f01fdedcf99e7729557449d305506e11dc40d17a4a6d6b3db

data/lib/app/views/apples_.erb

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

data/lib/rubee.rb

@@ -34,7 +34,7 @@ module Rubee
       route = Router.route_for(request)
       # if react is the view so we would like to delegate not cauth by rubee routes to it.
       if Rubee::Configuration.react[:on] && !route
-        index = File.read File.join(Rubee::APP_ROOT, Rubee::LIB, 'app/views', 'index.html')
+        index = File.read(File.join(Rubee::APP_ROOT, Rubee::LIB, 'app/views', 'index.html'))
         return [200, { 'content-type' => 'text/html' }, [index]]
       end
       # if not found return 404
@@ -213,9 +213,9 @@ module Rubee
   end
 
   class Generator
-    def initialize(model_name, attributes, controller_name, action_name, **options)
+    def initialize(model_name, model_attributes, controller_name, action_name, **options)
       @model_name = model_name&.downcase
-      @attributes = attributes
+      @model_attributes = model_attributes || []
       @plural_name = controller_name.to_s.gsub('Controller', '').downcase.to_s
       @action_name = action_name
       @controller_name = controller_name
@@ -240,7 +240,7 @@ module Rubee
 
       content = <<~RUBY
         class #{@model_name.capitalize} < Rubee::SequelObject
-          attr_accessor #{@attributes.map { |hash| ":#{hash[:name]}" }.join(', ')}
+          #{'attr_accessor' + @model_attributes.map { |hash| ":#{hash[:name]}" }.join(', ') unless @model_attributes.empty?}
         end
       RUBY
 
@@ -271,17 +271,17 @@ module Rubee
       if @react[:view_name]
         view_file = File.join(Rubee::APP_ROOT, Rubee::LIB, "app/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 User() {
-
-          return (
-            <div>
-              <h2>#{@react[:view_name]} view</h2>
-            </div>
-          );
-        }
+          import React, { useEffect, useState } from "react";
+          // 1. Add your logic that fetches data
+          // 2. Do not forget to add respective react route
+          export function User() {
+
+            return (
+              <div>
+                <h2>#{@react[:view_name]} view</h2>
+              </div>
+            );
+          }
         JS
       else
         view_file = File.join(Rubee::APP_ROOT, Rubee::LIB, "app/views/#{@plural_name}_#{@action_name}.erb")
@@ -311,6 +311,11 @@ module Rubee
       content = <<~RUBY
         class Create#{@plural_name.capitalize}
           def call
+            return if Rubee::SequelObject::DB.tables.include?(:#{@plural_name})
+
+            Rubee::SequelObject::DB.create_table(:#{@plural_name}) do
+              #{@model_attributes.map { |attribute| generate_sequel_schema(attribute) }.join("\n\t\t\t")}
+            end
           end
         end
       RUBY
@@ -318,5 +323,40 @@ module Rubee
       File.open(db_file, 'w') { |file| file.write(content) }
       color_puts("DB file for #{@plural_name} created", color: :green)
     end
+
+    def generate_sequel_schema(attribute)
+      type = attribute[:type]
+      name = if attribute[:name].is_a?(Array)
+        attribute[:name].map { |nom| ":#{nom}" }.join(", ").prepend('[') + ']'
+      else
+        ":#{attribute[:name]}"
+      end
+      table = attribute[:table] || 'replace_with_table_name'
+      options = attribute[:options] || {}
+
+      lookup_hash = {
+        primary: "primary_key #{name}",
+        string: "String #{name}",
+        text: "String #{name}, text: true",
+        integer: "Integer #{name}",
+        date: "Date #{name}",
+        datetime: "DateTime #{name}",
+        time: "Time #{name}",
+        boolean: "TrueClass #{name}",
+        bigint: "Bignum #{name}",
+        decimal: "BigDecimal #{name}",
+        foreign_key: "foreign_key #{name}, :#{table}",
+        index: "index #{name}",
+        unique: "unique #",
+      }
+
+      statement = lookup_hash[type.to_sym]
+
+      options.keys.each do |key|
+        statement += ", #{key}: '#{options[key]}'"
+      end
+
+      statement
+    end
   end
 end

data/lib/tests/rubee_generator_test.rb

@@ -0,0 +1,190 @@
+require_relative 'test_helper'
+
+describe 'Rubee::Generator' do
+  describe 'generates Sequel schema lines' do
+    after do
+      File.delete('lib/app/models/apple.rb') if File.exist?('lib/app/models/apple.rb')
+      File.delete('lib/db/create_apples.rb') if File.exist?('lib/db/create_apples.rb')
+    end
+    it 'for string with just name' do
+      generator = Rubee::Generator.new(nil, nil, nil, nil)
+
+      attribute = { name: 'something', type: :string }
+
+      text = generator.send(:generate_sequel_schema, attribute)
+
+      _(text).must_equal('String :something')
+    end
+
+    it 'for string name and options' do
+      generator = Rubee::Generator.new(nil, nil, nil, nil)
+
+      attribute = { name: 'something', type: :string, options: { curse: 'squirrel' } }
+
+      text = generator.send(:generate_sequel_schema, attribute)
+
+      _(text).must_equal("String :something, curse: 'squirrel'")
+    end
+  end
+
+  describe 'generates Sequel file' do
+    after do
+      File.delete('lib/app/models/apple.rb') if File.exist?('lib/app/models/apple.rb')
+      File.delete('lib/db/create_apples.rb') if File.exist?('lib/db/create_apples.rb')
+    end
+
+    it 'not without a model' do
+      generator = Rubee::Generator.new(nil, nil, nil, nil)
+      generator.call
+
+      _(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
+
+      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
+    end
+
+    it 'with a model with attributes' do
+      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
+
+      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
+    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.call
+
+      _(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
+    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.call
+
+      _(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
+    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
+
+      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
+    end
+  end
+
+  describe 'generates Model file' do
+    after do
+      File.delete('lib/app/models/apple.rb') if File.exist?('lib/app/models/apple.rb')
+      File.delete('lib/db/create_apples.rb') if File.exist?('lib/db/create_apples.rb')
+    end
+
+    it 'not without a model' do
+      generator = Rubee::Generator.new(nil, nil, nil, nil)
+      generator.call
+
+      _(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
+
+      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
+    end
+
+    it 'with a model with attributes' do
+      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
+
+      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
+    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.call
+
+      _(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
+    end
+  end
+
+  describe 'generates View file' do
+
+  end
+
+  describe 'generates Controller file' do
+  end
+end

data/lib/tests/rubeeapp_test.rb

@@ -7,14 +7,6 @@ class RubeeAppTest < Minitest::Test
     Rubee::Application.instance
   end
 
-  def setup
-    Rubee::Configuration.setup(env = :test) { _1.react = { on: false, env: } }
-  end
-
-  def teardown
-    Rubee::Configuration.setup(env = :test) { _1.react = { on: false, env: } }
-  end
-
   def test_welcome_route
     get('/')
 
@@ -30,10 +22,13 @@ class RubeeAppTest < Minitest::Test
 
   def test_react_home
     Rubee::Configuration.setup(env = :test) { _1.react = { on: true, env: } }
+
     get('/home')
 
     assert_equal(200, last_response.status)
     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: } }
   end
 end

data/lib/tests/user_model_test.rb

@@ -153,9 +153,13 @@ describe 'User model' do
       User.destroy_all(cascade: true)
     end
 
+    before do
+      User.destroy_all(cascade: true)
+    end
+
     describe 'when there are records' do
       it 'returns all records' do
-        skip "This is Flaky test that blcoks dev, need to be fixed"
+        # skip "This is Flaky test that blcoks dev, need to be fixed"
         user = User.new(email: 'ok-test@test.com', password: '123')
         user2 = User.new(email: 'ok-test2@test.com', password: '123')
         user.save

data/readme.md

@@ -24,10 +24,9 @@ All greaet features are yet to come!
 - **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.
-- **Router**: Router driven - generates all required files from the routes.
 - **Databases**: Sqlite3, Postgres, Mysql and many more supported by sequel gem.
 - **Views**: Json, ERB and plain HTML and ..
-- **React** Supported out of the box as a rubee view
+- **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.
@@ -51,8 +50,7 @@ cd my_project
 3. Install dependencies
 
 ***Prerequisites***<br />
-**ruBee** is using **Sqlite** as a default database. However you can pick up any other database supported by sequel gem.
-Aside that, make sure:
+Make sure:
 **Ruby** language (3+) is installed
 **Bundler** is installed
 
@@ -67,35 +65,46 @@ rubee start
 
 5. Open your browser and go to http://localhost:7000
 
-## Create API contract and generate files from the routes
-1. Add the routes to the routes.rb
+## Run the tests
 ```bash
-Rubee::Router.draw do |router|
-  ...
-  # draw the contract
-  router.get "/apples", to: "apples#index",
-    model: {
-      name: "apple",
-      attributes: [
-        { name: 'id', type: :integer },
-        { name: 'colour', type: :string },
-        { name: 'weight', type: :integer }
-      ]
-    }
-end
+rubee test
 ```
-2. genrate the files
-```bash
-rubee generate get /apples
-```
-3. This will generate the following files
-```bash
-./app/controllers/apples_controller.rb # Controller with respective action
-./app/models/apple.rb # Model that acts as ORM
-./app/views/apples_index.erb # ERB view that is rendered by the controller right away
-./db/create_items.rb # Database migration file needed for creating repsective table
-```
-4. Fill those files with the logic you need and run the server again!
+
+## Create API contract and generate files from the routes
+1. Add the routes to the routes.rb
+    ```ruby
+    Rubee::Router.draw do |router|
+      ...
+      # draw the contract
+      router.get "/apples", to: "apples#index",
+        model: {
+          name: "apple",
+          attributes: [
+            { name: 'id', type: :primary },
+            { name: 'colour', type: :string },
+            { name: 'weight', type: :integer }
+          ]
+        }
+    end
+    ```
+2. generate the files
+    ```bash
+    rubee generate get /apples
+    ```
+- 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!
 
 ## Model
 Model in ruBee is just simple ruby object that can be serilalized in the view
@@ -107,8 +116,8 @@ Here below is a simple example on how it can be used by rendering json from in m
   #ApplesController
 
   def show
-    # in memory example
-apples = [Apple.new(colour: 'red', weight: '1lb'), Apple.new(colour: 'green', weight: '1lb')]
+    # In memory example
+    apples = [Apple.new(colour: 'red', weight: '1lb'), Apple.new(colour: 'green', weight: '1lb')]
     apple = apples.find { |apple| apple.colour = params[:colour] }
 
     response_with object: apple, type: :json
@@ -122,8 +131,8 @@ 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.
-
+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
   class Apple < Rubee::SequelObject
     attr_accessor :id, :colour, :weight
@@ -131,7 +140,6 @@ However, you can simply turn it to ORM object by extending database class.
 ```
 
 So in the controller you would need to query your target object now.
-
 ```ruby
   #ApplesController
 
@@ -276,10 +284,138 @@ 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.
 
+## 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`
+
+### Routing methods
+``` ruby
+Rubee::Router.draw do |router|
+  router.get '/posts', to: 'posts#index'
+  router.post '/posts', to: 'posts#create'
+  router.patch '/posts/{id}', to: 'posts#update'
+  router.put '/posts/{id}', to: 'posts#update'
+  router.delete '/posts/{id}', to: 'posts#delete'
+  router.head '/posts', to: 'posts#index'
+  router.connect '/posts', to: 'posts#index'
+  router.options '/posts', to: 'posts#index'
+  router.trace '/posts', to: 'posts#index'
+end
+```
+
+As you see above every route is set up as:\
+`route.http_method path, to: "controller#action", model { ...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.
+
+```ruby
+Rubee::Router.draw do |router|
+  ...
+  # draw the contract
+  router.get "/apples", to: "apples#index",
+    model: {
+      name: "apple",
+      attributes: [
+        { name: 'id', type: :primary },
+        { name: 'colour', type: :string },
+        { name: 'weight', type: :integer }
+      ]
+    }
+end
+```
+
+There are many other keys 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 }
+]
+```
+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 } }`
+
+Gets translated to:\
+`String :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.
+
+To generate based on a get route for the path /apples:\
+`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}`
+
 
+Example:
+```ruby
+Rubee::Router.draw do |router|
+  ...
+  # draw the contract
+  router.get "/apples", to: "apples#index"
+end
+```
+Will Generate:
+```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
+```
+
+Example 2:
+```ruby
+Rubee::Router.draw do |router|
+  ...
+  # draw the contract
+  router.get "/apples", to: "apples#index", model: { name: 'apple' }
+end
+```
+Will generate:
+```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
+```
+
+Example 3:
+```ruby
+Rubee::Router.draw do |router|
+  ...
+  # draw the contract
+  router.get "/apples", to: "apples#index", 
+    model: { 
+      name: 'apple', 
+      attributes: [
+        { name: 'id', type: :primary },
+        { name: 'colour', type: :string },
+        { name: 'weight', type: :integer }
+      ]
+    }
+end
+```
+
+Will generate:
+```bash
+./app/controllers/apples_controller.rb # Controller with respective action
+./app/models/apple.rb # Model that acts as ORM
+./app/views/apples_index.erb # ERB view that is rendered by the controller right away
+./db/create_items.rb # Database migration file needed for creating repsective table
+```
 
 ## Views
-View in ruBee is just a plain html/erb file that can be rendered from the controller.
+View in ruBee is just a plain html/erb/react file that can be rendered from the controller.
 
 ## Templates over erb
 
@@ -369,7 +505,7 @@ end
 # app/controllers/api/user_controller.rb
 class Api::UserController < Rubee::BaseController
   def index
-    response_with object: User.all
+    response_with object: User.all, type: :json
   end
 end
 ```
@@ -379,7 +515,7 @@ end
 // app/views/app.tsx
 <Router>
   <Routes>
-    <Route path="/users" element={<Home />} />
+    <Route path="/users" element={<Users />} />
     <Route path="*" element={<NotFound />} />
   </Routes>
 </Router>
@@ -508,6 +644,8 @@ end
 ```bash
 rubee start # start the server
 rubee start_dev # start the server in dev mode, which restart server on changes
+rubee react prepare # install react dependencies
+rubee react watch # dev mode for react, works together with start_dev
 rubee stop # stop the server
 rubee restart # restart the server
 ```
@@ -519,6 +657,7 @@ rubee generate get /apples # generate controller view, model and migration if se
 
 ## Migraiton commands
 ```bash
+rubee db run:all # run all migrations
 rubee db run:create_apples # where create_apples is the name of the migration file, located in /db folder
 rubee db structure # generate migration file for the database structure
 ```
@@ -526,6 +665,7 @@ rubee db structure # generate migration file for the database structure
 ## Rubee console
 ```bash
 rubee console # start the console
+# you can reload the console by typing reload, so it will pick up latest changes
 ```
 
 ## Testing
@@ -533,6 +673,7 @@ rubee console # start the console
 rubee test # run all tests
 rubee test auth_tokenable_test.rb # run specific tests
 ```
+
 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
 
@@ -616,30 +757,11 @@ TestAsyncRunnner.new.perform_async(options: {"email"=> "new@new.com", "password"
 
 ### Contributing
 
-You are more than welcome to contribute to ruBee! To do so, please follow these steps:
-
-1. Fork the repository by clicking the "Fork" button on the GitHub page.
-
-2. Clone your fork:
-```bash
-git clone https://github.com/your-username/rubee.git
-```
-
-3. Create a new branch for your feature or bug fix:
-```bash
-git checkout -b feature/your-feature-name
-```
-
-4. Make your changes and commit them with descriptive messages:
-```bash
-git commit -m "Add feature: [brief description of feature]"
-```
-
-5. Push your changes to your fork:
-```bash
-git push origin feature/your-feature-name
-```
-
-6. Submit a pull request to the main branch of the original repository.
+If you are interested in contributing to ruBee,
+please read the [Contributing](https://github.com/nucleom42/rubee/blob/main/CONTRIBUTING.md) guide.
+Also feel free to open an [issue](https://github.com/nucleom42/rubee/issues) if you apot one.
+Have an idea or you wnat to discuss something?
+Please open a [discussion](https://github.com/nucleom42/rubee/discussions)
 
-Let's make it shine even brighter!
+## License
+This project is released under the MIT License.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ru.Bee
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Oleg Saltykov
@@ -44,6 +44,7 @@ files:
 - lib/app/controllers/welcome_controller.rb
 - lib/app/models/user.rb
 - lib/app/views/app.tsx
+- lib/app/views/apples_.erb
 - lib/app/views/index.html
 - lib/app/views/layout.erb
 - lib/app/views/utils/redirectToBackend.tsx
@@ -243,6 +244,7 @@ files:
 - lib/tests/example_models/comment.rb
 - lib/tests/example_models/post.rb
 - lib/tests/example_models/user.rb
+- lib/tests/rubee_generator_test.rb
 - lib/tests/rubeeapp_test.rb
 - lib/tests/test.db
 - lib/tests/test_helper.rb