nesta-plugin-subpages 0.5.0 → 0.5.2

data/README.md

@@ -17,10 +17,10 @@ subdirectories. For example:
     Page.find_by_path('parent').subpages() => [page-1, page-2, subdir-1]
 
 The returned array contains the Page instances themselves, not their
-string paths.
+string paths, and they will be sorted based on their titles.
 
-Lastly, there is also `#has_subpages?` helper method that returns true
-or false if the page has any subpages.
+Next, there is also `#has_subpages?` helper method that returns true or
+false if the page has any subpages.
 
 Subpages are cached within an instance variable the first time that
 `#subpages` is called, but this should not be a problem in most cases.
@@ -28,6 +28,20 @@ Subpages are cached within an instance variable the first time that
 Also, there is a helper defined called `subpages_for` that takes either
 a Page instance or a string path and returns the same array.
 
+Lastly, if for some reason you do *not* want a subpage listed, merely
+give it the metadata tag of `skip subpage: true` and it will indeed be
+skipped in the list.
+
+There are two options that you can pass to `subpages` in a hash to
+modify what it does:
+
+    :do_sort         - Defaults to true; sorts the pages by title.
+    :include_subdirs - Defaults to true; includes index pages of
+                       immediate subdirectories.
+
+Also, if you give the method a block, each page will be yielded and the
+method will return nil.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -53,7 +67,12 @@ example, in the sidebar, you might do this:
         %h1 Subpages
         - display_menu(@page.subpages, :class => "menu")
 
-        
+Or, if you wanna iterate of the pages:
+
+    - @page.subpages do |page|
+      = page.title
+
+
 # Contributing
 
 1. Fork it

data/lib/nesta-plugin-subpages/init.rb

@@ -8,10 +8,10 @@ module Nesta
         # array otherwise.
         def subpages_for(page_or_path)
           case page_or_path
-          when Page
+          when Nesta::Page
             return page_or_path.subpages()
           when String
-            page = Page.find_by_path(page_or_path)
+            page = Nesta::Page.find_by_path(page_or_path)
             return page.subpages if page
           end
 
@@ -27,10 +27,23 @@ module Nesta
     # page and any index pages in immediate subdirectories. If
     # the page is NOT an index page or there are NO subpages, an
     # empty array is returned.
-    def subpages
+    #
+    # The argument is a hash that defines two keys:
+    #   :do_sort         -- sort the results by page title.
+    #   :include_subdirs -- include index pages in immediate subdirectories.
+    #
+    # If given a block, the method will yield each page to it and
+    # method will return nil. Pages are still cached in @subpages
+    # however.
+    def subpages(opts={})
       return [] unless self.index_page?
       return @subpages if @subpages
 
+      options = {
+        :do_sort         => true,
+        :include_subdirs => true
+      }.update(opts)
+
       pth   = File.dirname(self.filename)
       mpth  = Page.model_path   # Just cacheing these two for
       fmts  = FORMATS.join('|') # use below.
@@ -44,9 +57,15 @@ module Nesta
         entry = File.join(pth, entry)
 
         if File.directory?(entry)
-          # If no index page is detected, move on to the next entry.
-          idxpth = File.join(entry, 'index.%s')
-          next unless FORMATS.detect {|fmt| File.exists?(idxpth % fmt)}
+          # If we are allowed to include the sub-directory
+          # index pages, do so. If no index page is detected, 
+          # move on to the next entry.
+          if options[:include_subdirs]
+            idxpth = File.join(entry, 'index.%s')
+            next unless FORMATS.detect {|fmt| File.exists?(idxpth % fmt)}
+          else
+            next
+          end
         else
           # Ignore any file that isn't a page.
           next unless entry.match(/\.(#{fmts})$/)
@@ -62,7 +81,16 @@ module Nesta
         end
       end
 
-      @subpages = pages.sort {|n, m| n.title.downcase <=> m.title.downcase}
+      @subpages = pages
+
+      if options[:do_sort]
+        @subpages.sort! {|n, m| n.title.downcase <=> m.title.downcase}
+      end
+
+      if block_given?
+        @subpages.each {|page| yield page}
+        return nil
+      end
 
       return @subpages
     end

data/lib/nesta-plugin-subpages/version.rb

@@ -1,7 +1,7 @@
 module Nesta
   module Plugin
     module Subpages
-      VERSION = "0.5.0"
+      VERSION = "0.5.2"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nesta-plugin-subpages
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-11 00:00:00.000000000 Z
+date: 2012-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nesta