katapult 0.1.1 → 0.1.2

data/features/model.feature

@@ -131,7 +131,9 @@ Feature: Generate Models
       end
 
       """
-    And the specs should pass
+
+    When I run rspec
+    Then the specs should pass
 
 
   Scenario: Get a helpful error message when an attribute has an unknown option
@@ -200,4 +202,46 @@ Feature: Generate Models
       end
 
       """
-    And the specs should pass
+
+    When I run rspec
+    Then the specs should pass
+
+
+  Scenario: Transform the application model multiple times
+
+    Do not add routes twice.
+
+    When I overwrite "lib/katapult/application_model.rb" with:
+      """
+      model 'Car'
+      wui 'Car' do |wui|
+        wui.crud
+      end
+      """
+      And I successfully transform the application model
+    Then the file named "config/routes.rb" should contain:
+      """
+      Rails.application.routes.draw do
+        root 'cars#index'
+        resources :cars, only: [:index, :show, :new, :create, :edit, :update, :destroy] do
+          member do
+          end
+          collection do
+          end
+        end
+      """
+      And I successfully transform the application model
+    Then the file named "config/routes.rb" should contain:
+      """
+      Rails.application.routes.draw do
+        root 'cars#index'
+        resources :cars, only: [:index, :show, :new, :create, :edit, :update, :destroy] do
+          member do
+          end
+          collection do
+          end
+        end
+      """
+      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."

data/features/step_definitions/file_steps.rb

@@ -1,5 +1,5 @@
 When /^I replace "(.*?)" with "(.*?)" inside "(.*?)"$/ do |a, b, path|
-  in_current_dir do
+  cd '.' do
     content = File.read(path)
     content.gsub! a, b
     File.open(path, 'w') { |file| file.puts(content) }
@@ -7,8 +7,19 @@ When /^I replace "(.*?)" with "(.*?)" inside "(.*?)"$/ do |a, b, path|
 end
 
 Then /^there should be a migration with:$/ do |migration|
-  migrations_path = File.join(current_dir, 'db', 'migrate', '*.rb')
+  migrations_path = File.join(expand_path('.'), 'db', 'migrate', '*.rb')
 
   all_migrations = Dir.glob(migrations_path).map(&File.method(:read)).join
   expect(all_migrations).to include(migration)
 end
+
+Then /^the file named "(.+?)" should contain "(.+?)" exactly once$/ do |file_name, content|
+  cd '.' do
+    occurrences = File.read(file_name).scan(content)
+
+    expect( occurrences.count ).to eq(1), <<-ERROR_MESSAGE
+      Expected file "#{ file_name }" to contain "#{ content }"
+      once, but had it #{ occurrences.count } times.
+    ERROR_MESSAGE
+  end
+end

data/features/step_definitions/katapult_steps.rb

@@ -1,14 +1,20 @@
+# Note: Aruba adds the project's bin/ directory to the path
+
 When /^I install katapult$/ do
   append_to_file 'Gemfile', "gem 'katapult', path: '../../..'"
-  run_simple('bin/rails generate katapult:install')
+  run_simple 'rails generate katapult:install'
 end
 
 # This step is required for any feature because it generates config/database.yml
 When /^I generate katapult basics$/ do
-  run_simple('bin/rails generate katapult:basics')
+  with_aruba_timeout 45 do
+    run_simple 'rails generate katapult:basics --db-user=katapult --db-password=secret'
+  end
 end
 
 When /^I( successfully)? transform the application model$/ do |require_success|
   # the second parameter would be true when not specified
-  run_simple('bin/rails generate katapult:transform lib/katapult/application_model.rb', !!require_success)
+  with_aruba_timeout 45 do
+    run_simple 'rails generate katapult:transform lib/katapult/application_model.rb', !!require_success
+  end
 end

data/features/step_definitions/rails_steps.rb

@@ -1,12 +1,13 @@
 module KatapultRailsHelper
 
   def with_aruba_timeout(timeout, &block)
-    original_aruba_timeout = @aruba_timeout_seconds
-    @aruba_timeout_seconds = timeout
+    original_aruba_timeout = aruba.config.exit_timeout
+    aruba.config.exit_timeout = timeout.to_i
+    # print "(timeout: #{ timeout })"
 
     block.call
   ensure
-    @aruba_timeout_seconds = original_aruba_timeout
+    aruba.config.exit_timeout = original_aruba_timeout
   end
 
   def create_cached_app(name)
@@ -38,7 +39,7 @@ Given /^a pristine Rails application$/ do
     end
 
     # copy cached app to aruba directory
-    FileUtils.cp_r('tmp/cached_test_app', File.join(current_dir, 'katapult_test_app'))
+    FileUtils.cp_r 'tmp/cached_test_app', File.join(expand_path('.'), 'katapult_test_app')
     cd 'katapult_test_app' # Aruba::Api method
   end
 end

data/features/step_definitions/test_steps.rb

@@ -1,7 +1,11 @@
-Then /^the specs should pass$/ do
-  run_simple('bin/rspec')
+When /^I run rspec/ do
+  run_simple 'rspec'
 end
 
-Then /^the features should pass$/ do
-  run_simple('bin/cucumber')
+When /^I run cucumber/ do
+  # The test application's Bundler sees an empty BUNDLE_GEMFILE variable and
+  # infers the wrong Gemfile location. Fixed by removing the var altogether.
+  delete_environment_variable 'BUNDLE_GEMFILE'
+
+  run_simple 'bundle exec cucumber'
 end

data/features/support/env.rb

@@ -4,11 +4,13 @@ require 'pry'
 # Make sure tests use the correct katapult gem
 ENV['KATAPULT_GEMFILE_OPTIONS'] = ", path: '../../..'"
 
-Before do
-  @aruba_timeout_seconds = 30
+Aruba.configure do |config|
+  config.exit_timeout = 30 # Todo: decrease to ~5
+end
 
-  unset_bundler_env_vars
-  run_simple 'spring stop # Clean up in case the After hook did not run'
+Before do
+  unset_bundler_env_vars # Don't use katapult's Bundler environment inside tests
+  run_simple 'spring stop # Ensure Spring is not running'
 end
 
 After do

data/features/wui.feature

@@ -316,4 +316,19 @@ Feature: Web User Interface
             But I should not see "name-string"
 
       """
-    And the features should pass
+
+    When I run cucumber
+    Then the features should pass
+
+
+  Scenario: Generate layout file with query diet widget
+    When I overwrite "lib/katapult/application_model.rb" with:
+      """
+      model 'Car'
+      wui 'Car'
+      """
+    And I successfully transform the application model
+    Then the file "app/views/layouts/application.html.haml" should contain:
+      """
+      = query_diet_widget(bad_count: 15) if Rails.env.development?
+      """

data/katapult.gemspec

@@ -18,7 +18,7 @@ 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 = '~> 2.0'
 
   spec.add_runtime_dependency 'rails'
   spec.add_runtime_dependency 'spring' # speed-up
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
 
   # Testing
-  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'aruba', '~> 0.10.2'
   spec.add_development_dependency 'guard-cucumber'
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec', '~> 3.4.0'
 end

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

@@ -4,17 +4,29 @@ module Katapult
   module Generators
     class BasicsGenerator < Rails::Generators::Base
 
-      SKIP_GEMS = %w(sass-rails coffee-rails turbolinks sdoc uglifier)
+      SKIP_GEMS = %w(sass-rails coffee-rails turbolinks sdoc uglifier mysql2)
 
       desc 'Generate basics like test directories and gems'
       source_root File.expand_path('../templates', __FILE__)
 
+      class_option :db_user, type: :string,
+        description: 'The user to set in config/database.yml'
+      class_option :db_password, type: :string,
+        description: 'The password to set in config/database.yml'
+
+
+      def add_gitignore
+        template '.gitignore', force: true
+      end
 
       def write_ruby_version
         template '.ruby-version'
       end
 
       def write_database_ymls
+        @db_user = options.db_user || 'root'
+        @db_password = options.db_password || ''
+
         template 'config/database.yml', force: true
         template 'config/database.sample.yml'
       end
@@ -31,13 +43,13 @@ module Katapult
       end
 
       def bundle_install
-        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.
-        bundle 'update sprockets sass-rails'
+        run 'bundle update sprockets sass-rails'
       end
 
       def remove_turbolinks_js
@@ -45,13 +57,35 @@ module Katapult
       end
 
       def setup_spring
-        bundle 'exec spring binstub --all'
-        template 'config/spring.rb'
-        run 'spring stop' # reload
+        # run 'spring binstub --all'
+        # # remove_file 'bin/bundle' # Won't play together with parallel_tests
+        # template 'config/spring.rb'
+        # template 'bin/rake'
+        run 'spring stop' # Reload (just in case)
+      end
+
+      def create_databases
+        run 'rake db:create:all parallel:create'
+      end
+
+      def set_timezone
+        gsub_file 'config/application.rb',
+          /# config\.time_zone =.*$/,
+          "config.time_zone = 'Berlin'"
+      end
+
+      def make_assets_debuggable
+        gsub_file 'config/application.rb',
+          /config\.assets\.debug =.*$/,
+          'config.assets.debug = false'
+      end
+
+      def install_initializers
+        directory 'config/initializers'
       end
 
       def add_modularity_load_paths
-        # This results in correct formatting :)
+        # This results in correct indentation :)
         application <<-'LOAD_PATHS'
 config.autoload_paths << "#{Rails.root}/app/controllers/shared"
     config.autoload_paths << "#{Rails.root}/app/models/shared"
@@ -62,20 +96,19 @@ config.autoload_paths << "#{Rails.root}/app/controllers/shared"
 
       def install_cucumber
         generate 'cucumber:install'
+        directory 'features/support'
+        template 'config/cucumber.yml', force: true
 
-        template 'features/support/paths.rb'
-        template 'features/support/env-custom.rb'
+        # Remove cucumber section from database.yml. Don't need this.
+        gsub_file 'config/database.yml', /^cucumber.*\z/m, ''
       end
 
       def install_rspec
         generate 'rspec:install'
 
-        # Do not show Ruby warnings in RSpec runs.
-        gsub_file '.rspec', "--warnings\n", ''
-
-        inject_into_file 'spec/rails_helper.rb', after: "require 'rspec/rails'\n" do
-          "require 'shoulda/matchers'\n"
-        end
+        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'
       end
 
       def install_styles
@@ -88,23 +121,15 @@ config.autoload_paths << "#{Rails.root}/app/controllers/shared"
       #   template 'config/deploy.rb'
       # end
 
-      def print_instructions
-        puts <<-INSTRUCTIONS.strip_heredoc
-
-          Next step: Model your application in lib/katapult/application_model.rb and
-          trigger the code generation by running `katapult fire`.
-        INSTRUCTIONS
-      end
-
-      private
+    private
 
       def app_name
         File.basename(Dir.pwd)
       end
 
-      def bundle(command)
+      def run(*)
         Bundler.with_clean_env do
-          run 'bundle ' + command
+          super
         end
       end
 

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

@@ -0,0 +1,27 @@
+log/*
+tmp/*
+storage/*
+db/*.sqlite3
+db/schema.rb
+db/structure.sql
+public/system
+public/storage
+public/uploads
+.project
+.idea/
+public/javascripts/all*
+public/stylesheets/all*
+public/stylesheets/*.css
+config/database.yml
+*~
+*#*
+.#*
+.DS_Store
+webrat-*.html
+capybara-*.html
+rerun.txt
+coverage.data
+coverage/*
+dump_for_download.dump
+.~lock.*
+.*.swp

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

@@ -5,6 +5,7 @@ source 'https://rubygems.org'
 
 # engines
 gem 'haml-rails'
+gem 'mysql2', '~> 0.3.18' # Work around require-error in Rails 4.2
 
 # internal
 gem 'exception_notification'
@@ -46,6 +47,7 @@ group :development do
   gem 'binding_of_caller'
   gem 'thin'
 
+  gem 'parallel_tests'
   gem 'guard-livereload', require: false
   gem 'rack-livereload'
   gem 'spring-commands-rspec'
@@ -60,15 +62,14 @@ group :development, :test do
 end
 
 group :test do
-  gem 'parallel_tests'
   gem 'database_cleaner'
   gem 'timecop'
   gem 'launchy'
 
   gem 'capybara'
+  gem 'capybara-screenshot'
   gem 'cucumber-rails', require: false
   gem 'cucumber_factory'
-  gem 'cucumber_spinner'
   gem 'selenium-webdriver'
   gem 'spreewald'
 

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

@@ -0,0 +1,10 @@
+<%%
+  rerun_log = 'tmp/parallel_cucumber_failures.log'
+  rerun_failures = File.file?(rerun_log) ? File.read(rerun_log).gsub("\n", ' ') : ''
+  std_opts = "-r features --format #{ ENV['CUCUMBER_FORMAT'] || 'progress' } --strict --tags ~@wip"
+  log_failures = "--format ParallelTests::Cucumber::FailuresLogger --out #{ rerun_log }"
+%>
+default: <%%= std_opts %> features
+wip: --tags @wip:3 --wip features
+parallel: <%%= std_opts %> features <%%= log_failures %>
+rerun: -r features --format pretty --strict <%%= rerun_failures %> <%%= log_failures %>

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

@@ -8,9 +8,6 @@ development:
   <<: *common
   database: <%= app_name %>_development
 
-test: &test
+test:
   <<: *common
   database: <%= app_name %>_test<%%= ENV['TEST_ENV_NUMBER'] %>
-
-cucumber:
-  <<: *test

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

@@ -1,8 +1,8 @@
 common: &common
   adapter: mysql2
   encoding: utf8
-  username: katapult
-  password: secret
+  username: <%= @db_user %>
+  password: <%= @db_password %>
 
 development:
   <<: *common

data/lib/generators/katapult/basics/templates/config/initializers/exception_notification.rb.tt

@@ -0,0 +1,16 @@
+require 'exception_notification/rails'
+
+ExceptionNotification.configure do |config|
+
+  config.add_notifier :email, {
+    email_prefix: '[<%= app_name %>] ',
+    exception_recipients: %w[fail@makandra.de],
+    sender_address: 'fail@makandra.de',
+    sections: %w[request backtrace],
+    background_sections: %w[backtrace],
+  }
+
+  # Regularly occurs when users have multiple tabs open
+  config.ignored_exceptions += %w[ActionController::InvalidAuthenticityToken]
+
+end

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

@@ -0,0 +1,19 @@
+ActiveRecord::Base.class_eval do
+
+  def self.find_by_anything(identifier)
+    matchable_columns = columns.reject { |column| [:binary, :boolean].include?(column.type) }
+    query_clauses = matchable_columns.collect do |column|
+      qualified_column_name = "#{table_name}.#{column.name}"
+      column_as_string = "CAST(#{qualified_column_name} AS CHAR)"
+      "#{column_as_string} = ?"
+    end
+    bindings = [identifier] * query_clauses.size
+    where([query_clauses.join(' OR '), *bindings]).first
+  end
+  
+  def self.find_by_anything!(identifier)
+    find_by_anything(identifier) or raise ActiveRecord::RecordNotFound, "No column equals \"#{identifier}\""
+  end
+
+end
+

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

@@ -0,0 +1,45 @@
+if Rails.env == 'development'
+
+  ActionView::Helpers::FormHelper.class_eval do
+
+    def form_for_with_development_errors(*args, &block)
+      form_for_without_development_errors(*args) do |form|
+        html = ''.html_safe
+        if form.object && form.object.respond_to?(:errors) && form.object.errors.any?
+          html << content_tag(:div, form.object.errors.full_messages.collect { |m| h m }.join('<br />').html_safe, :class => 'development_errors', :onclick => 'this.parentNode.removeChild(this);')
+          html << '<style type="text/css"><!--'.html_safe
+          css = <<-EOF
+            .development_errors {
+              position: fixed;
+              bottom: 0;
+              right: 0;
+              z-index: 999999;
+              font-size: 11px;
+              line-height: 15px;
+              background-color: #fed;
+              border-top: 1px solid #cba;
+              border-left: 1px solid #cba;
+              color: #821;
+              padding: 10px;
+              cursor: pointer;
+              filter:alpha(opacity=80);
+              -moz-opacity:0.8;
+              -khtml-opacity: 0.8;
+              opacity: 0.8;
+
+            }
+          EOF
+          html << css.html_safe
+          html << '</style>'.html_safe
+        end
+        html << capture(form, &block)
+        Rails.version.to_i < 3 ? concat(html) : html
+      end
+    end
+
+    alias_method_chain :form_for, :development_errors
+
+  end
+
+end
+

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

@@ -0,0 +1,4 @@
+require 'capybara-screenshot/cucumber'
+
+# Keep up to the number of screenshots specified in the hash
+Capybara::Screenshot.prune_strategy = { keep: 10 }

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

@@ -0,0 +1 @@
+Cucumber::Factory.add_steps(self)

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

@@ -0,0 +1,3 @@
+DatabaseCleaner.clean_with(:deletion) # clean once, now
+DatabaseCleaner.strategy = :transaction
+Cucumber::Rails::Database.javascript_strategy = :deletion

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

@@ -0,0 +1,56 @@
+module HtmlSelectorsHelpers
+  # Maps a name to a selector. Used primarily by the
+  #
+  #   When /^(.+) within (.+)$/ do |step, scope|
+  #
+  # step definitions in web_steps.rb
+  #
+  def selector_for(locator)
+    case locator
+
+    # Auto-mapper for BEM classes
+    #
+    # Usage examples:
+    #   the main menu -> '.main-menu'
+    #   the item box's header -> '.item-box--header'
+    #   the slider's item that is current -> '.slider--item.is-current'
+    when /^the (.+?)(?:'s (.+?))?(?: that (.+))?$/
+      selector = '.'
+      selector << selectorify($1)
+      selector << '--' << selectorify($2) if $2
+      selector << '.' << selectorify($3) if $3
+      selector
+
+    # Add more mappings here.
+    # Here is an example that pulls values out of the Regexp:
+    #
+    #  when /^the (notice|error|info) flash$/
+    #    ".flash.#{$1}"
+
+    # You can also return an array to use a different selector
+    # type, like:
+    #
+    #  when /the header/
+    #    [:xpath, "//header"]
+
+    # This allows you to provide a quoted selector as the scope
+    # for "within" steps as was previously the default for the
+    # web steps:
+    when /^"(.+)"$/
+      $1
+
+    else
+      raise "Can't find mapping from \"#{locator}\" to a selector.\n" +
+          "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+
+  private
+
+  def selectorify(string)
+    string.gsub(/ /, '-')
+  end
+
+end
+
+World(HtmlSelectorsHelpers)

data/lib/generators/katapult/basics/templates/spec/support/shoulda_matchers.rb

@@ -0,0 +1,8 @@
+require 'shoulda/matchers'
+
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :rspec
+    with.library :rails
+  end
+end

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

@@ -9,6 +9,8 @@
     = csrf_meta_tags
 
   %body
+    = query_diet_widget(bad_count: 15) if Rails.env.development?
+
     .layout
 
       .layout__head