cockpit 0.0.1.5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Lance Pollard (lancejpollard@gmail.com)
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+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 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.

data/README.markdown

@@ -0,0 +1,175 @@
+# Cockpit
+
+<q>Super DRY Settings for Ruby, Rails, and Sinatra Apps.</q>
+
+## Install
+
+    sudo gem install cockpit
+    
+## Usage
+
+### Migration
+
+    create_table :settings, :force => true do |t|
+      t.string :key
+      t.string :value
+      t.string :cast_as
+      t.string :configurable_type
+      t.integer :configurable_id
+    end
+
+### Setup (`config/initializers/settings.rb`)
+
+    Cockpit do
+      site do
+        title "Martini", :tooltip => "Set your title!"
+        tagline "Developer Friendly, Client Ready Blog with Rails 3"
+        keywords "Rails 3, Heroku, JQuery, HTML 5, Blog Engine, CSS3"
+        copyright "© 2010 Viatropos. All rights reserved."
+        timezones :value => lambda { TimeZone.first }, :options => lambda { TimeZone.all }
+        date_format "%m %d, %Y"
+        time_format "%H"
+        week_starts_on "Monday", :options => ["Monday", "Sunday", "Friday"]
+        language "en-US", :options => ["en-US", "de"]
+        touch_enabled true
+        touch_as_subdomain false
+        google_analytics ""
+        teasers :title => "Teasers" do
+          disable false
+          left 1, :title => "Left Teaser"
+          right 2
+          center 3
+        end
+        main_quote 1
+      end
+      asset :title => "Asset (and related) Settings" do
+        thumb do
+          width 100, :tip => "Thumb's width"
+          height 100, :tip => "Thumb's height"
+        end
+        medium do
+          width 600, :tip => "Thumb's width"
+          height 250, :tip => "Thumb's height"
+        end
+        large do
+          width 600, :tip => "Large's width"
+          height 295, :tip => "Large's height"
+        end
+      end
+      authentication :title => "Authentication Settings" do
+        use_open_id true
+        use_oauth true
+      end
+      front_page do
+        slideshow_tag "slideshow"
+        slideshow_effect "fade"
+      end
+      page do
+        per_page 10
+        feed_per_page 10
+      end
+      people do
+        show_avatars true
+        default_avatar "/images/missing-person.png"
+      end
+      social do
+        facebook "http://facebook.com/viatropos"
+        twitter "http://twitter.com/viatropos"
+      end
+      s3 do
+        key "my_key"
+        secret "my_secret"
+      end
+    end
+
+#### Get
+
+    Settings.get("site.title").value        #=> "Martini"
+    Settings.get("site.title.value")        #=> "Martini"
+    Settings("site.title").value            #=> "Martini"
+    Settings("site.title.value")            #=> "Martini"
+    Settings["site.title"].value            #=> "Martini"
+    Settings["site.title.value"]            #=> "Martini"
+    Settings.site.title.value               #=> "Martini" # doesn't pass through store yet
+    
+#### Set
+
+    Settings.set("site.title" => "Martini") #=> {:site => {:title => {:value => "Martini"}}}
+    Settings("site.title" => "Martini")     #=> {:site => {:title => {:value => "Martini"}}}
+    Settings["site.title"] = "Martini"      #=> {:site => {:title => {:value => "Martini"}}}
+    Settings.site.title = "Martini"         #=> {:site => {:title => {:value => "Martini"}}} # doesn't pass through store yet
+
+### Key points
+
+- Each node is any word you want
+- You can nest them arbitrarily deep
+- You can use Procs
+- Values are type casted
+- Settings can be defined in yaml or using the DSL.
+- The preferred way to _get_ values is `Settings("path.to.value").value`
+- You can add custom properties to each setting:
+  - `Settings("site.title").tooltip #=> "Set your title!"`
+- You have multiple storage options:
+  - `Settings.store = :db`: Syncs setting to/from ActiveRecord
+  - `Settings.store = :memory`: Stores everything in a Hash (memoized, super fast)
+- You can specify them on a per-model basis.
+
+Example:
+
+    class User < ActiveRecord::Base
+      acts_as_configurable :settings do
+        name "Lance", :title => "First Name", :options => ["Lance", "viatropos"]
+        favorite do
+          color "red"
+        end
+      end
+    end
+    
+    User.new.settings #=> <#Settings @tree={
+      :favorite => {
+        :color => {:type=>:string, :value=>"red"}
+      },
+      :name => {:type=>:string, :title=>"First Name", :value=>"Lance", :options=>["Lance", "Viatropos"]}
+    }/>
+    
+### Why
+
+There's no standard yet for organizing random properties in Rails apps.  And settings should be able to be modified through an interface (think Admin panel).
+
+Cockpit encapsulates the logic common to:
+
+- Options
+- Preferences
+- Settings
+- Configuration
+- Properties and Attributes
+- Key/Value stores
+
+Sometimes you need a global store, sometimes that global store needs to be customizable by the user, sometimes each user has their own set of configurations.  This handles all of those cases.
+
+## Todo
+
+- Settings should be sorted by the way they were constructed
+- Check type, so when it is saved it knows what to do.
+
+This ended up being very similar to i18n:
+
+- [http://guides.rubyonrails.org/i18n.html](http://guides.rubyonrails.org/i18n.html)
+- [I asked about this on the i18n lighthouse](http://i18n.lighthouseapp.com/projects/14947/tickets/21-abstract-out-configuration-functionality-from-i18n-into-separate-gem#ticket-21-1)
+
+I think the i18n gem should be broken down into two parts: Configuration (key/value store), and Translation.
+
+#### End Goal
+
+- Base key-value functionality gem, which allows you to store arbitrary key values in any database (similar to moneta).
+- i18n and Cockpit build on top of that
+
+### Alternatives
+
+- [Preferences](http://github.com/pluginaweek/preferences)
+- [SettingsGoo](http://rubygems.org/gems/settings-goo)
+- [RailsSettings](http://github.com/Squeegy/rails-settings)
+- [SimpleConfig](http://github.com/lukeredpath/simpleconfig)
+- [Configatron](http://github.com/markbates/configatron)
+- [RConfig](http://github.com/rahmal/rconfig)
+- [Serenity](http://github.com/progressions/serenity)

data/Rakefile

@@ -0,0 +1,78 @@
+require 'rake'
+require "rake/rdoctask"
+require 'rake/gempackagetask'
+
+spec = Gem::Specification.new do |s|
+  s.name              = "cockpit"
+  s.authors           = ["Lance Pollard"]
+  s.version           = "0.0.1.5"
+  s.summary           = "Cockpit: Super DRY Configuration for Ruby, Rails, and Sinatra Apps"
+  s.homepage          = "http://github.com/viatropos/cockpit"
+  s.email             = "lancejpollard@gmail.com"
+  s.description       = "Super DRY Configuration for Ruby, Rails, and Sinatra Apps"
+  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.require_path      = "lib"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec    = spec
+  pkg.package_dir = "pkg"
+end
+
+desc 'run unit tests'
+task :test do
+  Dir["test/**/*"].each do |file|
+    next unless File.basename(file) =~ /test_/
+    next unless File.extname(file) == ".rb"
+    system "ruby #{file}"
+  end
+end
+
+desc "Create .gemspec file (useful for github)"
+task :gemspec do
+  File.open("pkg/#{spec.name}.gemspec", "w") do |f|
+    f.puts spec.to_ruby
+  end
+end
+
+desc "Build the gem into the current directory"
+task :gem => :gemspec do
+  `gem build pkg/#{spec.name}.gemspec`
+end
+
+desc "Publish gem to rubygems"
+task :publish => [:package] do
+  %x[gem push pkg/#{spec.name}-#{spec.version}.gem]
+end
+
+desc "Print a list of the files to be put into the gem"
+task :manifest do
+  File.open("Manifest", "w") do |f|
+    spec.files.each do |file|
+      f.puts file
+    end
+  end
+end
+
+desc "Install the gem locally"
+task :install => [:package] do
+  File.mkdir("pkg") unless File.exists?("pkg")
+  command = "gem install pkg/#{spec.name}-#{spec.version} --no-ri --no-rdoc"
+  command = "sudo #{command}" if ENV["SUDO"] == true
+  sh %{#{command}}
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.markdown", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.markdown"
+  rdoc.title = spec.summary
+end
+
+task :yank do
+  `gem yank #{spec.name} -v #{spec.version}`
+end

data/init.rb

@@ -0,0 +1 @@
+File.dirname(__FILE__) + "/rails/init.rb"

data/lib/cockpit.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'active_support'
+require 'active_record'
+
+this = File.dirname(__FILE__)
+Dir["#{this}/cockpit/*"].each { |c| require c }
+
+class Settings
+  include Cockpit::Configuration
+end
+
+def Settings(*args, &block)
+  Settings.configure(*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"

data/lib/cockpit/cockpit.rb

@@ -0,0 +1,94 @@
+module Cockpit
+  
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    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
+
+      class_inheritable_accessor settings_name
+      has_many settings_name, :class_name => "Setting", :as => :configurable
+      
+      Settings { send(clazz_name, &block) }
+      
+      self.send("#{settings_name}=", ::Settings.for(clazz_name))
+
+      define_method settings_name do |*value|
+        unless @settings
+          @settings = self.class.send(settings_name).dup
+          @settings.configurable = self
+        end
+        
+        unless value.empty?
+          @settings[value.first]
+        else
+          @settings
+        end
+        # model-dependent settings.
+        # requires refactoring the Settings module
+        # so none of it uses class methods...
+      end
+      
+    end
+    
+    def acts_as_settable
+      belongs_to :configurable, :polymorphic => true
+    end
+  end
+  
+  def self.get_type(object)
+    result = case object
+      when Fixnum
+        :integer
+      when Array
+        :array
+      when Float # decimal
+        :float
+      when String
+        :string
+      when Proc
+        :proc
+      when TrueClass
+        :boolean
+      when FalseClass
+        :boolean
+      when DateTime
+        :datetime
+      when Time
+        :time
+      else
+        :string
+      end    
+  end
+  
+  def self.type_cast(object, type)
+    return object if type.nil?
+    result = case type.to_sym
+      when :integer
+        object.to_i
+      when :array
+        object.to_a
+      when :float, :decimal # decimal
+        object.to_f
+      when :string, :text
+        object.to_s
+      when :boolean
+        if object == "true" || object == true || object == "1" || object == 1 || object == "t"
+          true
+        else
+          false
+        end
+      when :datetime, :timestamp
+        object.is_a?(String) ? DateTime.parse(object) : object
+      when :time
+        object.is_a?(String) ? Time.parse(object) : object
+      else
+        object.to_s
+      end
+  end
+  
+end

data/lib/cockpit/configuration.rb

@@ -0,0 +1,218 @@
+module Cockpit
+  module Configuration
+  
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_eval do
+        include InstanceMethods
+      end
+    end
+    
+    module InstanceMethods
+      
+      attr_accessor :setting_class, :configurable
+      
+      def setting_class
+        @setting_class ||= ::Setting
+      end
+      
+      def initialize(*args, &block)
+        store.tree = args.extract_options!
+        value      = args
+        build(&block)
+      end
+      
+      def build(&block)
+        tree.instance_eval(&block) if block_given?
+      end
+      
+      def configurable=(object)
+        @configurable = object
+        store.configurable = object
+      end
+      
+      # something like this
+      # Settings.for(@user.id).set(:allow_email => params[:allow_email])
+      # or
+      # @user.settings(:allow_email => params[:allow_email])
+      def for(configurable_id)
+        self
+      end
+      
+      def each_setting(&block)
+        tree.each_setting(&block)
+      end
+      
+      def tree
+        store.tree
+      end
+      
+      def defaults
+        store.defaults
+      end
+      
+      def store
+        self.store = :memory if @store.nil?
+        @store
+      end
+      
+      def empty?
+        tree.empty?
+      end
+      
+      def store=(value)
+        options = {:configurable => configurable}
+        options[:tree] = @store.tree unless @store.nil?
+        @store = case value
+        when :memory
+          Cockpit::Store::Memory.new(self, options)
+        when :db
+          Cockpit::Store::Database.new(self, options)
+        else
+          value
+        end
+      end
+      
+      def get(path)
+        store.get(path)
+      end
+      alias_method :[], :get
+    
+      def get!(path)
+        store.get!(path)
+      end
+    
+      def set(value)
+        store.set(value)
+      end
+      
+      def set!(value)
+        store.set!(value)
+      end
+    
+      def []=(key, value)
+        store.set(key => value)
+      end
+      
+      def clear(options = {})
+        store.clear(options)
+      end
+      
+      def inspect
+        "<##{self.class.to_s} @tree=#{tree.inspect}/>"
+      end
+      
+      def to_yaml
+        to_hash.to_yaml
+      end
+      
+      def to_hash
+        store.tree.to_hash
+      end
+      
+      def method_missing(meth, *args, &block)
+        if args.empty?
+          store.get(meth)
+        else
+          store.set(meth, args.first)
+        end
+      end
+      
+    end
+  
+    module ClassMethods
+      
+      def setting_class
+        global.setting_class
+      end
+      
+      def global(&block)
+        @global ||= new
+        @global.build(&block)
+        @global
+      end
+      
+      def configure(*args, &block)
+        options = args.extract_options!
+        path = args.first
+        if path && !path.is_a?(Hash)
+          global[path]
+        elsif !options.empty?
+          global.set(options)
+        else
+          global(&block)
+        end
+      end
+      
+      # something like this
+      # Settings.for(@user.id).set(:allow_email => params[:allow_email])
+      # or
+      # @user.settings(:allow_email => params[:allow_email])
+      def for(name)
+        Settings.new(get(name).dup)
+      end
+      
+      def tree
+        global.tree
+      end
+      
+      def defaults
+        global.defaults
+      end
+      
+      def store
+        global.store
+      end
+      
+      def store=(value)
+        global.store = value
+      end
+      
+      def get(path)
+        global.get(path)
+      end
+      alias_method :[], :get
+    
+      def get!(path)
+        global.get!(path)
+      end
+    
+      def set(value)
+        global.set(value)
+      end
+      
+      def set!(value)
+        global.set!(value)
+      end
+    
+      def []=(key, value)
+        global.set(key => value)
+      end
+      
+      def clear(options = {})
+        global.clear(options)
+      end
+      
+      def empty?
+        global.empty?
+      end
+      
+      def inspect
+        global.inspect
+      end
+      
+      def to_yaml
+        global.to_yaml
+      end
+      
+      def to_hash
+        global.to_hash
+      end
+      
+      def method_missing(meth, *args, &block)
+        global.method_missing(meth, *args, &block)
+      end
+      
+    end
+  end
+end