setting_accessors 0.0.1

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Rails.application.config.session_store :cookie_store, key: '_dummy_session'

data/test/dummy/config/initializers/setting_accessors.rb

@@ -0,0 +1 @@
+SettingAccessors.setting_class = Setting

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#  self.include_root_in_json = true
+# end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,23 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/routes.rb

@@ -0,0 +1,56 @@
+Rails.application.routes.draw do
+  # The priority is based upon order of creation: first created -> highest priority.
+  # See how all your routes lay out with "rake routes".
+
+  # You can have the root of your site routed with "root"
+  # root 'welcome#index'
+
+  # Example of regular route:
+  #   get 'products/:id' => 'catalog#view'
+
+  # Example of named route that can be invoked with purchase_url(id: product.id)
+  #   get 'products/:id/purchase' => 'catalog#purchase', as: :purchase
+
+  # Example resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Example resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Example resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Example resource route with more complex sub-resources:
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', on: :collection
+  #     end
+  #   end
+
+  # Example resource route with concerns:
+  #   concern :toggleable do
+  #     post 'toggle'
+  #   end
+  #   resources :posts, concerns: :toggleable
+  #   resources :photos, concerns: :toggleable
+
+  # Example resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+end

data/test/dummy/config/secrets.yml

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: 9466152fe1a4826b5d3df6a72834d41c3771e28d1d9aa4bbdc46f5882bf118f2c1baba5ce51f0adeb66d1ee452c10635c5dcedcf6a94b92dfef756d3b75f95f5
+
+test:
+  secret_key_base: 0ed95a983cd27bdf250be838d482830715643bf7f110971bdac935a2d3437c1c2f5a8f6bc7d3fc97f8819a4f1628950311952e219783d53d810f043bf8708972
+
+# Do not keep production secrets in the repository,
+# instead read values from the environment.
+production:
+  secret_key_base: <%= ENV["SECRET_KEY_BASE"] %>

data/test/dummy/config/settings.yml

@@ -0,0 +1,23 @@
+#
+# This file specifies all settings used in the application
+# (be it record specific or global).
+#
+# The keys are the setting names, the values are a hash
+# containing validation options, type and default value
+#
+
+a_string:
+  type: string
+  default: "I am a string!"
+  validations:
+    presence: true
+
+a_number:
+  type: integer
+  default: "I am a Number!"
+
+a_boolean:
+  type: boolean
+  default: true
+  validations:
+    boolean: true

data/test/dummy/db/migrate/20150102112106_create_users.rb

@@ -0,0 +1,9 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :first_name
+      t.string :last_name
+      t.timestamps null: false
+    end
+  end
+end

data/test/dummy/db/migrate/20150102115329_create_settings.rb

@@ -0,0 +1,12 @@
+class CreateSettings < ActiveRecord::Migration
+  def change
+    create_table :settings do |t|
+      t.belongs_to :assignable, :polymorphic => true
+
+      t.string :name
+      t.text   :value
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy/db/schema.rb

@@ -0,0 +1,32 @@
+# 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.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# 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 that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20150102115329) do
+
+  create_table "settings", force: :cascade do |t|
+    t.integer  "assignable_id"
+    t.string   "assignable_type"
+    t.string   "name"
+    t.text     "value"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "users", force: :cascade do |t|
+    t.string   "first_name"
+    t.string   "last_name"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
+end

data/test/dummy/public/404.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/422.html

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/500.html

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+
+  div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+
+  div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+
+  div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/test/dummy/test/models/setting_test.rb

@@ -0,0 +1,131 @@
+require_relative '../../../test_helper'
+
+class SettingTest < ActiveSupport::TestCase
+  should validate_presence_of :name
+
+  #FIXME: This is currently setting assignable_type and assignable_id to "0" resp. "1" which breaks everything.
+  # should validate_uniqueness_of(:name).scoped_to([:assignable_type, :assignable_id])
+
+  context 'Global Setting Accessors (method missing)' do
+
+    should 'ignore a setting function if more than 1 argument is given' do
+      assert_raises(NoMethodError) { Setting.my_setting(1, 2, 3) }
+    end
+
+    should 'return nil for a non-existing setting' do
+      assert_nil Setting.gotta_catch_em_all
+    end
+
+    should 'create a new setting if necessary' do
+      assert Setting.count.zero?
+      assert Setting.gotta_catch_em_all = 'Pokemon!'
+      assert Setting.count == 1
+    end
+
+    should "return the setting's value for an existing setting" do
+      assert Setting.gotta_catch_em_all = 'Pokemon!'
+      assert_equal Setting.gotta_catch_em_all, 'Pokemon!'
+    end
+
+    should 'update an existing setting instead of creating a new one' do
+      assert Setting.count.zero?
+      assert Setting.gotta_catch_em_all = 'Pokemon!'
+      assert Setting.gotta_catch_em_all = 'Pokemon!'
+      assert Setting.count == 1
+    end
+
+    should 'return assignable specific settings if an assignable is given' do
+      ash         = User.create(:first_name => 'Ash', :last_name => 'Ketchum')
+      gary        = User.create(:first_name => 'Gary', :last_name => 'Oak')
+      team_rocket = User.create(:first_name => 'Jessie', :last_name => 'James')
+
+      assert Setting.create_or_update(:pokedex_count, 151, ash)
+      assert Setting.create_or_update(:pokedex_count, 1, gary)
+
+      assert_nil Setting.pokedex_count
+
+      assert_equal Setting.pokedex_count(ash), 151
+      assert_equal Setting.pokedex_count(gary), 1
+
+      #They don't want to be on file.
+      assert_nil Setting.pokedex_count(team_rocket)
+    end
+  end
+
+  context 'The create_or_update function' do
+    setup do
+      @ash  = User.create(:first_name => 'Ash', :last_name => 'Ketchum')
+    end
+
+    should 'create a new assigned setting if it did not exist before' do
+      assert Setting.count.zero?
+      Setting.create_or_update(:pokedex_count, 151, @ash)
+      assert Setting.count == 1
+    end
+
+    should 'update an assigned setting if it already exists' do
+      Setting.create_or_update(:pokedex_count, 150, @ash)
+      assert Setting.count == 1
+      Setting.create_or_update(:pokedex_count, 151, @ash)
+      assert Setting.count == 1
+      assert_equal Setting.pokedex_count(@ash), 151
+    end
+
+    should 'return a setting object by default' do
+      assert_instance_of Setting, Setting.create_or_update(:pokedex_count, 151, @ash)
+    end
+
+    should 'return just the value if wished' do
+      assert_equal Setting.create_or_update(:pokedex_count, 151, @ash, true), 151
+    end
+  end
+
+  context 'The globally_defined method' do
+    should 'return true for a setting which is defined in config/settings.yml' do
+      assert SettingAccessors::Internal.globally_defined_setting?('a_string')
+    end
+
+    should 'return false for a setting which is not defined in config/settings.yml' do
+      assert !SettingAccessors::Internal.globally_defined_setting?('something_different')
+    end
+  end
+
+  context 'setting_accessors' do
+    should 'return the default value as fallback if :fallback => :default is given' do
+      assert_equal 'I am a string!', User.new.a_string
+    end
+
+    should 'return the global setting value as fallback if :fallback => :global is given' do
+      Setting.a_number = 42
+      assert_equal 42, User.new.a_number
+    end
+
+    should 'return the given value as fallback if :fallback => VALUE is given' do
+      assert_equal false, User.new.a_boolean
+    end
+  end
+
+  context 'Class-Defined Settings' do
+    should 'have the type defined in the setting_accessor call' do
+      assert u = User.create(:first_name => 'a', :last_name => 'name', :locale => 'de')
+      assert s = Setting.setting_record(:locale, User.first)
+      assert_equal 'string', s.value_type.to_s
+    end
+
+    should 'not override global settings' do
+      assert_raises(ArgumentError) do
+        User.class_eval do
+          setting_accessor :a_string, :type => :integer
+        end
+      end
+    end
+
+    should 'use value fallbacks' do
+      assert_equal 'Oiski Poiski!', User.new.class_wise_with_value_fallback
+    end
+
+    should 'use default fallbacks' do
+      assert_equal 'Kapitanski', User.new.class_wise_with_default_fallback
+    end
+  end
+end