middleman-portfolio 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78258eb595b3e291a9a00adcdc5fe2a0d66f2983
+  data.tar.gz: fd7a671381e7f53b89e7b41f3951a1db40334af1
+SHA512:
+  metadata.gz: 3149c6d803dcf84a72ececbd0fc43f8140b938253e15a76c8698ae95cdfe07f32cb7c741af5b64d0408004db7780a794cfea82f422d244ff623f926b13a12b48
+  data.tar.gz: 815438f24e1d84ff4411ba17c265c4ccdbce5b21607c3e4b5c73602413485d2b1f062f833c0f2f1c9dec8ba892a6ef3b6727e27699c972ed4d92e05cbd7c10b4

data/Gemfile

@@ -0,0 +1,19 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+gem 'mini_magick', '~> 4.2.10'
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+  gem 'jeweler'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'fivemat'
+  gem 'aruba'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,95 @@
+# middleman-portfolio
+
+A low-drama portfolio generator for your [middleman](https://github.com/middleman/middleman) site. Place images in `source/portfolio/[project]/`, and build. That's it.
+
+![Screenshot](https://raw.githubusercontent.com/dhulihan/middleman-portfolio/master/screenshot.jpg)
+
+## Setup
+
+Add this to `Gemfile`
+
+```rb
+gem "middleman-portfolio"
+```
+
+and
+
+```sh
+bundle install
+```
+
+Add to `config.rb`
+
+```rb
+activate :portfolio
+```
+
+Add projects to portfolio dir
+
+```sh
+cp -r project-a/ source/portfolio/ 
+cp -r project-b/ source/portfolio/ 
+```
+
+Run `middleman server`
+
+* [`http://localhost:4567/portfolio`](http://localhost:4567/portfolio) (if you're using `directory_indexes`)
+
+* [`http://localhost:4567/portfolio/index.html`](http://localhost:4567/portfolio/index.html) (vanilla middleman)
+
+or `middleman build` if you're ready to roll.
+
+
+## Configuration (optional)
+
+```rb
+activate :portfolio do |f|
+  # Looks in source/portfolio/ for projects and builds to build/portfolio/
+  f.portfolio_dir = 'portfolio'
+
+  # thumbnail width (px)
+  f.thumbnail_width  = 200 
+
+  # thumbnail height (px)
+  f.thumbnail_height = 150
+  
+  # class added to thumbnail <img> tag
+  f.thumbnail_class, "thumbnail"
+
+  # class added to thumbnail <a> tag
+  f.thumbnail_link_class ""
+
+  # override default portfolio template (must be located in source/)
+  f.portfolio_template "portfolio.html.erb"
+
+  # override default project template (also must be in source/)
+  f.project_template "project.html.erb"
+end
+```
+
+### Custom Templates
+
+You can create your own custom portfolio and project template pages by using the `portfolio_template` or `project_tamplate` options (see above).
+
+Place your template anywhere in your `source/` dir. Take a look at the default [portfolio](https://github.com/dhulihan/middleman-portfolio/blob/master/lib/template/source/portfolio.html.erb) or [project](https://github.com/dhulihan/middleman-portfolio/blob/master/lib/template/source/project.html.erb) template for a good starting point. Here's an example portfolio page:
+
+```erb
+<!-- source/portfolio.html.erb -->
+<% for project in project_resources %>
+	<% link_to project.path, class: "thumbnail" do %>
+		<%= image_tag project.metadata[:locals][:thumbnail_resources].first.path %>	
+	<% end %>
+<% end %>
+```
+
+## Additional Notes
+
+* You can mix and match image types (`.jpg`, `.png`, `.gif`)
+* [minimagick](https://github.com/minimagick/minimagick) is used for thumbnail generation. Make sure imagemagick is installed on your machine.
+
+
+## TODO
+
+* Page content from `data/`
+* Non-project images (stored directly in portfolio/)
+* FileWatcher monitor for new images

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task default: :test
+# encoding: utf-8
+
+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 'rake'
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "middleman-portfolio"
+  gem.homepage = "http://github.com/dhulihan/middleman-portfolio"
+  gem.license = "MIT"
+  gem.summary = %Q{A low-drama portfolio generator for your middleman site.}
+  gem.description = %Q{A low-drama portfolio generator for your middleman site.}
+  gem.email = "dhulihan@gmail.com"
+  gem.authors = ["Dave Hulihan"]
+  # dependencies defined in Gemfile
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "middleman-portfolio #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-portfolio')

data/lib/middleman-portfolio.rb

@@ -0,0 +1,252 @@
+class Portfolio < ::Middleman::Extension
+  TEMPLATES_DIR = File.expand_path('../template/source/', __FILE__)
+
+  option :portfolio_dir, 'portfolio', 'Default portfolio directory inside your source'
+  option :generate_thumbnails, true, 'Do you want thumbnails?'
+  option :thumbnail_width, 200, "Width (in px) for thumbnails"
+  option :thumbnail_height, 150,  "Height (in px) for thumbnails"
+  option :thumbnail_class, "thumbnail", "class for thumbnail <img>"
+  option :thumbnail_link_class, "", "class for thumbnail <a> "
+  option :portfolio_template, nil, "path to portfolio index page template"
+  option :project_template, nil, "path to portfolio project page template"
+
+  attr_accessor :sitemap
+  #alias :included :registered
+
+  class << self
+    def cleanup
+      # Delete tmp files
+      tmp_files = Dir.glob(File.join(tmp_dir, "*")).select {|f| File.file?(f)}
+      tmp_files.each {|f| 
+        File.delete(f)
+        debug "#{f} not deleted" if File.exist?(f)
+      }
+      Dir.rmdir(tmp_dir)
+    end
+
+    # path to temp dir for storing intermediate files
+    def tmp_dir
+      File.join(Dir.tmpdir, "middleman-portfolio")
+    end
+  end 
+
+  def initialize(app, options_hash={}, &block)
+    # Call super to build options from the options_hash
+    super
+
+    # Create tmp dir
+    Dir.mkdir(Portfolio.tmp_dir) unless Dir.exist?(Portfolio.tmp_dir)
+
+    # set up your extension
+    app.after_build do
+      Portfolio.cleanup
+    end 
+  end
+
+  def after_configuration
+    register_extension_templates
+  end
+
+  # generate thumbnail OUTSIDE of build dir
+  def generate_thumbnail(image)
+    debug "Generating thumbnail of #{image}"
+    dst = File.join(Portfolio.tmp_dir, thumbnail_name(image))
+    if !File.exist?(dst)
+      img = ::MiniMagick::Image.open(image)
+      #img.resize "#{options.thumbnail_width}x#{options.thumbnail_height}"
+      img = resize_to_fill(img, options.thumbnail_width, options.thumbnail_height)
+      img.write(dst)
+      raise "Thumbnail not generated at #{dst}" unless File.exist?(dst)
+    else
+      debug "#{dst} already exists"
+    end 
+    return dst
+  end
+
+  # Resize to fill target dims. Crop any excess. Will upscale.
+  def resize_to_fill(img, width, height, gravity = 'Center')
+    cols, rows = img[:dimensions]
+    img.combine_options do |cmd|
+      if width != cols || height != rows
+        scale_x = width/cols.to_f
+        scale_y = height/rows.to_f
+        if scale_x >= scale_y
+          cols = (scale_x * (cols + 0.5)).round
+          rows = (scale_x * (rows + 0.5)).round
+          cmd.resize "#{cols}"
+        else
+          cols = (scale_y * (cols + 0.5)).round
+          rows = (scale_y * (rows + 0.5)).round
+          cmd.resize "x#{rows}"
+        end
+      end
+      cmd.gravity gravity
+      cmd.background "rgba(255,255,255,0.0)"
+      cmd.extent "#{width}x#{height}" if cols != width || rows != height
+    end
+    img = yield(img) if block_given?
+    img
+  end  
+
+  def register_extension_templates
+    # We call reload_path to register the templates directory with Middleman.
+    # The path given to app.files must be relative to the Middleman site's root.
+    templates_dir_relative_from_root = Pathname(TEMPLATES_DIR).relative_path_from(Pathname(app.root))
+    app.files.reload_path(templates_dir_relative_from_root)
+  end
+
+  def template(path)
+    full_path = File.join(TEMPLATES_DIR, path)
+    raise "Template #{full_path} not found" if !File.exist?(full_path)
+    full_path
+  end
+
+  def manipulate_resource_list(resources)
+    # Load in reverse order for easier building
+    proj_resources = projects.collect {|project|
+      thumbs = project_thumbnail_resources(project)
+      resources += thumbs
+      project_resource(project, thumbs)
+    }
+
+    # Add project resources to main array
+    resources += proj_resources
+    # resources += project_thumbnail_resources(project)  
+    resources << portfolio_index_resource(proj_resources)
+    return resources
+  end
+
+  # get abs path to portfolio dir
+  def portfolio_path
+    File.join(app.source_dir, options.portfolio_dir) 
+  end
+  
+  def portfolio_index_path
+    "#{options.portfolio_dir}.html"
+  end 
+
+  def portfolio_index_resource(project_resources) 
+    Middleman::Sitemap::Resource.new(app.sitemap, portfolio_index_path, source_file(:portfolio)).tap do |resource|
+      resource.add_metadata(
+        # options: { layout: false }, 
+        locals: {
+          projects: projects,
+          options: options,
+          project_resources: project_resources 
+        }
+      )
+    end
+  end
+
+  # get absolute path to project directory, eg: /path/to/site/portfolio/example-project/
+  def project_dir(project)
+    File.join(portfolio_path, project)
+  end 
+
+  # array of images for a project
+  def project_images(project)
+    Dir.glob(File.join(project_dir(project), '*'))
+  end
+
+  # project_resource_path("/path/to/image.png") => "portfolio/project/image.png"
+  def project_image_resource_path(project, image)
+    File.join(options.portfolio_dir, project, File.basename(image))
+  end
+
+  # Get all projects located in options.portfolio_dir
+  def project_dirs
+    #debug "Looking in #{options.portfolio_dir} for project subdirectories"
+    Dir.glob(File.join(portfolio_path, '*')).select {|f| File.directory? f}
+  end 
+
+  def projects
+    # Look for project directories
+    projects = project_dirs.collect {|d| File.basename(d) }    
+  end 
+
+  # portfolio/example-project.html
+  def project_resource_path(project)
+    File.join(options.portfolio_dir, "#{project}.html")
+  end
+
+  def project_resource(project, thumbnail_resources)
+ 
+    Middleman::Sitemap::Resource.new(app.sitemap, project_resource_path(project), source_file(:project)).tap do |resource|
+      resource.add_metadata(
+        locals: {
+          name: project,
+          options: options,
+          thumbnail_resources: thumbnail_resources,
+        }
+      )
+    end
+  end
+
+  # create a resource for each portfolio project
+  def project_resources(thumbnail_resources)
+    projects.collect {|project| project_resource(project, thumbnail_resources)}
+  end 
+
+  # generate thumbnail and resource for an image in a project
+  def project_thumbnail_resource(project, image)
+    debug "Generating thumbnail of #{project}/#{image}"
+    tmp_image = generate_thumbnail(image)
+
+    # Add image to sitemap
+    path = project_thumbnail_resource_path(project, File.basename(tmp_image))
+    debug "Adding #{path} to #{project}"
+    Middleman::Sitemap::Resource.new(app.sitemap, path, tmp_image).tap do |resource|
+      resource.add_metadata(
+        locals: {
+          project: project,
+          image: File.basename(image)
+        }
+      )
+    end    
+  end
+
+  # generate thumbnail resource for each image in project dir
+  def project_thumbnail_resources(project)
+    resources = Array.new
+    for image in project_images(project)
+      resources << project_thumbnail_resource(project, image)
+    end 
+
+    return resources
+  end
+
+  # Generate resource path to project thumbnail, eg: "portfolio/example-project/1-thumbnail.jpg"
+  def project_thumbnail_resource_path(project, thumbnail)
+    File.join(options.portfolio_dir, project, thumbnail)
+  end
+
+  # get path to source file for page, use default if not set, freak out if missing 
+  def source_file(page)
+    # Load custom template or default
+    opt = options.send("#{page}_template")
+
+    if opt
+      path = File.join(app.source_dir, opt)  
+      raise "#{path} doesn't exist" unless File.exist?(path)
+      return path 
+    else
+      return template("#{page}.html.erb") 
+    end
+  end
+
+  # thumbnail_name("1.jpg") => "1-200x150.jpg"
+  def thumbnail_name(image)
+    name = "#{File.basename(image, '.*')}-#{options.thumbnail_width}x#{options.thumbnail_height}#{File.extname(image)}"
+    name.gsub!(/ /, "-")
+    return name
+  end
+
+  def debug(str)
+    #puts str
+  end
+
+  helpers do
+  end
+end
+
+::Middleman::Extensions.register(:portfolio, Portfolio)

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-portfolio'

data/lib/template/source/portfolio.html.erb

@@ -0,0 +1,9 @@
+<% for project in project_resources %>
+	<% if project.metadata[:locals][:thumbnail_resources] %>
+		<% link_to project.path, title: project.metadata[:locals][:name], class: "#{options.thumbnail_link_class}" do %>
+			<%= image_tag project.metadata[:locals][:thumbnail_resources].first.path, class: "#{options.thumbnail_class}" %>	
+		<% end %>
+	<% else %>
+		<!-- No thumbnails found for <%= project.metadata[:locals][:name] %> -->
+	<% end %>
+<% end %>

data/lib/template/source/project.html.erb

@@ -0,0 +1,5 @@
+<% for thumb in thumbnail_resources  %>
+	<% link_to thumb.metadata[:locals][:image], class: "#{options.thumbnail_link_class}" do %>
+		<%= image_tag thumb.path, class: "#{options.thumbnail_class}" %> 
+	<% end %>
+<% end %>

data/middleman-portfolio.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: middleman-portfolio 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "middleman-portfolio"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Dave Hulihan"]
+  s.date = "2015-08-14"
+  s.description = "A low-drama portfolio generator for your middleman site."
+  s.email = "dhulihan@gmail.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "features/support/env.rb",
+    "lib/middleman-portfolio.rb",
+    "lib/middleman_extension.rb",
+    "lib/template/source/portfolio.html.erb",
+    "lib/template/source/project.html.erb",
+    "middleman-portfolio.gemspec",
+    "screenshot.jpg"
+  ]
+  s.homepage = "http://github.com/dhulihan/middleman-portfolio"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5"
+  s.summary = "A low-drama portfolio generator for your middleman site."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<middleman-portfolio>, [">= 0"])
+      s.add_runtime_dependency(%q<mini_magick>, [">= 0"])
+      s.add_development_dependency(%q<rake>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<middleman-portfolio>, [">= 0"])
+      s.add_dependency(%q<mini_magick>, [">= 0"])
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<middleman-portfolio>, [">= 0"])
+    s.add_dependency(%q<mini_magick>, [">= 0"])
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: middleman-portfolio
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Dave Hulihan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mini_magick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.10
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A low-drama portfolio generator for your middleman site.
+email: dhulihan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- README.md
+- Rakefile
+- VERSION
+- features/support/env.rb
+- lib/middleman-portfolio.rb
+- lib/middleman_extension.rb
+- lib/template/source/portfolio.html.erb
+- lib/template/source/project.html.erb
+- middleman-portfolio.gemspec
+- screenshot.jpg
+homepage: http://github.com/dhulihan/middleman-portfolio
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: A low-drama portfolio generator for your middleman site.
+test_files: []