octopress-ink 1.0.0.alpha.14 → 1.0.0.alpha.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08eb9060996010061c041b3f2434f22875ac59ec
-  data.tar.gz: d1e151131e5c0ab81d2d17d87039928e38123484
+  metadata.gz: 90fb70585fe1d4f7edbbaa1b3d2e3669b3014450
+  data.tar.gz: dda5c5f03ffc61784957309400887f79c8c7596a
 SHA512:
-  metadata.gz: 2b43c4be69c724b9a62e000fb31323ba9936e0ce1baba2f5100505f03de77763bb8af2513a15c40b33b5f455e39f7a8219a50c49d6626186f18cce2c1e0271ea
-  data.tar.gz: dc9ddf7f51b00ffd0b7fc3592420a0db21379aad007620f5e5f690ccf85162eb295aaec66cd5bbd9c834c6ba247df41c0c6b18304f55c71e492608b8944df3ec
+  metadata.gz: 3d7e8812d7b06fa34355e92602bb3d57885012228132875f4877cf1e19b69ef7499dbe9fb84a55a1a026b714c5561b30bbd6de40df01a4342aaa8155ada7fee0
+  data.tar.gz: e4e7be648642fac3335e419dbdd45388b680b0a8fe87b2aceb29b9435d4cab13720235c7372634b7f1530c3e24762f193fa61f6cf87fc32b6e5eb54c877f4c99

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+script: cd test && ruby test.rb
+

data/README.md

@@ -2,6 +2,9 @@
 
 Use Ink to help you build themes and plugins for Jekyll.
 
+[![Gem Version](https://badge.fury.io/rb/octopress-ink.png)](http://badge.fury.io/rb/octopress-ink)
+[![Build Status](https://travis-ci.org/octopress/ink.png?branch=master)](https://travis-ci.org/octopress/ink)
+
 ### Features
 - Installing Ink plugins is easy.
 - Users won't need to install or managae plugin assets.

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

@@ -17,16 +17,18 @@ module Octopress
       end
 
       def path(site)
-        file = user_path(site)
+        unless @found_file
+          files = []
+          files << user_path(site)
+          files << plugin_path unless @plugin_type == 'local_plugin'
+          files = files.flatten.reject { |f| !exists? f }
 
-        if !exists?(file) && @plugin_type != 'local_plugin'
-          file = plugin_path 
+          unless files.size
+            raise IOError.new "Could not find #{File.basename(@file)} at #{file}"
+          end
+          @found_file = Pathname.new files[0]
         end
-
-        unless exists? file
-          raise IOError.new "Could not find #{File.basename(file)} at #{file}"
-        end
-        Pathname.new file
+        @found_file
       end
 
       def file(file, site)
@@ -54,14 +56,28 @@ module Octopress
         File.join site.source, Plugins.custom_dir(site), @dir
       end
 
+      def local_plugin_path(site)
+        File.join site.source, @dir, @file
+      end
+
+      def user_override_path(site)
+        File.join user_dir(site), @file
+      end
+
       def user_path(site)
         if @plugin_type == 'local_plugin'
-          File.join site.source, @dir, @file
+          local_plugin_path(site)
         else
-          File.join user_dir(site), @file
+          user_override_path(site)
         end
       end
 
+      def alt_syntax_file
+        ext = File.extname(@file)
+        alt_ext = ext == 'scss' ? 'sass' : 'scss'
+        @file.sub(/\.#{ext}/, ".#{alt_ext}")
+      end
+
       def exists?(file)
         @exists[file] ||= File.exists?(file)
         @exists[file]

data/lib/octopress-ink/assets/{template.rb → include.rb}

@@ -1,6 +1,6 @@
 module Octopress
   module Assets
-    class Template < Asset
+    class Include < Asset
 
       def initialize(plugin, type)
         @plugin_type = plugin.type

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

@@ -19,8 +19,9 @@ module Octopress
         "<link href='/#{File.join(@dir, @file)}' media='#{@media}' rel='stylesheet' type='text/css'>"
       end
 
+      # TODO: choose user path before local path.
       def user_load_path(site)
-        File.join site.source, Plugins.custom_dir(site), @dir, File.dirname(@file)
+        File.join(site.source, Plugins.custom_dir(site), @dir, File.dirname(@file)).sub /\/\.$/, ''
       end
 
       def theme_load_path
@@ -48,13 +49,25 @@ module Octopress
             # If the plugin isn't a local plugin, add source paths to allow overrieds on @imports.
             #
             options[:load_paths] = [user_load_path(site), theme_load_path]
-            @compiled = Plugins.compile_sass_file(path(site).to_s, options)
+            @compiled = Plugins.compile_sass(path(site).read, options)
           end
         end
-
         @compiled
       end
 
+      def user_override_path(site)
+        # Allow Sass overrides to use either syntax
+        if @file =~ /s[ac]ss$/
+          [File.join(user_dir(site), @file), File.join(user_dir(site), alt_syntax_file)]
+        else
+          File.join user_dir(site), @file
+        end
+      end
+
+      def destination
+        File.join(@dir, @file.sub(/s.ss/, 'css'))
+      end
+
       def copy(site)
         site.static_files << StaticFileContent.new(compile(site), destination)
       end

data/lib/octopress-ink/assets.rb

@@ -4,7 +4,7 @@ module Octopress
     autoload :Javascript,           'octopress-ink/assets/javascript'
     autoload :Stylesheet,           'octopress-ink/assets/stylesheet'
     autoload :Sass,                 'octopress-ink/assets/sass'
-    autoload :Template,             'octopress-ink/assets/template'
+    autoload :Include,              'octopress-ink/assets/include'
     autoload :Layout,               'octopress-ink/assets/layout'
   end
 end

data/lib/octopress-ink/plugin.rb

@@ -1,21 +1,21 @@
 module Octopress
   class Plugin
     attr_accessor :name, :type, :asset_override, :assets_path,
-                  :layouts_dir, :stylesheets_dir, :javascripts_dir, :files_dir, :embeds_dir, :images_dir,
-                  :layouts, :embeds, :stylesheets, :javascripts, :images, :sass, :fonts, :files
+                  :layouts_dir, :stylesheets_dir, :javascripts_dir, :files_dir, :includes_dir, :images_dir,
+                  :layouts, :includes, :stylesheets, :javascripts, :images, :sass, :fonts, :files
 
     def initialize(name, type)
       @layouts_dir       = 'layouts'
       @files_dir         = 'files'
       @fonts_dir         = 'fonts'
       @images_dir        = 'images'
-      @embeds_dir        = 'embeds'
+      @includes_dir      = 'includes'
       @javascripts_dir   = 'javascripts'
       @stylesheets_dir   = 'stylesheets'
       @name              = name
       @type              = type
       @layouts           = []
-      @embeds            = []
+      @includes          = []
       @stylesheets       = []
       @javascripts       = []
       @images            = []
@@ -24,7 +24,7 @@ module Octopress
       @files             = []
       add_assets
       add_layouts
-      add_embeds
+      add_includes
     end
 
     def add_assets
@@ -69,8 +69,8 @@ module Octopress
       end
     end
 
-    def add_embeds
-      @embeds = Assets::Template.new(self, @embeds_dir)
+    def add_includes
+      @includes = Assets::Include.new(self, @includes_dir)
     end
 
     def add_image(file)
@@ -137,8 +137,8 @@ module Octopress
       files.dup.map { |f| f.tag }
     end
 
-    def embed(file, site)
-      @embeds.file(file, site)
+    def include(file, site)
+      @includes.file(file, site)
     end
   end
 end

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

@@ -6,8 +6,10 @@ module Octopress
     def add_files(files)
       files = [files] unless files.is_a? Array
       files.each do |file|
+        # accept ['file', 'media_type']
         if file.is_a? Array
           add_sass file.first, file.last
+        # accept 'file'
         else
           add_sass file
         end

data/lib/octopress-ink/plugins.rb

@@ -21,8 +21,8 @@ module Octopress
       [@theme].concat(@plugins).concat(@local_plugins).compact
     end
 
-    def self.embed(name, file, site)
-      plugin(name).embed(file, site)
+    def self.include(name, file, site)
+      plugin(name).include(file, site)
     end
 
     def self.register_plugin(plugin, name, type='plugin')
@@ -53,12 +53,12 @@ module Octopress
     end
     
     def self.combined_stylesheet_path(media)
-      File.join('stylesheets', "site-#{media}-#{@combined_stylesheets[media][:fingerprint]}.css")
+      File.join('stylesheets', "#{media}-#{@combined_stylesheets[media][:fingerprint]}.css")
     end
 
     def self.combined_javascript_path
       print = @javascript_fingerprint || ''
-      File.join('javascripts', "site-#{print}.js")
+      File.join('javascripts', "#{print}.js")
     end
 
     def self.write_files(site, source, dest)
@@ -165,21 +165,37 @@ module Octopress
       end
     end
 
-    def self.stylesheet_tags
-      css = []
-      plugins.each do |plugin| 
-        css.concat plugin.stylesheet_tags
-        css.concat plugin.sass_tags
+    def self.stylesheet_tags(site)
+      if concat_css(site)
+        combined_stylesheet_tag(site)
+      else
+        css = []
+        plugins.each do |plugin| 
+          css.concat plugin.stylesheet_tags
+          css.concat plugin.sass_tags
+        end
+        css
       end
-      css
     end
 
-    def self.javascript_tags
-      js = []
-      plugins.each do |plugin| 
-        js.concat plugin.javascript_tags
+    def self.concat_css(site)
+      site.config['octopress'] && site.config['octopress']['concat_css'] != false
+    end
+
+    def self.concat_js(site)
+      site.config['octopress'] && site.config['octopress']['concat_js'] != false
+    end
+
+    def self.javascript_tags(site)
+      if concat_js(site)
+        combined_javascript_tag(site)
+      else
+        js = []
+        plugins.each do |plugin| 
+          js.concat plugin.javascript_tags
+        end
+        js
       end
-      js
     end
 
     def self.copy_javascripts(site)
@@ -195,26 +211,34 @@ module Octopress
       end
     end
 
+    def self.local_sass_files(site)
+      if site.config['octopress'] && site.config['octopress']['sass'] && site.config['octopress']['sass']['files']
+        sass_files = site.config['octopress']['sass']['files'] || []
+      else
+        files = Dir.glob(File.join(site.source, 'stylesheets', '**/*.s[ca]ss')).reject { |f| File.basename(f) =~ /^_/ }
+        sass_files = files.map { |f| f.split('stylesheets/').last}
+      end
+      sass_files
+    end
+
     def self.add_static_files(site)
      
-      if site.config['sass'] and site.config['sass']['files']
-        plugin('sass').add_files site.config['sass']['files']
-      end
+      plugin('sass').add_files(local_sass_files(site))
  
       # Copy/Generate Stylesheets
       #
-      if site.config['octopress'] && site.config['octopress']['combine_stylesheets'] != false
-        copy_stylesheets(site)
-      else
+      if concat_css(site)
         write_combined_stylesheet(site)
+      else
+        copy_stylesheets(site)
       end
 
       # Copy/Generate Javascripts
       #
-      if site.config['octopress'] && site.config['octopress']['combine_javascripts'] != false
-        copy_javascripts(site)
-      else
+      if concat_js(site)
         write_combined_javascript(site)
+      else
+        copy_javascripts(site)
       end
 
       # Copy other assets

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

@@ -0,0 +1,32 @@
+module Octopress
+  module Tags
+    class IncludeTag < Liquid::Tag
+      PLUGIN_SYNTAX = /(.+?):(\S+)/
+
+      def initialize(tag_name, markup, tokens)
+        super
+        @markup = markup
+      end
+
+      def render(context)
+        include_tag = Jekyll::Tags::IncludeTag.new('include', @markup, [])
+
+        # If markup references a plugin e.g. plugin-name:include-file.html
+        if @markup.strip =~ PLUGIN_SYNTAX
+          @plugin = $1
+          @path = $2
+          content = Plugins.include(@plugin, @path, context.registers[:site]).read
+          partial = Liquid::Template.parse(content)
+          context.stack {
+            context['include'] = include_tag.parse_params(context)
+            partial.render!(context)
+          }.strip
+        # Otherwise, use Jekyll's default include tag
+        else
+          include_tag.render(context)
+        end
+      end
+    end
+  end
+end
+

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

@@ -6,11 +6,7 @@ module Octopress
       end
       def render(context)
         site = context.registers[:site]
-        if site.config['octopress'] && site.config['octopress']['combine_javascripts'] != false
-          Plugins.javascript_tags
-        else
-          Plugins.combined_javascript_tag(site)
-        end
+        Plugins.javascript_tags(site)
       end
     end
   end

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

@@ -6,11 +6,7 @@ module Octopress
       end
       def render(context)
         site = context.registers[:site]
-        if site.config['octopress'] && site.config['octopress']['combine_stylesheets'] != false
-          Plugins.stylesheet_tags
-        else
-          Plugins.combined_stylesheet_tag(site)
-        end
+        Plugins.stylesheet_tags(site)
       end
     end
   end

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

@@ -9,7 +9,11 @@ module Octopress
       end
 
       def render(context)
-        Helpers::ContentFor.render(context, @block_name)
+        content = Helpers::ContentFor.render(context, @block_name)
+        if @block_name == 'head'
+          content = "<meta name='generator' content='Octopress #{Octopress::Ink::VERSION}'>\n" + content
+        end
+        content
       end
     end
   end

data/lib/octopress-ink/tags.rb

@@ -1,6 +1,6 @@
 module Octopress
   module Tags
-    autoload :EmbedTag,             'octopress-ink/tags/embed'
+    autoload :IncludeTag,           'octopress-ink/tags/include'
     autoload :JavascriptTag,        'octopress-ink/tags/javascript'
     autoload :StylesheetTag,        'octopress-ink/tags/stylesheet'
     autoload :ContentForBlock,      'octopress-ink/tags/content_for'

data/lib/octopress-ink/version.rb

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

data/lib/octopress-ink.rb

@@ -1,10 +1,12 @@
 require 'jekyll'
 require 'digest/md5'
 
+require 'octopress-ink/version'
 require 'octopress-ink/generators/plugin_assets'
 require 'octopress-ink/jekyll/hooks'
 require 'octopress-ink/version'
 require 'octopress-ink/helpers/content_for'
+require 'pry-debugger'
 
 module Octopress
   CUSTOM_DIR = "_custom"
@@ -17,12 +19,12 @@ module Octopress
   autoload :Tags,                 'octopress-ink/tags'
   autoload :SassPlugin,           'octopress-ink/plugins/sass'
 
-  def self.register_plugin(plugin, name, type)
+  def self.register_plugin(plugin, name, type='plugin')
     Plugins.register_plugin(plugin, name, type)
   end
 end
 
-Liquid::Template.register_tag('embed', Octopress::Tags::EmbedTag)
+Liquid::Template.register_tag('include', Octopress::Tags::IncludeTag)
 Liquid::Template.register_tag('octopress_js', Octopress::Tags::JavascriptTag)
 Liquid::Template.register_tag('octopress_css', Octopress::Tags::StylesheetTag)
 Liquid::Template.register_tag('content_for', Octopress::Tags::ContentForBlock)

data/test/_config.yml

@@ -1,13 +1,20 @@
 name: Your New Jekyll Site
 markdown: redcarpet
 pygments: true
+source: source
+destination: site
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - test.rb
   
 # Sass configurations 
-sass: 
-  #output_style: compact
-  #line_numbers: true
-  files:
-    - [site.sass, all]
+octopress:
+  sass: 
+    #output_style: compact
+    #line_numbers: true
+    files:
+      - [site.sass, all]
 
 #gem:
   #- octopress-plugins

data/test/expected/index.html

@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+    <title>Your New Jekyll Site</title>
+    <meta name="viewport" content="width=device-width">
+  </head>
+  <body class=" ">
+    <div class='local-override'><p>Test plugin assets and overrides:</p>
+
+<ul>
+<li>layouts</li>
+<li>includes</li>
+<li>stylesheets</li>
+<li>javascripts</li>
+<li>files</li>
+<li>images</li>
+<li>fonts</li>
+<li>sass plugin</li>
+</ul>
+
+<p>Test configurations</p>
+
+<ul>
+<li>sass compression</li>
+<li>sass line numbers</li>
+<li>concat_css</li>
+<li>concat_js</li>
+</ul>
+
+<p>Test: markdown
+<strong>Hello World!</strong></p>
+
+<p>Test: head tag</p>
+
+<p>Testing Include booga</p>
+</div>
+
+  </body>
+</html>

data/test/expected/javascripts/d41d8cd98f00b204e9800998ecf8427e.js

@@ -0,0 +1,2 @@
+console.log('omg')
+console.log('bar')

data/test/expected/layout_tests/local.html

@@ -0,0 +1,3 @@
+Testing a local layout
+Load a standard layout
+

data/test/expected/layout_tests/plugin_layout.html

@@ -0,0 +1,3 @@
+The awesome-sauce plugin layout
+Load a layout from the awesome-sauce plugin
+

data/test/expected/layout_tests/theme.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+    <title></title>
+    <meta name="viewport" content="width=device-width">
+  </head>
+  <body class=" ">
+    Load a theme layout
+
+  </body>
+</html>

data/test/expected/layout_tests/theme_override.html

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+    <title></title>
+    <meta name="viewport" content="width=device-width">
+  </head>
+  <body class=" ">
+    <div class='local-override'>Load a layout from the theme override
+</div>
+
+  </body>
+</html>

data/test/expected/stylesheets/all-f769b23f68363155b7ab58ba178c0f53.css

@@ -0,0 +1 @@
+body{color:black}div{display:block}body{background:#fff}body{display:table}body{background:#aaa111}div{display:table}

data/test/expected/stylesheets/print-8f4e66fc8350adcb4482cebe140f212d.css

@@ -0,0 +1 @@
+.omg{display:none}

data/test/expected/tag_tests/content_for.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name='generator' content='Octopress 1.0.0.alpha.15'>
+
+  </head>
+  <body>
+    Testing content for
+    
+    
+  </body>
+</html>

data/test/expected/tag_tests/footer.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name='generator' content='Octopress 1.0.0.alpha.15'>
+
+  </head>
+  <body>
+    
+    <footer>This should go in the footer</footer>
+    
+  </body>
+</html>

data/test/expected/tag_tests/head.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name='generator' content='Octopress 1.0.0.alpha.15'>
+Testing head tagTesting that content_for is additive
+  </head>
+  <body>
+    
+    
+    
+  </body>
+</html>

data/test/expected/tag_tests/include.html

@@ -0,0 +1,2 @@
+Testing Include var_test
+

data/test/expected/tag_tests/include_plugin.html

@@ -0,0 +1 @@
+include from plugin

data/test/expected/tag_tests/include_theme.html

@@ -0,0 +1,2 @@
+Testing theme include
+Yo Dawg, I heard you like includes.

data/test/expected/tag_tests/include_theme_override.html

@@ -0,0 +1 @@
+, I heard you like includes.

data/test/expected/tag_tests/scripts.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name='generator' content='Octopress 1.0.0.alpha.15'>
+
+  </head>
+  <body>
+    
+    
+    Testing scripts
+  </body>
+</html>