glib-web 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 722e3662e1925d71fe99c6eec5897c0e59bf0f53
-  data.tar.gz: 6cb98608b96b0fc9a9a88c8ba44b7e15855f0465
+SHA256:
+  metadata.gz: b310f37fb4b17ad903b9747af586ced2918eb3bd2415dafc68ebf7133415ca40
+  data.tar.gz: 6fca728dab6fffa7ced37f979f5d0537d42bbee83410ce7db54a26d10441f482
 SHA512:
-  metadata.gz: 233399bbc9018a97adb6fa9316b566698e19e24607f0433fc684b58648af295778aaf5676f3af51edc9a4813410e6e82d1d6443a6d512d13e668cdf9a1c44f13
-  data.tar.gz: 437210e7dfb02b783d8593809c59e155b91f552be6785ef46d05b7cf6f73138e783ffffa0fc814c7dce31099159e0b6644e49ea3570854cf8102fbace060b532
+  metadata.gz: 6f1b8b84319689a92c56827bd4791be5da1fe048f627b88a3e60c1d5d8a47adac19ac2e7b6d6ea0985ed8c0bdff4426893c88780aa548eecac29d907138d757b
+  data.tar.gz: 02a7d64bd89e2a49073b6d9d66e7b145c36f750d05f143ed5c6b476dcedba5af1e55d6c60115e26a06dea7ac50d7bd14d10f1976cd746b4d14e5365780705664

data/app/controllers/concerns/glib/json/dynamic_text.rb

@@ -38,8 +38,8 @@ module Glib::Json::DynamicText
     JSON.parse(response)
   end
 
-  def crawl views
-    Glib::Json::DynamicText::crawl_multiple views, ->(view) do
+  def crawl(views)
+    Glib::Json::Crawler.new.crawl_multiple views, ->(view) do
       extract_spec(view, 'text')
     end
   end
@@ -58,31 +58,35 @@ module Glib::Json::DynamicText
       view[prop] = text.gsub(/\{\{(\w+)\}\}/) { args.fetch($1, "{{#{$1}}}") }
     end
   end
+end
+
+class Glib::Json::Crawler
+  attr_reader :forms
+
+  def initialize
+    @forms = []
+  end
 
-  def self.crawl_multiple views, block
+  def crawl_multiple(views, block)
     if views.is_a? Array
       views.each do |view|
-        crawl_single view, block
+        case view['view']
+        when 'panels/form-v1'
+          @forms << view
+          crawl_single view, block
+          @forms.pop
+        else
+          crawl_single view, block
+        end
       end
-
-      # views.each do |view|
-      #   case view['view']
-      #   when 'panels/form-v1'
-      #     @@forms << view
-      #     crawl_single view, block
-      #     @@forms.pop
-      #   else
-      #     crawl_single view, block
-      #   end
-      # end
     end
   end
 
-  def self.crawl_vertical_content view, block
+  def crawl_vertical_content(view, block)
     crawl_multiple view['childViews'], block if view
   end
 
-  def self.crawl_single view, block
+  def crawl_single(view, block)
     block.call view
 
     # Generic view children
@@ -106,5 +110,4 @@ module Glib::Json::DynamicText
       end
     end
   end
-
 end

data/app/controllers/concerns/glib/json/libs.rb

@@ -27,7 +27,7 @@ module Glib::Json::Libs
   def json_ui_app_is_android?
     json_ui_app_device_os == 'android'
   end
-  
+
   def json_ui_app_is_ios?
     json_ui_app_device_os == 'ios'
   end
@@ -44,7 +44,9 @@ module Glib::Json::Libs
       include Glib::Json::Transformation
       include Glib::Json::Validation
       include Glib::Json::Ui
-      include Glib::Json::DynamicText
+
+      include Glib::Json::Traversal
+      include Glib::Json::NewDynamicText
 
       before_action :__json_ui_start
 
@@ -53,10 +55,12 @@ module Glib::Json::Libs
         __json_ui_commit(options)
       end
       after_action :__json_transformation_commit
-      after_action :__json_dynamic_text_perform
       after_action :__json_validate_perform
+
+      after_action :__json_traversal_perform
+      after_action :__json_traversal_register_dynamic_text
     end
-    
+
     def json_libs_set_locale
       before_action do
         # Need to explicitly fallback to EN
@@ -65,7 +69,7 @@ module Glib::Json::Libs
         I18n.locale = :en
       end
     end
-    
+
     def json_libs_force_json_ui
       before_action do
         if params[:_render] != 'v1'
@@ -74,17 +78,17 @@ module Glib::Json::Libs
       end
     end
 
-    def json_libs_rescue_csrf      
+    def json_libs_rescue_csrf
       rescue_from ActionController::InvalidAuthenticityToken do |exception|
         sign_out(:user)
 
         respond_to do |format|
           format.json do
-            render json: { 
-              onResponse: { 
+            render json: {
+              onResponse: {
                 action: 'windows/open-v1',
                 url: root_url
-              } 
+              }
             }
           end
         end

data/app/controllers/concerns/glib/json/new_dynamic_text.rb

@@ -0,0 +1,120 @@
+module Glib::Json::NewDynamicText
+  def __json_traversal_register_dynamic_text
+    @__specs = {}
+    @__specs_db = {}
+
+    __json_traversal_on_traverse do |view|
+      extract_spec(view, 'text')
+    end
+
+    __json_traversal_on_complete do |view|
+      if @__specs.keys.size > 0
+        # translated_texts = retrieve_remote_texts(@__specs.keys)
+        translated_texts = retrieve_local_texts(@__specs.keys).merge(retrieve_remote_texts(@__specs.keys))
+        translated_texts.each do |key, value|
+          @__specs[key].each do |spec|
+            spec.substitute_with(value)
+          end
+
+          if @__specs_db[key] && @__specs_db[key].images.attached?
+            @__specs[key].each do |spec|
+              spec.substitute_image_with(@__specs_db[key].images)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def retrieve_example_texts(keys)
+    examples_translations = {
+      'home.json_ui_garage.hello' => 'Hello {{name}}',
+      'home.json_ui_garage.greeting' => 'Good day!',
+    }
+
+    translated_texts = {}
+    keys.each do |key|
+      translated_texts[key] = examples_translations[key]
+    end
+    translated_texts
+  end
+
+  def retrieve_remote_texts(keys)
+    response = RestClient.get(ENV['DTR_URL'], { params: { keys: keys } })
+    JSON.parse(response)
+  end
+
+  def retrieve_local_texts(keys)
+    translated_texts = {}
+    db_keys = []
+
+    contents = $dt_redis.pipelined do
+      keys.each do |key|
+        args = @__specs[key].first.args
+        options = {
+          scope: args.fetch(:scope, 'itinerarybuilder'),
+          lang: args.fetch(:lang, 'en')
+        }
+
+        scope_key = "#{options[:scope]}.#{options[:lang]}.#{key}"
+        $dt_redis.get(scope_key)
+      end
+    end
+
+    keys.each_with_index do |key, index|
+      if content = contents[index]
+        translated_texts[key] = content
+        db_keys << key if content.match(/\{\{image(\d)\}\}/)
+      else
+        db_keys << key
+      end
+    end
+
+    if db_keys.size > 0
+      texts = Glib::Text.where(key: db_keys)
+      texts.each do |text|
+        translated_texts[text.key] = text.content
+        @__specs_db[text.key] = text
+      end
+    end
+
+    translated_texts
+  end
+
+  def extract_spec(view, prop)
+    if (spec = view[prop])
+      if spec.is_a?(Hash) && (key = spec['dt_key'])
+        @__specs[key] ||= []
+        @__specs[key] << TextSpec.new(view, prop, spec)
+      end
+    end
+  end
+
+  TextSpec = Struct.new(:view, :prop, :args) do
+    def substitute_with(text)
+      view[prop] = text.gsub(/\{\{(\w+)\}\}/) { args.fetch($1, "{{#{$1}}}") }
+    end
+
+    def substitute_image_with(images)
+      view[prop] = view[prop].gsub(/\{\{image(\d)\}\}/) {
+        if image = images[$1.to_i - 1]
+          image_server_url(image.blob.key)
+        else
+          "{{image#{$1}}}"
+        end
+      }
+    end
+
+    def image_server_url(blob_key, w: 100, h: 100)
+      return unless blob_key.present?
+
+      uri = URI::HTTPS.build(
+        host: 'imageserver-demo.herokuapp.com',
+        path: "/image/#{ENV['AWS_S3_BUCKET']}/#{blob_key}",
+        query: { w: w, h: h }.to_param
+      )
+
+      uri.to_s
+    end
+  end
+end

data/app/controllers/concerns/glib/json/traversal.rb

@@ -0,0 +1,86 @@
+module Glib::Json::Traversal
+  def __json_traversal_on_traverse(&block)
+    @__json_traversal_on_traverses ||= []
+    @__json_traversal_on_traverses << block
+  end
+
+  def __json_traversal_on_complete(&block)
+    @__json_traversal_on_completes ||= []
+    @__json_traversal_on_completes << block
+  end
+
+  def __json_traversal_perform
+    if (hash = json_transformation_start).is_a?(Hash)
+      traverse hash['header']&.[]('childViews')
+      traverse hash['body']&.[]('childViews')
+      traverse hash['footer']&.[]('childViews')
+
+      @__json_traversal_on_completes.each do |block|
+        block.call
+      end
+    end
+  end
+
+  def traverse(views)
+    Visitor.new.traverse_multiple views, ->(view) do
+      @__json_traversal_on_traverses.each do |block|
+        block.call(view)
+      end
+    end
+  end
+
+
+
+  class Visitor
+    # Used in test crawler
+    attr_reader :forms
+
+    def initialize
+      @forms = []
+    end
+
+    def traverse_multiple(views, block)
+      if views.is_a? Array
+        views.each do |view|
+          case view['view']
+          when 'panels/form-v1'
+            @forms << view
+            traverse_single view, block
+            @forms.pop
+          else
+            traverse_single view, block
+          end
+        end
+      end
+    end
+
+    def traverse_vertical_content(view, block)
+      traverse_multiple view['childViews'], block if view
+    end
+
+    def traverse_single(view, block)
+      block.call view
+
+      # Generic view children
+      traverse_multiple view['childViews'], block
+
+      # panels/split
+      # crawl_multiple view['leftViews'], block
+      # crawl_multiple view['rightViews'], block
+
+      # Split panel
+      traverse_vertical_content view['left'], block
+      traverse_vertical_content view['center'], block
+      traverse_vertical_content view['right'], block
+
+      # TODO: crawl header and footer
+      # Table/List
+      if (sections = view['sections']).is_a? Array
+        sections.each do |section|
+          # Table
+          traverse_multiple section['rows'], block
+        end
+      end
+    end
+  end
+end

data/app/helpers/glib/dynamic_texts_helper.rb

@@ -12,10 +12,10 @@ module Glib
       end
 
       content, text_object = Glib::Text.get_content(new_key, default_value, options: options)
-      content.gsub(/\{\{(\w+)\}\}/) { args.fetch($1.to_sym, "{{#{$1}}}") }
+      content = content.gsub(/\{\{(\w+)\}\}/) { args.fetch($1.to_sym, "{{#{$1}}}") }
 
       if text_object.images.attached?
-        content.gsub(/\{\{image(\d)\}\}/) {
+        content = content.gsub(/\{\{image(\d)\}\}/) {
           if image = text_object.images[$1.to_i - 1]
             image_server_url(image.blob.key)
           else
@@ -23,6 +23,8 @@ module Glib
           end
         }
       end
+
+      content
     end
 
     def dt_json(key, default_value = '', **args)

data/app/policies/glib/application_policy.rb

@@ -1,148 +1,148 @@
-# The main purpose of this is for security. If it is important to display useful error message or to provide a "banana", then
-# it's better to perform an explicit check (e.g. as a validation in the model or using a before_action).
-module Glib
-  class ApplicationPolicy
-    attr_reader :user, :record, :controller, :request, :params
-
-    private
-    def initialize(user, record, controller, request, params)
-      @user = user
-      @record = record
-      @controller = controller
-      @request = request
-      # Don't get params from request because we might not have a proper request object. This might execute in Sidekiq. 
-      # See Presenter::Model::inside_mock_controller()
-      @params = params
-    end
-    
-    class << self
-      attr_reader :catch_all
-
-      # This is to define the authorization logic for an action (or a group of actions). It's different from controller's 
-      # authorize().
-      private  # Used by child
-      def authorize(*actions, &block)
-        actions.each do |action|
-          if action == :manage
-            # Serve as a catch-all to all actions that have not been specified in the policy.
-            @catch_all = block
-          else
-            method_name = "#{action}?"
-            # Avoid accidentally redefining multiple times from child policies. But it's okay if the child policy
-            # wants to override the parent's authorization method.
-            raise "Action authorization has been declared: #{action}" if instance_methods(false).include?(method_name.to_sym)
-            define_method method_name, &block
-          end
-        end
-      end
-    end
-    
-    private
-    def catch_all
-      self.class.catch_all
-    end
-    
-    private
-    # To ensure the block is called on the policy's instance instead class.
-    def call_catch_all
-      instance_eval(&catch_all)
-    end
-
-    authorize :index do
-      # We need this line because in `index` action, this method will be called instead of method_missing().
-      # Having this line ensures that the catch_all behaviour works according to the priority below:
-      # - child_policy#index?
-      # - child_policy#manage? -- catch_all
-      # - application_policy@index?
-      return call_catch_all if catch_all
-
-      false
-    end
-
-    authorize :show do
-      return call_catch_all if catch_all
-
-      scope.where(id: record.id).exists?
-    end
-
-    authorize :create do
-      return call_catch_all if catch_all
-      
-      false
-    end
-
-    authorize :new do
-      return call_catch_all if catch_all
-      
-      create?
-    end
-
-    authorize :update do
-      return call_catch_all if catch_all
-      
-      false
-    end
-
-    authorize :edit do
-      return call_catch_all if catch_all
-      
-      update?
-    end
-
-    authorize :destroy do
-      return call_catch_all if catch_all
-      
-      false
-    end
-
-    public
-    def method_missing(name, *args, &block)
-      if name.to_s.end_with?('?') && catch_all
-        call_catch_all
-      else
-        super
-      end
-    end
-
-    public
-    def scope
-      Pundit.policy_scope!(user, record.class)
-    end
-
-    private  # Used by child
-    def public?
-      true
-    end
-
-    # # TODO: Revise because it seems there is no justification for allowing owner to see any of the deleted entities, which include User, Guild, and Post
-    # private  # Used by child
-    # def not_deleted_unless_owner_or_moderator?(&block)
-    #   block ||= lambda { |unused_arg| @user.moderator? }
-    #   !@record.deleted? || (@user && (@user.id == @record.user_owner_id || block.call(@record)))
-    # end
-
-    # private  # Used by child
-    # def not_deleted_unless_moderator?(&block)
-    #   block ||= lambda { |unused_arg| @user.moderator? }
-    #   !@record.deleted? || (@user && block.call(@record))
-    # end
-
-    public
-    def self.args_builder
-      Proc.new { |controller| [] }
-    end
-    
-    class Scope
-      attr_reader :user, :scope
-
-      def initialize(user, scope)
-        @user = user
-        @scope = scope
-      end
-
-      def resolve
-        scope
-      end
-    end
-  end
-end
+# The main purpose of this is for security. If it is important to display useful error message or to provide a "banana", then
+# it's better to perform an explicit check (e.g. as a validation in the model or using a before_action).
+module Glib
+  class ApplicationPolicy
+    attr_reader :user, :record, :controller, :request, :params
+
+    private
+    def initialize(user, record, controller, request, params)
+      @user = user
+      @record = record
+      @controller = controller
+      @request = request
+      # Don't get params from request because we might not have a proper request object. This might execute in Sidekiq. 
+      # See Presenter::Model::inside_mock_controller()
+      @params = params
+    end
+    
+    class << self
+      attr_reader :catch_all
+
+      # This is to define the authorization logic for an action (or a group of actions). It's different from controller's 
+      # authorize().
+      private  # Used by child
+      def authorize(*actions, &block)
+        actions.each do |action|
+          if action == :manage
+            # Serve as a catch-all to all actions that have not been specified in the policy.
+            @catch_all = block
+          else
+            method_name = "#{action}?"
+            # Avoid accidentally redefining multiple times from child policies. But it's okay if the child policy
+            # wants to override the parent's authorization method.
+            raise "Action authorization has been declared: #{action}" if instance_methods(false).include?(method_name.to_sym)
+            define_method method_name, &block
+          end
+        end
+      end
+    end
+    
+    private
+    def catch_all
+      self.class.catch_all
+    end
+    
+    private
+    # To ensure the block is called on the policy's instance instead class.
+    def call_catch_all
+      instance_eval(&catch_all)
+    end
+
+    authorize :index do
+      # We need this line because in `index` action, this method will be called instead of method_missing().
+      # Having this line ensures that the catch_all behaviour works according to the priority below:
+      # - child_policy#index?
+      # - child_policy#manage? -- catch_all
+      # - application_policy@index?
+      return call_catch_all if catch_all
+
+      false
+    end
+
+    authorize :show do
+      return call_catch_all if catch_all
+
+      scope.where(id: record.id).exists?
+    end
+
+    authorize :create do
+      return call_catch_all if catch_all
+      
+      false
+    end
+
+    authorize :new do
+      return call_catch_all if catch_all
+      
+      create?
+    end
+
+    authorize :update do
+      return call_catch_all if catch_all
+      
+      false
+    end
+
+    authorize :edit do
+      return call_catch_all if catch_all
+      
+      update?
+    end
+
+    authorize :destroy do
+      return call_catch_all if catch_all
+      
+      false
+    end
+
+    public
+    def method_missing(name, *args, &block)
+      if name.to_s.end_with?('?') && catch_all
+        call_catch_all
+      else
+        super
+      end
+    end
+
+    public
+    def scope
+      Pundit.policy_scope!(user, record.class)
+    end
+
+    private  # Used by child
+    def public?
+      true
+    end
+
+    # # TODO: Revise because it seems there is no justification for allowing owner to see any of the deleted entities, which include User, Guild, and Post
+    # private  # Used by child
+    # def not_deleted_unless_owner_or_moderator?(&block)
+    #   block ||= lambda { |unused_arg| @user.moderator? }
+    #   !@record.deleted? || (@user && (@user.id == @record.user_owner_id || block.call(@record)))
+    # end
+
+    # private  # Used by child
+    # def not_deleted_unless_moderator?(&block)
+    #   block ||= lambda { |unused_arg| @user.moderator? }
+    #   !@record.deleted? || (@user && block.call(@record))
+    # end
+
+    public
+    def self.args_builder
+      Proc.new { |controller| [] }
+    end
+    
+    class Scope
+      attr_reader :user, :scope
+
+      def initialize(user, scope)
+        @user = user
+        @scope = scope
+      end
+
+      def resolve
+        scope
+      end
+    end
+  end
+end

data/app/views/json_ui/garage/dynamic_texts/basic.json.jbuilder

@@ -7,6 +7,7 @@ json_ui_page json do |page|
     scroll.h3 text: dt_json('.hello', name: 'John')
     scroll.spacer height: 6
     scroll.label text: dt_json('.greeting')
+    scroll.label text: dt_json('.greeting_with_image')
   end
 
 end

data/lib/glib/json_crawler/router.rb

@@ -1,19 +1,18 @@
-
 module Glib
   module JsonCrawler
     class Router
-      def self.log action, url, response = nil
+      def self.log(action, url, response = nil)
         @@logger.puts '  ' * @@depth + [
           action,
           response.present? ? response.code : nil,
           url
         ].compact.join(' :: ')
       end
-      
+
       def self.set_up(logger)
         @@depth = -1
         @@logger = logger
-        @@forms = []
+        @@visitor = Glib::Json::Traversal::Visitor.new
       end
 
       def self.step(http, args)
@@ -35,13 +34,14 @@ module Glib
             when 'http/post-v1'
               JsonCrawler::ActionHttp.new(:post, http, params, action)
             when 'forms/submit-v1'
-              raise 'Submit action needs to be inside a form' if @@forms.size < 1
-              JsonCrawler::FormsSubmit.new(http, params, action, @@forms.last)
+              forms = @@visitor.forms
+              raise 'Submit action needs to be inside a form' if forms.size < 1
+              JsonCrawler::FormsSubmit.new(http, params, action, forms.last)
             else
               self.log action, params['url']
             end
             @@depth -= 1
-            return child
+            child
           end
         end
       end
@@ -49,51 +49,11 @@ module Glib
       def self.tear_down
         @@logger.close
       end
-        
-      def self.crawl_multiple views, block
-        if views.is_a? Array
-          views.each do |view|
-            case view['view']
-            when 'panels/form-v1'
-              @@forms << view
-              crawl_single view, block
-              @@forms.pop
-            else
-              crawl_single view, block
-            end
-          end
-        end
-      end
 
-      def self.crawl_vertical_content view, block
-        crawl_multiple view['childViews'], block if view
-      end
-
-      def self.crawl_single view, block
-        block.call view
-
-        # Generic view children
-        crawl_multiple view['childViews'], block
-
-        # panels/split
-        # crawl_multiple view['leftViews'], block
-        # crawl_multiple view['rightViews'], block
-        
-        # Split panel
-        crawl_vertical_content view['left'], block
-        crawl_vertical_content view['center'], block
-        crawl_vertical_content view['right'], block
-
-        # TODO: crawl header and footer
-        # Table/List
-        if (sections = view['sections']).is_a? Array
-          sections.each do |section|
-            # Table
-            crawl_multiple section['rows'], block
-          end
-        end
+      def self.crawl_multiple(views, block)
+        @@visitor.traverse_multiple views, block
       end
 
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glib-web
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - ''
@@ -71,7 +71,9 @@ files:
 - app/controllers/concerns/glib/auth/policy.rb
 - app/controllers/concerns/glib/json/dynamic_text.rb
 - app/controllers/concerns/glib/json/libs.rb
+- app/controllers/concerns/glib/json/new_dynamic_text.rb
 - app/controllers/concerns/glib/json/transformation.rb
+- app/controllers/concerns/glib/json/traversal.rb
 - app/controllers/concerns/glib/json/ui.rb
 - app/controllers/concerns/glib/json/validation.rb
 - app/controllers/glib/home_controller.rb
@@ -197,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: ''