octopress-ink 1.0.0.alpha.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2733bea14e5d82069fb9d58a63ccd5fed20efb04
+  data.tar.gz: deb7324821b5d0ac653e401d3c2897502968b415
+SHA512:
+  metadata.gz: 2240d4345400bac8244d3aeb23387fc94ace79f70fbfe706f047c2592f7961696f2df21b41fd8c7ba649ba210d6634c14dc37f1b7b97febef6f789e0a290fd8a
+  data.tar.gz: 2bc307c23fa3d23c472c524ec94326354da8b0a4b6239a3b7bff53117394a38bf0ae496ab45133d4ba4120345774696f0b9fe065d81cff7d753096ae5ffc97c3

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+.sass-cache

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in themebase.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brandon Mathis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# Octopress Ink
+
+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.
+- 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 their modified version to _themes directory.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'octopress-ink'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octopress-ink
+
+## Usage
+
+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
+through some of this stuff. Pretty soon, build a theme or a plugin and tell me what's broken.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/octopress-ink.rb

@@ -0,0 +1,37 @@
+require 'jekyll'
+require 'pry-debugger'
+require 'digest/md5'
+
+require 'octopress-ink/generators/plugin_assets'
+require 'octopress-ink/jekyll/hooks'
+require 'octopress-ink/version'
+require 'octopress-ink/helpers/content_for'
+
+module Octopress
+  CUSTOM_DIR = "_custom"
+
+  autoload :Assets,               'octopress-ink/assets'
+  autoload :StaticFile,           'octopress-ink/assets/static_file'
+  autoload :StaticFileContent,    'octopress-ink/assets/static_file_content'
+  autoload :Plugins,              'octopress-ink/plugins'
+  autoload :Plugin,               'octopress-ink/plugin'
+  autoload :Tags,                 'octopress-ink/tags'
+  autoload :SassPlugin,           'octopress-ink/plugins/sass'
+
+  def self.register_plugin(plugin, name, type)
+    Plugins.register_plugin(plugin, name, type)
+  end
+end
+
+Liquid::Template.register_tag('embed', Octopress::Tags::EmbedTag)
+Liquid::Template.register_tag('theme_js', Octopress::Tags::JavascriptTag)
+Liquid::Template.register_tag('theme_css', Octopress::Tags::StylesheetTag)
+Liquid::Template.register_tag('content_for', Octopress::Tags::ContentForBlock)
+Liquid::Template.register_tag('head', Octopress::Tags::HeadBlock)
+Liquid::Template.register_tag('footer', Octopress::Tags::FooterBlock)
+Liquid::Template.register_tag('scripts', Octopress::Tags::ScriptsBlock)
+Liquid::Template.register_tag('yield', Octopress::Tags::YieldTag)
+Liquid::Template.register_tag('wrap_yield', Octopress::Tags::WrapYieldBlock)
+
+Octopress.register_plugin(Octopress::SassPlugin, 'sass', 'local_plugin')
+

data/lib/octopress-ink/assets.rb

@@ -0,0 +1,10 @@
+module Octopress
+  module Assets
+    autoload :Asset,                'octopress-ink/assets/asset'
+    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 :Layout,               'octopress-ink/assets/layout'
+  end
+end

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

@@ -0,0 +1,71 @@
+module Octopress
+  module Assets
+    class Asset
+
+      def initialize(plugin, type, file)
+        @file = file
+        @type = type
+        @plugin = plugin
+        @plugin_type = plugin.type
+        @root = plugin.assets_path
+        @dir = File.join(plugin.namespace, type)
+        @exists = {}
+      end
+
+      def file
+        @file
+      end
+
+      def path(site)
+        file = user_path(site)
+
+        if !exists?(file) && @plugin_type != 'local_plugin'
+          file = plugin_path 
+        end
+
+        unless exists? file
+          raise IOError.new "Could not find #{File.basename(file)} at #{file}"
+        end
+        Pathname.new file
+      end
+
+      def file(file, site)
+        @file = file
+        path(site)
+      end
+
+      def destination
+        File.join(@dir, @file)
+      end
+
+      def copy(site)
+        site.static_files << StaticFile.new(path(site), destination)
+      end
+
+      def plugin_dir
+        File.join @root, @type
+      end
+
+      def plugin_path
+        File.join plugin_dir, @file
+      end
+
+      def user_dir(site)
+        File.join site.source, Plugins.custom_dir(site), @dir
+      end
+
+      def user_path(site)
+        if @plugin_type == 'local_plugin'
+          File.join site.source, @dir, @file
+        else
+          File.join user_dir(site), @file
+        end
+      end
+
+      def exists?(file)
+        @exists[file] ||= File.exists?(file)
+        @exists[file]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Octopress
+  module Assets
+    class Javascript < Asset
+      def tag
+        "<script src='/#{File.join(@dir, @file)}'></script>"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Octopress
+  module Assets
+    class Layout < Asset
+
+      def file(file, site)
+        @file = file
+      end
+
+      def register(site)
+        name = "#{@plugin.namespace}:#{@file}"
+        name = name.split(".")[0..-2].join(".")
+
+        file = user_path(site)
+        dir = user_dir(site)
+        if !exists?(file)
+          file = plugin_path 
+          dir = plugin_dir
+        end
+
+        site.layouts[name] = Jekyll::Layout.new(site, dir, @file)
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,64 @@
+module Octopress
+  module Assets
+    class Sass < Asset
+      def initialize(plugin, type, file, media)
+        @file = file
+        @type = type
+        @plugin_type = plugin.type
+        @root = plugin.assets_path
+        @dir = File.join(plugin.namespace, type)
+        @exists = {}
+        @media = media || 'all'
+      end
+
+      def media
+        @media
+      end
+
+      def tag
+        "<link href='/#{File.join(@dir, @file)}' media='#{@media}' rel='stylesheet' type='text/css'>"
+      end
+
+      def user_load_path(site)
+        File.join site.source, Plugins.custom_dir(site), @dir, File.dirname(@file)
+      end
+
+      def theme_load_path
+        File.expand_path(File.join(@root, @type))
+      end
+
+      # Remove sass files from Jekyll's static_files array so it doesn't end up in the
+      # compiled site directory. 
+      #
+      def remove_static_file(site)
+        site.static_files.clone.each do |sf|
+          if sf.kind_of?(Jekyll::StaticFile) && sf.path == path(site).to_s
+            site.static_files.delete(sf)
+          end
+        end
+      end
+
+      def compile(site)
+        unless @compiled
+          options = Plugins.sass_options(site)
+          if @plugin_type == 'local_plugin'
+            remove_static_file(site)
+            @compiled = Plugins.compile_sass_file(path(site).to_s, options)
+          else
+            # 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)
+          end
+        end
+
+        @compiled
+      end
+
+      def copy(site)
+        site.static_files << StaticFileContent.new(compile(site), destination)
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,26 @@
+module Octopress
+  class StaticFile
+    def initialize(source, dest)
+      @source = source
+      @dest = dest
+    end
+
+    def destination(dest)
+      File.join(dest, @dest)
+    end
+
+    def path
+      @source
+    end
+
+    def write(dest)
+      dest_path = destination(dest)
+
+      FileUtils.mkdir_p(File.dirname(dest_path))
+      FileUtils.cp(@source, dest_path)
+
+      true
+    end
+  end
+end
+

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

@@ -0,0 +1,13 @@
+module Octopress
+  class StaticFileContent < StaticFile
+    def write(dest)
+      dest_path = destination(dest)
+
+      FileUtils.mkdir_p(File.dirname(dest_path))
+      File.open(dest_path, 'w') { |f| f.write(@source) }
+
+      true
+    end
+  end
+end
+

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

@@ -0,0 +1,24 @@
+module Octopress
+  module Assets
+    class Stylesheet < Asset
+      def initialize(plugin, type, file, media)
+        @file = file
+        @type = type
+        @root = plugin.assets_path
+        @dir = File.join(plugin.namespace, type)
+        @plugin_type = plugin.type
+        @media = media || 'all'
+        @exists = {}
+      end
+
+      def media
+        @media
+      end
+
+      def tag
+        "<link href='/#{File.join(@dir, @file)}' media='#{@media}' rel='stylesheet' type='text/css'>"
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,20 @@
+module Octopress
+  module Assets
+    class Template < Asset
+
+      def initialize(plugin, type)
+        @plugin_type = plugin.type
+        @root = plugin.assets_path
+        @type = type
+        @dir = File.join(plugin.namespace, type)
+        @exists = {}
+      end
+
+      def file(file, site)
+        @file = file
+        path(site)
+      end
+    end
+  end
+end
+

data/lib/octopress-ink/generators/plugin_assets.rb

@@ -0,0 +1,9 @@
+module Octopress
+  class PluginAssets < Jekyll::Generator
+    def generate(site)
+      Plugins.register_layouts(site)
+      Plugins.add_static_files(site)
+    end
+  end
+end
+

data/lib/octopress-ink/helpers/content_for.rb

@@ -0,0 +1,29 @@
+module Octopress
+  module Helpers
+    module ContentFor
+      def self.get_block_name(tag_name, markup)
+        if markup.strip == ''
+          raise IOError.new "Syntax Error: #{tag_name} requires a name, eg. {% #{tag_name} sidebar %}"
+        else
+          markup.strip
+        end
+      end
+
+      # Gets the storage space for the content block
+      def self.get_block(context, block)
+        context.environments.first['content_for'] ||= {}
+        context.environments.first['content_for'][block] ||= []
+      end
+
+      def self.render(context, block)
+        content = get_block(context, block).map { |b| b.strip }.join
+      end
+
+      def self.append_to_block(context, block, content)
+        converter = context.environments.first['converter']
+        content = converter.convert(content.strip).strip
+        get_block(context, block) << content
+      end
+    end
+  end
+end