katapult 0.2.0 → 0.3.0

data/lib/generators/katapult/clearance/clearance_generator.rb

@@ -6,8 +6,9 @@ module Katapult
   module Generators
     class ClearanceGenerator < Katapult::Generator
 
-      desc 'Generate authentication with Clearance'
+      MENU_BAR = 'app/views/layouts/_menu_bar.html.haml'
 
+      desc 'Generate authentication with Clearance'
       check_class_collision
       source_root File.expand_path('../templates', __FILE__)
 
@@ -74,6 +75,17 @@ resources :users do
         ROUTES
       end
 
+      def add_current_user_to_layout
+        template 'app/views/layouts/_current_user.html.haml'
+        inject_into_file MENU_BAR, <<-CONTENT, after: /^\s+#navbar.*\n/
+      = render 'layouts/current_user' if signed_in?
+        CONTENT
+      end
+
+      def hide_navigation_unless_signed_in
+        gsub_file MENU_BAR, /(render.*navigation')/, '\1 if signed_in?'
+      end
+
       def add_sign_in_background_to_all_features
         Dir['features/*.feature'].each do |file|
           inject_into_file file, <<-CONTENT, after: /^Feature: .*$/
@@ -110,7 +122,7 @@ resources :users do
       end
 
       def add_user_factory
-        inject_into_file 'spec/factories/factories.rb', <<-'CONTENT', after: 'FactoryGirl.define do'
+        inject_into_file 'spec/factories/factories.rb', <<-'CONTENT', after: 'FactoryBot.define do'
 
   factory :user do
     sequence(:email) { |i| "user-#{ i }@example.com" }

data/lib/generators/katapult/clearance/templates/app/views/layouts/_current_user.html.haml

@@ -0,0 +1,11 @@
+%ul.nav.navbar-nav.navbar-right
+  %li.dropdown
+    = link_to edit_user_path(current_user), data: { toggle: 'dropdown' } do
+      Hello,
+      = current_user
+      %span.caret
+
+    %ul.dropdown-menu
+      %li= link_to 'Edit profile', edit_user_path(current_user)
+      %li.divider
+      %li= link_to 'Sign out', sign_out_path, method: :delete, class: 'navbar-logout'

data/lib/generators/katapult/clearance/templates/app/views/passwords/create.html.haml

@@ -1,5 +1,11 @@
-%h1
-  Password Reset Instructions Sent
+.row
+  .col-md-4.col-md-offset-4
 
-%p
-  We've sent you an email with instructions on how to reset your password.
+    %h1
+      Password Reset Instructions Sent
+
+    %p
+      We've sent you an email with instructions on how to reset your password.
+
+    %p
+      = link_to 'Back to sign-in form', sign_in_path, class: 'btn btn-primary'

data/lib/generators/katapult/clearance/templates/app/views/passwords/edit.html.haml

@@ -1,16 +1,16 @@
-%h1
-  Reset Password
+.row
+  .col-md-4.col-md-offset-4
 
-%p
-  Choose your new password:
+    %h1
+      Reset Password
 
-= form_for :password_reset,
-  url: user_password_path(@user, token: @user.confirmation_token),
-  html: { method: :put } do |form|
+    = form_for :password_reset,
+      url: user_password_path(@user, token: @user.confirmation_token),
+      html: { method: :put } do |form|
 
-  .form-group
-    = form.label :password
-    = form.password_field :password, class: 'form-control',
-      placeholder: 'New Password'
+      .form-group
+        = form.label :password
+        = form.password_field :password, class: 'form-control',
+          placeholder: 'New password'
 
-  = form.submit 'Update Password', class: 'btn btn-primary'
+      = form.submit 'Update password', class: 'btn btn-primary'

data/lib/generators/katapult/clearance/templates/app/views/passwords/new.html.haml

@@ -1,14 +1,17 @@
-%h1
-  Password Reset
+.row
+  .col-md-4.col-md-offset-4
 
-%p
-  Please enter your email address. We will send you instructions on how
-  to reset your password.
+    %h1
+      Password Reset
 
-= form_for :password, url: passwords_path do |form|
-  .form-group
-    = form.label :email
-    = form.email_field :email, class: 'form-control',
-      placeholder: 'Email Address'
+    %p
+      Please enter your email address. We will send you instructions on how
+      to reset your password.
 
-  = form.submit 'Request Instructions', class: 'btn btn-primary'
+    = form_for :password, url: passwords_path do |form|
+      .form-group
+        = form.label :email
+        = form.email_field :email, class: 'form-control',
+          placeholder: 'Email address'
+
+      = form.submit 'Request instructions', class: 'btn btn-primary'

data/lib/generators/katapult/clearance/templates/app/views/sessions/new.html.haml

@@ -1,19 +1,20 @@
-%h1
-  Please sign in
+.row
+  .col-md-4.col-md-offset-4
 
-= form_for :session, url: session_path do |form|
-  .form-group
-    = form.label :email
-    = form.email_field :email, class: 'form-control',
-      placeholder: 'Email Address', required: true, autofocus: true
+    %h1
+      Please sign in
 
-  .form-group
-    = form.label :password
-    = form.password_field :password, class: 'form-control', required: true,
-      placeholder: 'Password'
+    = form_for :session, url: session_path do |form|
+      .form-group
+        = form.label :email
+        = form.email_field :email, class: 'form-control',
+          placeholder: 'Email Address', required: true, autofocus: true
 
-  %p
-    = form.submit 'Sign in', class: 'btn btn-primary'
+      .form-group
+        = form.label :password
+        = form.password_field :password, class: 'form-control', required: true,
+          placeholder: 'Password'
 
-  %p
-    = link_to 'Forgot password', new_password_path, class: 'text-muted'
+      %p
+        = form.submit 'Sign in', class: 'btn btn-primary'
+        = link_to 'Forgot password', new_password_path, class: 'btn btn-link'

data/lib/generators/katapult/clearance/templates/features/authentication.feature

@@ -51,7 +51,7 @@ Feature: Everything about user authentication
       And I sign in as the user above
 
     When I go to the homepage
-      And I follow "henry@example.com" within the current user
+      And I follow "henry@example.com" within the navbar
     Then I should be on the form for the user above
 
     When I fill in "Password" with "new-password"
@@ -74,7 +74,7 @@ Feature: Everything about user authentication
       And I should see "Password Reset"
 
     When I fill in "Email" with "henry@example.com"
-      And I press "Request Instructions"
+      And I press "Request instructions"
     Then an email should have been sent with:
       """
       From: system@example.com
@@ -89,6 +89,6 @@ Feature: Everything about user authentication
       And I should see "Reset Password"
 
     When I fill in "Choose password" with "new-password"
-      And I press "Update Password"
+      And I press "Update password"
     Then I should see "Password successfully changed" within the flash
       And I should be on the homepage

data/lib/generators/katapult/cucumber_features/templates/feature.feature

@@ -59,5 +59,5 @@ Feature: <%= model.name(:humans).titleize %>
 
     When I follow "Destroy <%= model.label_attr.test_value %>"
     Then I should be on the list of <%= model.name(:variables) %>
-      But I should not see "<%= model.label_attr.test_value %>"
+    But I should not see "<%= model.label_attr.test_value %>"
 <% end -%>

data/lib/generators/katapult/model_specs/templates/model_spec.rb

@@ -1,17 +1,15 @@
-require 'rails_helper'
-
 describe <%= model.name :class %> do
 
   describe '#to_s' do
   <%- if model.label_attr -%>
     it 'returns the #<%= model.label_attr.name %> attribute' do
       subject.<%= model.label_attr.name %> = <%= model.label_attr.test_value.inspect %>
-      expect(subject.to_s).to eql(<%= model.label_attr.test_value.to_s.inspect %>)
+      expect(subject.to_s).to eq(<%= model.label_attr.test_value.to_s.inspect %>)
     end
   <%- else -%>
     it 'returns its class name with its id' do
       subject.id = 17
-      expect(subject.to_s).to eql("<%= model.name %>#17")
+      expect(subject.to_s).to eq("<%= model.name %>#17")
     end
   <%- end -%>
   end
@@ -25,7 +23,7 @@ describe <%= model.name :class %> do
   <%- unless attr.default.nil? -%>
 
     it 'has a default' do
-      expect( subject.<%= attr.name %> ).to eql(<%= attr.default.inspect %>)
+      expect(subject.<%= attr.name %>).to eq(<%= attr.default.inspect %>)
     end
   <%- end -%>
   end

data/lib/generators/katapult/navigation/navigation_generator.rb

@@ -6,12 +6,18 @@ module Katapult
   module Generators
     class NavigationGenerator < Katapult::Generator
 
+      MENU_BAR = 'app/views/layouts/_menu_bar.html.haml'
+
       desc 'Generate the navigation'
       source_root File.expand_path('../templates', __FILE__)
 
 
       def create_navigation
-        template 'app/models/navigation.rb'
+        template 'app/views/layouts/_navigation.html.haml'
+
+        inject_into_file MENU_BAR, <<-CONTENT, after: /^\s+#navbar.*\n/
+      = render 'layouts/navigation'
+        CONTENT
       end
 
       private

data/lib/generators/katapult/navigation/templates/app/views/layouts/_navigation.html.haml

@@ -0,0 +1,15 @@
+%ul.nav.navbar-nav
+<% navigation.links.each do |label, path| -%>
+  %li(up-expand)
+    = content_link_to <%= label.titleize.inspect %>, <%= path %>
+<% end -%>
+
+  %li.dropdown
+    = link_to '#', data: { toggle: 'dropdown' } do
+      Dropdown example
+      %span.caret
+
+    %ul.dropdown-menu
+      %li= link_to 'One', '#'
+      %li.divider
+      %li= link_to 'Two', '#'

data/lib/generators/katapult/transform/transform_generator.rb

@@ -6,9 +6,12 @@
 # 2) render the parsed model into code
 
 require 'katapult/parser'
+require 'katapult/generator_goodies'
 
 module Katapult
   class TransformGenerator < Rails::Generators::Base
+    include Katapult::GeneratorGoodies
+
     desc 'Transform the katapult application model'
 
     argument :path, required: true, type: :string,
@@ -16,34 +19,26 @@ module Katapult
 
     def transform_application_model
       say_status :parse, path
-      @app_model = Katapult::Parser.new.parse(path)
+      application_model = File.read(path)
+      @app_model = Katapult::Parser.new.parse(application_model, path)
 
-      say_status :render, "into #{application_name}"
+      say_status :render, "into #{app_name}"
       @app_model.render
     end
 
     def write_root_route
       unless File.read('config/routes.rb').include? '  root'
-        root_wui = @app_model.wuis.find { |w| w.find_action :index }
-        route "root '#{ root_wui.model_name(:variables) }#index'" if root_wui
+        root_web_ui = @app_model.web_uis.find { |w| w.find_action :index }
+        route "root '#{ root_web_ui.model_name(:variables) }#index'" if root_web_ui
       end
     end
 
     def remigrate_all_databases
-      run 'spring stop' # parallel_tests does not work together with Spring
-      run 'rake db:drop:all db:create:all db:migrate parallel:create parallel:prepare'
-    end
-
-  private
+      return if ENV['SKIP_MIGRATIONS'] # Used to speed up tests
 
-    def application_name
-       File.basename(Dir.pwd)
-    end
-
-    def run(*)
-      Bundler.with_clean_env do
-        super
-      end
+      run 'rake db:drop db:create db:migrate'
+      # See comment to Katapult::BasicsGenerator#create_databases
+      run 'unset RAILS_ENV; rake parallel:drop parallel:create parallel:prepare'
     end
 
   end

data/lib/generators/katapult/views/templates/_form.html.haml

@@ -0,0 +1,48 @@
+<%- object = model_name(:ivar) -%>
+= form_for <%= object %> do |form|
+
+<% web_ui.model.editable_attrs.each do |attribute| -%>
+  .form-group
+    = form.label <%= attribute.name(:symbol) %>
+  <%- if attribute.assignable_values -%>
+    = form.select <%= attribute.name(:symbol) %>, form.object.assignable_<%= attribute.name(:variables) %>
+  <%- else -%>
+    <%- case attribute.type -%>
+    <%- when :string -%>
+    = form.text_field <%= attribute.name(:symbol) %>, class: 'form-control'
+    <%- when :email -%>
+    = form.email_field <%= attribute.name(:symbol) %>, class: 'form-control'
+    <%- when :password -%>
+    = form.password_field <%= attribute.name(:symbol) %>, class: 'form-control',
+      autocomplete: 'new-password'
+    <%- when :url -%>
+    = form.url_field <%= attribute.name(:symbol) %>, class: 'form-control'
+    <%- when :integer -%>
+    = form.number_field <%= attribute.name(:symbol) %>, class: 'form-control'
+    <%- when :money -%>
+    .input-group
+      = form.number_field <%= attribute.name(:symbol) %>, class: 'form-control'
+      .input-group-addon
+        €
+    <%- when :text -%>
+    = form.text_area <%= attribute.name(:symbol) %>, rows: 5, class: 'form-control'
+    <%- when :flag -%>
+    .checkbox
+      = form.label <%= attribute.name(:symbol) %> do
+        = form.check_box <%= attribute.name(:symbol) %>
+    <%- when :datetime -%>
+    = form.date_field <%= attribute.name(:symbol) %>, class: 'form-control'
+    <%- end -%>
+  <%- end -%>
+<% end -%>
+
+  .action-bar
+    - cancel_path = <%= object %>.new_record? ? <%= web_ui.path(:index) %> : <%= web_ui.path(:show, object) %>
+
+    .pull-right
+      - if <%= object %>.persisted?
+        = link_to "Destroy <%= model_name(:human) %>", <%= web_ui.path(:destroy, object) %>, method: :delete,
+          class: 'btn btn-danger', data: { confirm: 'Really destroy?' }
+
+    = form.submit 'Save', class: 'btn btn-primary'
+    = link_to 'Cancel', cancel_path, class: 'btn btn-link'

data/lib/generators/katapult/views/templates/app/helpers/table_helper.rb

@@ -0,0 +1,14 @@
+module TableHelper
+
+  def table(*headers, &block)
+    thead = content_tag(:thead) do
+      content_tag(:tr) do
+        headers.map{ |h| content_tag :th, h }.xss_aware_join
+      end
+    end
+    rest = capture(&block)
+
+    content_tag :table, thead + rest, class: 'table table-hover'
+  end
+
+end

data/lib/generators/katapult/views/templates/app/webpack/assets/stylesheets/blocks/action_bar.sass

@@ -0,0 +1,22 @@
+@import ../environment
+
+.action-bar
+  margin-top: $space-md
+  border-top: 1px solid $panel-default-border
+  padding-top: $space-xs
+
+  &.-main
+    float: right
+
+    margin-top: 3px
+    border: none
+    padding: 0
+
+  +within-modal
+    margin: 30px -40px -30px
+    padding: 15px 40px
+
+    background: $panel-footer-bg
+    border-bottom-left-radius: $border-radius-base
+    border-bottom-right-radius: $border-radius-base
+

data/lib/generators/katapult/views/templates/app/webpack/assets/stylesheets/blocks/title.sass

@@ -0,0 +1,11 @@
+@import ../environment
+
+h1.title
+  margin: $space-lg 0 $space-sm -2px
+
+  +within-modal
+    margin-top: 3px
+
+h2.title
+  margin: $space-sm 0
+

data/lib/generators/katapult/views/templates/custom_action.html.haml

@@ -0,0 +1,5 @@
+.action-bar
+  = link_to 'All <%= model_name(:humans) %>', <%= web_ui.path(:index) %>, class: 'btn btn-default'
+
+%h1.title
+  <%= @action.name.humanize.titleize %>

data/lib/generators/katapult/views/templates/edit.html.haml

@@ -0,0 +1,4 @@
+%h1.title
+  = <%= model_name(:ivar) %>
+
+= render 'form'

data/lib/generators/katapult/views/templates/index.html.haml

@@ -0,0 +1,26 @@
+.action-bar.-main.btn-group
+  = link_to 'Add <%= model_name(:human) %>', <%= web_ui.path(:new) %>, class: 'btn btn-default'
+<% web_ui.custom_actions.select(&:collection?).each do |action| -%>
+  = link_to '<%= action.name.humanize.titleize %>', <%= web_ui.path(action) %>, class: 'btn btn-default'
+<% end -%>
+
+%h1.title
+  <%= model_name(:humans).capitalize %>
+
+- if <%= model_name(:ivars) %>.any?
+  <%- object = model_name(:variable) -%>
+
+  = table '<%= web_ui.model.label_attr.name(:human).titleize %>', 'Actions' do
+    - <%= model_name(:ivars) %>.each do |<%= object %>|
+      %tr(up-expand)
+        %td(width='40%')
+          = link_to <%= object %>, <%= object %>
+        %td
+          = link_to 'Edit', <%= web_ui.path(:edit, object) %>
+          = link_to 'Destroy', <%= web_ui.path(:destroy, object) %>, method: :delete,
+            class: 'text-danger',
+            data: { confirm: 'Really destroy?' }, title: "Destroy #{<%= object %>}"
+
+- else
+  %p.help-block
+    No <%= model_name(:humans) %> found.

data/lib/generators/katapult/{haml → views}/templates/new.html.haml

@@ -1,4 +1,4 @@
-%h1
+%h1.title
   Add <%= model_name(:human) %>
 
 = render 'form'

data/lib/generators/katapult/views/templates/show.html.haml

@@ -0,0 +1,39 @@
+<%- object = model_name(:ivar) -%>
+.action-bar.-main.btn-group
+  = link_to 'All <%= model_name(:humans) %>', <%= web_ui.path(:index) %>, class: 'btn btn-default'
+  = link_to 'Edit', <%= web_ui.path(:edit, object) %>, class: 'btn btn-default'
+<% web_ui.custom_actions.select(&:member?).each do |action| -%>
+  = link_to '<%= action.name(:human).titleize %>', <%= web_ui.path(action, object) %>, class: 'btn btn-default'<%=
+    ", method: :#{action.method}" unless action.get?
+    %>
+<% end -%>
+
+%h1.title
+  = <%= model_name(:ivar) %>
+
+%dl
+<% web_ui.model.renderable_attrs.each do |attribute| -%>
+  <%- model_attribute = "#{object}.#{attribute.name}" -%>
+  %dt
+    = <%= model_name(:class) %>.human_attribute_name(:<%= attribute.name %>)
+  %dd
+  <%- case attribute.type -%>
+  <%- when :string -%>
+    = <%= model_attribute %>
+  <%- when :email -%>
+    = mail_to <%= model_attribute %>, nil
+  <%- when :url -%>
+    = link_to <%= model_attribute %>, <%= model_attribute %>
+  <%- when :integer -%>
+    = <%= model_attribute %>
+  <%- when :money -%>
+    = <%= model_attribute %>
+    €
+  <%- when :text -%>
+    = simple_format(<%= model_attribute %>)
+  <%- when :flag -%>
+    = <%= model_attribute %> ? 'Yes' : 'No'
+  <%- when :datetime -%>
+    = l(<%= model_attribute %>.to_date) if <%= model_attribute %>
+  <%- end -%>
+<%- end -%>

data/lib/generators/katapult/{haml/haml_generator.rb → views/views_generator.rb}

@@ -1,28 +1,30 @@
-# Generate views for a WUI.
+# Generate views for a WebUI
 
 require 'katapult/generator'
 require 'generators/katapult/cucumber_features/cucumber_features_generator'
 
 module Katapult
   module Generators
-    class HamlGenerator < Katapult::Generator
+    class ViewsGenerator < Katapult::Generator
 
       desc 'Generate HAML views'
       source_root File.expand_path('../templates', __FILE__)
 
 
-      def install_application_layout
-        remove_file 'app/views/layouts/application.html.erb'
-        template 'app/views/layouts/application.html.haml'
-        template 'app/views/layouts/_flashes.html.haml'
-      end
-
       def create_views_directory
         FileUtils.mkdir_p views_path
       end
 
+      def install_helpers
+        directory 'app/helpers'
+      end
+
+      def install_styles
+        directory 'app/webpack/assets/stylesheets/blocks'
+      end
+
       def create_rails_standard_action_views
-        actions.select{ |a| a.get? && WUI::RAILS_ACTIONS.include?(a.name) }.each do |action|
+        actions.select{ |a| a.get? && WebUI::RAILS_ACTIONS.include?(a.name) }.each do |action|
           file_name = "#{action.name}.html.haml"
 
           create_view file_name, File.join(views_path, file_name)
@@ -40,54 +42,46 @@ module Katapult
       end
 
       def create_views_for_custom_actions
-        wui.custom_actions.select(&:get?).each do |action|
+        web_ui.custom_actions.select(&:get?).each do |action|
           @action = action # Make the action object accessible in templates
           create_view 'custom_action.html.haml', File.join(views_path, "#{action.name}.html.haml")
         end
       end
 
       def generate_integration_tests
-        if wui.model.present?
-          Generators::CucumberFeaturesGenerator.new(wui.model).invoke_all
+        if web_ui.model.present?
+          Generators::CucumberFeaturesGenerator.new(web_ui.model).invoke_all
         end
       end
 
       no_tasks do
         def model_name(kind = nil)
-          wui.model_name(kind)
+          web_ui.model_name(kind)
         end
 
         def views_path
           File.join('app', 'views', model_name(:variables))
         end
-
-        def navigation
-          wui.application_model.navigation
-        end
-
-        def authentication
-          wui.application_model.authentication
-        end
       end
 
       private
 
-      # Rails views depend heavily on models. If the WUI has no model, do not
+      # Rails views depend heavily on models. If the WebUI has no model, do not
       # use the templates but create empty files instead.
       def create_view(template, destination)
-        if wui.model
+        if web_ui.model
           template template, destination
         else
           create_file destination
         end
       end
 
-      def wui
+      def web_ui
         @element
       end
 
       def actions
-        wui.actions
+        web_ui.actions
       end
 
     end

data/lib/generators/katapult/{w_u_i → web_ui}/templates/_route.rb

@@ -1,12 +1,12 @@
-% rails_actions = wui.actions - wui.custom_actions
+% rails_actions = web_ui.actions - web_ui.custom_actions
 resources <%= model_name(:symbols) %>, only: <%= rails_actions.map(&:name).map(&:to_sym) %> do
     member do
-% wui.custom_actions.select(&:member?).each do |action|
+% web_ui.custom_actions.select(&:member?).each do |action|
       <%= action.method %> '<%= action.name %>'
 % end
     end
     collection do
-% wui.custom_actions.select(&:collection?).each do |action|
+% web_ui.custom_actions.select(&:collection?).each do |action|
       <%= action.method %> '<%= action.name %>'
 % end
     end