safer_rails_console 0.1.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cdf260deb3867b5bed0d92646aa88de6f64afd03
-  data.tar.gz: 3cbaac5740f226b7a0364168f4ab137d080fe1ec
+SHA256:
+  metadata.gz: cafff060a5348f7dbabb75a906b6ec0fe610cbf994308be6273aa67fd02e72aa
+  data.tar.gz: b13364f0f4eaf4ece0d3eab4ed49e5d50bd9803ca8159f964456cb8c99211694
 SHA512:
-  metadata.gz: 470e4da18f0fe1ad4e10df31ae6189f66c7ee58f66389bc8bc3c6d0224f6f8c816dec8d7b94001b22911778bc595a6da7e0de0e3a360c348e29b56de64f7638f
-  data.tar.gz: a3afb5cc08b8a001879271c7f86b4c78dc5b6cb13d97f2a7602f4ab3ebe96437cc9fb0d22c33ef872fbf9d9daa85e5bd7cc44c43b2e679d2baab112be7c8ef5d
+  metadata.gz: 4a7443a5523a213e3728c956100fd988288c32e60b86445504d5d42a3d002042dccfcc8fd8c9fd9faeefa25d45e025b810259d6cd5824d4a23a25266cb27a26f
+  data.tar.gz: 3da4c68ff49a4e9f59bd86c8f84e281378dc0d93db3cf31dce6239476d74b67769b6be94602cfa2ebf9d61378a2ab1e986bacfa054bf5a9290096b61614f2679

data/.circleci/config.yml

@@ -0,0 +1,79 @@
+version: 2.1
+jobs:
+  lint:
+    docker:
+      - image: salsify/ruby_ci:2.5.8
+    working_directory: ~/safer_rails_console
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v2-gems-ruby-2.5.8-{{ checksum "safer_rails_console.gemspec" }}-{{ checksum "Gemfile" }}
+            - v2-gems-ruby-2.5.8-
+      - run:
+          name: Install Gems
+          command: |
+            if ! bundle check --path=vendor/bundle; then
+              bundle install --path=vendor/bundle --jobs=4 --retry=3
+              bundle clean
+            fi
+      - save_cache:
+          key: v2-gems-ruby-2.5.8-{{ checksum "safer_rails_console.gemspec" }}-{{ checksum "Gemfile" }}
+          paths:
+            - "vendor/bundle"
+            - "gemfiles/vendor/bundle"
+      - run:
+          name: Run Rubocop
+          command: bundle exec rubocop
+  test:
+    parameters:
+      gemfile:
+        type: string
+    docker:
+      - image: salsify/ruby_ci:2.5.8
+        environment:
+          CIRCLE_TEST_REPORTS: "test-results"
+          BUNDLE_GEMFILE: "/home/circleci/safer_rails_console/<< parameters.gemfile >>"
+      - image: circleci/postgres:9.6
+        environment:
+          POSTGRES_USER: "circleci"
+          POSTGRES_DB: "safer_rails_console_test"
+          POSTGRES_HOST_AUTH_METHOD: "trust"
+    working_directory: ~/safer_rails_console
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - v2-gems-ruby-2.5.8-{{ checksum "safer_rails_console.gemspec" }}-{{ checksum "<< parameters.gemfile >>" }}
+            - v2-gems-ruby-2.5.8-
+      - run:
+          name: Install Gems
+          command: |
+            if ! bundle check --path=vendor/bundle; then
+              bundle install --path=vendor/bundle --jobs=4 --retry=3
+              bundle clean
+            fi
+      - save_cache:
+          key: v2-gems-ruby-2.5.8-{{ checksum "safer_rails_console.gemspec" }}-{{ checksum "<< parameters.gemfile >>" }}
+          paths:
+            - "vendor/bundle"
+            - "gemfiles/vendor/bundle"
+      - run:
+          name: Run Tests
+          command: |
+            bundle exec rspec --format RspecJunitFormatter --out $CIRCLE_TEST_REPORTS/rspec/junit.xml --format progress spec
+      - store_test_results:
+          path: "test-results"
+workflows:
+  build:
+    jobs:
+      - lint
+      - test:
+          matrix:
+            parameters:
+              gemfile:
+              - "gemfiles/5.0.gemfile"
+              - "gemfiles/5.1.gemfile"
+              - "gemfiles/5.2.gemfile"
+              - "gemfiles/6.0.gemfile"
+              - "gemfiles/6.1.gemfile"

data/.gitignore

@@ -13,3 +13,5 @@
 
 # Appraisal gemfile.lock
 /gemfiles/*.gemfile.lock
+out
+*.sqlite3

data/.rubocop.yml

@@ -1,2 +1,11 @@
 inherit_gem:
   salsify_rubocop: conf/rubocop_rails.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'vendor/**/*'
+    - 'gemfiles/vendor/**/*'
+
+Style/FrozenStringLiteralComment:
+  Enabled: true

data/Appraisals

@@ -1,10 +1,4 @@
-appraise '4.1' do
-  gem 'rails', '~> 4.1.0'
-end
-
-appraise '4.2' do
-  gem 'rails', '~> 4.2.0'
-end
+# frozen_string_literal: true
 
 appraise '5.0' do
   gem 'rails', '~> 5.0.0'
@@ -13,3 +7,15 @@ end
 appraise '5.1' do
   gem 'rails', '~> 5.1.0'
 end
+
+appraise '5.2' do
+  gem 'rails', '~> 5.2.0'
+end
+
+appraise '6.0' do
+  gem 'rails', '~> 6.0.0'
+end
+
+appraise '6.1' do
+  gem 'rails', '~> 6.1.0'
+end

data/CHANGELOG.md

@@ -1,6 +1,59 @@
-# Change Log
+# Changelog
+
+## [v0.4.1](https://github.com/salsify/safer_rails_console/tree/v0.4.1) (2020-10-13)
+
+[Full Changelog](https://github.com/salsify/safer_rails_console/compare/v0.4.0...v0.4.1)
+
+**Closed issues:**
+
+- No default settings for rails 5.1 and 5.2 [\#29](https://github.com/salsify/safer_rails_console/issues/29)
+
+**Merged pull requests:**
+
+- Bump version v0.4.1 [\#33](https://github.com/salsify/safer_rails_console/pull/33) ([alexsalsify](https://github.com/alexsalsify))
+- Add support for config values from ENV variables [\#32](https://github.com/salsify/safer_rails_console/pull/32) ([alexsalsify](https://github.com/alexsalsify))
+
+## [v0.4.0](https://github.com/salsify/safer_rails_console/tree/v0.4.0) (2019-09-19)
+
+[Full Changelog](https://github.com/salsify/safer_rails_console/compare/v0.3.0...v0.4.0)
+
+**Closed issues:**
+
+- safer\_rails\_console breaks newrelic reporting [\#23](https://github.com/salsify/safer_rails_console/issues/23)
+
+**Merged pull requests:**
+
+- Rails 6.0 support [\#27](https://github.com/salsify/safer_rails_console/pull/27) ([jturkel](https://github.com/jturkel))
+- Drop Rails 4.2 support [\#26](https://github.com/salsify/safer_rails_console/pull/26) ([jturkel](https://github.com/jturkel))
+- Resolve sqlite3 dependency warning [\#11](https://github.com/salsify/safer_rails_console/pull/11) ([timothysu](https://github.com/timothysu))
+
+## [v0.3.0](https://github.com/salsify/safer_rails_console/tree/v0.3.0) (2018-04-16)
+
+[Full Changelog](https://github.com/salsify/safer_rails_console/compare/v0.2.0...v0.3.0)
+
+**Merged pull requests:**
+
+- Add support for Rails 5.2; remove support for Rails 4.1 [\#24](https://github.com/salsify/safer_rails_console/pull/24) ([timothysu](https://github.com/timothysu))
+- Patch PostgreSQLAdapter\#execute\_and\_clear instead of AbstractAdapter\#log for auto-rollback [\#15](https://github.com/salsify/safer_rails_console/pull/15) ([timothysu](https://github.com/timothysu))
+
+## [v0.2.0](https://github.com/salsify/safer_rails_console/tree/v0.2.0) (2017-09-07)
+
+[Full Changelog](https://github.com/salsify/safer_rails_console/compare/v0.1.4...v0.2.0)
+
+**Implemented enhancements:**
+
+- Sandbox mode should make it clear that edits don't stick [\#19](https://github.com/salsify/safer_rails_console/issues/19)
+- Writes made in sandbox mode take out DB locks [\#18](https://github.com/salsify/safer_rails_console/issues/18)
+- Confusion over unsandboxed/sandboxed terminology in command prompt [\#17](https://github.com/salsify/safer_rails_console/issues/17)
+
+**Merged pull requests:**
+
+- Use Postgres for local development too [\#28](https://github.com/salsify/safer_rails_console/pull/28) ([jturkel](https://github.com/jturkel))
+- Set DB transactions to read-only and provide messaging for non-read operations [\#21](https://github.com/salsify/safer_rails_console/pull/21) ([timothysu](https://github.com/timothysu))
+- Change 'sandboxed' and 'unsandboxed' to 'read-only' and 'writable' and add respective flags [\#20](https://github.com/salsify/safer_rails_console/pull/20) ([timothysu](https://github.com/timothysu))
 
 ## [v0.1.4](https://github.com/salsify/safer_rails_console/tree/v0.1.4) (2017-08-15)
+
 [Full Changelog](https://github.com/salsify/safer_rails_console/compare/v0.1.3...v0.1.4)
 
 **Fixed bugs:**
@@ -8,11 +61,8 @@
 - Invalid cached and prepared statements do not trigger a automatic rollback with PostgreSQL [\#16](https://github.com/salsify/safer_rails_console/issues/16)
 - safer\_rails\_console doesn't work in alerts service rails console mode in sandbox mode [\#13](https://github.com/salsify/safer_rails_console/issues/13)
 
-**Merged pull requests:**
-
-- Patch PostgreSQLAdapter\#execute\_and\_clear instead of AbstractAdapter\#log for auto-rollback [\#15](https://github.com/salsify/safer_rails_console/pull/15) ([timothysu](https://github.com/timothysu))
-
 ## [v0.1.3](https://github.com/salsify/safer_rails_console/tree/v0.1.3) (2017-08-02)
+
 [Full Changelog](https://github.com/salsify/safer_rails_console/compare/v0.1.2...v0.1.3)
 
 **Fixed bugs:**
@@ -22,9 +72,9 @@
 **Merged pull requests:**
 
 - Default sandbox flag to nil in Rails 5.1 [\#12](https://github.com/salsify/safer_rails_console/pull/12) ([timothysu](https://github.com/timothysu))
-- Resolve sqlite3 dependency warning [\#11](https://github.com/salsify/safer_rails_console/pull/11) ([timothysu](https://github.com/timothysu))
 
 ## [v0.1.2](https://github.com/salsify/safer_rails_console/tree/v0.1.2) (2017-07-21)
+
 [Full Changelog](https://github.com/salsify/safer_rails_console/compare/v0.1.1...v0.1.2)
 
 **Merged pull requests:**
@@ -32,6 +82,7 @@
 - Dasherize the app name given CamelCase [\#10](https://github.com/salsify/safer_rails_console/pull/10) ([timothysu](https://github.com/timothysu))
 
 ## [v0.1.1](https://github.com/salsify/safer_rails_console/tree/v0.1.1) (2017-07-07)
+
 [Full Changelog](https://github.com/salsify/safer_rails_console/compare/v0.1.0...v0.1.1)
 
 **Fixed bugs:**
@@ -43,10 +94,13 @@
 - Add support for Spring [\#8](https://github.com/salsify/safer_rails_console/pull/8) ([timothysu](https://github.com/timothysu))
 
 ## [v0.1.0](https://github.com/salsify/safer_rails_console/tree/v0.1.0) (2017-06-26)
+
+[Full Changelog](https://github.com/salsify/safer_rails_console/compare/baddba2bc069bc6d72e779d8c157e19d26b30fc1...v0.1.0)
+
 **Merged pull requests:**
 
 - Initial Implementation [\#2](https://github.com/salsify/safer_rails_console/pull/2) ([timothysu](https://github.com/timothysu))
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in safer_rails_console.gemspec

data/README.md

@@ -1,4 +1,7 @@
-# SaferRailsConsole [![Build Status](https://travis-ci.org/salsify/safer_rails_console.svg?branch=master)](https://travis-ci.org/salsify/safer_rails_console)
+# SaferRailsConsole
+
+[![Build Status](https://circleci.com/gh/salsify/safer_rails_console.svg?style=svg)](https://circleci.com/gh/salsify/safer_rails_console)
+[![Gem Version](https://badge.fury.io/rb/safer_rails_console.svg)](https://badge.fury.io/rb/safer_rails_console)
 
 This gem makes Rails console sessions less dangerous in specified environments by warning, color-coding, auto-sandboxing, and allowing read-only external connections (disables job queueing, non-GET requests, etc.)
 
@@ -27,11 +30,14 @@ require 'safer_rails_console/patches/boot'
 
 The quickest way to demo this gem is to run `bundle exec rails console --sandbox`.
 
-A way to explicitly enable or disable the sandbox is added to Rails console as a flag with the last install step.
+Several ways to explicitly enable or disable the sandbox are added to Rails console as flags with the last install step.  The order of precedence is `-s`, `-r`, then `-w` if multiple sandbox related flags are specified.
 ```ruby
 bundle exec rails console --help  
 
+Usage: rails console [environment] [options]
     -s, --[no-]sandbox               Explicitly enable/disable sandbox mode.
+    -w, --writable                   Alias for --no-sandbox.
+    -r, --read-only                  Alias for --sandbox.
     -e, --environment=name           Specifies the environment to run this console under (test/development/production).
                                      Default: development
         --debugger                   Enable the debugger.
@@ -70,6 +76,24 @@ config.safer_rails_console.warn_text = "WARNING: YOU ARE USING RAILS CONSOLE IN
                                        'Make sure you know what you\'re doing.'
 ```
 
+configuration settings can also be overridden using ENV variables. The following ENV vars can be used:
+```
+# Set the color prompt to a new color. See colors.rb for a listing of supported colors.
+SAFER_RAILS_CONSOLE_PROMPT_COLOR=red/yellow/green
+
+# Set the short name for the rails console prompt
+SAFER_RAILS_CONSOLE_ENVIRONMENT_NAME=short-name
+
+# Set the warning text to be displayed when warning for the environments rails consoled is enabled
+SAFER_RAILS_CONSOLE_WARN_TEXT=New warning prompt text
+
+# Enable or disable sandboxing of the rails console
+SAFER_RAILS_CONSOLE_SANDBOX_ENVIRONMENT=true/false
+
+# Enable or disable warning prompt of the rails console
+SAFER_RAILS_CONSOLE_WARN_ENVIRONMENT=true/false
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `wwtd` to simulate the entire build matrix (ruby version / rails version) or `appraisal` to test against each supported rails version with your active ruby version. Run `rubocop` to check for style. 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rails'

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "safer_rails_console"
+require 'bundler/setup'
+require 'safer_rails_console'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +11,5 @@ require "safer_rails_console"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/gemfiles/{4.1.gemfile → 5.2.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.1.0"
+gem "rails", "~> 5.2.0"
 
 gemspec path: "../"

data/gemfiles/{4.2.gemfile → 6.0.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.2.0"
+gem "rails", "~> 6.0.0"
 
 gemspec path: "../"

data/gemfiles/6.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"

data/lib/safer_rails_console.rb

@@ -1,25 +1,52 @@
+# frozen_string_literal: true
+
 require 'safer_rails_console/version'
 require 'safer_rails_console/railtie'
 require 'safer_rails_console/colors'
 require 'safer_rails_console/rails_version'
 require 'safer_rails_console/console'
+require 'active_model/type'
 
 module SaferRailsConsole
   class << self
     def environment_name
-      config.environment_names.key?(::Rails.env.downcase) ? config.environment_names[::Rails.env.downcase] : 'unknown env'
+      if ENV.key?('SAFER_RAILS_CONSOLE_ENVIRONMENT_NAME')
+        ENV['SAFER_RAILS_CONSOLE_ENVIRONMENT_NAME']
+      else
+        config.environment_names.key?(::Rails.env.downcase) ? config.environment_names[::Rails.env.downcase] : 'unknown env'
+      end
     end
 
     def prompt_color
-      config.environment_prompt_colors.key?(::Rails.env.downcase) ? config.environment_prompt_colors[::Rails.env.downcase] : SaferRailsConsole::Colors::NONE
+      if ENV.key?('SAFER_RAILS_CONSOLE_PROMPT_COLOR')
+        SaferRailsConsole::Colors.const_get(ENV['SAFER_RAILS_CONSOLE_PROMPT_COLOR'].upcase)
+      else
+        config.environment_prompt_colors.key?(::Rails.env.downcase) ? config.environment_prompt_colors[::Rails.env.downcase] : SaferRailsConsole::Colors::NONE
+      end
     end
 
     def sandbox_environment?
-      config.sandbox_environments.include?(::Rails.env.downcase)
+      if ENV.key?('SAFER_RAILS_CONSOLE_SANDBOX_ENVIRONMENT')
+        ActiveModel::Type::Boolean.new.cast(ENV['SAFER_RAILS_CONSOLE_SANDBOX_ENVIRONMENT'])
+      else
+        config.sandbox_environments.include?(::Rails.env.downcase)
+      end
     end
 
     def warn_environment?
-      config.warn_environments.include?(::Rails.env.downcase)
+      if ENV.key?('SAFER_RAILS_CONSOLE_WARN_ENVIRONMENT')
+        ActiveModel::Type::Boolean.new.cast(ENV['SAFER_RAILS_CONSOLE_WARN_ENVIRONMENT'])
+      else
+        config.warn_environments.include?(::Rails.env.downcase)
+      end
+    end
+
+    def warn_text
+      if ENV.key?('SAFER_RAILS_CONSOLE_WARN_TEXT')
+        ENV['SAFER_RAILS_CONSOLE_WARN_TEXT']
+      else
+        config.warn_text
+      end
     end
 
     def config

data/lib/safer_rails_console/colors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SaferRailsConsole
   module Colors
     NONE = 0

data/lib/safer_rails_console/console.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SaferRailsConsole
   module Console
     class << self
@@ -8,7 +10,7 @@ module SaferRailsConsole
       end
 
       def print_warning
-        puts color_text(SaferRailsConsole.config.warn_text, SaferRailsConsole.prompt_color) # rubocop:disable Rails/Output
+        puts color_text(SaferRailsConsole.warn_text, SaferRailsConsole.prompt_color) # rubocop:disable Rails/Output
       end
 
       def load_config

data/lib/safer_rails_console/consoles/irb.rb

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
 include SaferRailsConsole::Colors
 
-app_name = ::Rails.application.class.parent.to_s.underscore.dasherize
+app_name = if SaferRailsConsole::RailsVersion.six_or_above?
+             ::Rails.application.class.module_parent.to_s.underscore.dasherize
+           else
+             ::Rails.application.class.parent.to_s.underscore.dasherize
+           end
 env_name = SaferRailsConsole.environment_name
-status = ::Rails.application.sandbox ? 'sandboxed' : 'unsandboxed'
+status = ::Rails.application.sandbox ? 'read-only' : 'writable'
 color = SaferRailsConsole.prompt_color
 
 prompt = "#{app_name}(#{env_name})(#{status}):%03n:%i"
@@ -12,7 +18,7 @@ IRB.conf[:PROMPT][:RAILS_ENV] = {
   PROMPT_N: color_text("#{prompt}> ", color),
   PROMPT_S: color_text("#{prompt}%l ", color),
   PROMPT_C: color_text("#{prompt}* ", color),
-  RETURN: color_text('=> ', color).concat("%s\n")
+  RETURN: "#{color_text('=> ', color)}%s\n"
 }
 
 IRB.conf[:PROMPT_MODE] = :RAILS_ENV

data/lib/safer_rails_console/patches/boot.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 Dir[File.join(__dir__, 'boot', '*.rb')].each { |file| require file }

data/lib/safer_rails_console/patches/boot/sandbox_flag.rb

@@ -1,45 +1,22 @@
+# frozen_string_literal: true
+
 require 'safer_rails_console/rails_version'
 
 module SaferRailsConsole
   module Patches
     module Boot
       module SandboxFlag
-        module Rails
-          module CommandsTasks4
-            def console
-              require_command!('console')
-              ::Rails::Console.singleton_class.prepend(::SaferRailsConsole::Patches::Boot::SandboxFlag::Rails::Console4)
-              super
-            end
-          end
-
-          module Console4
-            def parse_arguments(arguments)
-              options = {}
-
-              OptionParser.new do |opt|
-                opt.banner = 'Usage: rails console [environment] [options]'
-                opt.on('-s', '--[no-]sandbox', 'Explicitly enable/disable sandbox mode.') { |v| options[:sandbox] = v }
-                opt.on('-e', '--environment=name', String,
-                       'Specifies the environment to run this console under (test/development/production).',
-                       'Default: development') { |v| options[:environment] = v.strip }
-                opt.on('--debugger', 'Enable the debugger.') { |v| options[:debugger] = v }
-                opt.parse!(arguments)
-              end
-
-              if arguments.first && arguments.first[0] != '-'
-                env = arguments.first
-                options[:environment] = if available_environments.include? env
-                                          env
-                                        else
-                                          %w(production development test).detect { |e| e =~ /^#{env}/ } || env
-                                        end
-              end
-
-              options
-            end
-          end
+        def self.console_options(opt, options = {})
+          opt.banner = 'Usage: rails console [environment] [options]'
+          opt.on('-s', '--[no-]sandbox', 'Explicitly enable/disable sandbox mode.') { |v| options[:sandbox] = v }
+          opt.on('-w', '--writable', 'Alias for --no-sandbox.') { |v| options[:writable] = v }
+          opt.on('-r', '--read-only', 'Alias for --sandbox.') { |v| options[:'read-only'] = v }
+          opt.on('-e', '--environment=name', String,
+                 'Specifies the environment to run this console under (test/development/production).',
+                 'Default: development') { |v| options[:environment] = v.strip }
+        end
 
+        module Rails
           module CommandsTasks50
             def console
               require_command!('console')
@@ -53,11 +30,7 @@ module SaferRailsConsole
               options = {}
 
               OptionParser.new do |opt|
-                opt.banner = 'Usage: rails console [environment] [options]'
-                opt.on('-s', '--[no-]sandbox', 'Explicitly enable/disable sandbox mode.') { |v| options[:sandbox] = v }
-                opt.on('-e', '--environment=name', String,
-                       'Specifies the environment to run this console under (test/development/production).',
-                       'Default: development') { |v| options[:environment] = v.strip }
+                ::SaferRailsConsole::Patches::Boot::SandboxFlag.console_options(opt, options)
                 opt.parse!(arguments)
               end
 
@@ -70,19 +43,18 @@ module SaferRailsConsole
   end
 end
 
-if SaferRailsConsole::RailsVersion.four_one? || SaferRailsConsole::RailsVersion.four_two?
-  require 'rails/commands/commands_tasks'
-  ::Rails::CommandsTasks.prepend(SaferRailsConsole::Patches::Boot::SandboxFlag::Rails::CommandsTasks4)
-elsif SaferRailsConsole::RailsVersion.five_zero?
+if SaferRailsConsole::RailsVersion.five_zero?
   require 'rails/commands/commands_tasks'
   ::Rails::CommandsTasks.prepend(SaferRailsConsole::Patches::Boot::SandboxFlag::Rails::CommandsTasks50)
-elsif SaferRailsConsole::RailsVersion.five_one?
+elsif SaferRailsConsole::RailsVersion.five_one_or_above?
   require 'rails/command'
   require 'rails/commands/console/console_command'
-  # Rails 5.1 defaults `sandbox` to `false`, but we need it to NOT have a default value and be `nil` when it is not user-specified
+  # Rails 5.1 and 5.2 defaults `sandbox` to `false`, but we need it to NOT have a default value and be `nil` when it is not user-specified
   ::Rails::Command::ConsoleCommand.class_eval do
     remove_class_option :sandbox
     class_option :sandbox, aliases: '-s', type: :boolean, desc: 'Explicitly enable/disable sandbox mode.'
+    class_option :writable, aliases: '-w', type: :boolean, desc: 'Alias for --no-sandbox.'
+    class_option :'read-only', aliases: '-r', type: :boolean, desc: 'Alias for --sandbox.'
   end
 else
   unless SaferRailsConsole::RailsVersion.supported?

data/lib/safer_rails_console/patches/railtie.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 Dir[File.join(__dir__, 'railtie', '*.rb')].each { |file| require file }

data/lib/safer_rails_console/patches/railtie/sandbox.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SaferRailsConsole
   module Patches
     module Sandbox
@@ -6,8 +8,15 @@ module SaferRailsConsole
           def start(*args)
             options = args.last
 
-            options[:sandbox] = SaferRailsConsole.sandbox_environment? if options[:sandbox].nil?
-            options[:sandbox] = SaferRailsConsole::Console.sandbox_user_prompt if SaferRailsConsole.sandbox_environment? && SaferRailsConsole.config.sandbox_prompt
+            if options[:sandbox].nil?
+              options[:sandbox] = if options[:'read-only']
+                                    true
+                                  elsif options[:writable]
+                                    false
+                                  else
+                                    SaferRailsConsole.sandbox_environment? && SaferRailsConsole.config.sandbox_prompt ? SaferRailsConsole::Console.sandbox_user_prompt : SaferRailsConsole.sandbox_environment?
+                                  end
+            end
 
             super *args
           end
@@ -18,7 +27,7 @@ module SaferRailsConsole
 end
 
 if SaferRailsConsole::RailsVersion.supported?
-  if SaferRailsConsole::RailsVersion.five_one?
+  if SaferRailsConsole::RailsVersion.five_one_or_above?
     require 'rails/commands/console/console_command'
   else
     require 'rails/commands/console'

data/lib/safer_rails_console/patches/sandbox.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 Dir[File.join(__dir__, 'sandbox', '*.rb')].each { |file| require file }

data/lib/safer_rails_console/patches/sandbox/auto_rollback.rb

@@ -1,46 +1,34 @@
+# frozen_string_literal: true
+
 module SaferRailsConsole
   module Patches
     module Sandbox
       module AutoRollback
+        extend SaferRailsConsole::Colors
+
         def self.rollback_and_begin_new_transaction
           connection = ::ActiveRecord::Base.connection
           connection.rollback_db_transaction
           connection.begin_db_transaction
         end
 
-        module ActiveRecord
-          module ConnectionAdapters
-            module PostgreSQLAdapter41
-              def exec_no_cache(sql, name, binds)
-                super
-              rescue => e
-                SaferRailsConsole::Patches::Sandbox::AutoRollback.rollback_and_begin_new_transaction
-                raise e
-              end
-
-              def exec_cache(sql, name, binds)
-                super
-              rescue => e
-                SaferRailsConsole::Patches::Sandbox::AutoRollback.rollback_and_begin_new_transaction
-                raise e
-              end
-            end
+        def self.handle_and_reraise_exception(e)
+          if e.message.include?('PG::ReadOnlySqlTransaction')
+            puts color_text('An operation could not be completed due to read-only mode.', RED) # rubocop:disable Rails/Output
+          else
+            rollback_and_begin_new_transaction
+          end
 
-            module PostgreSQLAdapter42
-              def execute_and_clear(sql, name, binds)
-                super
-              rescue => e
-                SaferRailsConsole::Patches::Sandbox::AutoRollback.rollback_and_begin_new_transaction
-                raise e
-              end
-            end
+          raise e
+        end
 
+        module ActiveRecord
+          module ConnectionAdapters
             module PostgreSQLAdapter5
               def execute_and_clear(sql, name, binds, prepare: false)
                 super
               rescue => e
-                SaferRailsConsole::Patches::Sandbox::AutoRollback.rollback_and_begin_new_transaction
-                raise e
+                SaferRailsConsole::Patches::Sandbox::AutoRollback.handle_and_reraise_exception(e)
               end
             end
           end
@@ -51,11 +39,5 @@ module SaferRailsConsole
 end
 
 if defined?(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
-  if SaferRailsConsole::RailsVersion.four_one?
-    ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(SaferRailsConsole::Patches::Sandbox::AutoRollback::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter41)
-  elsif SaferRailsConsole::RailsVersion.four_two?
-    ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(SaferRailsConsole::Patches::Sandbox::AutoRollback::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter42)
-  else
-    ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(SaferRailsConsole::Patches::Sandbox::AutoRollback::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter5)
-  end
+  ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(SaferRailsConsole::Patches::Sandbox::AutoRollback::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter5)
 end

data/lib/safer_rails_console/patches/sandbox/transaction_read_only.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SaferRailsConsole
+  module Patches
+    module Sandbox
+      module TransactionReadOnly
+        module ActiveRecord
+          module ConnectionAdapters
+            module PostgreSQLAdapter
+              def begin_db_transaction
+                super
+                execute 'SET TRANSACTION READ ONLY'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+if defined?(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+  ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend(SaferRailsConsole::Patches::Sandbox::TransactionReadOnly::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter)
+
+  # Ensure transaction is read-only if it was began before this patch was loaded
+  connection = ::ActiveRecord::Base.connection
+  connection.execute 'SET TRANSACTION READ ONLY' if connection.open_transactions > 0
+end

data/lib/safer_rails_console/rails_version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails'
 
 module SaferRailsConsole
@@ -6,17 +8,7 @@ module SaferRailsConsole
 
     class << self
       def supported?
-        four_one? || four_two? || five_zero? || five_one?
-      end
-
-      def four_one?
-        @is_four_one = Gem::Requirement.new('~> 4.1.0').satisfied_by?(SaferRailsConsole::RailsVersion::RAILS_VERSION) if @is_four_one.nil?
-        @is_four_one
-      end
-
-      def four_two?
-        @is_four_two = Gem::Requirement.new('~> 4.2.0').satisfied_by?(SaferRailsConsole::RailsVersion::RAILS_VERSION) if @is_four_two.nil?
-        @is_four_two
+        five_zero? || five_one? || five_two? || six_or_above?
       end
 
       def five_zero?
@@ -28,6 +20,26 @@ module SaferRailsConsole
         @is_five_one = Gem::Requirement.new('~> 5.1.0').satisfied_by?(SaferRailsConsole::RailsVersion::RAILS_VERSION) if @is_five_one.nil?
         @is_five_one
       end
+
+      def five_one_or_above?
+        @is_five_one_or_above = SaferRailsConsole::RailsVersion::RAILS_VERSION >= ::Gem::Version.new('5.1.0') if @is_five_one_or_above.nil?
+        @is_five_one_or_above
+      end
+
+      def five_two?
+        @is_five_two = Gem::Requirement.new('~> 5.2.0').satisfied_by?(SaferRailsConsole::RailsVersion::RAILS_VERSION) if @is_five_two.nil?
+        @is_five_two
+      end
+
+      def six_zero?
+        @is_six_zero = Gem::Requirement.new('~> 6.0.0').satisfied_by?(SaferRailsConsole::RailsVersion::RAILS_VERSION) if @is_six_zero.nil?
+        @is_six_zero
+      end
+
+      def six_or_above?
+        @is_six_or_above = SaferRailsConsole::RailsVersion::RAILS_VERSION >= ::Gem::Version.new('6.0.0') if @is_six_or_above.nil?
+        @is_six_or_above
+      end
     end
   end
 end

data/lib/safer_rails_console/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'safer_rails_console'
 

data/lib/safer_rails_console/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SaferRailsConsole
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.5.0'
 end

data/safer_rails_console.gemspec

@@ -1,4 +1,5 @@
 # coding: utf-8
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -31,14 +32,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'appraisal', '~> 2.2'
-  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'climate_control', '~> 0.2.0'
   spec.add_development_dependency 'mixlib-shellout', '~> 2.2'
   spec.add_development_dependency 'overcommit', '~> 0.39.0'
-  spec.add_development_dependency 'pg', '~> 0.21'
+  spec.add_development_dependency 'pg', '~> 1.1'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.6'
+  spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'salsify_rubocop', '~> 0.48.0'
-  spec.add_development_dependency 'sqlite3', '~> 1.3'
-  spec.add_development_dependency 'wwtd', '~> 1.3'
-  spec.add_runtime_dependency 'rails', '>= 4.1', '< 5.2'
+
+  spec.add_runtime_dependency 'rails', '>= 5.0', '< 6.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: safer_rails_console
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Salsify, Inc
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-08-15 00:00:00.000000000 Z
+date: 2020-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: climate_control
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,67 +123,53 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.6'
 - !ruby/object:Gem::Dependency
-  name: salsify_rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.48.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.48.0
-- !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: wwtd
+  name: salsify_rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 0.48.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 0.48.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '5.0'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.2'
 description: This gem makes Rails console sessions less dangerous in specified environments
   by warning, color-coding, auto-sandboxing, and allowing read-only external connections
   (disables job queueing, non-GET requests, etc.)
@@ -179,11 +179,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".overcommit.yml"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -192,10 +192,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/4.1.gemfile
-- gemfiles/4.2.gemfile
 - gemfiles/5.0.gemfile
 - gemfiles/5.1.gemfile
+- gemfiles/5.2.gemfile
+- gemfiles/6.0.gemfile
+- gemfiles/6.1.gemfile
 - lib/safer_rails_console.rb
 - lib/safer_rails_console/colors.rb
 - lib/safer_rails_console/console.rb
@@ -206,6 +207,7 @@ files:
 - lib/safer_rails_console/patches/railtie/sandbox.rb
 - lib/safer_rails_console/patches/sandbox.rb
 - lib/safer_rails_console/patches/sandbox/auto_rollback.rb
+- lib/safer_rails_console/patches/sandbox/transaction_read_only.rb
 - lib/safer_rails_console/rails_version.rb
 - lib/safer_rails_console/railtie.rb
 - lib/safer_rails_console/version.rb
@@ -215,7 +217,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -230,9 +232,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Make rails console less dangerous!
 test_files: []

data/.travis.yml

@@ -1,37 +0,0 @@
-language: ruby
-sudo: false
-
-services:
-  - postgresql
-
-bundler_args: --without test --jobs 3 --retry 3
-before_install:
-  - gem install bundler
-
-before_script:
-  - cp spec/internal/database.yml.travis spec/internal/rails_4_1/config/database.yml
-  - cp spec/internal/database.yml.travis spec/internal/rails_4_2/config/database.yml
-  - cp spec/internal/database.yml.travis spec/internal/rails_5_0/config/database.yml
-  - cp spec/internal/database.yml.travis spec/internal/rails_5_1/config/database.yml
-
-script:
-  - bundle exec rubocop
-  - bundle exec rspec
-
-rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
-
-gemfile:
-  - gemfiles/4.1.gemfile
-  - gemfiles/4.2.gemfile
-  - gemfiles/5.0.gemfile
-  - gemfiles/5.1.gemfile
-
-matrix:
-  allow_failures:
-    - gemfile: gemfiles/4.1.gemfile
-      rvm: 2.4.1
-
-  fast_finish: true