ns_settings_ui 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0c8f0d504ffd79a96f754d7250f311debf3a21ba
-  data.tar.gz: 64d114977ab0b97f8a230909ad337a6959aeb34e
+SHA256:
+  metadata.gz: def0eda93467645d2ae26f90946570733724636d514671634f0cb5d501ee6adb
+  data.tar.gz: 4fdd67d552b4e26777432af353e543f3ecd7fc04b300bb1d00602cd85653118e
 SHA512:
-  metadata.gz: a2846da77bb4edc91073591157f7f0729402e940e1f8f7db1c88904935463b49f1d3a15f0f5d89aef74a15ba242cd26e94c12ebc7f96ed8075d00f8127ba01f8
-  data.tar.gz: 96fe0ae18814b4709120436d00b0ec0da259f3ccd3dcd27600423de63bc08f07f8cb090e064c32276c7860a173d1648d98520a9f9758eafb2ff2dae9bc290dca
+  metadata.gz: de0094fefc6946fa3384af40f80956d73652ec3d7cb1140424ca80ddd5f14d2376cd5156183be645711732c0f7f562bb812c8a278442be8b2651a75225b56c9a
+  data.tar.gz: d078810ec119d6beb487b9c765f5bc02cae1e22493708ee3e87cba15d88ec7dd8677dde2a4f79396cd2fbc90c9a498f307c90ba5128e1830ff9fbe2aea2da337

data/.gitignore

@@ -15,3 +15,4 @@ gemfiles/*.gemfile.lock
 .[#]*
 spec/reports
 
+.idea/

data/Appraisals

@@ -1,6 +1,11 @@
-[5.0, 4.2].each do |version|
+[5.0, 5.1, 5.2].each do |version|
   appraise "rails_#{version}" do
     gem 'rails', "~> #{version}.0"
-    gem 'rails-controller-testing' if version == 5.0
+    gem "sqlite3", "~> 1.3.0"
   end
 end
+
+appraise "rails_6.0" do
+  gem 'rails', "~> 6.0.3"
+  gem "sqlite3", "~> 1.4.0"
+end

data/Gemfile

@@ -13,4 +13,5 @@ gemspec
 # To use debugger
 # gem 'debugger'
 
-gem 'rails', '~> 4.2'
+gem 'rails', '>= 5.0'
+gem "sprockets", "~> 3.7.2"

data/Jenkinsfile

@@ -33,8 +33,8 @@ def appNode(String rubyVersion) {
     }
 }
 
-appNode('ruby-2.2')
-appNode('ruby-2.3')
+appNode('ruby-2.5')
+appNode('ruby-2.6')
 
 def setupGemsDockerVolume(String rubyVersion, String executorNumber) {
     stage name: "$rubyVersion - Setup Docker Volume", concurrency: 1
@@ -44,8 +44,8 @@ def setupGemsDockerVolume(String rubyVersion, String executorNumber) {
 def resolveDependencies(me.knapik.DockerCompose compose, String rubyVersion) {
     stage "$rubyVersion - Resolve Dependencies"
     compose.exec('app', "bundle install --quiet")
-    compose.exec('app', "appraisal install")
-    compose.exec('app', "appraisal list > .rails_versions")
+    compose.exec('app', "bundle exec appraisal install")
+    compose.exec('app', "bundle exec appraisal list > .rails_versions")
 }
 
 def test(me.knapik.DockerCompose compose, String rubyVersion) {
@@ -53,15 +53,8 @@ def test(me.knapik.DockerCompose compose, String rubyVersion) {
     for (int i = 0; i < railsVersions.size(); ++i) {
         def railsVersion = railsVersions[i]
         stage "$rubyVersion $railsVersion - Tests"
-        try {
-            if(railsVersion >= 'rails_5.0') {
-                compose.exec('app', "appraisal $railsVersion rails app:db:environment:set RAILS_ENV=development")
-            }
-            compose.exec('app', "appraisal $railsVersion bundle exec rake app:db:schema:load")
-            compose.exec('app', "appraisal $railsVersion bundle exec rake app:ci:setup:rspec spec")
-        } finally {
-            publishTestResults()
-        }
+        compose.exec('app', "bundle exec appraisal $railsVersion rake db:schema:load")
+        compose.exec('app', "bundle exec appraisal $railsVersion rspec spec")
     }
 }
 
@@ -74,10 +67,6 @@ def checkstyle(me.knapik.DockerCompose compose, String rubyVersion) {
     }
 }
 
-def publishTestResults() {
-    step([$class: 'JUnitResultArchiver', testResults: 'spec/reports/*.xml,test/reports/*.xml'])
-}
-
 def publishStyleCheckResults() {
     step([$class: 'CheckStylePublisher', pattern: 'checkstyle.xml'])
 }

data/README.md

@@ -39,21 +39,28 @@ You can modify NsSettingsUi variables in order to:
 * `NsSettingsUi.layout` - set a layout from your application
 * `NsSettingsUi.parent_controller` - choose a controller that NsSettingUi controllers will inherit from
 
+## Rails support
+Rails 4.2 since ver 1.1, dropped in 1.5
+Rails 5.0 since ver 1.2
+Rails 5.2 since ver 1.5
+Rails 6.0 since ver 1.6
+
 ## Testing
-This engine is used by NTTR and socialguide. Upto version 1.1 it support Rails 3.2 and 4.2. Since version 1.2 it support Rails 4.2 and 5.0.
+This engine is used by NTTR and socialguide.
+
 It uses [Appraisal](https://github.com/thoughtbot/appraisal) gem with a set up similar to [permitters gem](https://github.com/permitters/permitters) to give you an easy way of testing the code under multiple Rails versions.
 
 To bundle install for each appraisal defined:
 
-`appraisal install`
+`bundle appraisal install`
 
 And then to run specs for all the appraisals:
 
-`appraisal bundle exec rspec spec`
+`bundle exec appraisal rspec spec`
 
 Or a specific one:
 
-`appraisal rails_4.2 bundle exec rspec spec`
+`bundle exec appraisal rails_5.0 rspec spec`
 
 ## Contributing
 

data/app/assets/stylesheets/ns_settings_ui/settings.css.scss

@@ -9,13 +9,9 @@
   form {
     display: inline;
   }
-  input[type=text] {
+  input[type=text], select {
     width: 130px;
-    display: inline;
-  }
-  table {
-    td {
-      padding: 2px;
-    }
+    display: inline-block;
+    flex: none;
   }
 }

data/app/controllers/ns_settings_ui/settings_controller.rb

@@ -1,16 +1,14 @@
 module NsSettingsUi
   class SettingsController < NsSettingsUi::ApplicationController
     layout NsSettingsUi.layout
-    before_filter :setting_from_id_param, only: [:update, :reset]
+    before_action :setting_from_id_param, only: [:update, :reset]
 
     def index
-      @settings = Setting.order('`key`').all
+      @settings = Setting.order(Arel.sql('`key`')).all
     end
 
     def update
-      @setting.value = params[:setting][:value]
-      @setting.default_value = params[:setting][:default_value]
-      @setting.save!
+      @setting.update!(setting_params)
       render partial: 'update'
     end
 
@@ -25,5 +23,9 @@ module NsSettingsUi
     def setting_from_id_param
       @setting = Setting.find(params[:id])
     end
+
+    def setting_params
+      params.require(:setting).permit(:value, :default_value)
+    end
   end
 end

data/app/helpers/ns_settings_ui/settings_helper.rb

@@ -18,9 +18,9 @@ module NsSettingsUi
 
     def render_field(form, value_type, name, additional_class = '')
       if [NsSettingsUi::Setting::TYPES[:boolean], NsSettingsUi::Setting::TYPES[:nullable_boolean]].include?(value_type)
-        form.select(name, [[:true, 'true'], [:false, 'false']], include_blank: true)
+        form.select(name, [[:true, 'true'], [:false, 'false']], {include_blank: true}, {class: "form-select form-select-sm"})
       else
-        form.text_field(name, size: 10, class: "form-control #{additional_class}")
+        form.text_field(name, size: 10, class: "form-control form-control-sm #{additional_class}")
       end
     end
 

data/app/views/ns_settings_ui/settings/_setting_row.html.erb

@@ -1,6 +1,18 @@
-<tr>
-  <td class="setting_key"><h5><%= setting.key -%></h5></td>
-  <td>
-    <%= render partial: 'edit', locals: {setting: setting} -%>
+<tr id="setting_<%= setting.id -%>">
+  <td class="setting_key align-middle"><%= setting.key -%></td>
+  <td class="text-center">
+    <%= form_for(setting, url: ns_settings_ui.setting_path(setting), method: :put, remote: true, html: {class: 'form-inline'}) do |f| %>
+      <%= render_default_value_field(f, setting) %>
+      <%= f.submit('Update', class: 'btn btn-sm btn-primary') %>
+    <% end %>
+  </td>
+  <td class="text-center">
+    <%= form_for(setting, url: ns_settings_ui.setting_path(setting), method: :put, remote: true, html: {class: 'form-inline'}) do |f| %>
+      <%= render_value_field(f, setting) %>
+      <%= f.submit('Update', class: 'btn btn-sm btn-primary') %>
+    <% end %>
+    <%= form_for(setting, url: ns_settings_ui.reset_setting_path(setting), method: :put, remote: true) do |f| %>
+      <%= f.submit('Reset', class: 'btn btn-sm btn-warning', title: 'Reset to default') %>
+    <% end %>
   </td>
 </tr>

data/app/views/ns_settings_ui/settings/_update.js.erb

@@ -1,3 +1,2 @@
-$("#ns_settings_ui #setting_<%= @setting.id -%>").replaceWith("<%= escape_javascript(render partial: 'edit', locals: {setting: @setting}) %>");
-$("#ns_settings_ui #setting_<%= @setting.id -%>").append('<span class="notice text-success">Updated</span>');
-$("#ns_settings_ui #setting_<%= @setting.id -%> .notice").delay(1000).fadeOut('slow');
+$("#ns_settings_ui #setting_<%= @setting.id -%>").replaceWith("<%= escape_javascript(render partial: 'setting_row', locals: {setting: @setting}) %>");
+$("#ns_settings_ui #setting_<%= @setting.id -%>").effect("highlight", {color: '#70ca63'}, 3000);

data/app/views/ns_settings_ui/settings/index.html.erb

@@ -3,14 +3,23 @@
     <%= javascript_include_tag 'ns_settings_ui/application' -%>
 <% end %>
 <div id="ns_settings_ui">
-  <div class="panel panel-default">
-    <div class="panel-heading">
-      <span>Filter: </span>
-      <input class="form-control" id="filter-input" type="text" value=""> (regular expressions are available)
-    </div>
-    <div class="panel-body">
-      <table class="table table-striped table-bordered">
-        <%= render partial: 'setting_row', collection: @settings, as: 'setting' -%>
+  <h1 class="text-white ps-1">Settings</h1>
+  <div class="card">
+    <div class="card-body">
+      <div class="input-group input-group-sm mb-2">
+        <span class="input-group-text">Filter: </span>
+        <input class="form-control form-control-sm" id="filter-input" type="text" value="">
+        <span class="form-text ms-2">(regular expressions are available)</span>
+      </div>
+      <table class="table table-sm table-striped">
+        <thead>
+          <th>Setting key</th>
+          <th class="text-center">Default value</th>
+          <th class="text-center">Current value</th>
+        </thead>
+        <tbody>
+          <%= render partial: 'setting_row', collection: @settings, as: 'setting' -%>
+        </tbody>
       </table>
     </div>
   </div>

data/db/migrate/20151210214903_create_ns_settings_ui_settings.rb

@@ -1,4 +1,4 @@
-class CreateNsSettingsUiSettings < ActiveRecord::Migration
+class CreateNsSettingsUiSettings < ActiveRecord::Migration[4.2]
   def up
     create_table :ns_settings_ui_settings do |t|
       t.string :key, null: false

data/db/migrate/20151215081718_add_value_type_to_ns_settings_ui_settings.rb

@@ -1,4 +1,4 @@
-class AddValueTypeToNsSettingsUiSettings < ActiveRecord::Migration
+class AddValueTypeToNsSettingsUiSettings < ActiveRecord::Migration[4.2]
   def change
     add_column :ns_settings_ui_settings, :value_type, :integer, default: 0
   end

data/docker/{ruby-2.3 → ruby-2.5}/Dockerfile

@@ -1,5 +1,5 @@
-FROM ruby:2.3
-MAINTAINER Michał Knapik <michal.knapik@u2i.com>
+FROM ruby:2.5
+MAINTAINER u2i <hello@u2i.com>
 
 RUN wget --quiet --output-document=dumb-init.deb \
       https://github.com/Yelp/dumb-init/releases/download/v1.1.3/dumb-init_1.1.3_amd64.deb && \

data/docker/{ruby-2.1 → ruby-2.6}/Dockerfile

@@ -1,5 +1,5 @@
-FROM ruby:2.1
-MAINTAINER Michał Knapik <michal.knapik@u2i.com>
+FROM ruby:2.6
+MAINTAINER u2i <hello@u2i.com>
 
 RUN wget --quiet --output-document=dumb-init.deb \
       https://github.com/Yelp/dumb-init/releases/download/v1.1.3/dumb-init_1.1.3_amd64.deb && \

data/gemfiles/rails_5.0.gemfile

@@ -3,7 +3,7 @@
 source "https://rubygems.org"
 
 gem "rails", "~> 5.0.0"
-gem "rails-controller-testing"
-gem "sass"
+gem "sprockets", "~> 3.7.2"
+gem "sqlite3", "~> 1.3.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.1.0"
+gem "sprockets", "~> 3.7.2"
+gem "sqlite3", "~> 1.3.0"
+
+gemspec path: "../"

data/gemfiles/rails_5.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 5.2.0"
+gem "sprockets", "~> 3.7.2"
+gem "sqlite3", "~> 1.3.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 6.0.3"
+gem "sprockets", "~> 3.7.2"
+gem "sqlite3", "~> 1.4.0"
+
+gemspec path: "../"

data/lib/ns_settings_ui/version.rb

@@ -1,3 +1,3 @@
 module NsSettingsUi
-  VERSION = '1.4.0'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/ns_settings_ui.gemspec

@@ -18,26 +18,25 @@ Gem::Specification.new do |s|
   s.files = `git ls-files -z`.split("\x0")
   s.test_files = Dir['spec/**/*']
 
-  s.add_dependency 'rails', '>= 4.2', '< 6'
+  s.add_dependency 'rails', '>= 5.0', '< 6.1'
 
-  s.add_development_dependency 'appraisal', '~> 2.1'
+  s.add_development_dependency 'appraisal', '~> 2.3'
   s.add_development_dependency 'sqlite3', '~> 1.3'
   s.add_development_dependency 'rspec', '~> 3.4'
-  s.add_development_dependency 'rspec-rails', '~> 3.4'
+  s.add_development_dependency 'rspec-rails', '~> 4.0'
   s.add_development_dependency 'rspec-its', '~> 1.2'
-  s.add_development_dependency 'machinist', '~> 2.0'
   s.add_development_dependency 'database_cleaner', '~> 1.5'
   s.add_development_dependency 'u2i-ci_utils', '~> 2.0'
-  s.add_development_dependency 'bundler', '~> 1.5'
-  s.add_development_dependency 'rake', '~> 11.1'
+  s.add_development_dependency 'bundler', '> 1.17'
+  s.add_development_dependency 'rake', '~> 12.3.3'
   s.add_development_dependency 'test-unit', '~> 3.1'
   s.add_development_dependency 'rubocop-rspec', '~> 1.4.0'
   s.add_development_dependency 'sass', '~> 3.4'
+  s.add_development_dependency 'rails-controller-testing'
 
   s.add_development_dependency 'guard', '~> 2.13'
   s.add_development_dependency 'guard-rspec', '~> 4.6'
   s.add_development_dependency 'guard-rubocop', '~> 1.2'
   s.add_development_dependency 'ruby_dep', '~> 1.3.1'
   s.add_development_dependency 'listen', '~> 3.0.0'
-  s.add_development_dependency 'pry-byebug', '~> 3.4.2'
 end

data/spec/controllers/ns_settings_ui/settings_controller_spec.rb

@@ -3,8 +3,13 @@ require 'spec_helper'
 RSpec.describe NsSettingsUi::SettingsController, type: :controller do
   routes { NsSettingsUi::Engine.routes }
 
+  def sample_setting(value: 0, default_value: 0)
+    key = Array('aa'..'zz').sample(2).join('.')
+    NsSettingsUi::Setting.create(key: key, value: value, default_value: default_value)
+  end
+
   describe 'GET index' do
-    let!(:settings) { Array.new(8) { NsSettingsUi::Setting.make! }.sort_by(&:key) }
+    let!(:settings) { Array.new(8) { sample_setting }.sort_by(&:key) }
     subject { get :index }
 
     it 'assigns all settings' do
@@ -14,7 +19,7 @@ RSpec.describe NsSettingsUi::SettingsController, type: :controller do
 
     context 'with views' do
       render_views
-      it { is_expected.to be_success }
+      it { is_expected.to be_successful }
     end
   end
 
@@ -24,7 +29,7 @@ RSpec.describe NsSettingsUi::SettingsController, type: :controller do
     end
 
     it 'responds with 200' do
-      expect(response).to be_success
+      expect(response).to be_successful
     end
 
     it 'sets flash message' do
@@ -33,9 +38,10 @@ RSpec.describe NsSettingsUi::SettingsController, type: :controller do
   end
 
   describe 'PUT reset' do
-    let(:setting) { NsSettingsUi::Setting.make!(value: 'a', default_value: 'b') }
+    let(:setting) { sample_setting(value: 'a', default_value: 'b') }
+    let(:params) { {id: setting.id, format: :js} }
 
-    before { get :reset, id: setting.id, format: :js }
+    before { get :reset, params: params }
 
     it 'resets setting value to the default value' do
       expect(assigns(:setting).value).to eq(setting.default_value)
@@ -45,17 +51,19 @@ RSpec.describe NsSettingsUi::SettingsController, type: :controller do
   end
 
   describe 'PUT update' do
-    let(:setting) { NsSettingsUi::Setting.make! }
-    let(:params) { {value: '5', default_value: '6', key: 'matching.cluster_size'} }
+    let(:setting) { sample_setting }
+    let(:setting_params) { {value: '5', default_value: '6', key: 'matching.cluster_size'} }
+    let(:params) { {id: setting.id, setting: setting_params, format: :js} }
+
 
-    before { put :update, id: setting.id, setting: params, format: :js }
+    before { put :update, params: params }
 
     it 'updates value' do
-      expect(assigns(:setting).value).to eq(params[:value])
+      expect(assigns(:setting).value).to eq(setting_params[:value])
     end
 
     it 'updates default value' do
-      expect(assigns(:setting).default_value).to eq(params[:default_value])
+      expect(assigns(:setting).default_value).to eq(setting_params[:default_value])
     end
 
     it 'does not update key' do

data/spec/dummy/db/schema.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -9,17 +8,18 @@
 # from scratch. The latter is a flawed and unsustainable approach (the more migrations
 # you'll amass, the slower it'll run and the greater likelihood for issues).
 #
-# It's strongly recommended to check this file into your version control system.
+# It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20151215081718) do
-  create_table 'ns_settings_ui_settings', force: true do |t|
-    t.string 'key', null: false
-    t.string 'value'
-    t.string 'default_value'
-    t.datetime 'created_at',                   null: false
-    t.datetime 'updated_at',                   null: false
-    t.integer 'value_type', default: 0
+ActiveRecord::Schema.define(version: 2015_12_15_081718) do
+
+  create_table "ns_settings_ui_settings", force: :cascade do |t|
+    t.string "key", null: false
+    t.string "value"
+    t.string "default_value"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+    t.integer "value_type", default: 0
+    t.index ["key"], name: "index_ns_settings_ui_settings_on_key"
   end
 
-  add_index 'ns_settings_ui_settings', ['key'], name: 'index_ns_settings_ui_settings_on_key'
 end