wallaby 5.1.8 → 6.0.1

data/lib/interfaces/wallaby/mode.rb

@@ -1,47 +0,0 @@
-module Wallaby
-  # This is the abstract class that all ORM modes to have implemented.
-  class Mode
-    class << self
-      # @see Wallaby::ModelDecorator
-      # @return [Wallaby::ModelDecorator] model decorator for the mode
-      def model_decorator
-        check_and_constantize __callee__
-      end
-
-      # @see Wallaby::ModelFinder
-      # @return [Wallaby::ModelFinder] model finder for the mode
-      def model_finder
-        check_and_constantize __callee__
-      end
-
-      # @see Wallaby::ModelServiceProvider
-      # @return [Wallaby::ModelServiceProvider] service provider for the mode
-      def model_service_provider
-        check_and_constantize __callee__
-      end
-
-      # @see Wallaby::ModelPaginationProvider
-      # @return [Wallaby::ModelPaginationProvider]
-      # pagination provider for the mode
-      def model_pagination_provider
-        check_and_constantize __callee__
-      end
-
-      private
-
-      #
-      # @return [Class] constantized class
-      def check_and_constantize(method_id)
-        method_class  = method_id.to_s.classify
-        class_name    = "#{name}::#{method_class}"
-        parent_class  = "Wallaby::#{method_class}".constantize
-        class_name.constantize.tap do |klass|
-          next if klass < parent_class
-          raise InvalidError, "#{klass} must inherit #{parent_class}"
-        end
-      rescue NameError
-        raise NotImplemented, class_name
-      end
-    end
-  end
-end

data/lib/interfaces/wallaby/model_decorator.rb

@@ -1,135 +0,0 @@
-module Wallaby
-  # Model Decorator interface, designed to maintain metadata for all
-  # the fields coming from data source (database/api)
-  # @see Wallaby::ResourceDecorator for more information on how to customize
-  #   metadata
-  class ModelDecorator
-    include FieldHelpers
-
-    attr_reader :model_class
-    attr_writer \
-      :field_names, :index_field_names, :show_field_names, :form_field_names
-
-    # Initialize with model class
-    # @param model_class [Class] model class
-    def initialize(model_class)
-      @model_class = model_class
-    end
-
-    # @return [Hash] origin metadata for fields
-    def fields
-      raise NotImplemented
-    end
-
-    # Set metadata as origin
-    # @param fields [Hash] metadata
-    def fields=(fields)
-      @fields = ::ActiveSupport::HashWithIndifferentAccess.new fields
-    end
-
-    # @return [Array<String>, Array<Symbol>] a list of field names
-    def field_names
-      @field_names ||= reposition fields.keys, primary_key
-    end
-
-    # @return [Hash] metadata for fields used on index page
-    def index_fields
-      raise NotImplemented
-    end
-
-    # Set metadata for index page
-    # @param fields [Hash] metadata
-    def index_fields=(fields)
-      @index_fields = ::ActiveSupport::HashWithIndifferentAccess.new fields
-    end
-
-    # @return [Array<String>, Array<Symbol>]
-    #   a list of field names displayed on index page
-    def index_field_names
-      @index_field_names ||= reposition index_fields.keys, primary_key
-    end
-
-    # @return [Hash] metadata for fields used on show page
-    def show_fields
-      raise NotImplemented
-    end
-
-    # Set metadata for show page
-    # @param fields [Hash] metadata
-    def show_fields=(fields)
-      @show_fields = ::ActiveSupport::HashWithIndifferentAccess.new fields
-    end
-
-    # @return [Array<String>, Array<Symbol>]
-    #   a list of field names displayed on show page
-    def show_field_names
-      @show_field_names ||= reposition show_fields.keys, primary_key
-    end
-
-    # @return [Hash] metadata for fields used on form (new/edit) page
-    def form_fields
-      raise NotImplemented
-    end
-
-    # Set metadata for form (new/edit) page
-    # @param fields [Hash] metadata
-    def form_fields=(fields)
-      @form_fields = ::ActiveSupport::HashWithIndifferentAccess.new fields
-    end
-
-    # @return [Array<String>, Array<Symbol>]
-    #   a list field names displayed on form (new/edit) page
-    def form_field_names
-      @form_field_names ||= reposition form_fields.keys, primary_key
-    end
-
-    # @return [Hash] metadata for custom filters used on index page
-    def filters
-      @filters ||= ::ActiveSupport::HashWithIndifferentAccess.new
-    end
-
-    # @return [Hash] validation errors for current resource
-    def form_active_errors(_resource)
-      raise NotImplemented
-    end
-
-    # @return [String] primary key
-    def primary_key
-      raise NotImplemented
-    end
-
-    # To guess the title for a resource.
-    #
-    # This title will be used on the following places:
-    # - page title on show page
-    # - in the response for autocomplete association field
-    # - title of show link for a resource
-    # @param _resource [Object] resource
-    # @return [String] title of current resource
-    def guess_title(_resource)
-      raise NotImplemented
-    end
-
-    # @return [String] resources name coverted from model class
-    def resources_name
-      Map.resources_name_map @model_class
-    end
-
-    protected
-
-    # @param field_names [Array<String>, Array<Symbol>] field names
-    # @param primary_key [String] primary key name
-    # @return [Array<String>, Array<Symbol>]
-    #   a list of field names that primary key goes first
-    def reposition(field_names, primary_key)
-      field_names.unshift(primary_key).uniq
-    end
-
-    # Ensure type is present
-    # @param type [String, Symbol, nil] type of a field
-    # @return [String, Symbol] type name
-    def validate_presence_of(field_name, type)
-      type || raise(::ArgumentError, "Type is required for #{field_name}.")
-    end
-  end
-end

data/lib/interfaces/wallaby/model_decorator/field_helpers.rb

@@ -1,78 +0,0 @@
-module Wallaby
-  class ModelDecorator
-    # Field helper for model decorator
-    module FieldHelpers
-      # @param field_name [String, Symbol] field name
-      # @return [Hash] metadata information for a given field
-      def metadata_of(field_name)
-        fields[field_name] || {}
-      end
-
-      # @param field_name [String, Symbol] field name
-      # @return [String] label for a given field
-      def label_of(field_name)
-        metadata_of(field_name)[:label]
-      end
-
-      # @param field_name [String, Symbol] field name
-      # @return [String, Symbol] type for a given field
-      def type_of(field_name)
-        validate_presence_of field_name, metadata_of(field_name)[:type]
-      end
-
-      # @param field_name [String, Symbol] field name
-      # @return [Hash] index metadata information for a given field
-      def index_metadata_of(field_name)
-        index_fields[field_name] || {}
-      end
-
-      # @param field_name [String, Symbol] field name
-      # @return [String] index label for a given field
-      def index_label_of(field_name)
-        index_metadata_of(field_name)[:label]
-      end
-
-      # @param field_name [String, Symbol] field name
-      # @return [String, Symbol] index type for a given field
-      def index_type_of(field_name)
-        validate_presence_of field_name, index_metadata_of(field_name)[:type]
-      end
-
-      # @param field_name [String, Symbol] field name
-      # @return [Hash] show metadata information for a given field
-      def show_metadata_of(field_name)
-        show_fields[field_name] || {}
-      end
-
-      # @param field_name [String, Symbol] field name
-      # @return [String] show label for a given field
-      def show_label_of(field_name)
-        show_metadata_of(field_name)[:label]
-      end
-
-      # @param field_name [String, Symbol] field name
-      # @return [String, Symbol] show type for a given field
-      def show_type_of(field_name)
-        validate_presence_of field_name, show_metadata_of(field_name)[:type]
-      end
-
-      # @param field_name [String, Symbol] field name
-      # @return [Hash] form metadata information for a given field
-      def form_metadata_of(field_name)
-        form_fields[field_name] || {}
-      end
-
-      # @param field_name [String, Symbol] field name
-      # @return [String] form label for a given field
-      def form_label_of(field_name)
-        form_metadata_of(field_name)[:label]
-      end
-
-      # @param field_name [String, Symbol] field name
-      # @return [String, Symbol] form type for a given field
-      def form_type_of(field_name)
-        validate_presence_of field_name, form_metadata_of(field_name)[:type]
-      end
-    end
-  end
-end

data/lib/interfaces/wallaby/model_finder.rb

@@ -1,10 +0,0 @@
-module Wallaby
-  # Model finder interface
-  class ModelFinder
-    # Need to implement this method to get all the available model for a mode
-    # @return [Array<Class>] a list of model class
-    def all
-      raise NotImplemented
-    end
-  end
-end

data/lib/interfaces/wallaby/model_pagination_provider.rb

@@ -1,105 +0,0 @@
-module Wallaby
-  # Model pagination provider interface
-  class ModelPaginationProvider
-    # @param collection [#to_a]
-    # @param params [ActionController::Parameters]
-    # @param options [Hash] options
-    # @param model_decorator [Wallaby::ModelDecorator, nil]
-    def initialize(collection, params, options: {}, model_decorator: nil)
-      @collection = collection
-      @params = params
-      @options = options
-      @model_decorator = model_decorator
-    end
-
-    # If a collection has pagination feature
-    # @return [Boolean]
-    def paginatable?
-      raise NotImplemented
-    end
-
-    # Check and see if it's the first page
-    # @return [Boolean]
-    def first_page?
-      page_number > first_page_number
-    end
-
-    # Check and see if it's the previous page
-    # @return [Boolean]
-    def prev_page?
-      page_number > first_page_number
-    end
-
-    # Check and see if it's the last page
-    # @return [Boolean]
-    def last_page?
-      page_number < last_page_number
-    end
-
-    # Check and see if it's the next page
-    # @return [Boolean]
-    def next_page?
-      page_number < last_page_number
-    end
-
-    # Find out the offset `from`
-    # @return [Integer]
-    def from
-      (page_number - 1) * page_size + 1
-    end
-
-    # Find out the offset `to`
-    # @return [Integer]
-    def to
-      [page_number * page_size, total].min
-    end
-
-    # Find out the total count of current query
-    # @return [Integer]
-    def total
-      raise NotImplemented
-    end
-
-    # Find out the current page size
-    # @return [Integer]
-    def page_size
-      raise NotImplemented
-    end
-
-    # Find out the current page number
-    # @return [Integer]
-    def page_number
-      raise NotImplemented
-    end
-
-    # Page number of first page
-    # @return [Integer]
-    def first_page_number
-      1
-    end
-
-    # Page number of last page
-    # @return [Integer]
-    def last_page_number
-      number_of_pages
-    end
-
-    # Page number of previous page
-    # @return [Integer]
-    def prev_page_number
-      [page_number - 1, first_page_number].max
-    end
-
-    # Page number of next page
-    # @return [Integer]
-    def next_page_number
-      [page_number + 1, last_page_number].min
-    end
-
-    # Total number of pages
-    # @return [Integer]
-    def number_of_pages
-      (total / page_size.to_f).ceil
-    end
-  end
-end

data/lib/interfaces/wallaby/model_service_provider.rb

@@ -1,79 +0,0 @@
-module Wallaby
-  # Model service provider interface
-  class ModelServiceProvider
-    # @param model_class [Class] model class
-    # @param model_decorator [Wallaby::ModelDecorator, nil] model decorator
-    def initialize(model_class, model_decorator = nil)
-      raise ::ArgumentError, 'model class required' unless model_class
-      @model_class = model_class
-      @model_decorator = model_decorator || Map.model_decorator_map(model_class)
-    end
-
-    # To whitelist params for a model class
-    # @param _params [ActionController::Parameters]
-    # @return [ActionController::Parameters] whitelisted params
-    def permit(_params)
-      raise NotImplemented
-    end
-
-    # Fetch collection by params
-    # @param _params [ActionController::Parameters]
-    # @param _authorizer
-    # @return [#to_a]
-    def collection(_params, _authorizer)
-      raise NotImplemented
-    end
-
-    # Paginate the resources
-    # @param _query
-    # @param _params [ActionController::Parameters]
-    # @return [#to_a]
-    def paginate(_query, _params)
-      raise NotImplemented
-    end
-
-    # Initialize the model class using params
-    # @param _params [ActionController::Parameters]
-    # @param _authorizer
-    # @return a resource object
-    def new(_params, _authorizer)
-      raise NotImplemented
-    end
-
-    # Find a resource using id
-    # @param _id [Object]
-    # @param _params [ActionController::Parameters]
-    # @param _authorizer
-    # @return a resource object
-    def find(_id, _params, _authorizer)
-      raise NotImplemented
-    end
-
-    # Save the newly initialized resource
-    # @param _resource [Object]
-    # @param _params [ActionController::Parameters]
-    # @param _authorizer
-    # @return a resource object
-    def create(_resource, _params, _authorizer)
-      raise NotImplemented
-    end
-
-    # Update the persisted resource
-    # @param _resource [Object]
-    # @param _params [ActionController::Parameters]
-    # @param _authorizer
-    # @return a resource object
-    def update(_resource, _params, _authorizer)
-      raise NotImplemented
-    end
-
-    # Destroy the given resource
-    # @param _resource [Object]
-    # @param _params [ActionController::Parameters]
-    # @param _authorizer
-    # @return a resource object
-    def destroy(_resource, _params, _authorizer)
-      raise NotImplemented
-    end
-  end
-end