zen 0.2.4.1 → 0.2.5

data/lib/zen/package/sections/lib/sections.rb

@@ -1,32 +1,48 @@
+require __DIR__('sections/model/section')
+require __DIR__('sections/model/section_entry')
+require __DIR__('sections/controller/sections')
+require __DIR__('sections/controller/section_entries')
+require __DIR__('sections/plugin/sections')
+require __DIR__('sections/plugin/section_entries')
 
-# Load all the classes such as controllers, models and so on.
-require __DIR__ 'sections/model/section'
-require __DIR__ 'sections/model/section_entry'
-require __DIR__ 'sections/controller/sections'
-require __DIR__ 'sections/controller/section_entries'
+Zen::Language.options.paths.push(__DIR__('sections'))
+Zen::Language.load('sections')
+Zen::Language.load('section_entries')
 
-# Load and register all our liquid tags
-require __DIR__ 'sections/liquid/section_entries'
-require __DIR__ 'sections/liquid/sections'
-
-Liquid::Template.register_tag('sections', Sections::Liquid::Sections)
-Liquid::Template.register_tag('section_entries', Sections::Liquid::SectionEntries)
-
-# Describe what this extension is all about
 Zen::Package.add do |p|
-  p.name        = 'Sections'
+  p.name        = 'sections'
   p.author      = 'Yorick Peterse'
   p.url         = 'http://yorickpeterse.com/'
   p.about       = "The sections module allows users to create and manage sections. 
 Sections can be seen as small web applications that live inside the CMS. 
 For example, you could have a section for your blog and for your pages."
   
-  p.identifier    = 'com.zen.sections'
   p.directory     = __DIR__('sections')
   p.migration_dir = __DIR__('../migrations')
   
   p.menu = [{
-    :title => "Sections",
+    :title => lang('sections.titles.index'),
     :url   => "admin"
   }]
+
+  p.controllers = {
+    lang('sections.titles.index')        => Sections::Controller::Sections, 
+    lang('section_entries.titles.index') => Sections::Controller::SectionEntries
+  }
+end
+
+Zen::Plugin.add do |p|
+  p.name       = 'sections'
+  p.author     = 'Yorick Peterse'
+  p.about      = 'Plugin for retrieving multiple or individual sections.'
+  p.url        = 'http://yorickpeterse.com/'
+  p.plugin     = Sections::Plugin::Sections
+end
+
+Zen::Plugin.add do |p|
+  p.name       = 'section_entries'
+  p.author     = 'Yorick Peterse'
+  p.about      = 'Plugin for retrieving multiple or individual section entries.'
+  p.url        = 'http://yorickpeterse.com/'
+  p.plugin     = Sections::Plugin::SectionEntries
 end

data/lib/zen/package/sections/lib/sections/controller/section_entries.rb

@@ -1,7 +1,7 @@
 #:nodoc:
 module Sections
   #:nodoc:
-  module Controllers
+  module Controller
     ##
     # Section entries can be seen as blog entries, products, all sorts of things.
     # Each section belongs to a section and can't be created without one.
@@ -9,12 +9,11 @@ module Sections
     # @author Yorick Peterse
     # @since  0.1
     #
-    class SectionEntries < Zen::Controllers::AdminController
-      include ::Sections::Models 
-      
-      map   '/admin/section-entries' 
-      trait :extension_identifier => 'com.zen.sections'
+    class SectionEntries < Zen::Controller::AdminController
+      include ::Sections::Model 
       
+      map('/admin/section-entries')
+
       before_all do
         csrf_protection(:save, :delete) do
           respond(lang('zen_general.errors.csrf'), 403)
@@ -49,14 +48,6 @@ module Sections
           @page_title = lang("section_entries.titles.#{method}") rescue nil
         end
 
-        # Load our datepicker that ships with Zen itself
-        require_js(
-          'vendor/datepicker/Picker', 'vendor/datepicker/Picker.Attach', 
-          'vendor/datepicker/Picker.Date', 'vendor/datepicker/locale'
-        )
-
-        require_css('datepicker')
-
         @status_hash = {
           'draft'     => lang('section_entries.special.status_hash.draft'),
           'published' => lang('section_entries.special.status_hash.published')
@@ -123,7 +114,7 @@ module Sections
 
         @users_hash = {}
         
-        Users::Models::User.each { |u| @users_hash[u.id] = u.name }
+        Users::Model::User.each { |u| @users_hash[u.id] = u.name }
       end
       
       ##
@@ -153,7 +144,7 @@ module Sections
         @entry      = SectionEntry.new(:section_id => @section_id)
         @users_hash = {}
         
-        Users::Models::User.each { |u| @users_hash[u.id] = u.name }
+        Users::Model::User.each { |u| @users_hash[u.id] = u.name }
       end
       
       ##
@@ -172,7 +163,7 @@ module Sections
       # patches as it executes quite a few queries. I'll keep it as it is for now.
       #
       def save
-        if !user_authorized?([:create, :save])
+        if !user_authorized?([:create, :update])
           respond(lang('zen_general.errors.not_authorized'), 403)
         end
         
@@ -214,7 +205,7 @@ module Sections
             
             # Update the field values
             field_values.each do |field_id, value|
-              field_value = CustomFields::Models::CustomFieldValue[
+              field_value = CustomFields::Model::CustomFieldValue[
                 :custom_field_id  => field_id, 
                 :section_entry_id => @entry.id
               ]

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

@@ -1,7 +1,7 @@
 #:nodoc:
 module Sections
   #:nodoc:
-  module Controllers
+  module Controller
     ##
     # Sections can be seen as mini applications inside your website.
     # Examples of sections can be a blog, pages, a products listing, etc.
@@ -14,11 +14,10 @@ module Sections
     # @author  Yorick Peterse
     # @since   0.1
     #
-    class Sections < Zen::Controllers::AdminController
-      include ::Sections::Models
+    class Sections < Zen::Controller::AdminController
+      include ::Sections::Model
 
-      map   '/admin'
-      trait :extension_identifier => 'com.zen.sections'
+      map('/admin')
       
       before_all do
         csrf_protection(:save, :delete) do
@@ -95,8 +94,8 @@ module Sections
           @page_title
         )
         
-        @custom_field_group_pk_hash = CustomFields::Models::CustomFieldGroup.pk_hash(:name)
-        @category_group_pk_hash     = Categories::Models::CategoryGroup.pk_hash(:name)
+        @custom_field_group_pk_hash = CustomFields::Model::CustomFieldGroup.pk_hash(:name)
+        @category_group_pk_hash     = Categories::Model::CategoryGroup.pk_hash(:name)
 
         if flash[:form_data]
           @section = flash[:form_data]
@@ -126,8 +125,8 @@ module Sections
           @page_title
         )
         
-        @custom_field_group_pk_hash = CustomFields::Models::CustomFieldGroup.pk_hash(:name)
-        @category_group_pk_hash     = Categories::Models::CategoryGroup.pk_hash(:name)
+        @custom_field_group_pk_hash = CustomFields::Model::CustomFieldGroup.pk_hash(:name)
+        @category_group_pk_hash     = Categories::Model::CategoryGroup.pk_hash(:name)
         @section                    = Section.new
       end
       

data/lib/zen/package/sections/lib/sections/language/en/section_entries.yml

@@ -1,6 +1,6 @@
 ---
 titles:
-  index  : 'Entries'
+  index  : 'Section Entries'
   edit   : 'Edit Entry'
   new    : 'Add Entry'
 

data/lib/zen/package/sections/lib/sections/model/section.rb

@@ -1,7 +1,7 @@
 #:nodoc:
 module Sections
   #:nodoc:
-  module Models
+  module Model
     ##
     # Model that represents a single section. This model has the following
     # relations:
@@ -20,18 +20,18 @@ module Sections
     class Section < Sequel::Model
       one_to_many(
         :section_entries, 
-        :class => "Sections::Models::SectionEntry", 
+        :class => "Sections::Model::SectionEntry", 
         :eager => [:custom_field_values]
       )
       
       many_to_many(
         :custom_field_groups, 
-        :class => "CustomFields::Models::CustomFieldGroup"
+        :class => "CustomFields::Model::CustomFieldGroup"
       )
 
       many_to_many(
         :category_groups,
-        :class => "Categories::Models::CategoryGroup"
+        :class => "Categories::Model::CategoryGroup"
       )
 
       plugin(:sluggable, :source => :name, :freeze => false)

data/lib/zen/package/sections/lib/sections/model/section_entry.rb

@@ -1,7 +1,7 @@
 #:nodoc:
 module Sections
   #:nodoc:
-  module Models
+  module Model
     ##
     # Model that represents a singe section entry. This model has the following
     # relations:
@@ -19,21 +19,19 @@ module Sections
     # @author Yorick Peterse
     # @since  0.1
     #
-    class SectionEntry < Sequel::Model  
-      one_to_many(
-        :comments, 
-        :class => "Comments::Models::Comment"
-      )
+    class SectionEntry < Sequel::Model
+
+      one_to_many(:comments, :class => "Comments::Model::Comment")
 
       one_to_many(
         :custom_field_values, 
-        :class => "CustomFields::Models::CustomFieldValue", 
+        :class => "CustomFields::Model::CustomFieldValue", 
         :eager => [:custom_field]
       )
       
-      many_to_one(:user       , :class => "Users::Models::User")
-      many_to_many(:categories, :class => "Categories::Models::Category")
-      many_to_one(:section    , :class => "Sections::Models::Section")
+      many_to_one(:user       , :class => "Users::Model::User")
+      many_to_many(:categories, :class => "Categories::Model::Category")
+      many_to_one(:section    , :class => "Sections::Model::Section")
       
       plugin(:sluggable , :source => :title     , :freeze => false)
       plugin(:timestamps, :create => :created_at, :update => false)
@@ -48,6 +46,7 @@ module Sections
         validates_presence([:title, :status, :user_id])
         validates_presence(:slug) unless new?
       end
+
     end
   end
 end

data/lib/zen/package/sections/lib/sections/plugin/section_entries.rb

@@ -0,0 +1,224 @@
+#:nodoc:
+module Sections
+  #:nodoc:
+  module Plugin
+    ##
+    # The SectionEntries plugin can be used to retrieve section entries as well as the
+    # associated comments and user data. This allows you to relatively easily build a list
+    # of entries (e.g. blog articles) without having to retrieve and process the 
+    # associated data manually.
+    #
+    # ## Usage
+    #
+    # Basic usage is as following:
+    #
+    #     entries = plugin(:section_entries, :limit => 10, :section => 'blog')
+    #     entries.each do |e|
+    #       puts e[:title]
+    #     end
+    #
+    # The values of custom fields are stored under the key :fields. This key contains a
+    # hash where the keys are the slugs of the custom fields and the values the values for
+    # the current entry.
+    #
+    #     entries.each do |e|
+    #       e[:fields][:thumbnail]
+    #     end
+    #
+    # User data can be found in the key :user:
+    #
+    #     entries.each do |e|
+    #       e[:user][:name]
+    #     end
+    #
+    # Last but not least, comments can be found under the key :comments:
+    #
+    #     entries.each do |e|
+    #       e[:comments].each do |c|
+    #         c[:comment]
+    #       end
+    #     end
+    #
+    # For a full list of available options see Sections::Plugin::SectionEntries.initialize.
+    #
+    # @author Yorick Peterse
+    # @since  0.2.5
+    #
+    class SectionEntries
+      include ::Zen::Plugin::Helper
+      include ::Sections::Model
+
+      ##
+      # Creates a new instance of the plugin and validates/stores the given configuration
+      # options. Please note that you always need to either specify a section from which
+      # to retrieve all entries or a single entry in order to use this plugin. You can
+      # retrieve a list of entries (or just a single one) by specifying the ID or the 
+      # slug:
+      #
+      #     plugin(:section_entries, :section => 'blog')
+      #     plugin(:section_entries, :section => 10)
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @param  [Hash] options Hash with a collection of custom configuration options that
+      # determine how and what entries should be retrieved.
+      # @option options [Fixnum/Integer] :limit
+      # @option options [Fixnum/Integer] :offset
+      # @option options [NilClass/String/Integer/Fixnum] :section
+      # @option options [NilClass/String/Integer/Fixnum] :entry
+      # @option options [TrueClass] :markup When set to true the markup of all entries will
+      # be converted to the desired output (usually this is HTML).
+      # @option options [TrueClass] :comments When set to true all comments for each entry
+      # will be retrieved.
+      # @option options [TrueClass] :comment_markup When set to true the markup of comments
+      # will be converted to the desired output.
+      # @option options [TrueClass] :categories When set to true all categories for each
+      # entry will be retrieved as well.
+      #
+      def initialize(options = {})
+        @options = {
+          :limit          => 20,
+          :offset         => 0,
+          :section        => nil,
+          :entry          => nil,
+          :markup         => true,
+          :comments       => true,
+          :comment_markup => true,
+          :categories     => true
+        }.merge(options)
+
+        validate_type(@options[:limit]   , :limit   , [Fixnum, Integer])
+        validate_type(@options[:offset]  , :limit   , [Fixnum, Integer])
+        validate_type(@options[:section] , :section , [NilClass, String, Integer, Fixnum])
+        validate_type(@options[:entry]   , :entry   , [NilClass, String, Integer, Fixnum])
+        validate_type(@options[:markup]  , :markup  , [TrueClass, FalseClass])
+        validate_type(@options[:comments], :comments, [TrueClass, FalseClass])
+
+        if @options[:section].nil? and @options[:entry].nil?
+          raise(
+            ArgumentError, 
+            "You need to specify either an entry or a section to retrieve."
+          )
+        end
+      end
+
+      ##
+      # Fetches all the data and converts everything to a hash. Once this is done either
+      # an array of entries or a single entry hash will be returned.
+      #
+      # @author Yorick Peterse
+      # @since  0.2.5
+      # @return [Array/Hash]
+      #
+      def call
+        # Create the list with models to load using eager()
+        eager_models = [:custom_field_values, :categories, :section, :user]
+        filter_hash  = {}
+
+        if @options[:comments] === true
+          eager_models.push(:comments)
+        end
+
+        # Retrieve multiple entries
+        if !@options[:section].nil?
+          # Retrieve the section by it's slug
+          if @options[:section].class == String
+            section_id = Section[:slug => @options[:section]].id
+          else
+            section_id = @options[:section]
+          end
+
+          filter_hash[:section_id] = section_id
+        end
+
+        # Retrieve a specific entry
+        if !@options[:entry].nil?
+          # Retrieve it by it's slug
+          if @options[:entry].class == String
+            filter_hash[:slug] = @options[:entry]
+          # Retrieve the entry by it's ID
+          else
+            filter_hash[:id] = @options[:entry]
+          end
+        end
+
+        # Get the entries
+        entries = SectionEntry.filter(filter_hash)
+          .eager(*eager_models)
+          .limit(@options[:limit], @options[:offset])
+          .all
+
+        comment_format = nil
+
+        # Loop through all entries so we can process our custom field values
+        entries.each_with_index do |entry, index|
+          if comment_format.nil?
+            comment_format = entry.section.comment_format
+          end
+
+          field_values = {}
+          user         = {}
+          comments     = []
+          categories   = []
+
+          # Store all the custom field values
+          entry.custom_field_values.each do |v|
+            name  = v.custom_field.slug.to_sym
+            value = v.value
+
+            # Convert the markup
+            if @options[:markup] === true
+              value = plugin(:markup, v.custom_field.format, value)
+            end
+
+            field_values[name] = value
+          end
+
+          # Get all the comments if the developer wants them
+          if @options[:comments] === true
+            entry.comments.each do |c|
+              comment        = c.values
+
+              if c.user
+                comment[:user] = c.user.values
+              end
+
+              # Convert the comment's markup
+              if @options[:comment_markup]
+                comment[:comment] = plugin(:markup, comment_format, comment[:comment])
+              end
+
+              comments.push(comment)
+            end
+          end
+
+          # Get the user data
+          if !entry.user.nil?
+            user = entry.user.values
+          end
+
+          # Get all categories
+          categories = entry.categories.map do |cat|
+            cat.values
+          end
+
+          # Convert the entry to a hash and re-assign all data
+          entry              = entry.values
+          entry[:fields]     = field_values
+          entry[:user]       = user
+          entry[:comments]   = comments
+          entry[:categories] = categories
+          entries[index]     = entry
+        end
+
+        # Do we only want a single entry?
+        if !@options[:entry].nil?
+          entries = entries[0]
+        end
+
+        return entries
+      end
+
+    end
+  end
+end