zen 0.2.8 → 0.3b

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

@@ -0,0 +1,146 @@
+module Ramaze
+  module Helper
+    ##
+    # Helper for retrieving section entries in your templates.
+    #
+    # @since  0.3
+    #
+    module SectionFrontend
+      ##
+      # Retrieves a number of entries for a given section ID or section slug.
+      #
+      # @example Retrieving all entries by a section's ID
+      #  get_entries(2)
+      #
+      # @example Retrieving all entries by a section's slug
+      #  get_entries('pages')
+      #
+      # @example Paginating the results
+      #  entries = get_entries('pages', :paginate => true)
+      #
+      #  entries.each do |entry|
+      #    puts entry.title
+      #  end
+      #
+      #  entries.navigation
+      #
+      # @example Customizing the sort order
+      #  get_entries('pages', :order_by => :created_at, :order => :asc)
+      #
+      # @since  0.3
+      # @param  [String|Fixnum] section The ID or slug of an section for which
+      #  to retrieve a number of entries.
+      # @param  [Hash] options A hash containing various options to customize
+      #  the return value.
+      # @option options [Fixnum] :limit The maximum amount of entries to
+      #  retrieve.
+      # @option options [TrueClass|FalseClass] :comments Whether or not all
+      #  comments should be eager loaded, set to ``false`` by default.
+      # @option options [TrueClass|FalseClass] :categories Whether or not all
+      #  categories have to be eager loaded, set to ``false`` by default.
+      # @option options [Symbol] :order_by The column to order the results on.
+      # @option options [Symbol] :order The sort order to use, set to ``:desc``
+      #  by default.
+      # @option options [TrueClass|FalseClass] :paginate Whether or not the
+      #  results should be paginated.
+      # @option options [String] :var The name of the query string item that
+      #  contains the current page number.
+      # @option options [TrueClass|FalseClass] :field_values Whether or not
+      #  custom fields and their values should be eager loaded. When set to
+      #  false the hash ``fields`` on each entry will **not** be filled.
+      # @option options [TrueClass|FalseClass] :user Whether or not the user
+      #  objects should be eager loaded for all entries. Set to ``false`` by
+      #  default.
+      # @return [Mixed]
+      #
+      def get_entries(section, options = {})
+        trait   = Zen::Controller::FrontendController.ancestral_trait[:paginate]
+        options = {
+          :limit               => trait[:limit],
+          :var                 => trait[:var],
+          :paginate            => false,
+          :comments            => false,
+          :categories          => false,
+          :order_by            => :id,
+          :order               => :desc,
+          :custom_field_values => true,
+          :user                => false
+        }.merge(options)
+
+        eager = [:section]
+
+        # Determine what relations to eager load.
+        [:custom_field_values, :user, :comments, :categories].each do |k|
+          if options[k] == true
+            eager << k
+          end
+        end
+
+        # Build the query
+        query = Sections::Model::SectionEntry.select_all(:section_entries) \
+          .eager(*eager) \
+          .join(:sections, :section_entries__section_id => :sections__id)
+
+        if section.is_a?(String)
+          query = query.filter(:sections__slug => section)
+        else
+          query = query.filter(:sections__id => section)
+        end
+
+        query = query.order(options[:order_by].send(options[:order]))
+
+        # Paginate the results?
+        if options[:paginate] == true
+          query = paginate(
+            query,
+            :var   => options[:var],
+            :limit => options[:limit]
+          )
+        else
+          query = query.limit(options[:limit]).all
+        end
+
+        # Loop over the rows and create a hash containing the custom fields and
+        # values of each entry.
+        query.each do |row|
+          row.fields ||= {}
+
+          # Get the fields?
+          if options[:custom_field_values] == true
+            row.custom_field_values.each do |field_value|
+              name             = field_value.custom_field.slug.to_sym
+              row.fields[name] = field_value.html
+            end
+          end
+        end
+
+        return query
+      end
+
+      ##
+      # Retrieves the details of a single section entry.
+      #
+      # @example Get a single entry
+      #  entry = get_entry('home')
+      #
+      # @since  0.3
+      # @param  [String|Fixnum] entry The ID or slug of an entry to retrieve.
+      # @return [Mixed]
+      #
+      def get_entry(entry)
+        row = Sections::Model::SectionEntry.find_by_pk_or_slug(entry)
+
+        return row if row.nil?
+
+        row.fields ||= {}
+
+        row.custom_field_values.each do |field_value|
+          name             = field_value.custom_field.slug.to_sym
+          row.fields[name] = field_value.html
+        end
+
+        return row
+      end
+    end # SectionFrontend
+  end # Helper
+end # Ramaze

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

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'en'
+  trans.name     = 'section_entries'
+
+  trans.translate do |t|
+    t['titles.index'] = 'Section Entries'
+    t['titles.edit']  = 'Edit Entry'
+    t['titles.new']   = 'Add Entry'
+
+    t['labels.id']         = '#'
+    t['labels.title']      = 'Title'
+    t['labels.slug']       = 'Slug'
+    t['labels.status']     = 'Status'
+    t['labels.created_at'] = 'Created at'
+    t['labels.updated_at'] = 'Updated at'
+    t['labels.author']     = 'Author'
+
+    t['special.status_hash.draft']     = 'Draft'
+    t['special.status_hash.published'] = 'Published'
+
+    t['tabs.basic']      = 'Basic'
+    t['tabs.categories'] = 'Categories'
+
+    t['messages.no_entries']    = 'No section entries were found.'
+    t['messages.no_categories'] = 'No categories have been assigned to the '\
+      'current section.'
+
+    t['errors.new']           = 'Failed to create a new section entry.'
+    t['errors.save']          = 'Failed to save the section entry.'
+    t['errors.delete']        = 'Failed to delete the section entry with ID#%s'
+    t['errors.no_delete']     = 'You haven\'t specified any section '\
+      'entries to delete.'
+    t['errors.invalid_entry'] = 'The specified entry is invalid.'
+
+    t['success.new']    = 'The new section entry has been created.'
+    t['success.save']   = 'The section entry has been modified.'
+    t['success.delete'] = 'All selected entries have been deleted.'
+
+    t['buttons.new']    = 'Add section entry'
+    t['buttons.delete'] = 'Delete selected entries'
+    t['buttons.save']   = 'Save entry'
+
+    t['permissions.show']   = 'Show section entry'
+    t['permissions.edit']   = 'Edit section entry'
+    t['permissions.new']    = 'Add section entry'
+    t['permissions.delete'] = 'Delete section entry'
+  end
+end

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

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'en'
+  trans.name     = 'sections'
+
+  trans.translate do |t|
+    t['titles.index'] = 'Sections'
+    t['titles.edit']  = 'Edit Section'
+    t['titles.new']   = 'Add Secton'
+
+    t['labels.id']                      = '#'
+    t['labels.name']                    = 'Name'
+    t['labels.slug']                    = 'Slug'
+    t['labels.description']             = 'Description'
+    t['labels.comment_allow']           = 'Allow comments'
+    t['labels.comment_require_account'] = 'Comments require an account'
+    t['labels.comment_moderate']        = 'Moderate comments'
+    t['labels.comment_format']          = 'Comment format'
+    t['labels.custom_field_groups']     = 'Custom field groups'
+    t['labels.category_groups']         = 'Category groups'
+    t['labels.manage_entries']          = 'Manage entries'
+
+    t['special.boolean_hash.true']  = 'Yes'
+    t['special.boolean_hash.false'] = 'No'
+
+    t['tabs.general']           = 'General'
+    t['tabs.comment_settings']  = 'Comment Settings'
+    t['tabs.group_assignments'] = 'Group Assignments'
+
+    t['messages.no_sections'] = 'No sections have been created yet.'
+
+    t['errors.new']       = 'Failed to create a new section.'
+    t['errors.save']      = 'Failed to modify the section.'
+    t['errors.delete']    = 'Failed to delete the section with ID #%s.'
+    t['errors.no_delete'] = 'You need to specify at least one ' \
+      'section to delete.'
+    t['errors.invalid_section'] = 'The specified section is invalid.'
+
+    t['success.new']    = 'The new section has been created.'
+    t['success.save']   = 'The section has been modified.'
+    t['success.delete'] = 'The selected sections have been deleted.'
+
+    t['buttons.new']    = 'Add section'
+    t['buttons.delete'] = 'Delete selected sections'
+    t['buttons.save']   = 'Save section'
+
+    t['permissions.show']   = 'Show section'
+    t['permissions.edit']   = 'Edit section'
+    t['permissions.new']    = 'Add section'
+    t['permissions.delete'] = 'Delete section'
+
+    t['description'] = 'Manage sections and section entries.'
+  end
+end

data/lib/zen/package/sections/lib/sections/language/nl/section_entries.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'nl'
+  trans.name     = 'section_entries'
+
+  trans.translate do |t|
+    t['titles.index'] = 'Sectie items'
+    t['titles.edit']  = 'Sectie item aanpassen'
+    t['titles.new']   = 'Sectie item aanmaken'
+
+    t['labels.id']         = '#'
+    t['labels.title']      = 'Titel'
+    t['labels.slug']       = 'Slug'
+    t['labels.status']     = 'Status'
+    t['labels.created_at'] = 'Aanmaak datum'
+    t['labels.updated_at'] = 'Aanpas datum'
+    t['labels.author']     = 'Auteur'
+
+    t['special.status_hash.draft']     = 'Voorbeeld'
+    t['special.status_hash.published'] = 'Gepubliceerd'
+
+    t['tabs.basic']      = 'Algemeen'
+    t['tabs.categories'] = 'Categoriën'
+
+    t['messages.no_entries']    = 'Er konden geen items worden gevonden.'
+    t['messages.no_categories'] = 'De huidige sectie bevat geen categoriën.'
+
+    t['success.new']    = 'Het sectie item is aangemaakt.'
+    t['success.save']   = 'Het sectie item is aangepast.'
+    t['success.delete'] = 'Alle geselecteerde items zijn verwijderd.'
+
+    t['errors.new']        = 'Het sectie item kon niet worden aangemaakt.'
+    t['errors.save']       = 'Het sectie item kon niet worden aangepast.'
+    t['errors.delete']     = 'Het sectie item met ID #%s kon niet ' \
+      'worden verwijderd.'
+    t['errors.no_delete']  = 'U moet ten minste 1 item specificeren ' \
+      'om te verwijderen.'
+    t['errors.invalid_entry'] = 'Het opgegeven item is ongeldig.'
+
+    t['buttons.new']    = 'Sectie item toevoegen'
+    t['buttons.save']   = 'Sectie item opslaan'
+    t['buttons.delete'] = 'Geselecteerde items verwijderen'
+
+    t['permissions.show']   = 'Sectie item weergeven'
+    t['permissions.edit']   = 'Sectie item aanpassen'
+    t['permissions.new']    = 'Sectie item aanmaken'
+    t['permissions.delete'] = 'Sectie item verwijderen'
+  end
+end

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

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+Zen::Language::Translation.add do |trans|
+  trans.language = 'nl'
+  trans.name     = 'sections'
+
+  trans.translate do |t|
+    t['titles.index'] = 'Secties'
+    t['titles.edit']  = 'Sectie aanpassen'
+    t['titles.new']   = 'Sectie toevoegen'
+
+    t['labels.id']                      = '#'
+    t['labels.name']                    = 'Naam'
+    t['labels.slug']                    = 'Slug'
+    t['labels.description']             = 'Beschrijving'
+    t['labels.comment_allow']           = 'Reacties toegestaan'
+    t['labels.comment_require_account'] = 'Reacties vereisen een account'
+    t['labels.comment_moderate']        = 'Beheer reacties'
+    t['labels.comment_format']          = 'Text opmaak'
+    t['labels.custom_field_groups']     = 'Veld groepen'
+    t['labels.category_groups']         = 'Categorie groepen'
+    t['labels.manage_entries']          = 'Beheer items'
+
+    t['special.boolean_hash.true']  = 'Ja'
+    t['special.boolean_hash.false'] = 'Nee'
+
+    t['tabs.general']           = 'Algemeen'
+    t['tabs.comment_settings']  = 'Reactie instellingen'
+    t['tabs.group_assignments'] = 'Groepen'
+
+    t['messages.no_sections'] = 'Er konden geen secties worden gevonden.'
+
+    t['success.new']    = 'De sectie is aangemaakt.'
+    t['success.save']   = 'De sectie is aangepast.'
+    t['success.delete'] = 'Alle geselecteerde secties zijn verwijderd.'
+
+    t['errors.new']       = 'De sectie kon niet worden aangemaakt.'
+    t['errors.save']      = 'De sectie kon niet worden aangepast.'
+    t['errors.delete']    = 'De sectie met ID #%s kon niet worden verwijderd.'
+    t['errors.no_delete'] = 'U moet ten minste 1 sectie specificeren ' \
+      'om te verwijderen.'
+    t['errors.invalid_section'] = 'De opgegeven sectie is ongeldig.'
+
+    t['buttons.new']    = 'Sectie toevoegen'
+    t['buttons.save']   = 'Sectie opslaan'
+    t['buttons.delete'] = 'Geselecteerde secties verwijderen'
+
+    t['permissions.show']   = 'Sectie weergeven'
+    t['permissions.edit']   = 'Sectie aanpassen'
+    t['permissions.new']    = 'Sectie aanmaken'
+    t['permissions.delete'] = 'Sectie verwijderen'
+
+    t['description'] = 'Beheer secties en sectie items.'
+  end
+end

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

@@ -1,64 +1,64 @@
-#:nodoc:
 module Sections
   #:nodoc:
   module Model
     ##
-    # Model that represents a single section. This model has the following
-    # relations:
+    # Model that represents a single section.
     #
-    # * section entries (one to many), eager loads the custom field values
-    # * custom field group (many to many)
-    # * category groups (many to many)
-    #
-    # The following plugins are loaded by this model:
-    #
-    # * sluggable (source: "name")
-    #
-    # @author Yorick Peterse
     # @since  0.1
     #
     class Section < Sequel::Model
-      one_to_many(
-        :section_entries, 
-        :class => "Sections::Model::SectionEntry", 
+      include Zen::Model::Helper
+
+      one_to_many :section_entries,
+        :class => 'Sections::Model::SectionEntry',
         :eager => [:custom_field_values, :section_entry_status]
-      )
-      
-      many_to_many(
-        :custom_field_groups, 
-        :class => "CustomFields::Model::CustomFieldGroup"
-      )
 
-      many_to_many(
-        :category_groups, 
-        :class => "Categories::Model::CategoryGroup"
-      )
+      many_to_many :custom_field_groups,
+        :class => 'CustomFields::Model::CustomFieldGroup'
+
+      many_to_many :category_groups,
+        :class => 'Categories::Model::CategoryGroup'
+
+      plugin :sluggable, :source => :name, :freeze => false
+
+      ##
+      # Searches for a number of sections of which the title or description
+      # matches the search query.
+      #
+      # @example
+      #  Sections::Model::Section.search('pages')
+      #
+      # @since  16-10-2011
+      # @param  [String] query The search query.
+      # @return [Mixed]
+      #
+      def self.search(query)
+        return filter(
+          search_column(:name, query) | search_column(:description, query)
+        )
+      end
 
-      plugin(:sluggable, :source => :name, :freeze => false)
-      
       ##
       # Specifies all validation rules for each section.
       #
-      # @author Yorick Peterse
       # @since  0.1
       #
       def validate
         validates_presence([
-          :name, 
-          :comment_allow, 
-          :comment_require_account, 
-          :comment_moderate, 
+          :name,
+          :comment_allow,
+          :comment_require_account,
+          :comment_moderate,
           :comment_format
         ])
 
-        validates_presence(:slug) unless new?
         validates_max_length(255, [:name, :slug])
-        
+
         validates_type(
-          TrueClass, 
+          TrueClass,
           [:comment_allow, :comment_require_account, :comment_moderate]
         )
-        
+
         validates_unique(:slug)
       end
     end # Section