katapult 0.4.1 → 0.5.0

data/Rakefile

@@ -16,11 +16,11 @@ RSpec::Core::RakeTask.new(:spec)
 task :update_readme do
   require_relative 'lib/katapult/version'
   readme_path = 'README.md'
+
   readme = File.read readme_path
+  readme.sub! /\A# Katapult.*\nGenerating.*\n/, '# ' + `bin/katapult version`
+  readme.sub! /(required .Ruby. version is )[\d\.]+\d/, "\\1#{Katapult::RUBY_VERSION}"
 
-  # Using \s+ to support line breaks
-  readme.sub! /(currently\s+it's\s+Rails\s+)[\d\.]+/, "\\1#{Katapult::RAILS_VERSION}"
-  readme.sub! /(and\s+Ruby\s+)[\d\.]+\d/, "\\1#{Katapult::RUBY_VERSION}"
   File.open readme_path, 'w' do |f|
     f.write readme
   end

data/bin/katapult

@@ -3,8 +3,6 @@
 # This script simplifies the usage of `katapult` by grouping relevant actions
 # that the user else had to perform manually.
 
-usage = 'Usage: katapult new APP_NAME | fire [path/to/model] | version'
-
 require_relative '../lib/katapult/version'
 require_relative '../lib/katapult/support/binary_util'
 util = Katapult::BinaryUtil
@@ -35,6 +33,25 @@ is not supported by this version of katapult.
 Please switch to Ruby #{supported_ruby} and run again.
 MSG
 
+# Prepare output ###############################################################
+
+# This is also used as README heading
+version = <<-VERSION
+Katapult #{Katapult::VERSION}
+Generating a Rails #{Katapult::RAILS_VERSION} app on Ruby #{Katapult::RUBY_VERSION}.
+VERSION
+
+usage = <<-USAGE
+Usage: katapult <command>
+
+Commands:
+new APP_NAME    Generate a configured Rails application
+fire [PATH]     Transform application model into code
+                Default path: lib/katapult/application_model.rb
+templates       Copy templates to lib/templates/katapult
+version         Print version
+USAGE
+
 
 case ARGV.shift
 when 'new'
@@ -78,13 +95,16 @@ when 'new'
 Application initialization done.
 
 Next steps:
-
+- \`cd #{app_name}\`
+- Customize Katapult's template files in lib/templates/katapult
 - Model your application in lib/katapult/application_model.rb and transform it
-  into code by running `katapult fire`
+  into code by running \`katapult fire\`
+- Run \`bundle update\` if you want to use the latest versions of all gems
 - Configure public/robots.txt
 - Write a README
   INSTRUCTIONS
 
+
 when 'fire'
   app_model_path = ARGV.shift || 'lib/katapult/application_model.rb'
   transform_command = 'bin/rails generate katapult:transform ' + app_model_path
@@ -102,12 +122,18 @@ Now boot up your development server (e.g. with `rails server`) and try your
 kickstarted application in the browser!
   INSTRUCTIONS
 
+
+when 'templates'
+  util.run 'bundle exec rails generate katapult:templates'
+  util.pink 'Templates copied to lib/templates/katapult.'
+
+
 when 'version'
-  puts <<-VERSION
-Katapult #{Katapult::VERSION}
-Generating a Rails #{Katapult::RAILS_VERSION} app on Ruby #{Katapult::RUBY_VERSION}.
-  VERSION
+  puts version
+
 
 else
+  puts version
+  puts
   puts usage
 end

data/features/application_model.feature

@@ -5,50 +5,14 @@ Feature: The default application model prepared by Katapult
     Given a new Rails application with Katapult basics installed
 
     When I generate the application model
-    Then the file "lib/katapult/application_model.rb" should contain:
-    """
-    # 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
-
-      # Reference other models just like you called them
-      product.belongs_to 'user'
-    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'
-
-    """
+    Then the file "lib/katapult/application_model.rb" should contain "crud 'product'"
+      And the file "lib/katapult/application_model.rb" should contain "product.attr :price, type: :money"
+      And the file "lib/katapult/application_model.rb" should contain "product.belongs_to 'user'"
+
+      And the file "lib/katapult/application_model.rb" should contain "model 'user'"
+      And the file "lib/katapult/application_model.rb" should contain "web_ui 'user'"
+      And the file "lib/katapult/application_model.rb" should contain "navigation"
+      And the file "lib/katapult/application_model.rb" should contain "authenticate 'user'"
 
     When I successfully transform the application model including migrations
       And I run cucumber

data/features/authenticate.feature

@@ -7,10 +7,12 @@ Feature: Add authentication to an application
 
 
   Scenario: Authenticate with the user model
+    # Have a custom "label attr" (:name)
     When I write to "lib/katapult/application_model.rb" with:
       """
-      model 'user'
-      web_ui('user', &:crud)
+      crud 'user' do |user|
+        user.attr :name
+      end
       authenticate 'user', system_email: 'system@example.com'
       """
     And I successfully transform the application model including migrations
@@ -267,11 +269,11 @@ Feature: Add authentication to an application
 
 
         Scenario: Reset password as a signed-in user
-          Given there is a user with the email "henry@example.com"
+          Given there is a user with the email "henry@example.com" and the name "name-string"
             And I sign in as the user above
 
           When I go to the homepage
-            And I follow "henry@example.com" within the navbar
+            And I follow "name-string" within the navbar
           Then I should be on the form for the user above
 
           When I fill in "Password" with "new-password"
@@ -351,3 +353,18 @@ Feature: Add authentication to an application
 
     When I run cucumber
     Then the features should pass
+
+
+  Scenario: Generate a model with authentication twice
+    Given I write to "lib/katapult/application_model.rb" with:
+      """
+      crud 'user'
+      authenticate 'user', system_email: 'system@example.com'
+      """
+
+    When I successfully transform the application model
+      And I successfully transform the application model, ignoring conflicts
+    Then the file named "spec/factories/factories.rb" should contain "factory :user" exactly once
+
+    When I run cucumber
+    Then the features should pass

data/features/basics.feature

@@ -25,6 +25,7 @@ Feature: Preparation of a new Rails app (basics generator)
 
     And the configured Rails version should be listed in the Gemfile.lock
     And the file "Gemfile" should contain "gem 'katapult', path: '../../..'"
+    And a file named "Gemfile.lock" should exist
 
     And the file "app/controllers/application_controller.rb" should contain:
     """
@@ -63,6 +64,9 @@ Feature: Preparation of a new Rails app (basics generator)
     And binstubs should be set up
 
 
+    And the file "app/models/application_record.rb" should contain "def these"
+    And the file "app/models/application_record.rb" should contain "def find_by_anything"
+
     # Config
     And the file "config/application.rb" should contain "config.time_zone = 'Berlin'"
     And the file "config/application.rb" should contain "config.system_email = 'system@katapult_test_app.com'"
@@ -132,6 +136,7 @@ Feature: Preparation of a new Rails app (basics generator)
       require filename
     end
     """
+    And a file "config/schedule.rb" should exist
     And the file "config/secrets.yml" should contain:
     """
     staging:
@@ -141,95 +146,17 @@ Feature: Preparation of a new Rails app (basics generator)
 
 
     # Lib
-    And the file "lib/ext/active_record/find_by_anything.rb" should contain:
-    """
-    ActiveRecord::Base.class_eval do
-
-      def self.find_by_anything(identifier)
-    """
-    And the file "lib/ext/action_view/spec_label.rb" should contain:
-    """
-    ActionView::Helpers::FormBuilder.class_eval do
-
-      def spec_label(field, text = nil, options = {})
-    """
-    And the file "lib/ext/action_view/form_for_with_development_errors.rb" should contain:
-    """
-    if Rails.env.development?
-
-      ActionView::Helpers::FormHelper.module_eval do
-        def form_for_with_development_errors
-    """
-    And the file "lib/ext/active_record/these.rb" should contain:
-    """
-    ActiveRecord::Base.class_eval do
-
-      def self.these(arg)
-        where(id: arg.collect_ids)
-      end
-    """
-    And the file "lib/ext/array/xss_aware_join.rb" should contain:
-    """
-    Array.class_eval do
-      def xss_aware_join(delimiter = '')
-        ''.html_safe.tap do |str|
-          each_with_index do |element, i|
-            str << delimiter if i > 0
-            str << element
-          end
-        end
-      end
-    end
-    """
-    And the file "lib/ext/enumerable/natural_sort.rb" should contain:
-    """
-    module Enumerable
-
-      def natural_sort
-    """
-    And the file "lib/ext/hash/infinite.rb" should contain:
-    """
-    class Hash
-
-      def self.infinite
-        new { |h, k| h[k] = new(&h.default_proc) }
-      end
-
-    end
-    """
-    And the file "lib/ext/string/html_entities.rb" should contain:
-    """
-    class String
-
-      def self.nbsp
-        ' '
-      end
-
-      def self.ndash
-        '–'
-      end
-
-    end
-    """
-    And the file "lib/ext/string/to_sort_atoms.rb" should contain:
-    """
-    String.class_eval do
-
-      def to_sort_atoms
-        SmartSortAtom.parse(self)
-      end
-
-    end
-    """
-    And the file "lib/tasks/pending_migrations.rake" should contain:
-    """
-          pending_migrations = ActiveRecord::Migrator.new(:up, all_migrations).pending_migrations
-
-          if pending_migrations.any?
-            puts ''
-            puts '======================================================='
-            puts "You have #{ pending_migrations.size } pending migrations:"
-    """
+    And Katapult templates should have been copied to the application
+
+    And a file "lib/ext/action_view/spec_label.rb" should exist
+    And a file "lib/ext/action_view/form_for_with_development_errors.rb" should exist
+    And a file "lib/ext/array/xss_aware_join.rb" should exist
+    And a file "lib/ext/enumerable/natural_sort.rb" should exist
+    And a file "lib/ext/hash/infinite.rb" should exist
+    And the file "lib/ext/string/html_entities.rb" should contain "def self.nbsp"
+    And the file "lib/ext/string/html_entities.rb" should contain "def self.ndash"
+    And a file "lib/ext/string/to_sort_atoms.rb" should exist
+    And a file "lib/tasks/pending_migrations.rake" should exist
 
 
     # Tests

data/features/binary.feature

@@ -4,7 +4,17 @@ Feature: Katapult binary `katapult`
 
   Scenario: Run without arguments
     When I run `katapult`
-    Then the output should contain "Usage: katapult new APP_NAME | fire [path/to/model] | version"
+    Then the output should contain:
+    """
+    Usage: katapult <command>
+
+    Commands:
+    new APP_NAME    Generate a configured Rails application
+    fire [PATH]     Transform application model into code
+                    Default path: lib/katapult/application_model.rb
+    templates       Copy templates to lib/templates/katapult
+    version         Print version
+    """
 
 
   Scenario: Print versions
@@ -13,6 +23,11 @@ Feature: Katapult binary `katapult`
       And the output should contain "Generating a Rails 5."
       And the output should contain " app on Ruby 2."
 
+    When I run `katapult -v`
+    Then the output should contain "Katapult"
+      And the output should contain "Generating a Rails 5."
+      And the output should contain " app on Ruby 2."
+
 
   Scenario: Missing options are asked for
     When I run `katapult new` interactively
@@ -36,6 +51,10 @@ Feature: Katapult binary `katapult`
 
 #  @announce-output
   Scenario: Start new Rails application
+
+    This scenario is particularly prone to "Spring zombies". If it fails, make
+    sure there are no broken Spring instances (see README).
+
     # Rails new including yarn install + installing basics takes quite some time
     Given the aruba exit timeout is 90 seconds
 
@@ -45,9 +64,12 @@ Feature: Katapult binary `katapult`
       And the output should contain "Generating katapult basics"
 
       And the output should contain "Application initialization done."
+      And the output should contain "cd binary_test"
       And the output should contain "Model your application in lib/katapult/application_model.rb"
       And the output should contain "Configure public/robots.txt"
       And the output should contain "Write a README"
+      And the output should contain "Run `bundle update`"
+      And the output should contain "Customize Katapult's template files"
 
     When I cd to "binary_test"
     Then the file "Gemfile" should contain "gem 'katapult'"
@@ -97,10 +119,10 @@ Feature: Katapult binary `katapult`
     """
     model 'custom'
     """
-    And I run `katapult fire lib/katapult/custom_model.rb`
+      And I run `katapult fire lib/katapult/custom_model.rb`
     Then the output should contain "Loading katapult"
-    And the output should contain "parse  lib/katapult/custom_model"
-    And a file named "app/models/custom.rb" should exist
+      And the output should contain "parse  lib/katapult/custom_model"
+      And a file named "app/models/custom.rb" should exist
 
 
   Scenario: When the transformation fails, an error message is printed
@@ -115,3 +137,14 @@ Feature: Katapult binary `katapult`
     And I run `katapult fire`
     Then the output should not contain "Model transformation done"
     But the output should contain "x Something went wrong"
+
+
+  Scenario: Copying templates to the application
+    Given a pristine Rails application
+
+    When I install katapult
+    Then a directory named "lib/templates/katapult" should not exist
+
+    When I run `katapult templates`
+    Then a directory named "lib/templates/katapult" should exist
+      And Katapult templates should have been copied to the application

data/features/model.feature

@@ -188,19 +188,21 @@ Feature: Generate Models
       """
       model 'Person' do |person|
         person.attr :age, type: :integer, assignable_values: 9..99
+        person.attr :mood, assignable_values: %w[happy pensive]
         person.attr :hobby, assignable_values: %w[soccer baseball], default: 'soccer', allow_blank: true
       end
       """
     And I successfully transform the application model including migrations
-    Then the file "app/models/person.rb" should contain exactly:
+    Then the file "app/models/person.rb" should contain:
       """
-      class Person < ApplicationRecord
-
-
         assignable_values_for :age, {} do
           9..99
         end
 
+        assignable_values_for :mood, {} do
+          ["happy", "pensive"]
+        end
+
         assignable_values_for :hobby, {:allow_blank=>true, :default=>"soccer"} do
           ["soccer", "baseball"]
         end
@@ -208,26 +210,19 @@ Feature: Generate Models
         def to_s
           age.to_s
         end
-
-      end
-
       """
-    And the file "spec/models/person_spec.rb" should contain exactly:
+    And the file "spec/models/person_spec.rb" should contain:
       """
-      describe Person do
-
-        describe '#to_s' do
-          it 'returns the #age attribute' do
-            subject.age = 9
-            expect(subject.to_s).to eq("9")
-          end
-        end
-
         describe '#age' do
           it { is_expected.to allow_value(99).for(:age) }
           it { is_expected.to_not allow_value(100).for(:age) }
         end
 
+        describe '#mood' do
+          it { is_expected.to allow_value("pensive").for(:mood) }
+          it { is_expected.to_not allow_value("pensive-unassignable").for(:mood) }
+        end
+
         describe '#hobby' do
           it { is_expected.to allow_value("baseball").for(:hobby) }
           it { is_expected.to_not allow_value("baseball-unassignable").for(:hobby) }
@@ -236,23 +231,41 @@ Feature: Generate Models
             expect(subject.hobby).to eq("soccer")
           end
         end
+      """
+      And the file "spec/factories/factories.rb" should contain:
+      """
+        factory :person do
+          age 9
+          mood "happy"
+        end
+      """
 
-      end
-
+    When I write to "spec/models/factory_spec.rb" with:
       """
+      describe Person do
 
-    When I run rspec
+        describe 'person factory' do
+          subject { create :person }
+
+          it 'generates a valid record' do
+            expect(subject).to be_valid
+          end
+        end
+
+      end
+      """
+      And I run rspec
     Then the specs should pass
 
 
   Scenario: Transform the application model multiple times
 
-    Do not add routes twice.
+    Some generators inject code snippets into files. They should not do this
+    if their snippet is already present.
 
     When I write to "lib/katapult/application_model.rb" with:
       """
-      model('Car') { |c| c.attr :model }
-      web_ui 'Car', &:crud
+      crud('Car') { |c| c.attr :model }
       """
       And I successfully transform the application model
     Then the file named "config/routes.rb" should contain:
@@ -261,7 +274,8 @@ Feature: Generate Models
         root 'cars#index'
         resources :cars
       """
-      And I successfully transform the application model
+
+    When I successfully transform the application model
     Then the file named "config/routes.rb" should contain:
       """
       Rails.application.routes.draw do
@@ -271,3 +285,5 @@ Feature: Generate Models
       And the file named "config/routes.rb" should contain "root 'cars#index'" exactly once
       And the file named "config/routes.rb" should contain "resources :cars" exactly once
       And the output should contain "Routes for :cars already exist! Not updated."
+
+      And the file named "spec/factories/factories.rb" should contain "factory :car" exactly once