ns_settings_ui 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 620d3d4a37036756b288e67585ce6e0438dd3755
+  data.tar.gz: d2ac6935cc37e0bf72b7427e5bef7859033b454a
+SHA512:
+  metadata.gz: aa7c499bd852dfb1f66bdc3e079fc5f0499a8b282ee5a9f5a9fa4b3ee53c2bc50fa1c347efc4cb461bd63b6e3c4321bde508786e8d39facb98361d76a920c66b
+  data.tar.gz: a2f0cfb55baefacd78f29004d242a6da74f2f33c20be924c9872836c5dd733ed7d18c793b3f66eaeab3d160d3f87cae35716334467e3846b943feabacf4ddac9

data/.gitignore

@@ -0,0 +1,14 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+Gemfile.lock
+
+# Skip emacs backup files
+*~
+[#]*[#]
+.[#]*

data/.rubocop.yml

@@ -0,0 +1,14 @@
+inherit_from: .rubocop_u2i.yml
+
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - config/**/*
+
+Style/Lambda:
+  Enabled: false
+
+Rails/ActionFilter:
+  Enabled: false

data/.rubocop_u2i.yml

@@ -0,0 +1,54 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+    - '**/config.ru'
+  Exclude:
+    - bin/**/*
+    - db/**/*
+    - config/**/*
+    - script/**/*
+    - db/schema.rb
+    - bundle/**/*
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/Documentation:
+  Enabled: false
+
+Style/WhileUntilModifier:
+  MaxLineLength: 120
+  Exclude:
+    - spec/**/*
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+
+Style/MultilineBlockChain:
+  Enabled: true
+
+Style/DotPosition:
+  EnforcedStyle: trailing
+  Enabled: true
+
+Style/SingleLineMethods:
+  AllowIfMethodIsEmpty: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+#Style/TrailingComma:
+#  # If EnforcedStyleForMultiline is comma, the cop allows a comma after the
+#  # last item of a list, but only for lists where each item is on its own line.
+#  EnforcedStyleForMultiline: comma
+
+Metrics/LineLength:
+  Max: 120
+  Enabled: true
+  Exclude:
+    - spec/**/*
+
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 30

data/Appraisals

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

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in ns_settings_ui.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+
+gem 'rails', '~> 3.2' # assuming Rails 3.2 for jenkins jobs and top level rake tasks

data/Guardfile

@@ -0,0 +1,79 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+# This group allows to skip running RuboCop if RSpec.
+
+group :red_green_refactor, halt_on_fail: true do
+  guard :rspec, cmd: "bin/rspec" do
+    require "guard/rspec/dsl"
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # Feel free to open issues for suggestions and improvements
+
+    # RSpec files
+    rspec = dsl.rspec
+    watch(rspec.spec_helper) { rspec.spec_dir }
+    watch(rspec.spec_support) { rspec.spec_dir }
+    watch(rspec.spec_files)
+
+    # Ruby files
+    ruby = dsl.ruby
+    dsl.watch_spec_files_for(ruby.lib_files)
+
+    # Rails files
+    rails = dsl.rails(view_extensions: %w(erb haml slim))
+    dsl.watch_spec_files_for(rails.app_files)
+    dsl.watch_spec_files_for(rails.views)
+
+    watch(rails.controllers) do |m|
+      [
+        rspec.spec.("routing/#{m[1]}_routing"),
+        rspec.spec.("controllers/#{m[1]}_controller"),
+        rspec.spec.("acceptance/#{m[1]}")
+      ]
+    end
+
+    # Rails config changes
+    watch(rails.spec_helper)     { rspec.spec_dir }
+    watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+    watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+    # Capybara features specs
+    watch(rails.view_dirs)     { |m| rspec.spec.("features/#{m[1]}") }
+    watch(rails.layouts)       { |m| rspec.spec.("features/#{m[1]}") }
+
+    # Turnip features and steps
+    watch(%r{^spec/acceptance/(.+)\.feature$})
+    watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+      Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+    end
+  end
+
+  guard :rubocop, all_on_start: false, cli: %w(--format fuubar --rails) do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end
+

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+[![Build Status](http://jenkins.nielsensocial.u2i.eu/buildStatus/icon?job=(master) ns_settings_ui)](http://jenkins.nielsensocial.u2i.eu/job/(master) ns_settings_ui)
+
+# NsSettingsUi
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ns_settings_ui'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ns_settings_ui
+
+Install migrations:
+
+    $ rake ns_settings_ui:install:migrations
+
+And run db:migrate in your application
+
+    $ rake db:migate
+
+## Configuration
+
+Add ns_setting_ui initializer to config/initializers/ns_settings_ui.rb
+
+```
+if defined?(NsSettingsUi)
+  NsSettingsUi.layout = nil
+  NsSettingsUi.parent_controller = ActionController::Base
+end
+```
+
+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
+
+## Testing
+
+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:
+
+`appraisal install`
+
+And then to run specs for all the appraisals:
+
+`appraisal bundle exec rspec spec`
+
+Or a specific one:
+
+`appraisal rails_4.2 bundle exec rspec spec`
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/ns_settings_ui/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NsSettingsUi'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+
+task default: :spec

data/app/assets/javascripts/ns_settings_ui/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/javascripts/ns_settings_ui/jquery.liveFilter.js

@@ -0,0 +1,50 @@
+/*
+ * jQuery.liveFilter
+ *
+ * Copyright (c) 2009 Mike Merritt
+ *
+ * Forked by Lim Chee Aun (cheeaun.com)
+ * 
+ */
+ 
+(function($){
+	$.fn.liveFilter = function(inputEl, filterEl, options){
+		var defaults = {
+			filterChildSelector: null,
+			filter: function(el, val){
+                return $(el).text().toUpperCase().match(val.toUpperCase()) !== null;
+			},
+			before: function(){},
+			after: function(){}
+		};
+		var options = $.extend(defaults, options);
+		
+		var el = $(this).find(filterEl);
+		if (options.filterChildSelector) el = el.find(options.filterChildSelector);
+
+		var filter = options.filter;
+		$(inputEl).keyup(function(){
+			var val = $(this).val();
+			var contains = el.filter(function(){
+				return filter(this, val);
+			});
+			var containsNot = el.not(contains);
+			if (options.filterChildSelector){
+				contains = contains.parents(filterEl);
+				containsNot = containsNot.parents(filterEl).hide();
+			}
+			
+			options.before.call(this, contains, containsNot);
+			
+			contains.show();
+			containsNot.hide();
+			
+			if (val === '') {
+				contains.show();
+				containsNot.show();
+			}
+			
+			options.after.call(this, contains, containsNot);
+		});
+	}
+})(jQuery);

data/app/assets/stylesheets/ns_settings_ui/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,21 @@
+// Place all the styles related to the Settings controller here.
+// They will automatically be included in application.css.
+// You can use Sass (SCSS) here: http://sass-lang.com/
+
+#ns_settings_ui {
+  ul {
+    list-style-type: none;
+  }
+  form {
+    display: inline;
+  }
+  input[type=text] {
+    width: 130px;
+    display: inline;
+  }
+  table {
+    td {
+      padding: 2px;
+    }
+  }
+}

data/app/controllers/ns_settings_ui/application_controller.rb

@@ -0,0 +1,4 @@
+module NsSettingsUi
+  class ApplicationController < NsSettingsUi.parent_controller
+  end
+end

data/app/controllers/ns_settings_ui/settings_controller.rb

@@ -0,0 +1,29 @@
+module NsSettingsUi
+  class SettingsController < NsSettingsUi::ApplicationController
+    layout NsSettingsUi.layout
+    before_filter :setting_from_id_param, only: [:update, :reset]
+
+    def index
+      @settings = Setting.order('`key`').all
+    end
+
+    def update
+      @setting.value = params[:setting][:value]
+      @setting.default_value = params[:setting][:default_value]
+      @setting.save!
+      render partial: 'update'
+    end
+
+    def reset
+      @setting.value = @setting.default_value
+      @setting.save!
+      render partial: 'update'
+    end
+
+    private
+
+    def setting_from_id_param
+      @setting = Setting.find(params[:id])
+    end
+  end
+end

data/app/helpers/ns_settings_ui/application_helper.rb

@@ -0,0 +1,17 @@
+module NsSettingsUi
+  module ApplicationHelper
+    def url_for(options)
+      super(options)
+    rescue ActionController::RoutingError
+      main_app.url_for(options)
+    end
+
+    def method_missing(method, *args, &block)
+      if main_app.respond_to?(method)
+        main_app.send(method, *args)
+      else
+        super
+      end
+    end
+  end
+end

data/app/helpers/ns_settings_ui/settings_helper.rb

@@ -0,0 +1,15 @@
+module NsSettingsUi
+  module SettingsHelper
+    def setting_value_class(setting)
+      return 'alert-danger' if setting.value.nil? || setting.value.empty?
+      return 'alert-warning' if setting.value != setting.default_value
+      ''
+    end
+
+    private
+
+    def recursive_hash
+      Hash.new { |hash, key| hash[key] = recursive_hash }
+    end
+  end
+end

data/app/models/ns_settings_ui/setting.rb

@@ -0,0 +1,26 @@
+module NsSettingsUi
+  class Setting < ActiveRecord::Base
+    TYPES = {
+      string: 1,
+      integer: 2
+    }.freeze
+
+    def self.get(*keys)
+      where(key: keys.join('.')).first_or_create
+    end
+
+    def keys
+      key.split('.').map(&:to_sym)
+    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
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+<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)}" )  %>
+      <%= f.label(:default_value) %>
+      <%= f.text_field(:default_value, size: 10, class: 'form-control') %>
+      <%= 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| %>
+      <%= f.submit('Reset to default', class: 'btn btn-default') %>
+  <% end %>
+</div>

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

@@ -0,0 +1,6 @@
+<tr>
+  <td class="setting_key"><h5><%= setting.key -%></h5></td>
+  <td>
+    <%= render partial: 'edit', locals: {setting: setting} -%>
+  </td>
+</tr>

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

@@ -0,0 +1,3 @@
+$("#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');

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

@@ -0,0 +1,21 @@
+<%= content_for :head do %>
+    <%= stylesheet_link_tag 'ns_settings_ui/settings' -%>
+    <%= 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' -%>
+      </table>
+    </div>
+  </div>
+</div>
+
+<%= javascript_tag do -%>
+    $('#ns_settings_ui').liveFilter('#ns_settings_ui #filter-input', 'tr', {filterChildSelector: '.setting_key'});
+<% end %>

data/bin/rails

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails"
+# with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/ns_settings_ui/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/bin/rspec

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/config/routes.rb

@@ -0,0 +1,7 @@
+NsSettingsUi::Engine.routes.draw do
+  resources :settings, only: [:index, :update] do
+    member do
+      put 'reset'
+    end
+  end
+end

data/db/migrate/20151210214903_create_ns_settings_ui_settings.rb

@@ -0,0 +1,15 @@
+class CreateNsSettingsUiSettings < ActiveRecord::Migration
+  def up
+    create_table :ns_settings_ui_settings do |t|
+      t.string :key, null: false
+      t.string :value
+      t.string :default_value
+      t.timestamps
+    end
+    add_index :ns_settings_ui_settings, :key
+  end
+
+  def down
+    drop_table :ns_settings_ui_settings
+  end
+end

data/db/migrate/20151215081718_add_value_type_to_ns_settings_ui_settings.rb

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

data/gemfiles/rails_3.2.gemfile

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

data/gemfiles/rails_4.2.gemfile

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

data/lib/ns_settings_ui/engine.rb

@@ -0,0 +1,9 @@
+module NsSettingsUi
+  class Engine < ::Rails::Engine
+    isolate_namespace NsSettingsUi
+
+    initializer 'ns_settings_ui.assets.precompile' do |app|
+      app.config.assets.precompile += %w(ns_settings_ui/settings.css)
+    end
+  end
+end

data/lib/ns_settings_ui/version.rb

@@ -0,0 +1,3 @@
+module NsSettingsUi
+  VERSION = '1.0.0'.freeze
+end