katapult 0.2.0 → 0.3.0

data/features/{wui.feature → web_ui.feature}

@@ -1,13 +1,13 @@
+#@announce-output
+#@announce-stderr
 Feature: Web User Interface
 
   Background:
-    Given a pristine Rails application
-    And I install katapult
-    And I generate katapult basics
+    Given a new Rails application with Katapult basics installed
 
 
   Scenario: Generate a Web User Interface
-    When I overwrite "lib/katapult/application_model.rb" with:
+    When I write to "lib/katapult/application_model.rb" with:
       """
       model 'customer' do |customer|
         customer.attr :name
@@ -24,15 +24,11 @@ Feature: Web User Interface
         customer.attr :plain_data, type: :plain_json
       end
 
-      wui 'customer', model: 'customer' do |wui|
-        wui.crud
-        wui.action :get_member, method: :get, scope: :member
-        wui.action :post_member, method: :post, scope: :member
-        wui.action :get_collection, method: :get, scope: :collection
-        wui.action :put_collection, method: :put, scope: :collection
+      web_ui 'customer', model: 'customer' do |web_ui|
+        web_ui.crud
       end
       """
-    And I successfully transform the application model
+    And I successfully transform the application model including migrations
     Then the file "app/controllers/customers_controller.rb" should contain exactly:
       """
       class CustomersController < ApplicationController
@@ -51,7 +47,7 @@ Feature: Web User Interface
 
         def create
           build_customer
-          save_customer or render :new
+          save_customer
         end
 
         def edit
@@ -62,7 +58,7 @@ Feature: Web User Interface
         def update
           load_customer
           build_customer
-          save_customer or render :edit
+          save_customer
         end
 
         def destroy
@@ -71,24 +67,6 @@ Feature: Web User Interface
           redirect_to customers_path
         end
 
-        def get_member
-          load_customer
-        end
-
-        def post_member
-          load_customer
-          redirect_to @customer
-        end
-
-        def get_collection
-          load_customers
-        end
-
-        def put_collection
-          load_customers
-          redirect_to customers_path
-        end
-
         private
 
         def load_customers
@@ -100,19 +78,36 @@ Feature: Web User Interface
         end
 
         def build_customer
-          @customer ||= customer_scope.build
+          @customer ||= customer_scope.new
           @customer.attributes = customer_params
         end
 
         def save_customer
           if @customer.save
             redirect_to @customer
+          else
+            action = @customer.new_record? ? 'new' : 'edit'
+            render action, status: :unprocessable_entity
           end
         end
 
         def customer_params
           customer_params = params[:customer]
-          customer_params ? customer_params.permit(%i[name age email password revenue homepage locked notes first_visit indexable_data plain_data]) : {}
+          return {} if customer_params.blank?
+
+          customer_params.permit(
+            :name,
+            :age,
+            :email,
+            :password,
+            :revenue,
+            :homepage,
+            :locked,
+            :notes,
+            :first_visit,
+            :indexable_data,
+            :plain_data,
+          )
         end
 
         def customer_scope
@@ -124,58 +119,49 @@ Feature: Web User Interface
       """
     And the file "config/routes.rb" should contain:
       """
-        resources :customers, only: [:index, :show, :new, :create, :edit, :update, :destroy] do
-          member do
-            get 'get_member'
-            post 'post_member'
-          end
-          collection do
-            get 'get_collection'
-            put 'put_collection'
-          end
-        end
+        resources :customers
       """
+    And the file "app/helpers/table_helper.rb" should contain "def table(*headers, &block)"
+
+    And a file named "app/webpack/assets/stylesheets/blocks/action_bar.sass" should exist
+    And a file named "app/webpack/assets/stylesheets/blocks/title.sass" should exist
+
     And the file "app/views/customers/index.html.haml" should contain exactly:
       """
-      %h1
-        Customers
+      .action-bar.-main.btn-group
+        = link_to 'Add customer', new_customer_path, class: 'btn btn-default'
 
-      .tools
-        = link_to 'Add customer', new_customer_path, class: 'tools__button is_primary'
-        = link_to 'Get Collection', get_collection_customers_path, class: 'tools__button'
-        = link_to 'Put Collection', put_collection_customers_path, class: 'tools__button'
+      %h1.title
+        Customers
 
       - if @customers.any?
-        %table.items
+
+        = table 'Name', 'Actions' do
           - @customers.each do |customer|
-            %tr
+            %tr(up-expand)
+              %td(width='40%')
+                = link_to customer, customer
               %td
-                = link_to customer.to_s, customer, class: 'hyperlink'
-              %td
-                .items__actions
-                  = link_to 'Edit', edit_customer_path(customer), class: 'items__action'
-                  = link_to 'Destroy', customer_path(customer), method: :delete, class: 'items__action', data: { confirm: 'Really destroy?' }, title: "Destroy #{customer.to_s}"
-                  = link_to 'Get Member', get_member_customer_path(customer), class: 'items__action'
-                  = link_to 'Post Member', post_member_customer_path(customer), class: 'items__action', method: :post
+                = link_to 'Edit', edit_customer_path(customer)
+                = link_to 'Destroy', customer_path(customer), method: :delete,
+                  class: 'text-danger',
+                  data: { confirm: 'Really destroy?' }, title: "Destroy #{customer}"
 
       - else
         %p.help-block
-          There are no customers yet.
+          No customers found.
 
       """
     And the file "app/views/customers/show.html.haml" should contain exactly:
       """
-      %h1
-        = @customer.to_s
+      .action-bar.-main.btn-group
+        = link_to 'All customers', customers_path, class: 'btn btn-default'
+        = link_to 'Edit', edit_customer_path(@customer), class: 'btn btn-default'
 
-      .tools
-        = link_to 'All customers', customers_path, class: 'tools__button'
-        = link_to 'Edit', edit_customer_path(@customer), class: 'tools__button is_primary'
-        = link_to 'Destroy', customer_path(@customer), method: :delete, class: 'tools__button', confirm: 'Really destroy?'
-        = link_to 'Get Member', get_member_customer_path(@customer), class: 'tools__button'
-        = link_to 'Post Member', post_member_customer_path(@customer), class: 'tools__button', method: :post
+      %h1.title
+        = @customer
 
-      %dl.values
+      %dl
         %dt
           = Customer.human_attribute_name(:name)
         %dd
@@ -187,7 +173,7 @@ Feature: Web User Interface
         %dt
           = Customer.human_attribute_name(:email)
         %dd
-          = mail_to @customer.email, nil, class: 'hyperlink'
+          = mail_to @customer.email, nil
         %dt
           = Customer.human_attribute_name(:revenue)
         %dd
@@ -196,7 +182,7 @@ Feature: Web User Interface
         %dt
           = Customer.human_attribute_name(:homepage)
         %dd
-          = link_to @customer.homepage, @customer.homepage, class: 'hyperlink'
+          = link_to @customer.homepage, @customer.homepage
         %dt
           = Customer.human_attribute_name(:locked)
         %dd
@@ -211,12 +197,9 @@ Feature: Web User Interface
           = l(@customer.first_visit.to_date) if @customer.first_visit
 
       """
-    # Note that no views are generated for JSON fields, as they are mainly data
-    # storage fields
-
     And the file "app/views/customers/new.html.haml" should contain exactly:
       """
-      %h1
+      %h1.title
         Add customer
 
       = render 'form'
@@ -224,8 +207,8 @@ Feature: Web User Interface
       """
     And the file "app/views/customers/edit.html.haml" should contain exactly:
       """
-      %h1
-        = @customer.to_s
+      %h1.title
+        = @customer
 
       = render 'form'
 
@@ -234,71 +217,55 @@ Feature: Web User Interface
       """
       = form_for @customer do |form|
 
-        %dl.controls
-          %dt
-            = form.label :name
-          %dd
-            = form.text_field :name
-          %dt
-            = form.label :age
-          %dd
-            = form.number_field :age
-          %dt
-            = form.label :email
-          %dd
-            = form.email_field :email
-          %dt
-            = form.label :password
-          %dd
-            = form.password_field :password
-          %dt
-            = form.label :revenue
-          %dd
-            = form.number_field :revenue
-            €
-          %dt
-            = form.label :homepage
-          %dd
-            = form.url_field :homepage
-          %dt
-            = form.label :locked
-          %dd
-            = form.check_box :locked
-          %dt
-            = form.label :notes
-          %dd
-            = form.text_area :notes, rows: 5
-          %dt
-            = form.label :first_visit
-          %dd
-            = form.date_field :first_visit
-
-        .tools
-          = form.submit 'Save', class: 'tools__button is_primary'
+        .form-group
+          = form.label :name
+          = form.text_field :name, class: 'form-control'
+        .form-group
+          = form.label :age
+          = form.number_field :age, class: 'form-control'
+        .form-group
+          = form.label :email
+          = form.email_field :email, class: 'form-control'
+        .form-group
+          = form.label :password
+          = form.password_field :password, class: 'form-control',
+            autocomplete: 'new-password'
+        .form-group
+          = form.label :revenue
+          .input-group
+            = form.number_field :revenue, class: 'form-control'
+            .input-group-addon
+              €
+        .form-group
+          = form.label :homepage
+          = form.url_field :homepage, class: 'form-control'
+        .form-group
+          = form.label :locked
+          .checkbox
+            = form.label :locked do
+              = form.check_box :locked
+        .form-group
+          = form.label :notes
+          = form.text_area :notes, rows: 5, class: 'form-control'
+        .form-group
+          = form.label :first_visit
+          = form.date_field :first_visit, class: 'form-control'
+
+        .action-bar
           - cancel_path = @customer.new_record? ? customers_path : customer_path(@customer)
-          = link_to 'Cancel', cancel_path, class: 'tools__button'
 
-      """
-    And the file "app/views/customers/get_member.html.haml" should contain exactly:
-      """
-      %h1
-        Get Member
+          .pull-right
+            - if @customer.persisted?
+              = link_to "Destroy customer", customer_path(@customer), method: :delete,
+                class: 'btn btn-danger', data: { confirm: 'Really destroy?' }
 
-      .tools
-        = link_to 'All customers', customers_path, class: 'tools__button'
+          = form.submit 'Save', class: 'btn btn-primary'
+          = link_to 'Cancel', cancel_path, class: 'btn btn-link'
 
       """
-    But a file named "app/views/customers/post_member.html.haml" should not exist
-    And the file "app/views/customers/get_collection.html.haml" should contain exactly:
-      """
-      %h1
-        Get Collection
-
-      .tools
-        = link_to 'All customers', customers_path, class: 'tools__button'
+    # Note that no form fields are generated for JSON fields, as they are mainly
+    # data storage fields
 
-      """
-    But a file named "app/views/customers/put_collection.html.haml" should not exist
     And the file "features/customers.feature" should contain exactly:
       """
       Feature: Customers
@@ -348,7 +315,7 @@ Feature: Web User Interface
 
           When I follow "Destroy name-string"
           Then I should be on the list of customers
-            But I should not see "name-string"
+          But I should not see "name-string"
 
       """
 
@@ -356,24 +323,84 @@ Feature: Web User Interface
     Then the features should pass
 
 
-  Scenario: A WUI also generates the application layout file
-    When I overwrite "lib/katapult/application_model.rb" with:
+  Scenario: Generate a Web User Interface with custom actions
+    When I write to "lib/katapult/application_model.rb" with:
       """
-      model 'Car'
-      wui 'Car'
+      model 'customer' do |customer|
+        customer.attr :name
+      end
+
+      web_ui 'customer', model: 'customer' do |web_ui|
+        web_ui.crud
+        web_ui.action :get_member, method: :get, scope: :member
+        web_ui.action :post_member, method: :post, scope: :member
+        web_ui.action :get_collection, method: :get, scope: :collection
+        web_ui.action :put_collection, method: :put, scope: :collection
+      end
       """
     And I successfully transform the application model
-    Then the file "app/views/layouts/application.html.haml" should contain:
+    Then the file "app/controllers/customers_controller.rb" should contain:
       """
-      = query_diet_widget(bad_count: 15) if Rails.env.development?
+
+        def get_member
+          load_customer
+        end
+
+        def post_member
+          load_customer
+          redirect_to @customer
+        end
+
+        def get_collection
+          load_customers
+        end
+
+        def put_collection
+          load_customers
+          redirect_to customers_path
+        end
+
       """
-    And the file "app/views/layouts/application.html.haml" should contain:
+    And the file "config/routes.rb" should contain:
       """
-      = render 'layouts/flashes'
+        resources :customers, only: [:index, :show, :new, :create, :edit, :update, :destroy] do
+          member do
+            get 'get_member'
+            post 'post_member'
+          end
+          collection do
+            get 'get_collection'
+            put 'put_collection'
+          end
+        end
+      """
+    And the file "app/views/customers/index.html.haml" should contain:
+      """
+        = link_to 'Get Collection', get_collection_customers_path, class: 'btn btn-default'
+        = link_to 'Put Collection', put_collection_customers_path, class: 'btn btn-default'
+      """
+    And the file "app/views/customers/show.html.haml" should contain:
+      """
+        = link_to 'Get Member', get_member_customer_path(@customer), class: 'btn btn-default'
+        = link_to 'Post Member', post_member_customer_path(@customer), class: 'btn btn-default', method: :post
       """
-    And the file "app/views/layouts/_flashes.html.haml" should contain:
+    And the file "app/views/customers/get_member.html.haml" should contain exactly:
+      """
+      .action-bar
+        = link_to 'All customers', customers_path, class: 'btn btn-default'
+
+      %h1.title
+        Get Member
+
+      """
+    But a file named "app/views/customers/post_member.html.haml" should not exist
+    And the file "app/views/customers/get_collection.html.haml" should contain exactly:
       """
-      - flash.each do |level, message|
-        .flash.alert.alert-info
-          = message
+      .action-bar
+        = link_to 'All customers', customers_path, class: 'btn btn-default'
+
+      %h1.title
+        Get Collection
+
       """
+    But a file named "app/views/customers/put_collection.html.haml" should not exist

data/katapult.gemspec

@@ -9,7 +9,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Dominik Schöler']
   spec.email         = ['dominik.schoeler@makandra.de']
   spec.summary       = %q{Kickstart Rails development}
-  spec.description   = %q{Katapult is a framework for generating base code}
+  spec.description   = %q{
+    Katapult is a framework for generating base code for Rails applications in
+    two leaps. Basics Generation prepares a new Rails application with lots of
+    best practices, Model Transformation generates application code from a model
+    of the application.
+  }
   spec.homepage      = 'https://github.com/makandra/katapult'
   spec.license       = 'MIT'
 
@@ -18,18 +23,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '~> 2.0'
+  # spec.required_ruby_version = Katapult::RUBY_VERSION
 
-  spec.add_runtime_dependency 'rails'
+  spec.add_runtime_dependency 'rails', Katapult::RAILS_VERSION
   spec.add_runtime_dependency 'spring' # speed-up
-
-  # Development
-  spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'pry'
-
-  # Testing
-  spec.add_development_dependency 'aruba', '~> 0.10.2'
-  spec.add_development_dependency 'guard-cucumber'
-  spec.add_development_dependency 'rspec', '~> 3.4.0'
 end

data/lib/generators/katapult/app_model/app_model_generator.rb

@@ -0,0 +1,12 @@
+module Katapult
+  class AppModelGenerator < Rails::Generators::Base
+
+    desc 'Generate the default application model'
+    source_root File.expand_path('../templates', __FILE__)
+
+    def generate_application_model
+      template 'lib/katapult/application_model.rb'
+    end
+
+  end
+end

data/lib/generators/katapult/app_model/templates/lib/katapult/application_model.rb

@@ -0,0 +1,40 @@
+# In this file, you model your application. Refer to the README or get inspired
+# by the full-fledged example below (which you can generate right away).
+
+# Define a model + generate views with CRUD actions
+# Since this generates the first web UI with an index action, the products list
+# will become the home page of the generated app
+crud 'product' do |product|
+  # The first attribute of each model is taken as a human identifier/label
+  product.attr :title # Default type "string"
+
+  # The order of attributes is respected when generating the form for that model
+  product.attr :price, type: :money
+  product.attr :mode, assignable_values: %w[public private]
+  product.attr :provider, type: :url
+  product.attr :import_data, type: :json
+end
+
+# Define a model
+model 'user' do |user|
+  user.attr :email # Type "email" derived from attribute name
+
+  user.attr :name
+  user.attr :last_visit, type: :datetime
+  user.attr :locked, type: :flag, default: false
+end
+
+# Add a web user interface for the 'user' model
+web_ui 'user' do |web_ui|
+  # All CRUD actions: index, show, new, create, edit, update, destroy
+  web_ui.crud
+
+  # Custom action
+  web_ui.action :lock, scope: :member, method: :post
+end
+
+# Have a main menu
+navigation
+
+# Add authentication
+authenticate 'user', system_email: 'system@example.com'