RubyGems - ru.Bee - Versions diffs - 1.2.0 → 1.3.0 - Mend

ru.Bee 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

checksums.yaml +4 -4
data/lib/app/views/layout.erb +46 -0
data/lib/app/views/welcome_header.erb +1 -0
data/lib/app/views/welcome_show.erb +3 -43
data/lib/rubee/controllers/base_controller.rb +22 -4
data/lib/tests/test.db +0 -0
data/readme.md +172 -34
metadata +4 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 173d9793c002668ec637f531604481515d4a48b4482280248dfdb9c43e5d6684
-  data.tar.gz: d45bd460ef9db6c347f5b9bca7028fe403d2fb4d35b5ae8649efb2f1528f27f7
+  metadata.gz: a01285afa9a2c3b5f9a08cd5cbd58ddbd300181a1cc4c5b823710c873e84300a
+  data.tar.gz: 241e42bbccbfe0731d83b80d58f5d40f0969c003b067660e53ace470294f2896
 SHA512:
-  metadata.gz: d2bb73fb7408c9261c3fb8f56d4b629805a9a0d04313ca81a6f68f3e19a5faff9c3901010e27dbce8d717161854a36e355dbdb26e81f56cee0c45f9490d43bf6
-  data.tar.gz: 1e241e252e183a725c1152d5ed9b81ef2a7d8fa1593de66361cd7164eaaab5a22678ddd8bc57957cfa5fd4a494bb135925d8c08c4a7835e6028489b1d2b2694f
+  metadata.gz: 2dbdeed01d5187c61ebbc3bc5773ce9d6150f6952fe634e76d4c8f22718b3c14091f591b879e9ecf94954672d8f9719ce1994f490966cc2d79aa899baca8e994
+  data.tar.gz: 91eaf06432d1f35f1c1450ea0af9bac800194bfc448bd055e7455294170682965f9e25122e2a6e64d9587049dbe6b91c6b062c6a345381cd11c3f22bb98fd60d

data/lib/app/views/layout.erb ADDED Viewed

@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title><%= @title || '' %></title>
+    <style>
+        body {
+            display: flex;
+            justify-content: center;
+            align-items: center;
+            height: 100vh;
+            margin: 0;
+            background-color: #fdf6a5;
+            text-align: center;
+            font-family: Arial, sans-serif;
+        }
+        .container {
+            padding: 20px;
+            background: white;
+            border-radius: 10px;
+            box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);
+        }
+        img {
+            width: 50px;
+            height: auto;
+            margin-top: 10px;
+        }
+        h1 {
+            font-size: 1.8rem;
+            margin: 10px 0;
+        }
+        @media (max-width: 600px) {
+            h1 {
+                font-size: 1.5rem;
+            }
+            img {
+                width: 60px;
+            }
+        }
+    </style>
+</head>
+<body>
+    <%= _yield_template %>
+</body>
+</html>

data/lib/app/views/welcome_header.erb ADDED Viewed

	@@ -0,0 +1 @@
1	+ <h1>All set up and running!</h1>

data/lib/app/views/welcome_show.erb CHANGED Viewed

@@ -1,48 +1,9 @@
 <!DOCTYPE html>
 <html lang="en">
 <head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Setup Complete</title>
-    <style>
-        body {
-            display: flex;
-            justify-content: center;
-            align-items: center;
-            height: 100vh;
-            margin: 0;
-            background-color: #fdf6a5;
-            text-align: center;
-            font-family: Arial, sans-serif;
-        }
-        .container {
-            padding: 20px;
-            background: white;
-            border-radius: 10px;
-            box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);
-        }
-        img {
-            width: 50px;
-            height: auto;
-            margin-top: 10px;
-        }
-        h1 {
-            font-size: 1.8rem;
-            margin: 10px 0;
-        }
-        @media (max-width: 600px) {
-            h1 {
-                font-size: 1.5rem;
-            }
-            img {
-                width: 60px;
-            }
-        }
-    </style>
-</head>
-<body>
     <div class="container">
-        <h1>All set up and running!</h1>
+        <%= render_template :welcome_header %>
         <br/>
         <img src="images/rubee.svg" alt="ruBee">
         <br/>
@@ -50,5 +11,4 @@
         <br/>
         <p>Version: <%= Rubee::VERSION %></p>
     </div>
-</body>
-</html>

data/lib/rubee/controllers/base_controller.rb CHANGED Viewed

@@ -18,7 +18,7 @@ module Rubee
       end
     end
-    def response_with type: nil, object: nil, status: 200, mime_type: nil, render_view: nil, headers: {}, to: nil, file: nil, filename: nil
+    def response_with type: nil, object: nil, status: 200, mime_type: nil, render_view: nil, headers: {}, to: nil, file: nil, filename: nil, **options
       case type&.to_sym
       in :json
         rendered_json = object.is_a?(Array) ? object&.map(&:to_h).to_json : object.to_json
@@ -42,13 +42,31 @@ module Rubee
         return [302, headers.merge("location" => "#{to}"), ["Unauthentificated"]]
       else # rendering erb view is a default behavior
         view_file_name = self.class.name.split("Controller").first.downcase
-        erb_file = render_view ? "#{render_view}.erb" : "#{view_file_name}_#{@route[:action]}.erb"
+        erb_file = render_view ? "#{render_view}" : "#{view_file_name}_#{@route[:action]}"
         lib = Rubee::PROJECT_NAME == 'rubee' ? 'lib/' : ''
-        rendered_erb = ERB.new(File.open("#{lib}app/views/#{erb_file}").read).result(binding)
-        return [status, headers.merge("content-type" => "text/html"), [rendered_erb]]
+        view = render_template(erb_file, { object:, **(options[:locals] || {}) })
+        whole_erb = if File.exist?(layout_path = "#{lib}app/views/#{options[:layout] || 'layout'}.erb")
+          context = Object.new
+          context.define_singleton_method(:_yield_template) { view }
+          layout = File.read(layout_path)
+          ERB.new(layout).result(context.instance_eval { binding })
+        else
+          ERB.new(view).result(binding)
+        end
+        return [status, headers.merge("content-type" => "text/html"), [whole_erb]]
       end
     end
+    def render_template(file_name, locals = {})
+      lib = Rubee::PROJECT_NAME == 'rubee' ? 'lib/' : ''
+      path = "#{lib}app/views/#{file_name}.erb"
+      erb_template = ERB.new(File.read(path))
+      erb_template.result(binding)
+    end
     def params
       inputs = @request.env['rack.input'].read
       body = JSON.parse(@request.body.read.strip) rescue body = {}

data/lib/tests/test.db CHANGED Viewed

Binary file

data/readme.md CHANGED Viewed

@@ -6,11 +6,11 @@
 ![GitHub Repo stars](https://img.shields.io/github/stars/nucleom42/rubee?style=social)
-# <img src="lib/images/rubee.svg" alt="ru.Bee" height="40"> ... ru.Bee
+# <img src="lib/images/rubee.svg" alt="ruBee" height="40"> ... ruBee
-ru.Bee is a fast and lightweight Ruby application server designed for minimalism and flexibility .
+ruBee is a fast and lightweight Ruby application server designed for minimalism and flexibility .
-The main philosophy of ru.Bee is to focus on Ruby language explicit implementation of the MVC web application.
+The main philosophy of ruBee is to focus on Ruby language explicit implementation of the MVC web application.
 Want to get a quick API server up and runing? You can do it for real quick!
 <br />
@@ -27,7 +27,7 @@ All greaet features are yet to come!
 - **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
-- **Bundlable** Charge your ru.Bee with any gem you need and update your project with bundle.
+- **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.
@@ -36,7 +36,7 @@ All greaet features are yet to come!
 ## Installation
-1. Install ru.Bee
+1. Install ruBee
 ```bash
 gem install ru.Bee
 ```
@@ -50,7 +50,7 @@ cd my_project
 3. Install dependencies
 ***Prerequisites***<br />
-**ru.Bee** is using **Sqlite** as a default database. However you can pick up any other database supported by sequel gem.
+**ruBee** is using **Sqlite** as a default database. However you can pick up any other database supported by sequel gem.
 Aside that, make sure:
 **Ruby** language (3+) is installed
 **Bundler** is installed
@@ -59,7 +59,7 @@ Aside that, make sure:
 bundle install
 ```
-4. Run ru.Bee server. Default port is 7000
+4. Run ruBee server. Default port is 7000
 ```bash
 rubee start
 ```
@@ -97,7 +97,7 @@ rubee generate get /apples
 4. Fill those files with the logic you need and run the server again!
 ## Model
-Model in ru.Bee is just simple ruby object that can be serilalized in the view
+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
@@ -128,24 +128,6 @@ However, you can simply turn it to ORM object by extending database class.
     attr_accessor :id, :colour, :weight
   end
 ```
-Rubee::SequelObject methods:
-- `apple.save`
-- `apple.destroy(cascade: true)` # default false
-- `apple.destroy_all`
-- `apple.update(colour: 'red')`
-- `apple.persisted?`
-- `apple.reload`
-- `apple.assign_attributes(colour: 'red', weight: '1lb')`
-- `Apple.last`
-- `Apple.where(colour: 'red')`
-- `Apple.last`
-- `Apple.all`
-- `Apple.create(colour: 'red', weight: '1lb')`
-- `Apple.destroy_all`
-- `Apple.serialize`
-- `Apple.serialize(Apple.dataset.joins(:trees).where(tree: { colour: 'brown' }))`
-...
 So in the controller you would need to query your target object now.
@@ -163,12 +145,144 @@ So in the controller you would need to query your target object now.
   end
 ```
+#### Rubee::SequelObject base methods:
+Initiate new record in memory
+```Ruby
+irb(main):015> user = User.new(email: "llo@ok.com", password: 543)
+=> #<User:0x000000010cda23b8 @email="llo@ok.com", @password=543>
+```
+Save record in db
+```Ruby
+=> #<User:0x000000010cda23b8 @email="llo@ok.com", @password=543>
+irb(main):018> user.save
+=> true
+```
+Update record with new value
+```Ruby
+irb(main):019> user.update(email: "update@email.com")
+=> #<User:0x000000010c39b298 @email="update@email.com", @id=3, @password="543">
+```
+Check whether it includes id
+```Ruby
+irb(main):015> user = User.new(email: "llo@ok.com", password: 543)
+=> #<User:0x000000010cda23b8 @email="llo@ok.com", @password=543>
+irb(main):016> user.persisted?
+=> false
+```
+Get the record from the database
+```Ruby
+irb(main):011> user = User.last
+=> #<User:0x000000010ccea178 @email="ok23@ok.com", @id=2, @password="123">
+irb(main):012> user.email = "new@ok.com"
+=> "new@ok.com"
+irb(main):013> user
+=> #<User:0x000000010ccea178 @email="new@ok.com", @id=2, @password="123">
+irb(main):014> user.reload
+=> #<User:0x000000010c488548 @email="ok23@ok.com", @id=2, @password="123"> # not persited data was updated from db
+```
+Assign attributes without persisiting it to db
+```Ruby
+irb(main):008> User.last.assign_attributes(email: "bb@ok.com")
+=> {"id" => 2, "email" => "ok23@ok.com", "password" => "123"
+```
+Get all records scoped by field
+```Ruby
+irb(main):005> User.where(email: "ok23@ok.com")
+=> [#<User:0x000000010cfaa5c0 @email="ok23@ok.com", @id=2, @password="123">]
+```
+Get all record
+```Ruby
+irb(main):001> User.all
+=> [#<User:0x000000010c239a30 @email="ok@ok.com", @id=1, @password="password">]
+```
+Find by id
+```Ruby
+irb(main):002> user = User.find 1
+=> #<User:0x000000010c2f7cd8 @email="ok@ok.com", @id=1, @password="password">
+```
+Get last record
+```Ruby
+irb(main):003> User.last
+=> #<User:0x000000010c2f7cd8 @email="ok@ok.com", @id=1, @password="password">
+```
+Create new persited record
+```Ruby
+irb(main):004> User.create(email: "ok23@ok.com", password: 123)
+=> #<User:0x000000010c393818 @email="ok23@ok.com", @id=2, @password=123>
+```
+Destroy record and all related records
+```Ruby
+irb(main):021> user.destroy(cascade: true)
+=> 1
+```
+Destroy all records one by one
+```Ruby
+irb(main):022> User.destroy_all
+=> [#<User:0x000000010d42df98 @email="ok@ok.com", @id=1, @password="password">, #<User:0x000000010d42de80 @email="ok23@ok.com", @id=2, @password="123">
+irb(main):023> User.all
+=> []
+```
+Use complex queries chains and when ready serialize it back to Rubee object.
+```Ruby
+# user model
+class User < Rubee::SequelObject
+  attr_accessor :id, :email, :password
+  owns_many :comments, over: :posts
+end
+# comment model
+class Comment < Rubee::SequelObject
+  attr_accessor :id, :text, :user_id
+  owns_many :users, over: :posts
+end
+# join post model
+class Post < Rubee::SequelObject
+  attr_accessor :id, :user_id, :comment_id
+  holds :comment
+  holds :user
+end
+```
+```Ruby
+irb(main):001> comment = Comment.new(text: "test")
+irb(main):002> comment.save
+irb(main):003> user = User.new(email: "ok-test@test.com", password: "123")
+irb(main):004> user.save
+irb(main):005> post = Post.new(user_id: user.id, comment_id: comment.id)
+irb(main):006> post.save
+=> true
+irb(main):007> comment
+=> #<Comment:0x000000012281a650 @id=21, @text="test">
+irb(main):008> result = Comment.dataset.join(:posts, comment_id: :id)
+irb(main):009>  .where(comment_id: Comment.where(text: "test").last.id)
+irb(main):010>  .then { |dataset| Comment.serialize(dataset) }
+=> [#<Comment:0x0000000121889998 @id=30, @text="test", @user_id=702>]
+```
+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.
 ## Views
-View in ru.Bee is just a plain html/erb file that can be rendered from the controller.
+View in ruBee is just a plain html/erb file that can be rendered from the controller.
 ## Object hooks
-In ru.Bee by extending Hookable module any Ruby object can be charged with hooks (logic),
+In ruBee by extending Hookable module any Ruby object can be charged with hooks (logic),
 that can be executed before, after and around a specific method execution.
 Here below a controller example. However it can be used in any Ruby object, like Model etc.
@@ -286,7 +400,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 ru.Bee command within a specific ENV make sure you added it before a command.
+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
 ```bash
@@ -367,8 +481,32 @@ end
 TestAsyncRunnner.new.perform_async(options: {"email"=> "new@new.com", "password"=> "123"})
 ```
-## TODOs
-- [x] Token authorization API
-- [ ] Document authorization API
-- [ ] Add test coverage
-- [ ] Fix bugs
+### 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.
+Let's make it shine even brighter!

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ru.Bee
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Oleg Saltykov
 bindir: bin
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2025-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,8 @@ files:
 - lib/Dockerfile
 - lib/app/controllers/welcome_controller.rb
 - lib/app/models/user.rb
+- lib/app/views/layout.erb
+- lib/app/views/welcome_header.erb
 - lib/app/views/welcome_show.erb
 - lib/config.ru
 - lib/config/base_configuration.rb