wallaby-core 0.1.0

data/lib/wallaby/configuration/sorting.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Wallaby
+  class Configuration
+    # Sorting global configuration
+    # @since 5.2.0
+    class Sorting
+      # @!attribute [w] strategy
+      attr_writer :strategy
+
+      # @!attribute [r] strategy
+      # To globally configure which strategy to use for sorting. Options are
+      #
+      #   - `:multiple`: support multiple columns sorting
+      #   - `:single`: support single column sorting
+      #
+      # By default, strategy is `:multiple`.
+      # @example To enable turbolinks:
+      #   Wallaby.config do |config|
+      #     config.sorting.strategy = :single
+      #   end
+      # @return [Symbol, String]
+      def strategy
+        @strategy ||= :multiple
+      end
+    end
+  end
+end

data/lib/wallaby/constants.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Wallaby
+  EMPTY_STRING = ''.html_safe
+  EMPTY_HASH = {}.freeze
+  EMPTY_ARRAY = [].freeze
+  SPACE = ' '
+  SLASH = '/'
+  COLONS = '::'
+  COMMA = ','
+  DOT = '.'
+
+  # Default page size for {Wallaby::Configuration::Pagination#page_size}
+  DEFAULT_PAGE_SIZE = 20
+  # Default max charactoers to display for {Wallaby::Configuration::Metadata#max}
+  DEFAULT_MAX = 20
+  # Default provider name for authorizer sorting.
+  DEFAULT_PROVIDER = 'default'
+
+  ERRORS = %i(
+    bad_request
+    forbidden
+    internal_server_error
+    not_found
+    not_implemented
+    unauthorized
+    unprocessable_entity
+  ).freeze
+  MODEL_ACTIONS = %i(index new create show edit update destroy).freeze
+  FORM_ACTIONS = { new: 'form', create: 'form', edit: 'form', update: 'form' }.with_indifferent_access.freeze
+  SAVE_ACTIONS = %w(create update).freeze
+  NON_FIND_ACTIONS = %w(index new create).freeze
+
+  SCRIPT_NAME = 'SCRIPT_NAME'
+  PATH_INFO = 'PATH_INFO'
+  # Page size list
+  # @see Wallaby::Configuration::Pagination#page_size
+  PERS = [10, 20, 50, 100].freeze
+  CSV = 'csv'
+  WILDCARD = 'QUERY'
+  TITLE_NAMES = %w(name title string text).freeze
+
+  # A constant of error path for error handling
+  ERROR_PATH = 'error'
+end

data/lib/wallaby/core.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'parslet'
+require 'responders'
+
+require 'wallaby/core/version'
+require 'wallaby/constants'
+require 'wallaby/engine'
+
+require 'support/action_dispatch/routing/mapper'
+
+require 'wallaby/configuration'
+require 'wallaby/configuration/features'
+require 'wallaby/configuration/mapping'
+require 'wallaby/configuration/metadata'
+require 'wallaby/configuration/models'
+require 'wallaby/configuration/pagination'
+require 'wallaby/configuration/security'
+require 'wallaby/configuration/sorting'
+require 'wallaby/map'
+
+require 'routes/wallaby/resources_router'
+require 'tree/wallaby/node'
+require 'parsers/wallaby/parser'
+
+require 'utils/wallaby/cell_utils'
+require 'utils/wallaby/field_utils'
+require 'utils/wallaby/filter_utils'
+require 'utils/wallaby/model_utils'
+require 'utils/wallaby/module_utils'
+require 'utils/wallaby/params_utils'
+require 'utils/wallaby/preload_utils'
+require 'utils/wallaby/test_utils'
+require 'utils/wallaby/utils'
+
+require 'concerns/wallaby/authorizable'
+require 'concerns/wallaby/baseable'
+require 'concerns/wallaby/decoratable'
+require 'concerns/wallaby/defaultable'
+require 'concerns/wallaby/engineable'
+require 'concerns/wallaby/fieldable'
+require 'concerns/wallaby/paginatable'
+require 'concerns/wallaby/rails_overridden_methods'
+require 'concerns/wallaby/resourcable'
+require 'concerns/wallaby/servicable'
+require 'concerns/wallaby/shared_helpers'
+require 'concerns/wallaby/themeable'
+
+require 'interfaces/wallaby/mode'
+require 'interfaces/wallaby/model_decorator'
+require 'interfaces/wallaby/model_finder'
+require 'interfaces/wallaby/model_service_provider'
+require 'interfaces/wallaby/model_pagination_provider'
+require 'interfaces/wallaby/model_authorization_provider'
+
+require 'errors/wallaby/general_error'
+require 'errors/wallaby/invalid_error'
+require 'errors/wallaby/not_implemented'
+require 'errors/wallaby/not_found'
+require 'errors/wallaby/model_not_found'
+require 'errors/wallaby/resource_not_found'
+require 'errors/wallaby/cell_handling'
+
+require 'errors/wallaby/forbidden'
+require 'errors/wallaby/not_authenticated'
+require 'errors/wallaby/unprocessable_entity'
+
+require 'decorators/wallaby/resource_decorator'
+require 'servicers/wallaby/model_servicer'
+require 'paginators/wallaby/model_paginator'
+require 'paginators/wallaby/resource_paginator'
+require 'authorizers/wallaby/model_authorizer'
+require 'authorizers/wallaby/default_authorization_provider'
+require 'authorizers/wallaby/cancancan_authorization_provider'
+require 'authorizers/wallaby/pundit_authorization_provider'
+
+require 'forms/wallaby/form_builder'
+
+require 'services/wallaby/map/mode_mapper'
+require 'services/wallaby/map/model_class_collector'
+require 'services/wallaby/map/model_class_mapper'
+require 'services/wallaby/prefixes_builder'
+require 'services/wallaby/engine_name_finder'
+require 'services/wallaby/engine_url_for'
+require 'services/wallaby/type_renderer'
+require 'services/wallaby/link_options_normalizer'
+require 'services/wallaby/sorting/hash_builder'
+require 'services/wallaby/sorting/next_builder'
+require 'services/wallaby/sorting/single_builder'
+require 'services/wallaby/sorting/link_builder'
+
+require 'helpers/wallaby/configuration_helper'
+require 'helpers/wallaby/form_helper'
+require 'helpers/wallaby/index_helper'
+require 'helpers/wallaby/links_helper'
+require 'helpers/wallaby/styling_helper'
+
+require 'helpers/wallaby/base_helper'
+require 'helpers/wallaby/resources_helper'
+require 'helpers/wallaby/secure_helper'
+require 'helpers/wallaby/application_helper'
+
+require 'responders/wallaby/resources_responder'
+require 'responders/wallaby/json_api_responder'
+
+require 'renderers/wallaby/cell'
+require 'renderers/wallaby/cell_resolver'
+require 'renderers/wallaby/custom_lookup_context'
+require 'renderers/wallaby/custom_renderer'
+require 'renderers/wallaby/custom_partial_renderer'
+
+require 'adaptors/wallaby/custom'
+require 'adaptors/wallaby/custom/default_provider'
+require 'adaptors/wallaby/custom/model_finder'
+require 'adaptors/wallaby/custom/model_decorator'
+require 'adaptors/wallaby/custom/model_pagination_provider'
+require 'adaptors/wallaby/custom/model_service_provider'

data/lib/wallaby/core/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Wallaby
+  module Core
+    VERSION = '0.1.0'
+  end
+end

data/lib/wallaby/engine.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # Wallaby engine
+  class Engine < ::Rails::Engine
+    initializer 'wallaby.autoload_paths', before: :set_load_path do |_|
+      # NOTE: this needs to be run before `set_load_path`
+      # so that files under `app/views` can be eager loaded
+      # and therefore, Wallaby's renderer can function properly
+      [Rails.configuration].each do |conf|
+        next if conf.paths['app/views'].eager_load?
+
+        conf.paths.add 'app/views', eager_load: true
+      end
+    end
+
+    initializer 'wallaby.development.reload' do |_|
+      # NOTE: Rails reload! will hit here
+      # @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...'
+          ::Wallaby::Map.clear
+          ::Wallaby::PreloadUtils.require_all
+        end
+      end
+    end
+
+    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.'
+      ::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.'
+        ::Wallaby::PreloadUtils.require_all
+      end
+    end
+  end
+end

data/lib/wallaby/map.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+module Wallaby
+  # Global storage to hold all the information that Wallaby needs to look up.
+  class Map
+    class << self
+      # To store modes
+      attr_writer :modes
+
+      # @return [Array<Class>] descendants of Mode
+      def modes
+        @modes ||= Mode.descendants
+      end
+
+      # @return [Hash] { model => mode }
+      def mode_map
+        @mode_map ||= ModeMapper.new(modes).map.freeze
+      end
+
+      # TODO: remove this method
+      # @return [Array] [ model classes ]
+      def model_classes
+        @model_classes ||= ModelClassCollector.new(configuration, mode_map.keys).collect.freeze
+      end
+
+      # { model => resources name }
+      # It's a setter when value is given.
+      # Otherwise, a getter.
+      # @param model_class [Class]
+      # @param value [String, nil] resources name
+      # @return [String] resources name
+      def resources_name_map(model_class, value = nil)
+        @resources_name_map ||= {}
+        @resources_name_map[model_class] ||= value || ModelUtils.to_resources_name(model_class)
+      end
+
+      # { resources name => model }
+      # It's a setter when value is given.
+      # Otherwise, a getter.
+      # @param resources_name [String]
+      # @return [Class]
+      def model_class_map(resources_name, value = nil)
+        @model_class_map ||= {}
+        @model_class_map[resources_name] ||= value || ModelUtils.to_model_class(resources_name)
+      end
+    end
+
+    class << self
+      # Look up which controller to use for a given model class
+      # @param model_class [Class]
+      # @param application_controller [Class, nil]
+      # @return [Class] controller class, default to `mapping.resources_controller`
+      def controller_map(model_class, application_controller = nil)
+        application_controller ||= mapping.resources_controller
+        map_of :@controller_map, model_class, application_controller
+      end
+
+      # Look up which resource decorator to use for a given model class
+      # @param model_class [Class]
+      # @param application_decorator [Class, nil]
+      # @return [Class] resource decorator class, default to `mapping.resource_decorator`
+      def resource_decorator_map(model_class, application_decorator = nil)
+        application_decorator ||= mapping.resource_decorator
+        map_of :@decorator_map, model_class, application_decorator
+      end
+
+      # { model => model decorator }
+      # @param model_class [Class]
+      # @param application_decorator [Class, nil]
+      # @return [Wallaby::ModelDecorator] model decorator instance
+      def model_decorator_map(model_class, application_decorator = nil)
+        application_decorator ||= mapping.resource_decorator
+        @model_decorator_map ||= {}
+        @model_decorator_map[application_decorator] ||= {}
+        @model_decorator_map[application_decorator][model_class] ||=
+          mode_map[model_class].try(:model_decorator).try :new, model_class
+      end
+
+      # Look up which model servicer to use for a given model class
+      # @param model_class [Class]
+      # @param application_servicer [Class, nil]
+      # @return [Class] model servicer class, default to `mapping.model_servicer`
+      def servicer_map(model_class, application_servicer = nil)
+        application_servicer ||= mapping.model_servicer
+        map_of :@servicer_map, model_class, application_servicer
+      end
+
+      # Look up which paginator to use for a given model class
+      # @param model_class [Class]
+      # @param application_paginator [Class, nil]
+      # @return [Class] resource paginator class, default to `mapping.model_paginator`
+      def paginator_map(model_class, application_paginator = nil)
+        application_paginator ||= mapping.model_paginator
+        map_of :@paginator_map, model_class, application_paginator
+      end
+
+      # Look up which authorizer to use for a given model class
+      # @param model_class [Class]
+      # @param application_authorizer [Class, nil]
+      # @return [Class] model authorizer class, default to `mapping.model_authorizer`
+      def authorizer_map(model_class, application_authorizer = nil)
+        application_authorizer ||= mapping.model_authorizer
+        map_of :@authorizer_map, model_class, application_authorizer
+      end
+    end
+
+    class << self
+      # { model => service_provider }
+      # @param model_class [Class]
+      # @return [Class] model service provider instance
+      def service_provider_map(model_class)
+        @service_provider_map ||= {}
+        @service_provider_map[model_class] ||= mode_map[model_class].try :model_service_provider
+      end
+
+      # { model => pagination_provider }
+      # @param model_class [Class]
+      # @return [Class] model pagination provider class
+      def pagination_provider_map(model_class)
+        @pagination_provider_map ||= {}
+        @pagination_provider_map[model_class] ||= mode_map[model_class].try :model_pagination_provider
+      end
+
+      # { model => authorizer_provider }
+      # @param model_class [Class]
+      # @return [Class] model authorizer provider class
+      def authorizer_provider_map(model_class)
+        @authorizer_provider_map ||= {}
+        @authorizer_provider_map[model_class] ||= mode_map[model_class].try :model_authorization_providers
+      end
+    end
+
+    class << self
+      # Reset all the instance variables to nil
+      def clear
+        instance_variables.each { |name| instance_variable_set name, nil }
+      end
+
+      private
+
+      # shorthand method
+      def configuration
+        ::Wallaby.configuration
+      end
+
+      # shorthand method
+      def mapping
+        configuration.mapping
+      end
+
+      # Set up the hash map for given variable name
+      # @param variable_name [Symbol] instance variable name e.g. :@decorator_map
+      # @param model_class [Class]
+      # @param application_class [Class]
+      # @return [Class]
+      def map_of(variable_name, model_class, application_class)
+        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)
+          return
+        end
+        instance_variable_set(variable_name, instance_variable_get(variable_name) || {})
+        map = instance_variable_get variable_name
+        map[application_class] ||= ModelClassMapper.map application_class.descendants
+        map[application_class][model_class] ||= application_class
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification
+name: wallaby-core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tian Chen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parslet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wallaby-cop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The core of Wallaby
+email:
+- me@tian.im
+executables: []
+extensions: []
+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
+- config/routes.rb
+- lib/adaptors/wallaby/custom.rb
+- lib/adaptors/wallaby/custom/default_provider.rb
+- lib/adaptors/wallaby/custom/model_decorator.rb
+- lib/adaptors/wallaby/custom/model_finder.rb
+- lib/adaptors/wallaby/custom/model_pagination_provider.rb
+- lib/adaptors/wallaby/custom/model_service_provider.rb
+- lib/authorizers/wallaby/cancancan_authorization_provider.rb
+- lib/authorizers/wallaby/default_authorization_provider.rb
+- lib/authorizers/wallaby/model_authorizer.rb
+- lib/authorizers/wallaby/pundit_authorization_provider.rb
+- lib/concerns/wallaby/authorizable.rb
+- lib/concerns/wallaby/baseable.rb
+- lib/concerns/wallaby/decoratable.rb
+- lib/concerns/wallaby/defaultable.rb
+- lib/concerns/wallaby/engineable.rb
+- lib/concerns/wallaby/fieldable.rb
+- lib/concerns/wallaby/paginatable.rb
+- lib/concerns/wallaby/rails_overridden_methods.rb
+- lib/concerns/wallaby/resourcable.rb
+- lib/concerns/wallaby/servicable.rb
+- lib/concerns/wallaby/shared_helpers.rb
+- lib/concerns/wallaby/themeable.rb
+- lib/decorators/wallaby/resource_decorator.rb
+- lib/errors/wallaby/cell_handling.rb
+- lib/errors/wallaby/forbidden.rb
+- lib/errors/wallaby/general_error.rb
+- lib/errors/wallaby/invalid_error.rb
+- lib/errors/wallaby/model_not_found.rb
+- lib/errors/wallaby/not_authenticated.rb
+- lib/errors/wallaby/not_found.rb
+- lib/errors/wallaby/not_implemented.rb
+- lib/errors/wallaby/resource_not_found.rb
+- lib/errors/wallaby/unprocessable_entity.rb
+- lib/forms/wallaby/form_builder.rb
+- lib/helpers/wallaby/application_helper.rb
+- lib/helpers/wallaby/base_helper.rb
+- lib/helpers/wallaby/configuration_helper.rb
+- lib/helpers/wallaby/form_helper.rb
+- lib/helpers/wallaby/index_helper.rb
+- lib/helpers/wallaby/links_helper.rb
+- lib/helpers/wallaby/resources_helper.rb
+- lib/helpers/wallaby/secure_helper.rb
+- lib/helpers/wallaby/styling_helper.rb
+- lib/interfaces/wallaby/mode.rb
+- lib/interfaces/wallaby/model_authorization_provider.rb
+- lib/interfaces/wallaby/model_decorator.rb
+- lib/interfaces/wallaby/model_finder.rb
+- lib/interfaces/wallaby/model_pagination_provider.rb
+- lib/interfaces/wallaby/model_service_provider.rb
+- lib/paginators/wallaby/model_paginator.rb
+- lib/paginators/wallaby/resource_paginator.rb
+- lib/parsers/wallaby/parser.rb
+- lib/renderers/wallaby/cell.rb
+- lib/renderers/wallaby/cell_resolver.rb
+- lib/renderers/wallaby/custom_lookup_context.rb
+- lib/renderers/wallaby/custom_partial_renderer.rb
+- lib/renderers/wallaby/custom_renderer.rb
+- lib/responders/wallaby/json_api_responder.rb
+- lib/responders/wallaby/resources_responder.rb
+- lib/routes/wallaby/resources_router.rb
+- lib/servicers/wallaby/model_servicer.rb
+- lib/services/wallaby/engine_name_finder.rb
+- lib/services/wallaby/engine_url_for.rb
+- lib/services/wallaby/link_options_normalizer.rb
+- lib/services/wallaby/map/mode_mapper.rb
+- lib/services/wallaby/map/model_class_collector.rb
+- lib/services/wallaby/map/model_class_mapper.rb
+- lib/services/wallaby/prefixes_builder.rb
+- lib/services/wallaby/sorting/hash_builder.rb
+- lib/services/wallaby/sorting/link_builder.rb
+- lib/services/wallaby/sorting/next_builder.rb
+- lib/services/wallaby/sorting/single_builder.rb
+- lib/services/wallaby/type_renderer.rb
+- lib/support/action_dispatch/routing/mapper.rb
+- lib/tree/wallaby/node.rb
+- lib/utils/wallaby/cell_utils.rb
+- lib/utils/wallaby/field_utils.rb
+- lib/utils/wallaby/filter_utils.rb
+- lib/utils/wallaby/model_utils.rb
+- lib/utils/wallaby/module_utils.rb
+- lib/utils/wallaby/params_utils.rb
+- lib/utils/wallaby/preload_utils.rb
+- lib/utils/wallaby/test_utils.rb
+- lib/utils/wallaby/utils.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
+- lib/wallaby/configuration/security.rb
+- lib/wallaby/configuration/sorting.rb
+- lib/wallaby/constants.rb
+- lib/wallaby/core.rb
+- lib/wallaby/core/version.rb
+- lib/wallaby/engine.rb
+- lib/wallaby/map.rb
+homepage: https://github.com/wallaby-rails/wallaby-core
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wallaby-rails/wallaby-core
+  source_code_uri: https://github.com/wallaby-rails/wallaby-core
+  changelog_uri: https://github.com/wallaby-rails/wallaby-core/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: The core of Wallaby
+test_files: []