matestack-ui-core 0.7.2.1 → 1.0.0.rc.1

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/isolated_component.rb

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

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

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

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

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

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/matestack_app_controller.erb → matestack/app/templates/app/controllers/%file_name%_controller.rb.tt}

@@ -1,7 +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/matestack_component.js.erb → matestack/component/templates/app/matestack/components/%namespace%/%file_name%.js.tt}

@@ -1,8 +1,8 @@
 // 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 %>
+//= require <% unless namespace.nil? %><%= namespace %>/<% end %><%= file_name %>
 
-MatestackUiCore.Vue.component('custom<% unless @namespace.nil? %>-<%= @namespace %><% end %>-<%= file_name %>', {
+MatestackUiCore.Vue.component('custom<% unless namespace.nil? %>-<%= namespace %><% end %>-<%= file_name %>', {
   mixins: [MatestackUiCore.componentMixin],
   data: function() {
     return {

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

@@ -0,0 +1,11 @@
+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/core/component/USAGE

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

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Matestack
+  module Core
+    module Generators
+      class ComponentGenerator < Rails::Generators::NamedBase
+        source_root File.expand_path('templates', __dir__)
+
+        def create_core_component
+          template 'app/concepts/matestack/ui/core/%file_name%/%file_name%.haml'
+          template 'app/concepts/matestack/ui/core/%file_name%/%file_name%.rb'
+          template 'spec/usage/components/%file_name%_spec.rb'
+          template 'docs/components/%file_name%.md'
+
+          inject_into_file 'docs/components/README.md', before: "\n## Dynamic Core Components\n" do <<~RUBY
+            - [#{file_name.underscore}](/docs/components/#{file_name.underscore}.md)
+          RUBY
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/matestack/core/component/templates/app/concepts/matestack/ui/core/%file_name%/%file_name%.haml.tt

@@ -0,0 +1,5 @@
+%<%= file_name.underscore %>{@tag_attributes}
+  - if options[:text].blank? && block_given?
+    = yield
+  - else
+    = options[:text]

data/lib/generators/matestack/core/component/templates/app/concepts/matestack/ui/core/%file_name%/%file_name%.rb.tt

@@ -0,0 +1,4 @@
+module Matestack::Ui::Core::<%= file_name.camelcase %>
+  class <%= file_name.camelcase %> < Matestack::Ui::Core::Component::Static
+  end
+end

data/lib/generators/matestack/core/component/templates/docs/components/%file_name%.md.tt

@@ -0,0 +1,45 @@
+# matestack core component: <%= file_name.camelcase %>
+
+Show [specs](/spec/usage/components/<%= file_name.underscore %>_spec.rb)
+
+The HTML `<<%= file_name.underscore %>>` tag implemented in ruby.
+
+## Parameters
+
+This component can take 2 optional configuration params and either yield content or display what gets passed to the `text` configuration param.
+
+#### # id (optional)
+Expects a string with all ids the `<<%= file_name.underscore %>>` should have.
+
+#### # class (optional)
+Expects a string with all classes the `<<%= file_name.underscore %>>` should have.
+
+## Example 1: Yield a given block
+
+```ruby
+<%= file_name.underscore %> id: 'foo', class: 'bar' do
+  plain '<%= file_name.camelcase %> example 1' # optional content
+end
+```
+
+returns
+
+```html
+<<%= file_name.underscore %> id="foo" class="bar">
+  <%= file_name.camelcase %> example 1
+</<%= file_name.underscore %>>
+```
+
+## Example 2: Render `options[:text]` param
+
+```ruby
+<%= file_name.underscore %> id: 'foo', class: 'bar', text: '<%= file_name.camelcase %> example 2'
+```
+
+returns
+
+```html
+<<%= file_name.underscore %> id="foo" class="bar">
+  <%= file_name.camelcase %> example 2
+</<%= file_name.underscore %>>
+```

data/lib/generators/matestack/core/component/templates/spec/usage/components/%file_name%_spec.rb

@@ -0,0 +1,31 @@
+require_relative '../../support/utils'
+include Utils
+
+describe '<%= file_name.camelcase %> component', type: :feature, js: true do
+  it 'Renders a simple and enhanced <%= file_name.underscore %> tag on a page' do
+    class ExamplePage < Matestack::Ui::Page
+      def response
+        components {
+          # Simple <%= file_name.underscore %>
+          <%= file_name.underscore %> text: 'Simple <%= file_name.underscore %> tag'
+
+          # Enhanced <%= file_name.underscore %>
+          <%= file_name.underscore %> id: 'my-id', class: 'my-class' do
+            plain 'Enhanced <%= file_name.underscore %> tag'
+          end
+        }
+      end
+    end
+
+    visit '/example'
+
+    static_output = page.html
+
+    expected_static_output = <<~HTML
+      <<%= file_name.underscore %>>Simple <%= file_name.underscore %> tag</<%= file_name.underscore %>>
+      <<%= file_name.underscore %> id="my-id" class="my-class">Enhanced <%= file_name.underscore %> tag</<%= file_name.underscore %>>
+    HTML
+
+    expect(stripped(static_output)).to include(stripped(expected_static_output))
+  end
+end

data/lib/generators/matestack/page/USAGE

@@ -0,0 +1,28 @@
+Description:
+  Stubs out a new matestack page and its route. Pass the page name and --app-name, both under_scored.
+
+  To place the page within a namespace, specify the namespace name under_scored and it
+  will get generated into 'app/matestack/pages/namespace/*'.
+
+  To create a custom controller#action to use in the created route, specify it as
+  under_scored_controller#under_scored_action
+
+  This generates a matestack page class in app/matestack/pages/ and adds a route to config/routes.rb
+
+Example 1:
+  `rails generate matestack:page example_page --app_name example_app`
+
+  This will create:
+    app/matestack/pages/example_app/example_page.rb
+
+  This will add to routes:
+    get 'example_app/example_page', to: 'example_app#example_page'
+
+Example 2:
+  `rails generate matestack:page example_page --app_name example_app --controller_action=static#second`
+
+  This will create:
+    app/matestack/pages/example_app/example_page.rb
+
+  This will add to routes:
+    get 'example_app/example_page', to: 'static#second'

data/lib/generators/matestack/page/page_generator.rb

@@ -0,0 +1,54 @@
+module Matestack
+  module Generators
+    class PageGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      class_option :app_name, type: :string, required: true
+      class_option :namespace, type: :string
+      class_option :controller_action, type: :string
+      class_option :called_by_app_generator, type: :boolean, default: false
+
+      def app_name
+        options[:app_name]
+      end
+
+      def namespace
+        options[:namespace]
+      end
+
+      def controller_action
+        if options[:controller_action].nil?
+          "#{app_name}\##{file_name}"
+        else
+          options[:controller_action]
+        end
+      end
+
+      def create_page
+        template "app/matestack/pages/%app_name%/%namespace%/%file_name%.rb"
+
+        unless options[:called_by_app_generator]
+          if namespace
+            route %{get '#{app_name}/#{namespace}/#{file_name}', to: '#{controller_action}'}
+          else
+            route %{get '#{app_name}/#{file_name}', to: '#{controller_action}'}
+          end
+
+          puts "Page created! Make sure to add"
+          puts ""
+          puts "def #{file_name}"
+
+          if namespace
+            puts "  responder_for(Pages::#{app_name.camelize}::#{namespace.camelize}::#{file_name.camelize})"
+          else
+            puts "  responder_for(Pages::#{app_name.camelize}::#{file_name.camelize})"
+          end
+
+          puts "end"
+          puts ""
+          puts "to the desired controller!"
+        end
+      end
+    end
+  end
+end

data/lib/generators/matestack/page/templates/app/matestack/pages/%app_name%/%namespace%/%file_name%.rb.tt

@@ -0,0 +1,29 @@
+class Pages::<% unless namespace.nil? %><%= namespace.camelize %>::<% end %><% unless app_name.nil? %><%= app_name.camelize %>::<% end %><%= class_name %> < Matestack::Ui::Page
+  # OPTIONAL: Prepare data for the response method
+  # def prepare
+  #   API calls and db queries go here
+  # end
+
+  # MANDATORY: This is where the matestack magic happens
+  def response
+    components {
+      heading text: 'Welcome to your <%= class_name %> page'
+      # your page content goes here, e.g.
+      # partial :partial_example
+    }
+  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/matestack/ui/core.rb

@@ -1,11 +1,14 @@
-require 'trailblazer'
-require 'trailblazer/rails'
 require 'trailblazer/cell'
 require 'cell/rails'
 require 'cell/haml'
 
+require "matestack/ui/core/cell"
 require "matestack/ui/core/engine"
 
+require "matestack/ui/core/dsl"
+require "matestack/ui/core/component/registry"
+require "matestack/ui/core/components"
+
 module Matestack
   module Ui
     module Core