katapult 0.4.1 → 0.5.0

data/lib/generators/katapult/basics/templates/app/models/application_record.rb

@@ -0,0 +1,28 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  class << self
+    def these(arg)
+      where(id: arg.collect_ids)
+    end
+
+    def 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}"
+        is_mysql = connection.class.name =~ /mysql/i
+        target_type = is_mysql ? 'CHAR' : 'TEXT' # CHAR is only 1 character in PostgreSQL
+        column_as_string = "CAST(#{qualified_column_name} AS #{target_type})"
+        "#{column_as_string} = ?"
+      end
+      bindings = [identifier] * query_clauses.size
+      where([query_clauses.join(' OR '), *bindings]).first
+    end
+
+    def find_by_anything!(identifier)
+      find_by_anything(identifier) or raise ActiveRecord::RecordNotFound,
+        "No column equals #{identifier.inspect}"
+    end
+  end
+
+end

data/lib/generators/katapult/basics/templates/app/webpack/assets/javascripts/bootstrap.js

@@ -1,8 +1,8 @@
-// import 'bootstrap-sass/assets/javascripts/bootstrap/transition'
+import 'bootstrap-sass/assets/javascripts/bootstrap/transition'
 // import 'bootstrap-sass/assets/javascripts/bootstrap/alert'
 // import 'bootstrap-sass/assets/javascripts/bootstrap/button'
 // import 'bootstrap-sass/assets/javascripts/bootstrap/carousel'
-// import 'bootstrap-sass/assets/javascripts/bootstrap/collapse'
+import 'bootstrap-sass/assets/javascripts/bootstrap/collapse'
 import 'bootstrap-sass/assets/javascripts/bootstrap/dropdown'
 // import 'bootstrap-sass/assets/javascripts/bootstrap/modal'
 // import 'bootstrap-sass/assets/javascripts/bootstrap/tab'

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

@@ -17,7 +17,7 @@ set :linked_files, %w(config/database.yml config/secrets.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 tmp/pids)
+set :linked_dirs, %w(log public/system tmp/pids node_modules public/packs)
 
 # Default value for default_env is {}
 # set :default_env, { path: "/opt/ruby/bin:$PATH" }
@@ -30,7 +30,6 @@ set :ssh_options, {
 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 :whenever_identifier, ->{ "#{fetch(:application)}_#{fetch(:stage)}" }
 
 set :maintenance_template_path, 'public/maintenance.html.erb'

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

@@ -4,5 +4,5 @@ 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)
+# 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

@@ -4,4 +4,4 @@ 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)
+# server 'example.com', user: 'deploy-user', roles: %w[app web cron db]

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

@@ -1,8 +1,4 @@
 namespace :deploy do
-  desc 'Restart application'
-  task :restart do
-    invoke 'passenger:restart'
-  end
 
   desc 'Show deployed revision'
   task :revision do
@@ -12,4 +8,5 @@ namespace :deploy do
       end
     end
   end
+
 end

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

@@ -124,16 +124,25 @@ resources :users do
       def add_user_factory
         factories_file = 'spec/factories/factories.rb'
 
-        # Remove empty factory, if it exists
-        gsub_file factories_file, "  factory :user\n\n", ''
+        # Remove empty factory
+        gsub_file factories_file, "\n  factory :user\n", ''
 
-        inject_into_file factories_file, <<-'CONTENT', before: /end\n\z/
+        # In a second `transform` run, this might already be present
+        unless file_contains? factories_file, 'factory :user'
+          inject_into_file factories_file, <<-'CONTENT', before: /end\n\z/
   factory :user do
     sequence(:email) { |i| "user-#{ i }@example.com" }
     password 'password'
   end
 
-        CONTENT
+          CONTENT
+        end
+      end
+
+      private
+
+      def user
+        @element.user
       end
 
     end

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

@@ -47,11 +47,11 @@ Feature: Everything about user authentication
 
 
   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 <%= user.label_attr.name(:variable) %> "<%= user.label_attr.test_value %>"
       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 "<%= user.label_attr.test_value %>" within the navbar
     Then I should be on the form for the user above
 
     When I fill in "Password" with "new-password"
@@ -59,7 +59,7 @@ Feature: Everything about user authentication
     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 "Email" with "<%= (user.label_attr.type == :email) ? user.label_attr.test_value : "henry@example.com" %>"
       And I fill in "Password" with "new-password"
       And I press "Sign in"
     Then I should be on the homepage

data/lib/generators/katapult/model/model_generator.rb

@@ -31,14 +31,24 @@ module Katapult
       end
 
       def write_factory
-        insert_into_file 'spec/factories/factories.rb', <<-FACTORY, before: /end\n\z/
-  factory #{ model.name(:symbol) }
+        factory = "  factory #{ model.name(:symbol) }"
+        factories_file = 'spec/factories/factories.rb'
+        # Can happen in multiple transformation runs with authentication
+        return if file_contains?(factories_file, factory)
 
-        FACTORY
+        factory_attrs = model.required_attrs.map do |a|
+          "    #{ a.name(:human) } #{ a.test_value.inspect }"
+        end
+
+        if factory_attrs.any?
+          factory << " do\n#{ factory_attrs.join "\n" }\n  end"
+        end
+
+        insert_into_file factories_file, factory + "\n\n", before: /end\n\z/
       end
 
       def generate_unit_tests
-        Generators::ModelSpecsGenerator.new(model).invoke_all
+        Generators::ModelSpecsGenerator.new(model, options).invoke_all
       end
 
       no_commands do

data/lib/generators/katapult/templates/templates_generator.rb

@@ -0,0 +1,35 @@
+module Katapult
+  class TemplatesGenerator < Rails::Generators::Base
+
+    desc 'Copy Katapult templates to the target application'
+    source_root File.expand_path('..', __dir__) # lib/generators/katapult
+
+    def copy_view_templates
+      copy_generator_templates 'views', %w[
+        _form.html.haml
+        edit.html.haml
+        index.html.haml
+        new.html.haml
+        show.html.haml
+      ]
+    end
+
+    def copy_controller_template
+      copy_generator_templates 'web_ui', 'controller.rb'
+    end
+
+    private
+
+    # file_list should contain paths relative the the respective generator
+    # template root
+    def copy_generator_templates(generator_name, file_list)
+      Array(file_list).each do |filename|
+        source = File.join generator_name, 'templates', filename
+        destination = File.join 'lib/templates/katapult', generator_name, filename
+
+        copy_file source, destination
+      end
+    end
+
+  end
+end

data/lib/generators/katapult/transform/transform_generator.rb

@@ -20,7 +20,7 @@ module Katapult
       @app_model = Katapult::ApplicationModel.parse(application_model, path)
 
       say_status :render, "into #{app_name}"
-      @app_model.render
+      @app_model.render options.slice(:force)
     end
 
     def write_root_route
@@ -33,9 +33,9 @@ module Katapult
     def remigrate_all_databases
       return if ENV['SKIP_MIGRATIONS'] # Used to speed up tests
 
-      run 'rake db:drop db:create db:migrate'
+      rake 'db:drop db:create db:migrate'
       # See comment to Katapult::BasicsGenerator#create_databases
-      run 'unset RAILS_ENV; rake parallel:drop parallel:create parallel:prepare'
+      run 'unset RAILS_ENV; bundle exec rake parallel:drop parallel:create parallel:prepare'
     end
 
   end

data/lib/generators/katapult/views/views_generator.rb

@@ -50,7 +50,7 @@ module Katapult
 
       def generate_integration_tests
         if web_ui.model.present?
-          Generators::CucumberFeaturesGenerator.new(web_ui.model).invoke_all
+          Generators::CucumberFeaturesGenerator.new(web_ui.model, options).invoke_all
         end
       end
 

data/lib/generators/katapult/web_ui/web_ui_generator.rb

@@ -36,7 +36,7 @@ MESSAGE
       end
 
       def generate_views
-        Generators::ViewsGenerator.new(web_ui).invoke_all
+        Generators::ViewsGenerator.new(web_ui, options).invoke_all
       end
 
       no_tasks do

data/lib/katapult/application_model.rb

@@ -11,7 +11,7 @@ module Katapult
 
     NotFound = Class.new(StandardError)
 
-    attr_reader :models, :web_uis, :navigation, :authentication, :associations
+    attr_reader :models, :web_uis, :nav, :authentication, :associations
 
     def self.parse(application_model_string, path_to_model = '')
       new.tap do |model|
@@ -38,7 +38,7 @@ module Katapult
 
     # DSL
     def navigation(name = :main)
-      @navigation = Navigation.new(name, application_model: self)
+      @nav = Navigation.new(name, application_model: self)
     end
 
     # DSL
@@ -78,13 +78,13 @@ module Katapult
       associations.select { |a| a.belongs_to == model_name }.map(&:model)
     end
 
-    def render
+    def render(options = {})
       prepare_render
 
-      models.each &:render
-      web_uis.each &:render
-      navigation.render if navigation
-      authentication.render if authentication
+      models.each { |m| m.render(options) }
+      web_uis.each { |w| w.render(options) }
+      nav.render(options) if nav
+      authentication.render(options) if authentication
     end
 
     private

data/lib/katapult/elements/attribute.rb

@@ -32,6 +32,22 @@ module Katapult
       !default.nil? and not [flag?, assignable_values].any?
     end
 
+    def renderable?
+      %i[plain_json json password].exclude? type
+    end
+
+    def editable?
+      %i[plain_json json].exclude? type
+    end
+
+    def required?
+      if assignable_values.present?
+        default.blank? && allow_blank.blank?
+      else
+        false
+      end
+    end
+
     def for_migration
       db_type = case type
       when :email, :url, :password then 'string'

data/lib/katapult/elements/authentication.rb

@@ -7,15 +7,18 @@ module Katapult
     attr_accessor :system_email
 
     def ensure_user_model_attributes_present
-      user_model = application_model.get_model!(name)
-      user_attrs = user_model.attrs.map(&:name)
+      user_attrs = user.attrs.map(&:name)
 
-      user_model.attr(:email) unless user_attrs.include?('email')
-      user_model.attr(:password, type: :password, skip_db: true) unless user_attrs.include?('password')
+      user.attr(:email) unless user_attrs.include?('email')
+      user.attr(:password, type: :password, skip_db: true) unless user_attrs.include?('password')
     end
 
-    def render
-      Generators::ClearanceGenerator.new(self).invoke_all
+    def render(options = {})
+      Generators::ClearanceGenerator.new(self, options).invoke_all
+    end
+
+    def user
+      @user ||= application_model.get_model!(name)
     end
 
   end

data/lib/katapult/elements/model.rb

@@ -48,11 +48,15 @@ module Katapult
     end
 
     def renderable_attrs
-      attrs.reject { |a| %w[plain_json json password].include? a.type.to_s }
+      attrs.select &:renderable?
     end
 
     def editable_attrs
-      attrs.reject { |a| %w[plain_json json].include? a.type.to_s }
+      attrs.select &:editable?
+    end
+
+    def required_attrs
+      attrs.select &:required?
     end
 
     def add_foreign_key_attrs(belongs_tos)
@@ -64,8 +68,8 @@ module Katapult
       end
     end
 
-    def render
-      Generators::ModelGenerator.new(self).invoke_all
+    def render(options = {})
+      Generators::ModelGenerator.new(self, options).invoke_all
     end
 
     private

data/lib/katapult/elements/navigation.rb

@@ -19,8 +19,8 @@ module Katapult
       end
     end
 
-    def render
-      Generators::NavigationGenerator.new(self).invoke_all
+    def render(options = {})
+      Generators::NavigationGenerator.new(self, options).invoke_all
     end
 
   end

data/lib/katapult/elements/web_ui.rb

@@ -78,8 +78,8 @@ module Katapult
       model.name(kind)
     end
 
-    def render
-      Generators::WebUIGenerator.new(self).invoke_all
+    def render(options = {})
+      Generators::WebUIGenerator.new(self, options).invoke_all
     end
 
   end

data/lib/katapult/generator.rb

@@ -9,10 +9,13 @@ module Katapult
 
     attr_accessor :element
 
-    def initialize(element)
+    # @option :force (from Thor): Overwrite on conflict
+    def initialize(element, options = {})
       self.element = element
+      args = [element.name]
+      config = {}
 
-      super([element.name], {}, {}) # args, opts, config
+      super args, options, config
     end
 
     private
@@ -22,5 +25,12 @@ module Katapult
       ERB.new(::File.binread(path), nil, '%').result(given_binding || binding)
     end
 
+    def generate(generator_name)
+      args = []
+      args << '--force' if options[:force]
+
+      super generator_name, *args
+    end
+
   end
 end

data/lib/katapult/support/generator_goodies.rb

@@ -1,3 +1,6 @@
+# This module holds methods that are shared between Katapult's element generators
+# and the Rails generators it uses (e.g. BasicsGenerator)
+#
 module Katapult::GeneratorGoodies
 
   def yarn(*args)
@@ -5,6 +8,11 @@ module Katapult::GeneratorGoodies
     run command
   end
 
+  def file_contains?(path, content)
+    file_content = File.read(path)
+    file_content.include? content
+  end
+
   private
 
   def app_name(kind = nil)
@@ -27,4 +35,10 @@ module Katapult::GeneratorGoodies
     end
   end
 
+  # Override Thor method
+  def rake(command, config = {})
+    command.prepend 'bundle exec rake '
+    run command, config
+  end
+
 end