Merge pull request #478 from matestack/next-release

jonasjabari · web-flow · commit f054656cf919 · 2020-11-20T17:29:29.000+01:00
1.2.0 Release
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## v1.2.0 Release
+
+### Improvements
+
+* Enable usage of Rails view/route helpers on standalone components used via matestack_component helper #476
+
 ## v1.1.0 Release
 
 ### Improvements
diff --git a/app/concepts/matestack/ui/core/component/base.rb b/app/concepts/matestack/ui/core/component/base.rb
@@ -245,7 +245,7 @@ def add_child(child_class, *args, &block)
 
       # check only allowed keys are passed to isolated components
       if child_class < Matestack::Ui::Core::Isolated::Isolated
-        unless args.empty? || args[0].keys.all? { |key| [:defer, :public_options, :rerender_on, :init_on, :rerender_delay, :matestack_context].include? key }
+        unless args.empty? || args[0].keys.all? { |key| [:defer, :public_options, :rerender_on, :init_on, :rerender_delay, :matestack_context, :context].include? key }
           raise "isolated components can only take params in a public_options hash, which will be exposed to the client side in order to perform an async request with these params."
         end
         if args.any? { |arg| arg[:init_on].present? } && @matestack_skip_defer == true
diff --git a/app/helpers/matestack/ui/core/application_helper.rb b/app/helpers/matestack/ui/core/application_helper.rb
@@ -102,8 +102,8 @@ def matestack_component(component, options = {}, &block)
           controller = (self.class <= ActionController::Base) ? self : @_controller
           context = (options[:matestack_context] ||= {}).merge(controller: controller)
           Matestack::Ui::Core::Component::Base
-            .new(options.merge(matestack_context: context))
-            .send(component, options.merge(matestack_context: context), &block).to_s
+            .new(options.merge(context: context, matestack_context: context))
+            .send(component, options.merge(context: context, matestack_context: context), &block).to_s
         end
       end
     end
diff --git a/app/lib/matestack/ui/core/has_view_context.rb b/app/lib/matestack/ui/core/has_view_context.rb
@@ -2,13 +2,15 @@ module Matestack::Ui::Core::HasViewContext
   def initialize(*args)
     super
     @view_context = @options.dig(:context, :view_context)
+    unless @view_context
+      @view_context = @options.dig(:matestack_context, :controller)&.view_context
+    end
   end
-
   def method_missing(*args, &block)
     if @view_context.respond_to? args.first
       @view_context.send(*args, &block)
     else
       raise NameError, "NameError: undefined method or local variable `#{args.first}' for #{self.class.name}"
     end
   end
-end
+end
diff --git a/app/lib/matestack/ui/core/rendering/main_renderer.rb b/app/lib/matestack/ui/core/rendering/main_renderer.rb
@@ -61,11 +61,14 @@ def render(controller_instance, page_class, options)
     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
+      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
 
diff --git a/docs/reactive_apps/100-rails_integration/README.md b/docs/reactive_apps/100-rails_integration/README.md
@@ -11,7 +11,7 @@ Matestack's JavaScript needs to be integrated into your Rails application in ord
 Add 'matestack-ui-core' to your `package.json` by running:
 
 ```
-$ yarn add https://github.com/matestack/matestack-ui-core#v1.1.0
+$ yarn add https://github.com/matestack/matestack-ui-core#v1.2.0
 $ yarn install
 ```
 
diff --git a/docs/reactive_apps/1000-tutorial/01_setup.md b/docs/reactive_apps/1000-tutorial/01_setup.md
@@ -60,7 +60,7 @@ to start the application. Now visit [localhost:3000](http://localhost:3000/) and
 
 To install matestack, run `gem install matestack-ui-core` or add `gem 'matestack-ui-core'` to your Gemfile and run `bundle install`.
 
-For a complete setup with Webpacker, you also need to run `yarn add https://github.com/matestack/matestack-ui-core#v1.1.0` followed by `yarn install`.
+For a complete setup with Webpacker, you also need to run `yarn add https://github.com/matestack/matestack-ui-core#v1.2.0` followed by `yarn install`.
 
 Then, add
 
diff --git a/docs/reactive_components/100-rails_integration/README.md b/docs/reactive_components/100-rails_integration/README.md
@@ -9,7 +9,7 @@ Matestack's JavaScript needs to be integrated into your Rails application in ord
 Add 'matestack-ui-core' to your `package.json` by running:
 
 ```
-$ yarn add https://github.com/matestack/matestack-ui-core#v1.1.0
+$ yarn add https://github.com/matestack/matestack-ui-core#v1.2.0
 $ yarn install
 ```
 
diff --git a/docs/start/100-installation/README.md b/docs/start/100-installation/README.md
@@ -9,7 +9,7 @@ If you want to use Matestack's optional reactivity features, please follow this
 Add 'matestack-ui-core' to your Gemfile
 
 ```ruby
-gem 'matestack-ui-core', '~> 1.1'
+gem 'matestack-ui-core', '~> 1.2'
 ```
 
 and run
diff --git a/docs/ui_components/100-rails_integration/README.md b/docs/ui_components/100-rails_integration/README.md
@@ -14,13 +14,12 @@ The easiest way to integrate Matestack is by creating custom components and usin
 
 This is a perfect place to start refactoring our application to use matestack. It's easy to start from the inside out, first replacing parts of your UI with components. As partials already are used to structure your UI in smaller reusable parts they are a perfect starting point. So let's refactor our product teaser into a custom component.
 
-After successfully following the [installation guide](/docs/start/100-installation/README.md) we can start. Remember to set the id "matestack-ui" in your corresponding layout.
+After successfully following the [installation guide](/docs/start/100-installation/README.md) we can start.
 
 Start by creating a file called `teaser.rb` in `app/matestack/components/products/teaser.rb`. Placement of this file is as you see similar to our partial. In this file we implement our component in pure ruby as follows:
 
 ```ruby
 class Components::Products::Teaser < Matestack::Ui::Component
-  include ::Rails.application.routes.url_helpers
 
   requires :product
 
@@ -37,7 +36,7 @@ class Components::Products::Teaser < Matestack::Ui::Component
 end
 ```
 
-We inherit from `Matestack::Ui::Component` to create our teaser component. As it should display product informations it requires a product. We can access this product through a getter method `product`. To access Rails url helpers we have to include `Rails.application.routes.url_helpers` as components usually get access to them through the pages but we render our component outside a Matestack page. Now we have now a teaser component, but in order to use it we have to register it and include our registration in our `ApplicationController`.
+We inherit from `Matestack::Ui::Component` to create our teaser component. As it should display product informations it requires a product. We can access this product through a getter method `product`. Now we have now a teaser component, but in order to use it we have to register it and include our registration in our `ApplicationController`.
 
 Let's register our component by creating a component registry in `app/matestack/components/registry.rb`.
 
diff --git a/lib/matestack/ui/core/version.rb b/lib/matestack/ui/core/version.rb
@@ -1,7 +1,7 @@
 module Matestack
   module Ui
     module Core
-      VERSION = '1.1.0'
+      VERSION = '1.2.0'
     end
   end
 end
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "matestack-ui-core",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "main": "app/javascript/matestack-ui-core",
   "private": true,
   "dependencies": {
diff --git a/spec/dummy/app/controllers/legacy_views/pages_controller.rb b/spec/dummy/app/controllers/legacy_views/pages_controller.rb
@@ -6,14 +6,14 @@ class LegacyViews::PagesController < ApplicationController
 
   def action_inline
   end
-  
+
   def action_custom_component
     @title = 'Test Title'
   end
-  
+
   def async_custom_component
   end
-  
+
   def async_inline
   end
 
@@ -45,6 +45,9 @@ def form_custom_component
   def onclick_custom_component
   end
 
+  def viewcontext_custom_component
+  end
+
   def isolated_custom_component
     render 'isolated_custom_component'
   end
@@ -78,4 +81,4 @@ def dummy_model_params
     )
   end
 
-end
+end
diff --git a/spec/dummy/app/matestack/components/legacy_views/pages/viewcontext.rb b/spec/dummy/app/matestack/components/legacy_views/pages/viewcontext.rb
@@ -0,0 +1,14 @@
+class Components::LegacyViews::Pages::Viewcontext < Matestack::Ui::Component
+
+  def response
+    div id: "my-component" do
+      if @view_context.view_renderer.instance_of?(ActionView::Renderer)
+        plain "has access to ActionView Context"
+      end
+      plain link_to "Test Link", "/some/page" # calling an ActionView Url Helper here
+      plain time_ago_in_words(3.minutes.from_now) # calling an ActionView Date Helper here
+      plain "root_path: #{root_path}" # calling a Path Helper here
+    end
+  end
+
+end
diff --git a/spec/dummy/app/matestack/components/registry.rb b/spec/dummy/app/matestack/components/registry.rb
@@ -13,6 +13,7 @@ module Components::Registry
     legacy_views_pages_form: Components::LegacyViews::Pages::Form,
     legacy_views_pages_onclick: Components::LegacyViews::Pages::Onclick,
     legacy_views_pages_isolated: Components::LegacyViews::Pages::Isolated,
+    legacy_views_pages_viewcontext: Components::LegacyViews::Pages::Viewcontext,
   )
 
 end
diff --git a/spec/dummy/app/views/legacy_views/pages/isolated_custom_component.html.erb b/spec/dummy/app/views/legacy_views/pages/isolated_custom_component.html.erb
@@ -1,4 +1,4 @@
 <h1>Isolated Custom Component</h1>
 <%=
   matestack_component(:legacy_views_pages_isolated, rerender_on: 'update_time' )
-%>
+%>
diff --git a/spec/dummy/app/views/legacy_views/pages/viewcontext_custom_component.html.erb b/spec/dummy/app/views/legacy_views/pages/viewcontext_custom_component.html.erb
@@ -0,0 +1,2 @@
+<h1>Viewcontext Custom Component</h1>
+<%= matestack_component(:legacy_views_pages_viewcontext) %>
diff --git a/spec/dummy/config/routes.rb b/spec/dummy/config/routes.rb
@@ -2,6 +2,8 @@
 
   mount Matestack::Ui::Core::Engine, at: '/matestack'
 
+  root to: 'my_app#my_first_page'
+
   scope :components_tests do
     get "static_rendering_test/:component", to: 'components_tests#static_rendering_test', as: "components_tests"
     get "custom_components_test", to: 'components_tests#custom_components_test'
@@ -55,6 +57,7 @@
     get 'form_custom_component', to: 'pages#form_custom_component'
     get 'onclick_custom_component', to: 'pages#onclick_custom_component'
     get 'isolated_custom_component', to: 'pages#isolated_custom_component'
+    get 'viewcontext_custom_component', to: 'pages#viewcontext_custom_component'
     post 'success', to: 'pages#success'
     post 'failure', to: 'pages#failure'
     post 'create', to: 'pages#create'
diff --git a/spec/test/base/core/app/action_view_context_spec.rb b/spec/test/base/core/app/action_view_context_spec.rb
@@ -27,6 +27,7 @@ def response
         end
         plain link_to "Test Link", "/some/page" # calling an ActionView Url Helper here
         plain time_ago_in_words(3.minutes.from_now) # calling an ActionView Date Helper here
+        plain "root_path: #{root_path}" # calling a Path Helper here
         main do
           page_content
         end
@@ -55,6 +56,7 @@ def page1
     expect(page).to have_content("Test Link")
     expect(page).to have_content("has access to ActionView Context")
     expect(page).to have_content("3 minutes")
+    expect(page).to have_content("root_path: /")
   end
 
 end
diff --git a/spec/test/base/core/component/view_context_access_spec.rb b/spec/test/base/core/component/view_context_access_spec.rb
@@ -32,6 +32,7 @@ def response
             end
             plain link_to "Test Link", "/some/page" # calling an ActionView Url Helper here
             plain time_ago_in_words(3.minutes.from_now) # calling an ActionView Date Helper here
+            plain "root_path: #{root_path}" # calling a Path Helper here
           end
         end
 
@@ -50,6 +51,7 @@ def response
       expect(page).to have_content("has access to ActionView Context")
       expect(page).to have_content("Test Link")
       expect(page).to have_content("3 minutes")
+      expect(page).to have_content("root_path: /")
     end
 
     it "a component can access view context scope when rerendered via async" do
diff --git a/spec/test/base/core/page/view_context_access_spec.rb b/spec/test/base/core/page/view_context_access_spec.rb
@@ -35,6 +35,7 @@ def response
           end
           plain link_to "Test Link", "/some/page" # calling an ActionView Url Helper here
           plain time_ago_in_words(3.minutes.from_now) # calling an ActionView Date Helper here
+          plain "root_path: #{root_path}" # calling a Path Helper here
         end
       end
 
@@ -45,6 +46,7 @@ def response
     expect(page).to have_content("has access to ActionView Context")
     expect(page).to have_content("Test Link")
     expect(page).to have_content("3 minutes")
+    expect(page).to have_content("root_path: /")
 
   end
 
diff --git a/spec/test/components/legacy_views/viewcontext_spec.rb b/spec/test/components/legacy_views/viewcontext_spec.rb
@@ -0,0 +1,14 @@
+require_relative "../../support/utils"
+include Utils
+
+describe "Viewcontext", type: :feature, js: true do
+
+  it 'should be accessible on components used on rails legacy views with matestack_component helper' do
+    visit 'legacy_views/viewcontext_custom_component'
+    expect(page).to have_content("has access to ActionView Context")
+    expect(page).to have_content("Test Link")
+    expect(page).to have_content("3 minutes")
+    expect(page).to have_content("root_path: /")
+  end
+
+end

Original file line number	Diff line number	Diff line change
`@@ -61,11 +61,14 @@ def render(controller_instance, page_class, options)`
`61`	`61`	`end`
`62`	`62`	`end`
`63`	`63`
	`64`	`+ # needs refactoring!`
	`65`	`+ # we shouldn't pass in the parts of the controller_instance and the instance itself`
`64`	`66`	`def create_context_hash(controller_instance)`
`65`	`67`	`{`
`66`	`68`	`view_context: controller_instance.view_context,`
`67`	`69`	`params: controller_instance.params,`
`68`		`- request: controller_instance.request`
	`70`	`+ request: controller_instance.request,`
	`71`	+ 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
`69`	`72`	`}`
`70`	`73`	`end`
`71`	`74`