katapult 0.2.0 → 0.3.0

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

@@ -1,57 +1,53 @@
 class <%= model_name(:classes) %>Controller < ApplicationController
-<%- if navigation -%>
-
-  before_filter :set_section
-<%- end -%>
-<% if wui.find_action :index -%>
+<% if web_ui.find_action :index -%>
 
   def index
     <%= method_name(:load_collection) %>
   end
 <% end -%>
-<% if wui.find_action :show -%>
+<% if web_ui.find_action :show -%>
 
   def show
     <%= method_name(:load_object) %>
   end
 <% end -%>
-<% if wui.find_action :new -%>
+<% if web_ui.find_action :new -%>
 
   def new
     <%= method_name(:build) %>
   end
 <% end -%>
-<% if wui.find_action :create -%>
+<% if web_ui.find_action :create -%>
 
   def create
     <%= method_name(:build) %>
-    <%= method_name(:save) %> or render :new
+    <%= method_name(:save) %>
   end
 <% end -%>
-<% if wui.find_action :edit -%>
+<% if web_ui.find_action :edit -%>
 
   def edit
     <%= method_name(:load_object) %>
     <%= method_name(:build) %>
   end
 <% end -%>
-<% if wui.find_action :update -%>
+<% if web_ui.find_action :update -%>
 
   def update
     <%= method_name(:load_object) %>
     <%= method_name(:build) %>
-    <%= method_name(:save) %> or render :edit
+    <%= method_name(:save) %>
   end
 <% end -%>
-<% if wui.find_action :destroy -%>
+<% if web_ui.find_action :destroy -%>
 
   def destroy
     <%= method_name(:load_object) %>
     <%= model_name(:ivar) %>.destroy
-    redirect_to <%= wui.path(:index) %>
+    redirect_to <%= web_ui.path(:index) %>
   end
 <% end -%>
-<% wui.custom_actions.each do |action|  -%>
+<% web_ui.custom_actions.each do |action|  -%>
 
   def <%= action.name %>
 <% if action.member? -%>
@@ -62,7 +58,7 @@ class <%= model_name(:classes) %>Controller < ApplicationController
 <% elsif action.collection? -%>
     <%= method_name(:load_collection) %>
   <%- unless action.get? -%>
-    redirect_to <%= wui.path(:index) %>
+    redirect_to <%= web_ui.path(:index) %>
   <%- end -%>
 <% end -%>
   end
@@ -79,28 +75,30 @@ class <%= model_name(:classes) %>Controller < ApplicationController
   end
 
   def <%= method_name(:build) %>
-    <%= model_name(:ivar) %> ||= <%= method_name(:scope) %>.build
+    <%= model_name(:ivar) %> ||= <%= method_name(:scope) %>.new
     <%= model_name(:ivar) %>.attributes = <%= method_name(:params) %>
   end
 
   def <%= method_name(:save) %>
     if <%= model_name(:ivar) %>.save
       redirect_to <%= model_name(:ivar) %>
+    else
+      action = <%= model_name(:ivar) %>.new_record? ? 'new' : 'edit'
+      render action, status: :unprocessable_entity
     end
   end
 
   def <%= method_name(:params) %>
     <%= method_name(:params) %> = params[:<%= model_name(:variable) %>]
-    <%= method_name(:params) %> ? <%= method_name(:params) %>.permit(%i[<%= wui.model.attrs.map(&:name).join(' ') %>]) : {}
+    return {} if <%= method_name(:params) %>.blank?
+
+    <%= method_name(:params) %>.permit(
+      <%= web_ui.params.join(",\n      ") %>,
+    )
   end
 
   def <%= method_name(:scope) %>
     <%= model_name(:class) %>.scoped
   end
 
-<%- if navigation -%>
-  def set_section
-    in_sections <%= navigation.section_name(wui) %>
-  end
-<%- end -%>
 end

data/lib/generators/katapult/{w_u_i/w_u_i_generator.rb → web_ui/web_ui_generator.rb}

@@ -1,11 +1,11 @@
-# Generate a controller, routes and view files for a WUI.
+# Generate a controller, routes and view files for a WebUI instance
 
 require 'katapult/generator'
-require 'generators/katapult/haml/haml_generator'
+require 'generators/katapult/views/views_generator'
 
 module Katapult
   module Generators
-    class WUIGenerator < Katapult::Generator
+    class WebUIGenerator < Katapult::Generator
 
       desc 'Generate a Web User Interface'
 
@@ -24,12 +24,11 @@ module Katapult
         if routes =~ /^\s+resources #{ route }/
           say_status :warn, <<MESSAGE, :red
 Routes for #{ route } already exist! Not updated.
-
 In order to keep existing routes created by the user, the config/routes.rb file
 is not wiped on model transformation. To have Katapult update the #{ route }
 route for you, delete it before transforming the application model.
 MESSAGE
-        elsif wui.crud_only?
+        elsif web_ui.crud_only?
           route "resources #{ route }"
         else
           route render_partial('_route.rb')
@@ -37,7 +36,7 @@ MESSAGE
       end
 
       def generate_views
-        Generators::HamlGenerator.new(wui).invoke_all
+        Generators::ViewsGenerator.new(web_ui).invoke_all
       end
 
       no_tasks do
@@ -53,17 +52,13 @@ MESSAGE
         end
 
         def model_name(kind = nil)
-          wui.model_name(kind)
-        end
-
-        def navigation
-          wui.application_model.navigation
+          web_ui.model_name(kind)
         end
       end
 
       private
 
-      def wui
+      def web_ui
         @element
       end
 

data/lib/katapult/action.rb

@@ -1,4 +1,4 @@
-# Models a controller action. To be used within the block of a WUI.
+# Models a controller action. To be used within the block of a WebUI.
 
 require 'katapult/element'
 require 'active_support/core_ext/module/delegation'

data/lib/katapult/application_model.rb

@@ -3,11 +3,11 @@
 module Katapult
   class ApplicationModel
 
-    attr_reader :models, :wuis, :navigation, :authentication
+    attr_reader :models, :web_uis, :navigation, :authentication
 
     def initialize
       @models = []
-      @wuis = []
+      @web_uis = []
     end
 
     def add_model(model)
@@ -19,13 +19,13 @@ module Katapult
       models.find { |m| m.name == name }
     end
 
-    def add_wui(wui)
-      wui.set_application_model(self)
-      @wuis << wui
+    def add_web_ui(web_ui)
+      web_ui.set_application_model(self)
+      @web_uis << web_ui
     end
 
-    def get_wui(name)
-      wuis.find { |w| w.name == name }
+    def get_web_ui(name)
+      web_uis.find { |w| w.name == name }
     end
 
     def set_navigation(navigation)
@@ -43,7 +43,7 @@ module Katapult
 
     def render
       models.each &:render
-      wuis.each &:render
+      web_uis.each &:render
       navigation.render if navigation
       authentication.render if authentication
     end

data/lib/katapult/binary_util.rb

@@ -1,9 +1,10 @@
 # Utility methods.
 
-# The Katapult::Util module is used inside the `katapult` script. It should not
-# require any gems in order to prevent version conflicts.
-require_relative '../katapult'
+# This module is used inside the `katapult` binary and thus should not
+# require any gems in order to prevent version conflicts
+require_relative '../katapult/version'
 require 'bundler'
+require 'io/console'
 
 module Katapult
   module BinaryUtil
@@ -15,23 +16,60 @@ module Katapult
     end
 
     def create_rails_app(name)
-      run "rails _#{ Katapult::RAILS_VERSION }_ new #{ name } --skip-test-unit --skip-bundle --database postgresql"
+      version = Katapult::RAILS_VERSION
+      options = %w[
+        --database postgresql
+        --webpack
+
+        --skip-test
+        --skip-system-test
+        --skip-turbolinks
+      ]
+
+      success = run "rails _#{version}_ new #{name} " + options.join(' ')
+      success or fail 'Failed to create Rails app'
+    end
+
+    def pink(*args, linefeed: true)
+      message = "> #{ args.join ' ' }"
+      message.prepend($/) if linefeed
+      message << (linefeed ? $/ : ' ')
+
+      pink_message = "\e[35m#{ message }\e[0m"
+      print pink_message
     end
 
-    def puts(*args)
-      message = "\n> #{ args.join ' ' }"
-      Kernel.puts "\e[35m#{ message }\e[0m" # pink
+    def ask(question)
+      pink(question, linefeed: false)
+      gets.chomp
     end
 
     # With clean Bundler env
     def run(command)
       success = Bundler.with_clean_env { system command }
+      success or fail 'Something went wrong'
+    end
 
-      if !success
-        puts 'x Something went wrong'
-        exit(1)
+    def job(do_something, done = 'Done.', &job)
+      pink "About to #{do_something}. [C]ontinue, [s]kip or [e]xit?"
+
+      case $stdin.getch
+      when 's' then puts('Skipped.')
+      when 'e' then fail('Cancelled.')
+      else
+        job.call
+        puts done
       end
     end
 
+    def fail(message)
+      puts "x #{message}"
+      exit(1)
+    end
+
+    def snake_case(string)
+      string.gsub(/([a-z])([A-Z])/,'\1_\2').downcase
+    end
+
   end
 end

data/lib/katapult/generator.rb

@@ -1,9 +1,11 @@
 # The katapult generator base class, slightly adapted from Rails generators.
 
 require 'rails/generators'
+require 'katapult/generator_goodies'
 
 module Katapult
   class Generator < Rails::Generators::NamedBase
+    include Katapult::GeneratorGoodies
 
     attr_accessor :element
 
@@ -15,20 +17,10 @@ module Katapult
 
     private
 
-    def app_name
-      File.basename(Dir.pwd)
-    end
-
     def render_partial(template_path, given_binding = nil)
       path = File.join(self.class.source_root, template_path)
       ERB.new(::File.binread(path), nil, '%').result(given_binding || binding)
     end
 
-    def run(*)
-      Bundler.with_clean_env do
-        super
-      end
-    end
-
   end
 end

data/lib/katapult/generator_goodies.rb

@@ -0,0 +1,23 @@
+module Katapult::GeneratorGoodies
+
+  def yarn(*args)
+    command =  'bin/yarn ' + args.join(' ')
+    run command
+  end
+
+  private
+
+  def app_name
+    File.basename(Dir.pwd)
+  end
+
+  # Override Thor method
+  def run(command, config={})
+    config[:capture] ||= false # false = return boolean instead of cmd output
+
+    Bundler.with_clean_env do
+      super(command, config) or exit(1)
+    end
+  end
+
+end

data/lib/katapult/navigation.rb

@@ -1,4 +1,4 @@
-# Models a navigation.
+# Models the main menu
 
 require 'katapult/element'
 require 'generators/katapult/navigation/navigation_generator'
@@ -6,12 +6,17 @@ require 'generators/katapult/navigation/navigation_generator'
 module Katapult
   class Navigation < Element
 
-    def wuis
-      application_model.wuis
+    def web_uis
+      application_model.web_uis
     end
 
-    def section_name(wui)
-      wui.model_name(:symbols)
+    def links
+      web_uis.each_with_object({}) do |web_ui, map|
+        next unless web_ui.find_action(:index).present?
+
+        label = web_ui.model_name :humans
+        map[label] = web_ui.path(:index)
+      end
     end
 
     def render

data/lib/katapult/parser.rb

@@ -3,7 +3,7 @@
 
 require_relative 'application_model'
 require 'katapult/model'
-require 'katapult/wui'
+require 'katapult/web_ui'
 require 'katapult/navigation'
 require 'katapult/authentication'
 
@@ -14,21 +14,28 @@ module Katapult
       self.application_model = Katapult::ApplicationModel.new
     end
 
-    def parse(path_to_app_model_file)
-      instance_eval File.read(path_to_app_model_file), path_to_app_model_file
+    def parse(application_model_string, path_to_model = '')
+      instance_eval application_model_string, path_to_model
 
       application_model
     end
 
-    def model(name, options = {}, &block)
-      application_model.add_model Model.new(name, options, &block)
+    def model(name, &block)
+      application_model.add_model Model.new(name, &block)
     end
 
-    def wui(name, options = {}, &block)
-      application_model.add_wui WUI.new(name, options, &block)
+    def web_ui(name, options = {}, &block)
+      application_model.add_web_ui WebUI.new(name, options, &block)
     end
 
-    def navigation(name)
+    # A shortcut to create a #model together with a default #web_ui with CRUD
+    # actions
+    def crud(name, &block)
+      application_model.add_model Model.new(name, &block)
+      application_model.add_web_ui WebUI.new(name, &:crud)
+    end
+
+    def navigation(name = :main)
       application_model.set_navigation Navigation.new(name)
     end
 

data/lib/katapult/version.rb

@@ -1,3 +1,7 @@
 module Katapult
-  VERSION = '0.2.0'
+  ruby_version_path = File.expand_path('../../.ruby-version', __dir__)
+
+  VERSION = '0.3.0'
+  RUBY_VERSION = File.read(ruby_version_path).strip
+  RAILS_VERSION = '5.1.4'
 end

data/lib/katapult/{wui.rb → web_ui.rb}

@@ -3,10 +3,10 @@
 
 require 'katapult/element'
 require 'katapult/action'
-require 'generators/katapult/w_u_i/w_u_i_generator'
+require 'generators/katapult/web_ui/web_ui_generator'
 
 module Katapult
-  class WUI < Element
+  class WebUI < Element
 
     options :model
     attr_accessor :actions
@@ -14,6 +14,7 @@ module Katapult
     RAILS_ACTIONS = %w[ index show new create edit update destroy ]
     UnknownActionError = Class.new(StandardError)
     UnknownModelError = Class.new(StandardError)
+    MissingLabelAttrError = Class.new(StandardError)
 
     def initialize(*args)
       self.actions = []
@@ -41,7 +42,13 @@ module Katapult
     def model
       model_name = @model || self.name
       application_model.get_model(model_name) or raise UnknownModelError,
-        "Could not find a model named #{model_name}"
+        "Cannot find a model named #{model_name}"
+    end
+
+    def params
+      model.attrs.map do |attr|
+        attr.name :symbol
+      end
     end
 
     def custom_actions
@@ -74,7 +81,15 @@ module Katapult
     end
 
     def render
-      Generators::WUIGenerator.new(self).invoke_all
+      validate!
+      Generators::WebUIGenerator.new(self).invoke_all
+    end
+
+    private
+
+    def validate!
+      model.label_attr.present? or raise MissingLabelAttrError,
+        'Cannot render a WebUI without a model with a label attribute'
     end
 
   end

data/lib/katapult.rb

@@ -1,7 +1,2 @@
-require 'active_support'
-require 'active_support/core_ext/hash/slice'
-
 module Katapult
-  RAILS_VERSION = '4.2.6'
-  RUBY_VERSION = '2.3.0'
 end

data/script/console

@@ -4,12 +4,15 @@
 # Run `script/console` from the gem root to start an IRB with the gem loaded.
 
 # Remember to require classes before using them,
-# i.e. run `require 'katapult/wui'` before `Katapult::WUI.new :example_name`.
+# i.e. `require 'katapult/model'` before `Katapult::Model.new :example_name`
 
 irb_options = [
   '-Ilib',      # add lib/ to load_path
   '-d',         # set $DEBUG = true
-  '-rkatapult', # require katapult
+  # Requires
+  '-rkatapult/version',
+  '-rrails',
+  '-rrails/generators',
   '-f'          # don't read ~/.irbrc
 ]
 

data/script/kta

@@ -0,0 +1,8 @@
+#!/usr/bin/env sh
+
+# kta = katapult_test_app
+# This script executes its arguments as shell command inside the generated
+# katapult test app directory
+
+cd tmp/aruba/katapult_test_app
+eval $@

data/script/update

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/katapult/version'
+require_relative '../lib/katapult/binary_util'
+
+u = Katapult::BinaryUtil
+version_path = 'lib/katapult/version.rb'
+
+
+# Intro ########################################################################
+
+at_project_root = File.exists?('lib/katapult.rb')
+at_project_root or fail 'Run this script from the Katapult project root.'
+
+puts <<INTRO
+Katapult #{Katapult::VERSION}
+
+This script will help you continue development on Katapult: updating the
+versions of Ruby and Rails, wiping tmp/ and more.
+
+It will always ask before doing anything.
+
+The script is intended as a one-time updater, but it wont' do harm if run
+repeatedly.
+
+INTRO
+
+u.pink "The Ruby version is #{`ruby -v`.chomp}."
+puts 'Should katapult use that version? [yN]'
+case $stdin.getch
+when 'y' then puts 'Ok.'
+else
+  u.pink 'Please configure the Ruby version in .ruby-version, then re-run this script.'
+  exit
+end
+
+# Jobs #########################################################################
+
+u.job 'update Bundler' do
+  system 'gem install bundler'
+end
+
+u.job "update Rails version (current: #{Katapult::RAILS_VERSION})", "#{version_path} updated." do
+  print 'Please enter the desired Rails version: '
+  rails_v = gets.strip
+
+  version_rb = File.read version_path
+  version_rb.gsub! /^(  RAILS_VERSION =).*$/, "\\1 '#{rails_v}'"
+  File.open version_path, 'w' do |f|
+    f.write version_rb
+  end
+end
+
+u.job 'update installed gems' do
+  system 'bundle update'
+end
+
+u.job 'update README' do
+  system 'rake update_readme'
+end
+
+u.job 'wipe tmp directory' do
+  puts 'Wiping ...'
+  FileUtils.rm_rf 'tmp'
+end
+
+sleep 1
+puts <<-DEBUG
+
+This script is done. Now you need to fix whatever was broken by the updates.
+
+The suggested way is to run the following features one by one, fixing issues as
+they occur:
+  features/basics.feature
+  features/binary.feature
+  features/model.feature
+
+In order to see the application output of Cucumber tests you may tag them with
+@announce-output.
+DEBUG

data/spec/action_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'katapult/action'
 
 describe Katapult::Action do

data/spec/attribute_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'katapult/attribute'
 
 describe Katapult::Attribute do

data/spec/element_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'katapult/element'
 
 describe Katapult::Element do

data/spec/model_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'katapult/model'
 require 'katapult/attribute'
 

data/spec/parser_spec.rb

@@ -0,0 +1,26 @@
+require 'katapult/parser'
+
+describe Katapult::Parser do
+
+  describe '#crud' do
+    it 'creates a model plus a web UI with crud actions' do
+      model = <<-MODEL
+crud 'user' do |user|
+  user.attr :age
+end
+      MODEL
+
+      parsed_model = subject.parse(model)
+      expect(parsed_model.models.count).to be 1
+      user = parsed_model.models.first
+      expect(user.name).to eq 'user'
+      expect(user.attrs.count).to be 1
+      expect(user.attrs.first.name).to eq 'age'
+
+      expect(parsed_model.web_uis.count).to be 1
+      web_ui = parsed_model.web_uis.first
+      expect(web_ui.actions.map(&:name)).to match Katapult::WebUI::RAILS_ACTIONS
+    end
+  end
+
+end

data/spec/util_spec.rb

@@ -1,4 +1,3 @@
-require 'spec_helper'
 require 'katapult/binary_util'
 
 describe Katapult::BinaryUtil do