octopress-ink 1.0.0.alpha.35 → 1.0.0.alpha.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 768fa9c52f22622c7612a91b2b7361a9f6b00e6e
-  data.tar.gz: e35a3eaab4d06c86ba3e114e08c240e593700047
+  metadata.gz: ba0cc24dea9dd480491670843df791c946c80b03
+  data.tar.gz: 1ee711e4557cbb1b1fd2189f3a6865a099bd02b1
 SHA512:
-  metadata.gz: e07ec4b06d2b6ee24f78c7913d6b2a8aac6f62b9c0f50b83fa09362781fcad8e192e9e0bf51c4af28e4ae06bb37a16ebf251b584caa2978020f65b17046c6760
-  data.tar.gz: 54358f50230a19b846dfa0185045e6edf37fa67f720dc86924ce621424600764b3d77c9ee814300fab2604cea8db08325625b016f2392553bc58171a21449142
+  metadata.gz: 47b839782bcf26f6582d72a49ba29ef59c510f0a625aa633e71ec802246b8f3ac8f954cd3b7b035e88b3cec5aa5e5234dfb0dc703eceabbe719af184455de6c0
+  data.tar.gz: a69ece94caf2e6eb8deabc429256e36f0bd7f4c13bfe00d086f2d154e829751e45928b96e65c0f578f80bdbfae896f6d2ba9b068f7bbecbb8162e14ee7bc30ec

data/lib/octopress-ink/assets/doc_page.rb

@@ -35,14 +35,18 @@ module Octopress
         end
 
         def page
-          @page ||= Page.new(Plugins.site, source_dir, page_dir, file, {'path'=>plugin.docs_base_path})
+          return @page if @page
+          @page = Page.new(Plugins.site, source_dir, page_dir, file, {'path'=>plugin.docs_base_path})
+          @page.data['layout'] = 'docs'
+          @page.data['plugin'] = @plugin.slug
+          @page.data['docs_pages'] = @plugin.doc_pages
+          @page
         end
 
         # Add doc page to Jekyll pages
         #
         def add
           if Ink.config['docs_mode']
-            page.data['layout'] = 'docs'
             Plugins.site.pages << page
           end
         end

data/lib/octopress-ink/jekyll/hooks.rb

@@ -10,6 +10,9 @@ module Jekyll
       payload['converter'] = self.converter
       payload['octopress'] = {}
       payload['octopress']['version'] = Octopress::Ink.version
+      if Octopress::Ink.config['docs_mode']
+        payload['doc_pages'] = Octopress::Ink::Plugins.doc_pages
+      end
       do_layout_orig(payload, layouts)
     end
   end

data/lib/octopress-ink/plugin.rb

@@ -3,12 +3,12 @@ require 'find'
 module Octopress
   module Ink
     class Plugin
-      attr_accessor :name, :type, :assets_path,
+      attr_reader   :name, :type, :assets_path,
                     :layouts_dir, :css_dir, :javascripts_dir, :files_dir, :includes_dir, :images_dir,
                     :layouts, :includes, :images, :fonts, :files, :pages, :docs,
                     :website, :description, :version, :config
 
-      def initialize(name, type)
+      def initialize(slug, type)
         @layouts_dir       = 'layouts'
         @files_dir         = 'files'
         @pages_dir         = 'pages'
@@ -20,8 +20,6 @@ module Octopress
         @css_dir           = 'stylesheets'
         @sass_dir          = 'stylesheets'
         @config_file       = 'config.yml'
-        @name              = name
-        @type              = type
         @layouts           = []
         @includes          = []
         @css               = []
@@ -32,6 +30,9 @@ module Octopress
         @fonts             = []
         @files             = []
         @pages             = []
+        @type              = type
+        @slug              = slug
+        @name            ||= slug
         @version         ||= false
         @description     ||= false
         @website         ||= false
@@ -84,12 +85,32 @@ module Octopress
       end
 
       def slug
-        @type == 'theme' ? @type : @name
+        @type == 'theme' ? @type : @slug
       end
 
       def docs_base_path
         type = @type == 'plugin' ? 'plugins' : @type
-        File.join('docs', type, @name)
+        File.join('docs', type, slug)
+      end
+
+      # Docs pages for easy listing in an index
+      #
+      # returns: Array of hashes including doc page title and url
+      #
+      def doc_pages
+        if !@docs.empty?
+          @docs.clone.map do |d|
+            page_data = d.page.data
+            title   = page_data['link_title'] || page_data['title']
+            title ||= File.basename(d.file, '.*')
+            path = File.join(docs_base_path, d.file)
+
+            {
+              'title' => title,
+              'path' => path
+            }
+          end
+        end
       end
 
       def can_disable
@@ -138,6 +159,7 @@ module Octopress
           name += " - v#{@version}" if @version
           name  = name
           message = name
+          message += "\nSlug: #{slug}"
 
           if @description
             message += "\n#{@description}"

data/lib/octopress-ink/plugins/asset_pipeline.rb

@@ -5,6 +5,11 @@ module Octopress
   module Ink
     class AssetPipelinePlugin < Plugin
 
+      def initialize(slug, type)
+        @name = "Octopress Assset Pipeline"
+        super
+      end
+
       def register_assets
 
         local_stylesheets.each {|f| add_stylesheet(f) }

data/lib/octopress-ink/plugins.rb

@@ -17,13 +17,13 @@ module Octopress
         plugins.size
       end
 
-      def self.plugin(name)
-        if name == 'theme'
+      def self.plugin(slug)
+        if slug == 'theme'
           @theme
         else
-          found = plugins.reject { |p| p.name != name }
+          found = plugins.reject { |p| p.slug != slug }
           if found.empty?
-            raise IOError.new "No Theme or Plugin with the name '#{name}' was found."
+            raise IOError.new "No Theme or Plugin with the slug '#{slug}' was found."
           end
           found.first
         end
@@ -84,7 +84,7 @@ module Octopress
 
           plugins.each do |p| 
             unless p == @theme
-              @config['plugins'][p.name] = p.config
+              @config['plugins'][p.slug] = p.config
             end
           end
 
@@ -92,6 +92,23 @@ module Octopress
         end
       end
 
+      # Docs pages for each plugin
+      #
+      # returns: Array of plugin doc pages
+      #
+      def self.doc_pages
+        plugins.clone.map { |p|
+          if pages = p.doc_pages
+            { 
+              "name" => p.name,
+              "pages" => pages
+            }
+          else
+            nil
+          end
+        }.compact
+      end
+
       def self.include(name, file)
         p = plugin(name)
         p.include(file)

data/lib/octopress-ink/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Ink
-    VERSION = "1.0.0.alpha.35"
+    VERSION = "1.0.0.alpha.36"
   end
 end

data/octopress-ink.gemspec

@@ -19,8 +19,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "jekyll", "~> 1.4.3"
-  spec.add_runtime_dependency "sass", "~> 3.2.0"
+  spec.add_runtime_dependency "sass", "~> 3.3.0"
 
+  spec.add_development_dependency "octopress", "~> 1.0.0.alpha.8"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry-debugger"

data/test/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 gem "octopress-ink", path: "../"
 gem "pry-debugger"
+#gem "octopress", path: "../../cli"

data/test/plugins/test-theme/plugin.rb

@@ -4,6 +4,7 @@ class TestTheme < Octopress::Ink::Plugin
   def initialize(name, type)
     @assets_path = File.expand_path(File.join(File.dirname(__FILE__)))
     @description = "Test theme y'all"
+    @name = "Classic Theme"
     super
   end
   def add_assets

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-ink
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.35
+  version: 1.0.0.alpha.36
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-08 00:00:00.000000000 Z
+date: 2014-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: octopress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.alpha.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.alpha.8
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement