hawkins 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3860e1fbd32bdc4502dcebb3bc21595486177226
+  data.tar.gz: 728296eae31ec40dc27a892cd7c4a7ad906bd41b
+SHA512:
+  metadata.gz: a1a4138fe80b645d1676295480f997150f72906c5863350145827ee93cd871952f451b5050cd45722f75fa7aaf17e57d6ec15a342864f7c5df966277e36d132d
+  data.tar.gz: 17b7dc16253c30272ba6162983479a974c24949e16f481b9bd6a01b132e16c1d08b640340d27812452f2f1c3ec05666df104bc31b97e0f18adf113a0922dc8fa

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,30 @@
+test/resources/test_site/_site
+
+# rcov generated
+coverage
+coverage.data
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# ruby environment manager
+.rvmrc
+.ruby-version
+.ruby-gemset
+
+# bundler
+Gemfile.lock
+
+# For vim:
+*.swp
+tags

data/.rubocop.yml

@@ -0,0 +1,54 @@
+ClassLength:
+  # It's not worth bending over backwards to avoid long classes.
+  Enabled: false
+CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    reduce: 'inject'
+    detect: 'find'
+    find_all: 'select'
+CyclomaticComplexity:
+  Enabled: false
+Documentation:
+  # TODO: We need to add a bunch of docs before we can enable this.
+  Enabled: false
+HashSyntax:
+  EnforcedStyle: hash_rockets
+IfUnlessModifier:
+  Enabled: false
+LineLength:
+  Enabled: true
+  Max: 100
+MethodLength:
+  Max: 50
+  CountComments: false
+ModuleFunction:
+  # The module_function declaration makes methods private so it means you can't use the module as a module.
+  Enabled: false
+ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+PerlBackrefs:
+  Enabled: false
+RaiseArgs:
+  EnforcedStyle: compact
+RedundantReturn:
+  AllowMultipleReturnValues: true
+RegexpLiteral:
+  Enabled: false
+SignalException:
+  EnforcedStyle: only_raise
+SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+StringLiterals:
+  # They say to not use double quoted strings unless there is interpolation.
+  # While this gives a marginal parse time speedup, it makes working with
+  # strings annoying.
+  Enabled: false
+TrailingComma:
+  Enabled: true
+UnneededPercentX:
+  Enabled: false
+WhileUntilModifier:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Alex Wood
+
+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,19 @@
+= hawkins
+
+Description goes here.
+
+== Contributing to hawkins
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Alex Wood. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require './lib/hawkins/version'
+
+require 'rake'
+require 'rdoc/task'
+require 'rubocop/rake_task'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec, :tag) do |t, task_args|
+    t.rspec_opts = "--tag #{task_args[:tag]}" if task_args.key?(:tag)
+    t.pattern = "test/**/*.rb"
+  end
+  task :default => :spec
+  task :test => :spec
+rescue LoadError
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hawkins #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+RuboCop::RakeTask.new

data/bin/hawkins

@@ -0,0 +1,5 @@
+#! /usr/bin/env ruby
+
+require 'hawkins'
+
+Hawkins::Cli.start(ARGV)

data/hawkins.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hawkins/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "hawkins"
+  spec.version = Hawkins::VERSION
+  spec.authors = ["Alex Wood"]
+  spec.email = ["awood@redhat.com"]
+  spec.summary = "A Jekyll extension that adds in Live Reload and page isolation"
+  spec.homepage = "http://github.com/awood/hawkins"
+  spec.license = "MIT"
+
+  spec.files = %x(git ls-files -z).split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency("guard", "~> 2.8")
+  spec.add_runtime_dependency("guard-livereload")
+  spec.add_runtime_dependency("jekyll", "~> 2.5")
+  spec.add_runtime_dependency("rack")
+  spec.add_runtime_dependency("rack-livereload")
+  spec.add_runtime_dependency("safe_yaml")
+  spec.add_runtime_dependency("stringex")
+  spec.add_runtime_dependency("thin")
+  spec.add_runtime_dependency("thor")
+
+  spec.add_development_dependency("bundler", "~> 1.6")
+  spec.add_development_dependency("rspec-core")
+  spec.add_development_dependency("rspec-expectations")
+  spec.add_development_dependency("rspec-mocks")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("rdoc", "~> 3.12")
+  # Rubocop can issue new releases with new checks which can result
+  # in errors we don't want.  We'll manage the version very strictly.
+  spec.add_development_dependency("rubocop", "= 0.24.1")
+  spec.add_development_dependency("simplecov")
+end

data/lib/hawkins.rb

@@ -0,0 +1,45 @@
+require 'date'
+require 'guard'
+require 'jekyll'
+require 'rack'
+require 'safe_yaml/load'
+require 'stringex_lite'
+require 'thor'
+
+require 'hawkins/cli'
+require 'hawkins/guard'
+require 'hawkins/version'
+
+module Hawkins
+  DEFAULT_EXTENSIONS = %w(
+    md
+    mkd
+    mkdn
+    markdown
+    textile
+    html
+    haml
+    slim
+    xml
+    yml
+  )
+
+  # When using pagination, Jekyll wants an index.html
+  DEFAULT_INCLUDES = %w(
+    *.less
+    *.js
+    *.css
+    *.png
+    *.jpg
+    *.gif
+    *.jpeg
+    *.eot
+    *.svg
+    *.ttf
+    *.woff
+    404.html
+    index.*
+  )
+
+  ISOLATION_FILE = ".isolation_config.yml"
+end

data/lib/hawkins/cli.rb

@@ -0,0 +1,190 @@
+require 'jekyll'
+require 'guard'
+require 'guard/runner'
+require 'listen'
+
+module Hawkins
+  class Cli < Thor
+    include Thor::Actions
+
+    attr_accessor :jekyll_config
+
+    def self.exit_on_failure?
+      true
+    end
+
+    def initialize(*args)
+      super
+      Jekyll.logger.log_level = :warn
+      @jekyll_config = Jekyll::Configuration[Jekyll::Configuration::DEFAULTS]
+      @jekyll_config.read_config_files(@jekyll_config.config_files({}))
+    end
+
+    desc "post TITLE", "create a post"
+    option :editor, :default => ENV['VISUAL'] || ENV['EDITOR'] || 'vi'
+    option :date, :default => Time.now.to_s
+    def post(title)
+      begin
+        date = Date.parse(options[:date])
+      rescue
+        # If an exception is not descended from the Thor::Error class, Thor
+        # prints the stacktrace.  We don't want a stacktrace in this instance,
+        # so we lie and use one of Thor's error classes in the call to fail().
+        fail(Thor::InvocationError, "ERROR: Could not parse '#{options[:date]}' as a date")
+      end
+      slug = title.to_url
+      dest = path_to(:_posts)
+
+      shell.mute { empty_directory(dest) }
+
+      filename = "#{date.strftime('%Y-%m-%d')}-#{slug}.md"
+      content = <<-CONTENT.gsub(/^\s*/, '')
+        ---
+        title: #{title}
+        ---
+      CONTENT
+
+      create_file(path_to(dest, filename), content)
+
+      case options[:editor]
+      when /g?vim/
+        editor_args = "+"
+      when /x?emacs/
+        editor_args = "+#{content.lines.count}"
+      else
+        editor_args = nil
+      end
+
+      exec(*[options[:editor], editor_args, path_to(dest, filename)].compact)
+    end
+
+    desc "isolate FILE ...", "work on a file or files in isolation (globs are allowed)"
+    long_desc <<-LONGDESC
+      Jekyll's regeneration capability is limited to regenerating the
+      entire site.  This option will ignore all files except the ones you
+      specify in order to speed regeneration.
+
+      Keep in mind that Jekyll's inclusion mechanism is not aware of
+      subdirectories so this command operates on the basename of all files
+      that match the file or glob you provide.
+    LONGDESC
+    option :future, :type => :boolean, :default => false, :desc => "publish future dated posts"
+    option :drafts, :type => :boolean, :default => false, :desc => "publish draft posts"
+    def isolate(*files)
+      SafeYAML::OPTIONS[:default_mode] = :safe
+
+      pages = []
+      pages << Hawkins::DEFAULT_EXTENSIONS.map do |ext|
+        Dir.glob("**/*.#{ext}")
+      end
+      pages.flatten!.reject! { |f| File.fnmatch?('_site/*', f) }
+
+      pages.select! do |p|
+        content = File.read(p)
+        # Jekyll only renders pages with YAML frontmatter.  See Jekyll's
+        # convertible.rb read_yaml method.
+        content =~ /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
+      end
+
+      isolation_config = {}
+      isolation_config['exclude'] = pages.concat(jekyll_config['exclude'])
+      isolation_config['include'] = Hawkins::DEFAULT_INCLUDES
+
+      files.each do |glob|
+        matches = Dir.glob(glob)
+        matches.map! do |f|
+          ext = File.extname(f)
+          # If we have to add to this list from Rack, then Rack will have no
+          # idea what the original file extension was.  Use a wildcard to
+          # avoid this issue.
+          "#{File.basename(f, ext)}.*"
+        end
+        if matches.empty?
+          raise Thor::Error.new("Could not find any matches for #{glob}.")
+        end
+        isolation_config['include'] += matches
+      end
+
+      isolation_config['include'].uniq!
+
+      # We have to write the isolation config out to a file so that the Guard
+      # can detect when the configuration changes.
+      create_file(Hawkins::ISOLATION_FILE, YAML.dump(isolation_config))
+
+      begin
+        invoke(:serve, [], options)
+      ensure
+        remove_file(Hawkins::ISOLATION_FILE)
+      end
+    end
+
+    desc "serve", "render and serve the site"
+    option :future, :type => :boolean, :default => false, :desc => "publish future dated posts"
+    option :drafts, :type => :boolean, :default => false, :desc => "publish draft posts"
+    def serve
+      config_files = jekyll_config.config_files({}) || []
+      if File.exist?(Hawkins::ISOLATION_FILE)
+        config_files << Hawkins::ISOLATION_FILE
+      end
+
+      # By default Jekyll uses the absolute path and Guard doesn't so we need to fix that.
+      dest = Pathname.new(jekyll_config['destination']).relative_path_from(Pathname.new(Dir.pwd))
+
+      contents = <<-GUARDFILE.gsub(/^\s*/, '')
+        interactor :off
+        notification :off
+        guard 'hawkins',
+          :config => #{config_files},
+          :drafts => #{options[:drafts]},
+          :future => #{options[:future]} do
+          watch %r{.*}
+          ignore %r{^#{dest}}
+        end
+
+        guard 'livereload',
+          :grace_period => 5 do
+          watch %r{.*}
+        end
+      GUARDFILE
+      guard_start(contents)
+    end
+
+    # Methods in the no_tasks block are not exposed to users
+    no_tasks do
+      def guard_start(guardfile_contents)
+        Guard.setup(:guardfile_contents => guardfile_contents)
+        Guard::Runner.new.run(:start)
+        Guard.listener.start
+
+        exitcode = 0
+        begin
+          while Guard.interactor.foreground != :exit
+            Guard.queue.process while Guard.queue.pending?
+          end
+        rescue Interrupt
+        rescue SystemExit => e
+          exitcode = e.status
+        end
+
+        guard_stop
+        exitcode
+      end
+
+      def guard_stop
+        Guard.listener.stop
+        Guard.interactor.background
+        Guard::Runner.new.run(:stop)
+      end
+
+      def self.source_root
+        File.expand_path("..", File.dirname(__FILE__))
+      end
+
+      # Builds a path within the source_root
+      def path_to(*args)
+        args = args.map(&:to_s)
+        File.join(*args)
+      end
+    end
+  end
+end