wallaby 5.1.5 → 5.1.6

data/lib/tree/wallaby/node.rb

@@ -6,10 +6,12 @@ module Wallaby
 
     delegate :name, to: :klass
 
+    # @param klass [Class]
     def initialize(klass)
       @klass = klass
     end
 
+    # @return [Array<Class>] a list of children classes
     def children
       @children ||= []
     end

data/lib/utils/wallaby/test_utils.rb

@@ -0,0 +1,32 @@
+module Wallaby
+  # Utils for test
+  module TestUtils
+    class << self
+      # @param context
+      # @param controller_class [Class]
+      def around_crud(context, controller_class = nil)
+        context.before do
+          controller_class ||= described_class
+          controller_path = controller_class.controller_path
+          Wallaby::TestUtils.draw(routes, controller_path)
+        end
+
+        context.after { Rails.application.reload_routes! }
+      end
+
+      # @param routes
+      # @param controller_path [String]
+      def draw(routes, controller_path)
+        routes.draw do
+          get ':resources', to: "#{controller_path}#index", as: :resources
+          get ':resources/:id', to: "#{controller_path}#show", as: :resource
+          get ':resources/new', to: "#{controller_path}#new"
+          get ':resources/:id/edit', to: "#{controller_path}#edit"
+          post ':resources', to: "#{controller_path}#create"
+          patch ':resources/:id', to: "#{controller_path}#update"
+          delete ':resources/:id', to: "#{controller_path}#destroy"
+        end
+      end
+    end
+  end
+end

data/lib/utils/wallaby/utils.rb

@@ -1,22 +1,55 @@
 module Wallaby
   # Utils
   module Utils
+    # @param klass [Class]
+    # @return [Boolean] whether a class is anonymous
+    def self.anonymous_class?(klass)
+      klass.name.blank? || klass.to_s.start_with?('#<Class')
+    end
+
+    # Help to translate a message for a class
+    # @param object [Object]
+    # @param key [String, Symbol]
+    # @param options [Hash]
+    # @return [String] a message for this class
+    def self.translate_class(object, key, options = {})
+      klass = object.is_a?(Class) ? object : object.class
+      key = [klass.name, key].join(SLASH).underscore.gsub(SLASH, DOT)
+      I18n.t key, options
+    end
+
+    # Convert model class (e.g. `Namespace::Product`) into resources name
+    # (e.g. `namespace::products`)
+    # @param model_class [Class, String] model class
+    # @return [String] resources name
     def self.to_resources_name(model_class)
       return EMPTY_STRING if model_class.blank?
       model_class.to_s.underscore.gsub(SLASH, COLONS).pluralize
     end
 
+    # Convert model class (e.g. `Namespace::Product`) into model label
+    # (e.g. `Namespace / Product`)
+    # @param model_class [Class, String] model class
+    # @return [String] model label
     def self.to_model_label(model_class)
       return EMPTY_STRING if model_class.blank?
       model_class_name = to_model_name model_class
       model_class_name.titleize.gsub(SLASH, SPACE + SLASH + SPACE)
     end
 
+    # Convert resources name (e.g. `namespace::products`) into model name
+    # (e.g. `Namespace::Product`)
+    # @param resources_name [String] resources name
+    # @return [String] model name
     def self.to_model_name(resources_name)
       return EMPTY_STRING if resources_name.blank?
       resources_name.to_s.singularize.gsub(COLONS, SLASH).camelize
     end
 
+    # Convert resources name (e.g. `namespace::products`) into model class
+    # (e.g. `Namespace::Product`)
+    # @param resources_name [String] resources name
+    # @return [Class] model class
     def self.to_model_class(resources_name)
       return if resources_name.blank?
       class_name = to_model_name resources_name
@@ -27,30 +60,42 @@ module Wallaby
       raise ModelNotFound, class_name
     end
 
+    # Find filter name in the following precedences:
+    # - filter name argument
+    # - filters that has been marked as default
+    # - `:all`
+    # @param filter_name [String, Symbol] filter name
+    # @param filters [Hash] filter metadata
+    # @return [String, Symbol]
     def self.find_filter_name(filter_name, filters)
       filter_name || # from params
         filters.find { |_k, v| v[:default] }.try(:first) || # from default value
         :all # last resort
     end
 
+    # @todo maybe delegate this label thing to the mode?
+    # @param field_name [String, Symbol] field name
+    # @return [String] field label
     def self.to_field_label(field_name, metadata)
       field_name = field_name.to_s if field_name.is_a? Symbol
       metadata[:label] || field_name.humanize
     end
 
+    # Return `form` for `new/create/edit/update`
+    # @param action_name [String]
+    # @return [String] action name
     def self.to_partial_name(action_name)
       FORM_ACTIONS.include?(action_name) ? 'form' : action_name
     end
 
-    def self.to_hash(array)
-      Hash[*array.flatten(1)]
-    end
-
     # @see http://stackoverflow.com/a/8710663/1326499
+    # @param object [Object]
+    # @return [Object] a clone object
     def self.clone(object)
       ::Marshal.load(::Marshal.dump(object))
     end
 
+    # Preload files
     def self.preload_all
       ::Wallaby::ApplicationController.to_s
       preload 'app/models/**/*.rb'
@@ -60,9 +105,10 @@ module Wallaby
       preload 'app/**/*.rb'
     end
 
+    # Preload files
     def self.preload(file_pattern)
       Dir[file_pattern].each do |file_path|
-        begin
+        begin # rubocop:disable Style/RedundantBegin
           name = file_path[%r{app/[^/]+/(.+)\.rb}, 1].gsub('concerns/', '')
           class_name = name.classify
           class_name.constantize unless Module.const_defined? class_name

data/lib/wallaby.rb

@@ -6,6 +6,7 @@ module Wallaby
   SLASH = '/'.freeze
   COLONS = '::'.freeze
   COMMA = ','.freeze
+  DOT = '.'.freeze
   CSV = 'csv'.freeze
   PERS = [10, 20, 50, 100].freeze
   DEFAULT_PAGE_SIZE = 20

data/lib/wallaby/configuration.rb

@@ -2,7 +2,7 @@
 module Wallaby
   # Global configuration
   class Configuration
-    attr_writer :base_controller, :page_size
+    attr_writer :base_controller
 
     # @return [Class]
     #   the controller that Wallaby should inherit from
@@ -29,6 +29,12 @@ module Wallaby
       @security ||= Security.new
     end
 
+    # @return [Wallaby::Configuration::Mapping]
+    #   configuration for Wallaby::Map
+    def mapping
+      @mapping ||= Mapping.new
+    end
+
     # @return [Wallaby::Configuration::Metadata] configuration of metadata
     def metadata
       @metadata ||= Metadata.new
@@ -47,8 +53,8 @@ module Wallaby
     # Clear all configurations
     # @return nil
     def clear
-      @base_controller, @models, @security, @pagination, @metadata,
-      @features = []
+      @base_controller, @models, @security, @mapping,
+      @pagination, @metadata, @features = []
     end
   end
 

data/lib/wallaby/configuration/features.rb

@@ -1,9 +1,10 @@
 module Wallaby
   class Configuration
-    # Configuration for metadata
+    # Configuration for features
     class Features
       attr_writer :turbolinks_enabled
 
+      # @return [Boolean] a feture flag for turbolinks
       def turbolinks_enabled
         @turbolinks_enabled ||= false
       end

data/lib/wallaby/configuration/mapping.rb

@@ -0,0 +1,66 @@
+module Wallaby
+  class Configuration
+    # Configuration used in Wallaby::Map
+    class Mapping
+      attr_writer \
+        :resources_controller, :resource_decorator,
+        :resource_paginator, :model_servicer
+
+      # This configuration is used by `Wallaby::Map.controller_map`
+      #
+      # If `resources_controller` is not defined,
+      # it will fallback to `Admin::ApplicationController`,
+      # then `Wallaby::ResourcesController`.
+      # @return [Class] configurable resources controller
+      def resources_controller
+        @resources_controller ||=
+          defined?(::Admin::ApplicationController) \
+            && ::Admin::ApplicationController < ::Wallaby::ResourcesController \
+            && ::Admin::ApplicationController
+        @resources_controller ||= ResourcesController
+      end
+
+      # This configuration is used by `Wallaby::Map.resource_decorator_map`
+      #
+      # If `resource_decorator` is not defined,
+      # it will fallback to `Admin::ApplicationDecorator`,
+      # then `Wallaby::ResourcesDecorator`.
+      # @return [Class] configurable resource decorator
+      def resource_decorator
+        @resource_decorator ||=
+          defined?(::Admin::ApplicationDecorator) \
+            && ::Admin::ApplicationDecorator < ::Wallaby::ResourceDecorator \
+            && ::Admin::ApplicationDecorator
+        @resource_decorator ||= ResourceDecorator
+      end
+
+      # This configuration is used by `Wallaby::Map.paginator_map`
+      #
+      # If resource_paginator is not defined,
+      # it will fallback to `Admin::ApplicationPaginator`,
+      # then `Wallaby::ResourcesPaginator`.
+      # @return [Class] configurable resource paginator
+      def resource_paginator
+        @resource_paginator ||=
+          defined?(::Admin::ApplicationPaginator) \
+            && ::Admin::ApplicationPaginator < ::Wallaby::ResourcePaginator \
+            && ::Admin::ApplicationPaginator
+        @resource_paginator ||= ResourcePaginator
+      end
+
+      # This configuration is used by `Wallaby::Map.servicer_map`
+      #
+      # If model_servicer is not defined,
+      # it will fallback to `Admin::ApplicationServicer`,
+      # then `Wallaby::ResourcesServicer`.
+      # @return [Class] configurable model servicer
+      def model_servicer
+        @model_servicer ||=
+          defined?(::Admin::ApplicationServicer) \
+            && ::Admin::ApplicationServicer < ::Wallaby::ModelServicer \
+            && ::Admin::ApplicationServicer
+        @model_servicer ||= ModelServicer
+      end
+    end
+  end
+end

data/lib/wallaby/configuration/metadata.rb

@@ -4,6 +4,7 @@ module Wallaby
     class Metadata
       attr_writer :max
 
+      # @return [Integer] max characters to display, default to 20
       def max
         @max ||= DEFAULT_MAX
       end

data/lib/wallaby/configuration/pagination.rb

@@ -1,9 +1,10 @@
 module Wallaby
   class Configuration
-    # Configuration for metadata
+    # Configuration for pagination
     class Pagination
       attr_writer :page_size
 
+      # @return [Integer] page size, default to 20
       def page_size
         @page_size ||= DEFAULT_PAGE_SIZE
       end

data/lib/wallaby/engine.rb

@@ -70,11 +70,13 @@ end
 require 'wallaby/configuration'
 require 'wallaby/configuration/models'
 require 'wallaby/configuration/security'
+require 'wallaby/configuration/mapping'
 require 'wallaby/configuration/metadata'
 require 'wallaby/configuration/pagination'
 require 'wallaby/configuration/features'
 
 require 'utils/wallaby/utils'
+require 'utils/wallaby/test_utils'
 require 'routes/wallaby/resources_router'
 require 'tree/wallaby/node'
 
@@ -146,5 +148,7 @@ require 'helpers/wallaby/base_helper'
 require 'helpers/wallaby/secure_helper'
 require 'helpers/wallaby/application_helper'
 
+require 'concerns/wallaby/resources_helper_methods'
+
 require 'responders/wallaby/abstract_responder'
 require 'responders/wallaby/resources_responder'

data/lib/wallaby/version.rb

@@ -1,3 +1,3 @@
 module Wallaby
-  VERSION = '5.1.5'.freeze
+  VERSION = '5.1.6'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wallaby
 version: !ruby/object:Gem::Version
-  version: 5.1.5
+  version: 5.1.6
 platform: ruby
 authors:
 - Tianwen Chen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-06 00:00:00.000000000 Z
+date: 2018-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bootstrap-sass
@@ -509,6 +509,7 @@ files:
 - lib/adaptors/wallaby/active_record/model_service_provider/querier.rb
 - lib/adaptors/wallaby/active_record/model_service_provider/querier/transformer.rb
 - lib/adaptors/wallaby/active_record/model_service_provider/validator.rb
+- lib/concerns/wallaby/resources_helper_methods.rb
 - lib/decorators/wallaby/abstract_resource_decorator.rb
 - lib/decorators/wallaby/resource_decorator.rb
 - lib/errors/wallaby/general_error.rb
@@ -554,12 +555,13 @@ files:
 - lib/services/wallaby/sorting/link_builder.rb
 - lib/services/wallaby/sorting/next_builder.rb
 - lib/services/wallaby/url_for.rb
-- lib/tasks/wallaby_tasks.rake
 - lib/tree/wallaby/node.rb
+- lib/utils/wallaby/test_utils.rb
 - lib/utils/wallaby/utils.rb
 - lib/wallaby.rb
 - lib/wallaby/configuration.rb
 - lib/wallaby/configuration/features.rb
+- lib/wallaby/configuration/mapping.rb
 - lib/wallaby/configuration/metadata.rb
 - lib/wallaby/configuration/models.rb
 - lib/wallaby/configuration/pagination.rb

data/lib/tasks/wallaby_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :wallaby do
-#   # Task goes here
-# end