katapult 0.1.2 → 0.2.0

data/lib/generators/katapult/basics/templates/lib/ext/array/xss_aware_join.rb

@@ -0,0 +1,10 @@
+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

data/lib/generators/katapult/basics/templates/lib/ext/enumerable/natural_sort.rb

@@ -0,0 +1,15 @@
+module Enumerable
+
+  def natural_sort
+    natural_sort_by
+  end
+
+  def natural_sort_by(&stringifier)
+    sort_by do |element|
+      element = stringifier.call(element) if stringifier
+      element = element.to_s unless element.respond_to?(:to_sort_atoms)
+      element.to_sort_atoms
+    end
+  end
+
+end

data/lib/generators/katapult/basics/templates/lib/ext/hash/infinite.rb

@@ -0,0 +1,7 @@
+class Hash
+
+  def self.infinite
+    new { |h, k| h[k] = new(&h.default_proc) }
+  end
+
+end

data/lib/generators/katapult/basics/templates/lib/ext/string/html_entities.rb

@@ -0,0 +1,11 @@
+class String
+
+  def self.nbsp
+    ' '
+  end
+
+  def self.ndash
+    '–'
+  end
+
+end

data/lib/generators/katapult/basics/templates/lib/ext/string/to_sort_atoms.rb

@@ -0,0 +1,52 @@
+class SmartSortAtom
+
+  attr_reader :value
+
+  def initialize(value)
+    @value = value
+  end
+
+  def <=>(other)
+    other.is_a?(self.class) or raise "Can only smart compare with other SmartSortAtom"
+    left_value = value
+    right_value = other.value
+    if left_value.class == right_value.class
+      left_value <=> right_value
+    elsif left_value.is_a?(Float)
+      -1
+    else
+      1
+    end
+  end
+
+  def self.parse(string)
+    # Loosely based on http://stackoverflow.com/a/4079031
+    string.scan(/[^\d\.]+|[\d\.]+/).collect do |atom|
+      if atom.match(/\d+(\.\d+)?/)
+        atom = atom.to_f
+      else
+        atom = normalize_string(atom)
+      end
+      new(atom)
+    end
+
+  end
+
+  private
+
+  def self.normalize_string(string)
+    string = ActiveSupport::Inflector.transliterate(string)
+    string = string.downcase
+    string
+  end
+
+end
+
+String.class_eval do
+
+  def to_sort_atoms
+    SmartSortAtom.parse(self)
+  end
+
+end
+

data/lib/generators/katapult/basics/templates/lib/tasks/pending_migrations.rake

@@ -0,0 +1,24 @@
+namespace :db do
+
+  desc 'Warns if there are pending migrations'
+  task :warn_if_pending_migrations => :environment do
+    if defined? ActiveRecord
+      all_migrations = ActiveRecord::Migrator.migrations('db/migrate')
+      pending_migrations = ActiveRecord::Migrator.new(:up, all_migrations).pending_migrations
+
+      if pending_migrations.any?
+        puts ''
+        puts '======================================================='
+        puts "You have #{ pending_migrations.size } pending migrations:"
+        pending_migrations.each do |pending_migration|
+          puts '  %4d %s' % [pending_migration.version, pending_migration.name]
+        end
+        puts 'Run cap <stage> deploy:migrations'
+        puts '======================================================='
+        puts ''
+      end
+
+    end
+  end
+
+end

data/lib/generators/katapult/basics/templates/spec/factories/factories.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+
+  factory :EXAMPLE do
+    status 'pending'
+    uuid { SecureRandom.uuid }
+    sequence(:title) { |i| "Titel #{ i }"}
+  end
+
+end

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

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/lib/generators/katapult/clearance/clearance_generator.rb

@@ -0,0 +1,125 @@
+# Generate authentication with Clearance
+
+require 'katapult/generator'
+
+module Katapult
+  module Generators
+    class ClearanceGenerator < Katapult::Generator
+
+      desc 'Generate authentication with Clearance'
+
+      check_class_collision
+      source_root File.expand_path('../templates', __FILE__)
+
+
+      def migrate
+        rake 'db:migrate' # Clearance must see the users table in the db
+      end
+
+      def install_clearance
+        insert_into_file 'Gemfile', <<-GEM, before: "gem 'katapult'"
+gem 'clearance', '< 1.14.0' # Has broken InstallGenerator :(
+
+        GEM
+        run 'bundle install --quiet'
+        generate 'clearance:install'
+      end
+
+      def require_login
+        file = 'app/controllers/application_controller.rb'
+        insert_into_file file, <<-CONTENT, after: "Clearance::Controller\n"
+
+  before_action :require_login
+        CONTENT
+      end
+
+      def overwrite_clearance_controllers
+        template 'app/controllers/passwords_controller.rb'
+      end
+
+      def create_clearance_views
+        directory 'app/views/clearance_mailer'
+        directory 'app/views/passwords'
+        directory 'app/views/sessions'
+      end
+
+      def install_backdoor
+        # This creepy indentation leads to correct formatting in the file
+        application <<-CONTENT, env: 'test'
+# Enable quick-signin in tests: `visit homepage(as: User.last!)`
+  config.middleware.use Clearance::BackDoor
+        CONTENT
+      end
+
+      def create_initializer
+        template 'config/initializers/clearance.rb', force: true
+      end
+
+      def create_translations
+        template 'config/locales/clearance.en.yml'
+      end
+
+      def create_routes
+        route <<-ROUTES
+resources :users do
+    resource :password, controller: 'passwords',
+      only: %i[edit update]
+  end
+
+  # Clearance
+  get '/login', to: 'clearance/sessions#new', as: 'sign_in'
+  resource :session, controller: 'clearance/sessions', only: [:create]
+  resources :passwords, controller: 'passwords', only: [:create, :new]
+  delete '/logout', to: 'clearance/sessions#destroy', as: 'sign_out'
+        ROUTES
+      end
+
+      def add_sign_in_background_to_all_features
+        Dir['features/*.feature'].each do |file|
+          inject_into_file file, <<-CONTENT, after: /^Feature: .*$/
+
+
+  Background:
+    Given there is a user
+      And I sign in as the user above
+          CONTENT
+        end
+      end
+
+      def create_authentication_feature
+        template 'features/authentication.feature'
+      end
+
+      def create_authentication_steps
+        template 'features/step_definitions/authentication_steps.rb'
+      end
+
+      def add_authentication_paths
+        inject_into_file 'features/support/paths.rb', <<-CONTENT, after: 'case page_name'
+
+
+    # Authentication
+    when 'the sign-in form'
+      sign_in_path
+    when 'the reset password page'
+      new_password_path
+    when 'the new password page for the user above'
+      edit_user_password_path(User.last!)
+
+        CONTENT
+      end
+
+      def add_user_factory
+        inject_into_file 'spec/factories/factories.rb', <<-'CONTENT', after: 'FactoryGirl.define do'
+
+  factory :user do
+    sequence(:email) { |i| "user-#{ i }@example.com" }
+    password 'password'
+  end
+
+        CONTENT
+      end
+
+    end
+  end
+end

data/lib/generators/katapult/clearance/templates/app/controllers/passwords_controller.rb

@@ -0,0 +1,16 @@
+class PasswordsController < Clearance::PasswordsController
+
+  def update
+    @user = find_user_for_update
+
+    if @user.update_password password_reset_params
+      sign_in @user
+      flash[:notice] = 'Password successfully changed' # <<- added
+      redirect_to url_after_update
+    else
+      flash_failure_after_update
+      render template: 'passwords/edit'
+    end
+  end
+
+end

data/lib/generators/katapult/clearance/templates/app/views/clearance_mailer/change_password.html.haml

@@ -0,0 +1,6 @@
+%p
+  To reset your password, please follow this link:
+
+%p
+  = link_to 'Change password',
+    edit_user_password_url(@user, token: @user.confirmation_token.html_safe)

data/lib/generators/katapult/clearance/templates/app/views/clearance_mailer/change_password.text.erb

@@ -0,0 +1,3 @@
+To reset your password, please follow this link:
+
+<%= edit_user_password_url(@user, token: @user.confirmation_token.html_safe) %>

data/lib/generators/katapult/clearance/templates/app/views/passwords/create.html.haml

@@ -0,0 +1,5 @@
+%h1
+  Password Reset Instructions Sent
+
+%p
+  We've sent you an email with instructions on how to reset your password.

data/lib/generators/katapult/clearance/templates/app/views/passwords/edit.html.haml

@@ -0,0 +1,16 @@
+%h1
+  Reset Password
+
+%p
+  Choose your new password:
+
+= form_for :password_reset,
+  url: user_password_path(@user, token: @user.confirmation_token),
+  html: { method: :put } do |form|
+
+  .form-group
+    = form.label :password
+    = form.password_field :password, class: 'form-control',
+      placeholder: 'New Password'
+
+  = form.submit 'Update Password', class: 'btn btn-primary'

data/lib/generators/katapult/clearance/templates/app/views/passwords/new.html.haml

@@ -0,0 +1,14 @@
+%h1
+  Password Reset
+
+%p
+  Please enter your email address. We will send you instructions on how
+  to reset your password.
+
+= form_for :password, url: passwords_path do |form|
+  .form-group
+    = form.label :email
+    = form.email_field :email, class: 'form-control',
+      placeholder: 'Email Address'
+
+  = form.submit 'Request Instructions', class: 'btn btn-primary'

data/lib/generators/katapult/clearance/templates/app/views/sessions/new.html.haml

@@ -0,0 +1,19 @@
+%h1
+  Please sign in
+
+= form_for :session, url: session_path do |form|
+  .form-group
+    = form.label :email
+    = form.email_field :email, class: 'form-control',
+      placeholder: 'Email Address', required: true, autofocus: true
+
+  .form-group
+    = form.label :password
+    = form.password_field :password, class: 'form-control', required: true,
+      placeholder: 'Password'
+
+  %p
+    = form.submit 'Sign in', class: 'btn btn-primary'
+
+  %p
+    = link_to 'Forgot password', new_password_path, class: 'text-muted'

data/lib/generators/katapult/clearance/templates/config/initializers/clearance.rb

@@ -0,0 +1,15 @@
+Clearance.configure do |config|
+  config.allow_sign_up = false
+  # config.cookie_domain = '.example.com'
+  # config.cookie_expiration = lambda { |cookies| 1.year.from_now.utc }
+  # config.cookie_name = 'remember_token'
+  # config.cookie_path = '/'
+  config.routes = false
+  # config.httponly = true
+  config.mailer_sender = 'system@example.com'
+  # config.password_strategy = Clearance::PasswordStrategies::BCrypt
+  # config.redirect_url = '/'
+  # config.secure_cookie = true
+  # config.sign_in_guards = []
+  # config.user_model = User
+end

data/lib/generators/katapult/clearance/templates/config/locales/clearance.en.yml

@@ -0,0 +1,59 @@
+---
+en:
+  clearance:
+    models:
+      clearance_mailer:
+        change_password: Change your password
+  clearance_mailer:
+    change_password:
+      closing: If you didn't request this, ignore this email. Your password has
+        not been changed.
+      link_text: Change my password
+      opening: "Someone, hopefully you, requested we send you a link to change
+        your password:"
+  flashes:
+    failure_after_create: Bad email or password.
+    failure_after_update: Password can't be blank.
+    failure_when_forbidden: Please double check the URL or try submitting
+      the form again.
+    failure_when_not_signed_in: Please sign in to continue.
+  helpers:
+    label:
+      password:
+        email: Email address
+      password_reset:
+        password: Choose password
+    submit:
+      password:
+        submit: Reset password
+      password_reset:
+        submit: Save this password
+      session:
+        submit: Sign in
+      user:
+        create: Sign up
+  layouts:
+    application:
+      sign_in: Sign in
+      sign_out: Sign out
+  passwords:
+    create:
+      description: You will receive an email within the next few minutes. It
+        contains instructions for changing your password.
+    edit:
+      description: Your password has been reset. Choose a new password below.
+      title: Change your password
+    new:
+      description: To be emailed a link to reset your password, please enter
+        your email address.
+      title: Reset your password
+  sessions:
+    form:
+      forgot_password: Forgot password?
+      sign_up: Sign up
+    new:
+      title: Sign in
+  users:
+    new:
+      sign_in: Sign in
+      title: Sign up

data/lib/generators/katapult/clearance/templates/features/authentication.feature

@@ -0,0 +1,94 @@
+Feature: Everything about user authentication
+
+  Scenario: Login is required to visit the homepage
+    When I go to the homepage
+    Then I should see "Please sign in to continue" within the flash
+      And I should be on the sign-in form
+
+
+  Scenario: Login
+    Given there is a user with the email "henry@example.com" and the password "password"
+
+    When I go to the homepage
+    Then I should be on the sign-in form
+      And I should see "Please sign in"
+
+    # Wrong email
+    When I fill in "Email" with "nonsense"
+      And I fill in "Password" with "password"
+      And I press "Sign in"
+    Then I should see "Bad email or password" within the flash
+      And I should see "Please sign in"
+
+    # Wrong password
+    When I fill in "Email" with "admin@example.com"
+      And I fill in "Password" with "wrong"
+      And I press "Sign in"
+    Then I should see "Bad email or password" within the flash
+      And I should see "Please sign in"
+
+    # Correct credentials
+    When I fill in "Email" with "henry@example.com"
+      And I fill in "Password" with "password"
+      And I press "Sign in"
+    Then I should be on the homepage
+
+
+  Scenario: Logout
+    Given there is a user
+      And I am signed in as the user above
+
+    When I follow "Sign out"
+    Then I should be on the sign-in form
+
+    # Logged out
+    When I go to the homepage
+    Then I should be on the sign-in form
+
+
+  Scenario: Reset password as a signed-in user
+    Given there is a user with the email "henry@example.com"
+      And I sign in as the user above
+
+    When I go to the homepage
+      And I follow "henry@example.com" within the current user
+    Then I should be on the form for the user above
+
+    When I fill in "Password" with "new-password"
+      And I press "Save"
+    Then I should be on the page for the user above
+
+    When I follow "Sign out"
+      And I fill in "Email" with "henry@example.com"
+      And I fill in "Password" with "new-password"
+      And I press "Sign in"
+    Then I should be on the homepage
+
+
+  Scenario: Reset password as a signed-out user
+    Given there is a user with the email "henry@example.com"
+
+    When I go to the sign-in form
+      And I follow "Forgot password"
+    Then I should be on the reset password page
+      And I should see "Password Reset"
+
+    When I fill in "Email" with "henry@example.com"
+      And I press "Request Instructions"
+    Then an email should have been sent with:
+      """
+      From: system@example.com
+      To: henry@example.com
+      Subject: Change your password
+
+      To reset your password, please follow this link:
+      """
+
+    When I follow the first link in the email
+    Then I should be on the new password page for the user above
+      And I should see "Reset Password"
+
+    When I fill in "Choose password" with "new-password"
+      And I press "Update Password"
+    Then I should see "Password successfully changed" within the flash
+      And I should be on the homepage

data/lib/generators/katapult/clearance/templates/features/step_definitions/authentication_steps.rb

@@ -0,0 +1,4 @@
+When /^I (?:am signed|sign) in as the user above$/ do
+  user = User.last!
+  visit root_path(as: user) # Using Clearance::BackDoor
+end

data/lib/generators/katapult/cucumber_features/templates/feature.feature

@@ -4,16 +4,18 @@ Feature: <%= model.name(:humans).titleize %>
     Given I am on the list of <%= model.name(:variables) %>
 
     # create
-    When I follow "Add <%= model.name(:variable) %>"
+    When I follow "Add <%= model.name(:human) %>"
 <% model.attrs.each do |attr| -%>
   <%- if attr.assignable_values -%>
       And I select "<%= attr.test_value %>" from "<%= attr.name.humanize %>"
   <%- else -%>
     <%- case attr.type -%>
-    <%- when :string, :email, :url, :integer, :money, :text, :markdown, :datetime -%>
+    <%- when :string, :email, :url, :integer, :money, :text, :password -%>
       And I fill in "<%= attr.name.humanize %>" with "<%= attr.test_value %>"
     <%- when :flag -%>
       And I check "<%= attr.name.humanize %>"
+    <%- when :datetime -%>
+      And I fill in "<%= attr.name.humanize %>" with "<%= attr.test_value.to_date %>"
     <%- end -%>
   <%- end -%>
 <% end -%>
@@ -23,12 +25,12 @@ Feature: <%= model.name(:humans).titleize %>
     Then I should be on the page for the <%= model.name(:variable) %> above
 <% model.attrs.each do |attr| -%>
   <%- case attr.type -%>
-    <%- when :string, :email, :url, :integer, :money, :text, :markdown -%>
+    <%- when :string, :email, :url, :integer, :money, :text -%>
       And I should see "<%= attr.test_value %>"
   <%- when :flag -%>
       And I should see "<%= attr.name.humanize %> Yes"
   <%- when :datetime -%>
-      And I should see "<%= I18n.localize(attr.test_value) %>"
+      And I should see "<%= I18n.localize(attr.test_value.to_date) %>"
   <%- end -%>
 <% end -%>
 
@@ -40,20 +42,22 @@ Feature: <%= model.name(:humans).titleize %>
       And "<%= attr.test_value %>" should be selected for "<%= attr.name.humanize %>"
   <%- else -%>
     <%- case attr.type -%>
-    <%- when :string, :email, :url, :integer, :money, :text, :markdown, :datetime -%>
+    <%- when :string, :email, :url, :integer, :money, :text -%>
       And the "<%= attr.name.humanize %>" field should contain "<%= attr.test_value %>"
     <%- when :flag -%>
       And the "<%= attr.name.humanize %>" checkbox should be checked
+    <%- when :datetime -%>
+      And the "<%= attr.name.humanize %>" field should contain "<%= attr.test_value.to_date %>"
     <%- end -%>
   <%- end -%>
 <% end -%>
 
-<% if model.label_attr # do not crash when the model has no label attr -%>
+<% if model.label_attr -%>
     # destroy
     When I go to the list of <%= model.name(:variables) %>
     Then I should see "<%= model.label_attr.test_value %>"
 
-    When I follow "Destroy"
+    When I follow "Destroy <%= model.label_attr.test_value %>"
     Then I should be on the list of <%= model.name(:variables) %>
       But I should not see "<%= model.label_attr.test_value %>"
 <% end -%>

data/lib/generators/katapult/haml/haml_generator.rb

@@ -14,6 +14,7 @@ module Katapult
       def install_application_layout
         remove_file 'app/views/layouts/application.html.erb'
         template 'app/views/layouts/application.html.haml'
+        template 'app/views/layouts/_flashes.html.haml'
       end
 
       def create_views_directory
@@ -63,6 +64,10 @@ module Katapult
         def navigation
           wui.application_model.navigation
         end
+
+        def authentication
+          wui.application_model.authentication
+        end
       end
 
       private

data/lib/generators/katapult/haml/templates/_form.html.haml

@@ -1,7 +1,7 @@
 = form_for <%= model_name(:ivar) %> do |form|
 
   %dl.controls
-<% wui.model.attrs.each do |attribute| -%>
+<% wui.model.editable_attrs.each do |attribute| -%>
     %dt
       = form.label <%= attribute.name(:symbol) %>
     %dd
@@ -13,6 +13,8 @@
       = form.text_field <%= attribute.name(:symbol) %>
     <%- when :email -%>
       = form.email_field <%= attribute.name(:symbol) %>
+    <%- when :password -%>
+      = form.password_field <%= attribute.name(:symbol) %>
     <%- when :url -%>
       = form.url_field <%= attribute.name(:symbol) %>
     <%- when :integer -%>
@@ -22,12 +24,10 @@
       €
     <%- when :text -%>
       = form.text_area <%= attribute.name(:symbol) %>, rows: 5
-    <%- when :markdown -%>
-      = form.text_area <%= attribute.name(:symbol) %>, rows: 15
     <%- when :flag -%>
       = form.check_box <%= attribute.name(:symbol) %>
     <%- when :datetime -%>
-      = form.datetime_field <%= attribute.name(:symbol) %>
+      = form.date_field <%= attribute.name(:symbol) %>
     <%- end -%>
   <%- end -%>
 <% end -%>

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

@@ -0,0 +1,3 @@
+- flash.each do |level, message|
+  .flash.alert.alert-info
+    = message

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

@@ -15,12 +15,18 @@
 
       .layout__head
         %h2 <%= app_name.titlecase %>
-        <%- if navigation -%>
+      <%- if navigation -%>
         = render_navigation Navigation.<%= navigation.name(:variable) %>
-        <%- end -%>
+      <%- end -%>
+      <%- if authentication -%>
+        - if signed_in?
+          .current-user
+            = link_to current_user.email, edit_user_path(current_user)
+            = link_to 'Sign out', sign_out_path, method: :delete
+      <%- end -%>
 
       .layout__main
-        =# render 'layouts/flashes'
+        = render 'layouts/flashes'
         = yield
 
       .layout__tail