kowl 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37626221be27260120fd6a0f658280f422fe7e93e696e5fac6502f7d644470f7
-  data.tar.gz: ec6f8debdb845e0638c7c3ad5739a59d8e164142a9dc3fced6150e0b6b8799c9
+  metadata.gz: 55dad8fede71a47a827d7dfabfcea21698ac1c0a103e0df207ab1ed8fb6d43b8
+  data.tar.gz: d977434db889ef74b5e3ad1afde05be472b3cfbf9ad27454ff99c239945bb665
 SHA512:
-  metadata.gz: 643d150a84ca6d872cf7fdb9488fea678e9edc6d0a1172175b804858cf46ef659bed67c90eefd0ea46845b9392cb7648ab1c425e7c2dda2206f68343f882aed0
-  data.tar.gz: a4d0ee1bfae9b4616d9de8502bd49b1aaa03517962767364c9755f8dd7ed9f60e6c384c73650cdac321fa7b083649c208bf1b961a23421c4d5b4d4c9089342b8
+  metadata.gz: '0859756bfdbe7291da754cd336203eca8d9f831d8398af0588a9f242ebf4712c985770f9dd5fcff739ccccce845c7cea070f5bc2e61c39bee1507f0ff5aa521e'
+  data.tar.gz: 33efd6182937aaecd1dc32592d7e0d24736b759959a2ce1c7757aaa06214085cf20604c7d955e24ca056a6970a0f44b8cfb7171502ba8db4c3d62aab4bc5800d

data/README.md

@@ -126,7 +126,7 @@ Options:
                                              # Default: false
    [--skip_javascript]                       # Skip adding javascript (webpacker) to the application
                                              # Default: false
-   [--skip_mailer]                           # Do you want to skip setting up a
+   [--skip_mailer]                           # Do you want to skip setting up a transactional mailer (see --mailer option above)?
                                              # Default: false
    [--skip_pagination]                       # Do you want to skip using pagination with your application?
                                              # Default: false
@@ -170,7 +170,7 @@ Options:
 
   `kowl AppName --git_repo=https://github/username/REPO_NAME.git`
 
-  Will generate an app with remote directory of https://github/username/REPO_NAME.git
+  Will generate an app with the remote repo set as `https://github/username/REPO_NAME.git`
 
   `kowl foobar --template_engine=haml --simpleform --framework=semantic;`
 
@@ -178,7 +178,7 @@ Options:
 
 ### Walk-Throughts
 
-* [#](/docs/actiontext.md) Create an application using simple_form and create posts scaffold and admin page that will use ActionText 
+* [#](/docs/actiontext.md) Create an application using simple_form and create posts scaffold and admin page that will use ActionText
 
 ## Gems
 
@@ -231,7 +231,7 @@ User gems that will be included unless the `--noauth` flag is specified when gen
 * [active_decorator](https://github.com/amatsuda/active_decorator) OOP view helpers for cleaning up your models.
 * [annotate](https://github.com/ctran/annotate_models) for adding a comment summarizing the current schema to models, routes, etc.
 * [auto_strip_attributes](https://github.com/holli/auto_strip_attributes) remove unnecessary whitespace from ActiveRecord attributes.
-* [fast_jsonapi](fast-jsonapi/fast_jsonapi) lightning fast JSON:API serializer (originally releases by [Netflix](https://github.com/Netflix/fast_jsonapi))
+* [jsonapi-serializer](https://github.com/jsonapi-serializer/jsonapi-serializer) lightning fast JSON:API serializer (originally releases by [Netflix](https://github.com/Netflix/fast_jsonapi))
 * [meta-tags](https://github.com/kpumuk/meta-tags) helpers for making SEO/meta-tags easier to manage with your rails application.
 * [oj](http://www.ohler.com/oj/) a fast JSON object serializer.
 * [simple_form](https://github.com/heartcombo/simple_form) a DSL for making forms easy to style and manage.
@@ -269,7 +269,7 @@ User gems that will be included unless the `--noauth` flag is specified when gen
 These gems will be included to setup sidekiq unless the `--skip_sidekiq` flag is used when generating an application.
 
 * [hiredis](https://github.com/redis/hiredis-rb) a C adapter for connecting your application to a Redis datestore _(faster than the ruby redis library)_.
-* [Sidekiq](https://github.com/mperham/sidekiq/)
+* [Sidekiq](https://github.com/mperham/sidekiq/) simple, efficient background processing for Ruby
 * [Sidekiq-Failures](https://github.com/mhfs/sidekiq-failures/) to get a better view of what jobs are failing.
 * [Sidekiq-Scheduler](https://moove-it.github.io/sidekiq-scheduler/) to schedule sidekiq jobs on a given interval.
 * [Sidekiq-Status](https://github.com/utgarda/sidekiq-status) is sidekiq extension to get a better status report of all currently running jobs.
@@ -326,11 +326,12 @@ If using ruby `>= 2.7` it also includes `e2mmap` and `thwait` to prevent ruby de
 
 ## Additonal Stuff
 
+* It corrects the issue ([37008](https://github.com/rails/rails/pull/37008)) when generating a Rails (v6) application when specifying Oracle as the database
 * When using this gem to generate applications it changes the devise password encrypting from bcrypt to [Argon2](https://cryptobook.nakov.com/mac-and-key-derivation/argon2)
 * When generating application Dockerfiles it defaults to using [Alpine](https://alpinelinux.org/) which will produce smaller docker images. But if applications are specified to use Oracle as the database it will default to [Debian](https://www.debian.org/) _(due to the required dependencies to use the [Oracle InstantClient](https://www.oracle.com/database/technologies/instant-client.html))_.
 * The `--encrypt` flag is used to enforce [GDPR](https://gdprchecklist.io/) and [CCPA](https://oag.ca.gov/privacy/ccpa) compliance to encrypt PII for users. _([GDPR Article 34, Section 3 (a)](https://gdpr-info.eu/art-34-gdpr/))_ By encrypting user identifiable information; this ensurers PII isn't plain text readable by hackers in case there is a data breach with the application. When encrypting user data it will use the [lockbox](https://github.com/ankane/lockbox) with the [xsalsa20](https://en.wikipedia.org/wiki/Salsa20) algorithm which requires [libsodium](https://libsodium.gitbook.io/doc/).
-* When using javascript/webpacker not only will it gzip js assets, it will also compress assets with brotli and zopfli compression.
-* A number of linter dotfiles added so you don't have to hunt down how they are setup.
+* When using javascript/webpacker not only will it gzip js assets, it will also compress assets with brotli and zopfli compression _(in production)_.
+* A number of linter dotfiles added, that way you don't have to hunt down how they are setup. And you only need to use the linters than you want to use.
 
 ## Notes
 

data/lib/kowl.rb

@@ -12,7 +12,7 @@ require 'kowl/generators/overrides/app_generator'
 # Load the list of customized application generators
 generators = %w[action admin assets config controller database decorators docker dotfiles libs mailer misc pages routes
                 sidekiq staging test text_files users_and_auth uuid views_and_helpers]
-generators.map { |file| require "kowl/generators/#{file}_generator" }
+generators.map { |file| require_relative "kowl/generators/#{file}_generator" }
 
 # For generating base template files, once the application has been build
 require 'kowl/generators/overrides/app_builder'

data/lib/kowl/actions.rb

@@ -135,7 +135,7 @@ module Kowl
     end
 
     # Add PgHero engine mount to the routes if the database iss postgresql
-    # @param database [String] A string containing the applications defined database adapater
+    # @param database [String] A string containing the applications defined database adapter
     # @return [String] the pghero dashboard mount path, if postgresql will be used
     def database_route(database = 'sqlite3')
       return '' unless database.to_s == 'postgresql'

data/lib/kowl/docker.rb

@@ -389,7 +389,7 @@ module Kowl
     # @return [String] an apk string for installing dependencies in the dockerfile
     def alpine_docker_dependencies(options = {})
       # core dependencies
-      dependencies = %w[brotli dumb-init git sqlite sqlite-dev tzdata vips vips-dev yarn]
+      dependencies = %w[brotli dumb-init git python3 sqlite sqlite-dev tzdata vips vips-dev yarn]
       # optional dependencies
       dependencies << 'graphviz' unless options[:skip_erd]
       dependencies << 'libsodium-dev' if options[:encrypt]
@@ -413,7 +413,7 @@ module Kowl
     # @param options [Hash] a list of the applictions specific options to determine what all dependencies are required
     # @return [String] an `apt-get install` with a list of all the applications dependencies listed
     def debian_docker_dependencies(options = {})
-      dependencies = %w[brotli curl git libjemalloc-dev libsqlite3-dev libvips sqlite3 wget]
+      dependencies = %w[brotli curl git libjemalloc-dev libsqlite3-dev libvips python sqlite3 wget]
 
       # optional dependencies
       dependencies << 'graphviz' unless options[:skip_erd]

data/lib/kowl/generators/base.rb

@@ -33,7 +33,7 @@ module Kowl
 
       # Return a cleaned up version of the name of the application being generated
       def app_name
-        Rails.app_class.parent_name.demodulize.underscore.dasherize
+        @app_name ||= Rails.app_class.module_parent_name.demodulize.underscore.dasherize
       end
     end
   end

data/lib/kowl/generators/config_generator.rb

@@ -127,11 +127,6 @@ module Kowl
       copy_file 'middleware.rb', 'config/initializers/middleware.rb', force: true
     end
 
-    # Generate initializer for using administrate with the application
-    def copy_administate_config
-      template('administrate.rb.tt', 'config/initializers/administrate.rb') unless options[:noauth]
-    end
-
     # Run the ERD generator, so the application will generate a new ERB when migrations are added/modified
     def setup_erd
       return nil if options[:skip_erd]

data/lib/kowl/generators/overrides/app_generator.rb

@@ -191,8 +191,6 @@ module Kowl
             extract_css: true
             # Cache manifest.json for performance
             cache_manifest: true
-            # Compile staging packs to a separate directory
-            public_output_path: packs-staging
         STAGING
         append_to_file('config/webpacker.yml', "\n#{webpacker_str}")
       end

data/lib/kowl/helpers.rb

@@ -113,7 +113,7 @@ def dh(str = '')
 end
 
 # Used to create and return the .env file database configuration for the specific environment
-# @param database [String] the database adapater in which the application will be connecting to
+# @param database [String] the database adapter in which the application will be connecting to
 # @param env [String] the environment which the env file is bring created for
 # @return [String] a list of database parameters for the specific database connection
 def dotfile_databases(database, env)

data/lib/kowl/templates/Gemfile.erb.tt

@@ -5,10 +5,7 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 # ruby '<%= RUBY_VERSION %>'
 gem 'rails', '<%= Kowl::RAILS_VERSION %>'
-gem 'puma', '~> 4.3'                            # Use Puma as the applications web server
-# gem 'iodine', '~> 0.7'                        # An extremely fast and concurrent Application Server (works well with websockets)
-# gem 'falcon'                                  # A high-performance web server for Ruby, supporting HTTP/1, HTTP/2 and TLS
-# Falon => https://www.codeotaku.com/journal/2019-02/falcon-early-hints/index
+gem 'puma', '>= 4.3'                            # Use Puma as the applications web server
 gem 'rack', '~> 2.2'
 
 # Gems required for running rails with RUBY_VERSION >= 2.7
@@ -71,7 +68,7 @@ gem 'image_processing'                          # Used for processing ActionStor
 ##############################
 # Admin/Dashboard
 ##############################
-gem 'administrate', github: 'thoughtbot/administrate' # Admin dashboard
+gem 'administrate', '>= 0.14' # Admin dashboard
 
 ##############################
 # Authorization, Authentication [Roles], and permissions
@@ -126,7 +123,7 @@ end
 # Misc
 ##############################
 gem 'auto_strip_attributes', '~> 2.5' # Reduce needing to add before_validation hooks to the models to cleanup attributes
-gem 'fast_jsonapi', github: 'fast-jsonapi/fast_jsonapi' # A lightening fast json serializer
+gem 'jsonapi-serializer', github: 'jsonapi-serializer/jsonapi-serializer' # A lightening fast json serializer
 gem 'jbuilder'<%= gemfile_requirement('jbuilder') %>      # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
 gem 'meta-tags'                 # Used for adding dynamic titles when switching between pages.
 gem 'oj'                        # For faster json generating and parsing
@@ -187,6 +184,7 @@ group :development, :test do
 <%= pry_gems(options[:skip_pry]) -%>
 
   # --- Linters (Asset testing, Static Code Analyzers)
+  gem 'fasterer', require: false # Used to scan and check for any slow code
   # gem 'inquisition', github: 'rubygarage/inquisition'
   <%= template_linter_gems(options[:template_engine]) %>
   gem 'scss_lint', require: false

data/lib/kowl/templates/app/dashboards/login_activity_dashboard.rb.tt

@@ -9,8 +9,7 @@ class LoginActivityDashboard < Administrate::BaseDashboard
   # which determines how the attribute is displayed
   # on pages throughout the dashboard.
   ATTRIBUTE_TYPES = {
-    # user: Field::Polymorphic,
-    user: Field::BelongsTo,
+    user: Field::Polymorphic,
 <%- if options[:uuid] -%>
     id: Field::String,
 <%- else -%>

data/lib/kowl/templates/docker/Dockerfile.alpine.tt

@@ -29,6 +29,7 @@ ENV APP_USER='app' \
 RUN apk update && apk -U upgrade >/dev/null 2>&1 && \
     apk add build-base ca-certificates libffi-dev linux-headers openssl >/dev/null 2>&1 && \
 <%= alpine_docker_dependencies(options) -%>
+    ln -sf python3 /usr/bin/python && \
     rm -rf /tmp/* /var/tmp/* /var/cache/apk/* && \
     truncate -s 0 /var/log/*log
 

data/lib/kowl/templates/docker/Dockerfile.debian.tt

@@ -81,10 +81,11 @@ RUN mkdir -p $INSTANT_CLIENT_PATH && \
     alien -i $INSTANT_CLIENT_SQLPLUS_PATH 2>/dev/null && \
     ldconfig
 <%- elsif options[:database] == 'sqlserver' -%>
-RUN wget ftp://ftp.freetds.org/pub/freetds/stable/freetds-1.00.27.tar.gz && \
-    tar -xzf freetds-1.00.27.tar.gz && \
-    rm -rf freetds-1.00.27.tar.gz && \
-    cd freetds-1.00.27 && \
+ENV FREETDS_VERSION='1.2.5'
+RUN wget ftp://ftp.freetds.org/pub/freetds/stable/freetds-$FREETDS_VERSION.tar.gz >/dev/null 2>&1 && \
+    tar -xzf freetds-$FREETDS_VERSION.tar.gz && \
+    rm -rf freetds-$FREETDS_VERSION.tar.gz && \
+    cd freetds-$FREETDS_VERSION && \
     ./configure --prefix=/usr/local --with-tdsver=7.3 --silent >/dev/null 2>&1 && \
     make -j "$(nproc)" >/dev/null 2>&1 && \
     make install >/dev/null 2>&1 && \

data/lib/kowl/templates/dotfiles/fasterer.yml

@@ -1,14 +1,34 @@
+speedups:
+  rescue_vs_respond_to: true
+  module_eval: true
+  shuffle_first_vs_sample: true
+  for_loop_vs_each: true
+  each_with_index_vs_while: false
+  map_flatten_vs_flat_map: true
+  reverse_each_vs_reverse_each: true
+  select_first_vs_detect: true
+  sort_vs_sort_by: true
+  fetch_with_argument_vs_block: true
+  keys_each_vs_each_key: true
+  hash_merge_bang_vs_hash_brackets: true
+  block_vs_symbol_to_proc: true
+  proc_call_vs_yield: true
+  gsub_vs_tr: true
+  select_last_vs_reverse_detect: true
+  getter_vs_attr_reader: true
+  setter_vs_attr_writer: true
+
 exclude_paths:
   - 'app/assets/**/**'
   - 'app/javascript/**/**'
-  - 'bin/**/**'
-  - 'coverage/**/**'
+  - 'bin/'
+  - 'coverage/'
   - 'db/**/*.rb'
-  - 'doc/**/**'
-  - 'log/**/**'
+  - 'doc/'
+  - 'log/'
   - 'node_modulse/**/**'
-  - 'public/**/**'
-  - 'storage/**/**'
-  - 'tmp/**/**'
+  - 'public/'
+  - 'storage/'
+  - 'tmp/'
   - 'vendor/**/*.rb'
   - '**.yml'

data/lib/kowl/version.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Kowl
-  RAILS_VERSION = '6.0.2.2'
+  RAILS_VERSION = '6.0.3.6'
   # Minimum required ruby version which to install the gem
   RUBY_VERSION = '2.5'
   WEBPACKER_VERSION = '5.0'
-  VERSION = '0.0.2'
+  VERSION = '0.0.7'
 end

data/spec/kowl/actions_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Kowl::Docker do
+  before(:each) do
+    # Include the Kowl::Docker module in a class in order to make it testible
+    # => This is because it is also included into the Rails generator class
+    class KowlClass
+      include Kowl::Actions
+    end
+    @kowl = KowlClass.new
+  end
+
+  context 'database route (pghero)' do
+    it { expect(@kowl.database_route).to eq('') }
+    it { expect(@kowl.database_route('mysql')).to eq('') }
+    it { expect(@kowl.database_route('postgresql')).to eq("  mount PgHero::Engine, at: \"pghero\"\n") }
+  end
+
+  context 'mailers' do
+    it { expect(@kowl.mailer_gems('postmark')).to eq("gem 'postmark-rails'") }
+    it { expect(@kowl.mailer_gems).to eq("gem 'sparkpost_rails'") }
+  end
+
+  context 'pry_gems' do
+    it { expect(@kowl.pry_gems(true)).to eq(nil) }
+  end
+
+  context 'robocop test engine' do
+    it { expect(@kowl.robocop_test_engine).to eq('') }
+    it { expect(@kowl.robocop_test_engine('minitest')).to include('minitest') }
+    it { expect(@kowl.robocop_test_engine('rspec')).to include('rspec') }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kowl
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Brandon Hicks
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-05-03 00:00:00.000000000 Z
+date: 2021-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.2.2
+        version: 6.0.3.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.2.2
+        version: 6.0.3.6
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: e2mmap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: thwait
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -244,7 +272,6 @@ files:
 - lib/kowl/templates/config/db/postgresql.yml.tt
 - lib/kowl/templates/config/db/sqlite3.yml.tt
 - lib/kowl/templates/config/db/sqlserver.yml.tt
-- lib/kowl/templates/config/initializers/administrate.rb.tt
 - lib/kowl/templates/config/initializers/bullet.rb
 - lib/kowl/templates/config/initializers/devise-security.rb
 - lib/kowl/templates/config/initializers/devise_argon2.rb
@@ -374,6 +401,7 @@ files:
 - lib/kowl/templates/text_files/robots.txt.tt
 - lib/kowl/templates/text_files/security.txt
 - lib/kowl/version.rb
+- spec/kowl/actions_spec.rb
 - spec/kowl/docker_spec.rb
 - spec/kowl/helpers_spec.rb
 - spec/kowl/version_spec.rb
@@ -386,7 +414,7 @@ metadata:
   bug_tracker_uri: https://github.com/tarellel/kowl/issues
   changelog_uri: https://github.com/tarellel/kowl/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/tarellel/kowl
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -401,12 +429,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.11
+signing_key:
 specification_version: 4
 summary: A rails application generator to get you out the door and started without
   wasting hours to get started.
 test_files:
+- spec/kowl/actions_spec.rb
 - spec/kowl/docker_spec.rb
 - spec/kowl/helpers_spec.rb
 - spec/kowl/version_spec.rb

data/lib/kowl/templates/config/initializers/administrate.rb.tt

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-if defined?(Administrate)
-  Rails.application.configure do
-    config.to_prepare do
-      Administrate::ApplicationController.helper <%= app_name.titleize %>::Application.helpers
-    end
-  end
-end