settler 1.0.0 → 1.0.1

data/README.rdoc

@@ -23,60 +23,62 @@ Or install as a plugin if you must.  But gems are cooler.
 == Setup
 
 * You must create the table used by the Setting model and install an initial configuration file. Simply run this command:
-  ruby script/generate settler
+  
+    ruby script/generate settler
 
 * This will create a migration and will add a settler.yml configuration file in your config directory. Now just migrate the database:
-  rake db:migrate
+  
+    rake db:migrate
   
 * Next, you'll have to edit the settler.yml file, of which the details are described in the next section.
 
 * You can manually set the configuration file source and default namespace as follows:
-  * Settler.source = '/path/to/my/settler.yml'
-  * Settler.namespace = 'staging'
+  - Settler.source = '/path/to/my/settler.yml'
+  - Settler.namespace = 'staging'
   
 == Configuration
 
 The initial version of settler.yml contains example settings for every default Rails environment. A setting consists of at least a key and a value. Consider the following example:
 
-  google_analytics_key: 
-    alt: Google analytics key
-    value: 'UA-xxxxxx-x'
-    editable: true
-    deletable: false
-    validations:
-      presence: true
+    google_analytics_key: 
+      alt: Google analytics key
+      value: 'UA-xxxxxx-x'
+      editable: true
+      deletable: false
+      validations:
+        presence: true
 
 In this case, 'google_analytics_key' is the key of the setting. Every nested property is either an attribute of the setting or a list of validations:
 
 * Alt, value, editable and deletable are attributes of the Setting model. If a Setting with a given key does not exist, it is created with the attributes found. Therefore, you can consider these attributes as the default values for the setting.
 * Validations are not part of every setting, but are loaded on validation of a Setting instance. They apply to the value of the setting. The following validations can be created:
-  * 'presence',  true/false.
-  * 'inclusion', followed by a YAML array (e.g. ['a','b','c']). Accepts a comma separated string as well.
+  - 'presence',  true/false.
+  - 'inclusion', followed by a YAML array (e.g. ['a','b','c']). Accepts a comma separated string as well.
 
-Note that you can use ERB in the configuration file if you need to. For example:
+  Note that you can use ERB in the configuration file if you need to. For example:
 
-  google_analytics_key: 
-    value: '<%= GOOGLE_ANALYTICS_KEY %>'
+    google_analytics_key: 
+      value: '<%= GOOGLE_ANALYTICS_KEY %>'
 
-will evaluate the GOOGLE_ANALYTICS_KEY constant.
+  will evaluate the GOOGLE_ANALYTICS_KEY constant.
 
 == Access settings
 
 * Accessors will be created for every defined setting, returning a Setting instance:
 
-  > Settler.google_analytics_key
-  Setting Load (0.7ms)   SELECT * FROM "settings" WHERE ("settings"."key" = 'google_analytics_key') LIMIT 1
-  +----+----------------------+----------------------+------------+----------+-----------+-------------------------+-------------------------+
-  | id | key                  | alt                  | value      | editable | deletable | created_at              | updated_at              |
-  +----+----------------------+----------------------+------------+----------+-----------+-------------------------+-------------------------+
-  | 6  | google_analytics_key | Google analytics key | UA-xxxxx-x | true     | false     | 2010-09-22 15:04:06 UTC | 2010-09-22 15:04:06 UTC |
-  +----+----------------------+----------------------+------------+----------+-----------+-------------------------+-------------------------+
+    >> Settler.google_analytics_key
+    Setting Load (0.7ms)   SELECT * FROM "settings" WHERE ("settings"."key" = 'google_analytics_key') LIMIT 1
+    +----+----------------------+----------------------+------------+----------+-----------+
+    | id | key                  | alt                  | value      | editable | deletable |
+    +----+----------------------+----------------------+------------+----------+-----------+
+    | 6  | google_analytics_key | Google analytics key | UA-xxxxx-x | true     | false     |
+    +----+----------------------+----------------------+------------+----------+-----------+
   
 * You can access a setting's value quickly by using the index operator:
 
-  > Settler[:google_analytics_key]
-  Setting Load (0.7ms)   SELECT * FROM "settings" WHERE ("settings"."key" = 'google_analytics_key') LIMIT 1
-  => "UA-xxxxx-x"
+    >> Settler[:google_analytics_key]
+    Setting Load (0.7ms)   SELECT * FROM "settings" WHERE ("settings"."key" = 'google_analytics_key') LIMIT 1
+    => "UA-xxxxx-x"
 
 == Changing / Destroying settings
 
@@ -84,52 +86,51 @@ will evaluate the GOOGLE_ANALYTICS_KEY constant.
 
 * By default, settings will only be editable or deletable iff the corresponding attribute is set to 'true'. This will be enforced before saving or destroying a record:
 
-  > Settler.google_analytics_key.destroy
-  Setting Load (0.7ms)   SELECT * FROM "settings" WHERE ("settings"."key" = 'google_analytics_key') LIMIT 1
-  => false
+    >> Settler.google_analytics_key.destroy
+    Setting Load (0.7ms)   SELECT \* FROM "settings" WHERE ("settings"."key" = 'google_analytics_key') LIMIT 1
+    => false
   
-* The Setting model performs a soft delete when it is destroyed, meaning the record is not really destroyed, but just marked as deleted. The reason for doing this is because settings are reloaded from the configuration file when your application is (re)started, unless a setting is already available in the database. Therefore, it should know about all deleted settings, otherwise it would re-insert the
-deleted setting. If you want to enforce this behaviour, use Setting#delete instead.
+* The Setting model performs a soft delete when it is destroyed, meaning the record is not really destroyed, but just marked as deleted. The reason for doing this is because settings are reloaded from the configuration file when your application is (re)started, unless a setting is already available in the database. Therefore, it should know about all deleted settings, otherwise it would re-insert the deleted setting. If you want to enforce this behaviour, use Setting#delete instead.
 
 == Advanced usage
   
 * When you define an inclusion validation on a setting, you can access these values for use in web forms by calling 'valid_values' on the setting:
 
-  > Settler.search_algorithm.valid_values
-  Setting Load (0.7ms)   SELECT * FROM "settings" WHERE ("settings"."key" = 'search_algorithm') LIMIT 1
-  => ["ferret", "sphinx"]
+    >> Settler.search_algorithm.valid_values
+    Setting Load (0.7ms)   SELECT * FROM "settings" WHERE ("settings"."key" = 'search_algorithm') LIMIT 1
+    => ["ferret", "sphinx"]
 
-NB: This method returns nil when valid values cannot be found.
+  NB: This method returns nil when valid values cannot be found.
 
 * Overriding setting attributes in the configuration is not as easy as it seems, since YAML doesn't support nested node merges. When overriding specific setting attributes, you should therefore do something like this:
 
-  settings: &settings
-    google_analytics_key: &google
-      alt: Google analytics key
-      value: 'UA-xxxxxx-x'
-
-  development:
-    <<: *settings  
-    google_analytics_key:
-      <<: *google
-      alt: Development Google analytics key
-      value: 'UA-xxxxxx-1'    
+    settings: &settings
+      google_analytics_key: &google
+        alt: Google analytics key
+        value: 'UA-xxxxxx-x'
+
+    development:
+      <<: *settings  
+      google_analytics_key:
+        <<: *google
+        alt: Development Google analytics key
+        value: 'UA-xxxxxx-1'    
     
 * Report missing / raise missing
   
-* You can tell Settler to report missing attributes:
+  * You can tell Settler to report missing attributes:
 
-  Settler.report_missing = true
+      Settler.report_missing = true
 
-This will output a warning to STDOUT and the Rails logger to notify you that a missing setting was requested.
+    This will output a warning to STDOUT and the Rails logger to notify you that a missing setting was requested.
 
-* It is also possible to raise an exception instead when requesting missing attributes:
+  * It is also possible to raise an exception instead when requesting missing attributes:
 
-  Settler.raise_missing = true
+      Settler.raise_missing = true
 
 == To do
 
-- Add more validations, for now only 'presence' and 'inclusion' are supported.
+* Add more validations, for now only 'presence' and 'inclusion' are supported.
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/settler.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{settler}
+  s.version = "1.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Reinier de Lange"]
+  s.date = %q{2010-09-23}
+  s.description = %q{This gem is a combination of the Squeegy's rails-settings and Binarylogic's settingslogic gem, meaning it reads its configuration from a YAML file, but stores all settings in the database as well for on the fly changes.}
+  s.email = %q{r.j.delange@nedforce.nl}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "generators/settler/settler_generator.rb",
+     "generators/settler/templates/migration.rb",
+     "generators/settler/templates/settler.yml",
+     "init.rb",
+     "lib/hash_extension.rb",
+     "lib/setting.rb",
+     "lib/settler.rb",
+     "settler.gemspec",
+     "test/database.yml",
+     "test/debug.log",
+     "test/helper.rb",
+     "test/schema.rb",
+     "test/settler.yml",
+     "test/test_settler.rb"
+  ]
+  s.homepage = %q{http://github.com/moiristo/settler}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Settler manages global application settings in Rails}
+  s.test_files = [
+    "test/helper.rb",
+     "test/schema.rb",
+     "test/test_settler.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Reinier de Lange
@@ -41,6 +41,7 @@ files:
 - lib/hash_extension.rb
 - lib/setting.rb
 - lib/settler.rb
+- settler.gemspec
 - test/database.yml
 - test/debug.log
 - test/helper.rb