settler 1.2.0 → 1.2.1

data/README.rdoc

@@ -24,7 +24,8 @@ Or install as a plugin if you must.  But gems are cooler.
 
 * You must create the table used by the Setting model and install an initial configuration file. Simply run this command:
   
-    ruby script/generate settler
+    rails2: ruby script/generate settler
+    rails3: rails g settler
 
 * This will create a migration and will add a settler.yml configuration file in your config directory. Now just migrate the database:
   

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.2.1

data/generators/settler/settler_generator.rb

@@ -1,6 +1,6 @@
 class SettlerGenerator < Rails::Generator::NamedBase
   def initialize(runtime_args, runtime_options = {})
-    runtime_args << 'add_settings_table' if runtime_args.empty?
+    runtime_args << 'create_settings_table' if runtime_args.empty?
     super
   end
 

data/init.rb

@@ -1,4 +1 @@
-require 'hash_extension'
-require 'setting'
 require 'settler'
-require 'type_casters'

data/lib/default_scope_patch.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  class Base
+    class << self
+      protected
+        def current_scoped_methods
+          method = scoped_methods.last
+          if method.respond_to?(:call)
+            unscoped(&method)
+          else
+            method
+          end
+        end
+    end
+  end
+end  

data/lib/generators/settler/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Sets up Settler in your Rails project. It creates a migration and a Settler configuration file.
+    
+Examples:
+    `script/rails generate settler`

data/lib/generators/settler/settler_generator.rb

@@ -0,0 +1,24 @@
+class SettlerGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  
+  source_root File.expand_path('../templates', __FILE__) 
+  
+  def generate_migration
+    migration_template "migration.rb", "db/migrate/create_settings_table.rb"
+  end
+  
+  def generate_settler_configruration
+    copy_file 'settler.yml', 'config/settler.yml'    
+  end
+  
+ # Implement the required interface for Rails::Generators::Migration.
+ # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+ def self.next_migration_number(dirname)
+   if ActiveRecord::Base.timestamped_migrations
+     Time.now.utc.strftime("%Y%m%d%H%M%S")
+   else
+     "%.3d" % (current_migration_number(dirname) + 1)
+   end
+ end  
+
+end

data/lib/generators/settler/templates/migration.rb

@@ -0,0 +1,19 @@
+class CreateSettingsTable < ActiveRecord::Migration
+  def self.up
+    create_table :settings, :force => true do |t|
+      t.string  :key, :null => false
+      t.string  :alt
+      t.text    :value
+      t.boolean :editable
+      t.boolean :deletable
+      t.boolean :deleted      
+      t.timestamps
+    end
+    
+    add_index :settings, :key
+  end
+
+  def self.down
+    drop_table :settings
+  end
+end

data/lib/generators/settler/templates/settler.yml

@@ -0,0 +1,30 @@
+settings: &settings
+  google_analytics_key: &google
+    alt: Google analytics key
+    value: 'UA-xxxxxx-x'
+    editable: true
+    deletable: false
+    validations:
+      presence: true
+  search_algorithm:
+    alt: Default search engine
+    value: 'ferret'
+    editable: true
+    validations:
+      inclusion: [ 'ferret' , 'sphinx' ]
+  white_list:
+    alt: 'White-listed words'
+    value: 'herp, derp'
+
+development:
+  <<: *settings  
+  google_analytics_key:
+    <<: *google
+    alt: Development Google analytics key
+    value: 'UA-xxxxxx-1'
+
+test:
+  <<: *settings
+
+production:
+  <<: *settings

data/lib/setting.rb

@@ -1,4 +1,5 @@
 require 'type_casters'
+require 'default_scope_patch' if defined?(ActiveRecord::VERSION) && ActiveRecord::VERSION::MAJOR >= 3
 
 # The Setting class is an AR model that encapsulates a Settler setting. The key if the setting is the only required attribute.\
 class Setting < ActiveRecord::Base  
@@ -10,11 +11,16 @@ class Setting < ActiveRecord::Base
   
   validates_presence_of :key  
   validate :setting_validations
-  if rails3 then validate(:ensure_editable, :on => :update) else validate_on_update(:ensure_editable) end
   
   serialize :value
   
-  default_scope :conditions => ['deleted = ? or deleted IS NULL', false]
+  if rails3 
+    validate(:ensure_editable, :on => :update)
+    default_scope lambda{ where(['deleted = ? or deleted IS NULL', false]) }
+  else 
+    validate_on_update(:ensure_editable) 
+    default_scope :conditions => ['deleted = ? or deleted IS NULL', false]    
+  end  
   
   scope_method = rails3 ? :scope : :named_scope
   send scope_method, :editable, :conditions => { :editable => true }

data/lib/settler.rb

@@ -1,6 +1,8 @@
 require 'yaml'
 require 'erb'
 require 'hash_extension'
+require 'setting'
+require 'type_casters'
 
 # Settler loads and manages application wide settings and provides an interface for retrieving settings. The Settler
 # object cannot be instantiated; all functionality is available on class level.

data/settler.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{settler}
-  s.version = "1.2.0"
+  s.version = "1.2.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-10-27}
+  s.date = %q{2011-02-24}
   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 = [
@@ -27,6 +27,11 @@ Gem::Specification.new do |s|
      "generators/settler/templates/migration.rb",
      "generators/settler/templates/settler.yml",
      "init.rb",
+     "lib/default_scope_patch.rb",
+     "lib/generators/settler/USAGE",
+     "lib/generators/settler/settler_generator.rb",
+     "lib/generators/settler/templates/migration.rb",
+     "lib/generators/settler/templates/settler.yml",
      "lib/hash_extension.rb",
      "lib/setting.rb",
      "lib/settler.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: settler
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 1
   - 2
-  - 0
-  version: 1.2.0
+  - 1
+  version: 1.2.1
 platform: ruby
 authors: 
 - Reinier de Lange
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-27 00:00:00 +02:00
+date: 2011-02-24 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -39,6 +39,11 @@ files:
 - generators/settler/templates/migration.rb
 - generators/settler/templates/settler.yml
 - init.rb
+- lib/default_scope_patch.rb
+- lib/generators/settler/USAGE
+- lib/generators/settler/settler_generator.rb
+- lib/generators/settler/templates/migration.rb
+- lib/generators/settler/templates/settler.yml
 - lib/hash_extension.rb
 - lib/setting.rb
 - lib/settler.rb