raygun 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 53fef6c89e692472bd5d1bdca79c821116c57bcc
-  data.tar.gz: 7f94124fd48ae4286dc162f25705c7f5a3dbeb26
+SHA256:
+  metadata.gz: 6464c730d406fd0cd161d886375e52ef103781865bfb7c81f382987351c08597
+  data.tar.gz: f01fc5f9e573314b6852e002e79e18ca49a1163fbcc9052008ab94ac24ab4d1e
 SHA512:
-  metadata.gz: 1ebcc79eef641dfb5449169f6cbc04a0eccf13586b1907c79dc537fbeb922140331134a6b35702bf25f9f632c85d057394c3796e156cbbe1bdfd55d2649d8ae4
-  data.tar.gz: 2ee3e7c2fc6944293daa3d6b3a24feebd31cdb1f58ff0ea3125acac6a6e44723913de5288ca7921c1f7ccc5d8997415b01dd08611e4fbdad16efdbb58f2b5576
+  metadata.gz: 9ac1c6b995395e8dffeb309443f204b7bd7799083b45e2ac3cf51dcc0d73a15621dcb9648da7fadb8aae133aa94bf06619d7285bc03c2c9b5b627e55bc9e2361
+  data.tar.gz: 1a6b817213c3ed7138a231e2f8b728b6d509c17a3e72f1a0e23248e6582261673156453c36f37fda3796774b2f0bd2946c66c32165ce9dc54281334a2a938828

data/.circleci/config.yml

@@ -0,0 +1,66 @@
+version: 2.1
+executors:
+  ruby:
+    parameters:
+      version:
+        description: "Ruby version number"
+        default: "2.7.2"
+        type: string
+    docker:
+      - image: cimg/ruby:<< parameters.version >>
+
+commands:
+  bundle_install:
+    description: Install Ruby dependencies with Bundler
+    parameters:
+      version:
+        description: "Ruby version number"
+        default: "2.7.2"
+        type: string
+    steps:
+      - restore_cache:
+          keys:
+            - bundle-v1-{{ arch }}-<< parameters.version >>
+      - run:
+          name: Install Ruby Dependencies
+          command: |
+            gem install bundler -v 2.1.4 --conservative --no-document
+            bundle config --local path vendor/bundle
+            bundle check || (bundle install --jobs=4 --retry=3 && bundle clean)
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: bundle-v1-{{ arch }}-<< parameters.version >>-{{ checksum "Gemfile.lock" }}
+
+jobs:
+  rubocop:
+    executor: ruby
+    steps:
+      - checkout
+      - bundle_install
+      - run: bundle exec rubocop
+
+  rspec:
+    parameters:
+      version:
+        description: "Ruby version number"
+        default: "2.7.2"
+        type: string
+    executor:
+      name: ruby
+      version: << parameters.version >>
+    steps:
+      - checkout
+      - bundle_install:
+          version: << parameters.version >>
+      - run: bundle exec rake spec
+
+workflows:
+  version: 2
+  commit-workflow:
+    jobs:
+      - rubocop
+      - rspec:
+          matrix:
+            parameters:
+              version: ["2.5.8", "2.6.6", "2.7.2", "3.0.0"]

data/.rubocop.yml

@@ -0,0 +1,99 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  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.2.4
+2.7.2

data/CHANGES.md

@@ -1,5 +1,50 @@
 # 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.2.0 [2021-05-20]
+
+New features:
+
+* Copy the new rubocop conventions from the `main` branch of the c5-conventions repo (#163).
+
+## 1.1.1 [2020-07-02]
+
+Housekeeping:
+
+* Fix compatibility so that any supported Ruby (currently 2.5+) is allowed (#165).
+
+## 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.

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,57 +45,126 @@ 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
-    $ ./bin/setup
+```bash
+$ cd your-project
+$ bin/setup
 
-    # Run the specs, they should all pass
-    $ rake
+# 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
+
+### React
+
+To add React, just run this generator:
+
+```bash
+$ bundle exec rails webpacker:install:react
+```
+
+You can use JSX in your `app/javascript` sources and the `react_component` helper in your Rails views. Your React code
+will be packaged and deployed automatically with the rest of your app, and you can test it end-to-end with Capybara,
+just like other Rails apps. See the [webpacker-react](https://github.com/renchap/webpacker-react) README for more
+information.
+
+> :bulb: Check out [spraygun-react](https://github.com/carbonfive/spraygun-react) for eslint and stylelint configurations that can work for React projects.
+
+### React with Typescript
+
+To add React with Typescript, run the React generator listed above, and then add Typescript:
+
+```bash
+$ bundle exec rails webpacker:install:typescript
+```
+
+Don't forget to rename any files containing JSX to `.tsx`.
+
+For more information, see the [webpacker Typescript docs](https://github.com/rails/webpacker/blob/master/docs/typescript.md).
+
+### Bootstrap
+
+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 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 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.
 
 ## 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
@@ -110,10 +177,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)