katapult 0.1.2 → 0.2.0

data/features/step_definitions/rails_steps.rb

@@ -1,3 +1,5 @@
+require 'katapult/binary_util'
+
 module KatapultRailsHelper
 
   def with_aruba_timeout(timeout, &block)
@@ -12,10 +14,9 @@ module KatapultRailsHelper
 
   def create_cached_app(name)
     job = 'Cached Rails app generation'
-    rails_new_command = "bundle exec rails new #{name} --skip-test-unit --skip-bundle --database mysql"
 
     puts "#{job} started (in #{Dir.pwd})"
-    system(rails_new_command) or raise "#{job} failed"
+    Katapult::BinaryUtil.create_rails_app(name)
     puts "#{job} done."
   end
 

data/features/wui.feature

@@ -14,9 +14,14 @@ Feature: Web User Interface
         customer.attr :age, type: :integer
 
         customer.attr :email
+        customer.attr :password
         customer.attr :revenue, type: :money
         customer.attr :homepage, type: :url, default: 'http://www.makandra.de'
         customer.attr :locked, type: :flag, default: false
+        customer.attr :notes, type: :text
+        customer.attr :first_visit, type: :datetime
+        customer.attr :indexable_data, type: :json
+        customer.attr :plain_data, type: :plain_json
       end
 
       wui 'customer', model: 'customer' do |wui|
@@ -107,7 +112,7 @@ Feature: Web User Interface
 
         def customer_params
           customer_params = params[:customer]
-          customer_params ? customer_params.permit([:name, :age, :email, :revenue, :homepage, :locked]) : {}
+          customer_params ? customer_params.permit(%i[name age email password revenue homepage locked notes first_visit indexable_data plain_data]) : {}
         end
 
         def customer_scope
@@ -149,7 +154,7 @@ Feature: Web User Interface
               %td
                 .items__actions
                   = link_to 'Edit', edit_customer_path(customer), class: 'items__action'
-                  = link_to 'Destroy', customer_path(customer), method: :delete, class: 'items__action', confirm: 'Really destroy?'
+                  = 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
 
@@ -196,8 +201,19 @@ Feature: Web User Interface
           = Customer.human_attribute_name(:locked)
         %dd
           = @customer.locked ? 'Yes' : 'No'
+        %dt
+          = Customer.human_attribute_name(:notes)
+        %dd
+          = simple_format(@customer.notes)
+        %dt
+          = Customer.human_attribute_name(:first_visit)
+        %dd
+          = 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
@@ -231,6 +247,10 @@ Feature: Web User Interface
             = form.label :email
           %dd
             = form.email_field :email
+          %dt
+            = form.label :password
+          %dd
+            = form.password_field :password
           %dt
             = form.label :revenue
           %dd
@@ -244,6 +264,14 @@ Feature: Web User Interface
             = 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'
@@ -283,9 +311,12 @@ Feature: Web User Interface
             And I fill in "Name" with "name-string"
             And I fill in "Age" with "778"
             And I fill in "Email" with "email@example.com"
+            And I fill in "Password" with "password-password"
             And I fill in "Revenue" with "2.21"
             And I fill in "Homepage" with "homepage.example.com"
             And I check "Locked"
+            And I fill in "Notes" with "notes-text"
+            And I fill in "First visit" with "2022-03-25"
             And I press "Save"
 
           # read
@@ -296,6 +327,8 @@ Feature: Web User Interface
             And I should see "2.21"
             And I should see "homepage.example.com"
             And I should see "Locked Yes"
+            And I should see "notes-text"
+            And I should see "2022-03-25"
 
           # update
           When I follow "Edit"
@@ -306,12 +339,14 @@ Feature: Web User Interface
             And the "Revenue" field should contain "2.21"
             And the "Homepage" field should contain "homepage.example.com"
             And the "Locked" checkbox should be checked
+            And the "Notes" field should contain "notes-text"
+            And the "First visit" field should contain "2022-03-25"
 
           # destroy
           When I go to the list of customers
           Then I should see "name-string"
 
-          When I follow "Destroy"
+          When I follow "Destroy name-string"
           Then I should be on the list of customers
             But I should not see "name-string"
 
@@ -321,7 +356,7 @@ Feature: Web User Interface
     Then the features should pass
 
 
-  Scenario: Generate layout file with query diet widget
+  Scenario: A WUI also generates the application layout file
     When I overwrite "lib/katapult/application_model.rb" with:
       """
       model 'Car'
@@ -332,3 +367,13 @@ Feature: Web User Interface
       """
       = query_diet_widget(bad_count: 15) if Rails.env.development?
       """
+    And the file "app/views/layouts/application.html.haml" should contain:
+      """
+      = render 'layouts/flashes'
+      """
+    And the file "app/views/layouts/_flashes.html.haml" should contain:
+      """
+      - flash.each do |level, message|
+        .flash.alert.alert-info
+          = message
+      """

data/lib/generators/katapult/basics/basics_generator.rb

@@ -4,14 +4,14 @@ module Katapult
   module Generators
     class BasicsGenerator < Rails::Generators::Base
 
-      SKIP_GEMS = %w(sass-rails coffee-rails turbolinks sdoc uglifier mysql2)
+      SKIP_GEMS = %w(sass-rails coffee-rails turbolinks sdoc uglifier)
 
       desc 'Generate basics like test directories and gems'
       source_root File.expand_path('../templates', __FILE__)
 
-      class_option :db_user, type: :string,
+      class_option :db_user, type: :string, default: 'root',
         description: 'The user to set in config/database.yml'
-      class_option :db_password, type: :string,
+      class_option :db_password, type: :string, default: '',
         description: 'The password to set in config/database.yml'
 
 
@@ -24,8 +24,8 @@ module Katapult
       end
 
       def write_database_ymls
-        @db_user = options.db_user || 'root'
-        @db_password = options.db_password || ''
+        @db_user = options.db_user
+        @db_password = options.db_password
 
         template 'config/database.yml', force: true
         template 'config/database.sample.yml'
@@ -45,15 +45,15 @@ module Katapult
       def bundle_install
         run 'bundle install'
 
-        # There is a bug in the current version of Compass, so we use an older
-        # one in our Gemfile template. Since its dependencies "sprockets" and
-        # "sass-rails" are already in the Gemfile.lock (from installing Rails),
-        # we need to explicitly update them.
-        run 'bundle update sprockets sass-rails'
+        # This is relevant for the server, so it may happen after bundling here.
+        # By having Nokogiri use system libraries, it will get automatic updates
+        # of the frequently broken libxml (i.e. when the system libxml updates).
+        run 'bundle config --local build.nokogiri --use-system-libraries'
       end
 
       def remove_turbolinks_js
         gsub_file 'app/assets/javascripts/application.js', "//= require turbolinks\n", ''
+        gsub_file 'app/views/layouts/application.html.erb', ", 'data-turbolinks-track' => true", ''
       end
 
       def setup_spring
@@ -64,8 +64,38 @@ module Katapult
         run 'spring stop' # Reload (just in case)
       end
 
+      def setup_guard
+        template 'Guardfile'
+        environment 'config.middleware.use Rack::LiveReload', env: :development
+      end
+
+      def setup_staging
+        FileUtils.copy 'config/environments/production.rb', 'config/environments/staging.rb'
+        secret = `rake secret`.chomp
+        # Cheating in the "staging" secret between "test" and "production"
+        insert_into_file 'config/secrets.yml', <<~SECRET, after: "test:\n"
+          secret_key_base: #{ secret }
+
+        staging:
+        SECRET
+      end
+
       def create_databases
-        run 'rake db:create:all parallel:create'
+        run 'rake db:drop:all db:create:all parallel:create'
+      end
+
+      def configure_action_mailer
+        app_con = 'app/controllers/application_controller.rb'
+        inject_into_file app_con, <<-CONFIG, before: /end\n\z/
+  before_filter :make_action_mailer_use_request_host_and_protocol
+
+  private
+
+  def make_action_mailer_use_request_host_and_protocol
+    ActionMailer::Base.default_url_options[:protocol] = request.protocol
+    ActionMailer::Base.default_url_options[:host] = request.host_with_port
+  end
+        CONFIG
       end
 
       def set_timezone
@@ -74,8 +104,8 @@ module Katapult
           "config.time_zone = 'Berlin'"
       end
 
-      def make_assets_debuggable
-        gsub_file 'config/application.rb',
+      def disable_asset_debugging # Faster
+        gsub_file 'config/environments/development.rb',
           /config\.assets\.debug =.*$/,
           'config.assets.debug = false'
       end
@@ -84,6 +114,10 @@ module Katapult
         directory 'config/initializers'
       end
 
+      def install_ext
+        directory 'lib/ext'
+      end
+
       def add_modularity_load_paths
         # This results in correct indentation :)
         application <<-'LOAD_PATHS'
@@ -109,6 +143,22 @@ config.autoload_paths << "#{Rails.root}/app/controllers/shared"
         gsub_file '.rspec', "--warnings\n", '' # Don't show Ruby warnings
         uncomment_lines 'spec/rails_helper.rb', /Dir.Rails.root.join.+spec.support/
         template 'spec/support/shoulda_matchers.rb'
+        template 'spec/support/factory_girl.rb'
+        directory 'spec/factories'
+      end
+
+      def install_capistrano
+        # Create Capfile *before* installing Capistrano to prevent annoying
+        # Harrow.io ad
+        template 'Capfile', force: true
+        run 'cap install'
+
+        template 'config/deploy.rb', force: true
+        template 'config/deploy/staging.rb', force: true
+        template 'config/deploy/production.rb', force: true
+
+        directory 'lib/capistrano/tasks'
+        template 'lib/tasks/pending_migrations.rake'
       end
 
       def install_styles
@@ -116,10 +166,6 @@ config.autoload_paths << "#{Rails.root}/app/controllers/shared"
         directory 'app/assets/stylesheets', force: true
       end
 
-      # def install_capistrano
-      #   capify!
-      #   template 'config/deploy.rb'
-      # end
 
     private
 

data/lib/generators/katapult/basics/templates/.gitignore

@@ -25,3 +25,4 @@ coverage/*
 dump_for_download.dump
 .~lock.*
 .*.swp
+.byebug_history

data/lib/generators/katapult/basics/templates/.ruby-version

@@ -1 +1 @@
-2.1.5
+<%= Katapult::RUBY_VERSION %>

data/lib/generators/katapult/basics/templates/Capfile

@@ -0,0 +1,25 @@
+# Load DSL and set up stages
+require 'capistrano/setup'
+
+# Include default deployment tasks
+require 'capistrano/deploy'
+
+# Include tasks from other gems included in your Gemfile
+require 'capistrano/bundler'
+require 'capistrano/maintenance'
+require 'capistrano/rails/assets'
+require 'capistrano/rails/migrations'
+require 'whenever/capistrano'
+
+Dir.glob('lib/capistrano/tasks/*.rake').each do |r|
+  # `import r` calls Rake.application.add_import(r), which imports the file only
+  # *after* this file has been processed, so the imported tasks would not be
+  # available to the hooks below.
+  Rake.load_rakefile r
+end
+
+before 'deploy:updating', 'db:dump'
+after 'deploy:published', 'deploy:restart'
+after 'deploy:published', 'db:warn_if_pending_migrations'
+after 'deploy:published', 'db:show_dump_usage'
+after 'deploy:finished', 'deploy:cleanup' # https://makandracards.com/makandra/1432

data/lib/generators/katapult/basics/templates/Gemfile

@@ -1,15 +1,14 @@
 source 'https://rubygems.org'
 
-# from original Gemfile
 <%= @original_gems.join %>
 
-# engines
-gem 'haml-rails'
-gem 'mysql2', '~> 0.3.18' # Work around require-error in Rails 4.2
-
 # internal
 gem 'exception_notification'
+# gem 'admin_cleaner', git: 'git@code.makandra.de:makandra/admin_cleaner.git'
+
+# security
 gem 'breach-mitigation-rails'
+gem 'safe_cookies'
 
 # better coding
 gem 'modularity'
@@ -33,12 +32,14 @@ gem 'will_paginate'
 gem 'makandra-navy', require: 'navy'
 
 # assets
+gem 'haml-rails'
 gem 'bootstrap-sass'
 gem 'sass-rails'
 gem 'autoprefixer-rails'
 gem 'coffee-rails'
+gem 'therubyracer', platform: :ruby
 gem 'uglifier'
-gem 'compass-rails', '>= 2.0.4' # fixes "uninitialized constant Sprockets::SassCacheStore"
+gem 'compass-rails'
 gem 'compass-rgbapng'
 
 group :development do
@@ -68,6 +69,7 @@ group :test do
 
   gem 'capybara'
   gem 'capybara-screenshot'
+  gem 'cucumber', '< 2' # Incompatible with Cucumber Factory
   gem 'cucumber-rails', require: false
   gem 'cucumber_factory'
   gem 'selenium-webdriver'
@@ -76,3 +78,9 @@ group :test do
   gem 'rspec'
   gem 'shoulda-matchers', require: false
 end
+
+group :deploy do
+  gem 'capistrano-rails', require: false
+  gem 'capistrano-bundler', require: false
+  gem 'capistrano-maintenance'
+end

data/lib/generators/katapult/basics/templates/Guardfile

@@ -0,0 +1,44 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard 'livereload' do
+  watch %r{app/views/.+\.(erb|haml)$}
+  watch 'app/models/navigation.rb' # Navy
+  watch 'app/models/power.rb' # Consul
+  watch %r{app/helpers/.+\.rb}
+  watch %r{public/.+\.(css|js|html)}
+  watch %r{config/locales/.+\.yml}
+  watch %r{spec/javascripts/} # Jasmine
+
+  # Rails Assets Pipeline
+  watch(%r{(app|vendor)(/assets/\w+/(.+\.(css|sass|js|coffee|html|png|jpg))).*}) do |m|
+    filename = m[3]
+    # When a .sass (or .css.sass) file was changed, tell the client to load the .css version.
+    # Similarly, for .coffee / .js.coffee files we ask the client to reload the .js file.
+    filename.gsub! /(\.css)?\.sass$/, '.css'
+    filename.gsub! /(\.js)?\.coffee$/, '.js'
+    "/assets/#{filename}"
+  end
+end

data/lib/generators/katapult/basics/templates/config/database.sample.yml

@@ -1,6 +1,7 @@
 common: &common
-  adapter: mysql2
-  encoding: utf8
+  adapter: postgresql
+  encoding: unicode
+  host: localhost
   username: root
   password:
 

data/lib/generators/katapult/basics/templates/config/database.yml

@@ -1,6 +1,7 @@
 common: &common
-  adapter: mysql2
-  encoding: utf8
+  adapter: postgresql
+  encoding: unicode
+  host: localhost
   username: <%= @db_user %>
   password: <%= @db_password %>
 

data/lib/generators/katapult/basics/templates/config/deploy/production.rb

@@ -0,0 +1,8 @@
+set :stage, :production
+
+set :deploy_to, '/var/www/<%= app_name %>'
+set :rails_env, 'production'
+set :branch, 'production'
+
+# server 'one.example.com', user: 'deploy-user', roles: %w(app web cron db)
+# server 'two.example.com', user: 'deploy-user', roles: %w(app web)

data/lib/generators/katapult/basics/templates/config/deploy/staging.rb

@@ -0,0 +1,7 @@
+set :stage, :staging
+
+set :deploy_to, '/var/www/<%= app_name %>-staging'
+set :rails_env, 'staging'
+set :branch, ENV['DEPLOY_BRANCH'] || 'master'
+
+# server 'example.com', user: 'deploy-user', roles: %w(app web cron db)

data/lib/generators/katapult/basics/templates/config/deploy.rb

@@ -0,0 +1,37 @@
+abort 'You must run this using "bundle exec ..."' unless ENV['BUNDLE_BIN_PATH'] || ENV['BUNDLE_GEMFILE']
+
+# config valid only for current version of Capistrano
+lock '3.4.0'
+
+# Default value for :format is :pretty
+# set :format, :pretty
+
+set :log_level, :info # %i(debug info error), default: :debug
+
+# Default value for :pty is false
+# set :pty, true
+
+# Default value for :linked_files is []
+# set :linked_files, fetch(:linked_files, []).push('config/database.yml', 'config/secrets.yml')
+set :linked_files, %w(config/database.yml)
+
+# Default value for linked_dirs is []
+# set :linked_dirs, fetch(:linked_dirs, []).push('log', 'tmp/pids', 'tmp/cache', 'tmp/sockets', 'vendor/bundle', 'public/system')
+set :linked_dirs, %w(log public/system)
+
+# Default value for default_env is {}
+# set :default_env, { path: "/opt/ruby/bin:$PATH" }
+
+set :application, '<%= app_name %>'
+set :keep_releases, 10
+set :ssh_options, {
+  forward_agent: true
+}
+set :scm, :git
+set :repo_url, 'git@code.makandra.de:makandra/<%= app_name %>.git'
+
+# set :whenever_roles, :cron
+# set :whenever_environment, defer { stage }
+# set :whenever_command, 'bundle exec whenever'
+
+set :maintenance_template_path, 'public/maintenance.html.erb'

data/lib/generators/katapult/basics/templates/config/initializers/ext.rb

@@ -0,0 +1,3 @@
+Dir.glob(Rails.root.join('lib/ext/**/*.rb')).each do |filename|
+  require filename
+end

data/lib/generators/katapult/basics/templates/features/support/factory_girl.rb

@@ -0,0 +1 @@
+World(FactoryGirl::Syntax::Methods)

data/lib/generators/katapult/basics/templates/features/support/paths.rb

@@ -3,6 +3,9 @@ module NavigationHelpers
   def path_to(page_name)
     case page_name
 
+    when 'the homepage'
+      root_path
+
     when /^the list of (.*?)$/
       models_prose = $1
       route = "#{model_prose_to_route_segment(models_prose)}_path"
@@ -27,6 +30,9 @@ module NavigationHelpers
       route = "new_#{model_prose_to_route_segment(model_prose)}_path"
       send(route)
 
+    when /"(.+?)"$/
+      $1
+
     end
   end
 

data/lib/generators/katapult/basics/templates/lib/capistrano/tasks/db.rake

@@ -0,0 +1,28 @@
+namespace :db do
+  desc 'Warn about pending migrations'
+  task :warn_if_pending_migrations do
+    on primary :db do
+      within current_path do
+        with rails_env: fetch(:rails_env, 'production') do
+          rake 'db:warn_if_pending_migrations'
+        end
+      end
+    end
+  end
+
+  desc 'Do a dump of the DB on the remote machine using dumple'
+  task :dump do
+    on primary :db do
+      within current_path do
+        execute :dumple, '--fail-gently', fetch(:rails_env, 'production')
+      end
+    end
+  end
+
+  desc 'Show usage of ~/dumps/ on remote host'
+  task :show_dump_usage do
+    on primary :db do
+      info capture :dumple, '-i'
+    end
+  end
+end

data/lib/generators/katapult/basics/templates/lib/capistrano/tasks/deploy.rake

@@ -0,0 +1,15 @@
+namespace :deploy do
+  desc 'Restart application'
+  task :restart do
+    invoke 'passenger:restart'
+  end
+
+  desc 'Show deployed revision'
+  task :revision do
+    on roles :app do
+      within current_path do
+        info "Revision: #{ capture :cat, 'REVISION' }"
+      end
+    end
+  end
+end

data/lib/generators/katapult/basics/templates/lib/capistrano/tasks/passenger.rake

@@ -0,0 +1,8 @@
+namespace :passenger do
+  desc 'Restart Application'
+  task :restart do
+    on roles :app do
+      execute "sudo passenger-config restart-app --ignore-app-not-running #{ fetch(:deploy_to) }"
+    end
+  end
+end

data/lib/generators/katapult/basics/templates/{config/initializers → lib/ext/action_view}/form_for_with_development_errors.rb

@@ -33,7 +33,6 @@ if Rails.env == 'development'
           html << '</style>'.html_safe
         end
         html << capture(form, &block)
-        Rails.version.to_i < 3 ? concat(html) : html
       end
     end
 
@@ -42,4 +41,3 @@ if Rails.env == 'development'
   end
 
 end
-

data/lib/generators/katapult/basics/templates/lib/ext/action_view/spec_label.rb

@@ -0,0 +1,46 @@
+ActionView::Helpers::FormBuilder.class_eval do
+
+  def spec_label(field, text = nil, options = {})
+    label_html = label(field)
+    element = parse_element(label_html, 'label')
+    id = element['for']
+    text ||= element.text
+    @template.spec_label_tag(id, text, options)
+  end
+
+  private
+
+  def parse_element(html, tag)
+    doc = Nokogiri::XML(html)
+    doc.css(tag).first or raise "Could not find CSS #{tag.inspect} in HTML #{html.inspect}"
+  end
+
+end
+
+ActionView::Helpers::FormTagHelper.class_eval do
+
+  def spec_label_tag(id, text = nil, options = {})
+    count = SpecLabelCounter.next(controller, text)
+    label = count == 1 ? text : "#{text} (#{count})"
+    options.merge!(:class => 'hidden') unless Rails.env.test?
+    html = label_tag(id, label, options)
+    html
+  end
+
+end
+
+class SpecLabelCounter
+  class << self
+
+    def next(controller, text)
+      counter(controller)[text] ||= 0
+      counter(controller)[text] += 1
+    end
+
+    def counter(controller)
+      ivar = :"@_spec_label_counter"
+      controller.instance_variable_get(ivar) || controller.instance_variable_set(ivar, {})
+    end
+
+  end
+end

data/lib/generators/katapult/basics/templates/lib/ext/active_record/these.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Base.class_eval do
+
+  def self.these(arg)
+    where(id: arg.collect_ids)
+  end
+
+end