zen 0.2.6 → 0.2.6.1

data/{CHANGELOG → CHANGELOG.md}

@@ -1,14 +1,22 @@
-0.2.6 May 29 2011
+## 0.2.6.1 - June 1st, 2011
+
+* Dropped Zen.settings and modified the settings plugin so that it works properly when
+  using a multi-process based environment such as Unicorn.
+
+## 0.2.6 - May 29th, 2011
 
 * Zen is now using RVM for gem management and such.
 * Began working on making Zen compatible with at least JRuby. Rubinius isn't worth the
-effort at this time.
+  effort at this time.
 * Removed Ramaze::Helper::Common.notification in favor of Ramaze::Helper::Message.
 * Dropped Zen::Database, Zen::Settings and most of the options in favor of instance
-variables set in the main Zen module. See commit d40ee1c2e518a323b2983e1bcfb7a0d863bf3b2f
-for more information.
+  variables set in the main Zen module. See commit 
+  [d40ee1c2e518a323b2983e1bcfb7a0d863bf3b2f][d40ee1c2e518a323b2983e1bcfb7a0d863bf3b2f] 
+  for more information.
 * Translated Zen to Dutch.
 * Re-organized the application prototypes to make them easier to use/understand.
 * Implemented the anti-spam system as a plugin and added a decent XSS protection system
-using Loofah.
+  using Loofah.
 * Various changes to the Javascript classes.
+
+[d40ee1c2e518a323b2983e1bcfb7a0d863bf3b2f]: https://github.com/zen-cms/Zen-Core/commit/d40ee1c2e518a323b2983e1bcfb7a0d863bf3b2f

data/MANIFEST

@@ -1,7 +1,7 @@
 .gems
 .travis.yml
 AUTHORS
-CHANGELOG
+CHANGELOG.md
 LICENSE
 MANIFEST
 README.md

data/lib/zen.rb

@@ -28,14 +28,6 @@ module Zen
     #
     attr_accessor :database
 
-    ##
-    # Hash containing all system settings.
-    #
-    # @author Yorick Peterse
-    # @since  0.2.6
-    #
-    attr_accessor :settings
-
     ##
     # String containing the path to the root directory of the Zen application.
     #
@@ -47,12 +39,10 @@ module Zen
     ##
     # Loads the database and the required models.
     #
-    # @author Yorick Peterse
+    # @author Yorick  Peterse
     # @since  0.1
     #
     def init
-      @settings ||= {}
-
       # Initialize the database
       Zen::Language.load('zen_general')
 
@@ -95,17 +85,6 @@ module Zen
           "Failed to migrate the settings, make sure the database table is up to date"
         )
       end
-
-      begin
-        ::Settings::Model::Setting.get_settings.each do |k, v|
-          Zen.settings[k] = v
-        end
-      rescue => e
-        Ramaze::Log.warn(
-          "Failed to retrieve the settings, are you sure the database is migrated?\n" + 
-          "Error: #{e.message}"
-        )
-      end
     end
   end # class << self
 end # Zen
@@ -138,3 +117,8 @@ require __DIR__('zen/controller/frontend_controller')
 require __DIR__('zen/controller/admin_controller')
 require __DIR__('zen/controller/main_controller')
 require __DIR__('zen/controller/preview')
+
+# Load the cache for the settings. This has to be done outside any of the init methods as
+# that would make it impossible to set a custom cache.
+Ramaze::Cache.options.names.push(:settings)
+Ramaze::Cache.options.settings = Ramaze::Cache::LRU

data/lib/zen/controller/main_controller.rb

@@ -26,12 +26,13 @@ module Zen
       #
       def index(*uri)
         @request_uri = []
+        theme        = plugin(:settings, :get, :theme).value
         
         # Clean the URI of nasty input
         uri.each { |v| @request_uri.push(h(v)) }
         
         if !@request_uri[0] or @request_uri[0].empty?
-          @request_uri[0] = ::Zen.settings[:default_section]
+          @request_uri[0] = plugin(:settings, :get, :default_section).value
         end
         
         if !@request_uri[1] or @request_uri[1].empty?
@@ -39,11 +40,11 @@ module Zen
         end
         
         # A theme is always required
-        if ::Zen.settings[:theme].nil? or ::Zen.settings[:theme].empty?
+        if theme.nil? or theme.empty?
           respond(lang('zen_general.errors.no_theme'))
         end
 
-        theme    = ::Zen::Theme[::Zen.settings[:theme]]
+        theme    = ::Zen::Theme[theme]
         group    = @request_uri[0]
         template = @request_uri[1]
         
@@ -53,7 +54,7 @@ module Zen
         template_path = File.join(theme_path, group, "#{template}.xhtml")
         
         # Is the website down?
-        if ::Zen.settings[:website_enabled] == '0'
+        if plugin(:settings, :get, :website_enabled).value === '0'
           offline_path = File.join(theme_path, 'offline.xhtml')
           
           if File.exist?(offline_path)

data/lib/zen/helper/theme.rb

@@ -12,7 +12,6 @@ module Ramaze
     # @since  0.2.5
     #
     module Theme
-
       ##
       # Renders a partial from the current theme's partial directory. The first argument
       # is the name of the partial (without an extension) to render. The second argument
@@ -29,7 +28,8 @@ module Ramaze
       # the partial.
       #
       def partial(file, variables = {})
-        theme = ::Zen::Theme[::Zen.settings[:theme]]
+        theme = plugin(:settings, :get, :theme).value
+        theme = Zen::Theme[theme]
 
         if !theme.respond_to?(:partial_dir) or theme.partial_dir.nil?
           raise(::Zen::ThemeError, "The theme #{theme.name} has no partial directory set.")
@@ -59,7 +59,7 @@ module Ramaze
       # @param  [Hash] variables Hash with variables to pass to the 404 template.
       #
       def show_404(variables = {})
-        theme    = ::Zen::Theme[::Zen.settings[:theme]]
+        theme    = ::Zen::Theme[plugin(:settings, :get, :theme).value]
         template = "#{theme.template_dir}/404.xhtml"
 
         # Render the template and replace the current buffer with it's output
@@ -67,7 +67,6 @@ module Ramaze
 
         respond(template, 404)
       end
-
-    end
-  end
-end
+    end # Theme
+  end # Helper
+end # Ramaze

data/lib/zen/layout/admin.xhtml

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="#{::Zen.settings[:language]}">
+<html lang="#{plugin(:settings, :get, :language).value}">
     <head>
         <meta charset="utf-8" />
         

data/lib/zen/layout/login.xhtml

@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html lang="#{::Zen.settings[:language]}">
+<html lang="#{plugin(:settings, :get, :language).value}">
     <head>
         <meta charset="utf-8" />
         

data/lib/zen/package/comments/lib/comments/controller/comments_form.rb

@@ -84,8 +84,8 @@ module Comments
         end
 
         # Require anti-spam validation?
-        if ::Zen.settings[:enable_antispam] == '1'
-          engine = ::Zen.settings[:anti_spam_system].to_sym
+        if plugin(:settings, :get, :enable_antispam).value === '1'
+          engine = plugin(:settings, :get, :anti_spam_system).value.to_sym
           spam   = plugin(:anti_spam, engine, nil, nil, nil, post['comment'])
 
           # Time to validate the Defensio response

data/lib/zen/package/comments/lib/comments/plugin/anti_spam.rb

@@ -114,13 +114,8 @@ module Comments
       # @return [TrueClass/FalseClass]
       #
       def defensio
-        spam = true
-
-        if !::Zen.settings.key?(:defensio_key)
-          raise(::Zen::PluginError, "The setting \"defensio_key\" is missing")
-        end
-
-        api_key = ::Zen.settings[:defensio_key]
+        spam    = true
+        api_key = plugin(:settings, :get, :defensio_key).value
 
         if api_key.nil? or api_key.empty?
           raise(

data/lib/zen/package/settings/lib/settings/controller/settings.rb

@@ -107,15 +107,8 @@ module Settings
 
         # Update all settings
         post.each do |key, value|
-          setting = Setting[:name => key]
-
           begin
-            setting.update(:value => value)
-
-            # Update the internal settings
-            if ::Zen.settings[key.to_sym] != value
-              ::Zen.settings[key.to_sym] = value
-            end
+            plugin(:settings, :get, key).value = value
           rescue => e
             Ramaze::Log.error(e.inspect)
             message(:error, flash_error)

data/lib/zen/package/settings/lib/settings/plugin/setting_base.rb

@@ -69,6 +69,48 @@ module Settings
           raise(::Zen::ValidationError, "The settings group #{group} doesn't exist.")
         end
       end
+
+      ##
+      # Updates the value of a setting both in the cache and the SQL database.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.6.1
+      # @param  [String] value The value to set the setting to.
+      #
+      def value=(value)
+        # First we'll update the SQL database
+        ::Settings::Model::Setting[:name => name].update(:value => value)
+
+        # Sync the cache
+        ::Ramaze::Cache.settings.store(name, value)
+      end
+
+      ##
+      # Retrieves the setting. If it exists in the cache the cache's value is used,
+      # otherwise it will be retrieved from the SQL database and cached.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.6.1
+      #
+      def value
+        val = ::Ramaze::Cache.settings.fetch(name)
+
+        # Get the setting from the database
+        if val.nil?
+          setting = ::Settings::Model::Setting[:name => name]
+
+          # If the value is also nil we'll use the default value
+          if setting.value.nil? or setting.value.empty?
+            val = setting.default
+          else
+            val = setting.value
+          end
+
+          ::Ramaze::Cache.settings.store(name, val)
+        end
+
+        return val
+      end
     end # SettingBase
   end # Plugin
 end # Settings

data/lib/zen/package/settings/lib/settings/plugin/settings.rb

@@ -181,7 +181,9 @@ module Settings
       # @return [Zen::StrictStruct]
       #
       def get(name)
-        validate_type(name, :name, [String])
+        validate_type(name, :name, [String, Symbol])
+
+        name = name.to_s
 
         if !Registered[:settings].key?(name)
           raise(ArgumentError, "The setting #{name} doesn't exist.")

data/lib/zen/package/settings/lib/settings/view/admin/settings/index.xhtml

@@ -20,12 +20,7 @@
       @settings_ordered.each do |group, items|
         f.g.div(:id => "group_#{group}") do
           items.each do |s|
-            # Get the value from either the value or default getter
-            if ::Zen.settings[s.name.to_sym].nil?
-              value = s.default
-            else
-              value = ::Zen.settings[s.name.to_sym]
-            end
+            value = plugin(:settings, :get, s.name).value
             
             case s.type
               when 'textbox'

data/lib/zen/package/users/lib/users/model/user.rb

@@ -42,24 +42,26 @@ module Users
       # @param  [Hash] creds The specified credentials
       # @return [Object/Boolean] new instance of the given user.
       #
-      def self.authenticate creds
+      def self.authenticate(creds)
         email    = creds['email']
         password = creds['password']
 
-        if email.nil? or password.nil?
-          return false
-        end
+        return false if email.nil? or password.nil?
 
         user = self[:email => email]
 
         if !user.nil? and user.password == password and user.status == 'open'
           # Overwrite all the global settings with the user specific ones
-          ::Zen.settings.each do |k, v|
-            if user.respond_to?(k)
-              got = user.send(k)
+          [:language, :frontend_language, :date_format].each do |setting|
+            # "plugin" is already defined by Sequel so we'll have to call the plugin
+            # manually.
+            value = ::Zen::Plugin[:settings].plugin.new(:get, setting).call.value
+
+            if user.respond_to?(setting)
+              got = user.send(setting)
               
               if got.nil? or got.empty?
-                user.send("#{k}=", v)
+                user.send("#{setting}=", value)
               end
             end
           end

data/lib/zen/version.rb

@@ -7,5 +7,5 @@ module Zen
   # @author Yorick Peterse
   # @since  0.1
   #
-  Version = '0.2.6'
+  Version = '0.2.6.1'
 end

metadata

@@ -2,7 +2,7 @@
 name: zen
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.6
+  version: 0.2.6.1
 platform: ruby
 authors: 
 - Yorick Peterse
@@ -203,7 +203,7 @@ files:
 - .gems
 - .travis.yml
 - AUTHORS
-- CHANGELOG
+- CHANGELOG.md
 - LICENSE
 - MANIFEST
 - README.md