Merge pull request #372 from matestack/prepare_0.7.4_release

Prepare 0.7.4 release

Author: jonasjabari

CHANGELOG.md

@@ -1,5 +1,64 @@
 # Changelog
 
+## v0.7.4
+
+[Merged PRs](https://github.com/basemate/matestack-ui-core/pulls?q=is%3Apr+is%3Aclosed+milestone%3A0.7.4)
+
+[Solved Issues](https://github.com/basemate/matestack-ui-core/issues?q=is%3Aissue+is%3Aclosed+milestone%3A0.7.4)
+
+### Improvements
+
+* On form submit, matestack form values are reset to previous values by fiedl
+--> The form component now does not reset itself when using `put`
+--> The reset behavior can now be configured (described in `form` component docs)
+
+* Dockerized core dev and test environment by jonasjabari
+--> easy local dev and test setup, cross-platform default for dev and testing
+--> CI is configured to run tests via dockerized test suite; same as local testing and good base for matrix testing (upcoming)
+--> Usage described in contribution docs
+
+* Add `follow_response` option to action component by fiedl
+--> same behavior enhancement as added to the `form` component in 0.7.3
+--> server may now decide where the transition should navigate to
+--> described in `action` component docs
+
+* Add confirm option to action component by fiedl
+--> easily add confirmation before performing an action
+--> prevent unintended delete action for example
+--> described in `action` component docs
+
+* New webpacker features by fiedl
+  * make webpacker create es5 code instead of es6 code
+  * Switch to Vue Production Mode if RAILS_ENV=staging or production
+  * Establish webpack(er) and asset-pipeline workflows
+
+--> webpacker now builds assets for asset pipline usage AND webpacker usage (both usage approaches are described in the installation docs)
+--> webpacker now builds minified versions of matestack-ui-core.js (great improvement in file size!)
+--> webpacker now builds es5 code, which is compatible with IE11
+--> when used via asset pipeline, the minified version of matestack-ui-core together with the production build of vue.js is automatically required
+--> when used via webpacker, matestack-ui-core can be used within a modern javascript workflow, importing and extending single matestack module for example
+
+* New components
+  * Add HTML `<picture>` tag to core components by pascalwengerter
+  * Add HTML `<option>` tag to core components by pascalwengerter
+  * Add HTML `<optgroup>` tag to core components by pascalwengerter
+  * Add HTML `<iframe>` tag to core components by pascalwengerter 
+  * Add HTML `<dfn>` tag to core components by pascalwengerter 
+  * Add HTML `<del>` tag to core components by pascalwengerter
+  * Add HTML `<data>` tag to core components by pascalwengerter
+  * Add HTML `<bdo>` tag to core components by pascalwengerter
+  * Add HTML `<bdi>` tag to core components by pascalwengerter
+  * Add HTML `<wbr>` tag to core components by pascalwengerter
+  * Add HTML `<samp>` tag to core components by pascalwengerter
+  * Add HTML `<u>` tag to core components by pascalwengerter 
+  * Add HTML `<template>` tag to core components by pascalwengerter
+
+
+### Bugfixes
+
+* Anchor Link Click triggers full page transition by PragTob
+
+
 ## v0.7.3
 
 [Merged PRs](https://github.com/basemate/matestack-ui-core/pulls?q=is%3Apr+is%3Aclosed+milestone%3A0.7.3)

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

README.md

@@ -1,6 +1,7 @@
 ![](https://github.com/matestack/matestack-ui-core/workflows/specs/badge.svg)
 [![Gitter](https://badges.gitter.im/basemate/community.svg)](https://gitter.im/basemate/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 [![Gem Version](https://badge.fury.io/rb/matestack-ui-core.svg)](https://badge.fury.io/rb/matestack-ui-core)
+[![Docs](https://img.shields.io/badge/docs-matestack-blue.svg)](https://www.matestack.org/docs/install)
 
 ![matestack logo](./logo.png)
 
@@ -21,7 +22,7 @@ dynamic Web-App.
 
 ### Current State: 
 
-We love to see more and more people using and contributing to matestack-ui-core. Our current version is 0.7.3 and it's not perfect yet. We recommend you to start using matestack-ui-core in a side project and report issues as this helps us to push matestack-ui-core towards a production ready 1.0.0. At basemate, we already use matestack-ui-core in production as we know how to handle current issues and bypass them with deep insights of the core implementation. We plan to invest time and money (yes, we're hiring) on following improvements:
+We love to see more and more people using and contributing to matestack-ui-core. Our current version is 0.7.4 and it's not perfect yet. We recommend you to start using matestack-ui-core in a side project and report issues as this helps us to push matestack-ui-core towards a production ready 1.0.0. At matestack, we already use matestack-ui-core in production as we know how to handle current issues and bypass them with deep insights of the core implementation. We plan to invest time and money (yes, we're hiring) on following improvements:
 
 * debugging and error handling
 * core refactoring, increased core maintainability and code quality

app/concepts/matestack/ui/core/app/app.rb

@@ -1,7 +1,7 @@
 module Matestack::Ui::Core::App
   class App < Trailblazer::Cell
 
-    include ::Cell::Haml
+    include Matestack::Ui::Core::Cell
     include Matestack::Ui::Core::ApplicationHelper
     include Matestack::Ui::Core::ToCell
 

app/concepts/matestack/ui/core/component/dynamic.rb

@@ -1,7 +1,6 @@
 module Matestack::Ui::Core::Component
   class Dynamic < Trailblazer::Cell
-
-    include ::Cell::Haml
+    include Matestack::Ui::Core::Cell
     include Matestack::Ui::Core::ApplicationHelper
     include Matestack::Ui::Core::ToCell
     include Matestack::Ui::Core::HasViewContext

app/concepts/matestack/ui/core/page/page.rb

@@ -2,7 +2,7 @@ module Matestack::Ui::Core::Page
   class Page < Trailblazer::Cell
 
     include ActionView::Helpers::TranslationHelper
-    include ::Cell::Haml
+    include Matestack::Ui::Core::Cell
     include Matestack::Ui::Core::ApplicationHelper
     include Matestack::Ui::Core::ToCell
     include Matestack::Ui::Core::HasViewContext
@@ -94,7 +94,7 @@ def show(component_key=nil, only_page=false)
         begin
           render_child_component component_key
         rescue => e
-          raise "Component '#{component_key}' could not be resolved."
+          raise "Component '#{component_key}' could not be resolved, because of #{e},\n#{e.backtrace.join("\n")}"
         end
       end
     end

app/concepts/matestack/ui/core/plain/plain.rb

@@ -2,7 +2,7 @@ module Matestack::Ui::Core::Plain
   class Plain < Matestack::Ui::Core::Component::Static
 
     def show
-      @argument
+      html_escape @argument
     end
 
   end

app/concepts/matestack/ui/core/unescaped/unescaped.rb

@@ -0,0 +1,7 @@
+module Matestack::Ui::Core::Unescaped
+  class Unescaped < Matestack::Ui::Core::Component::Static
+    def show
+      @argument
+    end
+  end
+end

docs/components/async.md

@@ -54,7 +54,7 @@ end
 
 ### Hide_after
 
-The `hide_after` option lets us define a timespan after which the component gets hidden.
+The `hide_after` option lets us define a timespan in milliseconds after which the component gets hidden.
 
 ```ruby
 async hide_after: 1000 do
@@ -103,7 +103,7 @@ end
 ```
 
 #### delayed defer
-`defer: 2000` means that the content of the `async` component gets requested within a separate GET request `2000ms` after initial page load is done.
+`defer: 2000` means that the content of the `async` component gets requested within a separate GET request 2000 milliseconds after initial page load is done.
 ```ruby
 async defer: 2000 do
   div id: 'my-div' do
@@ -290,7 +290,7 @@ end
 
 ### Example 4: Hide after show on event
 
-On our example page, we wrap a simple timestamp in an async component and tell it to show up when the event `my_event` gets triggered and be hidden after 1000ms.
+On our example page, we wrap a simple timestamp in an async component and tell it to show up when the event `my_event` gets triggered and be hidden after 1000 milliseconds.
 
 ```ruby
 class ExamplePage < Matestack::Ui::Page

docs/components/plain.md

@@ -2,7 +2,7 @@
 
 Show [specs](/spec/usage/components/plain_spec.rb)
 
-This element simply renders the value of a variable (or simple a string) wherever you want it.
+This element simply renders the value of a variable (or simple a string) wherever you want it **escaping HTML tags** (`<` becomes `&lt;` etc.).
 
 ## Parameters
 

docs/components/rawhtml.md

@@ -0,0 +1,35 @@
+# matestack core component: Rawhtml
+
+Show [specs](/spec/usage/components/rawhtml_spec.rb)
+
+This element simply renders the value of a variable (or simple a string) wherever you want it **without escaping HTML**.
+
+Only use this if you are sure that you have full control over the input to this function/no malicious code can find its way inside.
+
+## Parameters
+
+This component expects one parameter.
+
+## Example 1
+
+Rendering some HTML.
+
+```ruby
+
+def response
+  components {
+    rawhtml <<~HTML
+    <h1>Hello World</h1>
+    <script>alert('Really Hello!')</script>
+    HTML
+}
+end
+
+```
+
+returns
+
+```html
+<h1>Hello World</h1>
+<script>alert('Really Hello!')</script>
+```

docs/concepts/component.md

@@ -219,26 +219,19 @@ This gets rendered into HTML as shown below. Notice that the `@foo` from the com
 To use *component instance scope slots*, first define slots within a static component:
 
 ```ruby
-class Components::Some::Component < Matestack::Ui::StaticComponent
+class Components::Other::Component < Matestack::Ui::StaticComponent
 
   def prepare
-    @foo = "foo from component"
+    @foo = "foo from other component"
   end
 
   def response
     components {
-      div id: "my-component" do
-        custom_other_component slots: {
-          my_slot_from_component: my_slot_from_component,
-          my_slot_from_page: @options[:my_slot_from_page]
-        }
-      end
-    }
-  end
-
-  def my_slot_from_component
-    slot {
-      span id: "my-slot-from-component" do
+      div id: "my-other-component" do
+        slot @options[:slots][:my_slot_from_component]
+        br
+        slot @options[:slots][:my_slot_from_page]
+        br
         plain @foo
       end
     }
@@ -247,22 +240,29 @@ class Components::Some::Component < Matestack::Ui::StaticComponent
 end
 ```
 
-And another component:
+and also in some component:
 
 ```ruby
-class Components::Other::Component < Matestack::Ui::StaticComponent
+class Components::Some::Component < Matestack::Ui::StaticComponent
 
   def prepare
-    @foo = "foo from other component"
+    @foo = "foo from component"
   end
 
   def response
     components {
-      div id: "my-other-component" do
-        slot @options[:slots][:my_slot_from_component]
-        br
-        slot @options[:slots][:my_slot_from_page]
-        br
+      div id: "my-component" do
+        custom_other_component slots: {
+          my_slot_from_component: my_slot_from_component,
+          my_slot_from_page: @options[:my_slot_from_page]
+        }
+      end
+    }
+  end
+
+  def my_slot_from_component
+    slot {
+      span id: "my-slot-from-component" do
         plain @foo
       end
     }
@@ -271,7 +271,7 @@ class Components::Other::Component < Matestack::Ui::StaticComponent
 end
 ```
 
-Then, put both components to use on the example page:
+Then, put both components (note that some component uses other component so that's how they're both in here) to use on the example page:
 
 ```ruby
 class Pages::ExamplePage < Matestack::Ui::Page
@@ -367,7 +367,7 @@ Not a fancy example, but this is the result:
 <div id="div-on-page">
   <div id="my-component">
     foo from page
-  </div>  
+  </div>
 </div>
 ```