launch_base 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f884d46fd72417fcda19ba1790afbf3cbe0ea79e61f402fcc279ad086e9b4d0
+  data.tar.gz: a464b1631d7e8e0b79464d17613d90981378820a347d249ff4db912213d2408b
+SHA512:
+  metadata.gz: 8b8e81ce0905a2e9ac5b5808b4c964855743a1c45631587da73ef2b02b756e737644544ddbff1c0a90a52670d88f584af6bb253b3728ac3f44156ee44d4e1743
+  data.tar.gz: d09a32627efba676541340c9beed8184162c2ab6fba83b97de4b34af2b10b8ac3a732daba645c6de34be5a610e5518763f22ae6e4a7b980f36fb50a27ee5822a

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    launch_base (0.1.0)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    codeclimate-engine-rb (0.4.1)
+      virtus (~> 1.0)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    docile (1.3.0)
+    equalizer (0.0.11)
+    fuubar (2.3.1)
+      rspec-core (~> 3.0)
+      ruby-progressbar (~> 1.4)
+    gem-release (1.0.0)
+    ice_nine (0.11.2)
+    json (2.1.0)
+    method_source (0.9.0)
+    parallel (1.12.1)
+    parser (2.5.1.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.1)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    redcarpet (3.4.0)
+    reek (4.8.1)
+      codeclimate-engine-rb (~> 0.4.0)
+      parser (>= 2.5.0.0, < 2.6)
+      rainbow (>= 2.0, < 4.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.55.0)
+      parallel (~> 1.10)
+      parser (>= 2.5)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    unicode-display_width (1.3.2)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fuubar (~> 2.3)
+  gem-release (~> 1.0)
+  launch_base!
+  pry (~> 0.11)
+  rake (~> 10.0)
+  redcarpet (~> 3.4)
+  reek (~> 4.8)
+  rspec (~> 3.0)
+  rubocop (~> 0.55)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Martijn Versluis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# Kabisa LaunchBase :rocket:
+
+[![Build Status](https://travis-ci.org/kabisa/launch-base.svg?branch=master)](https://travis-ci.org/kabisa/launch-base)
+[![Maintainability](https://api.codeclimate.com/v1/badges/f563fdb89d5509e4e8f3/maintainability)](https://codeclimate.com/github/kabisa/launch-base/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/f563fdb89d5509e4e8f3/test_coverage)](https://codeclimate.com/github/kabisa/launch-base/test_coverage)
+
+## Installation
+
+### In an existing Rails application
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'launch_base'
+```
+
+And then execute:
+
+    bundle
+
+Or install it yourself as:
+
+    gem install launch_base
+
+### Globally, to generate a new application:
+
+    sudo gem install launch_base
+
+## Usage
+
+```
+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 update              # update LaunchBase
+launch_base lint install        # install lint configuration files
+launch_base lint update         # update gem and reinstall lint configuration files
+```
+
+## Requirements
+
+### Database transactions
+
+An app generated by Launch Base assumes database transactions work within Capybara tests, which requires Rails 5.1 or
+higher. Alternatively, you should add `DatabaseCleaner`:
+
+1. Add `DatabaseCleaner` to your gem within the `test` group (be sure to also run `bundle install`):
+
+```ruby
+group :test do
+  gem 'database_cleaner'
+end
+```
+
+2. Add a `spec/support/database_cleaner.rb` file:
+
+```ruby
+require 'database_cleaner'
+
+RSpec.configure do |config|
+  config.before :suite do
+    DatabaseCleaner.clean_with :truncation
+  end
+
+  config.around :each do |example|
+    DatabaseCleaner.strategy = if example.metadata[:type].in? [:feature, :request]
+                                 :truncation
+                               else
+                                 :transaction
+                               end
+
+    DatabaseCleaner.start
+    example.run
+    DatabaseCleaner.clean
+  end
+end
+```
+
+## Contents
+
+For info about the contents of an app generated by LaunchBase, please refer to the
+[`README.md` template](templates/README.md.erb)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake test` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [Launch Base](https://github.com/kabisa/launch-base).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/launch_base

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+source_path = (Pathname.new(__FILE__).dirname + '../lib').expand_path
+$LOAD_PATH << source_path
+
+require 'launch_base'
+
+LaunchBase::CLI.start

data/launch_base.gemspec

@@ -0,0 +1,45 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'launch_base/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'launch_base'
+  spec.version       = LaunchBase::VERSION
+  spec.authors       = ['Martijn Versluis', 'Tjaco Oostdijk']
+  spec.email         = ['martijn@kabisa.nl', 'tjaco@kabisa.nl']
+
+  spec.summary       = 'A Rails template with Kabisa defaults'
+  spec.homepage      = 'https://github.com/kabisa/launch-base'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    is_blacklisted_file = f.match(%r{^(\.|test/|spec/|bin/ci$|bin/setup$|package.json$|Rakefile$|yarn.lock$)})
+    is_symlink = File.symlink?(f)
+    is_blacklisted_file || is_symlink
+  end
+
+  spec.bindir = 'bin'
+  spec.executables   = ['launch_base']
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'fuubar', '~> 2.3'
+  spec.add_development_dependency 'rubocop', '~> 0.55'
+  spec.add_development_dependency 'reek', '~> 4.8'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'redcarpet', '~> 3.4'
+
+  spec.add_dependency 'thor', '~> 0.20'
+
+  spec.add_development_dependency 'gem-release', '~> 1.0'
+end

data/lib/launch_base.rb

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

data/lib/launch_base/cli.rb

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

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

data/lib/launch_base/utilities.rb

@@ -0,0 +1,14 @@
+module LaunchBase
+  module Utilities
+    def self.rails_up_to_date?(installed_rails_version)
+      Gem::Dependency.new('rails', RAILS_VERSION) =~ Gem::Dependency.new('rails', installed_rails_version)
+    end
+
+    def self.get_rails_version
+      output = `rails -v 2>&1`
+      match_data = /Rails ([0-9.]+)/.match(output)
+
+      match_data[1] if match_data
+    end
+  end
+end

data/lib/launch_base/version.rb

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

data/templates/.codeclimate.yml

@@ -0,0 +1,73 @@
+# For info about .codeclimate.yml structure see:
+# https://docs.codeclimate.com/docs/advanced-configuration
+
+version: "2"         # required to adjust maintainability checks
+
+# See: https://docs.codeclimate.com/docs/maintainability#section-checks
+checks:
+  argument-count:
+    config:
+      threshold: 4
+  complex-logic:
+    config:
+      threshold: 4
+  file-lines:
+    config:
+      threshold: 250
+  method-complexity:
+    config:
+      threshold: 5
+  method-count:
+    config:
+      threshold: 20
+  method-lines:
+    config:
+      threshold: 25
+  nested-control-flow:
+    config:
+      threshold: 4
+  return-statements:
+    config:
+      threshold: 4
+  similar-code:
+    config:
+      threshold: # language-specific defaults. an override will affect all languages.
+  identical-code:
+    config:
+      threshold: # language-specific defaults. an override will affect all languages.
+
+# See: https://docs.codeclimate.com/docs/advanced-configuration#section-plugins
+# and https://docs.codeclimate.com/docs/list-of-engines
+plugins:
+  brakeman:
+    enabled: true
+  bundler-audit:
+    enabled: true
+  csslint:
+    enabled: true
+  duplication:
+    enabled: true
+  eslint:
+    enabled: true
+    config:
+      config: .eslintrc.json
+      extensions:
+      - .es6
+      - .js
+      - .jsx
+  fixme:
+    enabled: true
+  markdownlint:
+    enabled: true
+  nodesecurity:
+    enabled: true
+  rubocop:
+    enabled: true
+  reek:
+    enabled: true
+    config:
+      config: config.reek
+  scss-lint:
+    enabled: true
+  shellcheck:
+    enabled: true