fiona 0.0.4 → 0.0.5

data/README.markdown

@@ -1,4 +1,4 @@
-# fiona - Rails 3 configuration data engine.
+# Fiona - Rails 3 configuration data engine.
 
 Fiona lets you store unstructured configuration data in your SQL database.
 Examples include application settings and template data.
@@ -8,17 +8,66 @@ Any JSON compatible datastructures and values are permitted (integer, float, str
 
 * Activerecord (tested with Rails 3.1)
 
-## Installation
+## Gem Installation
 
-    gem install fiona
+### With bundler
 
-If you are using bundler, add the following to your Gemfile:
+Add the following to your Gemfile and run the 'bundle' command to update your Gemfile.lock:
 
     gem "fiona"
 
+### Without bundler
+
+    gem install "fiona"
+
+## configuration
+
+After you install the gem, you need to generate Fiona's migration:
+
+    rails generate fiona
+
+This should create a migration named create_fiona_tables.rb in your Rails project.
+
 ## Usage
 
-TODO
+Fiona has uses two models (Template and TemplateAttribute).
+Template is an STI table so it is recommended that you subclass it as necessary.
+
+Example app/models/setting_template.rb:
+
+    class SettingTemplate < Template
+    end
+
+Create a template for application settings:
+
+    settings = SettingTemplate.new
+    settings.key = 'my_settings'
+    settings.app_name = 'My cool app'
+    settings.domain_name = 'somedomain.com'
+    settings.email_addresses = {:support => 'support@somedomain.com', :sales => 'sales@somedomain.com'}
+    settings.save!
+
+Create a convenient constant for accessing your settings (config/initializers/fiona.rb):
+
+    SETTINGS = SettingTemplate.find_by_key('my_settings')
+
+You can now access your settings at any time:
+
+    puts SETTINGS.domain_name
+
+You can change your settings easily whenever you want:
+
+    SETTINGS.whatever = 5
+    SETTINGS.save!
+
+Note: you will need to restart your Rails processes whenever settings change in order for all processes to see the changes.
+
+## TODO
+
+* Create a generator for creating subclasses of Template.
+* Keep projects clean by storing all template subclasses in app/templates instead of the models directory.
+* Create a singleton for simplifying template access.
+* Improve caching.
 
 ## Contributing to fiona
 
@@ -34,4 +83,3 @@ TODO
 
 Copyright (c) 2011 Chad Remesch. See LICENSE.txt for
 further details.
-

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/fiona.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "fiona"
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chad Remesch"]
-  s.date = "2011-12-19"
+  s.date = "2011-12-20"
   s.description = "Easily store and use template data with Rails."
   s.email = "chad@remesch.com"
   s.extra_rdoc_files = [

data/lib/template.rb

@@ -21,6 +21,8 @@ class Template < ActiveRecord::Base
       method = method.to_sym
       if processed_attributes.keys.include?(method)
         return processed_attributes[method]
+      elsif default_attributes.keys.include?(method)
+        return default_attributes[method]
       end
     end
 
@@ -54,4 +56,21 @@ class Template < ActiveRecord::Base
 
     return @processed_attributes
   end
+
+  def default_attributes
+    return @default_attributes || {}
+  end
+
+  def default_attributes=(defaults)
+    @default_attributes = defaults
+  end
+
+  def delete_attribute(attribute)
+    if processed_attributes.include?(attribute)
+      raw_attributes.where(:key => attribute).map{ |a| a.destroy }
+      return processed_attributes.delete(attribute)
+    else
+      return nil
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiona
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-19 00:00:00.000000000Z
+date: 2011-12-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70140526965060 !ruby/object:Gem::Requirement
+  requirement: &70318901733500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *70140526965060
+  version_requirements: *70318901733500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70140526964560 !ruby/object:Gem::Requirement
+  requirement: &70318901732620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70140526964560
+  version_requirements: *70318901732620
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70140526964020 !ruby/object:Gem::Requirement
+  requirement: &70318901723420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70140526964020
+  version_requirements: *70318901723420
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70140526963280 !ruby/object:Gem::Requirement
+  requirement: &70318901722780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70140526963280
+  version_requirements: *70318901722780
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70140526962700 !ruby/object:Gem::Requirement
+  requirement: &70318901722100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70140526962700
+  version_requirements: *70318901722100
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70140526962140 !ruby/object:Gem::Requirement
+  requirement: &70318901721520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70140526962140
+  version_requirements: *70318901721520
 description: Easily store and use template data with Rails.
 email: chad@remesch.com
 executables: []
@@ -118,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 875471196289828848
+      hash: -1829553723956385784
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: