ru.Bee 2.3.2 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3098241bea70d0e5fadfb944de3d50f411d7799142a84858ed848082ea97b5b4
-  data.tar.gz: 24c80462cc23bc334324bbee12192dab6efb6517460ddb2b427b28cc5ed69df4
+  metadata.gz: 066655ef03cfa0f000d95d634a06a9f1d40259ec45ea21d86e0ee85f74bf17ed
+  data.tar.gz: 45d04a51041408d8bdd2e690618e92f288e73fda5cb4447515319cc6f498918b
 SHA512:
-  metadata.gz: 3dfab254bc794bdd28ee8c4d36ddfcb8b10e5e0efd050e89fca05cda000d0861a5381aa6730767e0fbcc5f35ff6a64bf5d86f8c502a2de27ce670d98152fa5fd
-  data.tar.gz: 35d0922f40a339fd3ca2733d0682d60cea9b9b62b17ab080a0eb768e085217eeba3694a5a68a309974a45c4ed86b404cea9d468253c4bc7fc7f5949c1e12216a
+  metadata.gz: 468195453447949e93d0ea7b18e5fea7384bbf80ecc07447df37b70731f698113a8e27d8015afcef1366cb6a463860ea67c4006519bc4315f5a0e72a73bbfc48
+  data.tar.gz: 33e8dac0437cec2fd495d5fe17af96daf786696a3061a392fff6b31e352bea3025f29c8a8e2db131a2c6e781727648403e998cec24a327a0b41b76c208108ded

data/lib/rubee/autoload.rb

@@ -7,6 +7,7 @@ module Rubee
         # autoload all rbs
         root_directory = File.join(Rubee::ROOT_PATH, '/lib')
         priority_order_require(root_directory, black_list)
+        load_support(root_directory, black_list)
         load_inits(root_directory, black_list)
         # ensure sequel object is connected
         Rubee::SequelObject.reconnect!
@@ -38,6 +39,12 @@ module Rubee
         end
       end
 
+      def load_support(root_directory, black_list)
+        Dir[File.join(Rubee::ROOT_PATH, '/lib', '/rubee/support/**', '*.rb')].each do |file|
+          require_relative file unless black_list.include?("#{file}.rb")
+        end
+      end
+
       def priority_order_require(root_directory, black_list)
         # rubee pub sub
         Dir[File.join(root_directory, 'rubee/pubsub/**', '*.rb')].each do |file|

data/lib/rubee/configuration.rb

@@ -32,6 +32,19 @@ module Rubee
         yield(self)
       end
 
+      def rubee_support=(value)
+        all     = value.fetch(:all, false)
+        classes = value.fetch(:classes, [])
+        if all
+          Rubee::RUBEE_SUPPORT.each do |support_string, klass|
+            support_klass = Object.const_get(support_string)
+            klass.include(support_klass)
+          end
+        else
+          classes.each { |klass| Rubee::RUBEE_SUPPORT[klass.to_s].include(klass) }
+        end
+      end
+
       def database_url=(args)
         args[:app] ||= :app
         @configuraiton[args[:app].to_sym][args[:env].to_sym][:database_url] = args[:url].gsub("//", "//#{Rubee::LIB}")

data/lib/rubee/models/sequel_object.rb

@@ -27,7 +27,7 @@ module Rubee
       if args[:id]
         begin
           update(args)
-        rescue StandardError => _e
+        rescue StandardError => e
           add_error(:base, sequel_error: e.message)
           return false
         end

data/lib/rubee/support/hash.rb

@@ -0,0 +1,62 @@
+module Rubee
+  module Support
+    module Hash
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.prepend(InstanceMethods)
+      end
+
+      module ClassMethods
+      end
+
+      module InstanceMethods
+        def [](key)
+          return wrap(super(key)) if key?(key)
+
+          alt_key =
+            case key
+            when ::Symbol then key.to_s
+            when ::String then key.to_sym
+            else key
+            end
+
+          wrap(super(alt_key))
+        end
+
+        private
+
+        def wrap(value)
+          value.is_a?(::Hash) ? value.extend(Rubee::Support::Hash::InstanceMethods) : value
+        end
+
+        def keys_to_string!
+          keys_to(:string, self)
+        end
+
+        def keys_to_sym!
+          keys_to(:symbol, self)
+        end
+
+        def keys_to(type, obj)
+          case obj
+          when ::Hash
+            obj.each_with_object({}) do |(k, v), result|
+              key =
+                case type
+                when :string then k.to_s
+                when :symbol then k.to_sym
+                else k
+                end
+
+              result[key] = keys_to(type, v)
+            end
+          when ::Array
+            obj.map { |v| keys_to(type, v) }
+          else
+            obj
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubee/support/string.rb

@@ -0,0 +1,59 @@
+module Rubee
+  module Support
+    module String
+      def self.included(base)
+        base.extend(ClassMethods)
+        base.include(InstanceMethods)
+      end
+
+      module ClassMethods
+      end
+
+      module InstanceMethods
+        def pluralize
+          if end_with?('y') && !%w[a e i o u].include?(self[-2])
+            "#{self[0..-2]}ies" # Replace "y" with "ies"
+          elsif end_with?('s', 'x', 'z', 'ch', 'sh')
+            "#{self}es" # Add "es" for certain endings
+          else
+            "#{self}s" # Default to adding "s"
+          end
+        end
+
+        def plural?
+          return true if end_with?('s') && !end_with?('ss')
+
+          false
+        end
+
+        def singular?
+          !plural?
+        end
+
+        def camelize
+          split('_').map { _1.capitalize }.join
+        end
+
+        def snakeize
+          gsub(/::/, '_')
+            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+            .tr('-', '_')
+            .downcase
+        end
+
+        def singularize
+          if end_with?('ies') && length > 3
+            "#{self[0..-4]}y" # Convert "ies" to "y"
+          elsif end_with?('es') && %w[s x z ch sh].any? { |ending| self[-(ending.length + 2)..-3] == ending }
+            self[0..-3] # Remove "es" for selfs like "foxes", "buses"
+          elsif end_with?('s') && length > 1
+            self[0..-2] # Remove "s" for regular plurals
+          else
+            self # Return as-is if no plural form is detected
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubee.rb

@@ -16,8 +16,11 @@ 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)
+  unless defined?(RUBEE_SUPPORT)
+    RUBEE_SUPPORT = { "Rubee::Support::Hash" => Hash, "Rubee::Support::String" => String }
+  end
 
-  VERSION = '2.3.2'
+  VERSION = '2.4.0'
 
   require_relative 'rubee/router'
   require_relative 'rubee/logger'

data/lib/tests/configuration_test.rb

@@ -0,0 +1,23 @@
+require_relative 'test_helper'
+
+describe 'Configuration' do
+  describe 'rubee_support Hash only' do
+    it 'patches Hash only' do
+       String.send(:undef_method, :plural?) if "".respond_to?(:plural?)
+      Rubee::Configuration.setup(env = :test) do
+        _1.rubee_support = { classes: [Rubee::Support::Hash] }
+      end
+      _({ one: 1 }['one']).must_equal(1)
+
+      _(raise_error { "apples".plural? }.is_a?(NoMethodError)).must_equal(true)
+    end
+  end
+
+  describe 'rubee_support all' do
+    it 'patches Hash and String' do
+      Rubee::Configuration.setup(env = :test) { _1.rubee_support = { all: true } }
+      _({ one: 1 }['one']).must_equal(1)
+      _("apples".plural?).must_equal(true)
+    end
+  end
+end

data/lib/tests/models/comment_model_test.rb

@@ -96,7 +96,7 @@ describe 'Comment model' do
         comment = Comment.new(user_id: 1)
 
         _(comment.valid?).must_equal(true)
-        _(comment.errors[:test]).must_equal(nil)
+        _(comment.errors[:test].nil?).must_equal(true)
       end
 
       it 'text is a number should be invalid' do

data/readme.md

@@ -84,6 +84,7 @@ The comparison is based on a very generic and subjective information open in the
 - [Generate commands](#generate-commands)
 - [Migration commands](#migration-commands)
 - [Rubee console](#rubee-console)
+- [Rubee::Support](#rubee-support)
 - [Testing](#testing)
 - [Background jobs](#background-jobs)
 - [Modular](#modualar-application)
@@ -979,7 +980,7 @@ Model example
 ```ruby
 class User < Rubee::SequelObject
   attr_accessor :id, :email, :password, :created
-  
+
   validate_after_setters # This will run validation after each setter.
   validate_before_persist! # This will validate and raise error in case invalid before saving to DB
   validate do
@@ -1019,7 +1020,7 @@ irb(main):081> user
 ```
 If you want to apply validation_before_persist! and validation_after_setters globally,
 add init/sequle_object_preloader.rb(you can chose any name)
-file withing set up those methods 
+file withing set up those methods
 for Rubee::SequelObject parent class by adding:
 ```
 Rubee::SequelObject.validate_befor_persist!
@@ -1028,6 +1029,44 @@ Rubee::SequelObject.validate_after_setters
 So you shouldn't add it to each model again and again.
 [Back to content](#content)
 
+## Rubee support
+
+In Rubee you have an optional way to charge your code with usefull methods that added to base Ruby classes.
+You can add them to your project globally by setting up it in configuration.
+
+```ruby
+# To include all support methods
+Rubee::Configuration.setup do |config|
+  config.rubee_support = { all: true }
+end
+
+# To include only those who belong to a indicated class
+Rubee::Configuration.setup do |config|
+  config.rubee_support = { classes: [Rubee::Support::String] }
+  # So only String will be charged with support methods
+end
+```
+Here are list of additionl APIs extended for:
+
+```ruby
+# By adding to configuration Rubee::Suport::Hash class or just applying all, Hash will tollerate string or symbol keys.
+{one: 1}[:one] # => 1
+{one: 1}["one"] # => 1
+
+# By adding to configuration Rubee::Support::String or just applying all, String will be enriched with handy helper methods.
+```ruby
+"test".pluralize # => "tests"
+"test".singularize # => "test"
+"test".camelize # => "Test"
+"TestMe".snakeize # => "test_mei"
+"test".singular? # => true
+"test".plural? # => false
+```
+
+[Back to content](#content)
+
+
+
 ## JWT based authentification
 
 Charge you rpoject with token based authentification system and customize it for your needs.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ru.Bee
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
 platform: ruby
 authors:
 - Oleg Saltykov
@@ -273,11 +273,14 @@ files:
 - lib/rubee/pubsub/subscriber.rb
 - lib/rubee/pubsub/test_one.rb
 - lib/rubee/router.rb
+- lib/rubee/support/hash.rb
+- lib/rubee/support/string.rb
 - lib/rubee/websocket/websocket.rb
 - lib/rubee/websocket/websocket_connections.rb
 - lib/tests/async/thread_async_test.rb
 - lib/tests/cli/attach_test.rb
 - lib/tests/cli/db_test.rb
+- lib/tests/configuration_test.rb
 - lib/tests/controllers/auth_tokenable_test.rb
 - lib/tests/controllers/base_controller_test.rb
 - lib/tests/controllers/hookable_test.rb