mill 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f1e09004e5ec42eaa48258220004b0821601096
+  data.tar.gz: 6e92566945ca1b4549feeb5496aafd3c964b067d
+SHA512:
+  metadata.gz: f6b982c3c4fc9e81b47b50a303a15ccfb0cf4c3409a25b6e47e1aff213b3c08ec973329b069dd10693186c45d5df1824e173839ca1a251c48c7d44a597a6884b
+  data.tar.gz: 992d9f6ba951a49e12122e0a75fb09f2cd8932878dc1f9975decc590514874ea83587a7b211ea8d64de1f520d4af3ee3dff488f55cd84e28983f2adfa28b16b7

data/.gitignore

@@ -0,0 +1,37 @@
+*.gem
+*.rbc
+.DS_Store
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/test/site
+/test/resources
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'simple-server', git: 'https://github.com/jslabovitz/simple-server.git'
+
+# Specify your gem's dependencies in mill.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 jslabovitz
+
+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,4 @@
+mill
+====
+
+A simple but useful static site generator, in Ruby.

data/Rakefile

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

data/TODO.txt

@@ -0,0 +1,38 @@
+- resolve confusion between content-generation in #load vs. #final_content
+    + who does what?
+    + replacement/modification of HTML elements (image sizing, etc.) only happens in #load
+    + maybe #final_content should have option to fully qualify URIs, etc., to handle feed content
+
+- split Resource#date into Resource#published & Resource#updated
+    + add <published> element to feed
+    + #published should be stated date (e.g., from header)
+    + #updated should be mtime of source file
+
+- refactor MIME type usage
+    + allow specified type as regexp or glob (use File.fnmatch?)
+    + convert to MIME::Type object(s)
+
+- make Navigator into more generic Collection
+    + include Enumerable
+
+- make Resource::External for external links?
+    + add on import of HTML (by examining href/src/etc attributes)
+
+- Rationalize resource URI usage:
+    + #shorten_uris should only apply to writing final files.
+    + In original content/etc., URIs should be more flexible.
+    + A #convert_uris method should convert all references to proper type.
+
+- Compress/minify Javascript, CSS, and HTML
+    + https://remino.net/rails-html-css-js-gzip-compression/
+    + http://sass-lang.com/documentation/file.SASS_REFERENCE.html#_16
+    + JS: https://github.com/lautis/uglifier
+    + HTML: https://github.com/paolochiodi/htmlcompressor
+    + CSS: https://github.com/matthiassiegel/cssminify
+
+- Write compressed versions along with non-compressed
+    + Modify SimpleServer to use compressed versions if asked by client
+
+- Add MailChimp signup form generator to HTMLHelpers.
+
+- Add Google Analytics bug generator to HTMLHelpers and Mill setup.

data/lib/mill.rb

@@ -0,0 +1,336 @@
+require 'addressable'
+require 'image_size'
+require 'kramdown'
+require 'mime/types'
+require 'nokogiri'
+require 'path'
+require 'pp'
+require 'RedCloth'
+require 'rubypants'
+require 'simple-server'
+require 'time'
+require 'tidy_ffi'
+require 'term/ansicolor'
+
+require 'mill/file_types'
+require 'mill/html_helpers'
+require 'mill/navigator'
+require 'mill/resource'
+require 'mill/resources/feed'
+require 'mill/resources/generic'
+require 'mill/resources/image'
+require 'mill/resources/redirect'
+require 'mill/resources/robots'
+require 'mill/resources/sitemap'
+require 'mill/resources/text'
+require 'mill/version'
+
+class Mill
+
+  attr_accessor :input_dir
+  attr_accessor :output_dir
+  attr_accessor :site_title
+  attr_accessor :site_uri
+  attr_accessor :site_email
+  attr_accessor :site_control_date
+  attr_accessor :feed_resource
+  attr_accessor :sitemap_resource
+  attr_accessor :robots_resource
+  attr_accessor :ssh_location
+  attr_accessor :beta_ssh_location
+  attr_accessor :resources
+  attr_accessor :shorten_uris
+  attr_accessor :navigator
+  attr_accessor :navigator_items
+  attr_accessor :resource_classes
+  attr_accessor :schema_types
+  attr_accessor :redirects
+  attr_accessor :input_file_type_order
+  attr_accessor :link_elem_attrs
+
+  DefaultResourceClasses = [
+    Resource::Text,
+    Resource::Image,
+    Resource::Generic,
+  ]
+
+  SchemasDir = Path.new(__FILE__).dirname / 'mill' / 'schemas'
+
+  DefaultSchemaTypes = {
+    feed: SchemasDir / 'atom.xsd',
+    sitemap: SchemasDir / 'sitemap.xsd',
+  }
+
+  def initialize(params={})
+    @resource_classes = {}
+    @resources = []
+    @resources_by_uri = {}
+    @schema_types = {}
+    @schemas = {}
+    @shorten_uris = true
+    @input_file_type_order = [:generic, :image, :text]
+    @link_elem_attrs = %w{
+      img/@src
+      script/@src
+      a/@href
+      link/@href
+      stylesheet/@href
+    }
+    params.each { |k, v| send("#{k}=", v) }
+  end
+
+  def input_dir=(path)
+    @input_dir = Path.new(path).expand_path
+  end
+
+  def output_dir=(path)
+    @output_dir = Path.new(path).expand_path
+  end
+
+  def site_uri=(uri)
+    @site_uri = Addressable::URI.parse(uri)
+  end
+
+  def site_control_date=(date)
+    begin
+      @site_control_date = Date.parse(date)
+    rescue ArgumentError => e
+      raise "bad control date #{date.inspect}: #{e}"
+    end
+  end
+
+  def file_type(file)
+    if file.directory? || file.basename.to_s[0] == '.'
+      return :ignore
+    else
+      MIME::Types.of(file.to_s).each do |mime_type|
+        if (type = @file_types[mime_type.content_type])
+          return type
+        end
+      end
+    end
+    nil
+  end
+
+  def add_resource(resource)
+    resource.mill = self
+    begin
+      # ;;warn "loading #{resource.class.type} resource #{resource.uri} as #{resource.class}"
+      resource.load
+    rescue => e
+      warn "Failed to load resource #{resource.uri} (#{resource.class}): #{e}"
+      raise
+    end
+    @resources << resource
+  end
+
+  def update_resource(resource)
+    @resources_by_uri[resource.uri] = resource
+  end
+
+  def find_resource(uri)
+    uri = Addressable::URI.parse(uri.to_s) unless uri.kind_of?(Addressable::URI)
+    resource = @resources_by_uri[uri]
+    if resource.nil? && @shorten_uris
+      uri.path = uri.path.sub(%r{\.html$}, '')
+      resource = @resources_by_uri[uri]
+    end
+    resource
+  end
+
+  def home_resource
+    find_resource('/') or raise "Can't find home"
+  end
+
+  def schema_for_type(type)
+    @schemas[type]
+  end
+
+  def tag_uri
+    "tag:#{@site_uri.host.downcase},#{@site_control_date}:"
+  end
+
+  def feed_generator
+    [
+      'Mill',
+      {
+        uri: Addressable::URI.parse('http://github.com/jslabovitz/mill'),
+        version: Mill::VERSION,
+      }
+    ]
+  end
+
+  def feed_author_name
+    @site_title
+  end
+
+  def feed_author_uri
+    @site_uri
+  end
+
+  def feed_author_email
+    @site_email
+  end
+
+  def public_resources
+    @resources.select(&:public)
+  end
+
+  def clean
+    @output_dir.rmtree if @output_dir.exist?
+    @output_dir.mkpath
+  end
+
+  def load
+    warn "loading resources..."
+    build_file_types
+    build_resource_classes
+    build_schemas
+    load_files
+    load_others
+  end
+
+  def load_others
+    make_redirects
+    make_feed
+    make_sitemap
+    make_robots
+    make_navigator
+  end
+
+  def build
+    warn "building #{@resources.length} resources..."
+    @resources.each do |resource|
+      begin
+        resource.build
+      rescue => e
+        warn "Failed to build resource #{resource.uri}: #{e}"
+        raise
+      end
+    end
+  end
+
+  def publish(mode=:final)
+    location = case mode
+               when :final
+                 @ssh_location
+               when :beta
+                 @beta_ssh_location
+               else
+                 raise "Unknown publish mode: #{mode.inspect}"
+               end
+    raise "Must specify SSH location" unless location
+    system('rsync',
+      # '--dry-run',
+      '--archive',
+      '--delete-after',
+      '--progress',
+      # '--verbose',
+      @output_dir.to_s + '/',
+      location,
+    )
+  end
+
+  def server
+    SimpleServer.run!(
+      root: @output_dir,
+      multihosting: false,
+    )
+  end
+
+  private
+
+  def load_files
+    input_files_by_type.each do |type, input_files|
+      input_files.each do |input_file|
+        resource_class = @resource_classes[type] or raise "No resource class for #{input_file}"
+        resource = resource_class.new(
+          input_file: input_file,
+          output_file: @output_dir / input_file.relative_to(@input_dir))
+        add_resource(resource)
+      end
+    end
+  end
+
+  def input_files_by_type
+    hash = {}
+    raise "Input path not found: #{@input_dir}" unless @input_dir.exist?
+    @input_dir.find do |input_file|
+      input_file = @input_dir / input_file
+      type = file_type(input_file) or raise "Can't determine file type of #{input_file}"
+      unless type == :ignore
+        hash[type] ||= []
+        hash[type] << input_file
+      end
+    end
+    hash.sort_by { |t, f| input_file_type_order.index(t) || input_file_type_order.length }
+  end
+
+  def make_feed
+    @feed_resource = Resource::Feed.new(
+      output_file: @output_dir / 'feed.xml')
+    add_resource(@feed_resource)
+  end
+
+  def make_sitemap
+    @sitemap_resource = Resource::Sitemap.new(
+      output_file: @output_dir / 'sitemap.xml')
+    add_resource(@sitemap_resource)
+  end
+
+  def make_robots
+    @robots_resource = Resource::Robots.new(
+      output_file: @output_dir / 'robots.txt')
+    add_resource(@robots_resource)
+  end
+
+  def make_navigator
+    if @navigator_items
+      @navigator = Navigator.new
+      @navigator.items = @navigator_items.map do |uri, title|
+        uri = Addressable::URI.parse(uri)
+        if title.nil? && uri.relative?
+          resource = find_resource(uri) or raise "Can't find navigation resource for URI #{uri}"
+          title = resource.title
+        end
+        Navigator::Item.new(uri: uri, title: title)
+      end
+    end
+  end
+
+  def make_redirects
+    return unless @redirects
+    @redirects.each do |from, to|
+      output_file = @output_dir / Path.new(from).relative_to('/')
+      resource = Resource::Redirect.new(
+        output_file: output_file,
+        redirect_uri: to)
+      add_resource(resource)
+    end
+  end
+
+  def build_schemas
+    DefaultSchemaTypes.merge(@schema_types).each do |type, file|
+      ;;warn "loading schema #{type} from #{file}"
+      @schemas[type] = Nokogiri::XML::Schema(file.open) { |c| c.strict.nonet }
+    end
+  end
+
+  def build_file_types
+    @file_types = {}
+    FileTypes.each do |type, mime_types|
+      mime_types.each do |mime_type|
+        MIME::Types[mime_type].each do |t|
+          @file_types[t.content_type] = type
+        end
+      end
+    end
+  end
+
+  def build_resource_classes
+    @resource_classes = Hash[
+      (DefaultResourceClasses + @resource_classes).map { |rc| [rc.type, rc] }
+    ]
+  end
+
+end