rails-settings-ui 0.0.1

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "sqlite3"
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 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,125 @@
+Rails settings UI
+================================
+
+A Rails Engine to manage your application settings. Includes validation. Compatible with Rails 3.
+It compatible with [rails-settings-cached](https://github.com/huacnlee/rails-settings-cached) gem. Untested, but should work with rails-settings gem.
+
+Preview:
+
+![ScreenShot](https://raw.github.com/accessd/rails-settings-ui/master/doc/img/settings-page.png)
+
+How to
+-----
+
+Add to Gemfile
+
+    gem 'rails-settings-ui'
+    gem 'rails-settings-cached'
+    # or
+    gem 'rails-settings'
+    # or your fork of rails-settings
+
+Setup:
+
+    # adds initializer and route:
+    rails g rails_settings_ui:install
+
+Config
+------------
+
+In config/initializers/rails_settings_ui.rb
+
+    RailsSettingsUi.setup do |config|
+      config.ignored_settings = [:company_name] # Settings not displayed in the interface
+    end
+
+Routing
+-------
+
+    # engine root:
+    rails_settings_ui_url
+
+I18n
+-------------
+
+You can localize:
+
+*  Settings names, eg:
+
+```yaml
+  settings:
+    attributes:
+      launch_mode: # setting name
+        name: 'Launch mode'
+```
+
+*  Checkbox or select options labels for array options, eg:
+
+```yaml
+  settings:
+    attributes:
+      launch_mode:
+        labels:
+          auto: 'Auto mode'
+          manual: 'Manual mode'
+```
+
+*  Help blocks for settings, eg:
+
+```yaml
+  settings:
+    attributes:
+      launch_mode:
+        help_block: 'Rocket launch mode'
+```
+
+Validations
+-------------
+
+To validation work is required the default settings in the proper format, eg:
+
+    class Settings < RailsSettings::CachedSettings
+      defaults[:company_name] = "Company name"
+      defaults[:head_name] = "Head name"
+      defaults[:manager_premium] = 19
+      defaults[:show_contract_fields] = true
+      defaults[:launch_mode] = [:auto, :manual]
+    end
+
+Views
+-------------
+    Rails.application.config.to_prepare do
+      # Use admin layout:
+      RailsSettingsUi::ApplicationController.module_eval do
+        layout 'admin'
+      end
+      # If you are using a custom layout, you will want to make app routes available to rails-setting-ui:
+      RailsSettingsUi.inline_main_app_routes!
+    end
+
+
+Authentication & authorization
+------------------------------
+
+You can specify the parent controller for settings controller, and it will inherit all before filters.
+Note that this must be placed before any other references to rails-setting-ui application controller in the initializer:
+
+    RailsSettingsUi.parent_controller = 'Admin::ApplicationController' # default: '::ApplicationController'
+
+Alternatively, to have custom rules just for rails-setting-ui you can:
+
+    Rails.application.config.to_prepare do
+      RailsSettingsUi::ApplicationController.module_eval do
+        before_filter :check_settings_permissions
+      
+        private
+        def check_settings_permissions
+           render status: 403 unless current_user && can_manage_settings?(current_user)
+        end
+      end
+    end 
+
+
+
+
+This project uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,21 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test

data/app/assets/stylesheets/rails_settings_ui/application.css.scss

@@ -0,0 +1,4 @@
+/*
+ *= require bootstrap_and_overrides
+ *= require_self
+*/

data/app/assets/stylesheets/rails_settings_ui/bootstrap_and_overrides.css.less

@@ -0,0 +1,27 @@
+@import "twitter/bootstrap/bootstrap";
+body { padding-top: 60px; }
+
+@import "twitter/bootstrap/responsive";
+
+// Set the correct sprite paths
+@iconSpritePath: asset-path('twitter/bootstrap/glyphicons-halflings.png');
+@iconWhiteSpritePath: asset-path('twitter/bootstrap/glyphicons-halflings-white.png');
+
+// Font Awesome
+@fontAwesomeEotPath: asset-url("fontawesome-webfont.eot");
+@fontAwesomeEotPath_iefix: asset-url("fontawesome-webfont.eot?#iefix");
+@fontAwesomeWoffPath: asset-url("fontawesome-webfont.woff");
+@fontAwesomeTtfPath: asset-url("fontawesome-webfont.ttf");
+@fontAwesomeSvgPath: asset-url("fontawesome-webfont.svg#fontawesomeregular");
+@import "fontawesome/font-awesome";
+
+// Your custom LESS stylesheets goes here
+//
+// Since bootstrap was imported above you have access to its mixins which
+// you may use and inherit here
+//
+// If you'd like to override bootstrap's own variables, you can do so here as well
+// See http://twitter.github.com/bootstrap/less.html for their names and documentation
+//
+// Example:
+// @linkColor: #ff0000;

data/app/controllers/rails_settings_ui/application_controller.rb

@@ -0,0 +1,4 @@
+module RailsSettingsUi
+  class ApplicationController < ::RailsSettingsUi.parent_controller.constantize
+  end
+end

data/app/controllers/rails_settings_ui/settings_controller.rb

@@ -0,0 +1,29 @@
+class RailsSettingsUi::SettingsController < RailsSettingsUi::ApplicationController
+  before_filter :collection
+  before_filter :cast_settings_params, only: :update_all
+
+  def index
+  end
+
+  def update_all
+    if @casted_settings[:errors].any?
+      render :index
+    else
+      @casted_settings.map { |setting| Settings[setting[0]] = setting[1] if setting[0] != "errors" }
+      redirect_to [:settings]
+    end
+  end
+
+  private
+
+  def collection
+    I18n.locale = :en
+    all_settings = Settings.defaults.merge(Settings.all)
+    all_settings_without_ignored = all_settings.reject{ |name, description| RailsSettingsUi.ignored_settings.include?(name.to_sym) }
+    @settings = Hash[all_settings_without_ignored]
+  end
+
+  def cast_settings_params
+    @casted_settings = RailsSettingsUi::SettingsHelper.cast(params["settings"])
+  end
+end

data/app/helpers/rails_settings_ui/settings_helper.rb

@@ -0,0 +1,75 @@
+module RailsSettingsUi::SettingsHelper
+  def self.cast(requires_cast)
+    requires_cast[:errors] = {}
+    requires_cast.each do |var_name, value|
+      case Settings.defaults[var_name.to_sym]
+        when Fixnum
+          if is_numeric?(value)
+            requires_cast[var_name] = value.to_i
+          else
+            requires_cast[:errors][var_name.to_sym] = I18n.t("settings.errors.invalid_numeric", default: 'Invalid')
+          end
+        when ActiveSupport::HashWithIndifferentAccess
+          begin
+            requires_cast[var_name] = JSON.parse(value.gsub(/\=\>/, ':'))
+          rescue JSON::ParserError => e
+            requires_cast[:errors][var_name.to_sym] = I18n.t("settings.errors.invalid_hash", default: 'Invalid')
+          end
+        when Float
+          if is_numeric?(value)
+            requires_cast[var_name] = value.to_f
+          else
+            requires_cast[:errors][var_name.to_sym] = I18n.t("settings.errors.invalid_numeric", default: 'Invalid')
+          end
+        when Array
+          # Array presented in checkboxes
+          if value.is_a?(Hash)
+            requires_cast[var_name] = value.keys.map!(&:to_sym)
+          # or in select tag
+          else
+            value.to_sym
+          end
+        when FalseClass, TrueClass
+          requires_cast[var_name] = true
+      end
+    end
+    Settings.defaults.each do |name, value|
+      if !requires_cast[name.to_sym].present? && [TrueClass, FalseClass].include?(value.class)
+        requires_cast[name.to_sym] = false
+      end
+    end
+
+    requires_cast
+  end
+
+  def setting_field(setting_name, setting_value)
+    if RailsSettingsUi.settings_displayed_as_select_tag.include?(setting_name.to_sym)
+      default_setting_values = Settings.defaults[setting_name.to_s].map do |setting_value|
+        [I18n.t("settings.attributes.#{setting_name}.labels.#{setting_value}", default: setting_value.to_s), setting_value]
+      end
+      select_tag("settings[#{setting_name.to_s}]", options_for_select(default_setting_values, setting_value))
+    elsif setting_value.is_a?(Array)
+      field = ""
+      Settings.defaults[setting_name.to_sym].each do |value|
+        field << check_box_tag("settings[#{setting_name.to_s}][#{value.to_s}]", nil, Settings.defaults.merge(Settings.all)[setting_name.to_s].include?(value), style: "margin: 0 10px;")
+        field << label_tag("settings[#{setting_name.to_s}][#{value.to_s}]", I18n.t("settings.attributes.#{setting_name}.labels.#{value}", default: value.to_s), style: "display: inline-block;")
+      end
+      return field.html_safe
+    elsif [TrueClass, FalseClass].include?(setting_value.class)
+      return check_box_tag("settings[#{setting_name.to_s}]", nil, setting_value).html_safe
+    else
+      text_field = if setting_value.to_s.size > 30
+        text_area_tag("settings[#{setting_name}]", setting_value.to_s, rows: 10)
+      else
+        text_field_tag("settings[#{setting_name}]", setting_value.to_s)
+      end
+
+      help_block_content = I18n.t("settings.attributes.#{setting_name}.help_block", default: '')
+      text_field + (help_block_content.presence && content_tag(:span, help_block_content, class: 'help-block'))
+    end
+  end
+
+  def self.is_numeric?(value)
+    !value.to_s.match(/\A[+-]?\d+?(\.\d+)?\Z/).nil?
+  end
+end

data/app/views/layouts/rails_settings_ui/application.html.haml

@@ -0,0 +1,18 @@
+!!!
+%html
+  %head
+    %title Rails settings
+    %meta{:charset => "utf-8"}
+    %meta{"http-equiv" => "X-UA-Compatible", :content => "IE=edge,chrome=1"}
+    %meta{:name => "viewport", :content => "width=device-width, initial-scale=1, maximum-scale=1"}
+    = stylesheet_link_tag :application
+    = csrf_meta_tags
+  %body
+    .navbar.navbar-fixed-top
+      .navbar-inner
+        .container-fluid
+          %a.brand{href: "/"} Rails settings ui
+    .container-fluid
+      .row-fluid
+        .content= yield
+      %footer

data/app/views/rails_settings_ui/settings/index.html.haml

@@ -0,0 +1,25 @@
+%ul.breadcrumb
+  %li.active= t('settings.index.title')
+
+- if @casted_settings && @casted_settings[:errors].any?
+  .alert.alert-error= t('settings.index.settings_include_errors')
+
+= form_tag [:update_all], method: :put, class: 'form-inline' do
+  %table.table.table-striped
+    %thead
+      %tr
+        %th= t('settings.index.description')
+        %th= t('settings.index.value')
+    %tbody
+      - @settings.each do |name, value|
+        - if name != :errors
+          %tr
+            %td= I18n.t("settings.attributes.#{name}.name")
+            %td
+              - setting_with_error = @casted_settings && @casted_settings[:errors].include?(name)
+              %div{class: "control-group #{ setting_with_error ? 'error' : ''}"}
+                = setting_field(name, value)
+                - if setting_with_error
+                  %span.help-inline= @casted_settings[:errors][name]
+
+  = submit_tag t('settings.index.save_all'), class: 'btn btn-info'

data/config/initializers/rails_settings_ui.rb

@@ -0,0 +1,14 @@
+require 'rails-settings-ui'
+
+#= Application-specific
+#
+# # You can specify a controller for RailsSettingsUi::ApplicationController to inherit from:
+# RailsSettingsUi.parent_controller = 'Admin::ApplicationController' # default: '::ApplicationController'
+#
+# # Render RailsSettingsUi inside a custom layout (set to 'application' to use app layout, default is RailsSettingsUi's own layout)
+# RailsSettingsUi::ApplicationController.layout 'admin'
+
+Rails.application.config.to_prepare do
+  # If you use a *custom layout*, make route helpers available to RailsSettingsUi:
+  # RailsSettingsUi.inline_main_app_routes!
+end

data/config/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  settings:
+    index:
+      title: Settings
+      description: Description
+      value: Value
+      save_all: Save all
+      settings_include_errors: Settings include errors
+    errors:
+      invalid_numeric: Invalid numeric
+      invalid_hash: Invalid hash

data/config/locales/ru.yml

@@ -0,0 +1,11 @@
+ru:
+  settings:
+    index:
+      title: Настройки
+      description: Описание
+      value: Значение
+      save_all: Сохранить
+      settings_include_errors: Ошибка в настройках
+    errors:
+      invalid_numeric: Невалидный формат числа
+      invalid_hash: Невалидный хэш

data/config/routes.rb

@@ -0,0 +1,4 @@
+RailsSettingsUi::Engine.routes.draw do
+  get '/' => 'settings#index', as: :settings
+  put '/update_all' => 'settings#update_all'
+end

data/lib/generators/rails_settings_ui/install_generator.rb

@@ -0,0 +1,17 @@
+module RailsSettingsUi
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "creates an initializer file at config/initializers/rails_settings_ui.rb and adds route to config/routes.rb"
+      source_root File.expand_path('../../../..', __FILE__)
+
+      def generate_initialization
+        copy_file 'config/initializers/rails_settings_ui.rb', 'config/initializers/rails_settings_ui.rb'
+      end
+
+      def generate_routing
+        route "mount RailsSettingsUi::Engine, at: 'settings'"
+        log "# You can access RailsSettingsUi urls like this: rails_settings_ui_path #=> '/settings'"
+      end
+    end
+  end
+end

data/lib/rails-settings-ui.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require 'rails-settings-ui/engine'
+require 'rails-settings-ui/main_app_route_delegator'
+require 'rails-settings-ui/version'
+
+require 'rails-settings-cached'
+
+module RailsSettingsUi
+  mattr_accessor :parent_controller
+  self.parent_controller = '::ApplicationController'
+
+  # Settings not displayed in the interface (eg. [:launch_mode, :project_name])
+  mattr_accessor :ignored_settings
+  self.ignored_settings = []
+
+  # Settings displayed in the interface as select tag instead checkboxes (useful for array with one possible choice)
+  mattr_accessor :settings_displayed_as_select_tag
+  self.settings_displayed_as_select_tag = []
+
+  class << self
+    def inline_main_app_routes!
+      ::RailsSettingsUi::ApplicationController.helper ::RailsSettingsUi::MainAppRouteDelegator
+    end
+
+    def setup
+      yield self
+    end
+  end
+end

data/lib/rails-settings-ui/engine.rb

@@ -0,0 +1,5 @@
+module ::RailsSettingsUi
+  class Engine < Rails::Engine
+    isolate_namespace RailsSettingsUi
+  end
+end

data/lib/rails-settings-ui/main_app_route_delegator.rb

@@ -0,0 +1,19 @@
+module RailsSettingsUi::MainAppRouteDelegator
+  # delegate url helpers to main_app
+  def method_missing(method, *args, &block)
+    if main_app_route_method?(method)
+      main_app.send(method, *args)
+    else
+      super
+    end
+  end
+
+  def respond_to?(method)
+    super || main_app_route_method?(method)
+  end
+
+  private
+  def main_app_route_method?(method)
+    method.to_s =~ /_(?:path|url)$/ && main_app.respond_to?(method)
+  end
+end

data/lib/rails-settings-ui/version.rb

@@ -0,0 +1,3 @@
+module RailsSettingsUi
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: rails-settings-ui
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrey Morskov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: twitter-bootstrap-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: User interface for manage settings with rails-settings gem
+email: accessd0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/stylesheets/rails_settings_ui/application.css.scss
+- app/assets/stylesheets/rails_settings_ui/bootstrap_and_overrides.css.less
+- app/controllers/rails_settings_ui/application_controller.rb
+- app/controllers/rails_settings_ui/settings_controller.rb
+- app/helpers/rails_settings_ui/settings_helper.rb
+- app/views/layouts/rails_settings_ui/application.html.haml
+- app/views/rails_settings_ui/settings/index.html.haml
+- lib/generators/rails_settings_ui/install_generator.rb
+- lib/rails-settings-ui/engine.rb
+- lib/rails-settings-ui/main_app_route_delegator.rb
+- lib/rails-settings-ui/version.rb
+- lib/rails-settings-ui.rb
+- config/initializers/rails_settings_ui.rb
+- config/locales/en.yml
+- config/locales/ru.yml
+- config/routes.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.md
+homepage: https://github.com/accessd/rails-settings-ui
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: User interface for manage settings (rails engine)
+test_files: []