fixings 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5b0bea364c71d1c9a69cd585b8051602bfbddc35af9ad20e4f6de775b9273fc
-  data.tar.gz: 2b0350fd3db0b95b6346baa24d524b04700ad9488a1d548af722643ee67fb2b4
+  metadata.gz: 30c25a80b25e3420cea8cbfd58c9d84552015b7e9c66597e5c13397e9776e1c5
+  data.tar.gz: 58c2a0eda5173fe518c833d724ed689feaaf9653a569e9ecb0f58120cdb98044
 SHA512:
-  metadata.gz: 11766c1a98bac0aa55504bccceb2ebadc9082e128bd8a2646edbfb490d4fd79a3e228f3484ff786fb9c4422fa2a38e1d0034f8ad2a044803faf5394e0d73649c
-  data.tar.gz: 68b31a19870d584dd2e6ca730003d26a824402e36a01cddec184714a61692554d93b59081706049dafc6a3353ac88dd060a470c69d9aff9cf379478b7719b20d
+  metadata.gz: d5f19ae414f2e25022d46ec64ffdcf87aa14e398b1dbb276b8ffb055ba638ad5f5cb3ed296b5b3edaeee7a357c4aade9de4ff848c59a8b1d2ada76457e20b976
+  data.tar.gz: afda8e8d7da97f3229f1bba1e3b6d9841d2ce3a5124d1376601b84c6ca6de467203639bfd3226798ae874921fe434cb9230cf1ea106ed9cf484d51e4dea21fe9

data/.rubocop.yml

@@ -4,7 +4,7 @@ AllCops:
     - "vendor/**/*"
     - "node_modules/**/*"
     - "test/scratch/**/*"
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
 require:
   - rubocop-performance

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fixings (0.1.1)
+    fixings (0.1.2)
       active_record_query_trace
       annotate
       ar_transaction_changes
@@ -222,7 +222,7 @@ GEM
       rack (>= 1.1)
       rubocop (>= 0.72.0)
     ruby-progressbar (1.10.1)
-    rufo (0.9.0)
+    rufo (0.10.0)
     safe_yaml (1.0.5)
     semantic_logger (4.6.0)
       concurrent-ruby (~> 1.0)

data/README.md

@@ -25,7 +25,15 @@ inherit_gem:
     - .rubocop.yml
 ```
 
-And then set up the followings things in the app:
+Fixings also couples tightly to the middleware structure to set request logging up properly. This requires `ActionDispatch::Session::CacheStore` and `ActionDispatch::Static` to be in the middleware stack. For a fresh Rails app, this isn't the case because of the session store. As of now, Fixings requires you use the `CacheStore` for your sessions, which is generally better than cookies for a production app anyways.
+
+To use cache store, replace the contents of `config/initializers/session_store.rb` with
+
+```ruby
+# frozen_string_literal: true
+# Be sure to restart your server when you modify this file.
+Rails.application.config.session_store(:cache_store, key: "spellcheck_#{Rails.env.to_s}_sessions")
+```
 
 #### Sentry (via sentry-raven)
 
@@ -73,11 +81,68 @@ end
 
 ```
 
+
+#### Routes and Engine Mounts
+
+Mount the various engines que brings along with it:
+
+```ruby
+Rails.application.routes.draw do
+  # ...
+
+  health_check_routes  # added by the health check gem included by fixings
+  mount Flipper::UI.app(Flipper) => "/flipper"  # useful for administering beta flags powered by flipper
+end
+```
+
+A more complicated setup might look like this with a host constraint:
+
+```ruby
+Rails.application.routes.draw do
+  health_check_routes
+
+  constraints host: Rails.configuration.x.domains.admin do
+    constraints AdminAuthConstraint.new do
+      mount Que::Web, at: "/que"
+      mount Flipper::UI.app(Flipper) => "/flipper"
+    end
+
+    mount Trestle::Engine => Trestle.config.path
+  end
+
+  # ...
+end
+```
+
+## Rubocop Config
+
+Getcher lint-y fixin's for Ruby code by putting this in `.rubocop.yml`:
+
+```yaml
+AllCops:
+  Exclude:
+    - "bin/**/*"
+    - "vendor/**/*"
+    - "node_modules/**/*"
+    - "test/scratch/**/*"
+  TargetRubyVersion: 2.7
+
+inherit_gem:
+  fixings:
+    - .rubocop.yml
+```
+
 ## JavaScript / TypeScript config
 
 We have those fixings too!
 
-Create `.eslintrc.js` in your project with this content:
+Add the required packages:
+
+```
+yarn add --dev @fixings/prettier-config @fixings/eslint-config
+```
+
+Create `.eslintrc.json` in your project with this content:
 
 ```json
 {

data/lib/fixings/railtie.rb

@@ -79,6 +79,8 @@ module Fixings
         if SemanticLogger.appenders.all? { |appender| appender.instance_variable_get(:@log) != STDOUT }
           app.config.semantic_logger.add_appender(io: STDOUT, level: app.config.log_level, formatter: app.config.rails_semantic_logger.format)
         end
+      elsif Rails.env.test?
+        # Do nothing, leave appending to test.log file in place
       else
         # Use semantic_logger logging setup to log JSON to STDOUT
         app.config.rails_semantic_logger.add_file_appender = false

data/lib/fixings/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Fixings
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fixings
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Harry Brundage
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-16 00:00:00.000000000 Z
+date: 2020-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_record_query_trace