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

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

@@ -6,13 +6,16 @@ module Octopress
           c.option "layouts", "--layouts", "#{action} only layouts"
           c.option "includes", "--includes", "#{action} only includes"
           c.option "pages", "--pages", "#{action} only pages"
-          c.option "stylesheets", "--stylesheets", "#{action} only Stylesheets (CSS and Sass)"
-          c.option "css", "--css", "#{action} only CSS files"
-          c.option "sass", "--sass", "#{action} only Sass files"
-          c.option "javascripts", "--javascripts", "#{action} only Javascripts"
+          c.option "stylesheets", "--stylesheets", "#{action} only Stylesheets (.css, .scss, .sass)"
+          c.option "css", "--css", "#{action} only CSS files (.css)"
+          c.option "sass", "--sass", "#{action} only Sass files (.scss, .sass)"
+          c.option "javascripts", "--javascripts", "#{action} only Javascripts (.js and .coffee)"
+          c.option "js", "--js", "#{action} only Javascript files (.js)"
+          c.option "coffee", "--coffee", "#{action} only Coffeescript files (.coffee)"
           c.option "images", "--images", "#{action} only images"
           c.option "fonts", "--fonts", "#{action} only fonts"
           c.option "files", "--files", "#{action} only files"
+          c.option "defaults", "--defaults", "#{action} plugin's default configuration"
           c.option "config", "--config <CONFIG_FILE>[,CONFIG_FILE2,...]", Array, "Custom configuration file"
         end
       end

data/lib/octopress-ink/commands/init.rb

@@ -0,0 +1,48 @@
+module Octopress
+  module Ink
+    module Commands
+      class Init
+        def self.process_command(p)
+          p.command(:init) do |c|
+            c.syntax "init <PATH> [options]"
+            c.description "Add Octopress Ink scaffolding to an existing gem based plugin."
+            c.option "theme", "--theme", "Plugin will be a theme."
+
+            c.action do |args, options|
+              if args.empty?
+                raise "Please provide a plugin name, e.g. my_awesome_plugin."
+              else
+                @options = options
+                @options['path'] = args[0]
+                init_plugin
+              end
+            end
+          end
+        end
+
+        def self.init_plugin
+          settings = New.gem_settings(@options['path'])
+          settings[:type] = @options['theme'] ? 'theme' : 'plugin'
+
+          New.add_asset_dirs(settings)
+          New.add_demo_files(settings)
+
+          puts "\nTo finish setting up your Octopress Ink plugin:\n".bold
+          puts "1. Add gem requirements to your gemspec:\n\n"
+          puts New.dependencies(settings).sub("\n\n", "\n").yellow
+          puts "2. Add an Octopress Ink plugin to your gem, making changes as necessary:\n\n"
+
+          template = <<-HERE
+require "octopress-ink"
+
+Octopress::Ink.add_plugin({
+#{New.indent(New.plugin_config(settings))}
+})
+          HERE
+
+          puts template.yellow
+        end
+      end
+    end
+  end
+end

data/lib/octopress-ink/commands/list.rb

@@ -15,7 +15,7 @@ module Octopress
                 Octopress::Ink.list(options)
               else
                 name = args.first
-                Octopress::Ink.plugin_info(name, options)
+                Octopress::Ink.plugin_list(name, options)
               end
             end
           end

data/lib/octopress-ink/commands/new.rb

@@ -6,15 +6,15 @@ module Octopress
           p.command(:new) do |c|
             c.syntax "new <PLUGIN_NAME> [options]"
             c.description "Create a new Octopress Ink plugin with Ruby gem scaffolding."
-            c.option "path", "--path PATH", "Create a plugin at a specified path (defaults to current directory)."
             c.option "theme", "--theme", "Create a new theme."
+            c.option "path", "--path PATH", "Create a plugin at a specified path (defaults to current directory)."
 
             c.action do |args, options|
               if args.empty?
                 raise "Please provide a plugin name, e.g. my_awesome_plugin."
               else
-                options['name'] = args[0]
                 @options = options
+                @options['name'] = args[0]
                 new_plugin
               end
             end
@@ -24,28 +24,32 @@ module Octopress
         def self.new_plugin
           path = @options['path'] ||= Dir.pwd
           gem_name = @options['name']
-
-          @gem_dir = File.join(path, gem_name)
-          @gemspec_file = "#{gem_name}/#{gem_name}.gemspec"
+          path_to_gem = File.join(path, gem_name)
 
           if !Dir.exist?(path)
             raise "Directory not found: #{File.expand_path(path)}."
           end
 
-          if !Dir["#{@gem_dir}/*"].empty?
-            raise "Directory not empty: #{File.expand_path(@gem_dir)}."
+          if !Dir["#{path_to_gem}/*"].empty?
+            raise "Directory not empty: #{File.expand_path(path_to_gem)}."
           end
 
           FileUtils.cd path do
-            create_gem
+            create_gem(gem_name)
+
+            @settings = gem_settings(path_to_gem)
+            @settings[:type] = @options['theme'] ? 'theme' : 'plugin'
+
             add_dependency
             add_plugin
-            add_asset_dirs
+            add_assets
             add_demo_files
           end
         end
 
-        def self.create_gem
+        # Create a new gem with Bundle's gem command
+        #
+        def self.create_gem(name)
           begin
             require 'bundler/cli'
             bundler = Bundler::CLI.new
@@ -53,21 +57,27 @@ module Octopress
             raise "To use this feautre you'll need to install the bundler gem with `gem install bundler`."
           end
 
-          bundler.gem(@options['name'])
+          bundler.gem(name)
         end
 
         # Add Octopress Ink dependency to Gemspec
         #
         def self.add_dependency
-          minor_version = VERSION.scan(/\d\.\d/)[0]
-          @gemspec = File.open(@gemspec_file).read
-          dependency  = "  spec.add_runtime_dependency 'octopress-ink', '~> #{minor_version}', '>= #{VERSION}'\n"
-          dependency += "\n  spec.add_development_dependency 'octopress'\n"
+          pos = @settings[:gemspec].rindex("end")
+          @settings[:gemspec] = insert_before(@settings[:gemspec], pos, indent(dependencies))
 
-          pos = @gemspec.index("  spec.add_development_dependency")
-          @gemspec = insert_before(@gemspec, pos, dependency)
+          File.open(@settings[:gemspec_path], 'w+') {|f| f.write(@settings[:gemspec]) }
+        end
 
-          File.open(@gemspec_file, 'w+') {|f| f.write(@gemspec) }
+        # Returns lines which need to be added as a dependency
+        #
+        # spec_var - variable used to assign gemspec attributes,
+        # e.g. "spec" as in spec.name = "gem name"
+        #
+        def self.dependencies
+          minor_version = VERSION.scan(/\d\.\d/)[0]
+          d  = "#{@settings[:spec_var]}.add_development_dependency \"octopress\"\n\n"
+          d += "#{@settings[:spec_var]}.add_runtime_dependency \"octopress-ink\", \"~> #{minor_version}\", \">= #{VERSION}\"\n"
         end
 
         # Add Octopress Ink plugin to core module file
@@ -75,78 +85,145 @@ module Octopress
         def self.add_plugin
           # Grab the module directory from the version.rb require.
           # If a gem is created with dashes e.g. "some-gem", Bundler puts the module file at lib/some/gem.rb
-          module_subpath = @gemspec.scan(/['"](.+)\/version['"]/).flatten[0]
-          @module_file = File.join(@options['name'], 'lib', "#{module_subpath}.rb")
-          mod = File.open(@module_file).read
-          
-          # Find the inner most module name
-          @modules  = mod.scan(/module\s+(.+?)\n/).flatten
-          @mod_path = @modules.join('::')
-          
+          file = File.join(@settings[:path], @settings[:module_path])
+          mod = File.open(file).read
           mod = add_simple_plugin mod
 
-          File.open(@module_file, 'w+') {|f| f.write(mod) }
+          File.open(file, 'w+') {|f| f.write(mod) }
         end
 
-        def self.add_asset_dirs
-          %w{images fonts pages files layouts includes stylesheets javascripts}.each do |asset|
-            dir = File.join(@options['name'], 'assets', asset)
-            FileUtils.mkdir_p dir
+        def self.add_assets
+          dirs = %w{docs images fonts pages files layouts includes stylesheets javascripts}.map do |asset|
+            File.join(@settings[:path], 'assets', asset)
           end
+          create_empty_dirs dirs
+
+          # Add empty configuration file
+          FileUtils.touch File.join(@settings[:path], 'assets', 'config.yml')
         end
 
         # New plugin uses a simple configuration hash
         #
         def self.add_simple_plugin(mod)
-          mod  = mod.scan(/require.+\n/)[0]
-          mod += 'require "octopress-ink"'
-          mod += "\n\nOctopress::Ink.new_plugin({\n#{indent(plugin_config)}\n})"
+          mod  = "#{@settings[:require_version]}\n"
+          mod += "require 'octopress-ink'\n"
+          mod += "\nOctopress::Ink.add_plugin({\n#{indent(plugin_config)}\n})"
         end
 
+
+        # Return an Ink Plugin configuration hash desinged for this gem
+        #
         def self.plugin_config
-          plugin_name = format_name(@modules.last)
-          plugin_slug = Filters.sluggify(@options['name'])
-          depth = @module_file.count('/') - 1
+          depth = @settings[:module_path].count('/')
           assets_path = ("../" * depth) + 'assets'
-          type = @options['theme'] ? 'theme' : 'plugin'
 
           config = <<-HERE
-name:          "#{plugin_name}",
-slug:          "#{plugin_slug}",
+name:          "#{@settings[:module_name]}",
+slug:          "#{@settings[:name]}",
 assets_path:   File.expand_path(File.join(File.dirname(__FILE__), "#{assets_path}")),
-type:          "#{type}",
-version:       #{@mod_path}::VERSION,
+type:          "#{@settings[:type]}",
+version:       #{@settings[:version]},
 description:   "",
 website:       ""
           HERE
           config.rstrip
         end
 
+        # Creates a blank Jekyll site for testing out a new plugin
+        #
         def self.add_demo_files
-          dir = File.join(@options['name'], 'demo')
-          Jekyll::Commands::New.process([dir], {blank: true})
+          demo_dir = File.join(@settings[:path], 'demo')
 
-          gemfile = <<-HERE
+          dirs = %w{_layouts _posts}.map! do |d|
+            File.join(demo_dir, d)
+          end
+
+          create_empty_dirs dirs
+
+          index = File.join(demo_dir, 'index.html')
+          action = File.exist?(index) ? "exists".rjust(12).blue.bold : "create".rjust(12).green.bold
+          FileUtils.touch index
+          puts "#{action}  #{index}"
+
+          gemfile_path = File.join(demo_dir, 'Gemfile')
+          gemfile_content = <<-HERE
 source 'https://rubygems.org'
 
 group :octopress do
   gem 'octopress'
-  gem '#{@options['name']}', path: '../'
+  gem '#{@settings[:name]}', path: '../'
 end
           HERE
 
-          File.open(File.join(dir, 'Gemfile'), 'w+') {|f| f.write(gemfile) }
+          write(gemfile_path, gemfile_content)
+
+          config_path = File.join(demo_dir, '_config.yml')
+          config_content = "exclude:\n  - Gemfile*"
+
+          write(config_path, config_content)
         end
 
-        def self.indent(input, level=1)
-          input.gsub(/^/, '  ' * level)
+        def self.write(path, contents)
+          action = File.exist?(path) ? "written".rjust(12).blue.bold : "create".rjust(12).green.bold
+
+          File.open(path, 'w+') do |f| 
+            f.write(contents)
+          end
+          puts "#{action}  #{path}"
         end
+
+        def self.create_empty_dirs(dirs)
+          dirs.each do |d|
+            dir = File.join(d)
+            action = Dir.exist?(dir) ? "exists".rjust(12).blue.bold : "create".rjust(12).green.bold
+            FileUtils.mkdir_p dir
+            puts "#{action}  #{dir}/"
+          end
+        end
+
+        # Read gem settings from the gemspec
+        #
+        def self.gem_settings(gem_path)
+          gemspec_path = Dir.glob(File.join(gem_path, "/*.gemspec")).first
+
+          if gemspec_path.nil?
+            raise "No gemspec file found at #{gem_path}/. To create a new plugin use `octopress ink new <PLUGIN_NAME>`"
+          end
+
+          gemspec = File.open(gemspec_path).read
+          require_version = gemspec.scan(/require.+version.+$/)[0]
+          module_subpath = require_version.scan(/['"](.+)\/version/).flatten[0]
+          version = gemspec.scan(/version.+=\s+(.+)$/).flatten[0]
+          module_name = format_name(version.split('::')[-2])
+
+          {
+            path: gem_path,
+            gemspec: gemspec,
+            gemspec_path: gemspec_path,
+            spec_var: gemspec.scan(/(\w+)\.name/).flatten[0],
+            version: gemspec.scan(/version.+=\s+(.+)$/).flatten[0],
+            name: gemspec.scan(/name.+['"](.+)['"]/).flatten[0],
+            version: version,
+            require_version: require_version,
+            module_path: File.join('lib', module_subpath + '.rb'),
+            module_name: module_name
+          }
+        end
+
         # Add spaces between capital letters
         #
         def self.format_name(name)
           name.scan(/.*?[a-z](?=[A-Z]|$)/).join(' ')
         end
 
+        # Indent each line of a string
+        #
+        def self.indent(input, level=1)
+          input.gsub(/^/, '  ' * level)
+        end
+
+        # Insert a string before a position
+        #
         def self.insert_before(str, pos, input)
           if pos
             str[0..(pos - 1)] + input + str[pos..-1]

data/lib/octopress-ink/commands.rb

@@ -4,6 +4,7 @@ module Octopress
       require 'octopress-ink/commands/list'
       require 'octopress-ink/commands/copy'
       require 'octopress-ink/commands/new'
+      require 'octopress-ink/commands/init'
 
       class Ink < Octopress::Command
 
@@ -20,6 +21,7 @@ module Octopress
             List.process_command(c)
             Copy.process_command(c)
             New.process_command(c)
+            Init.process_command(c)
           end
         end
       end

data/lib/octopress-ink/configuration.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'yaml'
 
 module Octopress
@@ -5,17 +6,24 @@ module Octopress
     module Configuration
       DEFAULTS = {
         'docs_mode' => false,
-        'concat_css' => true,
-        'concat_js' => true,
-        'stylesheets_dir' => '_stylesheets',
-        'javascripts_dir' => '_javascripts',
-        'stylesheets' => [],
-        'javascripts' => [],
-        'disable' => []
+        'combine_css' => true,
+        'compress_css' => true,
+        'combine_js' => true,
+        'compress_js' => true,
+        'disable' => [],
+        'date_format' => 'ordinal',
+        'linkpost' => {
+          'marker' => "→",
+          'marker_position' => 'after'
+        },
+        'post' => {
+          'marker' => false,
+          'marker_position' => 'before'
+        }
       }
 
       def self.config
-        @config ||= DEFAULTS.deep_merge(octopress_config)
+        @config ||= Jekyll::Utils.deep_merge_hashes(DEFAULTS, octopress_config)
       end
 
       def self.octopress_config
@@ -23,8 +31,8 @@ module Octopress
           Octopress.config
         else
           file = '_octopress.yml'
-          if File.exist? file
-            YAML.safe_load(File.open(file).read || {})
+          if File.exist?(file)
+            SafeYAML.load_file(file) || {}
           else
             {}
           end

data/lib/octopress-ink/filters.rb

@@ -5,7 +5,7 @@ module Octopress
       # Returns the site's config root or '/' if the config isn't set
       #
       def root
-        root_url = Plugins.site.config['root']
+        root_url = Ink.site.config['root']
         root_url.nil? ? '/' : File.join('/', root_url)
       end
 
@@ -52,7 +52,7 @@ module Octopress
       # e.g. /images/awesome.gif => http://example.com/images/awesome.gif
       #
       def full_urls(input)
-        url = Plugins.site.config['url']
+        url = Ink.site.config['url']
         if url.nil?
           raise IOError.new "Could not expand urls: Please add your published url to your _config.yml, eg url: http://example.com/"
         else
@@ -68,7 +68,7 @@ module Octopress
       # e.g. /images/awesome.gif => http://example.com/images/awesome.gif
       #
       def full_url(input)
-        url = Plugins.site.config['url']
+        url = Ink.site.config['url']
         if url.nil?
           raise IOError.new "Could not expand url in #{input}: Please add your site's published url to your _config.yml, eg url: http://example.com/"
         else
@@ -106,7 +106,7 @@ module Octopress
 
       # Returns a title cased string based on John Gruber's title case http://daringfireball.net/2008/08/title_case_update
       def titlecase(input)
-        input.titlecase
+        Octopress::Utils.titlecase!(input)
       end
 
       # Formats a string for use as a css classname, removing illegal characters

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

@@ -2,9 +2,10 @@ module Octopress
   module Ink
     class PluginAssets < Jekyll::Generator
       def generate(site)
-        Plugins.register site
+        Ink.site = site
+        Plugins.register
         Plugins.add_files
-        site = Plugins.site
+        site = Ink.site
       end
     end
   end

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

@@ -27,7 +27,7 @@ module Octopress
           if file =~ /^\.+\//
             page = context['page']
             if local_dir = page['dir']
-              File.expand_path(File.join(local_dir, file))
+              File.expand_path(File.join(Ink.site.source, local_dir, file))
             else
               local_dir = File.dirname page['path']
               File.expand_path(File.join(root, local_dir, file))
@@ -44,7 +44,7 @@ module Octopress
         end
 
         def self.site_dir
-          File.expand_path(Plugins.site.config['destination'])
+          File.expand_path(Ink.site.config['destination'])
         end
 
         def self.page_destination(page)
@@ -56,14 +56,14 @@ module Octopress
         end
 
         def self.find_page_by_dest(dest)
-          Plugins.site.pages.clone.each do |p|
+          Ink.site.pages.clone.each do |p|
             return p if page_destination(p) == dest
           end
           return false
         end
 
         def self.remove_page(dest)
-          Plugins.site.pages.reject! do |p|
+          Ink.site.pages.reject! do |p|
             page_destination(p) == dest
           end
         end

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

@@ -4,17 +4,121 @@ module Jekyll
 
     def do_layout(payload, layouts)
       # The contentblock tags needs access to the converter to process it while rendering.
-      config = Octopress::Ink::Plugins.config
-      payload['plugins']   = config['plugins']
-      payload['theme']     = config['theme']
+      payload = Octopress::Ink.payload(payload)
       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
+
+      if page = payload['page']
+        if type == :post
+          payload['page'] = add_post_vars(page)
+        end
+
+        if page['date']
+          payload['page']['date_html'] = date_html(page['date'])
+        end
       end
+
       do_layout_orig(payload, layouts)
     end
+
+    def add_post_vars(page)
+      linkpost = page['external-url']
+
+      if linkpost
+        config = Octopress::Ink.config['linkpost']
+      else
+        config = Octopress::Ink.config['post']
+      end
+
+      if Octopress::Ink.config['titlecase']
+        Octopress::Utils.titlecase!(page['title'])
+      end
+
+      page.merge({
+        'title_text' => title_text(config, page['title']),
+        'title_html' => title_html(config, page['title']),
+        'title_url'  => linkpost || page['url'],
+        'linkpost'   => !linkpost.nil?
+      })
+    end
+
+    def date_html(date)
+      "<time class='entry-date' datetime='#{ datetime(date).xmlschema }' pubdate>#{ format_date(date) }</time>"
+    end
+
+    def format_date(date)
+      format = Octopress::Ink.config['date_format']
+      date = datetime(date)
+      if format == 'ordinal'
+        ordinalize(date)
+      else
+        date.strftime(format)
+      end
+    end
+
+    # Returns an ordidinal date eg July 22 2007 -> July 22nd 2007
+    def ordinalize(date)
+      date = datetime(date)
+      d = "<span class='date-month'>#{date.strftime('%b')}</span> "
+      d = "<span class='date-day'>#{date.strftime('%e')}</span> "
+      d += "<span class='date-suffix'>#{ordinal_suffix(date)}</span>, "
+      d += "<span class='date-year'>#{date.strftime('%Y')}</span>"
+    end
+
+    # Returns an ordinal number. 13 -> 13th, 21 -> 21st etc.
+    def ordinal_suffix(date)
+      number = date.strftime('%e').to_i
+      if (11..13).include?(number % 100)
+        "th"
+      else
+        case number % 10
+        when 1; "st"
+        when 2; "nd"
+        when 3; "rd"
+        else    "th"
+        end
+      end
+    end
+
+    def datetime(input)
+      case input
+      when Time
+        input
+      when String
+        Time.parse(input) rescue Time.at(input.to_i)
+      when Numeric
+        Time.at(input)
+      else
+        raise "Invalid Date:", "'#{input}' is not a valid datetime."
+        exit(1)
+      end
+    end
+    
+
+    def title_html(config, title)
+      return title if !config['marker']
+
+      marker = "<span class='post-marker post-marker-#{config['marker_position']}'>#{config['marker']}</span>"
+      position = config['marker_position']
+
+      title = Octopress::Ink::Filters.unorphan(title)
+
+      if config['marker_position'] == 'before'
+        "#{marker} #{title}"
+      else
+        "#{title} #{marker}"
+      end
+    end
+
+    def title_text(config, title)
+      return title if !config['marker']
+      position = config['marker_position']
+
+      if config['marker_position'] == 'before'
+        "#{config['marker']} #{title}"
+      else
+        "#{title} #{config['marker']}"
+      end
+    end
   end
 
   # Create a new page class to allow partials to trigger Jekyll Page Hooks.
@@ -36,4 +140,16 @@ module Jekyll
       do_layout(payload, { no_layout: nil })
     end
   end
+
+  class Site
+    alias_method :write_orig, :write
+    # Called after write
+     
+    def write
+      write_orig
+      Octopress::Ink::Plugins.static_files.each do |f| 
+        f.write(config['destination'])
+      end
+    end
+  end
 end

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

@@ -28,10 +28,12 @@ module Octopress
           @url
         else
           begin
-            config = @config['page_permalinks'][File.basename(self.name, '.*')]
+            config = @config['permalinks'][File.basename(self.name, '.*')]
             if config.is_a? String
               @url = config
               self.data['permalink'] = nil
+            else
+              @config['permalinks'][File.basename(self.name, '.*')] = self.data['permalink']
             end
           rescue; end