kowl 0.0.1

data/lib/kowl/templates/lib/tasks/stats.rake

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Modified from => https://github.com/rails/rails/blob/feb97dfabd027a73a41ca8bd2ab7c3196ab76d3d/railties/lib/rails/tasks/statistics.rake
+# While global constants are bad, many 3rd party tools depend on this one (e.g
+# rspec-rails & cucumber-rails). So a deprecation warning is needed if we want
+# to remove it.
+STATS_FOLDERS = [
+  %w(Controllers        app/controllers),
+  %w(Helpers            app/helpers),
+  %w(Jobs               app/jobs),
+  %w(Models             app/models),
+  %w(Mailers            app/mailers),
+  %w(Mailboxes          app/mailboxes),
+  %w(Channels           app/channels),
+  %w(JavaScripts        app/assets/javascripts),
+  %w(Webpacker          app/javascript),
+  %w(Dashboards         app/dashboards),
+  %w(Fields             app/fields),
+  %w(Inputs             app/inputs),
+  %w(Policies           app/policies),
+  %w(Services           app/services),
+  %w(Workers            app/workers),
+  %w(Libraries          lib/),
+  %w(APIs               app/apis),
+  %w(Controller\ tests  test/controllers),
+  %w(Helper\ tests      test/helpers),
+  %w(Model\ tests       test/models),
+  %w(Mailer\ tests      test/mailers),
+  %w(Mailbox\ tests     test/mailboxes),
+  %w(Channel\ tests     test/channels),
+  %w(Job\ tests         test/jobs),
+  %w(Integration\ tests test/integration),
+  %w(System\ tests      test/system),
+].collect do |name, dir|
+  [ name, "#{File.dirname(Rake.application.rakefile_location)}/#{dir}" ]
+end.select { |name, dir| File.directory?(dir) }
+
+desc 'Report code statistics (KLOCs, etc) from the application or engine'
+task :more_stats do
+  require 'rails/code_statistics'
+  CodeStatistics.new(*STATS_FOLDERS).to_s
+end

data/lib/kowl/templates/tests/factories/login_activity.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :LoginActivity do
+    identity { Faker::Internet.email }
+    ip { Faker::Internet.ip_v4_address }
+    success { Faker::Boolean.boolean }
+    user_type { 'User' }
+    association :user, factory: :user
+  end
+end

data/lib/kowl/templates/tests/factories/user.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :user do
+    email { Faker::Internet.email }
+    role { :user }
+    password { 'Pa$$w0rd!' }
+    password_confirmation { 'Pa$$w0rd!' }
+    # password { Faker::Internet.password(min_length: 6, mix_case: true, special_characters: true) }
+  end
+end

data/lib/kowl/templates/tests/minitest/README.md

@@ -0,0 +1,3 @@
+[https://guides.rubyonrails.org/testing.html](Rails Testing Guide)
+
+[The difference between Integraton Tests vs Controller Tests](https://www.codewithjason.com/difference-integration-tests-controller-tests-rails/)

data/lib/kowl/templates/tests/minitest/application_system_test_case.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
+end

data/lib/kowl/templates/tests/minitest/controllers/pages_controller_test.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class PageControllerTest < ActionController::TestCase
+  def welcome
+    get welcome_path
+    assert_response :success
+  end
+end

data/lib/kowl/templates/tests/minitest/models/login_activity_test.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class LoginActivityTest < ActiveSupport::TestCase
+  # Associations
+  # should belong_to(:user)
+end

data/lib/kowl/templates/tests/minitest/models/user_test.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+# https://www.rubydoc.info/github/thoughtbot/shoulda-matchers/master/Shoulda%2FMatchers%2FActiveModel:validate_numericality_of
+class UserTest < ActiveSupport::TestCase
+  # Associations
+  # should have_many(:login_activies)
+
+  # Validations
+  # should validate_presence_of(:email)
+  # should validate_length_of(:email).is_at_least(5).is_at_most(255)
+  # should validate_presence_of(:role)
+  # should define_enum_for(:role)
+end

data/lib/kowl/templates/tests/minitest/policies/login_activity_policy_test.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class LoginActivityPolicyTest < ActiveSupport::TestCase
+
+end

data/lib/kowl/templates/tests/minitest/policies/user_policy_test.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+class UserPolicyTest < ActiveSupport::TestCase
+
+end

data/lib/kowl/templates/tests/minitest/support/capybara.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'capybara/rails'
+require 'capybara/minitest'
+require 'webdrivers'
+# Integration testing
+
+# default capybara/selenium configuration
+# https://github.com/itmammoth/capybara-bootstrap/blob/master/scrape.rb
+# https://thoughtbot.com/blog/headless-feature-specs-with-chrome
+# run as headless mode with set window size
+Capybara.register_driver :headless_chrome do |app|
+  options = Selenium::WebDriver::Chrome::Options.new(
+    args: %w[headless disable-extensions disable-gpu disable-infobars disable-translate no-sandbox window-size=1280,800]
+  )
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
+end
+
+Capybara.javascript_driver = :headless_chrome
+Capybara.configure do |config|
+  config.default_max_wait_time = 5 # seconds
+  config.default_driver = :headless_chrome
+end
+
+# used for Integration Testing
+class ActionDispatch::IntegrationTest
+  # Make the Capybara DSL available in all integration tests
+  include Capybara::DSL
+  # Make `assert_*` methods behave like Minitest assertions
+  include Capybara::Minitest::Assertions
+
+  # Reset sessions and driver between tests
+  # Use super wherever this method is redefined in your individual test classes
+  def teardown
+    Capybara.reset_sessions!
+    Capybara.use_default_driver
+  end
+end

data/lib/kowl/templates/tests/minitest/support/database_cleaner.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# https://github.com/DatabaseCleaner/database_cleaner
+# https://medium.com/brief-stops/testing-with-rspec-factorygirl-faker-and-database-cleaner-651c71ca0688
+# Flush the database during tests to keep test data from clustering or hitting other tests
+require 'capybara/minitest'
+require 'database_cleaner'
+
+if defined?(DatabaseCleaner)
+  DatabaseCleaner.clean_with :truncation
+  DatabaseCleaner.strategy = :transaction
+
+  class ActionDispatch::IntegrationTest
+    include DatabaseCleanerSupport
+  end
+
+  class ActiveSupport::TestCase
+    include DatabaseCleanerSupport
+  end
+end

data/lib/kowl/templates/tests/minitest/support/database_cleaner_support.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'database_cleaner'
+# https://gist.github.com/lujanfernaud/67644f8ea4263f4e638be1090ec85580
+module DatabaseCleanerSupport
+  def before_setup
+    super
+    DatabaseCleaner.start
+  end
+
+  def after_teardown
+    DatabaseCleaner.clean
+    super
+  end
+end

data/lib/kowl/templates/tests/minitest/support/deferred_garbage_collection.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# https://stackoverflow.com/questions/10937366/find-a-list-of-slow-rspec-tests
+# https://makandracards.com/makandra/950-speed-up-rspec-by-deferring-garbage-collection
+class DeferredGarbageCollection
+  DEFERRED_GC_THRESHOLD = (ENV['DEFER_GC'] || 10.0).to_f
+  @@last_gc_run = Time.now
+
+  def self.start
+    GC.disable if DEFERRED_GC_THRESHOLD.positive?
+  end
+
+  def self.reconsider
+    return unless DEFERRED_GC_THRESHOLD.positive? && Time.now - @@last_gc_run >= DEFERRED_GC_THRESHOLD
+
+    GC.enable
+    GC.start
+    GC.disable
+    @@last_gc_run = Time.now
+  end
+end

data/lib/kowl/templates/tests/minitest/support/devise.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+if defined?(Devise)
+  ###
+  # For testing devise_cas
+  # https://github.com/nbudin/devise_cas_authenticatable/wiki/Testing
+  class ActionController::TestCase
+    # include Devise::TestHelpers
+    include Devise::Test::ControllerHelpers
+  end
+
+  class ActionDispatch::IntegrationTest
+    include Warden::Test::Helpers
+    Warden.test_mode!
+  end
+end

data/lib/kowl/templates/tests/minitest/support/factories.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class ActiveSupport::TestCase
+  # Include factoryboy for object creation
+  include FactoryBot::Syntax::Methods
+end

data/lib/kowl/templates/tests/minitest/support/formulaic.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+if defined?(Formulaic)
+  class ActionDispatch::IntegrationTest
+    include Capybara::DSL
+    include Formulaic::Dsl
+  end
+end

data/lib/kowl/templates/tests/minitest/support/helpers/devise_helper.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'devise'
+
+module DeviseHelpers
+  # Used for accessing the action as an admin/superuser (a member of devgroup)
+  def login_as_admin
+    user = FactoryBot.create(:user, role: 'superuser')
+    login_as(user)
+  end
+  # EXAMPLE: ----------------------------------------
+  # describe 'GET #index' do
+  #   it 'returns http success' do
+  #     login_as_admin
+  #     get :index
+  #     expect(response).to have_http_status(:success)
+  #   end
+  # end
+
+  def login_as_staff
+    user = FactoryBot.create(:user, role: :staff)
+    login_as(user)
+  end
+
+  # Used for hitting the user as a generic user
+  def login_as_user
+    user = FactoryBot.create(:user)
+    login_as(user)
+  end
+  # EXAMPLE: ----------------------------------------
+  # describe 'GET #index' do
+  #   it 'returns http success' do
+  #     login_as_user
+  #     get :index
+  #     expect(response).to have_http_status(:success)
+  #   end
+  # end
+
+  # Used for simulating a login as the specified user
+  def login_as(user)
+    user = FactoryBot.create(:user) if user.nil?
+    allow(controller).to receive(:authenticate_user!).and_return(true)
+    allow(controller).to receive(:current_user).and_return(user)
+  end
+  # EXAMPLE: ----------------------------------------
+  # This is also good to use if you need to add custom paramters to test against the user
+  # before do
+  #   @user = FactoryBot.create(:user, superuser: false, position: 'Nurse', )
+  # end
+  # describe 'GET #index' do
+  #   it 'returns http success' do
+  #     login_as @user
+  #     get :welcome
+  #     expect(response).to have_http_status(:success)
+  #   end
+  # end
+end

data/lib/kowl/templates/tests/minitest/support/papertrail.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# for enabling versioning to verify event captioning
+if defined?(PaperTrail)
+  def with_versioning
+    was_enabled = PaperTrail.enabled?
+    was_enabled_for_request = PaperTrail.request.enabled?
+    PaperTrail.enabled = true
+    PaperTrail.request.enabled = true
+    begin
+      yield
+    ensure
+      PaperTrail.enabled = was_enabled
+      PaperTrail.request.enabled = was_enabled_for_request
+    end
+  end
+end

data/lib/kowl/templates/tests/minitest/support/shoulda.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# dsl matchers for controllers, models, and views
+# Add shoulda test helpers: https://matchers.shoulda.io/
+require 'shoulda'
+Shoulda::Matchers.configure do |config|
+  config.integrate do |with|
+    with.test_framework :minitest
+    with.library :rails
+  end
+end

data/lib/kowl/templates/tests/minitest/support/simplecov.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Used to generate a test coverage report
+require 'simplecov'
+SimpleCov.start do
+  # Excluded, because in order to test it. It would have to a set of login requests
+  add_filter 'app/controllers/users_controller.rb'
+end

data/lib/kowl/templates/tests/minitest/test_helper.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+ENV['RAILS_ENV'] ||= 'test'
+require_relative '../config/environment'
+require 'rails/test_help'
+require 'minitest/reporters'
+Minitest::Reporters.use!
+
+# load test engines and set their configurations
+Dir[Rails.root.join('test/support/**/*.rb')].each { |f| require f }
+
+class ActiveSupport::TestCase
+  # Run tests in parallel with specified workers
+  parallelize(workers: :number_of_processors)
+
+  # Add more helper methods to be used by all tests here...
+end

data/lib/kowl/templates/tests/rspec/README.md

@@ -0,0 +1,9 @@
+[RSpec Rails Docs](https://relishapp.com/rspec/rspec-rails/docs)
+
+[RSpec](https://rspec.info/)
+
+[Better Specs](http://www.betterspecs.org/)
+
+[rspec-best-practices](https://github.com/codica2/rspec-best-practices)
+
+[Rails Testing with RSpec](https://blog.trk.in.rs/2015/11/09/rails-testing/)

data/lib/kowl/templates/tests/rspec/controllers/admin/application_controller_spec.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Admin::ApplicationController, type: :controller do
+  describe 'Require authentication' do
+    context 'when requesting /admin/*' do
+      it { is_expected.to use_before_action(:authenticate_user!) }
+      it { is_expected.to use_before_action(:ensure_admin!) }
+    end
+  end
+end

data/lib/kowl/templates/tests/rspec/controllers/admin/users_controller_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Admin::UsersController, type: :controller do
+  describe 'When user' do
+    before { login_as_user }
+
+    it 'GET index' do
+      get :index
+      expect(response).to be_redirect
+    end
+  end
+end

data/lib/kowl/templates/tests/rspec/controllers/pages_controller_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe PagesController, type: :controller do
+  describe 'GET #welcome' do
+    subject { get :welcome }
+    it { expect(response).to have_http_status(:success) }
+  end
+end

data/lib/kowl/templates/tests/rspec/features/README.md

@@ -0,0 +1,15 @@
+# RSpec and Capybara
+
+[RSpec feature tests](https://relishapp.com/rspec/rspec-rails/docs/feature-specs/feature-spec)
+
+[Capybara Cheatsheet](https://gist.github.com/zhengjia/428105)
+
+[Integration Tests with Capybara](https://thoughtbot.com/blog/rspec-integration-tests-with-capybara)
+
+[Writing unit tests as feature tests](https://bhserna.com/writing-unit-tests-as-feature-tests.html)
+
+[Capybara](https://github.com/teamcapybara/capybara)
+
+[RSpec/Capybara integration tests: the ultimate guide](https://www.codewithjason.com/rails-integration-tests-rspec-capybara/)
+
+[Gitlab moving to headless chrome](https://about.gitlab.com/2017/12/19/moving-to-headless-chrome/)

data/lib/kowl/templates/tests/rspec/features/visitor_sign_up_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+feature 'Signup User' do
+  scenario 'with valid credentails' do
+    sign_up_user('test@test.com', 'Passw0rd!')
+
+    expect(page).to have_text('Welcome! You have signed up successfully.')
+  end
+
+  scenario 'with invalid credentials' do
+    sign_up_user('test@test.com', 'password')
+
+    expect(page).to have_text('Password must contain at least one digit')
+  end
+
+  def sign_up_user(email, password)
+    visit new_user_registration_path
+    fill_in 'user_email', with: email
+    fill_in 'user_password', with: password
+    fill_in 'user_password_confirmation', with: password
+    click_button 'Sign up'
+  end
+end

data/lib/kowl/templates/tests/rspec/helpers/application_helper_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe ApplicationHelper, type: :helper do
+
+end

data/lib/kowl/templates/tests/rspec/helpers/pages_helper_spec.rb

@@ -0,0 +1,15 @@
+require 'rails_helper'
+
+# Specs in this file have access to a helper object that includes
+# the PagesHelper. For example:
+#
+# describe PagesHelper do
+#   describe "string concat" do
+#     it "concats two strings with spaces" do
+#       expect(helper.concat_strings("this","that")).to eq("this that")
+#     end
+#   end
+# end
+RSpec.describe PagesHelper, type: :helper do
+
+end

data/lib/kowl/templates/tests/rspec/models/login_activity_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe LoginActivity, type: :model do
+  describe 'associations do' do
+    context 'when users' do
+      it { is_expected.to belong_to(:user) }
+    end
+  end
+end

data/lib/kowl/templates/tests/rspec/models/user_spec.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe User, type: :model do
+  describe 'validations' do
+    context 'with email' do
+      it { is_expected.to validate_presence_of(:email) }
+      it { is_expected.to validate_length_of(:email).is_at_least(5).is_at_most(255) }
+      # it { is_expected.to validate_uniqueness_of(:email).case_insensitive }
+    end
+
+    context 'with roles' do
+      it { is_expected.to define_enum_for(:role).with(described_class.roles.keys) }
+    end
+
+    context 'with associations' do
+      it { is_expected.to have_many(:login_activities).order(created_at: :desc) }
+    end
+  end
+end

data/lib/kowl/templates/tests/rspec/policies/login_activity_policy_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe UserPolicy, type: :policy do
+  subject { described_class.new(member, user) }
+
+  let(:user) { FactoryBot.create(:user) }
+
+  context 'when user' do
+    let(:member) { FactoryBot.create(:user) }
+
+    it { is_expected.to forbid_actions(%i[index show destroy impersonate]) }
+    it { is_expected.to forbid_new_and_create_actions }
+    it { is_expected.to forbid_edit_and_update_actions }
+  end
+
+  context 'when staff' do
+    let(:member) { FactoryBot.create(:user, role: 'staff') }
+
+    it { is_expected.to forbid_actions(%i[index destroy impersonate]) }
+    it { is_expected.to permit_action(:show) }
+    it { is_expected.to forbid_new_and_create_actions }
+    it { is_expected.to permit_edit_and_update_actions }
+  end
+
+  context 'when superuser' do
+    let(:member) { FactoryBot.create(:user, role: 'superuser') }
+
+    it { is_expected.to permit_actions(%i[index show destroy impersonate]) }
+    it { is_expected.to forbid_new_and_create_actions }
+    it { is_expected.to permit_edit_and_update_actions }
+  end
+
+  permissions :update? do
+    let(:staff) { FactoryBot.create(:user, role: 'staff') }
+    let(:superuser) { FactoryBot.create(:user, role: 'superuser') }
+
+    context 'when user' do
+
+      describe 'when updating user' do
+        it { expect(described_class).to permit(staff, user) }
+      end
+
+      describe 'when updating superusers' do
+        it { expect(described_class).not_to permit(staff, superuser) }
+      end
+    end
+  end
+
+  permissions :show? do
+    let(:staff) { FactoryBot.create(:user, role: 'staff') }
+    let(:superuser) { FactoryBot.create(:user, role: 'superuser') }
+
+    it "staff can't view superuser" do
+      expect(described_class).not_to permit(staff, superuser)
+    end
+  end
+end

data/lib/kowl/templates/tests/rspec/policies/user_policy_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe UserPolicy, type: :policy do
+  subject { described_class.new(member, user) }
+
+  let(:user) { FactoryBot.create(:user) }
+
+  context 'when user' do
+    let(:member) { FactoryBot.create(:user) }
+
+    it { is_expected.to forbid_actions(%i[index show destroy impersonate]) }
+    it { is_expected.to forbid_new_and_create_actions }
+    it { is_expected.to forbid_edit_and_update_actions }
+  end
+
+  context 'when staff' do
+    let(:member) { FactoryBot.create(:user, role: 'staff') }
+
+    it { is_expected.to forbid_actions(%i[index destroy impersonate]) }
+    it { is_expected.to permit_action(:show) }
+    it { is_expected.to forbid_new_and_create_actions }
+    it { is_expected.to permit_edit_and_update_actions }
+  end
+
+  context 'when superuser' do
+    let(:member) { FactoryBot.create(:user, role: 'superuser') }
+
+    it { is_expected.to permit_actions(%i[index show destroy impersonate]) }
+    it { is_expected.to forbid_new_and_create_actions }
+    it { is_expected.to permit_edit_and_update_actions }
+  end
+
+  permissions :update? do
+    let(:staff) { FactoryBot.create(:user, role: 'staff') }
+    let(:superuser) { FactoryBot.create(:user, role: 'superuser') }
+
+    it 'when staff and updating users' do
+      expect(described_class).to permit(staff, user)
+    end
+
+    it 'when staff and updating superusers' do
+      expect(described_class).not_to permit(staff, superuser)
+    end
+  end
+
+  permissions :show? do
+    let(:staff) { FactoryBot.create(:user, role: 'staff') }
+    let(:superuser) { FactoryBot.create(:user, role: 'superuser') }
+
+    it "staff can't view superuser" do
+      expect(described_class).not_to permit(staff, superuser)
+    end
+  end
+end