middlemac-extras 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf5e2bfe3faed7c34abaf50486196b1c50cfe5f3
+  data.tar.gz: b6c58fce72a4d5a18cf65810187e4c2177f5dd51
+SHA512:
+  metadata.gz: 94a0b6fb575fbb78e1f29c4642d8013a6c6526860e7edccde7c29a2bbd9b5c35d321b96206be73c8797664b53a765bd0e33586fcac986e59f13cb05ad5a66404
+  data.tar.gz: 4045e6ffb9335e8190839777343b3d2f8d8cbf300bb778d231932b4ee5dc12a4814ea45b8573191e6870eefd6a378c90c2da330bd5e322bdd63d6988e294b5ef

data/.gitignore

@@ -0,0 +1,17 @@
+# Rubymine noise
+.idea/
+
+# BBedit noise
+*.bbprojectd
+
+# Mac OS X noise
+.DS_Store
+
+# Ignore bundler lock files
+Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+# Ignore build folders
+build*

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+middlemac-extras change log
+===========================
+
+- Version 1.0.0 / 2016-April-05
+
+  - Initial Release

data/Gemfile

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-pagegroups.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License
+===============
+
+Copyright (c) 2016 Jim Derry
+
+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,70 @@
+middlemac-extras readme
+-----------------------
+[![Gem Version](https://badge.fury.io/rb/middlemac-extras.svg)](https://badge.fury.io/rb/middlemac-extras)
+
+
+`middlemac-extras`
+
+ : This gem provides conveniences to Middleman projects such as CSS-based image
+   size limits; easy-to-use Markdown link references (including title!);
+   easy-to-use Markdown image references; and an enhanced `image_tag` helper
+   that includes @2x images automatically.
+
+   It is standalone and can be used in any Middleman project.
+
+
+Install the Gem
+---------------
+
+Install the gem in your preferred way, typically:
+
+~~~ bash
+gem install middlemac-extras
+~~~
+
+From git source:
+
+~~~ bash
+rake install
+~~~
+
+
+Documentation
+-------------
+
+The complete documentation leverages the features of this gem in order to better
+document them. Having installed the gem, read the full documentation in your
+web browser:
+
+~~~ bash
+middlemac-extras documentation
+cd middlemac-extras-docs/
+bundle install
+bundle exec middleman server
+~~~
+   
+And then open your web browser to the address specified (typically
+`localhost:4567`).
+
+
+Middlemac
+---------
+
+This Middleman extension is a critical part of
+[Middlemac](https://github.com/middlemac), the Mac OS X help building system
+for Mac OS X applications. However this gem is not Mac OS X specific and can be
+useful in any application for which you want to provide structure and
+navigation.
+
+
+License
+-------
+
+MIT. See `LICENSE.md`.
+
+
+Changelog
+---------
+
+See `CHANGELOG.md` for point changes, or simply have a look at the commit
+history for non-version changes (such as readme updates).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/middlemac-extras

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+################################################################################
+# middlemac-extras
+#  This file constitutes the command line interface for middlemac-extras
+################################################################################
+
+require 'thor'
+require 'fileutils'
+require_relative '../lib/middlemac-extras/version'
+
+
+module MiddlemacExtrasCli
+
+  class Cli < Thor
+
+    map %w[--version -v] => :__print_version
+
+    ############################################################
+    # help
+    #  Override to add additional description.
+    ############################################################
+    def help(*args)
+      if args.count == 0
+        puts <<-HEREDOC
+
+middlemac-extras version #{Middleman::MiddlemacExtras::VERSION}
+
+This gem adds functionality to Middleman and is not executable on its own,
+other than for generating the documentation sample project. Instead, you 
+must add this gem to your Middleman project's `Gemfile` and then activate 
+it in your `config.rb` file. 
+
+HEREDOC
+      end
+      super
+    end
+
+
+    ############################################################
+    # documentation
+    ############################################################
+    desc 'documentation', 'Install the sample project into your current working directory.'
+    long_desc <<-HEREDOC
+`documentation` will produce a sample project named `middlemac-extras-docs/`
+in your current working directory. This sample uses the features of this gem.
+You can then serve this new project to read the documentation by:
+
+cd middlemac-extras-docs
+bundle install
+bundle exec middleman server
+    
+    HEREDOC
+    def documentation
+      source = File.join('..', '..', 'documentation_project', '.')
+      source = File.expand_path(source, __FILE__)
+      dest = File.expand_path(File.join('.', 'middlemac-extras-docs', '.'))
+      FileUtils.cp_r(source, dest)
+      puts "middlemac-extras installed the project in\n#{dest}" 
+    end
+
+
+    ############################################################
+    # __print_version
+    ############################################################
+    desc '--version, -v', 'print the version'
+    def __print_version
+      puts "middlemac-extras version #{Middleman::MiddlemacExtras::VERSION}"
+    end
+
+  end # class Cli
+
+end # module MiddlemacExtrasCli
+
+
+###########################################################
+# Main
+###########################################################
+
+MiddlemacExtrasCli::Cli.start(ARGV)

data/documentation_project/.gitignore

@@ -0,0 +1,25 @@
+# Rubymine noise
+.idea/
+
+# BBedit noise
+*.bbprojectd
+
+# Mac OS X noise
+.DS_Store
+
+# Ignore bundler lock files
+Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+# Ignore build folders
+.rbenv-*
+.ruby-gemset
+.ruby-version
+.sass-cache
+.sassc
+.tmp
+build*
+Makefile
+tmp

data/documentation_project/Gemfile

@@ -0,0 +1,17 @@
+# If you do not have OpenSSL installed, change
+# the following line to use 'http://'
+source 'https://rubygems.org'
+
+# For faster file watcher updates on Windows:
+gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
+
+# Windows does not come with time zone data
+gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
+
+# Middleman Gems
+gem 'middlemac-extras', '~> 1.0'
+gem 'middleman', '~> 4.1.6'
+gem 'middleman-syntax'
+
+# Other required gems
+gem 'fastimage', '~> 1.9'

data/documentation_project/README.md

@@ -0,0 +1,13 @@
+documentation-project readme
+----------------------------
+
+This gem's documentation is a Middleman project using the features of this gem.
+To view the documentation project, `cd` into this directory and
+
+~~~ bash
+gem install
+bundle exec middleman serve
+~~~
+
+When the server starts, it will provide instructions on how to view the project
+in your web browser.

data/documentation_project/config.rb

@@ -0,0 +1,77 @@
+################################################################################
+# Sample Project for middlemac-extras
+################################################################################
+
+#==========================================================================
+# Conflicting resources
+#  middlemac-extras uses Middleman's resource map to generate a lot of the
+#  information that it provides. Be sure to activate other extensions that
+#  might manipulate the resource map before activating middlemac-extras,
+#  such as MiddlemanPageGroups.
+#
+#  The `image_tag` helper should inherit from other `image_tag` helpers,
+#  so it's best to make sure they're activated first.
+#==========================================================================
+# activate :MiddlemanPageGroups
+activate :automatic_alt_tags
+
+#==========================================================================
+# Extension Setup
+#==========================================================================
+activate :MiddlemacExtras do |config|
+
+  # If set to true, then the enhanced image_tag helper will be used
+  # to include @2x srcset automatically, if the image asset exists.
+  config.retina_srcset = true
+
+  # If set to true then the `image_tag` helper will work for images even
+  # if you don't specify an extension, but only if a file exists on disk
+  # that has one of the extensions in :img_auto_extensions_order.
+  config.img_auto_extensions = true
+
+  # Set this to an array of extensions in the order of precedence for
+  # using `image_tag` without file extensions.
+  config.img_auto_extensions_order = %w(.svg .png .jpg .jpeg .gif .tiff .tif)
+
+end
+
+
+#==========================================================================
+# Regular Middleman Setup
+#==========================================================================
+
+set :relative_links, true
+activate :syntax
+
+
+#==========================================================================
+# Helpers
+#  These helpers are used by the sample project only; there's no need
+#  to keep them around in your own projects.
+#==========================================================================
+
+# Methods defined in the helpers block are available in templates
+helpers do
+
+  def product_name
+    'middlemac-extras'
+  end
+
+  def product_version
+    '1.0.0'
+  end
+
+  def product_uri
+    'https://github.com/middlemac'
+  end
+
+end
+
+# Build-specific configuration
+configure :build do
+  # Minify CSS on build
+  # activate :minify_css
+
+  # Minify Javascript on build
+  # activate :minify_javascript
+end

data/documentation_project/source/archives/about.html.md.erb

@@ -0,0 +1,29 @@
+---
+title:    archives/about
+blurb:    Describes your legal rights and obligations for using these materials.
+layout:   template-logo-medium
+order:    40
+navigate: false
+---
+
+# <%= current_page.data.title %>
+
+**Copyright (c) 2016 Jim Derry**
+
+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/documentation_project/source/archives/index.html.md.erb

@@ -0,0 +1,78 @@
+---
+title:    archives/index.html Generic Sample Page
+layout:   template-logo-large
+---
+
+# <%= current_page.data.title %>
+
+This is a generic sample page, and it’s included in this project just to force
+the helpers to have some information to demonstrate. With that, let’s have a
+look at the helper output.
+
+* * *
+
+## `<%%= md_links %>` 
+
+This isn't normally meant to be visible; this simply shows you the content that
+would be part of your Markdown file when including this helper. You can use
+these reference-style tags with Markdown, e.g., `[Home page][index]`.
+
+<%= md_links %>
+
+~~~ erb
+<%%= md_links %>
+~~~
+
+~~~ markdown
+<%= md_links %>
+~~~
+
+### Test
+
+ 
+## `<%%= md_images %>` 
+
+This isn't normally meant to be visible; this simply shows you the content that
+would be part of your Markdown file when including this helper. You can use
+these reference-style tags with Markdown, e.g., `[Home page][index]`.
+
+<%= md_images %>
+
+~~~ erb
+<%%= md_images %>
+~~~
+
+~~~ markdown
+<%= md_images %>
+~~~
+
+### Test
+
+Using [middlemac-extras-small]:
+
+![middlemac-extras-small][middlemac-extras-small]
+
+Using [sub_images-middlemac-extras]:
+
+![sub_images-middlemac-extras][sub_images-middlemac-extras]
+
+
+## `<%%= css_image_sizes %>` 
+
+~~~ erb
+<%%= css_image_sizes %>
+~~~
+
+~~~ markdown
+<%= css_image_sizes %>
+~~~
+
+
+* * *
+
+# Link to license
+
+See the [license][license].
+Go to the [index][index].
+
+* * *

data/documentation_project/source/archives/past_far/about.html.md.erb

@@ -0,0 +1,29 @@
+---
+title:    archives/about
+blurb:    Describes your legal rights and obligations for using these materials.
+layout:   template-logo-medium
+order:    40
+navigate: false
+---
+
+# <%= current_page.data.title %>
+
+**Copyright (c) 2016 Jim Derry**
+
+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/documentation_project/source/archives/past_far/index.html.md.erb

@@ -0,0 +1,35 @@
+---
+title:    SCIENCE FICTION INDEX
+blurb:    <em>middlemac-extras</em> adds several developer conveniences..
+layout:   template-logo-large
+navigate: false
+---
+
+# <%= current_page.data.title %>
+
+Although developed for **MiddleMac**, the `middlemac-extras` extension for
+Middleman is a great way to add handy developer conveniences to your Middleman
+project.
+
+Features such as CSS-based image sizes, automatic Markdown reference-style
+links, and an automatic @2x `image_size` helper will increase your productivity.
+
+* * *
+
+# Link to license
+
+See the [license][license].
+
+Go to the [index][index].
+
+Go to the [science fiction][science_fiction_index] index.
+
+Go to the [science fiction](books/science fiction/index.html) index.
+
+* * *
+
+<%= md_links %>
+
+~~~ markdown
+<%= md_links %>
+~~~

data/documentation_project/source/archives/past_near/about.html.md.erb

@@ -0,0 +1,29 @@
+---
+title:    archives/about
+blurb:    Describes your legal rights and obligations for using these materials.
+layout:   template-logo-medium
+order:    40
+navigate: false
+---
+
+# <%= current_page.data.title %>
+
+**Copyright (c) 2016 Jim Derry**
+
+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/documentation_project/source/archives/past_near/index.html.md.erb

@@ -0,0 +1,35 @@
+---
+title:    SCIENCE FICTION INDEX
+blurb:    <em>middlemac-extras</em> adds several developer conveniences..
+layout:   template-logo-large
+navigate: false
+---
+
+# <%= current_page.data.title %>
+
+Although developed for **MiddleMac**, the `middlemac-extras` extension for
+Middleman is a great way to add handy developer conveniences to your Middleman
+project.
+
+Features such as CSS-based image sizes, automatic Markdown reference-style
+links, and an automatic @2x `image_size` helper will increase your productivity.
+
+* * *
+
+# Link to license
+
+See the [license][license].
+
+Go to the [index][index].
+
+Go to the [science fiction][science_fiction_index] index.
+
+Go to the [science fiction](books/science fiction/index.html) index.
+
+* * *
+
+<%= md_links %>
+
+~~~ markdown
+<%= md_links %>
+~~~

data/documentation_project/source/books/about.html.md.erb

@@ -0,0 +1,29 @@
+---
+title:    archives/about
+blurb:    Describes your legal rights and obligations for using these materials.
+layout:   template-logo-medium
+order:    40
+navigate: false
+---
+
+# <%= current_page.data.title %>
+
+**Copyright (c) 2016 Jim Derry**
+
+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/documentation_project/source/books/index.html.md.erb

@@ -0,0 +1,30 @@
+---
+title:    Welcome to <code>middlemac-extras</code>
+blurb:    <em>middlemac-extras</em> adds several developer conveniences..
+layout:   template-logo-large
+navigate: false
+---
+
+# <%= current_page.data.title %>
+
+Although developed for **MiddleMac**, the `middlemac-extras` extension for
+Middleman is a great way to add handy developer conveniences to your Middleman
+project.
+
+Features such as CSS-based image sizes, automatic Markdown reference-style
+links, and an automatic @2x `image_size` helper will increase your productivity.
+
+* * *
+
+# Link to license
+
+See the [license][license].
+Go to the [index][index].
+
+* * *
+
+<%= md_links %>
+
+~~~ markdown
+<%= md_links %>
+~~~