ns_settings_ui 1.1.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b8665dab191f28ece8eadccaead286f6fa658b79
-  data.tar.gz: 11e8c4de46aabde8b97c84a2c21866a2d53856ab
+SHA256:
+  metadata.gz: 02b49482fb2f7c31768dbe484b83e7fd0c781b28bd36fdf44bd9d143a8e7bb58
+  data.tar.gz: 47aebdc2fc7252481962e92310ff14c63f55d4b7830579748f213270ce2ad9a6
 SHA512:
-  metadata.gz: b1fe0313149eee0848529967798160389128c1e4712a7f001e20f00d18b74d7ccdbadd379e66f92ba122b625d233807f0437cfccb3c968fab68cd167eec6dad7
-  data.tar.gz: adec6c717e103a95ecd0d92a68683d8a0510b8e352dd7b82fae295315bdefc84a15b77814b7f964f21c8d18b1dd4d4afa932650aea621f316aca6e21416c8a93
+  metadata.gz: 95e9fcfbca788664f6c5cd8ca525379bd239add0daec59b25d6cda5550061f5232918391c503c3930d27327bf30f8b6289159c4bc8155d7715918bac08ba3936
+  data.tar.gz: ddc46185a5c57a8f7e04ce1ecc79cb63f379ce15e0c6efb6c4816b5231ad9b8de52a36d494f4e6e09f4b20c4b8c873e4859de1c88c60e022816c73631bdc8b64

data/Appraisals

@@ -1,4 +1,4 @@
-[5.0, 4.2, 3.2].each do |version|
+[5.0, 5.1, 5.2].each do |version|
   appraise "rails_#{version}" do
     gem 'rails', "~> #{version}.0"
   end

data/Gemfile

@@ -13,4 +13,5 @@ gemspec
 # To use debugger
 # gem 'debugger'
 
-gem 'rails', '~> 3.2' # assuming Rails 3.2 for jenkins jobs and top level rake tasks
+gem 'rails', '>= 5.0'
+gem "sprockets", "~> 3.7.2"

data/Jenkinsfile

@@ -33,9 +33,9 @@ def appNode(String rubyVersion) {
     }
 }
 
-appNode('ruby-2.1')
 appNode('ruby-2.2')
 appNode('ruby-2.3')
+appNode('ruby-2.5')
 
 def setupGemsDockerVolume(String rubyVersion, String executorNumber) {
     stage name: "$rubyVersion - Setup Docker Volume", concurrency: 1
@@ -45,16 +45,19 @@ 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', "bundle exec appraisal install")
+    compose.exec('app', "bundle exec appraisal list > .rails_versions")
 }
 
 def test(me.knapik.DockerCompose compose, String rubyVersion) {
-    stage "$rubyVersion - Tests"
-    try {
-        compose.exec('app', "bundle exec rake app:db:schema:load")
-        compose.exec('app', "bundle exec rake app:ci:setup:rspec spec")
-    } finally {
-        publishTestResults()
+    def railsVersions = readFile('.rails_versions').tokenize("\n")
+    for (int i = 0; i < railsVersions.size(); ++i) {
+        def railsVersion = railsVersions[i]
+        if(rubyVersion < 'ruby-2.5' && railsVersion >= 'rails_5.2')
+            continue
+        stage "$rubyVersion $railsVersion - Tests"
+        compose.exec('app', "bundle exec appraisal $railsVersion rake db:schema:load")
+        compose.exec('app', "bundle exec appraisal $railsVersion rspec spec")
     }
 }
 
@@ -67,10 +70,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,9 +39,14 @@ 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
+
 ## Testing
+This engine is used by NTTR and socialguide.
 
-This engine is used by NTTR and socialguide, thereby needs to be compatible with both Rails 3.2 and 4.2.
 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:

data/app/controllers/ns_settings_ui/settings_controller.rb

@@ -1,10 +1,10 @@
 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

data/app/helpers/ns_settings_ui/application_helper.rb

@@ -2,7 +2,7 @@ module NsSettingsUi
   module ApplicationHelper
     def url_for(options)
       super(options)
-    rescue ActionController::RoutingError
+    rescue ActionController::RoutingError, ActionController::UrlGenerationError
       main_app.url_for(options)
     end
 

data/app/helpers/ns_settings_ui/settings_helper.rb

@@ -6,8 +6,24 @@ module NsSettingsUi
       ''
     end
 
+    def render_value_field(form, setting)
+      render_field(form, setting.value_type, :value, setting_value_class(setting))
+    end
+
+    def render_default_value_field(form, setting)
+      render_field(form, setting.value_type, :default_value)
+    end
+
     private
 
+    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)
+      else
+        form.text_field(name, size: 10, class: "form-control #{additional_class}")
+      end
+    end
+
     def recursive_hash
       Hash.new { |hash, key| hash[key] = recursive_hash }
     end

data/app/models/ns_settings_ui/setting.rb

@@ -2,9 +2,37 @@ module NsSettingsUi
   class Setting < ActiveRecord::Base
     TYPES = {
       string: 1,
-      integer: 2
+      integer: 2,
+      boolean: 3,
+      date: 7,
+      nullable_string: 4,
+      nullable_integer: 5,
+      nullable_boolean: 6
     }.freeze
 
+    TYPE_HANDLERS = {
+      1 => :string_value,
+      2 => :integer_value,
+      3 => :boolean_value,
+      7 => :date_value,
+      4 => :nullable_string,
+      5 => :nullable_integer,
+      6 => :nullable_boolean
+    }.freeze
+
+    NULL_VALUES = [nil, ''].freeze
+
+    # TODO: in Nttr
+    # belongs_to :country
+    #
+    # def self.get(country, *keys)
+    #   where(country: country, key: keys.join('.')).first_or_create
+    # end
+    #
+    # def country_code
+    #   country.try(:alpha2).to_s
+    # end
+
     def self.get(*keys)
       where(key: keys.join('.')).first_or_create
     end
@@ -14,13 +42,41 @@ module NsSettingsUi
     end
 
     def formatted_value
-      return nil if value.nil?
-      case value_type
-      when TYPES[:string] then value.to_s
-      when TYPES[:integer] then value.to_i
-      else
-        value
-      end
+      TYPE_HANDLERS[value_type] ? send(TYPE_HANDLERS[value_type]) : value
+    end
+
+    private
+
+    def nullify?
+      NULL_VALUES.include?(value)
+    end
+
+    def nullable_string
+      string_value unless nullify?
+    end
+
+    def nullable_integer
+      integer_value unless nullify?
+    end
+
+    def nullable_boolean
+      boolean_value unless nullify?
+    end
+
+    def string_value
+      value.to_s
+    end
+
+    def integer_value
+      value.to_i
+    end
+
+    def boolean_value
+      value == 'true'
+    end
+
+    def date_value
+      Date.parse(value)
     end
   end
 end

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

@@ -1,9 +1,9 @@
 <div id="setting_<%= setting.id -%>">
   <%= form_for(setting, url: ns_settings_ui.setting_path(setting), method: :put, remote: true, html: {class: 'form-inline'}) do |f| %>
       <%= f.label(:value) %>
-      <%= f.text_field(:value, size: 10, class: "form-control #{setting_value_class(setting)}" )  %>
+      <%= render_value_field(f, setting) %>
       <%= f.label(:default_value) %>
-      <%= f.text_field(:default_value, size: 10, class: 'form-control') %>
+      <%= render_default_value_field(f, setting) %>
       <%= f.submit('Update', class: 'btn btn-default') %>
   <% end %>
   <%= form_for(setting, url: ns_settings_ui.reset_setting_path(setting), method: :put, remote: true) do |f| %>

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

@@ -1,5 +1,5 @@
-FROM ruby:2.1
-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/gemfiles/rails_5.0.gemfile

@@ -5,4 +5,4 @@ source "https://rubygems.org"
 gem "rails", "~> 5.0.0"
 gem "rails-controller-testing"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/rails_5.1.gemfile

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

data/gemfiles/rails_5.2.gemfile

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

data/lib/ns_settings_ui/version.rb

@@ -1,3 +1,3 @@
 module NsSettingsUi
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.5.2'.freeze
 end

data/ns_settings_ui.gemspec

@@ -18,20 +18,22 @@ Gem::Specification.new do |s|
   s.files = `git ls-files -z`.split("\x0")
   s.test_files = Dir['spec/**/*']
 
-  s.add_dependency 'rails', '>= 3.2.18', '< 6'
+  s.add_dependency 'rails', '>= 5.0', '< 6'
 
   s.add_development_dependency 'appraisal', '~> 2.1'
-  s.add_development_dependency 'sqlite3', '~> 1.3'
+  s.add_development_dependency 'sqlite3', '~> 1.3.0'
   s.add_development_dependency 'rspec', '~> 3.4'
   s.add_development_dependency 'rspec-rails', '~> 3.4'
   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.5'
+  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'

data/spec/controllers/ns_settings_ui/settings_controller_spec.rb

@@ -5,11 +5,17 @@ RSpec.describe NsSettingsUi::SettingsController, type: :controller do
 
   describe 'GET index' do
     let!(:settings) { Array.new(8) { NsSettingsUi::Setting.make! }.sort_by(&:key) }
+    subject { get :index }
 
     it 'assigns all settings' do
-      get :index
+      subject
       expect(assigns(:settings)).to eq(settings)
     end
+
+    context 'with views' do
+      render_views
+      it { is_expected.to be_success }
+    end
   end
 
   shared_examples_for 'sets setting and renders update' do
@@ -28,8 +34,9 @@ RSpec.describe NsSettingsUi::SettingsController, type: :controller do
 
   describe 'PUT reset' do
     let(:setting) { NsSettingsUi::Setting.make!(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)
@@ -40,16 +47,18 @@ RSpec.describe NsSettingsUi::SettingsController, type: :controller do
 
   describe 'PUT update' do
     let(:setting) { NsSettingsUi::Setting.make! }
-    let(:params) { {value: '5', default_value: '6', key: 'matching.cluster_size'} }
+    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/app/assets/javascripts/application.js

@@ -10,6 +10,4 @@
 // WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
 // GO AFTER THE REQUIRES BELOW.
 //
-//= require jquery
-//= require jquery_ujs
 //= require_tree .

data/spec/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,4 @@
+class HomeController < ApplicationController
+  def index
+  end
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -2,12 +2,13 @@
 <html>
 <head>
   <title>Dummy</title>
-  <%= stylesheet_link_tag    "application", :media => "all" %>
-  <%= javascript_include_tag "application" %>
+  <%= yield :head -%>
   <%= csrf_meta_tags %>
 </head>
 <body>
 
+<%= link_to 'Homepage', url_for(controller: '/home', action: :index) -%>
+
 <%= yield %>
 
 </body>

data/spec/dummy/config/initializers/ns_settings_ui.rb

@@ -1,4 +1,4 @@
 if defined?(NsSettingsUi)
-  NsSettingsUi.layout = nil
+  NsSettingsUi.layout = 'application'
   NsSettingsUi.parent_controller = ActionController::Base
 end

data/spec/dummy/config/routes.rb

@@ -1,3 +1,4 @@
 Rails.application.routes.draw do
   mount NsSettingsUi::Engine => '/ns_settings_ui'
+  get '/home', controller: :home, action: :index
 end

data/spec/helpers/ns_settings_ui/application_helper_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+RSpec.describe NsSettingsUi::ApplicationHelper, type: :helper do
+  describe '#url_for' do
+    subject { helper.url_for(url_params) }
+
+    context 'on self route' do
+      let(:url_params) { NsSettingsUi::Engine.routes.url_helpers.settings_path }
+      it { is_expected.to eq('/ns_settings_ui/settings') }
+    end
+
+    context 'on main application route' do
+      let(:url_params) { {controller: '/home'} }
+      it { is_expected.to eq('/home') }
+    end
+
+    context 'on incorrect route' do
+      let(:url_params) { {controller: 'non-existing-controller', action: 'index'} }
+      let(:error_class) do
+        Rails::VERSION::MAJOR <= 3 ? ActionController::RoutingError : ActionController::UrlGenerationError
+      end
+      it { expect { subject }.to raise_error(error_class) }
+    end
+  end
+end

data/spec/models/ns_settings_ui/setting_spec.rb

@@ -53,61 +53,163 @@ RSpec.describe NsSettingsUi::Setting, type: :model do
     let(:key) { 'aa.bb' }
     subject { described_class.make(key: key, value: value, value_type: value_type).formatted_value }
 
-    context 'when value_type is default' do
-      let(:value_type) { nil }
-      context 'when value is a nil' do
-        let(:value) { nil }
-        it { is_expected.to be_nil }
-      end
+    shared_examples 'string' do
       context 'when value is a string' do
         let(:value) { 'abcd' }
         it { is_expected.to eq('abcd') }
       end
+
       context 'when value is an integer with a string' do
         let(:value) { '4abcd' }
         it { is_expected.to eq('4abcd') }
       end
+
       context 'when value is an integer' do
         let(:value) { '10' }
         it { is_expected.to eq('10') }
       end
     end
-    context 'when value_type is :string' do
-      let(:value_type) { NsSettingsUi::Setting::TYPES[:string] }
+
+    shared_examples 'integer' do
+      context 'when value is a string' do
+        let(:value) { 'abcd' }
+        it { is_expected.to eq(0) }
+      end
+
+      context 'when value is an integer with a string' do
+        let(:value) { '4abcd' }
+        it { is_expected.to eq(4) }
+      end
+
+      context 'when value is an integer' do
+        let(:value) { '10' }
+        it { is_expected.to eq(10) }
+      end
+    end
+
+    shared_examples 'boolean' do
+      context 'when value is true' do
+        let(:value) { 'true' }
+        it { is_expected.to eq(true) }
+      end
+
+      context 'when value is false' do
+        let(:value) { 'false' }
+        it { is_expected.to eq(false) }
+      end
+
+      context 'when value is other than true or 1 or false' do
+        let(:value) { 'other' }
+        it { is_expected.to eq(false) }
+      end
+    end
+
+    shared_examples 'nullable_type' do
       context 'when value is a nil' do
         let(:value) { nil }
         it { is_expected.to eq(nil) }
       end
+
+      context 'when value is a empty string' do
+        let(:value) { '' }
+        it { is_expected.to eq(nil) }
+      end
+    end
+
+    context 'when value_type is default' do
+      let(:value_type) { nil }
+
+      context 'when value is a nil' do
+        let(:value) { nil }
+        it { is_expected.to be_nil }
+      end
+
       context 'when value is a string' do
         let(:value) { 'abcd' }
         it { is_expected.to eq('abcd') }
       end
+
       context 'when value is an integer with a string' do
         let(:value) { '4abcd' }
         it { is_expected.to eq('4abcd') }
       end
+
       context 'when value is an integer' do
         let(:value) { '10' }
         it { is_expected.to eq('10') }
       end
+
+      context 'when value is a boolean' do
+        let(:value) { 'true' }
+        it { is_expected.to eq('true') }
+      end
     end
+
+    context 'when value_type is :string' do
+      let(:value_type) { NsSettingsUi::Setting::TYPES[:string] }
+
+      context 'when value is a nil' do
+        let(:value) { nil }
+        it { is_expected.to eq('') }
+      end
+
+      it_behaves_like 'string'
+    end
+
+    context 'when value_type is :nullable_string' do
+      let(:value_type) { NsSettingsUi::Setting::TYPES[:nullable_string] }
+
+      it_behaves_like 'string'
+      it_behaves_like 'nullable_type'
+    end
+
     context 'when value_type is :integer' do
       let(:value_type) { NsSettingsUi::Setting::TYPES[:integer] }
+
       context 'when value is a nil' do
         let(:value) { nil }
-        it { is_expected.to eq(nil) }
-      end
-      context 'when value is a string' do
-        let(:value) { 'abcd' }
         it { is_expected.to eq(0) }
       end
-      context 'when value is an integer with a string' do
-        let(:value) { '4abcd' }
-        it { is_expected.to eq(4) }
+
+      it_behaves_like 'integer'
+    end
+
+    context 'when value_type is :nullable_integer' do
+      let(:value_type) { NsSettingsUi::Setting::TYPES[:nullable_integer] }
+
+      it_behaves_like 'integer'
+      it_behaves_like 'nullable_type'
+    end
+
+    context 'when value_type is :boolean' do
+      let(:value_type) { NsSettingsUi::Setting::TYPES[:boolean] }
+
+      context 'when value is a nil' do
+        let(:value) { nil }
+        it { is_expected.to eq(false) }
       end
-      context 'when value is an integer' do
-        let(:value) { '10' }
-        it { is_expected.to eq(10) }
+
+      it_behaves_like 'boolean'
+    end
+
+    context 'when value_type is :nullable_boolean' do
+      let(:value_type) { NsSettingsUi::Setting::TYPES[:nullable_boolean] }
+
+      it_behaves_like 'boolean'
+      it_behaves_like 'nullable_type'
+    end
+
+    context 'when value_type is :date' do
+      let(:value_type) { NsSettingsUi::Setting::TYPES[:date] }
+
+      context 'when value is a proper date' do
+        let(:value) { '2017-05-08' }
+        it { is_expected.to eq(Date.parse(value)) }
+      end
+
+      context 'when value is malformatted' do
+        let(:value) { '2017-05-df' }
+        it { expect { subject }.to raise_error(ArgumentError, 'invalid date') }
       end
     end
   end