zen 0.2.4.1 → 0.2.5

data/lib/zen/package/users/lib/users/view/admin/access-rules/index.xhtml

@@ -18,7 +18,8 @@
                     <?r end ?>
                     
                     <th>#{lang('access_rules.labels.id')}</th>
-                    <th>#{lang('access_rules.labels.extension')}</th>
+                    <th>#{lang('access_rules.labels.package')}</th>
+                    <th>#{lang('access_rules.labels.controller')}</th>
                     <th>#{lang('access_rules.labels.create')}</th>
                     <th>#{lang('access_rules.labels.read')}</th>
                     <th>#{lang('access_rules.labels.update')}</th>
@@ -37,16 +38,17 @@
                     <?r end ?>
                     
                     <td>#{rule.id}</td>
-                    
+                    <td>#{rule.package}</td>
+
                     <?r if user_authorized?([:update]) ?>
                     <td>
                         #{anchor_to(
-                          rule.extension, 
-                          Users::Controllers::AccessRules.r(:edit, rule.id)
+                          @form_controllers[rule.package].key(rule.controller), 
+                          Users::Controller::AccessRules.r(:edit, rule.id)
                         )}
                     </td>
                     <?r else ?>
-                    <td>#{rule.extension}</td>
+                    <td>#{@form_controllers[rule.package].key(rule.controller)}</td>
                     <?r end ?>
                     
                     <td>#{@boolean_hash.invert[rule.create_access]}</td>
@@ -78,7 +80,7 @@
             <div class="button">
                 #{anchor_to(
                   lang('access_rules.buttons.new'), 
-                  Users::Controllers::AccessRules.r(:new)
+                  Users::Controller::AccessRules.r(:new)
                 )}
             </div>
             <?r end ?>

data/lib/zen/package/users/lib/users/view/admin/user-groups/index.xhtml

@@ -37,7 +37,7 @@
                     <?r if user_authorized?([:update]) ?>
                     <td>
                         #{anchor_to(
-                          group.name, Users::Controllers::UserGroups.r(:edit, group.id)
+                          group.name, Users::Controller::UserGroups.r(:edit, group.id)
                         )}
                     </td>
                     <?r else ?>
@@ -45,7 +45,7 @@
                     <?r end ?>
                     
                     <td>#{group.slug}</td>
-                    <td>#{@boolean_hash[group.super_group]}</td>
+                    <td>#{@boolean_hash.invert[group.super_group]}</td>
                 </tr>
                 <?r end ?>
             </tbody>
@@ -61,7 +61,7 @@
             <div class="button">
                 #{anchor_to(
                   lang('user_groups.buttons.new'), 
-                  Users::Controllers::UserGroups.r(:new)
+                  Users::Controller::UserGroups.r(:new)
                 )}
             </div>
             <?r end ?>

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

@@ -40,7 +40,7 @@
                     <td>
                         #{anchor_to(
                           user.email, 
-                          Users::Controllers::Users.r(:edit, user.id)
+                          Users::Controller::Users.r(:edit, user.id)
                         )}
                     </td>
                     <?r else ?>
@@ -66,7 +66,7 @@
             <div class="button">
                 #{anchor_to(
                   lang('users.buttons.new'), 
-                  Users::Controllers::Users.r(:new)
+                  Users::Controller::Users.r(:new)
                 )}
             </div>
             <?r end ?>

data/lib/zen/package/users/migrations/1303510943_class_rules.rb

@@ -0,0 +1,13 @@
+Sequel.migration do
+
+  up do
+    rename_column(:access_rules, :extension, :package)
+    add_column(:access_rules, :controller, String, :null => false, :default => '*')
+  end
+  
+  down do
+    rename_column(:access_rules, :package, :extension)
+    drop_column(:access_rules, :controller)
+  end
+
+end

data/lib/zen/plugin.rb

@@ -1,171 +1,177 @@
 require __DIR__('error/plugin_error')
+require __DIR__('plugin/base')
 
 #:nodoc:
 module Zen
   ##
   # Plugins in Zen are quite similar to packages except for a few differences. The biggest
   # difference is that plugins won't update any Ramaze root directories or language
-  # direactories. This means that they can't have controllers, models and so on. On top
-  # of that they're nothing more than lambda's. Plugins are useful for supporting multiple
-  # markup formats (Markdown, Textile, etc) and other small tasks such as replacing Email
-  # addresses and so on.
+  # directories. This means that they can't have controllers, models and so on. 
+  # Plugins are useful for supporting multiple markup formats (Markdown, Textile, etc) 
+  # and other small tasks such as replacing Email addresses and so on.
   #
   # ## Creating Plugins
   #
-  # Creating plugins works in a similar way as creating packages. Plugins are added by
-  # calling Zen::Plugin#add and passing a block to it with details such as the name of
-  # the plugin, the author, the identifier and a list of actions. The last two are very
-  # important as the plugin won't work without them.
+  # Creating a plugin happens in two steps. First you'll create your class and then you'll
+  # register it so that it can be used by the system. A plugin has a very simple layout,
+  # it's just a class with two methods: initialize and call. The most basic skeleton of a
+  # plugin looks like the following:
   #
-  # ### Actions
+  #     class MyPlugin
+  #       def initialize
   #
-  # Each plugin has a getter/setter called "actions", this is just a simple key/value
-  # hash where the keys are the names of the actions and the values lambda's. The keys
-  # should always be symbols. Example:
+  #       end
+  #
+  #       def call
+  #
+  #       end
+  #     end
   #
-  #     actions = {
-  #       :downcase => lambda do |string|
-  #         string.downcase
+  # When a plugin is called all specified arguments are sent to the construct method so if
+  # your plugin requires a number of arguments be sure to store them. An example of this
+  # looks like the following:
+  #
+  #     class MyPlugin
+  #       def initialize(name)
+  #         @name = name
   #       end
-  #     }
   #
-  # Note that you don't *have to* use lambda's, anything that responds to call() will do.
-  # 
-  # Because the actions method contains just a hash you can easily add functionality to
-  # existing plugins as following:
+  #       def call
   #
-  #     # First retrieve our plugin
-  #     plugin = Zen::Plugin['com.something.plugin.name']
-  #     plugin.actions[:my_action] = lamda do
-  #       # Do something....
+  #       end
   #     end
   #
-  # This can be very useful for extending plugins such as the markup plugin that's used to
-  # convert Markdown or Textile to HTML. By default this plugin only converts Markdown and
-  # Textile or HTML (it escapes all HTML) but by modifying the actions hash we can easily
-  # add new markup engines such as RDoc or even Latex.
+  # The call method is supposed to return some data. Say we want to capitalize a given
+  # name we'd modify the skeleton so that it looks like the following:
   #
-  # ## Calling Plugins
+  #     class MyPlugin
+  #       def initialize(name)
+  #         @name = name
+  #       end
   #
-  # Plugins can be called using Zen::Plugin#call, this method requires you to specify the
-  # plugin identifier, the action to call and optionally any data to send to the plugin.
-  # An example of calling a plugin would look like the following:
+  #       def call
+  #         return @name.upcase
+  #       end
+  #     end
   #
-  #     Zen::Plugin.call('com.zen.plugin.markup', :markdown, 'hello **world**')
+  # ## Registering Plugins
   #
-  # ## Identifiers
+  # Now that the plugin is created it's time to tell Zen it actually is a plugin and not
+  # some random class that doesn't belong somewhere. This can be done by calling 
+  # Zen::Plugin.add and specifying a block with the details of the plugin. Example:
   #
-  # Plugin identifiers should always have the following format:
+  #     Zen::Plugin.add do |plugin|
+  #       plugin.name   = :my_plugin
+  #       plugin.author = 'Your name goes in here'
+  #       plugin.about  = 'A simple plugin that capitalizes a given string/name'
+  #       plugin.plugin = MyPlugin
+  #     end
+  #
+  # The name and plugin setter are the most important. Names should always match the 
+  # regular expression /[a-z0-9_\-]+/. This is done to ensure names are consistent and
+  # easy to remember. It's also used for calling plugins and making sure there are no
+  # duplicates.
+  #
+  # The second important part is the plugin setting. This setter takes the class constant
+  # of the plugin that was created earlier on. There's no need to call new(), this will
+  # be done by Zen whenever the plugin is actually used.
   #
-  #     com.VENDOR.plugin.NAME
+  # ## Executing Plugins
   #
-  # For example:
+  # Executing plugins is very easy and can be done by using the global method plugin():
   #
-  #     com.zen.plugin.markup
+  #     plugin(:my_plugin, 'yorick') # => "YORICK"
+  #
+  # The first argument is the name of the plugin to call, all following arguments will be
+  # sent to the plugin's construct method.
   #
   # @author Yorick Peterse
   # @since  0.2.4
-  # @attr_reader [Hash] plugins Hash containing all plugins.
   #
   module Plugin
-    class << self
-      attr_reader :plugins
-    end
 
     ##
-    # Adds a new plugin with the given details.
+    # Hash containing all registered plugins. The keys are the names of the plugins and
+    # the values are instances of Zen::Plugin::Base.
     #
-    # @example
-    #  Zen::Plugin.add do |p|
-    #    p.name    = 'Markup'
-    #    p.author  = 'Yorick Peterse'
-    #    p.actions = {
-    #      :markdown => lambda do |markup|
-    #        RDiscount.new(markup).to_html
-    #      end 
-    #  end
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    Registered = {}
+
+    ##
+    # Adds a new plugin with the given details.
     #
     # @author Yorick Peterse
     # @since  0.2.4
-    # @yield  [plugin] Struct object containing all the details of a plugin.
-    # @raise  [Zen::PluginError] Error raised whenever the plugin already exists or is missing
-    # a certain setter.
+    # @raise  [Zen::PluginError] Error raised whenever the plugin already exists or is 
+    # missing a certain setter.
     #
     def self.add
-      @plugins ||= {}
-      required   = [:name, :author, :about, :identifier, :actions]
-      plugin     = Zen::StrictStruct.new(
-        :name, :author, :about, :url, :identifier, :actions
-      ).new
+      plugin = Zen::Plugin::Base.new
 
       yield plugin
 
-      # Check if all the required keys have been set
-      plugin.validate(required) do |k|
-        raise(Zen::PluginError, "The following plugin key is missing: #{k}")
-      end
+      # Validate the plugin
+      plugin.validate
+      plugin.name = plugin.name.to_sym
 
-      # The actions getter should be a hash
-      if plugin.actions.class != Hash
-        raise(Zen::PluginError, "The actions setter/getter should be an instance of Hash.")
-      end
-
-      # Add our plugin
-      if !@plugins[plugin.identifier].nil?
-        raise(Zen::PluginError, "The plugin #{plugin.name} already exists.")
-      end
-
-      @plugins[plugin.identifier] = plugin
+      Registered[plugin.name] = plugin
     end
 
     ##
-    # Returns a plugin for the given identifier.
+    # Returns a plugin for the given name.
     #
     # @example
-    #  Zen::Plugin['com.zen.plugin.markup']
+    #  Zen::Plugin[:markup]
     #
     # @author Yorick Peterse
     # @since  0.2.4
-    # @param  [String] ident The plugin identifier.
+    # @param  [String] name The name of the plugin to retrieve.
     # @raise  Zen::PluginError Error that's raised when no plugins have been added yet or
     # the specified plugin doesn't exist.
     # @return [Struct] Instance of the plugin.
     #
-    def self.[](ident)
-      if @plugins.nil?
+    def self.[](name)
+      if name.class != Symbol
+        name = name.to_sym
+      end
+
+      if Registered.nil?
         raise(Zen::PluginError, "No plugins have been added.")
       end
 
-      if !@plugins[ident]
-        raise(Zen::PluginError, "The plugin #{ident} doesn't exist.")
+      if !Registered[name]
+        raise(Zen::PluginError, "The plugin #{name} doesn't exist.")
       end
 
-      return @plugins[ident]
+      return Registered[name]
     end
 
-    ##
-    # Calls the plugin for the given identifier and executes the action.
-    #
-    # @example
-    #  Zen::Plugin.call('com.zen.foobar', :markdown, 'hello **world**')
-    #
-    # @author Yorick Peterse
-    # @since  0.2.4
-    # @param  [String] ident The plugin identifier.
-    # @param  [Symbol] action The plugin action to call.
-    # @param  [Array] data Any data to pass to the plugin's action (a lambda).
-    # @return [Mixed]
-    #
-    def self.call(ident, action, *data)
-      plugin = self[ident]
-      action = action.to_sym
+    #:nodoc:
+    module SingletonMethods
+      ##
+      # Retrieves the given plugin and executes it. All specified parameters will be sent
+      # to the plugin as well.
+      #
+      # @example
+      #  plugin(:settings, :get, :language)
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @param  [String/Symbol] name The name of the plugin to call.
+      # @param  [Array] data Any data to pass to the plugin's action (a lambda).
+      # @param  [Proc] block A block that should be passed to the plugin instead of this
+      # method.
+      # @return [Mixed]
+      #
+      def plugin(name, *data, &block)
+        if name.class != Symbol
+          name = name.to_sym
+        end
 
-      if !plugin.actions[action]
-        raise(Zen::PluginError, "The action #{action} doesn't exist for #{ident}.")
+        return ::Zen::Plugin[name].plugin.new(*data, &block).call
       end
-
-      # Call the plugin and return it's value
-      return plugin.actions[action].call(*data)
     end
 
   end

data/lib/zen/plugin/base.rb

@@ -0,0 +1,46 @@
+#:nodoc:
+module Zen
+  #:nodoc:
+  module Plugin
+    ##
+    # Base class used to store the data about plugins such as the name, plugin class, etc.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    class Base
+      include ::Zen::Validation
+
+      # The name of the plugin
+      attr_accessor :name
+
+      # The author of the plugin
+      attr_accessor :author
+
+      # A small description of the plugin
+      attr_accessor :about
+
+      # The URL to the plugin's website
+      attr_accessor :url
+
+      # The class of the plugin
+      attr_accessor :plugin
+
+      ##
+      # Validates all the attributes.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      #
+      def validate
+        validates_presence([:name, :author, :about, :plugin])
+        validates_format(:name, /[a-z0-9_\-]+/)
+
+        # Check if the theme doesn't exist
+        if ::Zen::Plugin::Registered.key?(name.to_sym)
+          raise(::Zen::ValidationError, "The plugin #{name} already exists.")
+        end
+      end
+    end
+  end
+end

data/lib/zen/{liquid/controller_behavior.rb → plugin/controller.rb}

@@ -1,9 +1,9 @@
 #:nodoc:
 module Zen
   #:nodoc:
-  module Liquid
+  module Plugin
     ##
-    # Module that can be used to allow Liquid tags to use data that would otherwise
+    # Module that can be used to allows plugins to use data that would otherwise
     # only be available to controllers. Including this module gives your tags access to
     # the following methods:
     #
@@ -12,9 +12,9 @@ module Zen
     # * session
     #
     # @author Yorick Peterse
-    # @since  0.1
+    # @since  0.2.5
     #
-    module ControllerBehavior
+    module Controller
       include ::Ramaze::Trinity
       
       ##
@@ -22,7 +22,7 @@ module Zen
       # session() method not being available outside controllers.
       #
       # @author Yorick Peterse
-      # @since  0.1
+      # @since  0.2.5
       # @return [Object]
       # 
       def session
@@ -34,7 +34,7 @@ module Zen
       # request() method not being available outside controllers.
       #
       # @author Yorick Peterse
-      # @since  0.1
+      # @since  0.2.5
       # @return [Object]
       # 
       def request
@@ -46,12 +46,14 @@ module Zen
       # response() method not being available outside controllers.
       #
       # @author Yorick Peterse
-      # @since  0.1
+      # @since  0.2.5
       # @return [Object]
       # 
       def response
         return action.node.response
       end
+
     end
   end
 end
+