middleman-presentation-helpers 0.0.7 → 0.1.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 876b18b3f9d70c049bef406627c51b9ed376b772
-  data.tar.gz: 1eb02bac537e4102136f1a13847d3d05dae28e79
+  metadata.gz: 1fb635fa3238435651cdd97bd3362c32244f06a3
+  data.tar.gz: 4ed2069d1a150026b69674303f4e6b719dec23e5
 SHA512:
-  metadata.gz: 39a9576ac8bff208629b9263613ba85445cde1b9ff42cac93f0f126c525a92a8cf6423a1762b0d43adb838082ef00737a14ae5ad24746519e87f049932a6f53d
-  data.tar.gz: a2176cfcf94cbd60d8f3a792c0709ae037b21d8779594619d25801c3e7f876462699f26e3f927210e16ec3d9b1780dc9ff7c8be6b8fe34aa3846005dc55c3dd4
+  metadata.gz: 3ba948607297dd6b971a80f7ca5822e5d292fa67e1aa24e19570e7728f355128cfd30fabb221f482085877cc6aeeb1fdc1dc69692da0f3c01b9ed36038f411bd
+  data.tar.gz: 54446cd01e1baec08ccd4df9daf10f03b684abf0ff956abccba1ee87e1ab57424732eccebffa0dc7c21f18167c2526023afd316b3090a2a50c36def915f336c4

data/.rspec

@@ -1,5 +1,3 @@
---require rspec/legacy_formatters
-#--require spec_helper
 --format Fuubar
 --order rand
 --color

data/.rubocop.yml

@@ -1,4 +1,45 @@
-inherit_from: 
-  - config/rubocop/include.yml
-  - config/rubocop/exclude.yml
-  - config/rubocop/exclude.yml
+AllCops:
+  Exclude:
+    - 'tmp/**/*'
+
+# Configuration parameters: AllowURI.
+Metrics/LineLength:
+  Max: 225
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Configuration parameters: Exclude.
+Style/FileName:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 118
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 160
+#  Exclude:
+#    - lib/middleman-presentation-core/cli/create_presentation.rb
+
+Metrics/CyclomaticComplexity:
+  Max: 9
+#  Exclude:
+#    - lib/middleman-presentation-core/file_extensions.rb
+
+#Metrics/PerceivedComplexity:
+#  Exclude:
+#    - lib/middleman-presentation-core/cli/create_slide.rb
+#    - lib/middleman-presentation-core/frontend_component.rb 
+#    - lib/middleman-presentation-core/assets_manager.rb
+#    - lib/middleman-presentation-core/file_extensions.rb
+#    - lib/middleman-presentation-core/commands/slide.rb
+
+# Configuration parameters: MaxSlashes.
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+Metrics/AbcSize:
+  Enabled: false

data/README.md

@@ -1,6 +1,11 @@
 # Middleman::Presentation::Helpers
 
-TODO: Write a gem description
+This gem contains helpers for
+[`middleman-presentation`](https://github.com/maxmeyer/middleman-presentation):
+
+* Image gallery
+* Images
+* Some methods which could be core or helpers
 
 ## Installation
 
@@ -20,7 +25,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Image gallery
+
+If you want to create an image gallery in your slides you can use the
+`image_gallery`-helper. It just needs an id for the gallery and a list of images.
+
+```eruby
+<%= image_gallery ['img/image1.png', 'img/image2.png'], id: 'my-gallery' %>
+```
+
+### Images
+
+If you want to create an image in your slides and want it to have a fancy style, you can use the
+`image`-helper. Just needs the name of the image.
+
+```eruby
+<%= image 'img/image1.png' %>
+```
 
 ## Contributing
 

data/Rakefile

@@ -6,7 +6,7 @@ require 'active_support/all'
 require 'open3'
 
 def software
-  gemspec.name
+  gemspec.name.sub(/mp-/, 'middleman-presentation-')
 end
 
 def module_name
@@ -14,7 +14,7 @@ def module_name
 end
 
 def require_name
-  'middleman-presentation/helpers'
+  software
 end
 
 def gemspec
@@ -121,6 +121,10 @@ namespace :test do
     sh 'bundle exec cucumber -p all'
   end
 
+  task :parallel_cucumber do
+    sh 'bundle exec parallel_cucumber features -o "-p all" --serialize-stdout'
+  end
+
   desc 'Run mutant'
   task :mutant do
     sh 'mutant --include lib --require middleman-presentation --use rspec "Middleman::Presentation*"'

data/features/image_gallery.feature

@@ -5,17 +5,16 @@ Feature: Image Gallery
   In order to spent as less time as possible on it
 
   Background:
-    Given I create a new presentation with title "My Presentation"
+    Given I use presentation fixture "image_gallery" with title "My Presentation"
     And an image "image01.png" at "images/image01.png"
     And an image "image02.png" at "images/image02.png"
 
-    @wip
   Scenario: Images only
     Given a slide named "01.html.erb" with:
     """
     <section>
     <h1>Image Gallery</h1>
-    <%= image_gallery %W{images/image01.png images/image02.png}, image_gallery_id: 'test-gallery' %>
+    <%= image_gallery %W{images/image01.png images/image02.png}, id: 'test-gallery' %>
     </section>
     """
     And the Server is running
@@ -45,7 +44,7 @@ Feature: Image Gallery
     """
     <section>
     <h1>Image Gallery</h1>
-    <%= image_gallery({'images/image01.png' => 'Title 1', 'images/image02.png' => 'Title 2'}, image_gallery_id: 'test-gallery') %>
+    <%= image_gallery({'images/image01.png' => 'Title 1', 'images/image02.png' => 'Title 2'}, id: 'test-gallery') %>
     </section>
     """
     And the Server is running

data/features/metadata.feature

@@ -0,0 +1,40 @@
+Feature: Add meta data fields
+
+  As a creator of a presentation
+  I want to use meta data from configuration
+  In order to display them on the slides
+
+  Background:
+    Given I use presentation fixture "simple1" with title "My Presentation"
+
+  Scenario: Generate meta data
+    Given a presentation config file for middleman-presentation with:
+    """
+    author: 'Max'
+    """
+    And a slide named "01.html.erb" with:
+    """
+    <section>
+    <%= metadata_markup([:author], [:author]) %>
+    </section>
+    """
+    When the Server is running
+    And I go to "/"
+    Then I should see:
+    """
+    Max
+    """
+
+  Scenario: Unknown field
+    Given a slide named "01.html.erb" with:
+    """
+    <section>
+    <%= metadata_markup([:author], []) %>
+    </section>
+    """
+    When the Server is running
+    And I go to "/"
+    Then I should see:
+    """
+    You entered an unknown metadata field "author".
+    """

data/features/step_definitions.rb

@@ -4,4 +4,3 @@ Given(/^an image "([^"]+)" at "([^"]+)"$/) do |source, destination|
   source = source.gsub(/\.\./, '')
   write_file File.join('source', destination), File.read(File.expand_path("../../fixtures/images/#{source}", __FILE__))
 end
-

data/features/support/aruba.rb

@@ -8,7 +8,7 @@ module Middleman
       # Helpers for aruba
       module Aruba
         def dirs
-          @dirs ||= ['tmp', 'cucumber']
+          @dirs ||= %w(tmp cucumber)
         end
       end
     end

data/features/support/ci.rb

@@ -1,3 +1,3 @@
 # Test helpers
-require 'middleman-presentation/test_helpers'
+require 'middleman-presentation-core/test_helpers'
 World(Middleman::Presentation::TestHelpers)

data/features/support/env.rb

@@ -8,7 +8,7 @@ SimpleCov.start
 # middleman
 require 'middleman-core'
 require 'middleman-core/step_definitions'
-require 'middleman-presentation/step_definitions'
+require 'middleman-presentation-core/step_definitions'
 
 # Pull in all of the gems including those in the `test` group
 require 'bundler'

data/lib/middleman-presentation-helpers.rb

@@ -0,0 +1,24 @@
+require 'middleman-presentation-helpers/version'
+
+require 'middleman-presentation-helpers/helpers/image_gallery'
+require 'middleman-presentation-helpers/helpers/image'
+require 'middleman-presentation-helpers/helpers/slides'
+require 'middleman-presentation-helpers/helpers/metadata'
+
+require 'middleman-presentation-helpers/plugins/jquery_plugin'
+require 'middleman-presentation-helpers/plugins/normalize_plugin'
+require 'middleman-presentation-helpers/plugins/highlight_plugin'
+require 'middleman-presentation-helpers/plugins/slides_plugin'
+require 'middleman-presentation-helpers/plugins/images_plugin'
+require 'middleman-presentation-helpers/plugins/image_gallery_plugin'
+require 'middleman-presentation-helpers/plugins/metadata_plugin'
+require 'middleman-presentation-helpers/plugins/footer_plugin'
+require 'middleman-presentation-helpers/plugins/print_plugin'
+
+module Middleman
+  module Presentation
+    # Helpers plugin
+    module Helpers
+    end
+  end
+end

data/lib/middleman-presentation-helpers/helpers/image.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require 'middleman-presentation-helpers/helpers/image_gallery.rb'
+
+module Middleman
+  module Presentation
+    # Helper module
+    module Helpers
+      # Images helpers
+      module Image
+        # Create entry for single image
+        #
+        # @param [String] image
+        #   The path to the image, e.g. 'img/image1.png'
+        def image(image)
+          ImageGallery.image_gallery Array(image), id: SecureRandom.hex
+        end
+      end
+    end
+  end
+end

data/lib/{middleman-presentation → middleman-presentation-helpers}/helpers/image_gallery.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Middleman
   module Presentation
     # Helper module
@@ -6,20 +5,23 @@ module Middleman
       # Images helpers
       module ImageGallery
         # Create image gallery
-        def image_gallery(images, image_gallery_id:)
+        #
+        # @param [Array] images
+        #   An array of image paths, e.g. `img/image.png`
+        #
+        # @param [String] id
+        #   A unique id for your image gallery - unique within your presentation
+        def image_gallery(images, id:)
           template = File.read(File.expand_path('../../../../templates/image_gallery.erb', __FILE__)).chomp
 
           images.each_with_object([]) do |(image, title), memo|
             engine = Erubis::Eruby.new(template)
 
-            memo << engine.result(image_path: image, image_gallery_id: image_gallery_id, title: title)
+            memo << engine.result(image_path: image, image_gallery_id: id, title: title)
           end.join("\n")
         end
 
-        # Create entry for single image
-        def image(image)
-          image_gallery Array(image), image_gallery_id: SecureRandom.hex
-        end
+        module_function :image_gallery
       end
     end
   end

data/lib/middleman-presentation-helpers/helpers/metadata.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    module Helpers
+      # Meta daa helper
+      module Metadata
+        def metadata_markup(requested_fields, allowed_fields)
+          requested_fields = Array(requested_fields).map(&:to_sym)
+          allowed_fields   = Array(allowed_fields).map(&:to_sym)
+          unknown_fields   = requested_fields - allowed_fields
+
+          fail ArgumentError, Middleman::Presentation.t('errors.unknown_metadata_fields', fields: unknown_fields.to_list, count: unknown_fields.size) unless unknown_fields.blank?
+
+          Erubis::Eruby.new(template).result(fields: requested_fields).chomp
+        end
+
+        private
+
+        def template
+          <<-EOS.strip_heredoc
+          <%- fields.each do |f| -%>
+          <span class="mp-meta-<%= f %>"><%= Middleman::Presentation.config.public_send f %></span>
+          <%- end -%>
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/{middleman-presentation → middleman-presentation-helpers}/helpers/slides.rb

@@ -7,17 +7,19 @@ module Middleman
       module Slides
         # Yield slides
         def yield_slides
-          list = SlideList.new(Dir.glob(File.join(source_dir, extensions[:presentation].options.slides_directory, '**', '*')), slide_builder: ExistingSlide, base_path: source_dir) do |l|
+          environment = Middleman::Presentation::MiddlemanEnvironment.new
+
+          list = SlideList.new(Dir.glob(File.join(environment.slides_path, '**', '*')), slide_builder: ExistingSlide, base_path: environment.sources_path) do |l|
             l.transform_with Transformers::FileKeeper.new
             l.transform_with Transformers::RemoveDuplicateSlides.new raise_error: true
-            l.transform_with Transformers::IgnoreSlides.new ignore_file: File.join(root, extensions[:presentation].options.slides_ignore_file)
+            l.transform_with Transformers::IgnoreSlides.new ignore_file: File.join(environment.root_path, Middleman::Presentation.config.slides_ignore_file)
             l.transform_with Transformers::SortSlides.new
-            l.transform_with Transformers::GroupSlides.new template: Erubis::Eruby.new(GroupTemplate.new(working_directory: root).content)
+            l.transform_with Transformers::GroupSlides.new template: Erubis::Eruby.new(GroupTemplate.new(working_directory: environment.root_path).content)
           end
 
           list.all.map do |element|
             begin
-              element.render { |path| partial(path).chomp }
+              element.render { |path| render_template(path, {}, layout: nil).chomp }
             rescue StandardError => e
               message = []
               message << "Rendering slide \"#{element.partial_path}\" failed with"

data/lib/middleman-presentation-helpers/plugins/footer_plugin.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # Helpers plugin
+    module Helpers
+      # Slides plugin
+      module SlidesPlugin
+        extend PluginApi
+
+        add_assets(
+          path: File.expand_path('../../../../vendor/assets', __FILE__),
+          importable_files: %w(footer.js footer.scss)
+        )
+      end
+    end
+  end
+end

data/lib/middleman-presentation-helpers/plugins/highlight_plugin.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # Helpers plugin
+    module Helpers
+      # Highlight plugin
+      module HighlightPlugin
+        extend PluginApi
+
+        loadable_files = [
+          /.*\.js$/
+        ]
+
+        add_component(
+          name: :'highlightjs',
+          version: 'latest',
+          importable_files: %w(zenburn.css),
+          loadable_files: loadable_files
+        )
+      end
+    end
+  end
+end

data/lib/middleman-presentation-helpers/plugins/image_gallery_plugin.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # Helpers plugin
+    module Helpers
+      # Image Gallery plugin
+      class ImageGalleryPlugin < Plugin
+        extend PluginApi
+
+        add_assets(
+          path: File.expand_path('../../../../vendor/assets', __FILE__),
+          importable_files: %w(image_gallery.scss)
+        )
+
+        add_component(
+          name: :lightbox2,
+          github: 'dg-vrnetze/revealjs-lightbox2',
+          importable_files: %w(js/lightbox.js)
+        )
+
+        add_helpers Middleman::Presentation::Helpers::ImageGallery
+      end
+    end
+  end
+end