fiona 0.0.9 → 0.0.10

data/README.markdown

@@ -6,70 +6,52 @@ Any JSON compatible datastructures and values are permitted (integer, float, str
 
 ## Requirements
 
-* Activerecord (tested with Rails 3.1)
+* Rails 3.x (tested with Rails 3.1)
 
 ## Gem Installation
 
 ### With bundler
 
-Add the following to your Gemfile and run the 'bundle' command to update your Gemfile.lock:
+Add the following to your Gemfile and run the 'bundle' command:
 
     gem "fiona"
 
-### Without bundler
+## Configuration
 
-    gem install "fiona"
-
-## configuration
-
-After you install the gem, you need to generate Fiona's migration:
+After you install the gem, you need to run Fiona's generator:
 
     rails generate fiona
 
-This should create a migration named create_fiona_tables.rb in your Rails project.
-
 ## Usage
 
-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):
+Create an instance of Template:
 
-    SETTINGS = SettingTemplate.find_by_key('my_settings')
+    t = Template.new(:key => 'some_template')
+    t.some_var = 'some sweet value'
+    t.save!
 
-You can now access your settings at any time:
+In the above example, 't' can have as many variables associated with it
+as you want.  Their values can be any JSON supported datatype including
+hashes, array, strings, etc.
 
-    puts SETTINGS.domain_name
+### Subclassing
 
-You can change your settings easily whenever you want:
+The Template class can be subclassed since it uses Rails STI.  The
+included SettingsTemplate feature is an example of this.
 
-    SETTINGS.whatever = 5
-    SETTINGS.save!
+### SettingsTemplate
 
-Note: you will need to restart your Rails processes whenever settings change in order for all processes to see the changes.
+Fiona comes with a template class named SettingsTemplate and an
+associated Rails initializer. Together they simplify the management of
+application settings and provide your application with globally
+accessible settings through the 'S' constant.
 
 ## 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
+## Contributing to Fiona
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.0.10

data/fiona.gemspec

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

data/lib/generators/fiona/templates/settings_initializer.rb

@@ -1,7 +1,10 @@
-# defaults = {
-#   app_name: 'My Awesome Rails App'
-# }
-#
-# S = SettingsTemplate.find_or_initialize_by_key('settings')
-# S.default_attributes = defaults
-# S.save!
+defaults = {
+  app_name: 'My Awesome Rails App'
+}
+
+begin
+  S = SettingsTemplate.find_or_initialize_by_key('settings')
+  S.default_attributes = defaults
+  S.save!
+rescue
+end

data/lib/template.rb

@@ -74,4 +74,8 @@ class Template < ActiveRecord::Base
       return nil
     end
   end
+
+  def all_attributes
+    return default_attributes.dup.merge(processed_attributes)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fiona
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-20 00:00:00.000000000Z
+date: 2011-12-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70154956904260 !ruby/object:Gem::Requirement
+  requirement: &70149798694900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3'
   type: :runtime
   prerelease: false
-  version_requirements: *70154956904260
+  version_requirements: *70149798694900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70154956901980 !ruby/object:Gem::Requirement
+  requirement: &70149798693100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70154956901980
+  version_requirements: *70149798693100
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70154956899720 !ruby/object:Gem::Requirement
+  requirement: &70149798692180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70154956899720
+  version_requirements: *70149798692180
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70154956896880 !ruby/object:Gem::Requirement
+  requirement: &70149798691140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70154956896880
+  version_requirements: *70149798691140
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70154956894440 !ruby/object:Gem::Requirement
+  requirement: &70149798690080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70154956894440
+  version_requirements: *70149798690080
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70154956892240 !ruby/object:Gem::Requirement
+  requirement: &70149798689060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70154956892240
+  version_requirements: *70149798689060
 description: Easily store and use template data with Rails.
 email: chad@remesch.com
 executables: []
@@ -120,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3628875406415562831
+      hash: 3233879644313255055
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: