glib-web 3.11.0 → 3.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29bf404f48d26b824a2e10162a8ec01be7a13754027b4bd3e6b625c1255dbb80
-  data.tar.gz: 5ed5e65ac4e3cbd23180de8fd03f2a98746b4a5df787d8d69f5f25c9d0f66bbb
+  metadata.gz: df6b1ad5defcb6d77fa2cff5f8daef5615ca3ce0965efeb7263a8d42e9e9ebe6
+  data.tar.gz: 8bb3862f75b2d32c3284efc9de83afaa051c4e915a3ed5c1fe1b28b78e5fc0dd
 SHA512:
-  metadata.gz: 3c42ecfe127600686502e3721e37a05bf62ce0b194801f42c0c1d49c5df09d12f86cdd8435e682686de4d2c2cf7d288ca6c205cf3da48a452d1e2aadb1f685e1
-  data.tar.gz: '082866223cfe93db662d532a2030bc60428d82ae1d62c2b98c9910d2e37c3054ca5120d851cb021210eaca9cf60828483a3f91acc70061110d3581dcf17d015a'
+  metadata.gz: daa8778895e12cfb01ef928b27a61bc4b8cfbe20eb9c61a7e242a2ae63c8d8690cd45d348335832f79ff2cc3906b7f4c6c4bdfcc415f9db0ee297beb1ee29b6d
+  data.tar.gz: c002c3203aedaff266113d6dc1ba50320010df33d53f82489cbe21fc207eb2069dc1fa82ed8934dfeccb2bc7c6c611788fbc3dadaa21769ff59039a984df90b4

data/app/helpers/glib/enum_helper.rb

@@ -7,8 +7,9 @@ module Glib
         text = clazz.glib_enum_humanize(enum_field, i)
         if include_hints
           i18n_key = clazz.model_name.i18n_key
-          hint = I18n.t("dt_models.#{i18n_key}.#{enum_name.pluralize}.#{i}.hint")
-          text += " #{hint}"
+          if (hint = I18n.t("dt_models.#{i18n_key}.#{enum_name.pluralize}.#{i}.hint")).present?
+            text += " #{hint}"
+          end
         end
         { text: text, value: i }
       end

data/app/helpers/glib/json_ui/action_builder/components.rb

@@ -1,6 +1,11 @@
 class Glib::JsonUi::ActionBuilder
   module Components
 
+    class Find < Action
+      string :targetId
+      action :onFind
+    end
+
     class Update < Action
       string :targetId
       views :views

data/app/helpers/glib/json_ui/action_builder/popovers.rb

@@ -11,6 +11,7 @@ class Glib::JsonUi::ActionBuilder
 
     class Close < Action
       string :key
+      action :onClose
     end
   end
 end

data/app/helpers/glib/urls_helper.rb

@@ -23,7 +23,8 @@ module Glib
         host: host,
         port: port,
         path: path,
-        query: params.to_query
+        # Prevent trailing `?` when there is no params
+        query: params.empty? ? nil : params.to_query
       )
     end
   end

data/app/models/concerns/glib/enum_humanization.rb

@@ -19,11 +19,12 @@ module Glib
   module ClassMethods
     def glib_enum_humanize(enum_name, enum_value, default_translation = nil)
       if enum_value
+        translation_key = "activerecord.attributes.#{model_name.i18n_key}.#{enum_name.to_s.pluralize}.#{enum_value}"
+
         if default_translation.nil? && Rails.env.development?
-          i18n_key = "activerecord.attributes.#{model_name.i18n_key}.#{enum_name.to_s.pluralize}.#{enum_value}"
-          I18n.t(i18n_key, raise: I18n::MissingTranslationData)
+          I18n.t(translation_key, raise: I18n::MissingTranslationData)
         else
-          I18n.t(i18n_key, default: default_translation)
+          I18n.t(translation_key, default: default_translation)
         end
       end
     end

data/app/models/concerns/glib/soft_deletable.rb

@@ -42,7 +42,7 @@ module Glib
 
             hard_destroy
           when :disallowed
-            raise_hard_delete_disallowed
+            raise_hard_delete_disallowed(4502)
           else
             raise "Unsupported on_mark_for_destruction behaviour: #{behaviour}"
           end
@@ -50,7 +50,7 @@ module Glib
           return true # Tell Rails that destroy has succeeded
         end
 
-        raise_hard_delete_disallowed
+        raise_hard_delete_disallowed(4501)
       end
 
 
@@ -79,7 +79,9 @@ module Glib
       # records are updated/validated one at a time.
       # Besides, it's probably not a good idea to prevent soft-deletion of objects that are already not valid.
       def _soft_destroy
+        before_soft_destroy
         update_columns(deleted_at: DateTime.current)
+        after_soft_destroy
         soft_destroy_associated_records
       end
 
@@ -99,8 +101,8 @@ module Glib
           end
         end
 
-        def raise_hard_delete_disallowed
-          raise ActiveRecord::ConfigurationError, "Hard deletion is not allowed for #{self.class.name}"
+        def raise_hard_delete_disallowed(code)
+          raise ActiveRecord::ConfigurationError, "Hard deletion is not allowed for #{self.class.name} (error #{code})"
         end
 
         def process_soft_deletable_relationship(relationship, &block)
@@ -110,8 +112,10 @@ module Glib
           # to existing objects which could cause a side effect.
           relation = send(relationship)
 
-          if relation.respond_to?(:find_each)
-            relation.find_each do |record|
+          # Use `each` instead of `find_each` because `each` is cached which is important to retain the
+          # `marked_for_destruction` status.
+          if relation.respond_to?(:each)
+            relation.each do |record|
               block.call(record)
             end
           else
@@ -140,6 +144,14 @@ module Glib
         def soft_deletable_associations
           []
         end
+
+        def before_soft_destroy
+          # To be overridden
+        end
+
+        def after_soft_destroy
+          # To be overridden
+        end
     end
   end
 end

data/app/views/json_ui/garage/forms/basic_post.json.jbuilder

@@ -1,14 +1,31 @@
 name, _ = params.require(:user).values_at(:name)
+is_valid = name.present?
 json_ui_response json do |action|
-  if !name.present?
+  if !is_valid
     action.dialogs_alert message: 'Please enter name'
   else
     if params[:mode] == 'dialog'
-      action.dialogs_close onClose: ->(subaction) do
-        render "#{@path_prefix}/forms/alert_post_data", action: subaction
-      end
+      render "#{@path_prefix}/forms/alert_post_data", action: action
+
+      # action.dialogs_close onClose: ->(subaction) do
+      #   render "#{@path_prefix}/forms/alert_post_data", action: subaction
+      # end
     else
       render "#{@path_prefix}/forms/alert_post_data", action: action
     end
   end
 end
+
+if params[:mode] == 'dialog' && is_valid
+  json.title 'This is a response'
+
+  # This should update the content of the dialog.
+  page = json_ui_page json
+  page.scroll \
+    width: 'matchParent',
+    padding: glib_json_padding_body,
+    childViews: ->(scroll) do
+      scroll.label text: 'Success!'
+      scroll.spacer height: 20
+    end
+end

data/lib/glib/json_crawler/action_crawlers/forms_submit.rb

@@ -56,24 +56,31 @@ module Glib
           json = @http.patch url, action, params
           perform(json['onResponse'])
         when :post
-          if (params = form_post_params)
-            json = @http.post url, action, params
-            perform(json['onResponse'])
+          if (groups = form_post_param_groups)
+            groups.each do |group_params|
+              json = @http.post url, action, group_params
+              perform(json['onResponse'])
+            end
           else
             @http.router.log action, url
           end
         end
       end
 
-      def form_post_params
+      def form_post_param_groups
         route = Rails.application.routes.recognize_path(@http.router.page_url)
         action_path = "#{route[:controller]}##{route[:action]}"
 
-        post_data[action_path]
+        post_request_scenarios[action_path]
       end
 
+      # # Redeclare this class and implement this method.
+      # def post_data
+      #   {}
+      # end
+
       # Redeclare this class and implement this method.
-      def post_data
+      def post_request_scenarios
         {}
       end
     end

data/lib/glib/json_crawler/router.rb

@@ -91,9 +91,18 @@ module Glib
         end
       end
 
-      def follow(http, target_router)
+      def follow(http, target_routers)
+        if !target_routers.is_a?(Array)
+          target_routers = [target_routers]
+        end
+
+        target_actions = Set.new
+        target_routers.each do |router|
+          target_actions += router.read_only_actions
+        end
+
         @depth += 1
-        target_router.read_only_actions.each do |crawler_action|
+        target_actions.each do |crawler_action|
           action, url = crawler_action
           http.get(url, action, {}, false)
         end

data/lib/glib/test_helpers.rb

@@ -1,35 +1,125 @@
 module Glib
   module TestHelpers
+    extend ActiveSupport::Concern
+
+    included do
+      extend ClassMethods
+    end
+
+    module ClassMethods
+      def define_crawler_test(user, crawled_at, &on_after_crawl)
+        test "crawl api for #{user[:email]} #{user[:device]} #{user[:version] || 'current'}" do
+          Timecop.freeze(crawled_at || user[:crawled_at]) do
+            router = crawl_json_pages(user)
+            on_after_crawl&.call(router)
+          end
+
+          # Right now we're not benefitting from these due to Ruby's limited concurrency.
+          # Thread.new(user) { crawl_pages(user) }.join
+        end
+      end
+    end
+
+    HOST = 'www.lvh.me:3000'
+    # LOG_DIR = File.expand_path(
+    #   File.join(File.dirname(__FILE__), 'integration/json_ui_crawler_test_results')
+    # )
+
     def response_assert_equal
       expected = __get_previous_result_from_git
-      result = __log(response.body)
-      assert_equal JSON.parse(expected), JSON.parse(result), "Result mismatch! #{__git_is_available? ? `git diff #{__log_dir}/#{__log_file}` : ''}"
+      result = __log_controller_data(response.body)
+      assert_equal JSON.parse(expected), JSON.parse(result), "Result mismatch! #{__git_is_available? ? `git diff #{__controller_log_dir}/#{__controller_log_file}` : ''}"
+    end
+
+    def crawl_json_pages(user, check_result: true, log_file: nil, &block)
+      __execute_crawler(user, check_result: true) do |router, http|
+        path = user[:path] ? "#{user[:path]}?format=json" : '/users/me?format=json&redirect=default'
+        router.host = HOST
+        router.step(
+          http,
+          'onClick' => {
+            'action' => user[:action] || 'initiate_navigation',
+            'url' => user[:url] || "http://#{HOST}#{path}"
+          }
+        )
+      end
+    end
+
+    def retrace_json_pages(user, guiding_routers:)
+      __execute_crawler(user, check_result: true) do |router, http|
+        router.follow(http, guiding_routers)
+      end
+    end
+
+    def logout
+      delete logout_url
+      assert_response :success
+    end
+
+    def logout_url
+      "http://#{HOST}/users/sign_out.json"
     end
 
     private
+      def __execute_crawler(user, check_result: true, log_file: nil, &block)
+        auth_token = login user
+        user[:token] = auth_token
+
+        router = Glib::JsonCrawler::Router.new
+        http = Glib::JsonCrawler::Http.new(self, user, router)
+        block.call(router, http)
+
+        logout
+
+        if check_result
+          log_file = "#{user[:email]}[#{user[:device]}][#{user[:version] || 'current'}].txt" if log_file.nil?
+
+          file_path = File.join(__crawler_log_dir, log_file)
+          expected = File.exist?(file_path) ? File.read(file_path) : ''
+          result = router.logger
+          File.write(file_path, result)
+          assert_equal expected, result, "Result mismatch! #{log_file.sub(/\.txt$/, '')}"
+        end
+
+        router
+      end
+
       def __git_is_available?
         @__git_is_available ||= (`git status 2>&1` =~ /fatal/).nil?
       end
 
-      def __log_dir
-        if @__log_dir.nil?
-          @__log_dir = File.expand_path(
+      def __crawler_log_dir
+        if @__crawler_log_dir.nil?
+          @__crawler_log_dir = File.expand_path(
+            "#{Rails.root}/test/integration/#{self.class.to_s.underscore}_results",
+            File.dirname(__FILE__)
+          )
+          unless File.directory?(@__crawler_log_dir)
+            FileUtils.mkdir_p(@__crawler_log_dir)
+          end
+        end
+        @__crawler_log_dir
+      end
+
+      def __controller_log_dir
+        if @__controller_log_dir.nil?
+          @__controller_log_dir = File.expand_path(
             "#{Rails.root}/test/controllers/#{self.class.to_s.underscore}_results",
             File.dirname(__FILE__)
           )
-          unless File.directory?(@__log_dir)
-            FileUtils.mkdir_p(@__log_dir)
+          unless File.directory?(@__controller_log_dir)
+            FileUtils.mkdir_p(@__controller_log_dir)
           end
         end
-        @__log_dir
+        @__controller_log_dir
       end
 
-      def __log_file
-        @__log_file ||= "#{self.method_name}.json"
+      def __controller_log_file
+        @__controller_log_file ||= "#{self.method_name}.json"
       end
 
-      def __log(json)
-        file = File.open("#{File.join(__log_dir, __log_file)}", 'w') do |f|
+      def __log_controller_data(json)
+        file = File.open("#{File.join(__controller_log_dir, __controller_log_file)}", 'w') do |f|
           f << JSON.pretty_generate(JSON.parse(json))
         end
         file.close
@@ -38,12 +128,12 @@ module Glib
 
       def __get_previous_result_from_git
         if __git_is_available?
-          `git checkout -- "#{File.join(__log_dir, __log_file)}" > /dev/null 2>&1`
+          `git checkout -- "#{File.join(__controller_log_dir, __controller_log_file)}" > /dev/null 2>&1`
         end
         if File.exist?(
-          File.join(__log_dir, __log_file)
+          File.join(__controller_log_dir, __controller_log_file)
         )
-          File.read(File.join(__log_dir, __log_file))
+          File.read(File.join(__controller_log_dir, __controller_log_file))
         else
           "\{\}"
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glib-web
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.12.0
 platform: ruby
 authors:
 - ''