matestack-ui-core 2.0.0 → 3.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a187da8c82641bf2c77bbb1b4a43b0b7e474d5870435ac1163cc28d09575ca48
-  data.tar.gz: 4337c9c2a671b9597fda5b88992bde5dffd89f945719f8e19991802bd98a23fa
+  metadata.gz: bca440b8da1782dde2827f08cef9915e72b715d5b9e08b1d89c1e1d816bf5d01
+  data.tar.gz: a8489ec244c77cc02c6b7bb4549ee8cd009a7d6a805ce00c032efd3306aa26ca
 SHA512:
-  metadata.gz: 46cb76c518e3146058dd8b27bc20e4699196d1321abfa3fa019a0809e3b7c62b46769a286300620848a465cbdcfd04607be1dbe6e7a99930490c80980031dcd3
-  data.tar.gz: f393f4268fb80477eacd18d117555cb605782f24ce6c5cf6aa4aa74c518ca94a9897ebd1bb1ed4b7edc4d81ac9d3f2d707ff3345462f0a77ec3b6a15646a4296
+  metadata.gz: 6e65668a7af15e0c358ac8d8e22d6e2defc0129467296ab56d9664145b75a564b6b9d3b33b9df84f5f784854d63da721f450b15575839dcab1a82b68c712f611
+  data.tar.gz: eba2e0d427f917bdf201755c01a4a8ef842f5be0e50fa19a0c9cc7d59b56ae33203b820500e16b6a645d98adad8a8cc50fdfc103614de13421c105cce10fc47c

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) Matestack GmbH
+Copyright (c) MateLab GmbH
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -6,44 +6,18 @@
 
 ![matestack logo](./logo.png)
 
-# matestack-ui-core | UI in pure Ruby
-
-----
-Version 2.0.0 was released on the 12th of April and proudly presented at RailsConf. Click here for more details
-
-Most important changes:
-
-- Changed to MIT License
-- 5 to 12 times better rendering performance (depending on the context)
-- Removed Trailblazer dependency
-- Improved core code readability/maintainability
-----
+# matestack-ui-core | Component based web UIs in pure Ruby for Rails
 
 Boost your productivity & easily create component based web UIs in pure Ruby.
-Reactivity included if desired.
-
-`matestack-ui-core` enables you to craft maintainable web UIs in pure Ruby, skipping ERB and HTML. UI code becomes a native and fun part of your Rails app. Thanks to reactive core components, reactivity can be optionally added on top without writing JavaScript, just using a simple Ruby DSL.
-
-You end up writing 50% less code while increasing productivity, maintainability and developer happiness. Work with pure Ruby. If necessary, extend with pure JavaScript. No Opal involved.
-
-[<img src="https://img.youtube.com/vi/Mue5gs6Wtq4/0.jpg" width="350">](https://www.youtube.com/watch?v=Mue5gs6Wtq4)
-
-The main goals are:
-
-- More maintainable UI code, using a component-based structure written in Ruby
-- Increased development speed and happiness, offering prebuilt UI-Components for typical requirements
-- Modern, dynamic UI feeling without the need to implement a separate JavaScript Application
 
-`matestack-ui-core` can progressively replace the classic Rails-View-Layer. You are able to use
-it alongside your classic views and incrementally turn your Rails-App into a
-dynamic Web-App.
+`matestack-ui-core` enables you to craft maintainable web UIs in pure Ruby, skipping ERB and HTML. UI code becomes a native and fun part of your Rails app. `matestack-ui-core` can progressively replace the classic Rails-View-Layer. You are able to use
+it alongside your classic views.
 
 ## Compatibility
 
-### Ruby/Rails
-
 `matestack-ui-core` is tested against:
 
+- Rails 7.0.1 + Ruby 3.0.0
 - Rails 6.1.1 + Ruby 3.0.0
 - Rails 6.1.1 + Ruby 2.7.2
 - Rails 6.0.3.4 + Ruby 2.6.6
@@ -51,22 +25,13 @@ dynamic Web-App.
 
 Rails versions below 5.2 are not supported.
 
-### Vue.js
-
-`matestack-ui-core` optionally requires Vue.js and Vuex for its reactivity features. Following version ranges are supported:
-
-- Vue.js ^2.6.0
-- Vuex ^3.6.0
-
-Vue 3 / Vuex 4 update is planned for Q2 2021.
-
 ## Documentation/Installation
 
-Documentation can be found [here](https://docs.matestack.io)
+Documentation can be found [here](https://docs.matestack.io/matestack-ui-core)
 
 ## Getting started
 
-A getting started guide can be found [here](https://docs.matestack.io/getting-started/tutorial)
+A getting started guide can be found [here](https://docs.matestack.io/matestack-ui-core/getting-started/hello-world)
 
 ## Changelog
 
@@ -80,11 +45,7 @@ As a low-barrier feedback channel for our early users, we have set up a Discord
 
 We are happy to accept contributors of any kind! In order to make it as easy and fun as possible to contribute to `matestack-ui-core`, we would like to onboard contributors personally! Best way to become a contributor: Ping us on Discord! We will schedule a video call with you and show you, how and what to work on :)
 
-Here are some good first issues for first time contributors: [good first issues](https://github.com/matestack/matestack-ui-core/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue")
-
-## Features
-
-On our [landingpage](https://www.matestack.io), we're presenting the following features alongside some live demos!
+## Feature walk-through
 
 ### 1. Create UI components in pure Ruby
 
@@ -128,7 +89,7 @@ Components can be then called on Rails views (not only! see below), enabling you
 ```erb
 
 <!-- some other erb markup -->
-<%= Components::Card.(title: "hello", body: "world") %>
+<%= Components::Card.call(title: "hello", body: "world") %>
 <!-- some other erb markup -->
 
 ```
@@ -167,7 +128,7 @@ class Components::Card < Matestack::Ui::Component
 
   def card_footer
     div class: "card-footer text-muted" do
-      plain footer
+      plain context.footer
     end
   end
 
@@ -179,7 +140,7 @@ end
 
 ```erb
 <!-- some other erb markup -->
-<%= Components::Card.(title: "hello", body: "world", footer: "foo") %>
+<%= Components::Card.call(title: "hello", body: "world", footer: "foo") %>
 <!-- some other erb markup -->
 ```
 
@@ -199,7 +160,7 @@ class Components::BlueCard < Components::Card
     div class: "card shadow-sm border-0 bg-primary text-white" do
       img path: context.image, class: "w-100" if context.image.present?
       card_content #defined in parent class
-      card_footer if footer.present? #defined in parent class
+      card_footer if context.footer.present? #defined in parent class
     end
   end
 
@@ -211,7 +172,7 @@ end
 
 ```erb
 <!-- some other erb markup -->
-<%= Components::BlueCard.(title: "hello", body: "world") %>
+<%= Components::BlueCard.call(title: "hello", body: "world") %>
 <!-- some other erb markup -->
 ```
 
@@ -234,7 +195,7 @@ class Components::Card < Matestack::Ui::Component
     div class: "card shadow-sm border-0 bg-light" do
       img path: context.image, class: "w-100" if context.image.present?
       # calling the CardBody component rather than using Ruby method partials
-      Components::CardBody.(title: context.title, body: context.body)
+      Components::CardBody.call(title: context.title, body: context.body)
     end
   end
 
@@ -283,7 +244,7 @@ class Components::Card < Matestack::Ui::Component
   def response
     div class: "card shadow-sm border-0 bg-light" do
       img path: context.image, class: "w-100" if context.image.present?
-      Components::CardBody.() do
+      Components::CardBody.call() do
         # yielding a block into the card_body component
         h5 context.title if context.title.present?
         paragraph context.body, class: "card-body"
@@ -331,7 +292,7 @@ class Components::Card < Matestack::Ui::Component
   def response
     div class: "card shadow-sm border-0 bg-light" do
       img path: context.image, class: "w-100" if context.image.present?
-      Components::CardBody.(slots: {
+      Components::CardBody.call(slots: {
         heading: method(:heading_slot),
         body: method(:body_slot)
       })
@@ -374,430 +335,6 @@ end
 
 ```
 
-
-### 2. Use reactive UI components in pure Ruby
-
-What about going even one step further and implement REACTIVE UIs in pure Ruby? Matestack's reactive core components can be used with a simple Ruby DSL enabling you to create reactive UIs without touching JavaScript!    
-
-#### Toggle parts of the UI based on events
-
-Matestack offers an event hub. Reactive components can emit and receive events through this event hub. \"onclick\" and \"toggle\" calling two of these reactive core components.
-\"onclick\" emits an event which causes the body of the \"toggle\" component to be visible for 5 seconds in this example.
-
-`app/matestack/components/some_component.rb`
-
-```ruby
-
-class Components::SomeComponent < Matestack::Ui::Component
-
-  def response
-    onclick emit: "some_event" do
-      button "click me"
-    end
-    toggle show_on: "some_event", hide_after: 5000 do
-      plain "Oh yes! You clicked me!"
-    end
-  end
-
-end
-
-```
-
-#### Call controller actions without JavaScript
-
-Core components offer basic dynamic behaviour and let you easily call controller actions and react to server responses on the client side without full page reload.
-The \"action\" component is configured to emit an event after successfully performed an HTTP request against a Rails controller action, which is receive by the \"toggle\" component, displaying the success message.
-
-`app/matestack/components/some_component.rb`
-
-```ruby
-
-class Components::SomeComponent < Matestack::Ui::Component
-
-  def response
-    action my_action_config do
-      button "click me"
-    end
-    toggle show_on: "some_event", hide_after: 5000 do
-      plain "Success!"
-    end
-  end
-
-  def my_action_config
-    {
-      path: some_rails_route_path,
-      method: :post,
-      success: {
-        emit: "some_event"
-      }
-    }
-  end
-
-end
-
-```
-
-
-### Dynamically handle form input without JavaScript
-
-Create dynamic forms for ActiveRecord Models (or plain objects) and display server side responses, like validation errors or success messages, without relying on a full page reload.
-Events emitted by the \"form\" component can be used to toggle parts of the UI.
-
-`app/matestack/components/some_component.rb`
-
-```ruby
-
-class Components::SomeComponent < Matestack::Ui::Component
-
-  def response
-    matestack_form my_form_config do
-      form_input key: :some_attribute, type: :text
-      button "click me", type: :submit
-    end
-    toggle show_on: "submitted", hide_after: 5000 do
-      span class: "message success" do
-        plain "created successfully"
-      end
-    end
-    toggle show_on: "failed", hide_after: 5000 do
-      span class: "message failure" do
-        plain "data was not saved, please check form"
-      end
-    end
-  end
-
-  def my_form_config
-    {
-      for: MyActiveRecordModel.new,
-      path: some_rails_route_path,
-      method: :post,
-      success: {
-        emit: "submitted"
-      },
-      failure: {
-        emit: "failed"
-      }
-    }
-  end
-
-end
-
-```
-
-#### Implement asynchronous, event-based UI rerendering in pure Ruby
-
-Using Matestack's built-in event system, you can rerender parts of the UI on client side events, such as form or action submissions. Even server side events pushed via ActionCable may be received!
-The \"async\" component requests a new version of its body at the server via an HTTP GET request after receiving the configured event. After successfu server response, the DOM of the \"async\" component gets updated. Everything else stays untouched.
-
-`app/matestack/components/some_component.rb`
-
-```ruby
-
-class Components::SomeComponent < Matestack::Ui::Component
-
-  def response
-    matestack_form my_form_config do
-      #...
-    end
-    #...
-    async rerender_on: "submitted", id: "my-model-list" do
-      ul do
-        MyActiveRecordModel.last(5).each do |model|
-          li model.some_attribute
-        end
-      end
-    end
-  end
-
-  def my_form_config
-    {
-      #...
-      success: {
-        emit: "submitted"
-      },
-      failure: {
-        emit: "failed"
-      }
-    }
-  end
-
-end
-
-```
-
-#### Manipulate parts of the UI via ActionCable
-
-\"async\" rerenders its whole body - but what about just appending the element to the list after successful form submission?
-The \"cable\" component can be configured to receive events and data pushed via ActionCable from the server side and just append/prepend new chunks of HTM (ideally rendered through a component) to the current \"cable\" component body. Updating and deleting is also supported!
-
-`app/matestack/components/some_component.rb`
-
-```ruby
-
-class Components::SomeComponent < Matestack::Ui::Component
-
-  def response
-    matestack_form my_form_config do
-      #...
-    end
-    #...
-    ul do
-      cable prepend_on: "new_element_created", id: "mocked-instance-list" do
-        MyActiveRecordModel.last(5).each do |model|
-          li model
-        end
-      end
-    end
-  end
-
-end
-
-```
-
-`app/controllers/some_controller.rb`
-
-```ruby
-# within your controller action handling the form input
-ActionCable.server.broadcast("matestack_ui_core", {
-  event: "new_element_created",
-  data: "<li>foo</li>" # or better: calling a component here
-})
-
-```
-
-#### Easily extend with Vue.js
-
-Matestack's dynamic parts are built on Vue.js. If you want to implement custom dynamic behaviour, you can simply create your own Vue components and use them along matestacks core components.
-It's even possible to interact with matestack's core components using the built-in event bus.
-
-`app/matestack/components/some_component.rb`
-
-```ruby
-
-class Components::SomeComponent < Matestack::Ui::Component
-
-  def response
-    my_vue_js_component
-    toggle show_on: "some_event", hide_after: "3000" do
-      span class: "message success" do
-        plain "event triggered from custom vuejs component"
-      end
-    end
-  end
-
-end
-
-```
-`app/matestack/components/my_vue_js_component.rb`
-
-```ruby
-class Components::MyVueJsComponent < Matestack::Ui::VueJsComponent
-
-  vue_name "my-vue-js-component"
-
-  def response
-    div class: "my-vue-js-component" do
-      button "@click": "increaseValue"
-      br
-      plain "{{ dynamicValue }}!"
-    end
-  end
-
-end
-```
-
-`app/matestack/components/my_vue_js_component.js`
-
-```javascript
-Vue.component('my-vue-js-component', {
-  mixins: [MatestackUiCore.componentMixin],
-  data: () => {
-    return {
-      dynamicValue: 0
-    };
-  },
-  methods: {
-    increaseValue(){
-      this.dynamicValue++
-      MatestackUiCore.eventHub.$emit("some_event")
-    }
-  }
-});
-```
-
-### 3. Create whole SPA-like apps in pure Ruby
-
-The last step in order to leverage the full Matestack power: Create app (~Rails layout) and page (Rails ~view) classes and implement dynamic page transitions without any JavaScript implementation required.
-
-#### Create your layouts and views in pure Ruby
-
-The app class is used to define a layout, usually containing some kind of header, footer and navigation. The page class is used to define a view. Following the same principles as seen on components, you can use components (core or your own) in order to create the UI.
-The \"transition\" component enables dynamic page transition, replacing the content within \"yield_page\" with new serverside rendered content.
-
-`app/matestack/some_app/app.rb`
-
-```ruby
-
-class SomeApp::App < Matestack::Ui::App
-
-  def response
-    nav do
-      transition path: page1_path do
-        button "Page 1"
-      end
-      transition path: page2_path do
-        button "Page 2"
-      end
-    end
-    main do
-      div class: "container" do
-        yield
-      end
-    end
-  end
-
-end
-
-```
-
-`app/matestack/some_app/pages/page1.rb`
-
-```ruby
-class SomeApp::Pages::Page1 < Matestack::Ui::Page
-
-  def response
-    div class: "row" do
-      div class: "col" do
-        plain "Page 1"
-      end
-    end
-  end
-
-end
-
-```
-
-`app/matestack/some_app/pages/page2.rb`
-
-```ruby
-class SomeApp::Pages::Page2 < Matestack::Ui::Page
-
-  def response
-    div class: "row" do
-      div class: "col" do
-        plain "Page 2"
-      end
-    end
-  end
-
-end
-
-```
-
-#### Apps and pages are referenced in your Rails controllers and actions
-
-Instead of referencing Rails layouts and views on your controllers, you just use apps and pages as substitutes.
-Work with controllers, actions and routing as you're used to! Controller hooks (e.g. devise's authenticate_user) would still work!
-
-`app/controllers/some_controller.rb`
-
-```ruby
-
-class SomeController < ApplicationController
-
-  include Matestack::Ui::Core::Helper
-
-  matestack_app SomeApp::App
-
-  def page1
-    render SomeApp::Page1
-  end
-
-  def page2
-    render SomeApp::Page2
-  end
-
-end
-
-```
-
-`app/config/routes.rb`
-
-```ruby
-Rails.application.routes.draw do
-
-  root to: 'some#page1'
-
-  get :page1, to: 'some#page1'
-  get :page2, to: 'some#page2'
-
-end
-
-```
-
-#### Use CSS animations for fancy page transition animations
-
-Use matestack's css classes applied to the wrapping DOM structure of a page in order to add CSS animiations, whenever a page transition is performed."
-You can even inject a loading state element, enriching your page transition effect.
-
-`app/matestack/some_app/app.rb`
-
-```ruby
-
-class SomeApp::App < Matestack::Ui::App
-
-  def response
-    nav do
-      transition path: page1_path do
-        button "Page 1"
-      end
-      transition path: page2_path do
-        button "Page 2"
-      end
-    end
-    main do
-      div class: "container" do
-        yield
-      end
-    end
-  end
-
-  def loading_state_element
-    div class: 'some-loading-element-styles'
-  end
-
-end
-
-```
-
-`app/assets/stylesheets/application.scss`
-
-```scss
-
-.matestack-page-container{
-
-  .matestack-page-wrapper {
-    opacity: 1;
-    transition: opacity 0.2s ease-in-out;
-
-    &.loading {
-      opacity: 0;
-    }
-  }
-
-  .loading-state-element-wrapper{
-    opacity: 0;
-    transition: opacity 0.3s ease-in-out;
-
-    &.loading {
-      opacity: 1;
-    }
-  }
-
-}
-
-```
-
 ## License
 
 `matestack-ui-core` is an Open Source project licensed under the terms of the [MIT license](./LICENSE)

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

@@ -12,7 +12,13 @@ module Matestack
         attr_accessor :html_tag, :text, :options, :parent, :escape, :bind_to_parent
 
         def initialize(html_tag = nil, text = nil, options = {}, &block)
-          self.bind_to_parent = ([:without_parent].include?(html_tag) ? false : true)
+          return unless render?
+
+          if options && options[:detach_from_parent] == true
+            self.bind_to_parent = false
+          else
+            self.bind_to_parent = ([:without_parent].include?(html_tag) ? false : true)
+          end
           self.slots = self.options.delete(:slots) if self.options
           # extract_options(text, options) is called in properties
           self.html_tag = html_tag if self.bind_to_parent
@@ -26,6 +32,12 @@ module Matestack
           self
         end
 
+        # can be optionally overwritten in subclass
+        # in order to conditionally render the component
+        def render?
+          true
+        end
+
         # check if text is given and set text and options accordingly
         def extract_options(text, options)
           if text.is_a? Hash
@@ -92,16 +104,21 @@ module Matestack
           end
         end
 
-        def method_missing(name, *args, &block)
-          return view_context.send(name, *args, &block) if view_context && view_context.respond_to?(name, true)
-          return Rails.application.routes.url_helpers.send(name, *args, &block) if Rails.application.routes.url_helpers.respond_to?(name, true)
+        def method_missing(name, *args, **kwargs, &block)
+          if view_context && view_context.respond_to?(name, true)
+            view_context_response = view_context.send(name, *args, **kwargs, &block)
+            return view_context_response
+          end
+          if Rails.application.routes.url_helpers.respond_to?(name, true)
+            return Rails.application.routes.url_helpers.send(name, *args, &block)
+          end
           return raise NameError, "#{name} is not defined for #{self.class}", caller
         end
 
-        # give easy access to vue data attributes
-        def vue
-          Matestack::Ui::Core::VueAttributes
+        def to_str
+          render_content
         end
+        alias to_s to_str
 
       end
     end

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

@@ -3,7 +3,7 @@ module Matestack
     module Core
       class Context < ActiveSupport::CurrentAttributes
 
-        attribute :app
+        attribute :layout
         attribute :parent
         attribute :isolated_parent
         attribute :params
@@ -14,4 +14,4 @@ module Matestack
       end
     end
   end
-end
+end