ledermann-rails-settings 1.2.0 → 2.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d35191c6b15823ec6934c9b66a8cf4291aa552c79bfe1ac6e24b2298a3bf6942
+  data.tar.gz: 1dabb6089d5894acc9f16aa57637daded9e9751c590b924fe3a8d3e074e01ac8
+SHA512:
+  metadata.gz: 2556adc7367efd4acd8a208d342d4f485ea356a79b1bac8971785bb2d3ab9ea3d31ec13b2008fe4e58171eb181090e7d7b18f3a242ee220fee9703777c7ca387
+  data.tar.gz: b391a6f0c86c8abab56b8b68b20161fbe4981c7d08acfa5766416d097d0c2ada7c77db29182b46b62853f0e822b77cc21ae300b3f42657c50cdebc7d83bdf4a8

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+coverage/*

data/.travis.yml

@@ -1,9 +1,17 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.3
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 gemfile:
-  - ci/Gemfile.rails-2.3.x
-#  - ci/Gemfile.rails-3.0.x
-  - ci/Gemfile.rails-3.1.x
-  - ci/Gemfile.rails-3.2.x
+  - ci/Gemfile-rails-4-2
+  - ci/Gemfile-rails-5-0
+  - ci/Gemfile-rails-5-1
+  - ci/Gemfile-rails-5-2
+  - ci/Gemfile-rails-6-0
+matrix:
+  exclude:
+    - rvm: 2.4.6
+      gemfile: ci/Gemfile-rails-6-0
+before_install: gem update bundler
+sudo: false

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rails-settings.gemspec
 gemspec

data/MIT-LICENSE

@@ -1,5 +1,6 @@
-Copyright (c) 2006 Alex Wayne
-Some additional features added 2009-2012 by Georg Ledermann
+Copyright (c) 2012-2019 Georg Ledermann
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -14,8 +15,8 @@ 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 PURPOa AND
-NONINFRINGEMENT. IN NO EVENT SaALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,158 +1,171 @@
-# Settings Gem/Plugin for Rails
-
-[![Build Status](https://secure.travis-ci.org/ledermann/rails-settings.png)](http://travis-ci.org/ledermann/rails-settings)
-
-Settings is a gem/plugin that makes managing a table of key/value pairs easy. Think of it like a Hash stored in you database, that uses simple ActiveRecord like methods for manipulation. Keep track of any setting that you don't want to hard code into your rails app. You can store any kind of object: Strings, numbers, arrays, or any object which can be noted as YAML.
-
-
-## Requirements
-
-Rails 2.3.x, 3.1.x or 3.2.x (due to an [issue with Rails caching](https://github.com/rails/rails/pull/2010) it does not work properly with Rails 3.0.x)
-
-Tested with Ruby 1.8.7 and 1.9.3
-
-
-## Installation
-
-Include the gem in your Gemfile
-
-    gem 'ledermann-rails-settings', :require => 'rails-settings'
-
-or install as a plugin:
-
-    ./script/plugin install git://github.com/ledermann/rails-settings.git
-
-
-You have to create the table used by the Settings model by using this migration:
-
-    class CreateSettingsTable < ActiveRecord::Migration
-      def self.up
-        create_table :settings, :force => true do |t|
-          t.string  :var,         :null => false
-          t.text    :value
-          t.integer :target_id
-          t.string  :target_type, :limit => 30
-          t.timestamps
-        end
-
-        add_index :settings, [ :target_type, :target_id, :var ], :unique => true
-      end
-
-      def self.down
-        drop_table :settings
-      end
-    end
-    
-Now update your database with:
-
-    rake db:migrate
-
-## Usage
-
-The syntax is easy. First, lets create some settings to keep track of:
-
-    Settings.admin_password = 'supersecret'
-    Settings.date_format    = '%m %d, %Y'
-    Settings.cocktails      = ['Martini', 'Screwdriver', 'White Russian']
-    Settings.foo            = 123
-    Settings.credentials    = { :username => 'tom', :password => 'secret' }
-
-Now lets read them back:
-
-    Settings.foo
-    # => 123
-
-Changing an existing setting is the same as creating a new setting:
-
-    Settings.foo = 'super duper bar'
-
-For changing an existing setting which is a Hash, you can merge new values with existing ones:
-
-    Settings.merge! :credentials, :password => 'topsecret'
-    Settings.credentials
-    # => { :username => 'tom', :password => 'topsecret' }
-
-Decide you dont want to track a particular setting anymore?
-
-    Settings.destroy :foo
-    Settings.foo
-    # => nil
-
-Want a list of all the settings (including defaults)?
-
-    Settings.all
-    # => { 'admin_password' => 'super_secret', 'date_format' => '%m %d, %Y' }
-
-You need name spaces and want a list of settings for a give name space? Just choose your prefered named space delimiter and use Settings.all like this:
-
-    Settings['preferences.color'] = :blue
-    Settings['preferences.size'] = :large
-    Settings['license.key'] = 'ABC-DEF'
-    Settings.all('preferences.')
-    # => { 'preferences.color' => :blue, 'preferences.size' => :large }
-
-Settings may be bound to any existing ActiveRecord object. Define this association like this:
-
-    class User < ActiveRecord::Base
-      has_settings
-    end
-
-Then you can set/get a setting for a given user instance just by doing this:
-
-    user = User.find(123)
-    user.settings.color = :red
-    user.settings.color
-    # => :red
-    
-    user.settings.all
-    # => { "color" => :red }
-
-
-Set defaults for certain settings of your app.  This will cause the defined settings to return with the
-specified value even if they are not in the database.  Make a new file in config/initializers/settings.rb
-with the following:
-
-    Settings.defaults[:foo] = 'footastic'
-  
-Now even if the database is completely empty, you app will have some intelligent defaults:
-
-    Settings.foo
-    # => 'footastic'
-
-Defaults can be defined on the model level, too:
-
-    User.settings.foo = 'bar'
-    User.find(123).settings.foo
-    # => 'bar'
-
-If the setting doesn't exist on the object or the model, you'll get the default, as expected:
-
-    Settings.defaults[:some_default] = 'foo'
-    
-    User.settings.some_default
-    # => 'foo'
-    
-    User.find(123).settings.some_default
-    # => 'foo'
-
-
-I you want to find users having or not having some settings, there are named scopes for this:
-
-    User.with_settings
-    # returns a scope of users having any setting
-    
-    User.with_settings_for('color')
-    # returns a scope of users having a 'color' setting
-  
-    User.without_settings
-    # returns a scope of users having no setting at all (means user.settings.all == {})
-    
-    User.without_settings('color')
-    # returns a scope of users having no 'color' setting (means user.settings.color == nil)
-
-For better performance, you can enable caching, e.g.:
-
-    Settings.cache = ActiveSupport::Cache::MemoryStore.new
-    Settings.cache_options = { :expires_in => 5.minutes }
-
-That's all there is to it! Enjoy!
+# Settings for Rails
+
+[![Build Status](https://travis-ci.org/ledermann/rails-settings.svg?branch=master)](https://travis-ci.org/ledermann/rails-settings)
+[![Code Climate](https://codeclimate.com/github/ledermann/rails-settings.svg)](https://codeclimate.com/github/ledermann/rails-settings)
+[![Coverage Status](https://coveralls.io/repos/ledermann/rails-settings/badge.svg?branch=master)](https://coveralls.io/r/ledermann/rails-settings?branch=master)
+
+Ruby gem to handle settings for ActiveRecord instances by storing them as serialized Hash in a separate database table. Namespaces and defaults included.
+
+## Requirements
+
+* Ruby 2.4 or newer
+* Rails 4.2 or newer (including Rails 6)
+
+
+## Installation
+
+Include the gem in your Gemfile and run `bundle` to install it:
+
+```ruby
+gem 'ledermann-rails-settings'
+```
+
+Generate and run the migration:
+
+```shell
+rails g rails_settings:migration
+rake db:migrate
+```
+
+
+## Usage
+
+### Define settings
+
+```ruby
+class User < ActiveRecord::Base
+  has_settings do |s|
+    s.key :dashboard, :defaults => { :theme => 'blue', :view => 'monthly', :filter => false }
+    s.key :calendar,  :defaults => { :scope => 'company'}
+  end
+end
+```
+
+If no defaults are needed, a simplified syntax can be used:
+
+```ruby
+class User < ActiveRecord::Base
+  has_settings :dashboard, :calendar
+end
+```
+
+Every setting is handled by the class `RailsSettings::SettingObject`. You can use your own class, e.g. for validations:
+
+```ruby
+class Project < ActiveRecord::Base
+  has_settings :info, :class_name => 'ProjectSettingObject'
+end
+
+class ProjectSettingObject < RailsSettings::SettingObject
+  validate do
+    unless self.owner_name.present? && self.owner_name.is_a?(String)
+      errors.add(:base, "Owner name is missing")
+    end
+  end
+end
+```
+
+In case you need to define settings separatedly for the same models, you can use the persistent option
+
+```ruby
+module UserDashboardConcern
+  extend ActiveSupport::Concern
+
+  included do
+    has_settings persistent: true do |s|
+      s.key :dashboard
+    end
+  end
+end
+
+class User < ActiveRecord::Base
+  has_settings persistent: true do |s|
+    s.key :calendar
+  end
+end
+```
+
+### Set settings
+
+```ruby
+user = User.find(1)
+user.settings(:dashboard).theme = 'black'
+user.settings(:calendar).scope = 'all'
+user.settings(:calendar).display = 'daily'
+user.save! # saves new or changed settings, too
+```
+
+or
+
+```ruby
+user = User.find(1)
+user.settings(:dashboard).update! :theme => 'black'
+user.settings(:calendar).update! :scope => 'all', :display => 'daily'
+```
+
+
+### Get settings
+
+```ruby
+user = User.find(1)
+user.settings(:dashboard).theme
+# => 'black
+
+user.settings(:dashboard).view
+# => 'monthly'  (it's the default)
+
+user.settings(:calendar).scope
+# => 'all'
+```
+
+### Delete settings
+
+```ruby
+user = User.find(1)
+user.settings(:dashboard).update! :theme => nil
+
+user.settings(:dashboard).view = nil
+user.settings(:dashboard).save!
+```
+
+### Using scopes
+
+```ruby
+User.with_settings
+# => all users having any setting
+
+User.without_settings
+# => all users without having any setting
+
+User.with_settings_for(:calendar)
+# => all users having a setting for 'calendar'
+
+User.without_settings_for(:calendar)
+# => all users without having settings for 'calendar'
+```
+
+### Eager Loading
+```ruby
+User.includes(:setting_objects)
+# => Eager load setting_objects when querying many users
+```
+
+## Compatibility
+
+Version 2 is a complete rewrite and has a new DSL, so it's **not** compatible with Version 1. In addition, Rails 2.3 is not supported anymore. But the database schema is unchanged, so you can continue to use the data created by 1.x, no conversion is needed.
+
+If you don't want to upgrade, you find the old version in the [1.x](https://github.com/ledermann/rails-settings/commits/1.x) branch. But don't expect any updates there.
+
+
+## Changelog
+
+See https://github.com/ledermann/rails-settings/releases
+
+
+## License
+
+MIT License
+
+Copyright (c) 2012-2019 [Georg Ledermann](http://www.georg-ledermann.de)
+
+This gem is a complete rewrite of [rails-settings](https://github.com/Squeegy/rails-settings) by [Alex Wayne](https://github.com/Squeegy)

data/Rakefile

@@ -1,11 +1,6 @@
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << 'lib' << 'test'
-  t.test_files = Dir.glob("test/**/*_test.rb")
-  t.verbose = true
-end
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
-task :default => :test
+RSpec::Core::RakeTask.new(:spec)
 
-require 'bundler/gem_tasks'
+task :default => :spec

data/ci/Gemfile-rails-4-2

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 4.2.11'
+gem 'protected_attributes' if ENV['PROTECTED_ATTRIBUTES'] == 'true'
+gem 'sqlite3', '~> 1.3.6'
+
+gemspec :path => "../"

data/ci/Gemfile-rails-5-0

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.0.7'
+gem 'sqlite3', '~> 1.3.6'
+
+gemspec :path => "../"

data/ci/Gemfile-rails-5-1

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.1.7'
+gem "sqlite3", "~> 1.3", ">= 1.3.6"
+
+gemspec :path => "../"

data/ci/Gemfile-rails-5-2

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.2.3'
+gem "sqlite3", "~> 1.3", ">= 1.3.6"
+
+gemspec :path => "../"