raygun 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e084b27460032eefecb4daac7fda0290bdd7a81146031e6e449e64e6f21ff2c
-  data.tar.gz: 3642729949a140b21817ee8a9f406458d83d00c4a3130da38c1503f0dd9e1c04
+  metadata.gz: c7ca3630bd95d0e0c12a7bf9d9f6b5cc0255ba5dfced51c83017a164f84ff147
+  data.tar.gz: 06ba32e033ec46d2ebe15f4e03c781b91ba94ac912075e9c1fff6872b68a5489
 SHA512:
-  metadata.gz: cc05b65d10b93a5ee1e8d2883764e0cad8e26e0d4ee3ee5e55e1429d74cf4dcfacbde2c918c5827edfdf08203947aa8e62e4b1f3d1b33dc3fe8eb95e27bc6e0c
-  data.tar.gz: 81fadf36b23b75a787ab94d8296189e539a186e9afd939d4610e98f292889a5ace35821b00581cd8b3e53ea866ecb35f7aa00e0c258709b491679ba2177cec2a
+  metadata.gz: 24416fbf00a23e6cb6b9afaf3c9ac3184bf1e99127c97a0f3db58d09364625e3f4ca5145e5801a039e4f878fa7b5e5952235866a792bfb462ec3b19c145a98ec
+  data.tar.gz: 496bcae1bc8c9bdaa1ed4975c9794c916a2187dfe76d1fb2df7fde190431f05c8a25cad2ed7b226898afc3d8a7249c02ee0ecdf6d2046e0633f806b74ba3e8b4

data/.rubocop.yml

@@ -0,0 +1,99 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+#
+# Ruby Cops
+#
+
+Layout/CaseIndentation:
+  Enabled: false
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HashAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 120
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+
+Lint/ScriptPermission:
+  Exclude:
+    - "Rakefile"
+
+Metrics/AbcSize:
+  Max: 35
+  Exclude:
+    - "spec/**/*"
+
+Metrics/BlockLength:
+  CountComments: false
+  Max: 50
+  Exclude:
+    - "config/**/*"
+    - "spec/**/*"
+
+Metrics/ClassLength:
+  Max: 250
+  Exclude:
+    - "spec/**/*"
+
+Metrics/MethodLength:
+  Max: 25
+  Exclude:
+    - "db/migrate/*"
+    - "spec/**/*"
+
+Naming/PredicateName:
+  Enabled: false
+
+Security/YAMLLoad:
+  Enabled: false
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/PreferredHashMethods:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/StructInheritance:
+  Enabled: true
+

data/.ruby-version

@@ -1 +1 @@
-2.4.2
+2.6.5

data/CHANGES.md

@@ -3,6 +3,26 @@
 **Note:** Don't let the apparent lack of activity here scare you away. Almost all changes are captured in the
 prototype repo (see [raygun-rails](https://github.com/carbonfive/raygun-rails)), and it's kept pretty well up to date.
 
+## 1.1.0 [2020-07-02]
+
+Breaking:
+
+* Require Ruby 2.4+ (#151)
+
+New features:
+
+* Copy `.rubocop.yml` template instead of using a fragile link to the c5-conventions repo (#148)
+* Initialize zapped projects with a default branch of "main" (#157)
+
+Docs:
+
+* Add Bootstrap instructions to the README (it has been removed from the app prototype) (#141)
+
+Housekeeping:
+
+* Add bundler and rake development dependencies (#143)
+* Upgrade to Ruby 2.6.5 (#142)
+
 ## 1.0.4 [2017-11-28]
 
 * Tweak instructions: use `heroku local` instead of `foreman s` (#138, thanks @mattbrictson)

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in raygun.gemspec
 gemspec

data/README.md

@@ -1,5 +1,5 @@
-[![Gem Version](https://badge.fury.io/rb/raygun.png)](http://badge.fury.io/rb/raygun)
-<img src="https://raw.github.com/carbonfive/raygun/master/marvin.jpg" align="right"/>
+[![Gem Version](https://badge.fury.io/rb/raygun.svg)](http://badge.fury.io/rb/raygun)
+<img src="https://raw.github.com/carbonfive/raygun/main/marvin.jpg" align="right"/>
 
 # Raygun
 
@@ -18,7 +18,6 @@ Major tools/libraries:
 * PostgreSQL
 * Slim
 * Sass
-* Bootstrap
 * RSpec and Capybara
 * Factory Bot
 * SimpleCov
@@ -27,8 +26,7 @@ Major tools/libraries:
 the details).
 
 Raygun includes generator templates for controllers, views, and specs so that generated code follows best
-practices. For example, view generation produces bootstrap compatible markup and rspec specs use factory
-girl when appropriate.
+practices. For example, rspec specs use factory bot when appropriate.
 
 Inspired by Xavier Shay work at Square and ThoughtBot's Suspenders. Thanks!
 
@@ -59,20 +57,54 @@ another ruby, just change the `Gemfile` and `.ruby-version` as necessary.
 
 ## Usage
 
-    $ raygun your-project
+```bash
+$ raygun your-project
+```
 
 Once your project is baked out, you can easily kick the wheels. Be sure that you have the prerequisites
 covered (see above).
 
-    $ cd your-project
-    $ bin/setup
+```bash
+$ cd your-project
+$ bin/setup
+
+# Run the specs, they should all pass
+$ bin/rake
+
+# Fire up the app and open it in a browser
+$ heroku local
+$ open http://localhost:3000
+```
+
+## Next Steps
+
+As you'll notice, the project comes with enough CSS (SCSS, actually) to establish some patterns.  If you
+need more of a framework, here are instructions on how to add Bootstrap to your new project.
+
+```bash
+$ yarn add bootstrap
+$ rails generate simple_form:install --bootstrap
+
+# Answer Yes to the question about overwriting your existing `config/initializers/simple_form.rb`
+```
+
+This generates an initializer and scaffold files for Rails view scaffolding.
+
+Add Bootstrap imports to the top your `application.scss`
 
-    # Run the specs, they should all pass
-    $ bin/rake
+```css
+// application.scss
+@import "~bootstrap/scss/_functions";
+@import "~bootstrap/scss/_variables";
+
+...
+```
+
+Now you've got Bootstrap in the application.
+
+We include `simple_form` in the project by default.  For more information about using Bootstrap styling
+on `simple_form` forms, check out the documentation here http://simple-form-bootstrap.plataformatec.com.br/documentation
 
-    # Fire up the app and open it in a browser
-    $ heroku local
-    $ open http://localhost:3000
 
 ## Using a Custom Project Template
 
@@ -116,10 +148,18 @@ prototype (which is a valid rails app) and tag them when they should be used for
 
 ### Development
 
-Generate an example app using your local development version of Raygun:
+To set up your local environment, run:
+
+    $ bin/setup
+
+To run tests and rubocop checks:
+
+    $ bundle exec rake
+
+To generate an example app using your local development version of Raygun:
 
-    $ ./bin/raygun tmp/example_app
+    $ bin/raygun tmp/example_app
 
 ## Changes
 
-[View the Change Log](https://github.com/carbonfive/raygun/tree/master/CHANGES.md)
+[View the Change Log](https://github.com/carbonfive/raygun/tree/main/CHANGES.md)

data/Rakefile

@@ -1 +1,9 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/bin/raygun

@@ -1,10 +1,10 @@
 #!/usr/bin/env ruby
 
-File.expand_path('../../lib', __FILE__).tap do |lib|
+File.expand_path("../lib", __dir__).tap do |lib|
   $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 end
 
-require 'raygun/raygun'
+require "raygun/raygun"
 
 raygun = Raygun::Runner.parse(ARGV)
 

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/colorize.rb

@@ -5,41 +5,40 @@
 # want to add a gem dependency.
 
 class String
-
   #
   # Colors Hash
   #
   COLORS = {
-    :black          => 0,
-    :red            => 1,
-    :green          => 2,
-    :yellow         => 3,
-    :blue           => 4,
-    :magenta        => 5,
-    :cyan           => 6,
-    :white          => 7,
-    :default        => 9,
-
-    :light_black    => 10,
-    :light_red      => 11,
-    :light_green    => 12,
-    :light_yellow   => 13,
-    :light_blue     => 14,
-    :light_magenta  => 15,
-    :light_cyan     => 16,
-    :light_white    => 17
+    black: 0,
+    red: 1,
+    green: 2,
+    yellow: 3,
+    blue: 4,
+    magenta: 5,
+    cyan: 6,
+    white: 7,
+    default: 9,
+
+    light_black: 10,
+    light_red: 11,
+    light_green: 12,
+    light_yellow: 13,
+    light_blue: 14,
+    light_magenta: 15,
+    light_cyan: 16,
+    light_white: 17
   }
 
   #
   # Modes Hash
   #
   MODES = {
-    :default        => 0, # Turn off all attributes
+    default: 0, # Turn off all attributes
     #:bright        => 1, # Set bright mode
-    :underline      => 4, # Set underline mode
-    :blink          => 5, # Set blink mode
-    :swap           => 7, # Exchange foreground and background colors
-    :hide           => 8  # Hide text (foreground color would be the same as background)
+    underline: 4, # Set underline mode
+    blink: 5, # Set blink mode
+    swap: 7, # Exchange foreground and background colors
+    hide: 8  # Hide text (foreground color would be the same as background)
   }
 
   protected
@@ -47,16 +46,14 @@ class String
   #
   # Set color values in new string intance
   #
-  def set_color_parameters( params )
-    if (params.instance_of?(Hash))
-      @color = params[:color]
-      @background = params[:background]
-      @mode = params[:mode]
-      @uncolorized = params[:uncolorized]
-      self
-    else
-      nil
-    end
+  def color_parameters(params)
+    return unless params.instance_of?(Hash)
+
+    @color = params[:color]
+    @background = params[:background]
+    @mode = params[:mode]
+    @uncolorized = params[:uncolorized]
+    self
   end
 
   public
@@ -77,22 +74,23 @@ class String
   #   puts "This is blue text on red".blue.on_red.blink
   #   puts "This is uncolorized".blue.on_red.uncolorize
   #
-  def colorize( params )
+  # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  def colorize(params)
     return self unless STDOUT.isatty
 
     begin
-      require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /win32/
+      require "Win32/Console/ANSI" if RUBY_PLATFORM.match?(/win32/)
     rescue LoadError
-      raise 'You must gem install win32console to use colorize on Windows'
+      raise "You must gem install win32console to use colorize on Windows"
     end
 
     color_parameters = {}
 
-    if (params.instance_of?(Hash))
+    if params.instance_of?(Hash)
       color_parameters[:color] = COLORS[params[:color]]
       color_parameters[:background] = COLORS[params[:background]]
       color_parameters[:mode] = MODES[params[:mode]]
-    elsif (params.instance_of?(Symbol))
+    elsif params.instance_of?(Symbol)
       color_parameters[:color] = COLORS[params]
     end
 
@@ -100,15 +98,18 @@ class String
     color_parameters[:background] ||= @background ||= COLORS[:default]
     color_parameters[:mode] ||= @mode ||= MODES[:default]
 
-    color_parameters[:uncolorized] ||= @uncolorized ||= self.dup
+    color_parameters[:uncolorized] ||= @uncolorized ||= dup
 
     # calculate bright mode
     color_parameters[:color] += 50 if color_parameters[:color] > 10
 
     color_parameters[:background] += 50 if color_parameters[:background] > 10
 
-    "\033[#{color_parameters[:mode]};#{color_parameters[:color]+30};#{color_parameters[:background]+40}m#{color_parameters[:uncolorized]}\033[0m".set_color_parameters( color_parameters )
+    "\033[#{color_parameters[:mode]};#{color_parameters[:color] + 30};"\
+    "#{color_parameters[:background] + 40}m#{color_parameters[:uncolorized]}\033[0m"\
+      .color_parameters(color_parameters)
   end
+  # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
   #
   # Return uncolorized string
@@ -127,37 +128,36 @@ class String
   #
   # Make some color and on_color methods
   #
-  COLORS.each_key do | key |
+  COLORS.each_key do |key|
     next if key == :default
 
     define_method key do
-      self.colorize( :color => key )
+      colorize(color: key)
     end
 
     define_method "on_#{key}" do
-      self.colorize( :background => key )
+      colorize(background: key)
     end
   end
 
   #
   # Methods for modes
   #
-  MODES.each_key do | key |
+  MODES.each_key do |key|
     next if key == :default
 
     define_method key do
-      self.colorize( :mode => key )
+      colorize(mode: key)
     end
   end
 
   class << self
-
     #
     # Return array of available modes used by colorize method
     #
     def modes
       keys = []
-      MODES.each_key do | key |
+      MODES.each_key do |key|
         keys << key
       end
       keys
@@ -168,7 +168,7 @@ class String
     #
     def colors
       keys = []
-      COLORS.each_key do | key |
+      COLORS.each_key do |key|
         keys << key
       end
       keys
@@ -177,16 +177,16 @@ class String
     #
     # Display color matrix with color names.
     #
-    def color_matrix( txt = "[X]" )
+    def color_matrix(txt = "[X]")
       size = String.colors.length
-      String.colors.each do | color |
-        String.colors.each do | back |
-          print txt.colorize( :color => color, :background => back )
+      String.colors.each do |color|
+        String.colors.each do |back|
+          print txt.colorize(color: color, background: back)
         end
         puts " < #{color}"
       end
-      String.colors.reverse.each_with_index do | back, index |
-        puts "#{"|".rjust(txt.length)*(size-index)} < #{back}"
+      String.colors.reverse.each_with_index do |back, index|
+        puts "#{"|".rjust(txt.length) * (size - index)} < #{back}"
       end
       ""
     end

data/lib/raygun/raygun.rb

@@ -1,44 +1,47 @@
-require 'optparse'
-require 'ostruct'
-require 'fileutils'
-require 'securerandom'
-require 'net/http'
-require 'json'
-require 'colorize'
-
-require_relative 'version'
-require_relative 'template_repo'
+require "optparse"
+require "ostruct"
+require "fileutils"
+require "securerandom"
+require "net/http"
+require "open-uri"
+require "json"
+require "colorize"
+
+require_relative "version"
+require_relative "template_repo"
 
 module Raygun
   class Runner
-    CARBONFIVE_REPO = 'carbonfive/raygun-rails'
+    CARBONFIVE_REPO = "carbonfive/raygun-rails"
+    C5_CONVENTIONS_REPO = "carbonfive/c5-conventions"
 
-    attr_accessor :target_dir, :app_dir, :app_name, :dash_name, :snake_name, :camel_name, :title_name, :prototype_repo,
+    attr_accessor :target_dir, :app_dir, :app_name, :dash_name, :snake_name,
+                  :camel_name, :title_name, :prototype_repo,
                   :current_ruby_version, :current_ruby_patch_level
 
     def initialize(target_dir, prototype_repo)
       @target_dir     = target_dir
       @app_dir        = File.expand_path(target_dir.strip.to_s)
-      @app_name       = File.basename(app_dir).gsub(/\s+/, '-')
-      @dash_name      = app_name.gsub('_', '-')
-      @snake_name     = app_name.gsub('-', '_')
+      @app_name       = File.basename(app_dir).gsub(/\s+/, "-")
+      @dash_name      = app_name.tr("_", "-")
+      @snake_name     = app_name.tr("-", "_")
       @camel_name     = camelize(snake_name)
       @title_name     = titleize(snake_name)
       @prototype_repo = prototype_repo
 
       @current_ruby_version     = RUBY_VERSION
-      @current_ruby_patch_level = if RUBY_VERSION < '2.1.0' # Ruby adopted semver starting with 2.1.0.
-                                   "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
+      @current_ruby_patch_level = if RUBY_VERSION < "2.1.0" # Ruby adopted semver starting with 2.1.0.
+                                    "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
                                   else
-                                    "#{RUBY_VERSION}"
+                                    RUBY_VERSION.to_s
                                   end
     end
 
     def check_target
-      unless Dir["#{@app_dir}/*"].empty?
-        puts "Misfire! The target directory isn't empty... aim elsewhere."
-        exit 1
-      end
+      return if Dir["#{@app_dir}/*"].empty?
+
+      puts "Misfire! The target directory isn't empty... aim elsewhere.".colorize(:light_red)
+      exit 1
     end
 
     def fetch_prototype
@@ -55,17 +58,17 @@ module Raygun
       $stdout.flush
 
       cached_prototypes_dir = File.join(Dir.home, ".raygun")
-      @prototype = "#{cached_prototypes_dir}/#{name.gsub('/','--')}-#{sha}.tar.gz"
+      @prototype = "#{cached_prototypes_dir}/#{name.gsub("/", "--")}-#{sha}.tar.gz"
 
       # Do we already have the tarball cached under ~/.raygun?
-      if File.exists?(@prototype)
+      if File.exist?(@prototype)
         puts " Using cached version.".colorize(:yellow)
       else
         print " Downloading...".colorize(:yellow)
         $stdout.flush
 
         # Download the tarball and install in the cache.
-        Dir.mkdir(cached_prototypes_dir, 0755) unless Dir.exists?(cached_prototypes_dir)
+        Dir.mkdir(cached_prototypes_dir, 0o755) unless Dir.exist?(cached_prototypes_dir)
         shell "curl -s -L #{tarball_url} -o #{@prototype}"
         puts " done!".colorize(:yellow)
       end
@@ -73,24 +76,23 @@ module Raygun
 
     def check_raygun_version
       required_raygun_version =
-        %x{tar xfz #{@prototype} --include "*.raygun-version" -O 2> /dev/null}.chomp ||
-          ::Raygun::VERSION
-
-      if Gem::Version.new(required_raygun_version) > Gem::Version.new(::Raygun::VERSION)
-        puts  ""
-        print "Hold up!".colorize(:red)
-        print " This version of the raygun gem (".colorize(:light_red)
-        print "#{::Raygun::VERSION})".colorize(:white)
-        print " is too old to generate this application (needs ".colorize(:light_red)
-        print "#{required_raygun_version}".colorize(:white)
-        puts  " or newer).".colorize(:light_red)
-        puts  ""
-        print "Please update the gem by running ".colorize(:light_red)
-        print "gem update raygun".colorize(:white)
-        puts  ", and try again. Thanks!".colorize(:light_red)
-        puts  ""
-        exit 1
-      end
+        `tar xfz #{@prototype} --include "*.raygun-version" -O 2> /dev/null`.chomp ||
+        ::Raygun::VERSION
+      return unless Gem::Version.new(required_raygun_version) > Gem::Version.new(::Raygun::VERSION)
+
+      puts  ""
+      print "Hold up!".colorize(:red)
+      print " This version of the raygun gem (".colorize(:light_red)
+      print "#{::Raygun::VERSION})".colorize(:white)
+      print " is too old to generate this application (needs ".colorize(:light_red)
+      print required_raygun_version.to_s.colorize(:white)
+      puts  " or newer).".colorize(:light_red)
+      puts  ""
+      print "Please update the gem by running ".colorize(:light_red)
+      print "gem update raygun".colorize(:white)
+      puts  ", and try again. Thanks!".colorize(:light_red)
+      puts  ""
+      exit 1
     end
 
     def copy_prototype
@@ -101,25 +103,28 @@ module Raygun
       # Github includes an extra directory layer in the tag tarball.
       extraneous_dir = Dir.glob("#{app_dir}/*").first
       dirs_to_move   = Dir.glob("#{extraneous_dir}/*", File::FNM_DOTMATCH)
-                          .reject { |d| %w{. ..}.include?(File.basename(d)) }
+        .reject { |d| %w[. ..].include?(File.basename(d)) }
 
       FileUtils.mv         dirs_to_move, app_dir
       FileUtils.remove_dir extraneous_dir
+
+      fetch_rubocop_file if @prototype_repo == CARBONFIVE_REPO
     end
 
     def rename_new_app
       Dir.chdir(app_dir) do
         {
-          'AppPrototype'  => camel_name,
-          'app-prototype' => dash_name,
-          'app_prototype' => snake_name,
-          'App Prototype' => title_name
+          "AppPrototype"  => camel_name,
+          "app-prototype" => dash_name,
+          "app_prototype" => snake_name,
+          "App Prototype" => title_name
         }.each do |proto_name, new_name|
           shell "find . -type f -print | xargs #{sed_i} 's/#{proto_name}/#{new_name}/g'"
         end
 
-        %w(d f).each do |find_type|
-          shell "find . -depth -type #{find_type} -name '*app_prototype*' -exec bash -c 'mv $0 ${0/app_prototype/#{snake_name}}' {} \\;"
+        %w[d f].each do |find_type|
+          shell "find . -depth -type #{find_type} -name '*app_prototype*' " \
+                "-exec bash -c 'mv $0 ${0/app_prototype/#{snake_name}}' {} \\;"
         end
       end
     end
@@ -149,26 +154,33 @@ module Raygun
     def initialize_git
       Dir.chdir(app_dir) do
         shell "git init"
+        shell "git checkout -q -b main"
         shell "git add -A ."
         shell "git commit -m 'Raygun-zapped skeleton.'"
       end
     end
 
+    # rubocop:disable Metrics/AbcSize
     def print_plan
-      puts '     ____ '.colorize(:light_yellow)
+      puts "     ____ ".colorize(:light_yellow)
       puts '    / __ \____ ___  ______ ___  ______ '.colorize(:light_yellow)
       puts '   / /_/ / __ `/ / / / __ `/ / / / __ \ '.colorize(:light_yellow)
-      puts '  / _, _/ /_/ / /_/ / /_/ / /_/ / / / / '.colorize(:light_yellow)
+      puts "  / _, _/ /_/ / /_/ / /_/ / /_/ / / / / ".colorize(:light_yellow)
       puts ' /_/ |_|\__,_/\__, /\__, /\__,_/_/ /_/ '.colorize(:light_yellow)
-      puts '             /____//____/ '.colorize(:light_yellow)
+      puts "             /____//____/ ".colorize(:light_yellow)
       puts
-      puts "Raygun will create new app in directory:".colorize(:yellow) + " #{target_dir}".colorize(:yellow) + "...".colorize(:yellow)
+      puts "Raygun will create new app in directory:".colorize(:yellow) +
+           " #{target_dir}".colorize(:yellow) + "...".colorize(:yellow)
       puts
-      puts "-".colorize(:blue) + " Application Name:".colorize(:light_blue) + " #{title_name}".colorize(:light_reen)
-      puts "-".colorize(:blue) + " Project Template:".colorize(:light_blue) + " #{prototype_repo}".colorize(:light_reen)
-      puts "-".colorize(:blue) + " Ruby Version:    ".colorize(:light_blue) + " #{@current_ruby_patch_level}".colorize(:light_reen)
+      puts "-".colorize(:blue) + " Application Name:".colorize(:light_blue) +
+           " #{title_name}".colorize(:light_reen)
+      puts "-".colorize(:blue) + " Project Template:".colorize(:light_blue) +
+           " #{prototype_repo}".colorize(:light_reen)
+      puts "-".colorize(:blue) + " Ruby Version:    ".colorize(:light_blue) +
+           " #{@current_ruby_patch_level}".colorize(:light_reen)
       puts
     end
+    # rubocop:enable Metrics/AbcSize
 
     def print_next_steps
       if @prototype_repo == CARBONFIVE_REPO
@@ -178,6 +190,7 @@ module Raygun
       end
     end
 
+    # rubocop:disable Metrics/AbcSize
     def print_next_steps_carbon_five
       puts ""
       puts "Zap! Your application is ready. Next steps...".colorize(:yellow)
@@ -193,8 +206,12 @@ module Raygun
       puts "$".colorize(:blue) + " heroku local".colorize(:light_blue)
       puts "$".colorize(:blue) + " open http://localhost:3000".colorize(:light_blue)
       puts ""
+      puts "# For some suggested next steps, check out the raygun README".colorize(:light_green)
+      puts "$".colorize(:blue) + " open https://github.com/carbonfive/raygun/#next-steps".colorize(:light_blue)
+      puts ""
       puts "Enjoy your Carbon Five flavored Rails application!".colorize(:yellow)
     end
+    # rubocop:enable Metrics/AbcSize
 
     def print_next_steps_for_custom_repo
       puts ""
@@ -205,66 +222,104 @@ module Raygun
 
     protected
 
+    def fetch_rubocop_file
+      sha = shell("git ls-remote https://github.com/#{C5_CONVENTIONS_REPO} master") || ""
+      sha = sha.slice(0..6)
+
+      rubocop_file = "https://raw.githubusercontent.com/#{C5_CONVENTIONS_REPO}/master/rubocop/rubocop.yml"
+      begin
+        rubocop_contents = URI.open(rubocop_file)
+        IO.write("#{@app_dir}/.rubocop.yml", <<~RUBOCOP_YML)
+          # Sourced from #{C5_CONVENTIONS_REPO} @ #{sha}
+          #
+          # If you make changes to this file, consider opening
+          # a PR to backport them to the c5-conventions repo:
+          # https://github.com/#{C5_CONVENTIONS_REPO}/blob/master/rubocop/rubocop.yml
+
+          #{rubocop_contents.string}
+        RUBOCOP_YML
+      rescue Errno::ENOENT, OpenURI::HTTPError => e
+        puts ""
+        puts "Failed to find the CarbonFive conventions rubocop file at #{rubocop_file}".colorize(:light_red)
+        puts "Error: #{e}".colorize(:light_red)
+        puts "You'll have to manage you're own `.rubocop.yml` setup".colorize(:light_red)
+      end
+    end
+
     def camelize(string)
       result = string.sub(/^[a-z\d]*/) { $&.capitalize }
-      result.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }
+      result.gsub(%r{(?:_|(/))([a-z\d]*)}) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
     end
 
     def titleize(underscored_string)
-      result = underscored_string.gsub(/_/, ' ')
-      result.gsub(/\b('?[a-z])/) { $1.capitalize }
+      result = underscored_string.tr("_", " ")
+      result.gsub(/\b('?[a-z])/) { Regexp.last_match(1).capitalize }
     end
 
     # Distinguish BSD vs GNU sed with the --version flag (only present in GNU sed).
     def sed_i
-      @sed_format ||= begin
-        %x{sed --version &> /dev/null}
-        $?.success? ? "sed -i" : "sed -i ''"
-      end
+      @sed_i ||= begin
+                   `sed --version &> /dev/null`
+                   $?.success? ? "sed -i" : "sed -i ''"
+                 end
     end
 
     # Run a shell command and raise an exception if it fails.
     def shell(command)
-      %x{#{command}}
+      output = `#{command}`
       raise "#{command} failed with status #{$?.exitstatus}." unless $?.success?
-    end
-
-    def self.parse(args)
-      raygun = nil
-
-      options = OpenStruct.new
-      options.target_dir     = nil
-      options.prototype_repo = CARBONFIVE_REPO
 
-      parser = OptionParser.new do |opts|
-        opts.banner = "Usage: raygun [options] NEW_APP_DIRECTORY"
+      output
+    end
 
-        opts.on('-h', '--help', "Show raygun usage") do
-          usage_and_exit(opts)
-        end
-        opts.on('-p', '--prototype [github_repo]', "Prototype github repo (e.g. carbonfive/raygun-rails).") do |prototype|
-          options.prototype_repo = prototype
+    class << self
+      # rubocop:disable Metrics/MethodLength
+      def parse(_args)
+        raygun = nil
+
+        options = OpenStruct.new
+        options.target_dir     = nil
+        options.prototype_repo = CARBONFIVE_REPO
+
+        parser = OptionParser.new do |opts|
+          opts.banner = "Usage: raygun [options] NEW_APP_DIRECTORY"
+
+          opts.on("-h", "--help", "Show raygun usage") do
+            usage_and_exit(opts)
+          end
+          opts.on(
+            "-p",
+            "--prototype [github_repo]",
+            "Prototype github repo (e.g. carbonfive/raygun-rails)."
+          ) do |prototype|
+            options.prototype_repo = prototype
+          end
+
+          opts.on("-v", "--version", "Print the version number") do
+            puts Raygun::VERSION
+            exit 1
+          end
         end
-      end
 
-      begin
-        parser.parse!
-        options.target_dir = ARGV.first
+        begin
+          parser.parse!
+          options.target_dir = ARGV.first
 
-        raise OptionParser::InvalidOption if options.target_dir.nil?
+          raise OptionParser::InvalidOption if options.target_dir.nil?
 
-        raygun = Raygun::Runner.new(options.target_dir, options.prototype_repo)
+          raygun = Raygun::Runner.new(options.target_dir, options.prototype_repo)
+        rescue OptionParser::InvalidOption
+          usage_and_exit(parser)
+        end
 
-      rescue OptionParser::InvalidOption
-        usage_and_exit(parser)
+        raygun
       end
+      # rubocop:enable Metrics/MethodLength
 
-      raygun
-    end
-
-    def self.usage_and_exit(parser)
-      puts parser
-      exit 1
+      def usage_and_exit(parser)
+        puts parser
+        exit 1
+      end
     end
   end
 end

data/lib/raygun/template_repo.rb

@@ -3,7 +3,7 @@ module Raygun
     attr_reader :name, :branch, :tarball, :sha
 
     def initialize(repo)
-      @name, @branch = repo.split('#').map(&:strip)
+      @name, @branch = repo.split("#").map(&:strip)
       fetch
     end
 
@@ -11,6 +11,7 @@ module Raygun
 
     def fetch
       return if @branch && @sha
+
       @branch ? fetch_branches : fetch_tags
     end
 
@@ -19,12 +20,12 @@ module Raygun
       print "Whoops - need to try again!".colorize(:red)
       puts  ""
       print "We could not find (".colorize(:light_red)
-      print "#{name}".colorize(:white)
+      print name.to_s.colorize(:white)
       print "##{branch}".colorize(:white) if @branch
       print ") on github.".colorize(:light_red)
       puts  ""
       print "The response from github was a (".colorize(:light_red)
-      print "#{response.code}".colorize(:white)
+      print response.code.to_s.colorize(:white)
       puts  ") which I'm sure you can fix right up!".colorize(:light_red)
       puts  ""
       exit 1
@@ -35,10 +36,11 @@ module Raygun
       print "Whoops - need to try again!".colorize(:red)
       puts  ""
       print "We could not find any tags in the repo (".colorize(:light_red)
-      print "#{name}".colorize(:white)
+      print name.to_s.colorize(:white)
       print ") on github.".colorize(:light_red)
       puts  ""
-      print "Raygun uses the 'largest' tag in a repository, where tags are sorted alphanumerically.".colorize(:light_red)
+      print "Raygun uses the 'largest' tag in a repository, " \
+            "where tags are sorted alphanumerically.".colorize(:light_red)
       puts  ""
       print "E.g., tag 'v.0.10.0' > 'v.0.9.9' and 'x' > 'a'.".colorize(:light_red)
       print ""
@@ -50,8 +52,8 @@ module Raygun
       response = http_get("https://api.github.com/repos/#{name}/branches/#{branch}")
       handle_github_error(response) unless response.code == "200"
       result = JSON.parse(response.body)
-      @sha = result['commit']['sha']
-      @tarball = result['_links']['html'].gsub(%r(/tree/#{branch}), "/archive/#{branch}.tar.gz")
+      @sha = result["commit"]["sha"]
+      @tarball = result["_links"]["html"].gsub(%r{/tree/#{branch}}, "/archive/#{branch}.tar.gz")
     end
 
     def fetch_tags
@@ -60,17 +62,17 @@ module Raygun
 
       result = JSON.parse(response.body).first
       handle_missing_tag_error unless result
-      @sha = result['commit']['sha']
-      @tarball = result['tarball_url']
+      @sha = result["commit"]["sha"]
+      @tarball = result["tarball_url"]
     end
 
     def http_get(url)
-      uri          = URI.parse(url)
+      uri          = URI(url)
       http         = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
-      request      = Net::HTTP::Get.new(URI.encode(url))
+      request      = Net::HTTP::Get.new(uri)
 
-      response     = http.request(request)
+      http.request(request)
     end
   end
 end

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

data/raygun.gemspec

@@ -1,23 +1,28 @@
-# -*- encoding: utf-8 -*-
-
-File.expand_path('../lib', __FILE__).tap do |lib|
+File.expand_path("lib", __dir__).tap do |lib|
   $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 end
 
-require 'raygun/version'
+require "raygun/version"
 
 Gem::Specification.new do |gem|
   gem.name          = "raygun"
   gem.version       = Raygun::VERSION
   gem.authors       = ["Christian Nelson", "Jonah Williams", "Jason Wadsworth"]
   gem.email         = ["christian@carbonfive.com"]
-  gem.description   = %q{Carbon Five Rails application generator}
-  gem.summary       = %q{Generates and customizes Rails applications with Carbon Five best practices baked in.}
+  gem.description   = "Carbon Five Rails application generator"
+  gem.summary       = "Generates and customizes Rails applications with Carbon Five best practices baked in."
   gem.homepage      = "https://github.com/carbonfive/raygun"
-  gem.license       = 'MIT'
+  gem.license       = "MIT"
 
-  gem.files         = `git ls-files`.split($/)
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = "~> 2.4"
+
+  gem.add_development_dependency "bundler", "~> 2.0"
+  gem.add_development_dependency "rake", "~> 13.0"
+  gem.add_development_dependency "rspec", "~> 3.9"
+  gem.add_development_dependency "rubocop", "0.79.0"
 end

data/spec/raygun/raygun.rb

@@ -0,0 +1,3 @@
+require_relative "../spec_helper"
+
+describe Raygun::Runner

data/spec/raygun/runner_spec.rb

@@ -0,0 +1,27 @@
+require_relative "../spec_helper"
+require_relative "../../lib/raygun/raygun"
+
+describe Raygun::Runner do
+  describe "#fetch_rubocop_file" do
+    context "the repo is the standard carbonfive raygun-rails repo" do
+      before do
+        @runner = described_class.new("target/dir", "carbonfive/raygun-rails")
+        allow(URI).to receive(:open).and_return(StringIO.new("# rubocop contents"))
+        allow(IO).to receive(:write)
+        allow(@runner).to receive(:shell).and_return("GitSHAgoeshere")
+      end
+      it "inserts a copy of the rubocop file pulled from the carbonfive/c5-conventions repo" do
+        @runner.send(:fetch_rubocop_file)
+        expect(@runner).to have_received(:shell)
+          .with("git ls-remote https://github.com/carbonfive/c5-conventions master")
+        expect(URI).to have_received(:open)
+          .with("https://raw.githubusercontent.com/carbonfive/c5-conventions/master/rubocop/rubocop.yml")
+        expect(IO).to have_received(:write) do |path, contents|
+          expect(path).to eq(File.absolute_path("target/dir/.rubocop.yml"))
+          expect(contents).to include("@ GitSHA")
+          expect(contents).to include("# rubocop contents")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "rspec"

metadata

@@ -1,26 +1,84 @@
 --- !ruby/object:Gem::Specification
 name: raygun
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Christian Nelson
 - Jonah Williams
 - Jason Wadsworth
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-28 00:00:00.000000000 Z
-dependencies: []
+date: 2020-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.79.0
 description: Carbon Five Rails application generator
 email:
 - christian@carbonfive.com
 executables:
 - raygun
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - CHANGES.md
@@ -29,35 +87,41 @@ files:
 - README.md
 - Rakefile
 - bin/raygun
+- bin/setup
 - lib/colorize.rb
 - lib/raygun/raygun.rb
 - lib/raygun/template_repo.rb
 - lib/raygun/version.rb
 - marvin.jpg
 - raygun.gemspec
+- spec/raygun/raygun.rb
+- spec/raygun/runner_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/carbonfive/raygun
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.1
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Generates and customizes Rails applications with Carbon Five best practices
   baked in.
-test_files: []
+test_files:
+- spec/raygun/raygun.rb
+- spec/raygun/runner_spec.rb
+- spec/spec_helper.rb