wallaby-core 0.2.0 → 0.2.1

data/lib/concerns/wallaby/servicable.rb

@@ -54,7 +54,7 @@ module Wallaby
       @current_servicer ||=
         (controller_to_get(:model_servicer) \
           || Map.servicer_map(current_model_class, controller_to_get(:application_servicer))).try do |klass|
-          Rails.logger.info %(  - Current servicer: #{klass})
+          Logger.debug %(Current servicer: #{klass})
           klass.new current_model_class, current_authorizer, current_model_decorator
         end
     end

data/lib/errors/wallaby/model_not_found.rb

@@ -5,7 +5,7 @@ module Wallaby
   class ModelNotFound < NotFound
     # @return [String] not found error message
     def message
-      I18n.t 'errors.not_found.model', model: super
+      Locale.t 'errors.not_found.model', model: super
     end
   end
 end

data/lib/errors/wallaby/resource_not_found.rb

@@ -5,7 +5,7 @@ module Wallaby
   class ResourceNotFound < NotFound
     # @return [String] resource not found error message
     def message
-      I18n.t 'errors.not_found.resource', resource: super
+      Locale.t 'errors.not_found.resource', resource: super
     end
   end
 end

data/lib/helpers/wallaby/application_helper.rb

@@ -66,5 +66,11 @@ module Wallaby
       options = default_options.merge!(sources.extract_options!.stringify_keys)
       super(*sources, options)
     end
+
+    # @param key
+    # @param options [Hash]
+    def wt(key, options = {})
+      Locale.t key, { translator: method(:t) }.merge(options)
+    end
   end
 end

data/lib/helpers/wallaby/form_helper.rb

@@ -46,9 +46,8 @@ module Wallaby
       type = metadata[:type]
       hint = metadata[:hint]
       # @see http://guides.rubyonrails.org/i18n.html#using-safe-html-translations
-      hint ||= type && t("hints.#{type}_html", default: '').presence
-      hint ||= type && t("hints.#{type}", default: '').presence
-      return unless hint
+      hint ||= type && wt("hints.#{type}_html", default: [:"hints.#{type}", ''])
+      return if hint.blank?
 
       content_tag :p, hint, class: 'help-block'
     end

data/lib/helpers/wallaby/index_helper.rb

@@ -6,7 +6,7 @@ module Wallaby
     # Just a label
     # @return [String]
     def all_label
-      t 'filters.all'
+      wt 'filters.all'
     end
 
     # If `:fields` parameter is given, only display fields that is in `index_field_names`
@@ -58,7 +58,7 @@ module Wallaby
     # @return [String] Export link for the given model_class.
     def export_link(model_class, url_params: {})
       index_link(model_class, url_params: { format: 'csv', page: nil, per: nil, with_query: true }.merge(url_params)) do
-        t 'links.export', ext: 'CSV'
+        wt 'links.export', ext: 'CSV'
       end
     end
 

data/lib/helpers/wallaby/links_helper.rb

@@ -44,7 +44,7 @@ module Wallaby
       html_options, block = LinkOptionsNormalizer.normalize(
         html_options, block,
         class: 'resource__create',
-        block: -> { t 'links.new', model: to_model_label(model_class) }
+        block: -> { wt 'links.new', model: to_model_label(model_class) }
       )
 
       url = options[:url] || new_path(model_class, url_params: url_params)
@@ -97,7 +97,7 @@ module Wallaby
       html_options, block = LinkOptionsNormalizer.normalize(
         html_options, block,
         class: 'resource__update',
-        block: -> { "#{t 'links.edit'} #{decorate(resource).to_label}" }
+        block: -> { "#{wt 'links.edit'} #{decorate(resource).to_label}" }
       )
 
       default = options[:readonly] && block.call || nil
@@ -123,11 +123,11 @@ module Wallaby
       return if unauthorized? :destroy, extract(resource)
 
       html_options, block = LinkOptionsNormalizer.normalize(
-        html_options, block, class: 'resource__destroy', block: -> { t 'links.delete' }
+        html_options, block, class: 'resource__destroy', block: -> { wt 'links.delete' }
       )
 
       html_options[:method] ||= :delete
-      (html_options[:data] ||= {})[:confirm] ||= t 'links.confirm.delete'
+      (html_options[:data] ||= {})[:confirm] ||= wt 'links.confirm.delete'
 
       url = options[:url] || show_path(resource, is_resource: options[:is_resource], url_params: url_params)
       link_to url, html_options, &block
@@ -140,7 +140,7 @@ module Wallaby
     # @yield block to return the link label
     # @return [String] anchor link of cancel action
     def cancel_link(html_options: {}, &block)
-      block ||= -> { t 'links.cancel' }
+      block ||= -> { wt 'links.cancel' }
       link_to 'javascript:history.back()', html_options, &block
     end
 

data/lib/helpers/wallaby/styling_helper.rb

@@ -3,6 +3,20 @@
 module Wallaby
   # Helper methods to build custom elements
   module StylingHelper
+    # backforward compatible with FontAwesome 4
+    # @see this fa migration document https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4
+    FONT_AWESOME_MAPPING = {
+      4 => {
+        clock: 'clock-o',
+        bars: 'navicon',
+        calendar: 'calendar-o',
+        'check-square': 'check-square-o',
+        square: 'square-o',
+        link: 'chain',
+        user: 'user-o'
+      }
+    }.with_indifferent_access.freeze
+
     # Shortcut to build up the HTML options as keyword arguments
     # @param string_or_array [String, Array<String>]
     # @param options [Hash]
@@ -54,12 +68,12 @@ module Wallaby
 
     # @return [String] grey null
     def null
-      muted t 'labels.empty'
+      muted wt 'labels.empty'
     end
 
     # @return [String] grey N/A
     def na
-      muted t 'labels.na'
+      muted wt 'labels.na'
     end
 
     # Grey text
@@ -74,7 +88,7 @@ module Wallaby
     def fa_map(name, major = nil)
       @map ||= begin
         major ||= Gem.loaded_specs['font-awesome-sass'].try(:version).try(:segments).try(:first)
-        t("fa.v#{major}").with_indifferent_access
+        FONT_AWESOME_MAPPING[major] || {}
       end
       @map[name] || name
     end

data/lib/interfaces/wallaby/mode.rb

@@ -61,10 +61,10 @@ module Wallaby
         class_name.constantize.tap do |klass|
           next if klass < parent_class
 
-          raise InvalidError, I18n.t('wallaby.mode.inherit_required', klass: klass, parent: parent_class)
+          raise InvalidError, Locale.t('mode.inherit_required', klass: klass, parent: parent_class)
         end
       rescue NameError => e
-        Rails.logger.error e
+        Logger.error e
         raise NotImplemented, class_name
       end
     end

data/lib/interfaces/wallaby/model_decorator.rb

@@ -162,7 +162,7 @@ module Wallaby
     # @return [String, Symbol] type
     # @raise [ArgumentError] when type is nil
     def validate_presence_of(field_name, type)
-      type || raise(::ArgumentError, I18n.t('errors.invalid.type_required', field_name: field_name))
+      type || raise(::ArgumentError, Locale.t('errors.invalid.type_required', field_name: field_name))
     end
   end
 end

data/lib/paginators/wallaby/model_paginator.rb

@@ -59,7 +59,7 @@ module Wallaby
     # @param params [ActionController::Parameters]
     def initialize(model_class, collection, params)
       @model_class = self.class.model_class || model_class
-      raise ArgumentError, I18n.t('errors.required', subject: 'model_class') unless @model_class
+      raise ArgumentError, Locale.t('errors.required', subject: 'model_class') unless @model_class
 
       @collection = collection
       @params = params

data/lib/routes/wallaby/resources_router.rb

@@ -53,7 +53,7 @@ module Wallaby
       return model_class unless MODEL_ACTIONS.include? params[:action].to_sym
       raise ModelNotFound, params[:resources] unless model_class
       unless Map.mode_map[model_class]
-        raise UnprocessableEntity, I18n.t('errors.unprocessable_entity.model', model: model_class)
+        raise UnprocessableEntity, Locale.t('errors.unprocessable_entity.model', model: model_class)
       end
 
       model_class

data/lib/servicers/wallaby/model_servicer.rb

@@ -75,7 +75,7 @@ module Wallaby
     # @raise [ArgumentError] if param model_class is blank
     def initialize(model_class, authorizer, model_decorator = nil)
       @model_class = model_class || self.class.model_class
-      raise ArgumentError, I18n.t('errors.required', subject: 'model_class') unless @model_class
+      raise ArgumentError, Locale.t('errors.required', subject: 'model_class') unless @model_class
 
       @model_decorator = model_decorator || Map.model_decorator_map(model_class)
       @authorizer = authorizer
@@ -100,6 +100,7 @@ module Wallaby
       provider.collection params, authorizer
     end
 
+    # @!method paginate(query, params)
     # @note This is a template method that can be overridden by subclasses.
     # Paginate given {#collection}.
     # @param query [Enumerable]

data/lib/services/wallaby/map/model_class_collector.rb

@@ -26,7 +26,7 @@ module Wallaby
         invalid_models = configured_models - @models
         return if invalid_models.blank?
 
-        message = I18n.t 'errors.invalid.models', models: invalid_models.to_sentence
+        message = Locale.t 'errors.invalid.models', models: invalid_models.to_sentence
         raise InvalidError, message
       end
 

data/lib/services/wallaby/type_renderer.rb

@@ -23,8 +23,8 @@ module Wallaby
       # @raise [ArgumentError] if field_name is not provided
       # @raise [ArgumentError] if object is not decorated
       def check(locals)
-        raise ArgumentError, I18n.t('errors.required', subject: 'form') if locals.key?(:form) && locals[:form].blank?
-        raise ArgumentError, I18n.t('errors.required', subject: 'field_name') if locals[:field_name].blank?
+        raise ArgumentError, Locale.t('errors.required', subject: 'form') if locals.key?(:form) && locals[:form].blank?
+        raise ArgumentError, Locale.t('errors.required', subject: 'field_name') if locals[:field_name].blank?
         raise ArgumentError, 'Object is not decorated.' unless locals[:object].is_a? ResourceDecorator
       end
 

data/lib/utils/wallaby/locale.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # Locale related
+  module Locale
+    class << self
+      # Extend translation just for Wallaby
+      # so that translation can be prefixed with `wallaby.`
+      # @param key [String, Symbol, Array]
+      # @param options [Hash] the rest of the arguments
+      # @return [String] translation
+      def t(key, options = {})
+        translator = options.delete(:translator) || I18n.method(:t)
+        return translator.call(key, options) unless key.is_a?(String) || key.is_a?(Symbol)
+
+        new_key, new_defaults = normalize key, options.delete(:default)
+
+        translator.call(new_key, { default: new_defaults }.merge(options))
+      end
+
+      private
+
+      # @param key [String, Symbol, Array]
+      # @param defaults [String, Symbol, Array]
+      # @return [Array]
+      def normalize(key, defaults)
+        *keys, default = *defaults
+
+        # default will NOT be considered as one of the key
+        # if it is not set or if it is a String (since String means translation for I18n.t)
+        unless default.nil? || default.is_a?(String)
+          keys << default
+          default = nil
+        end
+
+        new_defaults = prefix_defaults_from keys.unshift(key)
+        new_key = new_defaults.shift
+        new_defaults << default if default
+        [new_key, new_defaults]
+      end
+
+      # Duplicate and prefix the keys respectively
+      # @param keys [Array]
+      # @return [Array] new_keys
+      def prefix_defaults_from(keys)
+        keys.each_with_object([]) do |k, result|
+          result << :"wallaby.#{k}" unless k.to_s.start_with? 'wallaby.'
+          result << k.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/utils/wallaby/logger.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # Custom logger
+  module Logger
+    class << self
+      %w(unknown fatal error warn info debug).each do |method_id|
+        define_method method_id do |message, replacements = {}|
+          message = message.inspect unless message.is_a? String
+          sourcing = replacements.delete :sourcing # sourcing can be set to false
+
+          from = "\nfrom #{caller[sourcing || 0]}" unless sourcing == false
+          Rails.logger.public_send(
+            method_id, "#{method_id.upcase}: #{format message, replacements}#{from}"
+          )
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/utils/wallaby/model_utils.rb

@@ -34,7 +34,7 @@ module Wallaby
         class_name = to_model_name resources_name
         class_name.constantize
       rescue NameError
-        Rails.logger.warn I18n.t('errors.not_found.model', model: class_name)
+        Logger.warn Locale.t('errors.not_found.model', model: class_name), sourcing: 2
         nil
       end
 

data/lib/utils/wallaby/module_utils.rb

@@ -32,7 +32,7 @@ module Wallaby
         return unless child && parent
         return if child < parent
 
-        raise ::ArgumentError, I18n.t('errors.invalid.inheritance', klass: child, parent: parent)
+        raise ::ArgumentError, Locale.t('errors.invalid.inheritance', klass: child, parent: parent)
       end
 
       # If block is given, run the block. Otherwise, return subject

data/lib/utils/wallaby/utils.rb

@@ -8,7 +8,7 @@ module Wallaby
     # @param caller [String] the line where it's called
     # @param options [Hash]
     def self.deprecate(key, caller:, options: {})
-      warn I18n.t(key, options.merge(from: caller[0]))
+      warn Locale.t(key, options.merge(from: caller[0]))
     end
 
     # @see http://stackoverflow.com/a/8710663/1326499

data/lib/wallaby/core.rb

@@ -27,6 +27,8 @@ require 'parsers/wallaby/parser'
 
 require 'utils/wallaby/field_utils'
 require 'utils/wallaby/filter_utils'
+require 'utils/wallaby/locale'
+require 'utils/wallaby/logger'
 require 'utils/wallaby/model_utils'
 require 'utils/wallaby/module_utils'
 require 'utils/wallaby/params_utils'
@@ -34,6 +36,10 @@ require 'utils/wallaby/preload_utils'
 require 'utils/wallaby/test_utils'
 require 'utils/wallaby/utils'
 
+require 'concerns/wallaby/application_concern'
+require 'concerns/wallaby/authentication_concern'
+require 'concerns/wallaby/resources_concern'
+
 require 'concerns/wallaby/authorizable'
 require 'concerns/wallaby/baseable'
 require 'concerns/wallaby/decoratable'

data/lib/wallaby/core/version.rb

@@ -2,6 +2,6 @@
 
 module Wallaby
   module Core
-    VERSION = '0.2.0' # :nodoc:
+    VERSION = '0.2.1' # :nodoc:
   end
 end

data/lib/wallaby/engine.rb

@@ -19,7 +19,7 @@ module Wallaby
       # @see http://rmosolgo.github.io/blog/2017/04/12/watching-files-during-rails-development/
       config.to_prepare do
         if Rails.env.development? || Rails.configuration.eager_load
-          Rails.logger.debug '  [WALLABY] Reloading...'
+          Logger.debug '  [WALLABY] Reloading...'
           ::Wallaby::Map.clear
           ::Wallaby::PreloadUtils.require_all
         end
@@ -28,14 +28,14 @@ module Wallaby
 
     config.before_eager_load do
       # NOTE: We need to ensure that the core models are loaded before anything else
-      Rails.logger.debug '  [WALLABY] Preload all model files.'
+      Logger.debug '  [WALLABY] Preload all model files.'
       ::Wallaby::PreloadUtils.require_one 'app/models'
     end
 
     # Preload the rest files
     config.after_initialize do
       unless Rails.env.development? || Rails.configuration.eager_load
-        Rails.logger.debug '  [WALLABY] Preload files after initialize.'
+        Logger.debug '  [WALLABY] Preload files after initialize.'
         ::Wallaby::PreloadUtils.require_all
       end
     end

data/lib/wallaby/map.rb

@@ -157,7 +157,7 @@ module Wallaby
         return unless model_class
 
         unless mode_map[model_class]
-          Rails.logger.warn I18n.t('wallaby.map.missing_mode_for_model_class', model: model_class.name)
+          Logger.warn Locale.t('map.missing_mode_for_model_class', model: model_class.name), sourcing: 2
           return
         end
         instance_variable_set(variable_name, instance_variable_get(variable_name) || {})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wallaby-core
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Tian Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-15 00:00:00.000000000 Z
+date: 2020-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -117,9 +117,7 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- app/controllers/wallaby/application_controller.rb
 - app/controllers/wallaby/resources_controller.rb
-- app/controllers/wallaby/secure_controller.rb
 - app/security/ability.rb
 - config/locales/wallaby.en.yml
 - config/locales/wallaby_class.en.yml
@@ -134,6 +132,8 @@ files:
 - lib/authorizers/wallaby/default_authorization_provider.rb
 - lib/authorizers/wallaby/model_authorizer.rb
 - lib/authorizers/wallaby/pundit_authorization_provider.rb
+- lib/concerns/wallaby/application_concern.rb
+- lib/concerns/wallaby/authentication_concern.rb
 - lib/concerns/wallaby/authorizable.rb
 - lib/concerns/wallaby/baseable.rb
 - lib/concerns/wallaby/decoratable.rb
@@ -143,6 +143,7 @@ files:
 - lib/concerns/wallaby/paginatable.rb
 - lib/concerns/wallaby/prefixable.rb
 - lib/concerns/wallaby/resourcable.rb
+- lib/concerns/wallaby/resources_concern.rb
 - lib/concerns/wallaby/servicable.rb
 - lib/concerns/wallaby/shared_helpers.rb
 - lib/decorators/wallaby/resource_decorator.rb
@@ -193,6 +194,8 @@ files:
 - lib/tree/wallaby/node.rb
 - lib/utils/wallaby/field_utils.rb
 - lib/utils/wallaby/filter_utils.rb
+- lib/utils/wallaby/locale.rb
+- lib/utils/wallaby/logger.rb
 - lib/utils/wallaby/model_utils.rb
 - lib/utils/wallaby/module_utils.rb
 - lib/utils/wallaby/params_utils.rb