matestack-ui-core 0.7.5 → 1.1.0

data/app/lib/matestack/ui/core/rendering/default_renderer_class_determiner.rb

@@ -0,0 +1,33 @@
+# Handles the default rendering mechanism
+#
+# Not really compatible with the new flexible naming schemes
+module Matestack::Ui::Core::Rendering::DefaultRendererClassDeterminer
+  module_function
+
+  def determine_class(controller_path, action_name)
+    possible_default_render_matestack_page_class_names(controller_path, action_name).each do |class_name|
+      begin
+        return matestack_class = class_name.constantize
+      rescue NameError
+      end
+    end
+    return nil
+  end
+
+  def possible_default_render_matestack_page_class_names(controller_path, action_name)
+    possible_default_render_matestack_page_paths(controller_path, action_name).collect { |page_path|
+      page_path.split("/").collect { |str| str.camelcase }.join("::")
+    }
+  end
+
+  def possible_default_render_matestack_page_paths(controller_path, action_name)
+    paths = []
+    paths << "pages/#{controller_path}/#{action_name}"
+    paths << "pages/#{controller_path}" if action_name == "index"
+    paths << "pages/#{controller_path.singularize}" if action_name == "show"
+    paths << "#{controller_path}/#{action_name}_page"
+    paths << "#{controller_path}_page" if action_name == "index"
+    paths << "#{controller_path.singularize}_page" if action_name == "show"
+    paths
+  end
+end

data/app/lib/matestack/ui/core/rendering/main_renderer.rb

@@ -0,0 +1,200 @@
+# The main renderer that is usually called to determine how to perform rendering
+module Matestack::Ui::Core::Rendering::MainRenderer
+  module_function
+
+  EMPTY_JSON = "{}"
+
+  # Instead of rendering without an app class, we always have an "empty" app class
+  # to fall back to
+  DEFAULT_APP_CLASS = Matestack::Ui::Core::App::App
+
+  def render(controller_instance, page_class, options)
+    app_class = resolve_app_class(controller_instance, options)
+
+    params = controller_instance.params
+
+    context = create_context_hash(controller_instance)
+
+    if params[:only_page]
+      # standalone page rendering, used when performing a transition
+      page_instance = page_class.new(controller_instance: controller_instance, context: context)
+      render_matestack_object(controller_instance, page_instance)
+    elsif (params[:component_key].present? && params[:component_class].blank?)
+      # async component rerendering from non isolated context
+      app_instance = app_class.new(page_class, controller_instance, context)
+      component_key = params[:component_key]
+      page_instance = page_class.new(controller_instance: controller_instance, context: context)
+      render_component(component_key, app_instance, controller_instance, context)
+    elsif (params[:component_class].present? && params[:component_key].blank?)
+      # isolated component rendering
+      component_class = params[:component_class]
+      page_instance = page_class.new(controller_instance: controller_instance, context: context)
+      public_options = JSON.parse(params[:public_options]).with_indifferent_access rescue nil
+      render_isolated_component(component_class, page_instance, controller_instance, context, public_options)
+    elsif (params[:component_class].present? && params[:component_key].present?)
+      # async component rerendering from isolated context
+      component_class_name = params[:component_class]
+      component_key = params[:component_key]
+      page_instance = page_class.new(controller_instance: controller_instance, context: context)
+      if params[:public_options].present?
+        public_options = JSON.parse(params[:public_options]).with_indifferent_access
+      else
+        public_options = nil
+      end
+      component_class = resolve_isolated_component(component_class_name)
+      if component_class
+        component_instance = component_class.new(public_options: public_options, context: context)
+        if component_instance.authorized?
+          render_component(component_key, component_instance, controller_instance, context)
+        else
+          raise "not authorized"
+        end
+      end
+    else
+      if app_class == false
+        page_instance = page_class.new(controller_instance: controller_instance, context: context)
+        render_matestack_object(controller_instance, page_instance, layout: true)
+      else
+        app_instance = app_class.new(page_class, controller_instance, context)
+        render_matestack_object(controller_instance, app_instance, layout: true)
+      end
+    end
+  end
+
+  def create_context_hash(controller_instance)
+    {
+      view_context: controller_instance.view_context,
+      params: controller_instance.params,
+      request: controller_instance.request
+    }
+  end
+
+  def render_matestack_object(controller_instance, object, opts = {}, render_method = :show)
+    object.prepare
+    object.response if object.respond_to? :response
+    rendering_options = {html: object.call(render_method)}.merge!(opts)
+    controller_instance.render rendering_options
+  end
+
+  def render_component(component_key, app_or_page_instance, controller_instance, context)
+    matched_component = nil
+
+    app_or_page_instance.matestack_set_skip_defer(false)
+
+    app_or_page_instance.prepare
+    app_or_page_instance.response
+
+    matched_component = dig_for_component(component_key, app_or_page_instance)
+
+    unless matched_component.nil?
+      render_matestack_object(controller_instance, matched_component, {}, :render_content)
+    else
+      # some 404 probably
+      raise Exception, "Async component with id #{component_key} could not be found while rerendering."
+    end
+  rescue Exception => e
+     Rails.logger.warn e
+     render json: {}, status: :not_found
+  end
+
+  def dig_for_component component_key, component_instance
+    matched_component = nil
+
+    component_instance.children.each do |child|
+      if child.respond_to?(:get_component_key)
+        if child.get_component_key == component_key
+          matched_component = child
+        end
+      end
+    end
+
+    if matched_component.nil?
+      component_instance.children.each do |child|
+        if child.children.any?
+          matched_component = dig_for_component(component_key, child)
+          break if !matched_component.nil?
+        end
+      end
+      return matched_component
+    else
+      return matched_component
+    end
+
+  end
+
+  # TODO: too many arguments maybe get some of them together?
+  def render_isolated_component(component_class_name, page_instance, controller_instance, context, public_options = nil)
+    component_class = resolve_isolated_component(component_class_name)
+
+    if component_class
+      component_instance = component_class.new(public_options: public_options, context: context)
+      if component_instance.authorized?
+        render_matestack_object(controller_instance, component_instance, {}, :render_isolated_content)
+      else
+        # some 4xx? 404?
+        raise "not authorized"
+      end
+    else
+      # some 404 probably
+      raise "component not found"
+    end
+  end
+
+  def resolve_component(name)
+    constant = const_get(name)
+    # change to specific AsyncComponent parent class
+    if constant < Matestack::Ui::Core::Async::Async
+      constant
+    else
+      nil
+    end
+  rescue NameError
+    nil
+  end
+
+  def resolve_isolated_component(name)
+    constant = const_get(name)
+    if constant < Matestack::Ui::Core::Isolated::Isolated
+      constant
+    else
+      nil
+    end
+  rescue NameError
+    nil
+  end
+
+
+  def resolve_app_class(controller_instance, options)
+    app_class = DEFAULT_APP_CLASS
+
+    controller_level_app_class = controller_instance.class.get_matestack_app_class
+    action_level_app_class = options[:matestack_app]
+
+    if !controller_level_app_class.nil?
+      if controller_level_app_class == false
+        app_class = false
+      else
+        if controller_level_app_class.is_a?(Class) && (controller_level_app_class < Matestack::Ui::App)
+          app_class = controller_level_app_class
+        else
+          raise "#{controller_level_app_class} is not a valid Matestack::Ui::App class"
+        end
+      end
+    end
+    if !action_level_app_class.nil?
+      if action_level_app_class == false
+        app_class = false
+      else
+        matestack_app_class = action_level_app_class
+        if action_level_app_class.is_a?(Class) && (action_level_app_class < Matestack::Ui::App)
+          app_class = action_level_app_class
+        else
+          raise "#{action_level_app_class} is not a valid Matestack::Ui::App class"
+        end
+      end
+    end
+
+    return app_class
+  end
+
+end

data/app/lib/matestack/ui/isolated_component.rb

@@ -0,0 +1 @@
+Matestack::Ui::IsolatedComponent = Matestack::Ui::Core::Isolated::Isolated

data/app/lib/matestack/ui/vue_js_component.rb

@@ -0,0 +1 @@
+Matestack::Ui::VueJsComponent = Matestack::Ui::Core::Component::Dynamic

data/lib/matestack/ui/core.rb

@@ -1,5 +1,3 @@
-require 'trailblazer'
-require 'trailblazer/rails'
 require 'trailblazer/cell'
 require 'cell/rails'
 require 'cell/haml'
@@ -7,6 +5,10 @@ require 'cell/haml'
 require "matestack/ui/core/cell"
 require "matestack/ui/core/engine"
 
+require "matestack/ui/core/dsl"
+require "matestack/ui/core/component/registry"
+require "matestack/ui/core/components"
+
 module Matestack
   module Ui
     module Core

data/lib/matestack/ui/core/cell.rb

@@ -29,5 +29,3 @@ module Matestack
     end
   end
 end
-
-# Matestack::Ui::Core::Cell = ::Cell::Haml

data/lib/matestack/ui/core/component/registry.rb

@@ -0,0 +1,47 @@
+module Matestack::Ui::Core::Component
+  # Central Registration point for all component DSL methods.
+  #
+  # Keeps track of currently registered DSL methods to warn on
+  # conflicts. Adds them to a specified DSL module.
+  #
+  # Functions as a singleton as we don't want to have methods
+  # meaning something different within the same application.
+  #
+  # TODO: Potentially all DSL methods to further avoid conflicts?
+  module Registry
+    DEFAULT_DSL_MODULE = Matestack::Ui::Core::DSL
+
+    module_function
+
+    def register_component(dsl_name, component_class)
+      instance.register_component(dsl_name, component_class)
+    end
+
+    def register_components(components_hash)
+      components_hash.each do |dsl_name, component_class|
+        register_component dsl_name, component_class
+      end
+    end
+
+    def instance(target_module = DEFAULT_DSL_MODULE)
+      @instance ||= Instance.new(target_module)
+    end
+
+    class Instance
+
+      attr_reader :target_module, :registered_components
+
+      def initialize(target_module)
+        @target_module = target_module
+        @registered_components = {}
+      end
+
+      def register_component(dsl_name, component_class)
+        target_module.define_method(dsl_name) do |*args, &block|
+          add_child component_class, *args, &block
+        end
+        registered_components[dsl_name] = component_class
+      end
+    end
+  end
+end

data/lib/matestack/ui/core/components.rb

@@ -0,0 +1,269 @@
+# Responsible for registering all the components under their names.
+# TODO: Better file name?
+
+# TODO: app folder isn't in the LOAD_PATH 🤔
+# --> because of rails autoload when running as an engine, maybe add
+# app to loadpath? But we might move away from app in favor of lib anyhow.
+
+module Matestack::Ui::Core::Components
+  def self.require_app_path(path)
+    require_relative "../../../../app/#{path}"
+  end
+
+  def self.require_core_component(name)
+    if name.include?("/")
+      require_app_path "concepts/matestack/ui/core/#{name}/#{name.split("/").last}"
+    else
+      require_app_path "concepts/matestack/ui/core/#{name}/#{name}"
+    end
+  end
+
+  require_app_path "helpers/matestack/ui/core/application_helper"
+  require_app_path "lib/matestack/ui/core/has_view_context"
+  require_app_path "lib/matestack/ui/core/html_attributes"
+  require_app_path "lib/matestack/ui/core/properties"
+
+  require_app_path "concepts/matestack/ui/core/component/base"
+  require_app_path "concepts/matestack/ui/core/component/dynamic"
+  require_app_path "concepts/matestack/ui/core/component/static"
+
+  require_core_component "abbr"
+  require_core_component "action"
+  require_core_component "address"
+  require_core_component "area"
+  require_core_component "article"
+  require_core_component "aside"
+  require_core_component "async"
+  require_core_component "b"
+  require_core_component "bdi"
+  require_core_component "bdo"
+  require_core_component "blockquote"
+  require_core_component "br"
+  require_core_component "button"
+  require_core_component "cable"
+  require_core_component "caption"
+  require_core_component "cite"
+  require_core_component "code"
+  require_core_component "form" # required before collection
+  require_app_path "concepts/matestack/ui/core/form/has_input_html_attributes" # required before collection
+  require_app_path "concepts/matestack/ui/core/collection/helper"
+  require_core_component "collection/content"
+  require_core_component "collection/content/next"
+  require_core_component "collection/content/page/link"
+  require_core_component "collection/content/previous"
+  require_core_component "collection/filter"
+  require_core_component "collection/filter/input"
+  require_core_component "collection/filter/reset"
+  require_core_component "collection/filter/select"
+  require_core_component "collection/filter/submit"
+  require_core_component "collection/order"
+  require_core_component "collection/order/toggle"
+  require_core_component "collection/order/toggle/indicator"
+  require_core_component "data"
+  require_core_component "datalist"
+  require_core_component "dd"
+  require_core_component "del"
+  require_core_component "details"
+  require_core_component "dfn"
+  require_core_component "dialog"
+  require_core_component "div"
+  require_core_component "dl"
+  require_core_component "dt"
+  require_core_component "em"
+  require_core_component "fieldset"
+  require_core_component "figure"
+  require_core_component "footer"
+  require_core_component "form/checkbox"
+  require_core_component "form/input"
+  require_core_component "form/radio"
+  require_core_component "form/select"
+  require_core_component "form/submit"
+  require_core_component "header"
+  require_core_component "heading"
+  require_core_component "hr"
+  require_core_component "icon"
+  require_core_component "iframe"
+  require_core_component "img"
+  require_core_component "input"
+  require_core_component "ins"
+  require_core_component "isolated"
+  require_core_component "kbd"
+  require_core_component "label"
+  require_core_component "legend"
+  require_core_component "li"
+  require_core_component "link"
+  require_core_component "main"
+  require_core_component "map"
+  require_core_component "mark"
+  require_core_component "meter"
+  require_core_component "nav"
+  require_core_component "noscript"
+  require_core_component "object"
+  require_core_component "ol"
+  require_core_component "onclick"
+  require_core_component "optgroup"
+  require_core_component "option"
+  require_core_component "output"
+  require_core_component "page"
+  require_core_component "page/content"
+  require_core_component "paragraph"
+  require_core_component "param"
+  require_core_component "picture"
+  require_core_component "plain"
+  require_core_component "pre"
+  require_core_component "progress"
+  require_core_component "q"
+  require_core_component "view"
+  require_core_component "rp"
+  require_core_component "rt"
+  require_core_component "ruby"
+  require_core_component "s"
+  require_core_component "samp"
+  require_core_component "section"
+  require_core_component "small"
+  require_core_component "span"
+  require_core_component "strong"
+  require_core_component "sub"
+  require_core_component "summary"
+  require_core_component "sup"
+  require_core_component "table"
+  require_core_component "tbody"
+  require_core_component "td"
+  require_core_component "template"
+  require_core_component "textarea" # textarea needs to be required before form/textarea
+  require_core_component "form/textarea"
+  require_core_component "tfoot"
+  require_core_component "th"
+  require_core_component "thead"
+  require_core_component "time"
+  require_core_component "toggle"
+  require_core_component "tr"
+  require_core_component "transition"
+  require_core_component "u"
+  require_core_component "ul"
+  require_core_component "unescaped"
+  require_core_component "var"
+  require_core_component "video"
+  require_core_component "wbr"
+  require_core_component "youtube"
+end
+
+Matestack::Ui::Core::Component::Registry.register_components(
+  abbr: Matestack::Ui::Core::Abbr::Abbr,
+  action: Matestack::Ui::Core::Action::Action,
+  address: Matestack::Ui::Core::Address::Address,
+  area: Matestack::Ui::Core::Area::Area,
+  article: Matestack::Ui::Core::Article::Article,
+  aside: Matestack::Ui::Core::Aside::Aside,
+  async: Matestack::Ui::Core::Async::Async,
+  b: Matestack::Ui::Core::B::B,
+  bdi: Matestack::Ui::Core::Bdi::Bdi,
+  bdo: Matestack::Ui::Core::Bdo::Bdo,
+  blockquote: Matestack::Ui::Core::Blockquote::Blockquote,
+  br: Matestack::Ui::Core::Br::Br,
+  button: Matestack::Ui::Core::Button::Button,
+  cable: Matestack::Ui::Core::Cable::Cable,
+  caption: Matestack::Ui::Core::Caption::Caption,
+  cite: Matestack::Ui::Core::Cite::Cite,
+  code: Matestack::Ui::Core::Code::Code,
+  collection_content: Matestack::Ui::Core::Collection::Content::Content,
+  collection_content_next: Matestack::Ui::Core::Collection::Content::Next::Next,
+  collection_content_page_link: Matestack::Ui::Core::Collection::Content::Page::Link::Link,
+  collection_content_previous: Matestack::Ui::Core::Collection::Content::Previous::Previous,
+  collection_filter: Matestack::Ui::Core::Collection::Filter::Filter,
+  collection_filter_input: Matestack::Ui::Core::Collection::Filter::Input::Input,
+  collection_filter_reset: Matestack::Ui::Core::Collection::Filter::Reset::Reset,
+  collection_filter_select: Matestack::Ui::Core::Collection::Filter::Select::Select,
+  collection_filter_submit: Matestack::Ui::Core::Collection::Filter::Submit::Submit,
+  collection_order: Matestack::Ui::Core::Collection::Order::Order,
+  collection_order_toggle: Matestack::Ui::Core::Collection::Order::Toggle::Toggle,
+  collection_order_toggle_indicator: Matestack::Ui::Core::Collection::Order::Toggle::Indicator::Indicator,
+  data: Matestack::Ui::Core::Data::Data,
+  datalist: Matestack::Ui::Core::Datalist::Datalist,
+  dd: Matestack::Ui::Core::Dd::Dd,
+  del: Matestack::Ui::Core::Del::Del,
+  details: Matestack::Ui::Core::Details::Details,
+  dfn: Matestack::Ui::Core::Dfn::Dfn,
+  dialog: Matestack::Ui::Core::Dialog::Dialog,
+  div: Matestack::Ui::Core::Div::Div,
+  dl: Matestack::Ui::Core::Dl::Dl,
+  dt: Matestack::Ui::Core::Dt::Dt,
+  em: Matestack::Ui::Core::Em::Em,
+  fieldset: Matestack::Ui::Core::Fieldset::Fieldset,
+  figure: Matestack::Ui::Core::Figure::Figure,
+  footer: Matestack::Ui::Core::Footer::Footer,
+  form: Matestack::Ui::Core::Form::Form,
+  form_checkbox: Matestack::Ui::Core::Form::Checkbox::Checkbox,
+  form_input: Matestack::Ui::Core::Form::Input::Input,
+  form_radio: Matestack::Ui::Core::Form::Radio::Radio,
+  form_select: Matestack::Ui::Core::Form::Select::Select,
+  form_submit: Matestack::Ui::Core::Form::Submit::Submit,
+  form_textarea: Matestack::Ui::Core::Form::Textarea::Textarea,
+  header: Matestack::Ui::Core::Header::Header,
+  heading: Matestack::Ui::Core::Heading::Heading,
+  hr: Matestack::Ui::Core::Hr::Hr,
+  icon: Matestack::Ui::Core::Icon::Icon,
+  italic: Matestack::Ui::Core::Icon::Icon, # alias icon as italic
+  iframe: Matestack::Ui::Core::Iframe::Iframe,
+  img: Matestack::Ui::Core::Img::Img,
+  input: Matestack::Ui::Core::Input::Input,
+  ins: Matestack::Ui::Core::Ins::Ins,
+  kbd: Matestack::Ui::Core::Kbd::Kbd,
+  label: Matestack::Ui::Core::Label::Label,
+  legend: Matestack::Ui::Core::Legend::Legend,
+  li: Matestack::Ui::Core::Li::Li,
+  link: Matestack::Ui::Core::Link::Link,
+  main: Matestack::Ui::Core::Main::Main,
+  map: Matestack::Ui::Core::Map::Map,
+  mark: Matestack::Ui::Core::Mark::Mark,
+  meter: Matestack::Ui::Core::Meter::Meter,
+  nav: Matestack::Ui::Core::Nav::Nav,
+  noscript: Matestack::Ui::Core::Noscript::Noscript,
+  object: Matestack::Ui::Core::Object::Object,
+  ol: Matestack::Ui::Core::Ol::Ol,
+  onclick: Matestack::Ui::Core::Onclick::Onclick,
+  optgroup: Matestack::Ui::Core::Optgroup::Optgroup,
+  option: Matestack::Ui::Core::Option::Option,
+  output: Matestack::Ui::Core::Output::Output,
+  paragraph: Matestack::Ui::Core::Paragraph::Paragraph,
+  pg: Matestack::Ui::Core::Paragraph::Paragraph, # alias paragraph as pg
+  page_content_wrapper: Matestack::Ui::Core::Page::Content::Content,
+  param: Matestack::Ui::Core::Param::Param,
+  picture: Matestack::Ui::Core::Picture::Picture,
+  plain: Matestack::Ui::Core::Plain::Plain,
+  pre: Matestack::Ui::Core::Pre::Pre,
+  progress: Matestack::Ui::Core::Progress::Progress,
+  q: Matestack::Ui::Core::Q::Q,
+  rails_view: Matestack::Ui::Core::View::View,
+  rp: Matestack::Ui::Core::Rp::Rp,
+  rt: Matestack::Ui::Core::Rt::Rt,
+  ruby: Matestack::Ui::Core::Ruby::Ruby,
+  s: Matestack::Ui::Core::S::S,
+  samp: Matestack::Ui::Core::Samp::Samp,
+  section: Matestack::Ui::Core::Section::Section,
+  small: Matestack::Ui::Core::Small::Small,
+  span: Matestack::Ui::Core::Span::Span,
+  strong: Matestack::Ui::Core::Strong::Strong,
+  sub: Matestack::Ui::Core::Sub::Sub,
+  summary: Matestack::Ui::Core::Summary::Summary,
+  sup: Matestack::Ui::Core::Sup::Sup,
+  table: Matestack::Ui::Core::Table::Table,
+  tbody: Matestack::Ui::Core::Tbody::Tbody,
+  td: Matestack::Ui::Core::Td::Td,
+  template: Matestack::Ui::Core::Template::Template,
+  textarea: Matestack::Ui::Core::Textarea::Textarea,
+  tfoot: Matestack::Ui::Core::Tfoot::Tfoot,
+  th: Matestack::Ui::Core::Th::Th,
+  thead: Matestack::Ui::Core::Thead::Thead,
+  time: Matestack::Ui::Core::Time::Time,
+  toggle: Matestack::Ui::Core::Toggle::Toggle,
+  tr: Matestack::Ui::Core::Tr::Tr,
+  transition: Matestack::Ui::Core::Transition::Transition,
+  u: Matestack::Ui::Core::U::U,
+  ul: Matestack::Ui::Core::Ul::Ul,
+  unescaped: Matestack::Ui::Core::Unescaped::Unescaped,
+  var: Matestack::Ui::Core::Var::Var,
+  video: Matestack::Ui::Core::Video::Video,
+  wbr: Matestack::Ui::Core::Wbr::Wbr,
+  youtube: Matestack::Ui::Core::Youtube::Youtube,
+)