octopress-ink 1.0.0.alpha.44 → 1.0.0.alpha.45

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ddd087cd3f779c18b523d5f4feccfcb3b575b2f
-  data.tar.gz: 12126d852db51f062a0063516819319f554de313
+  metadata.gz: 93de0d96c0c1233b369f703f42e9c5232f6fa122
+  data.tar.gz: 64f81451f17f6c13c9bc614d9996103ba7723a68
 SHA512:
-  metadata.gz: 141cf68d224be24a4e57860e87584dac4af215dbe0a9f2aa9b7e83f2bb9e2b5ebbb30abf7c11738290fed5077fb2088ae2eb71dfe01a1a3cca49e94bc772aa27
-  data.tar.gz: e0bdf61520091974cfebe8cd353cffa5a5dd8d5c0bdd6bbdd8b9b8fb6c1e52423018042bf74570cd56328dd621886e6877ed7c9a8d2c603ee76264510eb1b55f
+  metadata.gz: 1e2db0a926b6b38952e84f2bf03e873cc1e8826710aed7f0908962f9585ebde1d5ec9025341f4bcf2ab0579933bae79c04e7b0bb84c48349a956b09b85ebdb7d
+  data.tar.gz: 6be1640d06425163015188be229496775d3b31e25258595acaf95028d940aacb4face70c80ccb4e880ad295d96454900419865d60f7d054dd7fceb390ef3c87e

data/README.md

@@ -7,7 +7,7 @@ Use Ink to help you build themes and plugins for Jekyll.
 
 ### Features
 - Installing Ink plugins is easy.
-- Users won't need to install or managae plugin assets.
+- Users won't need to install or manage plugin assets.
 - Jekyll will read your plugin's layouts, javascripts, stylesheets and more directly from your gem.
 - Ink allows users to modify a theme or plugin by adding a modified version to source/_custom directory.
 
@@ -30,11 +30,6 @@ Or install it yourself as:
 This is still evolving quite a bit. If you want to use it, you
 should probably talk to me directly.
 
-## Roadmap
-- Write an example theme
-- Write an example plugin
-- Add support for compiling and stitching javascript/coffeescript.
-
 ## Contributing
 
 For right now. Talk to me directly. I'd love help thinking

data/assets/docs/_plugin-template.markdown

@@ -1,25 +1,13 @@
 ```ruby
 require "octopress-ink"
 
-module MyPlugin
-  class InkPlugin < Octopress::Ink::Plugin
-    
-    # Define the configuration for your plugin
-    #
-    def configuration
-      {
-        name:          "My plugin",
-        slug:          "my-plugin",
-        assets_path:   File.expand_path(File.join(File.dirname(__FILE__), '../assets')),
-        type:          "plugin",
-        version:       MyPlugin::VERSION,
-        description:   "",
-        website:       ""
-      }
-    end
-  end
-end
-
-# Register the plugin with Octopress Ink
-Octopress::Ink.register_plugin(SomePlugin::InkPlugin)
+Octopress::Ink.add_plugin({
+  name:          "My Plugin",
+  slug:          "my-plugin",
+  assets_path:   File.expand_path(File.join(File.dirname(__FILE__), '../assets')),
+  type:          "plugin",
+  version:       MyPlugin::VERSION,
+  description:   "",
+  website:       ""
+})
 ```

data/assets/docs/creating-a-plugin.markdown

@@ -5,20 +5,49 @@ permalink: /guides/creating-a-plugin/
 
 *This guide assumes you have already installed Git, and Ruby 1.9.3 or greater.*
 
-Octopress Ink plugins are distributed as ruby gems so you'll probably need to create an acconut at [RubyGems.org](https://rubygems.org/sign_up) if you haven't yet. Also, be sure to install the [bundler](http://bundler.io) gem.
+Octopress Ink plugins are distributed as ruby gems so you'll need to create an account at [RubyGems.org](https://rubygems.org/sign_up) if you haven't yet. Also, be sure to install the [Bundler](http://bundler.io) gem.
 
-## Creating a Plugin
+## Creating a plugin
 
-To create a new plugin from scratch run:
+Creating an Octopress Ink plugin is very simple. Here's the standard template.
+
+{% render ./_plugin-template.markdown %}
+
+The configuration options are as follows.
+
+{% render ./_configuration.markdown %}
+
+Next you simply need an `assets` directory at the root of your gem with subdirectories for each asset type you plan to use in your plugin.
+
+If you have a gem-based plugin which you'd like to convert into an Octopress Ink plugin, this should make it easy for you.
+
+```sh
+$ octopress ink init your_gem
+```
+
+This will add the asset directories, create a demo site, and print out a plugin template with instructions for how to add it to your gem.
+
+### Create a plugin from scratch
+
+To create a new plugin named "Spicy Baconnaise" run:
 
 ```sh
-octopress ink new cool_plugin
+$ octopress ink new spicy_baconnaise
 ```
 
-This will add scaffolding for a gem-based plugin in the `cool_plugin` directory. To create a theme, add the `--theme` flag.  Here's what that will look like.
+This does the following.
+
+- Creates a new gem using Bundler's gem scaffolding.
+- It adds `octopress` and `octopress-ink` as dependencies in the gemspec.
+- An Octopress Ink plugin template is added to `lib/spicy_baconnaise.rb`.
+- `assets/` contains empty asset directories.
+- `demo/` contains a blank Jekyll site with your plugin already integrated for easy testing.
+
+Here's what the new `spicy_baconnaise` directory looks like.
 
 ```
 assets/
+  docs/
   files/
   fonts/
   images/
@@ -28,19 +57,68 @@ assets/
   pages/
   stylesheets/
 lib/
-  cool_plugin/
+  spicy_baconnaise/
     version.rb
-  cool_plugin.rb
-cool_plugin.gemspec
+  spicy_baconnaise.rb
+demo/
+  _layouts/
+  _posts/
+  Gemfile
+  index.html
+spicy_baconnaise.gemspec
 Gemfile
 LICENSE.txt
 Rakefile
 README.md
 ```
 
-This is basically Bundler's gem scaffolding with a few additions.
+In `lib/spicy_baconnaise.rb` you'll find an Octopress Ink plugin created specifically for your gem.
+
+```ruby
+require 'lib/version'
+require 'octopress-ink'
+
+Octopress::Ink.add_plugin({
+  name:          "Spicy Baconnaise"
+  slug:          "spicy_baconnaise",
+  assets_path:   File.expand_path(File.join(File.dirname(__FILE__), "../assets")),
+  type:          "spicy_baconnaise",
+  version:       SpicyBaconnaise::Version,
+  description:   "",
+  website:       ""
+})
+```
+
+Change whatever you want and you are ready to start building your plugin.
+
+### Building on an existing plugin
+
+If you're going to convert an existing gem-based Jekyll plugin to use Octopress Ink, from your gem directory run:
+
+```sh
+$ octopress ink init .
+```
+
+This will add the assets directories and the demo site to your
+plugin. To finish setting up your plugin, you'll need to add the plugin template to your gem.
+
+## Plugin assets
+
+Octopress Ink plugins make it super easy to integrate assets with any Jekyll site. Your plugin should have an assets directory called `assets`. Typically this should be in the root directory of your gem. Inside `assets` there will be folders for each asset type you plan to use.
+
+Note: Assets are only copied at build time and assets will not overwrite an existing file.
+
+
+| Asset directory |  Description                                    |
+|:----------------|:------------------------------------------------|
+| docs            | Add documentation files for your plugin here. Users will be able to read it by running `octopress docs`. [read more]({% doc_url plugin-documentation %}) |
+| fonts           | `wingdings.ttf` is copied to `_site/fonts/[plugin_slug]/wingdings.ttf`.                                 |
+| images          | `cat.gif` is copied to `_site/images/[plugin_slug]/cat.gif`.                                            |
+| javascripts     | `boom.js` is combined with all plugin javascripts into a single fingerprinted file.                     |
+| stylesheets     | `theme.scss` and `print.css` are combined with all plugin stylesheets into a single fingerprinted file. |
+| includes        | Includes are available to users by {% raw %}`{% include [plugin_slug]:some_file.html %}`{% endraw %}.   |
+| layouts         | Users can add layouts by setting `layout: [plugin_slug]:some_layout` in a page's YAML front-matter.     |
+| pages           | `pages/feed.xml` is processed and copied to `_site/feed.xml` at build time. Setting `permalink: feed/` renders to `_site/feed/index.xml`. |
+| files           | `files/favicon.ico` is copied to `_site/favicon.ico`.                                                   |
 
-- Empty asset directories are added.
-- The gemspec requires `octopress-ink` as a runtime dependency.
-- A basic Octopress Ink plugin is added to `lib/cool_plugin.rb`.
 

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

@@ -25,7 +25,7 @@ module Octopress
             shortpath = File.join(Plugins.custom_dir, dir)
             message += "from: #{shortpath}/#{filename}"
           end
-          message
+          "  - #{message}"
         end
 
         def filename
@@ -33,7 +33,12 @@ module Octopress
         end
 
         def disabled?
-          plugin.disabled?(base, filename)
+          is_disabled(base, filename)
+        end
+
+        def is_disabled(base, file)
+          config = @plugin.config['disable']
+          config.include?(base) || config.include?(File.join(base, filename))
         end
 
         def path
@@ -52,20 +57,12 @@ module Octopress
           end
         end
 
-        def source_dir
-          if exists? user_override_path
-            user_dir
-          else
-            plugin_dir
-          end
-        end
-
-        def destination
-          File.join(dir, file)
+        def read
+          path.read
         end
 
         def add
-          Plugins.site.static_files << StaticFile.new(path, destination)
+          Plugins.static_files << StaticFile.new(path, destination)
         end
 
         # Copy asset to user override directory
@@ -82,6 +79,49 @@ module Octopress
           "+ ".green + "#{File.join(target_dir, filename)}"
         end
 
+        # Remove files from Jekyll's static_files array so it doesn't end up in the
+        # compiled site directory. 
+        #
+        def remove_jekyll_asset
+          Ink.site.static_files.clone.each do |sf|
+            if sf.kind_of?(Jekyll::StaticFile) && sf.path == path.to_s
+              Ink.site.static_files.delete(sf)
+            end
+          end
+        end
+
+        private
+
+        def source_dir
+          if exists? user_override_path
+            user_dir
+          else
+            plugin_dir
+          end
+        end
+
+        def destination
+          File.join(dir, file)
+        end
+
+        # Render file through Liquid if it contains YAML front-matter
+        #
+        def render
+          content = path.read
+
+          if content =~ /\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)/m
+            payload = Ink.site.site_payload
+            content = $POSTMATCH
+            payload['page'] = SafeYAML.load($1)
+            render_liquid(content, payload)
+          else
+            content
+          end
+        end
+
+        def render_liquid(content, payload={})
+          Liquid::Template.parse(content).render!(Ink.payload(payload), {})
+        end
 
         def plugin_dir
           File.join root, base
@@ -92,11 +132,11 @@ module Octopress
         end
 
         def user_dir
-          File.join Plugins.site.source, Plugins.custom_dir, dir
+          File.join Ink.site.source, Plugins.custom_dir, dir
         end
 
         def local_plugin_path
-          File.join Plugins.site.source, dir, file
+          File.join Ink.site.source, dir, file
         end
 
         def user_override_path
@@ -107,17 +147,6 @@ module Octopress
           user_override_path
         end
 
-        # Remove files from Jekyll's static_files array so it doesn't end up in the
-        # compiled site directory. 
-        #
-        def remove_jekyll_asset
-          Plugins.site.static_files.clone.each do |sf|
-            if sf.kind_of?(Jekyll::StaticFile) && sf.path == path.to_s
-              Plugins.site.static_files.delete(sf)
-            end
-          end
-        end
-
         def file_check
           if !exists? plugin_path
             raise "\nPlugin: #{plugin.name}: Could not find #{File.basename(file)} at #{plugin_path}".red

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

@@ -0,0 +1,22 @@
+module Octopress
+  module Ink
+    module Assets
+      class Coffeescript < Javascript
+        def read
+          @compiled ||= compile
+        end
+
+        private
+
+        def compile
+          ::CoffeeScript.compile(render)
+        end
+
+        def destination
+          File.join(base, plugin.slug, file.sub(/\.coffee/,'.js'))
+        end
+      end
+    end
+  end
+end
+

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

@@ -12,25 +12,29 @@ module Octopress
           @file = path
         end
 
-        def user_dir
-          File.join Plugins.site.source, Plugins.custom_dir, dir
-        end
-
-        def local_plugin_path
-          File.join Plugins.site.source, dir, file
+        # If config plugin config file exists, return contents for list command
+        def info
+          if exists?(config = plugin_path)
+            File.open(config).read.gsub(/^/,'    ')
+          else
+            "  none"
+          end
         end
 
         def read
           config = {}
           default = plugin_path
           if exists? default
-            config = YAML.safe_load(File.open(default))
+            config = SafeYAML.load_file(default) || {}
           end
 
           if exists? user_path
-            config = config.deep_merge YAML.safe_load(File.open(user_path))
+            user_config = SafeYAML.load_file(user_path) || {}
+            config = Jekyll::Utils.deep_merge_hashes(config, user_config)
           end
 
+          config['permalinks'] ||= {}
+
           config
         end
       end

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

@@ -18,25 +18,23 @@ module Octopress
           file_check
         end
 
-        def page_dir
-          dir == '.' ? '' : dir
-        end
-
-        def plugin_path
+        def path
           File.join(plugin_dir, page_dir, file)
         end
-
-        def source_dir
-          File.join root, base
+        
+        # Add doc page to Jekyll pages
+        #
+        def add
+          if Ink.config['docs_mode']
+            Ink.site.pages << page
+          end
         end
 
-        def path
-          File.join(plugin_dir, page_dir, file)
-        end
+        private
 
         def page
           return @page if @page
-          @page = Page.new(Plugins.site, source_dir, page_dir, file, {'path'=>plugin.docs_base_path})
+          @page = Page.new(Ink.site, source_dir, page_dir, file, {'path'=>plugin.docs_base_path})
           @page.data['layout'] = 'docs'
           @page.data['plugin'] = { 
             'name' => @plugin.name, 
@@ -47,13 +45,18 @@ module Octopress
           @page
         end
 
-        # Add doc page to Jekyll pages
-        #
-        def add
-          if Ink.config['docs_mode']
-            Plugins.site.pages << page
-          end
+        def page_dir
+          dir == '.' ? '' : dir
+        end
+
+        def plugin_path
+          File.join(plugin_dir, page_dir, file)
+        end
+
+        def source_dir
+          File.join root, base
         end
+
       end
     end
   end

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

@@ -17,18 +17,20 @@ module Octopress
           file_check
         end
 
+        def add
+          if !exists?(local_plugin_path) && !Ink.config['docs_mode']
+            Plugins.static_files << StaticFile.new(File.join(source_dir, file), destination)
+          end
+        end
+
+        private
+
         def filename
           @filename
         end
 
         def user_dir
-          File.join Plugins.site.source, Plugins.custom_dir, plugin.slug, base
-        end
-
-        def add
-          if !exists?(local_plugin_path) && !Ink.config['docs_mode']
-            Plugins.site.static_files << StaticFile.new(File.join(source_dir, file), destination)
-          end
+          File.join Ink.site.source, Plugins.custom_dir, plugin.slug, base
         end
       end
     end

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

@@ -6,6 +6,13 @@ module Octopress
           "<script src='#{Filters.expand_url(File.join(dir, file))}'></script>"
         end
 
+        def add
+          Plugins.add_js_tag tag
+          super
+        end
+
+        private
+
         def destination
           File.join(base, plugin.slug, file)
         end

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

@@ -8,13 +8,15 @@ module Octopress
           register
         end
 
+        private
+
         def register
           dir = user_dir
           if !exists?(File.join(dir, file))
             dir = plugin_dir
           end
 
-          Plugins.site.layouts[name] = Jekyll::Layout.new(Plugins.site, dir, file)
+          Ink.site.layouts[name] = Jekyll::Layout.new(Ink.site, dir, file)
         end
 
         def name

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

@@ -18,6 +18,16 @@ module Octopress
           file_check
         end
 
+        # Add page to Jekyll pages if no other page has a conflicting destination
+        #
+        def add
+          if page.url && !Ink.config['docs_mode']
+            Ink.site.pages << page unless Helpers::Path.find_page(page)
+          end
+        end
+
+        private
+
         def page_dir
           dir == '.' ? '' : dir
         end
@@ -31,19 +41,11 @@ module Octopress
         end
 
         def user_dir
-          File.join Plugins.site.source, Plugins.custom_dir, plugin.slug, base
+          File.join Ink.site.source, Plugins.custom_dir, plugin.slug, base
         end
 
         def page
-          @page ||= Page.new(Plugins.site, source_dir, page_dir, file, plugin.config)
-        end
-
-        # Add page to Jekyll pages if no other page has a conflicting destination
-        #
-        def add
-          if page.url && !Ink.config['docs_mode']
-            Plugins.site.pages << page unless Helpers::Path.find_page(page)
-          end
+          @page ||= Page.new(Ink.site, source_dir, page_dir, file, plugin.config)
         end
       end
     end

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

@@ -17,27 +17,38 @@ module Octopress
           "<link href='#{Filters.expand_url(File.join(dir, file))}' media='#{@media}' rel='stylesheet' type='text/css'>"
         end
 
-        # TODO: see if this is done TODO: choose user path before local path.
-        def user_load_path
-          File.join(Plugins.site.source, Plugins.custom_dir, dir, File.dirname(file)).sub /\/\.$/, ''
+        def read
+          @compiled ||= compile
         end
 
-        def theme_load_path
-          File.expand_path(File.join(root, base))
+        def content
+          render
+        end
+
+        def ext
+          path.extname
+        end
+
+        def load_paths
+          [user_load_path, theme_load_path]
         end
 
         def disabled?
-          plugin.disabled?('sass', filename) ||
-          plugin.disabled?('stylesheets', filename)
+          is_disabled('sass', filename) || is_disabled('stylesheets', filename)
         end
 
+        private
+
         def compile
-          unless @compiled
-            options = Plugins.sass_options
-            options[:load_paths] = [user_load_path, theme_load_path]
-            @compiled = Plugins.compile_sass(path.read, options)
-          end
-          @compiled
+          PluginAssetPipeline.compile_sass(self)
+        end
+
+        def user_load_path
+          File.join(Ink.site.source, Plugins.custom_dir, dir, File.dirname(file)).sub /\/\.$/, ''
+        end
+
+        def theme_load_path
+          File.expand_path(File.join(root, base))
         end
 
         def user_override_path
@@ -58,10 +69,6 @@ module Octopress
         def destination
           File.join(base, plugin.slug, file.sub(/@(.+?)\./,'.').sub(/s.ss/, 'css'))
         end
-
-        def add
-          Plugins.site.static_files << StaticFileContent.new(compile, destination)
-        end
       end
     end
   end

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

@@ -23,17 +23,23 @@ module Octopress
         end
 
         def disabled?
-          plugin.disabled?('css', filename) ||
-          plugin.disabled?('stylesheets', filename)
-        end
-
-        def destination
-          File.join(base, plugin.slug, file.sub(/@(.+?)\./,'.'))
+          is_disabled('css', filename) || is_disabled('stylesheets', filename)
         end
 
         def tag
           "<link href='#{Filters.expand_url(File.join(dir, file))}' media='#{media}' rel='stylesheet' type='text/css'>"
         end
+
+        def add
+          Plugins.add_css_tag tag
+          super
+        end
+
+        private
+
+        def destination
+          File.join(base, plugin.slug, file.sub(/@(.+?)\./,'.'))
+        end
       end
     end
   end

data/lib/octopress-ink/assets.rb

@@ -2,17 +2,14 @@ module Octopress
   module Ink
     module Assets
       autoload :Asset,                'octopress-ink/assets/asset'
-      autoload :LocalAsset,           'octopress-ink/assets/local_asset'
       autoload :Config,               'octopress-ink/assets/config'
       autoload :FileAsset,            'octopress-ink/assets/file'
       autoload :PageAsset,            'octopress-ink/assets/page'
       autoload :DocPageAsset,         'octopress-ink/assets/doc_page'
       autoload :Javascript,           'octopress-ink/assets/javascript'
+      autoload :Coffeescript,         'octopress-ink/assets/coffeescript'
       autoload :Stylesheet,           'octopress-ink/assets/stylesheet'
-      autoload :LocalStylesheet,      'octopress-ink/assets/local_stylesheet'
-      autoload :LocalJavascript,      'octopress-ink/assets/local_javascript'
       autoload :Sass,                 'octopress-ink/assets/sass'
-      autoload :LocalSass,            'octopress-ink/assets/local_sass'
       autoload :Include,              'octopress-ink/assets/include'
       autoload :Layout,               'octopress-ink/assets/layout'
     end