settr 0.1.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,29 @@
+Settr
+=====
+
+Settr is a hierarchical key-value based storage for configuration settings in Rails apps.
+
+Usage
+-----
+
+Use 
+
+`rails g settr:install` 
+
+to install settr and modify */config/initializers/settr.rb* to your needs.
+
+The path to settr settings is */settr/settings/settings*.
+
+Check out the dummy app in the test directory (load seed data via `rake db:seed`).
+One can access settr settings by e.g. `Settr.my_group.my_subgroup.my_setting`.
+
+Authors
+-------
+
+* **Torsten Sprenger** – [ts@metaminded.com](mailto:ts@metaminded.com)
+* **Peter Horn** – [ph@metaminded.com](mailto:ph@metaminded.com)
+
+Copyright and License
+---------------------
+
+Copyright 2012 metaminded UG. Licensed under the MIT License.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/assets/stylesheets/settr.css.scss

@@ -0,0 +1,25 @@
+.settr_form {
+  h1 {
+    font-size: 24px;
+  }
+  
+  h2 {
+    font-size: 20px;
+  }
+  
+  h3 {
+    font-size: 17px;
+  }
+  
+  h4 {
+    font-size: 14px;
+  }
+  
+  h5 {
+    font-size: 12px;
+  }
+
+  h6 {
+    font-size: 11px;
+  }
+}

data/app/controllers/settr/application_controller.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+class Settr::ApplicationController < ApplicationController
+end

data/app/controllers/settr/settings_controller.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+class Settr::SettingsController < Settr::ApplicationController
+
+  def new
+    @setting = SettrSetting.new
+  end
+  
+  def create
+    @setting = SettrSetting.new(params[:settr_setting])
+    if @setting.select?
+      unless @setting.options.include?(@setting.value)
+        flash[:error] = t('settr.setting.not_created_value_not_in_options')
+        redirect_to settr_settings_path
+        return
+      end
+    end
+    
+    if @setting.save 
+      flash[:success] = t('settr.setting.created')
+    else
+      flash[:error] = t('settr.setting.not_created')
+    end
+    
+    redirect_to settr_settings_path
+  end
+
+  def edit
+    @setting = SettrSetting.find(params[:id])
+  end
+
+  def update
+    @setting = SettrSetting.find(params[:id])
+    @new_setting = SettrSetting.new(params[:settr_setting])
+    if @new_setting.select?
+      unless @new_setting.options.include?(@setting.value)
+        flash[:error] = t('settr.setting.not_updated_value_not_in_options')
+        redirect_to settr_settings_path
+        return
+      end
+    end
+    
+    if @setting.update_attributes(params[:settr_setting])
+      flash[:success] = t('settr.setting.updated')
+    else
+      flash[:error] = t('settr.setting.not_updated')
+    end
+    redirect_to settr_settings_path
+  end
+  
+  def index
+    @settings = SettrSetting.order(:key)
+  end
+  
+  def destroy
+    @setting = SettrSetting.find(params[:id])
+    if @setting.destroy
+      flash[:success] = t('settr.setting.deleted')
+    else
+      flash[:error] = t('settr.setting.not_deleted')
+    end
+    redirect_to settr_settings_path
+  end
+  
+  def settings
+    @settings = Settr.all
+    
+    if request.post?
+      params[:settr].each do |k, v|
+        setting = SettrSetting.find_by_key(k)
+        setting.value = (setting.typ == 'boolean' ? (v == '1').to_s : v)
+        setting.save!
+      end      
+      flash[:success] = t('settr.settings.saved')
+      redirect_to settings_settr_settings_path
+    end
+  end
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/app/helpers/settr/settings_helper.rb

@@ -0,0 +1,14 @@
+class Settr
+  module SettingsHelper
+    def header(content)
+      html_options = Settr.header_class ? {:class => Settr.header_class} : {}
+      content_tag(Settr.header_tag.to_sym, content, html_options)
+    end
+    
+    def link(body, url, html_options = {})
+      options = Settr.link_class ? {:class => Settr.link_class} : {}
+      options.update(html_options)
+      link_to(body, url, options)
+    end
+  end
+end

data/app/models/settr_setting.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+class SettrSetting < ActiveRecord::Base
+
+  def val
+    case typ
+      when 'boolean'
+        value == 'true'
+      when 'float'
+        value.to_f
+      when 'integer'
+        value.to_i
+      else
+        value
+    end
+  end
+  
+  def select?
+    typ == 'select'
+  end
+  
+  def options=(opts)
+    write_attribute :options, opts.gsub(' ','').gsub(',', ', ')
+  end
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Settr</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/settr/settings/_form.html.erb

@@ -0,0 +1,26 @@
+<%= simple_form_for setting, :html => {:class => ['settr_form', Settr.form_class].compact.join(' ')} do |f| %>
+  <%= f.input :key, :label => t('settr.model.key') %>
+  <%= f.input :value, :label => t('settr.model.value') %>
+  <%= f.input :typ, :label => t('settr.model.typ'), :collection => ['string', 'text', 'boolean', 'integer', 'float', 'select'], :include_blank => false %>
+  <%= f.input :options, :label => t('settr.model.options'), :label_html => {:class => 'settr_setting_options_label'} %>
+  <%= f.input :alterable, :label => t('settr.model.alterable') %>
+  <%= f.submit (params[:action] == 'edit' ? t('settr.form.submit.edit') : t('settr.form.submit.new')) %>
+<% end %>
+
+<script type="text/javascript" charset="utf-8">
+$(function(){
+  $(".settr_setting_options_label").hide();
+
+  <% unless setting.select? %>
+    $("#settr_setting_options").hide();
+  <% end  %>
+  
+  $("#settr_setting_typ").change(function(){
+    if ($("#settr_setting_typ :selected").text() == 'select') {
+      $("#settr_setting_options").show();
+    } else {
+      $("#settr_setting_options").hide().val('');     
+    }
+  }); 
+});
+</script>

data/app/views/settr/settings/_setting.html.erb

@@ -0,0 +1,39 @@
+<% if object.is_a? SettrSetting %>
+  <% if object.alterable %>
+    <div class="clearfix string">
+      <% case object.typ %>
+        <% when 'boolean' %>
+          <label class="clearfix"><%= t("settr.#{object.key}") %></label>
+          <input type="hidden" name="settr[<%= object.key %>]" value="0" />
+          <input type="checkbox" name="settr[<%= object.key %>]" value="1" <%= 'checked' if object.val %> />
+        <% when 'string' %>
+          <label class="clearfix"><%= t("settr.#{object.key}") %></label>
+          <input type="text" name="settr[<%= object.key %>]" value="<%= object.value %>" />
+        <% when 'text' %>
+          <label class="clearfix"><%= t("settr.#{object.key}") %></label>
+          <textarea cols="10" rows="10" name="settr[<%= object.key %>]"><%= object.value %></textarea>
+        <% when 'float' %>
+          <label class="clearfix"><%= t("settr.#{object.key}") %></label>
+          <input type="text" name="settr[<%= object.key %>]" value="<%= object.value %>" />
+        <% when 'integer' %>
+          <label class="clearfix"><%= t("settr.#{object.key}") %></label>
+          <input type="text" name="settr[<%= object.key %>]" value="<%= object.value %>" />
+        <% when 'select' %>
+          <label class="clearfix"><%= t("settr.#{object.key}._title") %></label>
+          <select name="settr[<%= object.key %>]">
+            <% object.options.split(', ').each do |option| %>
+              <option value="<%= option %>" <%= 'selected' if object.value == option %> ><%= t("settr.#{object.key}.#{option}") %></option>
+            <% end %>
+          </select>
+      <% end %>
+    </div>
+  <% end %>
+<% else %>
+  <%= content_tag "h#{level}" do %>
+    <%= t("settr.#{key}._title") %>
+  <% end if level > 0 %>
+  <% object.sort_by{|k, v| k}.each do |k, v| %>
+    <%= render :partial => 'setting', :locals => {:object => v, :level => level + 1, :key => "#{key}.#{k}"} %>
+  <% end %>
+  <div class="horizontal_line grey"></div>
+<% end %>

data/app/views/settr/settings/_settings_form.html.erb

@@ -0,0 +1,4 @@
+<%= form_tag({}, {:class => ['simple_form', 'settr_form', Settr.form_class].compact.join(' ')}) do %>  
+  <%= render :partial => 'setting', :locals => {:object => @settings, :level => 0, :key => ''} %>
+  <%= submit_tag t('settr.form.submit.settings') %>
+<% end %>

data/app/views/settr/settings/edit.html.erb

@@ -0,0 +1,3 @@
+<%= header t('settr.title.edit') %>
+
+<%= render :partial => 'form', :locals => {:setting => @setting} %>

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

@@ -0,0 +1,27 @@
+<%= header t('settr.title.index') %>
+
+<%= link t('settr.link.settings'), settings_settr_settings_path %>
+<%= link t('settr.link.new'), new_settr_setting_path %>
+
+<table class="<%= Settr.table_class %>">
+  <thead>
+    <tr>
+      <th><%= t('settr.model.key') %></th>
+      <th><%= t('settr.model.value') %></th>
+      <th><%= t('settr.model.typ') %></th>
+      <th><%= t('settr.model.options') %></th>
+      <th><%= t('settr.model.alterable') %></th>
+    </tr>
+  </thead>
+<% @settings.each do |s| %>
+  <tr>
+    <td><%= s.key %></td>
+    <td><%= s.value %></td>
+    <td><%= s.typ %></td>
+    <td><%= s.options %></td>
+    <td><%= s.alterable %></td>
+    <td><%= link t('settr.link.destroy'), settr_setting_path(s), :method => :delete, :confirm => t('settr.link.really_destroy') %></td>
+    <td><%= link t('settr.link.edit'), edit_settr_setting_path(s) %></td>
+  </tr>
+<% end %>
+</table>

data/app/views/settr/settings/new.html.erb

@@ -0,0 +1,3 @@
+<%= header t('settr.title.new') %>
+
+<%= render :partial => 'form', :locals => {:setting => @setting} %>

data/app/views/settr/settings/settings.html.erb

@@ -0,0 +1 @@
+<%= render :partial => 'settings_form' %>

data/config/locales/de.yml

@@ -0,0 +1,36 @@
+de:
+  settr:
+    model:
+      key: 'Schlüssel'
+      value: 'Wert'
+      typ: 'Datentyp'
+      alterable: 'Modifizierbar'
+      options: 'Auswahlmöglichkeiten'
+    form:
+      submit:
+        new: 'Einstellungsattribut anlegen'
+        edit: 'Einstellungsattribut aktualisieren'
+        settings: 'Einstellungen sichern'
+    title:
+      index: 'Einstellungsattribute'
+      new: 'Einstellungsattribut anlegen'
+      edit: 'Einstellungsattribut bearbeiten'
+      settings: 'Einstellungen'
+    link:
+      destroy: 'Löschen'
+      edit: 'Bearbeiten'
+      really_destroy: 'Wirklich löschen?'
+      new: 'Einstellungsattribut anlegen'
+      settings: 'Zu Einstellungen'
+      index: 'Alle Einstellungsattribute'
+    settings: 
+      saved: 'Einstellungen gesichert'
+    setting:
+      created: 'Einstellungsattribut angelegt'
+      not_created: 'Einstellungsattribut konnte nicht angelegt werden'
+      not_created_value_not_in_options: 'Einstellungsattribut konnte nicht angelegt werden, da der angegebene Wert nicht bei den Auswahlmöglichkeiten auftritt'
+      updated: 'Einstellungsattribut aktualisiert'
+      not_updated: 'Einstellungsattribut konnte nicht aktualisiert werden'
+      not_updated_value_not_in_options: 'Einstellungsattribut konnte nicht aktualisiert werden, da der angegebene Wert nicht bei den Auswahlmöglichkeiten auftritt'
+      deleted: 'Einstellungsattribut gelöscht'
+      not_deleted: 'Einstellungsattribut konnte nicht gelöscht werden'

data/config/locales/en.yml

@@ -0,0 +1,36 @@
+en:
+  settr:
+    model:
+      key: 'Key'
+      value: 'Value'
+      typ: 'Data Type'
+      alterable: 'Alterable'
+      options: 'Options'
+    form:
+      submit:
+        new: 'Create Setting'
+        edit: 'Update Setting'
+        settings: 'Save Settings'
+    title:
+      index: 'Settings'
+      new: 'Create Setting'
+      edit: 'Edit Setting'
+      settings: 'Settings'
+    link:
+      destroy: 'Delete'
+      edit: 'Edit'
+      really_destroy: 'Really delete?'
+      new: 'Create Setting'
+      settings: 'To Settings'
+      index: 'All Settings'
+    settings: 
+      saved: 'Settings saved'
+    setting:
+      created: 'Setting created'
+      not_created: 'Setting could not be created'
+      not_created_value_not_in_options: 'Setting could not be created, because its value is not contained in options'
+      updated: 'Setting updated'
+      not_updated: 'Setting could not be updated'
+      not_updated_value_not_in_options: 'Setting could not be updated, because its value is not contained in options'
+      deleted: 'Setting deleted'
+      not_deleted: 'Setting could not be deleted'

data/config/routes.rb

@@ -0,0 +1,12 @@
+Rails.application.routes.draw do
+  # settr
+  if Settr.resources
+    namespace :settr do
+      resources 'settings' do
+        match 'settings', :on => :collection
+      end
+    end  
+  else
+    match 'settr/settings/settings' => 'settr/settings#settings'
+  end
+end

data/db/migrate/20110506184758_create_settr_settings.rb

@@ -0,0 +1,16 @@
+class CreateSettrSettings < ActiveRecord::Migration
+  def up
+    create_table :settr_settings do |t|
+      t.string    'key',        :unique => true
+      t.string    'value'
+      t.string    'typ'
+      t.string    'options',    :default => ''
+      t.boolean   'alterable',  :default => true
+      t.timestamps
+    end
+  end
+
+  def down
+    drop_table :settr_settings
+  end
+end

data/lib/generators/settr/install_generator.rb

@@ -0,0 +1,18 @@
+class Settr
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "install settr default files"
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer
+        copy_file 'settr.rb', 'config/initializers/settr.rb'
+      end
+      
+      def copy_and_run_migration
+        run 'rake settr_engine:install:migrations'
+        run 'rake db:migrate'
+      end
+    end
+  end
+end