sudo_rails 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ed6d190a51d927747f58d7ce61af01b6dd8ab0edff663969773ebbbebd21b37
-  data.tar.gz: 85f9dc0920bdc8226b36053b06c4304b45b55f90a4735b22faed4334a7a87ad1
+  metadata.gz: 13a5abdefd6191deed91535f4401bf0def14a6e502b6d4b191d7129e7fb2c754
+  data.tar.gz: 1166792b0ff651665d8dba513e56af064decf4b97c6d68c5302eddc3a194ac04
 SHA512:
-  metadata.gz: ef19bd450721d754b582ebe425dcdf30e91758089593743ed16fadd2400ac4cb2e898e336000a840fed37ac69124138cf5105953ff2342cdf3b37b45c6295196
-  data.tar.gz: 76a63a6de298a85130286495533149325a752c772bcf0a4d3d33ccb20e9645563397c9dca75f0c9174f46e9924b02d58b89a4de5919067ffd2f00cd2cd540bf7
+  metadata.gz: cb284469c871a0f3bd17213d2c316835b4a1c3ea2ed82d3fda416066e1a89128f0d2b0c4848b3068eb1298109993ece6fec8941b119ca8cb1cf591d32998d2c8
+  data.tar.gz: 6154b8cdda0c06b4c6afc7d19d751131fb1cfe33d93e6e090afd8f8070c52197c62d0f65d0928001281f5f489d6965dd9c2f229232308ae1d297af378ab3821a

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2019-2020 Marc Anguera Insa @markets
+Copyright 2019 Marc Anguera Insa @markets
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,7 +1,7 @@
 # Sudo Rails
 
 [![Gem](https://img.shields.io/gem/v/sudo_rails.svg?style=flat-square)](https://rubygems.org/gems/sudo_rails)
-[![Build Status](https://travis-ci.com/markets/sudo_rails.svg?branch=master)](https://travis-ci.com/markets/sudo_rails)
+[![Build Status](https://github.com/markets/sudo_rails/workflows/CI/badge.svg)](https://github.com/markets/sudo_rails/actions)
 [![Maintainability](https://api.codeclimate.com/v1/badges/322350adc7ab052beccb/maintainability)](https://codeclimate.com/github/markets/sudo_rails/maintainability)
 
 > Sudo mode for your Rails controllers
@@ -16,6 +16,8 @@ end
 
 *Inspired by [Unix `sudo` command](https://en.wikipedia.org/wiki/Sudo) and [GitHub Sudo mode](https://help.github.com/en/articles/sudo-mode).*
 
+![](support/images/cover.png)
+
 ## Installation
 
 Add this line to your Gemfile and then execute `bundle install`:
@@ -55,9 +57,9 @@ SudoRails.setup do |config|
   config.sudo_session_duration = 10.minutes
 
   # Confirmation page styling
-  config.custom_logo = 'logos/medium_dark.png'
-  config.primary_color = '#1A7191'
-  config.background_color = '#1A7191'
+  config.custom_logo = '/images/logo_medium.png'
+  config.primary_color = '#1a7191'
+  config.background_color = '#1a1a1a'
   config.layout = 'admin'
 
   # Confirmation strategy implementation
@@ -71,6 +73,8 @@ SudoRails.setup do |config|
 end
 ```
 
+Use the provided `sudo_rails:config` generator to create a default config file under your *initializers* folder.
+
 ### Sudo sessions
 
 Using the `sudo_session_duration` option you are able to configure the `sudo` session duration (30 minutes by default).
@@ -81,9 +85,11 @@ If you set it to `nil`, your `sudo` session won't expire automatically and you w
 
 Using the `custom_logo`, `primary_color` and `background_color` options, you can customize the confirmation page. In case you want full control of the styles, you can use your own layout (and consequently your own styles too) using the `layout` option.
 
-See some [examples here](support/images/).
+See some :camera: [examples here](support/images/examples/).
 
-**NOTE** If you are using your own layout, don't forget to render the flash messages in that layout. You can do something like [this](app/views/sudo_rails/_flash_alert.html.erb).
+> ℹ️ If you are using your own layout, don't forget to render the flash messages in that layout. You can do something [like this](app/views/sudo_rails/_flash_alert.html.erb).
+
+You can also override the view by calling the `sudo_rails:view` generator. This will create a copy of the view file at `app/views/sudo_rails/confirm_form.html.erb` which can be later modified as per your requirements.
 
 ### Confirmation strategy
 
@@ -91,6 +97,8 @@ You should define how to validate the password using the `confirm_strategy` opti
 
 By default, the gem ships with `Devise` and `Clearance` integration. Check it [here](lib/sudo_rails/integrations/).
 
+> ℹ️ In order to autoload `Devise` or `Clearance` strategy properly, you should place the `sudo_rails` gem after them in the Gemfile.
+
 Implementation examples:
 
 ```ruby

data/Rakefile

@@ -1,6 +1 @@
 require "bundler/gem_tasks"
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/app/views/layouts/sudo_rails/application.html.erb

@@ -3,8 +3,7 @@
 <head>
   <title><%= t('sudo_rails.page_header') %></title>
   <%= csrf_meta_tags %>
-  <%= stylesheet_link_tag "sudo_rails/application", media: "all" %>
-  <%= render 'sudo_rails/inject_custom_styles' if SudoRails.custom_styles? %>
+  <%= render 'sudo_rails/stylesheet' %>
 </head>
 <body>
   <%= render 'sudo_rails/flash_alert' %>

data/app/views/sudo_rails/_stylesheet.html.erb

@@ -0,0 +1,93 @@
+<style type="text/css">
+  body {
+    text-align: center;
+    font-family: Helvetica, Arial, sans-serif;
+    background-color: #ececec;
+    margin: 0 auto;
+  }
+
+  a {
+    color: #000;
+  }
+
+  input {
+    -webkit-appearance: none;
+  }
+
+  .sudo-container {
+    transform: translateY(25%);
+  }
+
+  .sudo-header {
+    margin: 2em auto;
+  }
+
+  .sudo-header img {
+    margin-top: -60px;
+    max-width: 280px;
+  }
+
+  .sudo-form {
+    background-color: #fff;
+    border-radius: 5px;
+    padding: 2em;
+    margin: 0 auto;
+    max-width: 340px;
+    box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.2);
+  }
+
+  .sudo-form input {
+    display: block;
+    width: 100%;
+    font-size: 16px;
+    line-height: 2em;
+    padding: 4px;
+    border-radius: 5px;
+    border: 1px solid #ececec;
+  }
+
+  .sudo-form input[type="submit"] {
+    cursor: pointer;
+    margin: 1em auto;
+    width: 60%;
+    padding: 4px;
+    background-color: #ececec;
+    border-radius: 25px;
+    border: none;
+  }
+
+  .sudo-tip {
+    margin-top: 2em;
+    font-size: 14px;
+  }
+
+  .sudo-alert {
+    background: #000;
+    color: #fff;
+    padding: 10px;
+    font-weight: bold;
+  }
+
+  <% if SudoRails.background_color.present? %>
+    body {
+      background-color: <%= SudoRails.background_color %>;
+      color: <%= SudoRails.color_contrast(SudoRails.background_color) %>;
+    }
+
+    .sudo-alert {
+      background-color: <%= SudoRails.color_contrast(SudoRails.background_color) %>;
+      color: <%= SudoRails.background_color %>;
+    }
+  <% end %>
+
+  <% if SudoRails.primary_color.present? %>
+    a {
+      color: <%= SudoRails.primary_color %>;
+    }
+
+    .sudo-form input[type="submit"] {
+      background-color: <%= SudoRails.primary_color %>;
+      color: <%= SudoRails.color_contrast(SudoRails.primary_color) %>;
+    }
+  <% end %>
+</style>

data/app/views/sudo_rails/confirm_form.html.erb

@@ -1,13 +1,13 @@
 <div class='sudo-header'>
   <% if SudoRails.custom_logo %>
-    <%= image_tag SudoRails.custom_logo %>
+    <img src="<%= SudoRails.custom_logo %>">
   <% end %>
 
   <h2><%= t('sudo_rails.page_header') %></h2>
 </div>
 
 <div class='sudo-form'>
-  <%= form_tag '/sudo_rails/confirm' do |f| %>
+  <%= form_tag sudo_rails_confirm_path do |f| %>
     <%= hidden_field_tag :locale, I18n.locale %>
     <%= hidden_field_tag :target_path, params[:target_path] || request.url %>
     <%= password_field_tag :password, nil, required: true, placeholder: t('sudo_rails.password') %>

data/lib/generators/sudo_rails/config_generator.rb

@@ -0,0 +1,28 @@
+class SudoRails::ConfigGenerator < Rails::Generators::Base
+  def create_config_file
+    create_file "config/initializers/sudo_rails.rb", <<~RUBY
+      SudoRails.setup do |config|
+        ### On/off engine
+        # config.enabled = true
+
+        ### Sudo mode sessions duration, default is 30 minutes
+        # config.sudo_session_duration = 10.minutes
+
+        ### Confirmation page styling
+        # config.custom_logo = '/images/logo_medium.png'
+        # config.primary_color = '#1a7191'
+        # config.background_color = '#1a1a1a'
+        # config.layout = 'admin'
+
+        ### Confirmation strategy implementation
+        # config.confirm_strategy = -> (context, password) {
+        #   user = context.current_user
+        #   user.valid_password?(password)
+        # }
+
+        ### Reset password link
+        # config.reset_pass_link = '/users/password/new'
+      end
+    RUBY
+  end
+end

data/lib/generators/sudo_rails/view_generator.rb

@@ -0,0 +1,7 @@
+class SudoRails::ViewGenerator < Rails::Generators::Base
+  source_root File.expand_path("../../../app/views/sudo_rails/", __dir__)
+
+  def copy_view_file
+    copy_file "confirm_form.html.erb", "app/views/sudo_rails/confirm_form.html.erb"
+  end
+end

data/lib/sudo_rails/engine.rb

@@ -3,19 +3,15 @@ module SudoRails
     isolate_namespace SudoRails
 
     initializer "sudo_rails.controller_ext" do
-      ActiveSupport.on_load(:action_controller) do
+      ActiveSupport.on_load(:action_controller_base) do
         include SudoRails::ControllerExt
       end
     end
 
     initializer 'sudo_rails.routes' do |app|
       app.routes.append do
-        post '/sudo_rails/confirm' => 'sudo_rails/application#confirm'
+        post '/sudo_rails/confirm' => 'sudo_rails/application#confirm', as: :sudo_rails_confirm
       end
     end
-
-    config.assets.precompile << %w(
-      sudo_rails/application.css
-    )
   end
 end

data/lib/sudo_rails/styling.rb

@@ -4,15 +4,10 @@ module SudoRails
       SudoRails.layout || 'sudo_rails/application'
     end
 
-    def custom_styles?
-      SudoRails.primary_color.present? || SudoRails.background_color.present?
-    end
-
-    # Ref: https://gist.github.com/charliepark/480358
     def color_contrast(hex_color)
       return nil unless hex_color.include?('#')
 
-      hex_color.delete('#').scan(/../).sum { |color| color.hex } > 382.5 ? '#000' : '#FFF'
+      hex_color.delete('#').scan(/../).sum { |color| color.hex } > 382.5 ? '#000' : '#fff'
     end
   end
 end

data/lib/sudo_rails/version.rb

@@ -1,3 +1,3 @@
 module SudoRails
-  VERSION = "0.6.1"
+  VERSION = "0.8.0"
 end

data/lib/sudo_rails.rb

@@ -2,7 +2,6 @@ require "sudo_rails/version"
 require "sudo_rails/controller_ext"
 require "sudo_rails/styling"
 require "sudo_rails/engine"
-require "sassc-rails"
 
 module SudoRails
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sudo_rails
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - markets
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-14 00:00:00.000000000 Z
+date: 2024-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-- !ruby/object:Gem::Dependency
-  name: sassc-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -62,13 +48,14 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- app/assets/stylesheets/sudo_rails/application.scss
 - app/controllers/sudo_rails/application_controller.rb
 - app/views/layouts/sudo_rails/application.html.erb
 - app/views/sudo_rails/_flash_alert.html.erb
-- app/views/sudo_rails/_inject_custom_styles.html.erb
+- app/views/sudo_rails/_stylesheet.html.erb
 - app/views/sudo_rails/confirm_form.html.erb
 - config/locales/en.yml
+- lib/generators/sudo_rails/config_generator.rb
+- lib/generators/sudo_rails/view_generator.rb
 - lib/sudo_rails.rb
 - lib/sudo_rails/controller_ext.rb
 - lib/sudo_rails/engine.rb
@@ -80,7 +67,7 @@ homepage: https://github.com/markets/sudo_rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: Sudo mode for Rails
 test_files: []

data/app/assets/stylesheets/sudo_rails/application.scss

@@ -1,68 +0,0 @@
-body {
-  text-align: center;
-  font-family: Helvetica, Arial, sans-serif;
-  background-color: #ececec;
-  margin: 0 auto;
-}
-
-a {
-  color: #000;
-}
-
-input {
-  -webkit-appearance: none;
-}
-
-.sudo-container {
-  transform: translateY(25%);
-}
-
-.sudo-header {
-  margin: 2em auto;
-
-  img {
-    margin-top: -60px;
-    max-width: 280px;
-  }
-}
-
-.sudo-form {
-  background-color: #fff;
-  border-radius: 5px;
-  padding: 2em;
-  margin: 0 auto;
-  max-width: 340px;
-  box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.2), 0 6px 20px 0 rgba(0, 0, 0, 0.2);
-
-  input {
-    display: block;
-    width: 100%;
-    font-size: 16px;
-    line-height: 2em;
-    padding: 4px;
-    border-radius: 5px;
-    border: 1px solid #ececec;
-  }
-
-  input[type="submit"] {
-    cursor: pointer;
-    margin: 1em auto;
-    width: 60%;
-    padding: 4px;
-    background-color: #ececec;
-    border-radius: 25px;
-    border: none;
-  }
-}
-
-.sudo-tip {
-  margin-top: 2em;
-  font-size: 14px;
-}
-
-.sudo-alert {
-  background: #000;
-  color: #fff;
-  padding: 10px;
-  font-weight: bold;
-}

data/app/views/sudo_rails/_inject_custom_styles.html.erb

@@ -1,24 +0,0 @@
-<style type="text/css">
-  <% if SudoRails.background_color.present? %>
-    body {
-      background-color: <%= SudoRails.background_color %>;
-      color: <%= SudoRails.color_contrast(SudoRails.background_color) %>;
-    }
-
-    .sudo-alert {
-      background-color: <%= SudoRails.color_contrast(SudoRails.background_color) %>;
-      color: <%= SudoRails.background_color %>;
-    }
-  <% end %>
-
-  <% if SudoRails.primary_color.present? %>
-    a {
-      color: <%= SudoRails.primary_color %>;
-    }
-
-    .sudo-form input[type="submit"] {
-      background-color: <%= SudoRails.primary_color %>;
-      color: <%= SudoRails.color_contrast(SudoRails.primary_color) %>;
-    }
-  <% end %>
-</style>