octopress-ink 1.0.0.rc.49 → 1.0.0.rc.50

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4858b7de639dfc2e080960481b60d2e3b35c809
-  data.tar.gz: 748629f2f8af0d24a45fe78025106eb9c6cd4b57
+  metadata.gz: ce4c7acfb6d35fa4fbef2bd55517ea7afe07c152
+  data.tar.gz: 11699fa14d7a02824d0d19dd06ba50d0e202195a
 SHA512:
-  metadata.gz: 71f5e690c1ca468c8e14f8ab3770cc53b0fb2cfecf7379ca4be5ca11106de7a61acc46172571e69bfcc9bdc5e14b98427f236e198d91f19d92355b69f84c360b
-  data.tar.gz: 329f7932850c832ced252c2fd5103c45c9965c78528d4aee906bb303f919b9858b58c350c53407bc2c86375bc9328160fa0b5e500f6ca448dc7ba10011ac1acf
+  metadata.gz: f1799a7689945f7ca5f44474c7ab83261c267826bfcbee3078fa6ab9cbac01255acecd68b52dc766e8b616a57ac4c89512d9b2a7696ab1e01fc5f58ba27d95ea
+  data.tar.gz: 370063e56a406ef072e2e9032ebef830930529c2384fd0523d1a55ed803bc1f75d734476fe881c9c5550df31a0b79f31663143fb16ddf841e7f20a494883b115

data/CHANGELOG.md

@@ -1,7 +1,11 @@
 # Changelog
 
-### 1.0.0 RC49 - 2015-03-02
+### 1.0.0 RC50 - 2015-03-04
+- Improved information about disabled or overridden assets on `ink list plugin` commands
+- Reworked plugin bootstrap to use templates instead of pages
+- Removed page clone method (templates should be used for this)
 
+### 1.0.0 RC49 - 2015-03-02
 - New: Plugin bootstrap allows plugins to work with templates for post indexes and RSS feeds. Each with automatic support for multilingual sites.
 
 Plugins can add pages and templates for:

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

@@ -2,11 +2,10 @@ module Octopress
   module Ink
     module Assets
       class Asset
-        attr_reader :plugin, :dir, :base, :root, :file, :overridden
+        attr_reader :plugin, :dir, :base, :root, :file, :replacement
         attr_accessor :exists
 
         FRONT_MATTER = /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
-        @overridden = false
 
         def initialize(plugin, base, file)
           @file = file
@@ -19,16 +18,22 @@ module Octopress
         end
 
         def info
+          "  - #{asset_info}"
+        end
+
+        def asset_info
           message = filename.ljust(35)
-          if @overridden
-            message += "-overridden by #{@overridden}-"
+
+          if replaced?
+            message += "Replaced by #{@replacement} plugin"
           elsif disabled?
-            message += "-disabled-"
+            message += "Disabled by configuration"
           elsif path.to_s != plugin_path
             shortpath = File.join(Plugins.custom_dir.sub(Dir.pwd,''), dir).sub('/','')
-            message += "from: #{File.join(shortpath,filename).sub('/./', '/')}"
+            message += "From: #{File.join(shortpath,filename)}"
           end
-          "  - #{message}"
+          
+          message
         end
 
         def filename
@@ -36,7 +41,15 @@ module Octopress
         end
 
         def disabled?
-          is_disabled(base, filename) || @overridden
+          @disabled || is_disabled(base, filename) || replaced?
+        end
+
+        def replaced?
+          !@replacement.nil?
+        end
+
+        def disable
+          @disabled = true
         end
 
         def is_disabled(base, file)
@@ -44,10 +57,6 @@ module Octopress
           config.include?(base) || config.include?(File.join(base, filename))
         end
 
-        def override(plugin)
-          @overridden = plugin.name
-        end
-
         def path
           if @found_file
             @found_file

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

@@ -6,7 +6,7 @@ module Octopress
     module Assets
       class PageAsset < Asset
         attr_reader :filename
-        attr_accessor :data, :permalink_name, :cloned, :clone_of
+        attr_accessor :data, :permalink_name
 
         def initialize(plugin, base, file)
           @root = plugin.assets_path
@@ -31,14 +31,6 @@ module Octopress
           end
         end
 
-        def clone(data={})
-          self.cloned = true
-          p = PageAsset.new(plugin, base, file)
-          p.clone_of = self
-          p.data = data
-          p
-        end
-
         def merge_data(data={})
           page.data.merge!(data)
         end
@@ -68,26 +60,12 @@ module Octopress
             end
 
             page.data.merge!(@data)
+            page.plugin = plugin
 
             page
           end
         end
 
-        def info
-          message = super
-          return message if disabled?
-
-          if clone_of
-            "     #{permalink}"
-          elsif cloned
-            message << "\n     #{permalink}"
-          else
-            name = permalink_name << page.ext
-            message.sub!(/#{filename}\s*/, name.ljust(35))
-            message.ljust(25) << permalink
-          end
-        end
-
         def permalink
           page.url
         end

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

@@ -7,25 +7,24 @@ module Octopress
         def initialize(*args)
           super(*args)
           @pages = []
+          @existing_pages = {}
         end
 
         def add; end
 
         def info
-          message = filename.ljust(35)
-
-          if disabled?
-            message += "-disabled-"
-          elsif path.to_s != plugin_path
-            shortpath = File.join(Plugins.custom_dir.sub(Dir.pwd,''), dir).sub('/','')
-            message += "from: #{shortpath}/#{filename}"
+          message = "  - #{asset_info}\n"
+
+          unless disabled?
+            self.pages.each do |page|
+              if existing_page = @existing_pages[page.url]
+                message << "     #{page.url.ljust(33)} Disabled: /#{existing_page.path} already exists\n"
+              else
+                message << "     #{page.url}\n"
+              end
+            end
           end
 
-          message = "  - #{message}\n"
-
-          self.pages.each do |page|
-            message << "     #{page.url}\n"
-          end
           message
         end
 
@@ -33,10 +32,23 @@ module Octopress
           return if disabled?
           page = Ink::Page.new(Octopress.site, File.dirname(self.path), '.', File.basename(self.path))
           page.data.merge!(data)
-
+          page.plugin = plugin
           self.pages << page
 
-          page
+          if existing_page = page_exists?(page)
+            if existing_page.respond_to?(:plugin)
+              @replacement = existing_page.plugin.name
+            else
+              @existing_pages[existing_page.url] = existing_page
+            end
+            false
+          else
+            page
+          end
+        end
+
+        def page_exists?(page)
+          Octopress.site.pages.find {|p| p.url == page.url}
         end
       end
     end

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

@@ -2,7 +2,7 @@ module Octopress
   module Ink
     class Page < Jekyll::Page
       include Ink::Convertible
-      attr_accessor :dir, :name
+      attr_accessor :dir, :name, :plugin
 
       def relative_asset_path
         site_source = Pathname.new Octopress.site.source

data/lib/octopress-ink/plugin/bootstrap.rb

@@ -8,61 +8,49 @@ module Octopress
       # All with multilingual support.
       #
 
-      def self.reset
-        @pages      = {}
-        @categories = {}
-        @tags       = {}
-        @feeds      = {}
-      end
-
-      def self.pages
-        @pages
-      end
-
-      def self.categories
-        @categories
-      end
-
-      def self.tags
-        @tags
-      end
-
-      def self.feeds
-        @feeds
-      end
+      class << self
+        attr_reader :pages, :categories, :tags, :feeds
+
+        def reset
+          @pages      = {}
+          @categories = {}
+          @tags       = {}
+          @feeds      = {}
+        end
 
-      def self.page(lang, type, key)
-        @pages[type][key]
-      end
+        def page(lang, type, key)
+          @pages[type][key]
+        end
 
-      def self.category(category, lang)
-        category = "#{category}_#{page.lang}" if Octopress.multilingual? && page.lang 
-        @categories[category]
-      end
+        def category(category, lang)
+          category = "#{category}_#{page.lang}" if Octopress.multilingual? && page.lang 
+          @categories[category]
+        end
 
-      def self.tag(category, lang)
-        tag = "#{tag}_#{page.lang}" if Octopress.multilingual? && page.lang 
-        @tags[tag]
-      end
+        def tag(category, lang)
+          tag = "#{tag}_#{page.lang}" if Octopress.multilingual? && page.lang 
+          @tags[tag]
+        end
 
-      def self.add_page(page, key=nil)
-        if @pages[page.url].nil?
-          @pages[page.url] = page
-
-          url = page.url.sub(/index.(xml|html)/, '')
-
-          if key == 'feeds'
-            @feeds[url] = page.data['title']
-          elsif key == 'tag'
-            tag = page.data[key]
-            tag = "#{tag}_#{page.lang}" if Octopress.multilingual? && page.lang 
-            @tags[tag] = url
-          elsif key == 'category'
-            category = page.data[key]
-            category = "#{category}_#{page.lang}" if Octopress.multilingual? && page.lang 
-            @categories[category] = url
+        def add_page(page, key=nil)
+          if @pages[page.url].nil?
+            @pages[page.url] = page
+
+            url = page.url.sub(/index.(xml|html)/, '')
+
+            if key == 'feeds'
+              @feeds[url] = page.data['title']
+            elsif key == 'tag'
+              tag = page.data[key]
+              tag = "#{tag}_#{page.lang}" if Octopress.multilingual? && page.lang 
+              @tags[tag] = url
+            elsif key == 'category'
+              category = page.data[key]
+              category = "#{category}_#{page.lang}" if Octopress.multilingual? && page.lang 
+              @categories[category] = url
+            end
+            page
           end
-          page
         end
       end
 
@@ -71,7 +59,6 @@ module Octopress
       def bootstrap_plugin
         register_templates
         inject_configs
-        add_page_metadata
 
         # Add pages for other languages
         if Octopress.multilingual?
@@ -84,8 +71,8 @@ module Octopress
       def register_templates
         # Find pages and templates
 
-        @post_index       = pages.find     { |p| p.filename == 'post_index.html' }
-        @post_archive     = pages.find     { |p| p.filename == 'post_archive.html' }
+        @post_index       = templates.find { |p| p.filename == 'post_index.html' }
+        @post_archive     = templates.find { |p| p.filename == 'post_archive.html' }
         @main_feed        = templates.find { |p| p.filename == 'main_feed.xml' }
         @articles_feed    = templates.find { |p| p.filename == 'articles_feed.xml' }
         @links_feed       = templates.find { |p| p.filename == 'links_feed.xml' }
@@ -132,19 +119,6 @@ module Octopress
         opt_config
       end
 
-      def add_page_metadata
-        [post_index, post_archive].compact.each do |page|
-          page.page.data['title'] ||= page_title(page.page, config)
-          if Octopress.multilingual?
-            page.page.data['lang'] = Octopress.site.config['lang']
-          end
-
-          unless Bootstrap.add_page(page)
-            page.override Bootstrap.pages[page.url].plugin
-          end
-        end
-      end
-
       # Automatically clone pages or generate templates
       #
       # This will only occur if:
@@ -161,10 +135,8 @@ module Octopress
 
         # Only clone these pages for additional languages
         #
-        if Octopress.multilingual? && Octopress.site.config['lang'] != lang
-          add_indexes(config, lang, post_index)
-          add_indexes(config, lang, post_archive)
-        end
+        add_indexes(config, lang, post_index)
+        add_indexes(config, lang, post_archive)
 
         add_feeds(config, lang, main_feed)
 
@@ -177,33 +149,42 @@ module Octopress
         add_meta_indexes(config, lang, 'tag', 'tags')
       end
 
-      def add_indexes(config, lang, page)
-        if new_page = clone_page(page, lang)
-          if Bootstrap.add_page(new_page)
-            @pages << new_page
-          end
+      def add_indexes(config, lang, template)
+        return if template.nil?
+
+        permalink = page_permalink(template, lang)
+        title     = page_title(template, config, lang)
+
+        if page = template.new_page({
+            'lang'      => lang,
+            'title'     => title,
+            'permalink' => permalink
+          })
+
+          Bootstrap.add_page(page)
+          Octopress.site.pages << page
         end
       end
 
-      def add_feeds(config, lang, feed_template)
-        if feed_template
-          type = feed_type(feed_template)
-          if page = feed_template.new_page({
-              'lang'      => lang,
-              'feed_type' => type,
-              'permalink' => lang_permalink(lang, config['permalinks']["#{type}_feed"]),
-              'plugin'    => self
-            })
+      def add_feeds(config, lang, template)
+        return if template.nil?
 
-            page.data['title'] = page_title(page, config)
+        permalink = page_permalink(template, lang)
 
-            if Bootstrap.add_page(page, "feeds")
-              Octopress.site.pages << page
-            else
-              feed_template.pages.delete(page)
-            end
-          end
+        if page = template.new_page({
+            'lang'      => lang,
+            'permalink' => permalink,
+            'title'     => page_title(template, config, lang),
+            'feed_type' => feed_type(template),
+            'plugin'    => self
+          })
+
+
+          Bootstrap.add_page(page, "feeds")
+          Octopress.site.pages << page
         end
+
+        page
       end
 
       # Generates tag or category index or feed pages for each category and language
@@ -234,88 +215,83 @@ module Octopress
 
         collection.each do |item|
           item = item.downcase
+          item_label = tag_or_category_display_label(item, config)
 
           # Only add pages if plugin has a feed template for this item
           # and it hasn't been disabled in the configuration
           #
-          if page_template && config["#{type}_indexes"] != false
-            permalink = lang_permalink(lang, config['permalinks']["#{type}_index"]).sub(":#{type}", item)
-
-            page = page_template.new_page({
-              'lang'      => lang,
-              "#{type}"   => item,
-              'permalink' => permalink,
-              'plugin'    => self
-            })
-
-            page.data['title'] = page_title(page, config)
-            if Bootstrap.add_page(page, type)
-              Octopress.site.pages << page
+          if page_template
+            if config["#{type}_indexes"] == false
+              page_template.disable
             else
-              page_template.pages.delete(page)
+              permalink = page_permalink(page_template, lang).sub(":#{type}", item)
+
+              if page = page_template.new_page({
+                  'lang'      => lang,
+                  "#{type}"   => item,
+                  'title'     => page_title(page_template, config, lang).sub(":#{type}", item_label),
+                  'permalink' => permalink,
+                  'plugin'    => self
+                })
+
+                Bootstrap.add_page(page, type)
+                Octopress.site.pages << page
+              end
             end
           end
 
           # Only add feeds if plugin has a feed template for this item
           # and it hasn't been disabled in the configuration
           #
-          if feed_template && config["#{type}_feeds"] != false
-            permalink = lang_permalink(lang, config['permalinks']["#{type}_feed"]).sub(":#{type}", item)
-
-            page = feed_template.new_page({
-              'lang'      => lang,
-              "#{type}"   => item,
-              'feed_type' => type,
-              'permalink' => permalink,
-              'plugin'    => self
-            })
-
-            page.data['title'] = page_title(page, config)
-            if Bootstrap.add_page(page, 'feeds')
-              Octopress.site.pages << page
+          if feed_template
+
+            if config["#{type}_feeds"] == false
+              feed_template.disable
             else
-              feed_template.delete(page)
+              permalink = page_permalink(feed_template, lang).sub(":#{type}", item)
+
+              if page = feed_template.new_page({
+                  'lang'      => lang,
+                  "#{type}"   => item,
+                  'title'     => page_title(feed_template, config, lang).sub(":#{type}", item_label),
+                  'permalink' => permalink,
+                  'feed_type' => type,
+                  'plugin'    => self
+                })
+
+                Bootstrap.add_page(page, 'feeds')
+                Octopress.site.pages << page
+              end
             end
           end
         end
       end
 
-      # Creates a copy of an Ink Page asset
-      # configuring lang and permalink accordingly
-      #
-      def clone_page(page, lang)
-        return if page.nil?
-        new_page = page.clone({
-          'lang'      => lang,
-          'permalink' => page_permalink(page, lang)
-        })
-
-        new_page.page.data['title'] = page_title(new_page.page, config(lang))
-        new_page.permalink_name = nil
-        new_page
-      end
-
-      # Ensure cloned pages have language in their permalinks
-      # Since pages are only cloned for multilingual sites
+      # Ensure pages have language in their permalinks except the primary language pages
+      # Unless the user has specified /:lang/ in their permalink config
       #
       def page_permalink(page, lang)
-        permalink = config(lang)['permalinks'][page.permalink_name]
+        permalink = config(lang)['permalinks'][page_type(page)]
 
-        if permalink.include?(":lang")
+        # Obey the permalink configuration
+        permalink = if lang && permalink.include?(":lang")
           permalink.sub(":lang", lang)
-        else
+
+        # Otherwise only add lang for secondary languages
+        elsif lang && lang != Octopress.site.config['lang']
           File.join("/#{lang}", permalink)
-        end
-      end
 
-      # Ensure language is set in permalink if language is defined
-      #
-      def lang_permalink(lang, permalink)
-        if lang
-          permalink.sub(":lang", lang)
+        # Finally strip language from url if primary language or no language defined
         else
           permalink.sub("/:lang/", '/')
         end
+
+        if permalink.end_with?('/')
+          ext = File.extname(page.path).match('xml') ? 'xml' : 'html'
+          permalink += "index.#{ext}"
+        end
+
+        permalink
       end
 
       
@@ -349,7 +325,8 @@ module Octopress
         end
       end
 
-      def generic_title(type, config, lang=nil)
+      def page_title(page, config, lang)
+        type = page_type(page)
         title = config['titles'][type]
         title = title.sub(':site_name', Octopress.site.config['name'] || '')
         if lang && Octopress.multilingual?
@@ -358,21 +335,8 @@ module Octopress
         title
       end
 
-      def page_title(page, config)
-        type = page_type(page)
-        title = generic_title(type, config, page.lang)
-
-        if type.match(/(category|tag)/)
-          key = type.sub(/_index|_feed/, '')
-          label = tag_or_category_label(page, key, config)
-          title = title.sub(":#{key}", label)
-        end
-
-        title
-      end
-
-      def tag_or_category_label(page, type, config)
-        label = page.data[type].capitalize
+      def tag_or_category_display_label(label, config)
+        label = label.capitalize
 
         if labels = config["#{type}_labels"]
           label = labels[type] || label

data/lib/octopress-ink/tags/feeds_tag.rb

@@ -11,7 +11,7 @@ module Octopress
         end
 
         def tag(url, title)
-          "<link href='#{url.sub('index.xml', '')}' title='#{title}' rel='alternate' type='application/atom+xml'>"
+          "<link href='#{File.join('/', Octopress.site.config['baseurl'], url).sub('index.xml', '')}' title='#{title}' rel='alternate' type='application/atom+xml'>"
         end
       end
     end

data/lib/octopress-ink/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Ink
-    VERSION = "1.0.0.rc.49"
+    VERSION = "1.0.0.rc.50"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-ink
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.49
+  version: 1.0.0.rc.50
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll