piccle 0.1.0.rc1

data/lib/piccle/streams/keyword_stream.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Browse photos by keyword.
+class Piccle::Streams::KeywordStream < Piccle::Streams::BaseStream
+  def namespace
+    "by-topic"
+  end
+
+  # Standard method called by the parser object. Returns a hash that contains the data to merge for the given photo.
+  def data_for(photo)
+    result = { namespace => {
+               :friendly_name => "By Topic",
+               :interesting => true
+             }}
+    photo.keywords.each do |kw|
+      result[namespace][slugify(kw.name)] = { friendly_name: kw.name, interesting: true, photos: [photo.md5] }
+    end
+    result
+  end
+
+  def metadata_for(photo)
+    photo.keywords.map { |kw| { friendly_name: kw.name, type: :keyword, selector: [namespace, slugify(kw.name)] } }
+  end
+end

data/lib/piccle/streams/location_stream.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+# Enables browsing photos by location.
+class Piccle::Streams::LocationStream < Piccle::Streams::BaseStream
+  def namespace
+    "by-location"
+  end
+
+  def data_for(photo)
+    data = {}
+    if photo.country
+      data = { namespace => {
+               :friendly_name => "By Location",
+               :interesting => false,
+               photo.country.downcase => {
+                 :friendly_name => photo.country,
+                 :interesting => true,
+                 :photos => [photo.md5]
+               },
+             }}
+      if photo.state
+        data[namespace][photo.country.downcase][photo.state.downcase] = {
+          :friendly_name => photo.state,
+          :interesting => false,
+          :photos => [photo.md5]
+        }
+
+        if photo.city
+          data[namespace][photo.country.downcase][photo.state.downcase][photo.city.downcase] = {
+            :friendly_name => photo.city,
+            :interesting => false,
+            :photos => [photo.md5]
+          }
+        end
+      end
+    end
+
+    data
+  end
+
+  def metadata_for(photo)
+    metadata = []
+
+    if photo.country
+      metadata << { friendly_name: photo.country, type: :location_country, selector: [namespace, photo.country.downcase] }
+
+      if photo.state
+        metadata << { friendly_name: photo.state, type: :location_state, selector: [namespace, photo.country.downcase, photo.state.downcase] }
+
+        if photo.city
+          metadata << { friendly_name: photo.city, type: :location_city, selector: [namespace, photo.country.downcase, photo.state.downcase, photo.city.downcase] }
+        end
+      end
+    end
+    metadata
+  end
+end

data/lib/piccle/template_helpers.rb

@@ -0,0 +1,79 @@
+require 'cgi'
+require 'handlebars'
+
+# Rendering functions for templates.
+# * For most files, we use Slim to render a Handlebars template (ie. HTML with embedded Handlebars). Handlebars then
+#   generates the final output. This lets us use the same templates for backend and frontend rendering.
+# * Partials don't have variable interpolation, because they're rendered inline into the main template. Their variables
+#   will be interpolated when the overall template is rendered.
+# * RSS feeds are generated via Slim only, as we don't need to generate those server-side.
+#
+# We don't cache Handlebars templates, because it actually results in WORSE performance than compiling a fresh instance
+# each time.
+
+class Piccle::TemplateHelpers
+  @@handlebars = nil
+  @@slim_pages = {}
+  @@slim_partials = {}
+
+  # Renders a partial template. Partial templates do NOT have their variables interpolated via Handlebars.
+  def self.render_partial(template_name, args = {})
+    @@slim_partials[template_name] ||= Tilt['slim'].new { File.read(Piccle.config.gem_root_join("templates/_#{template_name}.handlebars.slim")) }
+    @@slim_partials[template_name].render(Object.new, args)
+  end
+
+  # Renders an entire template out
+  def self.render(template_name, data = {})
+    options = { code_attr_delims: { '(' => ')', '[' => ']'}, attr_list_delims: { '(' => ')', '[' => ']' } }
+    @@slim_pages[template_name] ||= Tilt['slim'].new(options) { File.read(Piccle.config.gem_root_join("templates/#{template_name}.html.handlebars.slim")) }.render
+    template = handlebars.compile(@@slim_pages[template_name])
+    template.call(data)
+  end
+
+  def self.render_rss(template_name, data = {})
+    @@slim_pages["rss_#{template_name}"] ||= Tilt['slim'].new { File.read(Piccle.config.gem_root_join("templates/#{template_name}.atom.slim")) }
+    @@slim_pages["rss_#{template_name}"].render(Object.new, data)
+  end
+
+  # Gets a Handlebars version of the template. No variable replacement!
+  def self.compile_template(name)
+    slim_template = Tilt['slim'].new { File.read(Piccle.config.gem_root_join("templates/#{name}.html.handlebars.slim")) }
+    slim_template.render(Object.new, {})
+  end
+
+  # Given a "selector" (an array of string path components), returns an "include prefix" (a relative path that
+  # gets us back to the top level).
+  # eg. ["by-date", "2017", "03"] → "../../../"
+  def self.include_prefix(selector)
+    if selector.any?
+      "#{(['..'] * selector.length).join('/')}/"
+    else
+      ""
+    end
+  end
+
+  # Given a block of content, escape its HTML.
+  def self.escape_html(&block)
+    CGI::escape_html(yield)
+  end
+
+  protected
+
+  def self.handlebars
+    unless @@handlebars
+      @@handlebars = Handlebars::Context.new
+      @@handlebars.register_helper(:ifEqual) do |context, arg1, arg2, block|
+        if arg1 == arg2
+          block.fn(context)
+        else
+          block.inverse(context)
+        end
+      end
+
+      @@handlebars.register_helper(:join) do |context, arg1, arg2, block|
+        arg1.join(arg2)
+      end
+    end
+    @@handlebars
+  end
+end

data/lib/piccle/version.rb

@@ -0,0 +1,3 @@
+module Piccle
+  VERSION = "0.1.0.rc1"
+end

data/lib/tasks/development.rake

@@ -0,0 +1,38 @@
+require "sqlite3"
+
+namespace :db do
+  desc "Create a database for photo data"
+  task :initialise do
+    puts "This task is deprecated; run sequel -m db/migrations sqlite://photo_data.db instead."
+    # # If a DB already exists, do nothing.
+    # if File.exist?(Piccle::Database::PHOTO_DATABASE_FILENAME)
+    #   puts "Database #{Piccle::Database::PHOTO_DATABASE_FILENAME} already exists; exiting."
+    # else
+    #   puts "Creating an empty DB..."
+    #   db = SQLite3::Database.new(Piccle::Database::PHOTO_DATABASE_FILENAME)
+    #   puts "    ... and writing a schema to it..."
+    #   db.execute <<-SQL
+    #     CREATE TABLE photos(
+    #       id INTEGER PRIMARY KEY,
+    #       file_name text NOT NULL,
+    #       path text NOT NULL,
+    #       md5 varchar(128) NOT NULL,
+    #       width integer NOT NULL,
+    #       height integer NOT NULL,
+    #       camera_name text,
+    #       taken_at datetime,
+    #       created_at datetime
+    #     );
+    #     SQL
+    #   puts "    ... Done."
+    # end
+  end
+
+  desc "Drop the database"
+  task :drop do
+    File.delete("photo_data.db")
+  end
+
+  desc "Recreate the database"
+  task recreate: [:drop, :initialise]
+end

data/piccle.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'piccle/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "piccle"
+  spec.version = Piccle::VERSION
+  spec.authors = ["Alex Pounds"]
+  spec.email = ["piccle@alexpounds.com"]
+  spec.executables = ["piccle"]
+
+  spec.summary  = "A static site generator for photographers"
+  spec.description = "Piccle uses the EXIF data present in your photographs and uses it to build a website that lets
+  visitors browse by camera, tag, location, and more."
+  spec.homepage = "https://piccle.alexpounds.com/"
+
+  spec.files  = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = "bin"
+  spec.executables = ["piccle"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rspec", "~> 3.0" # Testing library
+  spec.add_development_dependency "simplecov" # Code coverage calculator
+  spec.add_development_dependency "simplecov-console" # Output stats on the console
+  spec.add_development_dependency "pry-byebug", "~> 3.5" # Debugging aid; only needed by developers.
+  spec.add_development_dependency "ruby-prof" # Performance profiling.
+
+  spec.add_dependency "exifr", "~> 1.3" # EXIF reading library
+  spec.add_dependency "handlebars" # Templating engine, usable both backend and frontend.
+  spec.add_dependency "httparty" # Simple HTTP library
+  spec.add_dependency "rake" # Ruby task runner
+  spec.add_dependency "recursive-open-struct", "~> 1.0" # Blesses database results into objects compatible with flavour-saver
+  spec.add_dependency "rmagick", "~> 2.0" # Image processing library
+  spec.add_dependency "sequel", "~> 5" # DB access in a structured way
+  spec.add_dependency "slim", "~> 3.0" # Templating language, so we don't have to write longhand HTML
+  spec.add_dependency "sqlite3", "~> 1.3" # Simple file-based database
+  spec.add_dependency "thor" # Nice Ruby CLI builder
+  spec.add_dependency "xmp", "~> 0.2" # Read XMP info from files
+end

data/templates/_breadcrumbs.handlebars.slim

@@ -0,0 +1,16 @@
+|
+  {{#if breadcrumbs}}
+    <ol>
+    {{#each breadcrumbs as |crumb|}}
+      {{#if @last}}
+        <li>{{crumb.friendly_name}}</li>
+      {{else}}
+        {{#if crumb.link}}
+          <li><a href="{{../include_prefix}}{{crumb.link}}">{{crumb.friendly_name}}</a></li>
+        {{else}}
+          <li>{{crumb.friendly_name}}</li>
+        {{/if}}
+      {{/if}}
+    {{/each}}
+    </ol>
+  {{/if}}

data/templates/_footer.handlebars.slim

@@ -0,0 +1,2 @@
+footer
+  | Generated by <a href="https://piccle.alexpounds.com/">Piccle</a>. Photography &copy; {{site_metadata.copyright_year}} {{site_metadata.author_name}}.

data/templates/_header.handlebars.slim

@@ -0,0 +1,36 @@
+head
+  meta charset="utf-8"
+  meta name="viewport" content="width=device-width, initial-scale=1"
+  title Photography by {{site_metadata.author_name}}
+  link rel="stylesheet" href="{{include_prefix}}css/normalize.css"
+  link rel="stylesheet" href="{{include_prefix}}css/default.css"
+  link rel="icon" href="{{include_prefix}}icons/favicon.ico"
+  link rel="icon" sizes="32x32" type="image/png" href="{{include_prefix}}icons/favicon-32x32.png"
+  link rel="icon" sizes="16x16" type="image/png" href="{{include_prefix}}icons/favicon-16x16.png"
+  link rel="icon" sizes="192x192" type="image/png" href="{{include_prefix}}icons/android-chrome-192x192.png"
+  link rel="icon" sizes="512x512" type="image/png" href="{{include_prefix}}icons/android-chrome-512x512.png"
+  link rel="apple-touch-icon" sizes="180x180" type="image/png" href="{{include_prefix}}icons/apple-touch-icon.png"
+  |
+    {{#if canonical}}
+    <link rel="canonical" href="{{include_prefix}}{{canonical}}" />
+    {{/if}}
+    {{#if prev_link}}
+    <link rel="prev" href="{{include_prefix}}{{prev_link}}" />
+    {{/if}}
+    {{#if next_link}}
+    <link rel="next" href="{{include_prefix}}{{next_link}}" />
+    {{/if}}
+    {{#if site_url}}
+    <link rel="alternate" type="application/atom+xml" href="{{include_prefix}}/feed.atom" title="All photos">
+    {{/if}}
+    {{#if open_graph}}
+    <meta property="og:type" content="website" />
+    <meta property="og:title" content="{{open_graph.title}}" />
+    <meta property="og:description" content="{{open_graph.description}}" />
+    <meta property="og:image" content="{{open_graph.image.url}}" />
+    <meta property="og:image:type" content="image/jpeg" />
+    {{#if open_graph.image.alt}}<meta property="og:image:alt" content="{{open_graph.image.alt}}" />{{/if}}
+    <meta property="og:image:width" content="{{open_graph.image.width}}" />
+    <meta property="og:image:height" content="{{open_graph.image.height}}" />
+    <meta property="og:url" content="{{open_graph.url}}" />
+    {{/if}}

data/templates/_navigation.handlebars.slim

@@ -0,0 +1,16 @@
+nav
+  |
+    <input type="checkbox" id="menu_toggle" name="menu_toggle" />
+    <label for="menu_toggle">Menu</label>
+    {{#each nav_items as |nav_item|}}
+      {{#if nav_item.entries}}
+        <section>
+        <h2>{{nav_item.friendly_name}}</h2>
+        <ul>
+          {{#each nav_item.entries as |entry|}}
+            <li><a href="{{../../include_prefix}}{{entry.link}}" title="{{entry.photo_count}} {{#ifEqual entry.photo_count 1}}photo{{else}}photos{{/ifEqual}}">{{entry.friendly_name}}</a></li>
+          {{/each}}
+        </ul>
+        </section>
+      {{/if}}
+    {{/each}}

data/templates/_substream.handlebars.slim

@@ -0,0 +1,17 @@
+|
+  {{#if stream.previous}}
+    <a class="navigation_arrow left" href="{{../include_prefix}}{{stream.selector_path}}{{stream.previous.hash}}.html#photo">&laquo;</a>
+  {{/if}}
+  <div class="stamps">
+  {{#each stream.photos as |substream_photo|}}
+    <a href="{{../../include_prefix}}{{stream.selector_path}}{{substream_photo.hash}}.html#photo">
+      <img
+        class="stamp{{#ifEqual substream_photo.hash ../../photo.hash}} current{{/ifEqual}}"
+        src="{{../../include_prefix}}images/thumbnails/{{substream_photo.hash}}.{{substream_photo.file_name}}"
+        alt="{{substream_photo.title}}" />
+    </a>
+  {{/each}}
+  </div>
+  {{#if stream.next}}
+    <a class="navigation_arrow right" href="{{../include_prefix}}{{stream.selector_path}}{{stream.next.hash}}.html#photo">&raquo;</a>
+  {{/if}}

data/templates/feed.atom.slim

@@ -0,0 +1,29 @@
+doctype xml
+feed xmlns="http://www.w3.org/2005/Atom"
+  title Photography by #{site_metadata[:author_name]}
+  author
+    name #{site_metadata[:author_name]}
+  link rel="self" href=URI::join(Piccle.config.home_url, joined_selector, "feed.atom")
+  link rel="alternate" href=URI::join(Piccle.config.home_url, joined_selector, "index.html")
+  icon = URI::join(Piccle.config.home_url, "icons", "android-chrome-192x192.png")
+  updated = feed_update_time.strftime("%FT%T%:z")
+  id = URI::join(Piccle.config.home_url, joined_selector, "feed.atom")
+
+  - photos.map do |hash, photo|
+    entry
+      title = photo[:title] || "A photo by #{site_metadata[:author_name]}"
+      link rel="alternate" href=URI::join(Piccle.config.home_url, joined_selector, "#{photo[:hash]}.html")
+      id = URI::join(Piccle.config.home_url, joined_selector, "#{photo[:hash]}.html")
+      updated = photo[:created_at].strftime("%FT%T%:z")
+      content type="html"
+        == Piccle::TemplateHelpers.escape_html
+          - if photo[:title]
+            h1 = photo[:title]
+          img src=URI::join(Piccle.config.home_url, "/images/photos/", "#{photo[:hash]}.#{URI::DEFAULT_PARSER.escape(photo[:file_name])}")
+          - if photo[:description]
+            p = photo[:description]
+          - if photo[:has_location]
+            p #{[photo[:city], photo[:state], photo[:country]].compact.join(", ")}.
+          - if photo[:taken_at]
+            p Taken #{photo[:taken_at].strftime("%-d %B, %Y.")}
+

data/templates/index.html.handlebars.slim

@@ -0,0 +1,36 @@
+doctype html
+html
+  == Piccle::TemplateHelpers.render_partial "header"
+
+  body.photos_index
+    header
+      |
+        {{#if selector}}
+          <h1><a href="{{include_prefix}}index.html">Photography by {{site_metadata.author_name}}</a></h1>
+        {{else}}
+          <h1>Photography by {{site_metadata.author_name}}</a></h1>
+        {{/if}}
+      == Piccle::TemplateHelpers.render_partial "breadcrumbs"
+    main
+      == Piccle::TemplateHelpers.render_partial "navigation"
+
+      .photos
+        |
+          {{#each photos as |photo|}}
+            {{#if (lookup ../event_ends photo.hash)}}
+              {{#with (lookup ../event_ends hash)}}
+                <p class="event_block event_end"><a href="{{../include_prefix}}{{join selector '/'}}/index.html">{{name}}</a></p>
+              {{/with}}
+            {{/if}}
+            <a href="{{../include_prefix}}{{../selector_path}}{{photo.hash}}.html#photo">
+              <img class="thumbnail" src="{{../include_prefix}}images/thumbnails/{{photo.hash}}.{{photo.file_name}}" alt="{{photo.title}}" />
+            </a>
+            {{#if (lookup ../event_starts photo.hash)}}
+              {{#with (lookup ../event_starts hash)}}
+                <p class="event_block event_start"><a href="{{../include_prefix}}{{join selector '/'}}/index.html">{{name}}</a></p>
+              {{/with}}
+            {{/if}}
+          {{/each}}
+
+    == Piccle::TemplateHelpers.render_partial "footer"
+

data/templates/show.html.handlebars.slim

@@ -0,0 +1,64 @@
+== Piccle::TemplateHelpers.render_partial "header"
+
+body.photo_show
+  header
+    h1
+      a href="{{include_prefix}}index.html" Photography by {{site_metadata.author_name}}
+    == Piccle::TemplateHelpers.render_partial "breadcrumbs"
+  main#photo
+    h2
+      | {{photo.title}}
+    .photo_with_pagination
+      | {{#if prev_link}}
+        <a class="navigation_arrow" href="{{include_prefix}}{{prev_link}}#photo">&laquo;</a>
+        {{else}}
+        <span class="navigation_arrow">&nbsp;</span>
+        {{/if}}
+      img src="{{include_prefix}}images/photos/{{photo.hash}}.{{photo.file_name}}"
+      | {{#if next_link}}
+        <a class="navigation_arrow" href="{{include_prefix}}{{next_link}}#photo">&raquo;</a>
+        {{else}}
+        <span class="navigation_arrow">&nbsp;</span>
+        {{/if}}
+
+    p.description
+      | {{photo.description}}
+    p.settings
+      | {{#if camera_link}}
+        <a href="{{include_prefix}}{{camera_link.link}}">{{camera_link.friendly_name}}</a>{{/if}}{{#if photo.focal_length}}, {{photo.focal_length}}{{/if}}{{#if photo.aperture}}, f/{{photo.aperture}}{{/if}}{{#if photo.shutter_speed}}, {{photo.shutter_speed}}{{/if}}{{#if photo.iso}}, ISO {{photo.iso}}{{/if}}.
+    | {{#if photo.taken_at}}
+        <p class="date">
+          {{#if day_link}}<a href="{{include_prefix}}{{day_link.link}}">{{day_link.friendly_name}}</a>{{/if}}
+          {{#if month_link}}<a href="{{include_prefix}}{{month_link.link}}">{{month_link.friendly_name}}</a>, {{/if}}
+          {{#if year_link}}<a href="{{include_prefix}}{{year_link.link}}">{{year_link.friendly_name}}</a>.{{/if}}
+        </p>
+      {{/if}}
+      {{#if photo.has_location}}
+        <ul class="location">
+          {{#if city_link}}<li><a href="{{include_prefix}}{{city_link.link}}">{{city_link.friendly_name}}</a></li>{{/if}}
+          {{#if state_link}}<li><a href="{{include_prefix}}{{state_link.link}}">{{state_link.friendly_name}}</a></li>{{/if}}
+          {{#if country_link}}<li><a href="{{include_prefix}}{{country_link.link}}">{{country_link.friendly_name}}</a></li>{{/if}}
+        </ul>
+      {{/if}}
+
+    | {{#if keywords}}
+        <div class="keywords">
+          {{#each keywords as |keyword|}}
+            <a href="{{../include_prefix}}{{keyword.link}}">{{keyword.friendly_name}}</a>
+          {{/each}}
+        </div>
+      {{/if}}
+
+    .streams
+      |
+        {{#each substreams as |stream|}}
+        <section>
+          <h2>{{stream.title}}</h2>
+          <div class="stream">
+      == Piccle::TemplateHelpers.render_partial "substream"
+      |
+          </div>
+        </section>
+        {{/each}}
+
+== Piccle::TemplateHelpers.render_partial "footer"