matestack-ui-core 1.5.0 → 3.0.0.rc1

data/app/lib/matestack/ui/core/html_attributes.rb

@@ -1,43 +0,0 @@
-module Matestack::Ui::Core::HtmlAttributes
-
-  HTML_GLOBAL_ATTRIBUTES = [
-    :accesskey, :class, :contenteditable, :data, :dir, :draggable, 
-    :hidden, :id, :lang, :spellcheck, :style, :tabindex, :title, :translate
-  ]
-
-  HTML_EVENT_ATTRIBUTES = [
-    :onafterprint, :onbeforeprint, :onbeforeunload, :onerror, :onhashchange, :onload, :onmessage, 
-    :onoffline, :ononline, :onpagehide, :onpageshow, :onpopstate, :onresize, :onstorage, :onunload
-  ]
-
-  def self.included(base)
-    base.class_eval do
-      extend ClassMethods
-    end
-  end
-
-  module ClassMethods
-
-    def inherited(subclass)
-      super
-      subclass.html_attributes *self.allowed_html_attributes
-    end
-
-    def html_attributes(*attributes)
-      attributes.each do |attribute|
-        allowed_html_attributes.push(attribute)
-      end
-    end
-
-    def allowed_html_attributes
-      @allowed_html_attributes.flatten!&.uniq! if defined? @allowed_html_attributes
-      @allowed_html_attributes ||= []
-    end
-
-  end
-
-  def html_attributes
-    options.slice(*self.class.allowed_html_attributes).merge((options[:attributes] || {}))
-  end
-
-end

data/app/lib/matestack/ui/core/properties.rb

@@ -1,161 +0,0 @@
-module Matestack::Ui::Core::Properties
-
-  class PropertyMissingException < StandardError
-  end
-
-  class PropertyOverwritingExistingMethodException < StandardError
-  end
-
-  # prepend the initializer and add class methods
-  def self.included(base)
-    base.class_eval do
-      extend ClassMethods
-    end
-    base.send :prepend, Initializer
-  end
-  
-  # initializer calls super and creates instance methods for defined required and optional properties afterwards
-  module Initializer
-    def initialize(model=nil, options={})
-      options = model.dup if options.empty? && model.is_a?(Hash)
-      # required_hooks(options)
-      # optional_hooks(options)
-      set_values(options) unless options[:skip_set_values]
-      super
-    end
-  end
-  
-  module ClassMethods
-
-    def inherited(subclass)
-      super
-      # self.new(nil, skip_set_values: true)
-      subclass.property_keys *self.all_property_keys
-      subclass.all_required_properties.concat(self.all_required_properties)
-      subclass.created_properties.concat(self.created_properties)
-    end
-    
-    # contains all property keys, or property hashes regardless of wheter they are optional or required
-    # used in order to initialize values of properties correctly for subclasses and make properties inheritable
-    def all_property_keys
-      @all_properties.flatten!&.uniq! if defined? @all_properties
-      @all_properties ||= []
-    end
-
-    def all_required_properties
-      @all_required_properties ||= []
-    end
-
-    def created_properties
-      @created_properties ||= []
-    end
-
-    # add property keys to array containing all property keys
-    def property_keys(*attributes)
-      attributes.each do |attribute|
-        if attribute.is_a?(Hash)
-          attribute.each do |temp|
-            all_property_keys.push({ "#{temp.first}": temp.last})
-          end
-        else
-          all_property_keys.push(attribute) 
-        end
-      end
-    end
-
-    # define optinoal properties for custom components with `optional :foo, :bar`
-    def optional(*properties)
-      property_keys *properties
-      add_properties_to_list(optional_properties, properties)
-      optional_hooks
-    end
-  
-    # define required properties for custom components with `requires :title, :foo, :bar`
-    def requires(*properties)
-      property_keys *properties
-      add_properties_to_list(requires_properties, properties)
-      required_hooks
-    end
-
-    def add_properties_to_list(list, properties)
-      properties.each do |property| 
-        if property.is_a? Hash 
-          property.each { |tmp_property| list.push(tmp_property) }
-        else
-          list.push(property) 
-        end
-      end
-    end
-  
-    # array of properties created from the component
-    def optional_properties
-      @optional_properties ||= []
-    end
-  
-    # array of required properties from the component
-    def requires_properties
-      @requires_properties ||= []
-    end
-
-    def optional_hooks
-      self.optional_properties.compact.each do |prop|
-        prop = extract_property_key({}, prop)
-        define_getter_and_setter_for_property(prop)
-      end
-    end
-
-    def required_hooks
-      self.requires_properties.compact.each do |prop|
-        prop = extract_property_key({}, prop)
-        self.all_required_properties.push(prop).uniq!
-        define_getter_and_setter_for_property(prop)
-      end
-    end
-
-    def extract_property_key(options, prop)
-      if prop.is_a?(Array) || prop.is_a?(Hash)
-        hash = prop.flatten
-        prop = hash.last[:as]
-      end
-      prop
-    end
-
-    def define_getter_and_setter_for_property(prop)
-      self.created_properties.push(prop)
-      self.send(:define_method, prop) do 
-        self.instance_variable_get(:"@#{prop}")
-      end
-      self.send(:define_method, :"#{prop}=") do |value|
-        self.instance_variable_set(:"@#{prop}", value)
-      end
-    end
-
-    def method_added(name)
-      if all_property_keys.include?(name) && !created_properties.include?(name)
-        raise PropertyOverwritingExistingMethodException, "Property \"#{name}\" would overwrite already defined instance method for #{self}"
-      end
-    end
-  end
-
-  def set_values(options)
-    self.class.all_property_keys.compact.each do |prop|
-      value_key = prop
-      prop = extract_property_key(options, prop)
-      if self.class.all_required_properties.include?(prop) && options[prop].nil?
-        raise PropertyMissingException, "Required property #{prop} is missing for #{self.class}" 
-      end
-      send(:"#{prop}=", options[prop])
-    end
-  end
-
-  # returns property key and sets alias if hash with as option is given
-  def extract_property_key(options, prop)
-    if prop.is_a?(Array) || prop.is_a?(Hash)
-      hash = prop.flatten
-      options[hash.last[:as]] = options[hash.first]
-      prop = hash.last[:as]
-    end
-    prop
-  end
-
-end

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

@@ -1,33 +0,0 @@
-# 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

@@ -1,203 +0,0 @@
-# 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
-
-  # needs refactoring!
-  # we shouldn't pass in the parts of the controller_instance and the instance itself
-  def create_context_hash(controller_instance)
-    {
-      view_context: controller_instance.view_context,
-      params: controller_instance.params,
-      request: controller_instance.request,
-      controller: controller_instance # if this is not included here, rails route helpers will fail with undefined method `url_options' for nil:NilClass in some cases
-    }
-  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/dynamic_actionview_component.rb

@@ -1 +0,0 @@
-Matestack::Ui::DynamicActionviewComponent = Matestack::Ui::Core::Actionview::Dynamic

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

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

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

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

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

@@ -1 +0,0 @@
-Matestack::Ui::Page = Matestack::Ui::Core::Page::Page

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

@@ -1 +0,0 @@
-Matestack::Ui::StaticActionviewComponent = Matestack::Ui::Core::Actionview::Static

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

@@ -1 +0,0 @@
-Matestack::Ui::StaticComponent = Matestack::Ui::Core::Component::Static

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

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

data/config/routes.rb

@@ -1,2 +0,0 @@
-Matestack::Ui::Core::Engine.routes.draw do
-end

data/lib/generators/matestack/app/USAGE

@@ -1,21 +0,0 @@
-Description:
-  Stubs out a new matestack app. Pass the app name under_scored.
-
-  If you want so, pass the option '--all_inclusive' to also create
-  a corresponding matestack example_page, a controller, its action
-  and the route in 'config/routes.rb'.
-
-Example 1:
-  `rails generate matestack:app example_app`
-
-  This will create:
-    app/matestack/apps/example_app.rb
-
-Example 2:
-  `rails generate matestack:app example_app --all_inclusive`
-
-  This will create:
-    app/matestack/apps/example_app.rb
-    app/matestack/pages/example_app/example_page.rb
-    app/controllers/example_app_controller.rb
-    route  get 'example_app/example_page', to: 'example_app#example_page'

data/lib/generators/matestack/app/app_generator.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Matestack
-  module Generators
-    class AppGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path('templates', __dir__)
-
-      class_option :all_inclusive, type: :boolean, default: false
-
-      def create_app
-        template 'app/matestack/apps/%file_name%.rb.tt'
-
-        if options[:all_inclusive] == true
-          template 'app/controllers/%file_name%_controller.rb'
-
-          route %{get '#{file_name}/example_page', to: '#{file_name}\#example_page'}
-
-          generate "matestack:page example_page --app_name #{file_name} --called_by_app_generator=true"
-
-          puts "You can visit your new matestack apps' example page under http://localhost:3000/#{file_name}/example_page"
-        end
-      end
-    end
-  end
-end

data/lib/generators/matestack/app/templates/app/controllers/%file_name%_controller.rb.tt

@@ -1,5 +0,0 @@
-class <%= class_name %>Controller < ApplicationController
-  def example_page
-    responder_for(Pages::<%= class_name %>::ExamplePage)
-  end
-end

data/lib/generators/matestack/app/templates/app/matestack/apps/%file_name%.rb.tt

@@ -1,28 +0,0 @@
-class Apps::<%= class_name %> < Matestack::Ui::App
-  # OPTIONAL: Prepare data that gets used on every page of this app
-  # def prepare
-  #   API calls and db queries go here
-  # end
-
-  # MANDATORY: This is where your matestack pages get yielded
-  def response
-    components {
-      heading text: 'Welcome to your <%= class_name %> app'
-      page_content
-    }
-  end
-
-  # OPTIONAL: Use partials to render stuff like layout components
-  # def partial_example
-  #   partial {
-  #     # your components go here
-  #   }
-  # end
-
-  # OPTIONAL: Slots come after partials
-  # def slot_example
-  #   slot {
-  #     # your components go here
-  #   }
-  # end
-end

data/lib/generators/matestack/component/USAGE

@@ -1,20 +0,0 @@
-Description:
-  Stubs out a new matestack component. Pass the component name, under_scored.
-
-  To create a dynamic component, specify it using the --dynamic option.
-
-  To place this component within a namespace, specify the namespace name under_scored and it
-  will get generated into 'app/matestack/components/namespace/*'.
-
-Example 1:
-  `rails generate matestack:component NAME`
-
-  This will create:
-    app/matestack/components/NAME.rb
-
-Example 2:
-  `rails generate matestack:component NAME --dynamic --namespace sample_namespace`
-
-  This will create:
-    app/matestack/components/sample_namespace/NAME.rb
-    app/matestack/components/sample_namespace/NAME.js

data/lib/generators/matestack/component/component_generator.rb

@@ -1,29 +0,0 @@
-module Matestack
-  module Generators
-    class ComponentGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path('templates', __dir__)
-
-      class_option :dynamic, type: :boolean, default: false
-      class_option :scss, type: :boolean, default: false
-      class_option :haml, type: :boolean, default: false
-      class_option :namespace, type: :string
-
-      def namespace
-        options[:namespace]
-      end
-
-      def dynamic
-        options[:dynamic]
-      end
-
-      def create_component
-        # Future: Check for matestack-compatible namespacing!
-
-        template 'app/matestack/components/%namespace%/%file_name%.rb.tt'
-        template 'app/matestack/components/%namespace%/%file_name%.js.tt' if options[:dynamic]
-        template 'app/matestack/components/%namespace%/%file_name%.scss.tt' if options[:scss]
-        template 'app/matestack/components/%namespace%/%file_name%.haml.tt' if options[:haml]
-      end
-    end
-  end
-end

data/lib/generators/matestack/component/templates/app/matestack/components/%namespace%/%file_name%.haml.tt

@@ -1,5 +0,0 @@
-.<%= file_name %>{@tag_attributes}
-  %div
-    This is your custom <%= class_name %> component
-  - if block_given?
-    = yield

data/lib/generators/matestack/component/templates/app/matestack/components/%namespace%/%file_name%.js.tt

@@ -1,17 +0,0 @@
-// Require your custom component in your application.js before usage
-// Place it below "//= require matestack-ui-core" using the following line:
-//= require <% unless namespace.nil? %><%= namespace %>/<% end %><%= file_name %>
-
-MatestackUiCore.Vue.component('custom<% unless namespace.nil? %>-<%= namespace %><% end %>-<%= file_name %>', {
-  mixins: [MatestackUiCore.componentMixin],
-  data: function() {
-    return {
-      foo: 'bar'
-    };
-  },
-  methods: {},
-  mounted: function(){
-    // this is your completeness check and should be deleted before deployment
-    console.log('Custom Dynamic Component <%= class_name %> mounted!')
-  }
-});

data/lib/generators/matestack/component/templates/app/matestack/components/%namespace%/%file_name%.rb.tt

@@ -1,11 +0,0 @@
-class Components::<% unless namespace.nil? %><%= namespace.camelize %>::<% end %><%= class_name %> < Matestack::Ui::<% if dynamic == true %>DynamicComponent<% else %>StaticComponent<% end %>
-  def prepare
-    # DB queries and API calls go here
-  end
-
-  def response
-    components {
-      # orchestrate existing matestack components here
-    }
-  end
-end

data/lib/generators/matestack/component/templates/app/matestack/components/%namespace%/%file_name%.scss.tt

@@ -1 +0,0 @@
-// your styles for the component <%= class_name %> go here

data/lib/generators/matestack/core/component/USAGE

@@ -1,16 +0,0 @@
-Description:
-  This generates a matestack core component in app/concepts/matestack, a spec file and a docs file.
-
-  Pass the name of the component under_scored.
-
-Example 1:
-  `rails generate matestack:core:component NAME`
-
-  This will create:
-    app/concepts/matestack/ui/core/NAME/NAME.haml
-    app/concepts/matestack/ui/core/NAME/NAME.rb
-    spec/usage/components/NAME_spec.rb
-    docs/components/NAME.md
-
-  This will insert a link to the docs in:
-    docs/components/README.md