launch_base 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f884d46fd72417fcda19ba1790afbf3cbe0ea79e61f402fcc279ad086e9b4d0
-  data.tar.gz: a464b1631d7e8e0b79464d17613d90981378820a347d249ff4db912213d2408b
+  metadata.gz: 70ef923d0623037c82adc26d13c28dc7f9bb4f3ce35061f0f803a3ac3d1aa253
+  data.tar.gz: 7e121c6715817126a207a737d351010889dbf82768837566715e4a69a7a1703f
 SHA512:
-  metadata.gz: 8b8e81ce0905a2e9ac5b5808b4c964855743a1c45631587da73ef2b02b756e737644544ddbff1c0a90a52670d88f584af6bb253b3728ac3f44156ee44d4e1743
-  data.tar.gz: d09a32627efba676541340c9beed8184162c2ab6fba83b97de4b34af2b10b8ac3a732daba645c6de34be5a610e5518763f22ae6e4a7b980f36fb50a27ee5822a
+  metadata.gz: da567056d8ef15e33b0719728246a1dd2c94961c694aab66679d17d9768b05da3bfa361e6b2cd2f127119d1401998af05d10e012ccb44d5ab9940a196518ed39
+  data.tar.gz: 2e028aba182253fe5ef863ec526f4aa067892a5433fa195f3f53ecdbe343e6a51372cc867e0f3e5f42868ab2a08d74eb56b2ce953d0e16187b87fd6e9f148cad

data/README.md

@@ -29,8 +29,10 @@ Or install it yourself as:
 ## Usage
 
 ```
+launch_base add sidekiq         # Add Sidekiq gem and configuration to your app
 launch_base help [COMMAND]      # Describe available commands or one specific command
 launch_base new                 # Create a new LaunchBase project (Rails 5.1 or higher is required)
+launch_base new --with-sidekiq  # Create a new LaunchBase project including Sidekiq support
 launch_base update              # update LaunchBase
 launch_base lint install        # install lint configuration files
 launch_base lint update         # update gem and reinstall lint configuration files
@@ -88,8 +90,8 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 To release a new version, update the version number in `version.rb`,
-and then run `bundle exec rake release`, which will create a git tag for the version,
-push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+and then run `bundle exec gem tag --push`, which will create and ush a git tag for the version. 
+Travis CI will automatically build and publish the gem.
 
 ## Contributing
 

data/bin/launch_base

@@ -6,4 +6,4 @@ $LOAD_PATH << source_path
 
 require 'launch_base'
 
-LaunchBase::CLI.start
+LaunchBase::CLI::Base.start

data/launch_base.gemspec

@@ -40,6 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'redcarpet', '~> 3.4'
 
   spec.add_dependency 'thor', '~> 0.20'
+  spec.add_dependency 'redcarpet', '~> 3.4'
 
   spec.add_development_dependency 'gem-release', '~> 1.0'
 end

data/lib/launch_base.rb

@@ -1,2 +1,2 @@
-require 'launch_base/cli'
+require 'launch_base/cli/base'
 require 'launch_base/version'

data/lib/launch_base/cli/add.rb

@@ -0,0 +1,17 @@
+require 'launch_base/plugin'
+require 'launch_base/plugins/all'
+
+module LaunchBase
+  module CLI
+    class Add < Thor
+      Plugin.each_plugin do |plugin_name, plugin|
+        desc plugin_name, "Adds #{plugin.description} to the Rails app"
+        long_desc "#{@package_name} add #{plugin_name} adds #{plugin.description} to the Rails app"
+
+        define_method(plugin_name) do
+          plugin.new.install
+        end
+      end
+    end
+  end
+end

data/lib/launch_base/cli/all.rb

@@ -0,0 +1,2 @@
+require_relative 'add'
+require_relative 'lint'

data/lib/launch_base/cli/base.rb

@@ -0,0 +1,72 @@
+require 'thor'
+require 'launch_base/cli/all'
+require 'launch_base/utilities'
+require 'launch_base/plugin'
+require 'launch_base/plugins/all'
+
+module LaunchBase
+  module CLI
+    class Base < Thor
+      include Thor::Actions
+
+      package_name 'launch_base'
+      register(CLI::Lint, 'lint', 'lint', 'Lint commands')
+      register(CLI::Add, 'add', 'add', 'Add additional modules')
+
+      desc 'update', "update #{LaunchBase}"
+
+      long_desc <<-LONGDESC
+        `#{@package_name} update` triggers Bundler to update the #{LaunchBase} gem
+      LONGDESC
+
+      def update
+        run 'bundle update launch_base --conservative'
+      end
+
+      desc 'new', "Create a new #{LaunchBase} project"
+
+      long_desc <<-LONGDESC
+        `#{@package_name} new [project-path]` creates a new rails project with Kabisa preferences.
+      LONGDESC
+
+      Plugin.each_plugin do |_plugin_name, plugin|
+        option plugin.command_line_flag, type: :boolean, default: false
+      end
+
+      def new(project_path)
+        installed_rails_version = Utilities.get_rails_version
+
+        if installed_rails_version
+          if Utilities.rails_up_to_date?(installed_rails_version)
+            run "rails new #{project_path} -m #{Utilities.gem_home}/templates/launch_base_default_template.rb"
+            Base.install_modules(project_path, options)
+          else
+            say "Your current installation of Rails is outdated (#{installed_rails_version}). "\
+                "Please upgrade to Rails #{RAILS_VERSION}"
+          end
+        else
+          say "No installation of Rails found. Please install Rails #{RAILS_VERSION}"
+        end
+      end
+
+      def help
+        show_banner
+        super
+      end
+
+      def self.install_modules(project_path, options)
+        Plugin.each_plugin do |_plugin_name, plugin|
+          if options[plugin.command_line_flag]
+            plugin.install(destination_root: project_path)
+          end
+        end
+      end
+
+      private
+
+      def show_banner
+        say "\u{1f680} Kabisa #{LaunchBase}\n\n"
+      end
+    end
+  end
+end

data/lib/launch_base/cli/lint.rb

@@ -0,0 +1,30 @@
+require 'thor'
+
+module LaunchBase
+  module CLI
+    class Lint < Thor
+      include Thor::Actions
+
+      desc 'install', 'install lint configuration files'
+      long_desc <<-LONGDESC
+        `#{@package_name} lint install` installs the lint configuration files into the current directory
+      LONGDESC
+      def install
+        ['.codeclimate.yml', '.eslintrc.json', '.mdlrc', '.rubocop.yml', 'config.reek'].each do |config_file_name|
+          create_file(config_file_name) do
+            Utilities.gem_home.join('templates', config_file_name).read
+          end
+        end
+      end
+
+      desc 'update', 'update gem and reinstall lint configuration files'
+      long_desc <<-LONGDESC
+        `#{@package_name} lint update` updates the gem and reinstalls the lint configuration files
+      LONGDESC
+      def update
+        invoke Base, 'update'
+        invoke :install
+      end
+    end
+  end
+end

data/lib/launch_base/plugin.rb

@@ -0,0 +1,70 @@
+require 'fileutils'
+
+module LaunchBase
+  class Plugin < Thor
+    include Thor::Actions
+
+    def self.method_added(method_sym)
+      super unless method_sym == :install
+    end
+
+    def touch(file_path)
+      full_path = File.join(destination_root, file_path)
+      FileUtils.touch(full_path)
+    end
+
+    def run_install
+      say "Install #{class_name} module"
+      install
+      say "Successfully installed #{class_name} module"
+    end
+
+    def self.install(destination_root:)
+      new([], {}, destination_root: destination_root).run_install
+    end
+
+    def self.description
+      to_s
+    end
+
+    def self.inherited(child_class)
+      plugin_name = child_class.plugin_name
+      register(plugin_name, child_class)
+    end
+
+    def self.register(name, plugin)
+      @plugins ||= {}
+      @plugins[name] = plugin
+    end
+
+    def self.each_plugin(&block)
+      @plugins.each(&block)
+    end
+
+    def self.plugin_name
+      to_snake_case(class_name)
+    end
+
+    def self.command_line_flag
+      "with-#{plugin_name.tr('_', '-')}"
+    end
+
+    def class_name
+      self.class.class_name
+    end
+
+    def self.class_name
+      name
+        .split('::')
+        .last
+    end
+
+    def self.to_snake_case(str)
+      str
+        .gsub(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr('-', '_')
+        .downcase
+    end
+  end
+end

data/lib/launch_base/plugins/all.rb

@@ -0,0 +1,3 @@
+Dir["#{__dir__}/**/*.rb"].each do |file|
+  require(file)
+end

data/lib/launch_base/plugins/sidekiq.rb

@@ -0,0 +1,15 @@
+require 'launch_base/plugin'
+
+module LaunchBase
+  module Plugins
+    class Sidekiq < Plugin
+      def install
+        append_to_file 'Gemfile', "gem 'sidekiq', '~> 5.1'"
+        touch 'Procfile'
+        append_to_file 'Procfile', 'bundle exec sidekiq'
+        empty_directory 'app/workers'
+        run 'bundle install'
+      end
+    end
+  end
+end

data/lib/launch_base/utilities.rb

@@ -10,5 +10,9 @@ module LaunchBase
 
       match_data[1] if match_data
     end
+
+    def self.gem_home
+      Pathname.new(__dir__).join('..', '..')
+    end
   end
 end

data/lib/launch_base/version.rb

@@ -1,5 +1,5 @@
 module LaunchBase
-  VERSION = '0.1.0'.freeze
+  VERSION = '1.0.0'.freeze
   RAILS_VERSION = '~> 5.2.0'.freeze
   RUBY_VERSION = '2.5.1'.freeze
 end

data/templates/.rubocop.yml

@@ -82,6 +82,10 @@ Style/MethodCalledOnDoEndBlock:
 Style/Next:
   Enabled: false
 
+# Do not enforce the use of modifiers over conditionals when they would fit on one line
+Style/IfUnlessModifier:
+  Enabled: false
+
 # Complex inline ifs need ()
 Style/TernaryParentheses:
   EnforcedStyle: require_parentheses_when_complex

data/templates/README.md.erb

@@ -64,3 +64,11 @@ codeclimate analyze
 More info about CodeClimate: [codeclimate.com](https://codeclimate.com)
 
 More info about the CodeClimate CLI: [github.com/codeclimate/codeclimate](https://github.com/codeclimate/codeclimate)
+
+## Before deployment/go live
+
+- verify mail can be sent
+- verify monitoring is in place
+- do a stress/load test
+- ensure continuous deployment works
+- ensure enough disk space/correct S3 configuration

data/templates/launch_base_default_template.rb

@@ -32,6 +32,7 @@ gem_group :development do
   gem 'web-console', '>= 3.3.0'
   gem 'spring'
   gem 'listen'
+  gem 'rubocop'
 end
 
 gem_group :test do

data/templates/spec/support/reraise_javascript_errors.rb

@@ -0,0 +1,10 @@
+RSpec.configure do |config|
+  config.after :each, js: true do
+    errors = page.driver.browser.manage.logs.get(:browser).select { |log| log.level == 'SEVERE' }
+
+    if errors.any?
+      report = errors.map { |error| error.message.gsub('\\n', '\n') }.join("\n\n")
+      raise "There were #{errors.count} JavaScript errors:\n\n#{report}"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: launch_base
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Martijn Versluis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-08 00:00:00.000000000 Z
+date: 2018-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -151,6 +151,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: gem-release
   requirement: !ruby/object:Gem::Requirement
@@ -181,8 +195,13 @@ files:
 - bin/launch_base
 - launch_base.gemspec
 - lib/launch_base.rb
-- lib/launch_base/cli.rb
-- lib/launch_base/lint_cli.rb
+- lib/launch_base/cli/add.rb
+- lib/launch_base/cli/all.rb
+- lib/launch_base/cli/base.rb
+- lib/launch_base/cli/lint.rb
+- lib/launch_base/plugin.rb
+- lib/launch_base/plugins/all.rb
+- lib/launch_base/plugins/sidekiq.rb
 - lib/launch_base/utilities.rb
 - lib/launch_base/version.rb
 - templates/.codeclimate.yml
@@ -208,6 +227,7 @@ files:
 - templates/spec/support/capybara.rb
 - templates/spec/support/factory_bot.rb
 - templates/spec/support/feature_spec_helpers.rb
+- templates/spec/support/reraise_javascript_errors.rb
 - templates/spec/support/spec_helpers.rb
 homepage: https://github.com/kabisa/launch-base
 licenses:
@@ -230,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: A Rails template with Kabisa defaults

data/lib/launch_base/cli.rb

@@ -1,54 +0,0 @@
-require 'thor'
-require 'launch_base/lint_cli'
-require 'launch_base/utilities'
-
-module LaunchBase
-  class CLI < Thor
-    include Thor::Actions
-
-    package_name 'launch_base'
-    register(LintCLI, 'lint', 'lint', 'Lint commands')
-
-    desc 'update', "update #{LaunchBase}"
-    long_desc <<-LONGDESC
-      `#{@package_name} update` triggers Bundler to update the #{LaunchBase} gem
-    LONGDESC
-    def update
-      run 'bundle update launch_base --conservative'
-    end
-
-    desc 'new', "Create a new #{LaunchBase} project"
-    long_desc <<-LONGDESC
-      `#{@package_name} new [project-path]` creates a new rails project with Kabisa preferences.
-    LONGDESC
-    def new(project_path)
-      installed_rails_version = Utilities.get_rails_version
-
-      if installed_rails_version
-        if Utilities.rails_up_to_date?(installed_rails_version)
-          run "rails new #{project_path} -m #{gem_home}/templates/launch_base_default_template.rb"
-        else
-          say "Your current installation of Rails is outdated (#{installed_rails_version}). "\
-              "Please upgrade to Rails #{RAILS_VERSION}"
-        end
-      else
-        say "No installation of Rails found. Please install Rails #{RAILS_VERSION}"
-      end
-    end
-
-    def help
-      show_banner
-      super
-    end
-
-    private
-
-    def show_banner
-      say "\u{1f680} Kabisa #{LaunchBase}\n\n"
-    end
-
-    def gem_home
-      Pathname.new(__dir__).join('..', '..')
-    end
-  end
-end

data/lib/launch_base/lint_cli.rb

@@ -1,34 +0,0 @@
-require 'thor'
-
-module LaunchBase
-  class LintCLI < Thor
-    include Thor::Actions
-
-    desc 'install', 'install lint configuration files'
-    long_desc <<-LONGDESC
-      `#{@package_name} lint install` installs the lint configuration files into the current directory
-    LONGDESC
-    def install
-      ['.codeclimate.yml', '.eslintrc.json', '.mdlrc', '.rubocop.yml', 'config.reek'].each do |config_file_name|
-        create_file(config_file_name) do
-          gem_home.join('templates', config_file_name).read
-        end
-      end
-    end
-
-    desc 'update', 'update gem and reinstall lint configuration files'
-    long_desc <<-LONGDESC
-      `#{@package_name} lint update` updates the gem and reinstalls the lint configuration files
-    LONGDESC
-    def update
-      invoke CLI, 'update'
-      invoke :install
-    end
-
-    private
-
-    def gem_home
-      Pathname.new(__dir__).join('..', '..')
-    end
-  end
-end