matestack-ui-core 0.7.0 → 0.7.4

data/app/javascript/packs/matestack-ui-core.js

@@ -0,0 +1,8 @@
+// // Add polyfills for the asset pipeline
+// // https://github.com/matestack/matestack-ui-core/issues/238#issuecomment-583905838
+//
+// import 'core-js/stable'
+// import 'regenerator-runtime/runtime'
+
+import '../matestack-ui-core/index'
+export default MatestackUiCore

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

@@ -13,15 +13,19 @@ module Matestack::Ui::Core
       @hash = {}
       @node_start_id = 0
       @component_instance = component_instance
-      @included_config = included_config
       component_instance.instance_variables.each do |component_instance_var_key|
         self.instance_variable_set(component_instance_var_key, component_instance.instance_variable_get(component_instance_var_key))
       end
+      @included_config = included_config
     end
 
     def method_missing meth, *args, &block
       begin
-        @component_instance.send(meth, *args, &block)
+        if (result = @component_instance.send(meth, *args, &block)).kind_of? ActiveSupport::SafeBuffer
+          plain result
+        else
+          result
+        end
       rescue
         node_id = @node_start_id + 1
         @node_start_id = node_id
@@ -32,6 +36,20 @@ module Matestack::Ui::Core
         @hash[current_node]["argument"] = nil
         @hash[current_node]["included_config"] = @included_config
 
+        if args.second == :include
+          included = args.first
+        else
+          unless @included_config.nil?
+            included = @included_config
+          else
+            included = nil
+          end
+        end
+
+        if meth == :isolate
+          raise("isolate > only works on page level currently. component support is comming soon!")
+        end
+
         if meth == :partial
           @hash[current_node]["components"] = @component_instance.send(args.first, *args.drop(1))
         elsif meth == :yield_components
@@ -39,20 +57,20 @@ module Matestack::Ui::Core
           @hash[current_node]["components"] = @component_instance.send(:get_children)
         else
           if args.first.is_a?(Hash)
-            @hash[current_node]["config"] = args.first
+            @hash[current_node]["config"] = args.first unless meth == :slot
           else
             @hash[current_node]["argument"] = args.first
           end
 
-          if args.second == :include
-            included = args.first
-          else
-            unless @included_config.nil?
-              included = @included_config
-            else
-              included = nil
-            end
-          end
+          # if args.second == :include
+          #   included = args.first
+          # else
+          #   unless @included_config.nil?
+          #     included = @included_config
+          #   else
+          #     included = nil
+          #   end
+          # end
 
           if block_given?
             @hash[current_node]["components"] = ComponentNode.build(@component_instance, included, &block)

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

@@ -0,0 +1,10 @@
+module Matestack::Ui::Core::HasViewContext
+  def initialize(model = nil, options = {})
+    @view_context = options[:context][:view_context]
+    super
+  end
+
+  def method_missing(*args, &block)
+    @view_context.send(*args, &block)
+  end
+end

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

@@ -1,18 +1,19 @@
 module Matestack::Ui::Core
   class PageNode
 
-    def self.build(page_instance, included_config, &block)
-      node = PageNode.new(page_instance, included_config)
+    def self.build(page_instance, included_config, url_params, &block)
+      node = PageNode.new(page_instance, included_config, url_params)
       node.instance_eval(&block)
       node.hash
     end
 
     attr_reader :hash
 
-    def initialize(page_instance, included_config)
+    def initialize(page_instance, included_config, url_params)
       @hash = {}
       @node_start_id = 0
       @included_config = included_config
+      @url_params = url_params
       @page_instance = page_instance
       page_instance.instance_variables.each do |page_instance_var_key|
         self.instance_variable_set(page_instance_var_key, page_instance.instance_variable_get(page_instance_var_key))
@@ -21,7 +22,11 @@ module Matestack::Ui::Core
 
     def method_missing meth, *args, &block
       begin
-        @page_instance.send(meth, *args, &block)
+        if (result = @page_instance.send(meth, *args, &block)).kind_of? ActiveSupport::SafeBuffer
+          plain result
+        else
+          result
+        end
       rescue
         node_id = @node_start_id + 1
         @node_start_id = node_id
@@ -42,10 +47,31 @@ module Matestack::Ui::Core
           end
         end
 
+        if meth == :isolate
+          if args.second.present?
+            if args.second.is_a? Hash
+              if args.second[:cached_params].nil?
+                raise "isolate > you need to pass params within a hash called 'cached_params'"
+              else
+                isolated_block = @page_instance.send(args.first, args.second[:cached_params])
+              end
+            else
+              raise "isolate > you need to pass params within a hash called 'cached_params'"
+            end
+          else
+            isolated_block = @page_instance.send(args.first)
+          end
+          @hash[current_node]["components"] = PageNode.build(
+            @page_instance, nil, @url_params, &isolated_block
+          )
+          @hash[current_node]["argument"] = args.first
+          @hash[current_node]["cached_params"] = args.second[:cached_params] if args.second.present?
+        end
+
         if meth == :partial
           partial_block = @page_instance.send(args.first, *args.drop(1))
           @hash[current_node]["components"] = PageNode.build(
-            @page_instance, included, &partial_block
+            @page_instance, included, @url_params, &partial_block
           )
         else
           if args.first.is_a?(Hash)
@@ -55,7 +81,15 @@ module Matestack::Ui::Core
           end
 
           if block_given?
-            @hash[current_node]["components"] = PageNode.build(@page_instance, included, &block)
+            if args.first.is_a?(Hash) && args.first[:defer].present?
+              if @url_params.present? && @url_params[:component_key].present?
+                @hash[current_node]["components"] = PageNode.build(@page_instance, included, @url_params, &block)
+              else
+                return
+              end
+            else
+              @hash[current_node]["components"] = PageNode.build(@page_instance, included, @url_params, &block)
+            end
           end
         end
       end

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

@@ -0,0 +1,89 @@
+module Matestack::Ui::Core::Render
+
+  # Matestack allows you to use `render` to render matestack pages.
+  #
+  #     render Pages::Member::Bookings::Index
+  #     render matestack: Pages::Member::Bookings::Index
+  #     render matestack: 'member/bookings/index'
+  #
+  def render(*args)
+    if (matestack_class = args.first).is_a?(Class) && (matestack_class < Matestack::Ui::Page)
+      responder_for matestack_class
+    elsif (options = args.first).kind_of?(Hash) && (matestack_arg = options[:matestack]).present?
+      if (matestack_path = matestack_arg).kind_of? String
+        matestack_path = "pages/#{matestack_path}" unless matestack_path.start_with?("pages/") or matestack_path.start_with?("components/")
+        matestack_class = matestack_path.split("/").collect { |str| str.camelcase }.join("::").constantize
+      elsif matestack_arg.is_a?(Class) && (matestack_arg < Matestack::Ui::Page)
+        matestack_class = matestack_arg
+      end
+      responder_for matestack_class
+    else
+      super
+    end
+  end
+
+  # Matestack allows implicit rendering. The matestack page class name is inferred from the
+  # controller path and action name.
+  #
+  #     class Clients::BookingsController < ApplicationController
+  #       def index
+  #         @bookings = Booking.all
+  #         # looks for Pages::Clients::Bookings::Index
+  #       end
+  #
+  #       def show
+  #         @booking = Booking.find params[:id]
+  #         # looks for Pages::Clients::Bookings::Show
+  #       end
+  #     end
+  #
+  # In this example, `clients/bookings#index` will render `Pages::Clients::Bookings::Index`,
+  # `clients/bookings#show` will render `Pages::Clients::Bookings::Show`.
+  #
+  # Custom action names translate also into page names.
+  #
+  #     class Clients::BookingsController < ApplicationController
+  #       def step1
+  #         # looks for Pages::Clients::Bookings::Step1
+  #       end
+  #     end
+  #
+  # In this example, the `clients/bookings#step1` action will render
+  # `Pages::Clients::Bookings::Step1`.
+  #
+  def default_render(*args)
+    if matestack_page_class = default_render_matestack_page_class
+      render matestack: matestack_page_class
+    else
+      super
+    end
+  end
+
+  def possible_default_render_matestack_page_paths
+    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
+
+  def possible_default_render_matestack_page_class_names
+    possible_default_render_matestack_page_paths.collect { |page_path|
+      page_path.split("/").collect { |str| str.camelcase }.join("::")
+    }
+  end
+
+  def default_render_matestack_page_class
+    possible_default_render_matestack_page_class_names.each do |class_name|
+      begin
+        return matestack_class = class_name.constantize
+      rescue NameError
+      end
+    end
+    return nil
+  end
+
+end

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

@@ -1,6 +1,7 @@
 module Matestack::Ui::Core::ToCell
 
-  def to_cell(key, component_name, config, argument, children, included_config)
+  def to_cell(key, component_name, config, argument, children, included_config, cached_params=nil)
+    # p cached_params
     request_uri = context[:request].env["REQUEST_URI"]
     query_string = context[:request].env["QUERY_STRING"]
 
@@ -9,6 +10,7 @@ module Matestack::Ui::Core::ToCell
     config.merge!(origin_url: request_uri.gsub("?" + query_string, ""))
     config.merge!(url_params: context[:params])
     config.merge!(included_config: included_config)
+    config.merge!(cached_params: cached_params)
 
     if component_name.start_with?("custom")
       return resolve_custom_component(component_name, argument, config)

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

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

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

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

data/config/routes.rb

@@ -1,3 +1,2 @@
 Matestack::Ui::Core::Engine.routes.draw do
-  get '/div', to: 'docs#div'
 end

data/lib/generators/matestack/app/USAGE

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

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

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

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

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

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

@@ -0,0 +1,5 @@
+.<%= 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

@@ -0,0 +1,17 @@
+// 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!')
+  }
+});