octopress-docs 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e40b0a59fde57b0e5436076083f368276f0d240e
-  data.tar.gz: 99c0393286971084bd5c27d5bc8d66de128c471f
+  metadata.gz: 05c977ae69bac6575c3cdb60de74d2cf97a7bee7
+  data.tar.gz: d35af90cad7c439f4cdf8d74291d5991c0e96db1
 SHA512:
-  metadata.gz: 780a883f9b27afd456bca8f3454f6810bad1a738152276bfec751680e00e6730c4c621e84a347a092927a2743dc32b40ebafa5a4ce014c638f754cdaccd6ae7e
-  data.tar.gz: 3874da1c6823efc2f33ee128f0f0a8e96349a70211dd97ba522fe4d866ea0fec00b6150470f4a10e9f850f6dd2f80df8d3a435d14efe29ed1834f738db69db8d
+  metadata.gz: 1daeb7c34ff8e14d2851596368a6a5097f531279938984b031727a539d7b8846805d33ff57525846db7f4823eada5bda9438665fb25601f1f3f6204e7097d8c7
+  data.tar.gz: e1a3d5b71f3c10ce2a2a06a7eeed2dfeff050b72d39b5c9e5b0f2f170df7242cfc94dd8b7dd84f446d4250cef2a6632a3a9058b7b48bdbb8544d58883e01d3f1

data/README.md

@@ -18,16 +18,17 @@ Or install it yourself as:
 
 ## Usage
 
-Automatically add your Readme and Changelog files:
+Automatically add your Readme and Changelog files along with any pages in your gem path under `/assets/docs`.
 
 ```ruby
 begin
   require 'octopress-docs'
   Octopress::Docs.add({
     name:        "Your Plugin",
-    dir:         File.expand_path(File.join(File.dirname(__FILE__), "../../")),
+    slug:        "your-plugin",
+    dir:         File.expand_path(File.join(File.dirname(__FILE__), "../../"))
   })
-rescue
+rescue LoadError
 end
 ```
 

data/docs/_layouts/docs.html

@@ -7,7 +7,7 @@ layout: default
 <h4>{{ page.plugin.name }} Doc Pages</h4>
 <nav role='navigation'>
 <ul>
-{% for doc in doc_pages[page.plugin.slug].pages %}
+{% for doc in plugin_docs[page.plugin.slug].docs %}
 <li><a href="{{ doc.url }}">{{ doc.title }}</a></li>
 {% endfor %}
 </ul>

data/docs/index.html

@@ -3,9 +3,9 @@ layout: default
 ---
 
 {% for plugin in plugin_docs %}
-<h4>{{ plugin.name }}</h4>
+<h4>{{ plugin[1].name }}</h4>
 <ul>
-{% for doc in plugin.docs %}
+{% for doc in plugin[1].docs %}
 <li><a href="{{ doc.url }}">{{ doc.title }}</a></li>
 {% endfor %}
 </ul>

data/lib/octopress-docs/command.rb

@@ -36,7 +36,7 @@ module Octopress
           'config-file' => File.join(site_dir, '_octopress.yml'),
           'override' => { 'docs_mode' => true }
         })
-        require_gems
+        require_plugins
         options['source'] = site_dir
         options['destination'] = File.join(site_dir, '_site')
         options
@@ -59,16 +59,32 @@ module Octopress
         Docs.gem_dir('docs')
       end
 
-      def self.require_gems
-        file = File.join(Dir.pwd, '_config.yml')
-        if File.exist? file
-          config = YAML.safe_load(File.open(file))
-          gems = config['gems']
-          if gems && gems.is_a?(Array)
-            gems.each {|g| require g }
+      def self.require_plugins
+        config = Octopress.site.config
+
+        if config['gems'].is_a?(Array)
+          config['gems'].each {|g| require g }
+        end
+
+        unless config['safe']
+          plugins_path.each do |plugins|
+            Dir[File.join(plugins, "**", "*.rb")].sort.each do |f|
+              require f
+            end
           end
         end
+        
+      end
+
+      # Returns an Array of plugin search paths
+      def self.plugins_path
+        if (Octopress.site.config['plugins'] == Jekyll::Configuration::DEFAULTS['plugins'])
+          [Jekyll.sanitized_path(Octopress.site.source, Octopress.site.config['plugins'])]
+        else
+          Array(Octopress.site.config['plugins']).map { |d| File.expand_path(d) }
+        end
       end
+      
     end
   end
 end

data/lib/octopress-docs/doc.rb

@@ -1,15 +1,15 @@
 module Octopress
   module Docs
     class Doc
-      attr_reader :filename, :plugin_name
+      attr_reader :filename, :plugin_name, :base_url
 
       def initialize(options={})
         @file            = options[:file]
         @dir             = options[:dir] ||= '.'
         @file_dir        = File.dirname(@file)
         @plugin_name     = options[:name]
-        @plugin_slug   ||= options[:slug] || @plugin_name
-        @plugin_type     = options[:type] || 'plugin'
+        @plugin_slug     = options[:slug]
+        @plugin_type     = options[:type]
         @base_url        = options[:base_url]
         @index           = options[:index]
       end
@@ -36,26 +36,18 @@ module Octopress
 
       def page
         return @page if @page
-        @page = Octopress::Ink::Page.new(Octopress.site, @dir, page_dir, file, {'path'=>base_url})
+        @page = Octopress::Docs::Page.new(Octopress.site, @dir, page_dir, file, {'path'=>@base_url})
         @page.data['layout'] = 'docs'
         @page.data['plugin'] = { 
           'name' => @plugin_name, 
           'slug' => plugin_slug,
-          'docs_base_url' => base_url
+          'docs_base_url' => @base_url
         }
         @page.data['dir'] = doc_dir
         @page.data['permalink'] = "/" if @index
         @page
       end
 
-      def base_url
-        @base_url || if @plugin_type == 'theme'
-          File.join('docs', 'theme')
-        else
-          File.join('docs', 'plugins', @plugin_slug)
-        end
-      end
-
       private
 
       def permalink

data/lib/octopress-docs/hooks.rb

@@ -1,7 +1,7 @@
 module Octopress
   module Docs
     class DocsSiteHook < Octopress::Hooks::Site
-      def post_read(site)
+      def pre_render(site)
         if Octopress.config['docs_mode']
           site.pages.concat Octopress::Docs.pages
         end

data/lib/octopress-docs/page.rb

@@ -0,0 +1,56 @@
+module Octopress
+  module Docs
+    class Page < Jekyll::Page
+      include Jekyll::Convertible
+
+      # Purpose: Configs can override a page's permalink
+      #
+      # url - Path relative to destination directory.
+      #       examples: 
+      #         - '/' for the _site/index.html page
+      #         - '/archive/' for the _site/archive/index.html page
+      #
+      def initialize(site, base, dir, name, config={})
+        @config = config
+        super(site, base, dir, name)
+        post_init if respond_to?(:post_init)
+      end
+
+      def hooks
+        self.site.page_hooks
+      end
+
+      def destination(dest)
+        unless @dest
+          if @config['path']
+            dest = File.join(dest, @config['path'])
+          end
+          @dest = File.join(dest, self.url)
+        end
+        @dest
+      end
+
+      def relative_asset_path
+        site_source = Pathname.new Octopress.site.source
+        page_source = Pathname.new @base
+        page_source.relative_path_from(site_source).to_s
+      end
+
+      # Allow pages to read url from plugin configuration
+      #
+      def url
+        unless @url
+          super
+
+          if @url && @url =~ /\/$/
+            ext = (self.ext == '.xml'? 'xml' : 'html')
+            @url = File.join(@url, "index.#{ext}")
+          end
+        end
+
+        @url
+      end
+    end
+  end
+end
+

data/lib/octopress-docs/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Docs
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/lib/octopress-docs.rb

@@ -2,9 +2,11 @@ require "octopress"
 require "jekyll"
 require "octopress-escape-code"
 require "octopress-hooks"
+require "find"
 
 require "octopress-docs/version"
 require "octopress-docs/command"
+require "octopress-docs/page"
 require "octopress-docs/doc"
 require "octopress-docs/tag"
 require "octopress-docs/hooks"
@@ -27,14 +29,15 @@ module Octopress
     end
 
     def self.pages_info
-      plugin_docs = []
-      @docs.keys.each { |slug|
-        plugin_docs << {
-          "name" => @docs[slug].first.plugin_name,
-          "docs" => plugin_docs(@docs[slug])
+      docs = @docs.clone
+      docs.each { |slug, pages|
+        docs[slug] = {
+          "name" => pages.first.plugin_name,
+          "docs" => plugin_docs(pages)
         }
       }
-      { 'plugin_docs' => plugin_docs }
+
+      { 'plugin_docs' => docs }
     end
 
     def self.plugin_docs(pages)
@@ -53,20 +56,23 @@ module Octopress
       }
     end
 
-    def self.add_plugin_docs(plugin, dir, files)
-      pages = []
-      options = plugin_options(plugin).merge({
-        dir: File.join(plugin.assets_path, dir),
-      })
-
-      files.each do |doc|
+    def self.add_plugin_docs(plugin)
+      plugin_doc_pages = []
+      options = plugin_options(plugin)
+      find_doc_pages(options).each do |doc|
         unless doc =~ /^_/
-          opts = options.merge({file: doc})   
-          pages << add_doc_page(opts)
+          opts = options.merge({file: doc, dir: options[:docs_path]})   
+          plugin_doc_pages << add_doc_page(opts)
         end
       end
 
-      pages
+      # If there is no docs index page, set the reame as the index page
+      has_index = !plugin_doc_pages.select {|d| d.file =~ /^index/ }.empty?
+      plugin_doc_pages << add_root_plugin_doc(plugin, 'readme', index: !has_index)
+
+      plugin_doc_pages << add_root_plugin_doc(plugin, 'changelog')
+
+      plugin_doc_pages
     end
 
     def self.plugin_options(plugin)
@@ -74,15 +80,43 @@ module Octopress
         name: plugin.name,
         slug: plugin.slug,
         type: plugin.type,
-        base_url: plugin.docs_base_url,
-        dir: plugin.path
+        base_url: plugin.docs_url,
+        dir: plugin.path,
+        docs_path: File.join(plugin.assets_path, 'docs'),
+        docs: %w{readme changelog}
       }
     end
 
+    def self.default_options(options)
+      options[:type] ||= 'plugin'
+      options[:slug] = slug(options)
+      options[:base_url] = base_url(options)
+      options[:dir] ||= '.'
+    end
+
+    def self.slug(options)
+      slug = options[:slug] || options[:name]
+      options[:type] == 'theme' ? 'theme' : Jekyll::Utils.slugify(slug)
+    end
+    
+    def self.base_url(options)
+      options[:base_url] || if options[:type] == 'theme'
+        File.join('docs', 'theme')
+      else
+        File.join('docs', 'plugins', options[:slug])
+      end
+    end
+
     def self.add(options)
+      options[:docs] ||= %w{readme changelog}
+      options[:docs_path] ||= File.join(options[:dir], 'assets', 'docs')
+      docs = []
+      docs.concat add_root_docs(options)
+      docs.concat 
+    end
 
+    def self.add_root_docs(options)
       root_docs = []
-      options[:docs] ||= %w{readme changelog}
       options[:docs].each do |doc|
         if doc =~ /readme/
           root_docs << add_root_doc(doc, options.merge({index: true}))
@@ -102,6 +136,8 @@ module Octopress
 
     def self.add_root_plugin_doc(plugin, filename, options={})
       options = plugin_options(plugin).merge(options)
+      
+      require 'pry-byebug'; binding.pry
       add_root_doc(filename, options)
     end
 
@@ -112,8 +148,23 @@ module Octopress
       page
     end
 
+    private
+
+    def self.find_doc_pages(options)
+      full_dir = options[:docs_path]
+      glob_assets(full_dir).map do |file|
+        file.sub(full_dir+'/', '')
+      end
+    end
+
+    def self.glob_assets(dir)
+      return [] unless Dir.exist? dir
+      Find.find(dir).to_a.reject {|f| File.directory? f }
+    end
+
     def self.select_first(dir, match)
       Dir.new(dir).select { |f| f =~/#{match}/i}.first
     end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-docs
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-15 00:00:00.000000000 Z
+date: 2014-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: octopress
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0.rc
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.0.0.rc
 - !ruby/object:Gem::Dependency
   name: octopress-hooks
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +115,7 @@ files:
 - lib/octopress-docs/command.rb
 - lib/octopress-docs/doc.rb
 - lib/octopress-docs/hooks.rb
+- lib/octopress-docs/page.rb
 - lib/octopress-docs/tag.rb
 - lib/octopress-docs/version.rb
 homepage: https://github.com/octopress/docs