cockpit 0.0.1.5 → 0.0.1.7

data/README.markdown

@@ -2,6 +2,31 @@
 
 <q>Super DRY Settings for Ruby, Rails, and Sinatra Apps.</q>
 
+I am going to use this in all future gems that need configurable variables.  Reason being, every gem uses _some_ configurable variables, and you end up writing the same code over and over again.
+
+This will make it so if say 10 gems have custom settings, you can change this:
+
+    Paperclip.config  = ...
+    S3.configure      = ...
+    Authlogic.setup   = ...
+    MyApp.settings    = ....
+    
+to this:
+
+    Settings do
+      paperclip       ...
+      s3              ...
+      authentication  ...
+      app             ...
+    end
+
+    Paperclip.config  = Settings(:paperclip)
+    S3.configure      = Settings(:s3)
+    Authlogic.setup   = Settings(:authentication)
+    MyApp.settings    = Settings(:app)
+    
+Which translates to 1, uniform, clean, configuration file.
+
 ## Install
 
     sudo gem install cockpit
@@ -149,8 +174,32 @@ Sometimes you need a global store, sometimes that global store needs to be custo
 
 ## Todo
 
+- Add ability to `freeze` certain branches of the tree (so plugins can use it and know `Settings.clear` won't remove it)
 - Settings should be sorted by the way they were constructed
 - Check type, so when it is saved it knows what to do.
+- Store global declarations in memory
+- Create "context" for each set of settings, giving it its own `tree`.  Allows mimicking subclasses.
+- `Settings` should be a collection of trees or `contexts`:
+    Settings
+      user
+        global
+          default
+          user_a
+          user_b
+      widget
+        global
+          default
+          widget_a
+          widget_b
+        text
+          default
+          widget_a
+          widget_b
+        social
+          default
+          widget_a
+          widget_b
+    Settings.for(:widget, :social) #=> default social widget settings.
 
 This ended up being very similar to i18n:
 
@@ -161,7 +210,7 @@ I think the i18n gem should be broken down into two parts: Configuration (key/va
 
 #### End Goal
 
-- Base key-value functionality gem, which allows you to store arbitrary key values in any database (similar to moneta).
+- Base key-value functionality gem, which allows you to store arbitrary key values in any database (similar to moneta).  Should store settings in MongoDB by default.
 - i18n and Cockpit build on top of that
 
 ### Alternatives
@@ -172,4 +221,5 @@ I think the i18n gem should be broken down into two parts: Configuration (key/va
 - [SimpleConfig](http://github.com/lukeredpath/simpleconfig)
 - [Configatron](http://github.com/markbates/configatron)
 - [RConfig](http://github.com/rahmal/rconfig)
-- [Serenity](http://github.com/progressions/serenity)
+- [Serenity](http://github.com/progressions/serenity)
+- [ApplicationSettings](http://github.com/bradhaydon/application_settings)

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/gempackagetask'
 spec = Gem::Specification.new do |s|
   s.name              = "cockpit"
   s.authors           = ["Lance Pollard"]
-  s.version           = "0.0.1.5"
+  s.version           = "0.0.1.7"
   s.summary           = "Cockpit: Super DRY Configuration for Ruby, Rails, and Sinatra Apps"
   s.homepage          = "http://github.com/viatropos/cockpit"
   s.email             = "lancejpollard@gmail.com"
@@ -13,7 +13,7 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc          = false
   s.rubyforge_project = "cockpit"
   s.platform          = Gem::Platform::RUBY
-  s.files             = %w(README.markdown Rakefile init.rb MIT-LICENSE) + Dir["{lib,rails,test}/**/*"] - Dir["test/tmp"]
+  s.files             = %w(README.markdown Rakefile init.rb MIT-LICENSE) + Dir["{lib,rails,test,app}/**/*"] - Dir["test/tmp"]
   s.require_path      = "lib"
 end
 

data/app/models/setting.rb

@@ -0,0 +1,59 @@
+class Setting < ActiveRecord::Base
+  acts_as_settable
+  
+  # set_table_name 'settings'
+  # attr_protected :is_proc, :interpolations
+  
+  # serialize :value
+  # serialize :interpolations, Array
+  
+  def save_with_setting
+    if save_without_setting
+       # update hash, eventually, just in case
+    end
+  end
+  alias_method_chain :save, :setting
+  
+  class << self
+    # adjust the arguments, so we find automatically by key
+    def find(*args)
+      key     = args.first
+      unless key.to_s =~ /^(all|first|last)$/
+        args[0] = :first
+        options = args.extract_options!
+        options[:conditions] = {:key => key.to_s} if key
+        args << options
+      end
+      result = super(*args)
+      # sync the global hash if necessary
+      sync_settings_hash(result)
+      
+      result
+    end
+    
+    def scoped(options = {}, &block)
+      result = super(options, &block)
+      sync_settings_hash(result)
+      result
+    end
+    
+    def sync_settings_hash(result)
+      return unless result
+      if result.is_a?(Array) || (defined?(ActiveRecord::Relation) && result.is_a?(ActiveRecord::Relation))
+        result.each do |record|
+          sync_setting(record)
+        end
+      else
+        sync_setting(result)
+      end
+    end
+    
+    def sync_setting(record)
+      record.value = Cockpit.type_cast(record.value, record.cast_as)
+      if record.respond_to?(:key) && record.configurable.nil?
+        Settings.store.set_one_without_database(record.key, record.value)
+      end
+    end
+  end
+  
+end

data/lib/cockpit/cockpit.rb

@@ -5,7 +5,12 @@ module Cockpit
   end
   
   module ClassMethods
-    def acts_as_configurable(*args, &block)      
+    # can be "unique_by_key"
+    # settings :text do
+    #   ...
+    # settings :social do
+    #   ...
+    def acts_as_configurable(*args, &block)
       options = args.extract_options!
       settings_name = (args.shift || "settings").to_s
       clazz_name = self.to_s.downcase.split("::").last
@@ -34,6 +39,8 @@ module Cockpit
       end
       
     end
+    alias configurable acts_as_configurable
+    alias settings acts_as_configurable
     
     def acts_as_settable
       belongs_to :configurable, :polymorphic => true

data/lib/cockpit/configuration.rb

@@ -132,10 +132,10 @@ module Cockpit
         @global
       end
       
-      def configure(*args, &block)
+      def define!(*args, &block)
         options = args.extract_options!
         path = args.first
-        if path && !path.is_a?(Hash)
+        if path && !path.is_a?(Hash) && !block_given?
           global[path]
         elsif !options.empty?
           global.set(options)

data/lib/cockpit/tree_hash.rb

@@ -96,8 +96,11 @@ module Cockpit
         options = args.extract_options!
         meth    = meth.to_s.gsub("=", "").to_sym
         if args.empty?
-          return self[meth] if self.has_key?(meth)
-          found = get(meth).set_attributes(options)
+          if self.has_key?(meth)
+            found = self[meth]
+          else
+            found = get(meth).set_attributes(options)
+          end
           found = found.instance_eval(&block) if block_given?
           found
         else

data/lib/cockpit.rb

@@ -2,21 +2,21 @@ require 'rubygems'
 require 'active_support'
 require 'active_record'
 
-this = File.dirname(__FILE__)
+this = File.expand_path(File.dirname(__FILE__))
 Dir["#{this}/cockpit/*"].each { |c| require c }
 
 class Settings
   include Cockpit::Configuration
 end
 
+ActiveRecord::Base.send(:include, Cockpit) if defined?(ActiveRecord::Base)
+
 def Settings(*args, &block)
-  Settings.configure(*args, &block)
+  Settings.define!(*args, &block)
 end
 
 def Cockpit(*args, &block)
   Settings(*args, &block)
 end
 
-ActiveRecord::Base.send(:include, Cockpit) if defined?(ActiveRecord::Base)
-
-require "#{this}/../app/models/setting.rb"
+require File.expand_path("#{this}/../app/models/setting.rb")

data/test/lib/database.rb

@@ -14,9 +14,10 @@ ActiveRecord::Schema.define(:version => 1) do
     t.string :cast_as
     t.string :configurable_type
     t.integer :configurable_id
+    t.string :context
   end
   
-  create_table "users", :force => true do |t|
+  create_table :users, :force => true do |t|
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: cockpit
 version: !ruby/object:Gem::Version 
-  hash: 65
+  hash: 69
   prerelease: false
   segments: 
   - 0
   - 0
   - 1
-  - 5
-  version: 0.0.1.5
+  - 7
+  version: 0.0.1.7
 platform: ruby
 authors: 
 - Lance Pollard
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-19 00:00:00 -07:00
+date: 2010-07-02 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -48,6 +48,7 @@ files:
 - test/test_settings.rb
 - test/test_settings_in_database.rb
 - test/test_settings_on_model.rb
+- app/models/setting.rb
 has_rdoc: true
 homepage: http://github.com/viatropos/cockpit
 licenses: []