safer_rails_console 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdf260deb3867b5bed0d92646aa88de6f64afd03
-  data.tar.gz: 3cbaac5740f226b7a0364168f4ab137d080fe1ec
+  metadata.gz: fdba797ed52f07225b6f16b76e99a9dac4731b4b
+  data.tar.gz: 7ecdb4551bb8c70d3d01d7aa964198cb667ed852
 SHA512:
-  metadata.gz: 470e4da18f0fe1ad4e10df31ae6189f66c7ee58f66389bc8bc3c6d0224f6f8c816dec8d7b94001b22911778bc595a6da7e0de0e3a360c348e29b56de64f7638f
-  data.tar.gz: a3afb5cc08b8a001879271c7f86b4c78dc5b6cb13d97f2a7602f4ab3ebe96437cc9fb0d22c33ef872fbf9d9daa85e5bd7cc44c43b2e679d2baab112be7c8ef5d
+  metadata.gz: c792c0b4684d712180eb6a963144faf05a68a28bc9565725b71987f17c8bff788362f839219faf2945952fcb025ac4ee9d76287cd0eff660882617b8c798020d
+  data.tar.gz: 5cda5a4537478ab21d1cbce6629e081e33864d650a9eb56c932c50c7e673efce188c114f6447c71c67041901d14159f4534f46005938f3b483b8551cbecb7787

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## [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:**
+
+- 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)
 

data/README.md

@@ -27,11 +27,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.

data/lib/safer_rails_console/consoles/irb.rb

@@ -2,7 +2,7 @@ include SaferRailsConsole::Colors
 
 app_name = ::Rails.application.class.parent.to_s.underscore.dasherize
 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"

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

@@ -4,6 +4,16 @@ module SaferRailsConsole
   module Patches
     module Boot
       module SandboxFlag
+        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 CommandsTasks4
             def console
@@ -18,11 +28,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.on('--debugger', 'Enable the debugger.') { |v| options[:debugger] = v }
                 opt.parse!(arguments)
               end
@@ -53,11 +59,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
 
@@ -83,6 +85,8 @@ elsif SaferRailsConsole::RailsVersion.five_one?
   ::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/sandbox.rb

@@ -6,8 +6,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

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

@@ -2,27 +2,37 @@ 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
 
+        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
+
+          raise e
+        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
+                SaferRailsConsole::Patches::Sandbox::AutoRollback.handle_and_reraise_exception(e)
               end
 
               def exec_cache(sql, name, binds)
                 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
 
@@ -30,8 +40,7 @@ module SaferRailsConsole
               def execute_and_clear(sql, name, binds)
                 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
 
@@ -39,8 +48,7 @@ module SaferRailsConsole
               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

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

@@ -0,0 +1,26 @@
+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/version.rb

@@ -1,3 +1,3 @@
 module SaferRailsConsole
-  VERSION = '0.1.4'.freeze
+  VERSION = '0.2.0'.freeze
 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.2.0
 platform: ruby
 authors:
 - Salsify, Inc
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-15 00:00:00.000000000 Z
+date: 2017-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -206,6 +206,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