raygun 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5a4f38bcb962367072335e95eda6d184b8b5fb60
-  data.tar.gz: 525cd6d636d97ff068c934371ac695609545974a
+SHA256:
+  metadata.gz: c7ca3630bd95d0e0c12a7bf9d9f6b5cc0255ba5dfced51c83017a164f84ff147
+  data.tar.gz: 06ba32e033ec46d2ebe15f4e03c781b91ba94ac912075e9c1fff6872b68a5489
 SHA512:
-  metadata.gz: 457ac34907223cbaaff392788bb8d049fcef8db50b2887335833cb5626a16293e30e6d0aab15f028e56a08ee70b1e5e466d341e2ca5f60018f16a774fef9e3da
-  data.tar.gz: 828b254b3a7176b80f5150d6efcc2339f080e46ec689131777267e07b4232baa5720649526b90d4a30365bc20f99f3d3daf17259ca606119867477ab106642f2
+  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.1.2
+2.6.5

data/CHANGES.md

@@ -1,5 +1,43 @@
 # Change Log
 
+**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)
+
+## 1.0.3 [2017-10-25]
+
+* Add ability to pull template repository by branch name (#137, thanks @bunnymatic!).
+* Updates to the README (mostly tweaks).
+* Use Ruby 2.4.2 for development.
+
+## 1.0.1 [2015-01-30]
+
+* Simplify instructions: use ./bin/setup instead of explicit commands.
+* Use ruby 2.2.0 for development.
+
 ## 1.0.0 [2014-07-01]
 
 * 1.0 Release, because it's about time.

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,12 +1,12 @@
-[![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
 
 Rails application generator that builds a new project skeleton configured with Carbon Five preferences and
 best practices baked right in. Spend less time configuring and more building cool features.
 
-Raygun generates Rails 4 projects by copying this [sample app](https://github.com/carbonfive/raygun-rails)
+Raygun generates Rails projects by copying this [sample app](https://github.com/carbonfive/raygun-rails)
 and massaging it gently into shape.
 
 Alternatively, Raygun allows you to specify your own prototype instead of the default sample app. See below
@@ -18,17 +18,15 @@ Major tools/libraries:
 * PostgreSQL
 * Slim
 * Sass
-* Bootstrap
-* RSpec
-* Factory Girl
-* Jasmine
+* RSpec and Capybara
+* Factory Bot
 * SimpleCov
-* Guard (rspec, jasmine, livereload)
-* And many tweaks, patterns and common recipes (see [raygun-rails](https://github.com/carbonfive/raygun-rails) for all the details).
+* Guard (rspec, livereload)
+* And many tweaks, patterns and common recipes (see [raygun-rails](https://github.com/carbonfive/raygun-rails) for all
+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!
 
@@ -47,61 +45,97 @@ Raygun...
 
 ## Prerequisites
 
-To generate an application, you only need the raygun gem and network connectivity.
+To generate an application, you only need the Raygun gem and network connectivity.
 
 To run your new application's specs or fire up its server, you'll need to meet these requirements.
 
-* PostgreSQL 9.x with superuser 'postgres' with no password (```createuser -s postgres```)
-* PhantomJS for JavaScript testing (```brew install phantomjs```)
+* PostgreSQL 9.x with superuser 'postgres' with no password (`createuser -s postgres`)
+* PhantomJS for JavaScript testing (`brew install phantomjs`)
 
-The generated app will be configured to use the ruby version that was used to invoke raygun. If you're using
-another ruby, just change the ```Gemfile``` and ```.ruby-version``` as necessary.
+The generated app will be configured to use the ruby version that was used to invoke Raygun. If you're using
+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 prerequities
+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
-    $ gem install bundler
-    $ bundle
+```bash
+$ cd your-project
+$ bin/setup
 
-    # Prepare the database: schema and reference / sample data
-    $ rake db:setup db:sample_data
+# Run the specs, they should all pass
+$ bin/rake
 
-    # Run the specs
-    $ 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`
+
+```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
-    $ foreman start
-    $ open http://localhost:3000
 
 ## Using a Custom Project Template
 
 The default is to use the project at [carbonfive/raygun-rails](https://github.com/carbonfive/raygun-rails) as a
-starting point. You can use another repo as the project template with the ```-p``` command line option.
+starting point. You can use another repo as the project template with the `-p` command line option.
 
-If you invoke raygun with the ```-p``` option, you can specify your own github repository.
+If you invoke raygun with the `-p` option, you can specify your own github repository.
 
     $ raygun -p githubid/repo your-project
 
+Or
+
+    $ raygun -p githubid/repo your-project#new-branch-name
+
 The repository must:
 
-* Have been tagged. Raygun chooses the "greatest" tag and downloads the repository as of that tag.
-* Not have any binary files. Raygun runs a 'sed' command on all files, which will fail on binaries, such as jar files.
+Not have any binary files. Raygun runs a 'sed' command on all files, which will fail on binaries, such as jar files.
+
+If you are not planning to pull the prototype repository by branch, it must also have a tag. Raygun will choose the
+"greatest" tag and downloads the repository as of that tag.
 
-If your project template requires a minimum version of raygun, include the version in a file called
-```.raygun-version``` at the root. Raygun will make sure it's new enough for your repo.
+If your project template requires a minimum version of Raygun, include the version in a file called
+`.raygun-version` at the root. Raygun will make sure it's new enough for your repo.
 
 ## Internal Mechanics
 
 Raygun fetches the greatest tag from the [carbonfive/raygun-rails](https://github.com/carbonfive/raygun-rails)
-repo, unless it already has it cached in ~/.raygun, extracts the contents of the tarball, and runs a series of
+repo, unless it already has it cached in `~/.raygun`, extracts the contents of the tarball, and runs a series of
 search-and-replaces on the code to customize it accordingly.
 
-This approach is fast, simple, and makes raygun developement very easy. Make changes to the application
+This approach is fast, simple, and makes developmentn on Raygun very easy: make changes to the application
 prototype (which is a valid rails app) and tag them when they should be used for new applications.
 
 ## Contributing
@@ -114,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