nesta-plugin-subpages 0.5.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nesta-plugin-subpages.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Randy "Syntruth" Carnahan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# Nesta Subpages Plugin
+
+Add two new methods to the `Nesta::Page` class that finds any subpages
+for an index page. A subpage is considered to be a sibling page in the
+same directory as the index page and any index pages within immediate
+subdirectories. For example:
+
+    /content/pages/parent/
+    /content/pages/parent/index.mdown
+    /content/pages/parent/page-1.mdown
+    /content/pages/parent/page-2.mdown
+    /content/pages/parent/subdir-1/
+    /content/pages/parent/subdir-1/index.haml
+    /content/pages/parent/subdir-2/
+    /content/pages/parent/subdir-2/some-other-pages.mdown
+
+    Page.find_by_path('parent').subpages() => [page-1, page-2, subdir-1]
+
+The returned array contains the Page instances themselves, not their
+string paths.
+
+Lastly, 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.
+
+Also, there is a helper defined called `subpages_for` that takes either
+a Page instance or a string path and returns the same array.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'nesta-plugin-subpages'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nesta-plugin-subpages
+
+## Usage
+
+Not much to do! Simply call the `#subpages` method on your Page object
+when you want to use the array of subpages! Easy peasy, m'friend. For
+example, in the sidebar, you might do this:
+
+    - if @page.has_subpages?
+      #nav.subpages
+        %h1 Subpages
+        - display_menu(@page.subpages, :class => "menu")
+
+        
+# Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/nesta-plugin-subpages.rb

@@ -0,0 +1,3 @@
+require "nesta-plugin-subpages/version"
+
+Nesta::Plugin.register(__FILE__)

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

@@ -0,0 +1,81 @@
+module Nesta
+  module Plugin
+    module Subpages
+      module Helpers
+
+        # Helper that takes a page or a string path to a page
+        # and returns any subpages if they exist, or an empty
+        # array otherwise.
+        def subpages_for(page_or_path)
+          case page_or_path
+          when Page
+            return page_or_path.subpages()
+          when String
+            page = Page.find_by_path(page_or_path)
+            return page.subpages if page
+          end
+
+          return []
+        end
+
+      end
+    end
+  end
+
+  class Page
+    # This method grabs any pages that are siblings of an index
+    # 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
+      return [] unless self.index_page?
+      return @subpages if @subpages
+
+      pth   = File.dirname(self.filename)
+      mpth  = Page.model_path   # Just cacheing these two for
+      fmts  = FORMATS.join('|') # use below.
+      pages = []
+
+      Dir.foreach(pth) do |entry|
+        # Skip the dot-dirs and any index page in the current
+        # directory.
+        next if entry == '.' or entry == '..' or entry.match(/^index/)
+
+        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)}
+        else
+          # Ignore any file that isn't a page.
+          next unless entry.match(/\.(#{fmts})$/)
+        end
+
+        entry = entry.sub("#{mpth}/", '').sub(/\.(#{fmts})/, '')
+        page  = Page.find_by_path(entry)
+
+        # If we have a page and we haven't been asked skip 
+        # this page, add it to the list.
+        if page and not page.metadata('skip subpage')
+          pages.push(page)
+        end
+      end
+
+      @subpages = pages.sort {|n, m| n.title.downcase <=> m.title.downcase}
+
+      return @subpages
+    end
+
+    # Returns true if the page is an index page AND there are
+    # any subpages, false otherwise.
+    def has_subpages?
+      return false unless self.index_page?
+      return self.subpages.empty? ? false : true
+    end
+  end
+
+  class App
+    helpers Nesta::Plugin::Subpages::Helpers
+  end
+end

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

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

data/nesta-plugin-subpages.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/nesta-plugin-subpages/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Syntruth"]
+  gem.email         = ["syntruth@gmail.com"]
+  gem.description   = "Plugin that adds index page subpages methods and helpers"
+  gem.summary       = "Nesta CMS Subpages Plugin."
+  gem.homepage      = "https://github.com/syntruth/Nesta-Subpages-Plugin"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "nesta-plugin-subpages"
+  gem.require_paths = ["lib"]
+  gem.version       = Nesta::Plugin::Subpages::VERSION
+  gem.add_dependency("nesta", ">= 0.9.11")
+  gem.add_development_dependency("rake")
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: nesta-plugin-subpages
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+  prerelease: 
+platform: ruby
+authors:
+- Syntruth
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nesta
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.11
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Plugin that adds index page subpages methods and helpers
+email:
+- syntruth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/nesta-plugin-subpages.rb
+- lib/nesta-plugin-subpages/init.rb
+- lib/nesta-plugin-subpages/version.rb
+- nesta-plugin-subpages.gemspec
+homepage: https://github.com/syntruth/Nesta-Subpages-Plugin
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Nesta CMS Subpages Plugin.
+test_files: []