middleman-presentation-core 0.16.0.alpha

data/lib/middleman-presentation-core/slide_group.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # A group of slides
+    class SlideGroup
+      private
+
+      attr_reader :template
+
+      public
+
+      attr_reader :name, :slides
+
+      def initialize(name:, slides:, template:)
+        @name     = name
+        @slides   = slides
+        @template = template
+      end
+
+      # Combine paths of all slides
+      def partial_path
+        slides.map(&:partial_path).to_list
+      end
+
+      # Call block for each slide
+      def render(&block)
+        slides_content = slides.each_with_object([]) { |e, a| a << e.render(&block) }.join("\n")
+
+        template.result(slides: slides_content)
+      end
+    end
+  end
+end

data/lib/middleman-presentation-core/slide_list.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # List of slides
+    class SlideList
+      include Enumerable
+
+      private
+
+      attr_accessor :transformers, :slides
+
+      public
+
+      def initialize(names, slide_builder:, **args, &block)
+        @slides = Array(names).map { |n| slide_builder.new(n, **args) }
+        @transformers = []
+
+        block.call(self) if block_given?
+
+        @slides = transformers.reduce(@slides) { |a, e| e.transform(a) }
+      end
+
+      def transform_with(transformer)
+        transformers << transformer
+      end
+
+      def all
+        slides.dup
+      end
+
+      def each(&block)
+        slides.each(&block)
+      end
+
+      def each_new(&block)
+        all.keep_if { |s| s.respond_to?(:exist?) && !s.exist? }.each(&block)
+      end
+
+      def each_existing(&block)
+        all.keep_if { |s| s.respond_to?(:exist?) && s.exist? }.each(&block)
+      end
+
+      def existing_slides
+        all.keep_if { |s| s.respond_to?(:exist?) && s.exist? }
+      end
+
+      def to_a
+        all
+      end
+    end
+  end
+end

data/lib/middleman-presentation-core/slide_name.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # Determine slide name base on old slide
+    class SlideName
+      private
+
+      attr_reader :old_slide, :base_name, :type
+
+      public
+
+      # Create new instance
+      #
+      # @param [ExistingSlide] old_slide
+      #   The old slide which should be used
+      #
+      # @param [String] base_name
+      #   The requested new base of the file name
+      #
+      # @param [String] type
+      #   The requested new type for the slide name
+      def initialize(old_slide, base_name:, type:)
+        @old_slide = old_slide
+        @base_name = base_name
+        @type      = type
+      end
+
+      # Return the string version of slide name
+      def to_s
+        return determine_base_name + guess_type if base_name.blank? && type.blank?
+
+        determine_base_name + determine_type
+      end
+
+      private
+
+      def guess_type
+        case File.extname(old_slide.ext_name)
+        when '.md'
+          '.erb'
+        when '.erb'
+          '.md'
+        else
+          '.md'
+        end
+      end
+
+      def determine_base_name
+        return base_name if base_name
+
+        old_slide.base_name
+      end
+
+      def determine_type
+        return type.gsub(/^\./, '').prepend('.') if type
+
+        File.extname(old_slide.ext_name)
+      end
+    end
+  end
+end

data/lib/middleman-presentation-core/start.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+# Main
+module Middleman
+  # Presentation extension
+  module Presentation
+    class << self
+      def start(environment)
+        environment.instance_eval do
+          activate :sprockets unless respond_to? :sprockets
+
+          # For testing only otherwise config = Middleman::Pre...::Config.new
+          # is run before the new home is set and the config file is created
+          # and there is not used.
+          Middleman::Presentation.config.redetect if ENV['MP_ENV'] == 'test'
+
+          set :js_dir, Middleman::Presentation.config.scripts_directory
+          set :images_dir, Middleman::Presentation.config.images_directory
+          set :build_dir, Middleman::Presentation.config.build_directory
+          set :css_dir, Middleman::Presentation.config.stylesheets_directory
+          set :source_dir, Middleman::Presentation.config.sources_directory
+
+          Middleman::Presentation::AssetsLoader.new(bower_directory: MiddlemanEnvironment.new.bower_path).load_at_presentation_runtime
+
+          helpers Middleman::Presentation.helpers_manager.available_helpers
+
+          set :markdown_engine, :kramdown
+          set :markdown,
+              parse_block_html: true,
+              tables: true,
+              syntax_highlighter: 'middleman_presentation',
+              syntax_highlighter_opts: {
+                code_block_class: 'mp-code-block',
+                inline_code_class: 'mp-code-inline'
+              },
+              smart_quotes: true
+
+          # ignore slides so that a user doesn't need to prepend slide names
+          # with an underscore
+          ignore 'slides/*'
+
+          # all fetchable components reside in the bower directory. Their
+          # assets are required with "component_name/path/to/asset.scss".
+          # Therefore it's suffice enough to add the bower directory only.
+          sprockets.append_path Pathname.new(File.join(root, Middleman::Presentation::MiddlemanEnvironment.new.bower_directory))
+
+          # all non fetchable components can be hidden in rubygems and
+          # therefor the full path to that components needs to be added
+          Middleman::Presentation.components_manager.each_nonfetchable_component do |c|
+            next if sprockets.appended_paths.include? c.path
+
+            sprockets.append_path c.path
+          end
+
+          Middleman::Presentation.assets_manager.each_loadable_asset do |a|
+            sprockets.import_asset a.load_path, &a.destination_path_resolver
+          end
+
+          configure :build do
+            if Middleman::Presentation.config.minify_assets
+              activate :minify_css
+              activate :minify_javascript
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/middleman-presentation-core/step_definitions.rb

@@ -0,0 +1,238 @@
+# encoding: utf-8
+Before do
+  @aruba_timeout_seconds = 120
+  ENV['MM_ENV'] = 'development'
+  ENV['MP_ENV'] = 'test'
+
+  step 'a mocked home directory'
+  step 'I configure bundler for fast testing'
+  step 'git is configured with username "User" and email-address "email@example.com"'
+  step 'I set the language for the shell to "en_GB.UTF-8"'
+end
+
+Given(/I configure bundler for fast testing/) do
+  config = []
+  config << "BUNDLE_PATH: #{ENV['BUNDLE_PATH']}" if ENV.key? 'BUNDLE_PATH'
+
+  config_file = File.join ENV['HOME'], '.bundle', 'config'
+
+  FileUtils.mkdir_p File.dirname(config_file)
+  File.write config_file, config.join("\n")
+end
+
+# Clean environment
+Around do |_, block|
+  old_env = ENV.to_h
+
+  block.call
+
+  ENV.replace old_env
+end
+
+When(/^I start debugging/) do
+  # rubocop:disable Lint/Debugger
+  require 'pry'
+  binding.pry
+  # rubocop:enable Lint/Debugger
+
+  ''
+end
+
+Given(/^I use presentation fixture "([^"]+)" with title "([^"]+)"(?: and date "([^"]+)")?$/) do |name, title, date|
+  directory = []
+  directory << name
+  directory << ('-' + title)
+  directory << ('-' + date) if date
+
+  directory = directory.join.characterize
+
+  command = []
+  command << "middleman-presentation create presentation #{temporary_fixture_path(directory)}"
+  command << "--title #{Shellwords.escape(title)}"
+  command << "--date #{Shellwords.escape(date)}" if date
+
+  system(command.join(' ')) unless temporary_fixture_exist?(directory)
+
+  FileUtils.cp_r temporary_fixture_path(directory), absolute_path(name)
+  step %(I cd to "#{name}")
+end
+
+Given(/^I set the language for the shell to "([^"]+)"$/) do |language|
+  set_env 'LANG', language
+end
+
+Given(/only the executables of gems "([^"]+)" can be found in PATH/) do |gems|
+  dirs = []
+
+  dirs.concat gems.split(/,\s?/).map(&:strip).each_with_object([]) { |e, a| a << Gem::Specification.find_by_name(e).bin_dir }
+
+  if ci?
+    dirs << "/home/travis/.rvm/rubies/ruby-#{RUBY_VERSION}/bin"
+    dirs << "/home/travis/.rvm/rubies/ruby-#{Gem.ruby_api_version}/bin" unless Gem.ruby_api_version == RUBY_VERSION
+  end
+
+  dirs << '/usr/bin'
+
+  set_env 'PATH', dirs.join(':')
+end
+
+Given(/^I create a new presentation with title "([^"]+)"(?: for speaker "([^"]+)")?(?: on "([^"]+)")?$/) do |title, speaker, date|
+  options = {}
+  options[:title] = title
+  options[:speaker] = speaker if speaker
+  options[:date] = date if date
+
+  step %(I successfully run `middleman-presentation create presentation presentation1 #{options.to_options.join(' ')}`)
+  step 'I cd to "presentation1"'
+end
+
+Given(/^I prepend "([^"]+)" to environment variable "([^"]+)"$/) do |value, variable|
+  set_env variable, value + ENV[variable]
+end
+
+Given(/^a slide named "(.*?)" with:$/) do |name, string|
+  step %(a file named "source/slides/#{name}" with:), string
+end
+
+Given(/^a project template named "(.*?)" with:$/) do |name, string|
+  step %(a file named "templates/#{name}" with:), string
+end
+
+Given(/^a user template named "(.*?)" with:$/) do |name, string|
+  step %(a file named "~/.config/middleman-presentation/templates/#{name}" with:), string
+end
+
+Given(/^a presentation theme named "(.*?)" does not exist$/) do |name|
+  step %(I remove the directory "middleman-presentation-theme-#{name}")
+end
+
+Given(/^a file named "(.*?)" does not exist$/) do |name|
+  FileUtils.rm_rf absolute_path(name)
+end
+
+Given(/^a directory named "(.*?)" does not exist$/) do |name|
+  step %(I remove the directory "#{name}")
+end
+
+Given(/^a plugin named "(.*?)" does not exist$/) do |name|
+  step %(I remove the directory "#{name}")
+end
+
+Then(%r{^a plugin named "(.*?)" should exist( with default files/directories created)?$}) do |name, default_files|
+  step %(a directory named "#{name}" should exist)
+
+  if default_files
+    %W(
+      #{name}/#{name}.gemspec
+      #{name}/lib/#{name}.rb
+      #{name}/lib/#{name}/version.rb
+      #{name}/Gemfile
+      #{name}/LICENSE.txt
+      #{name}/README.md
+      #{name}/Rakefile
+      #{name}/.gitignore
+    ).each do |file|
+      step %(a file named "#{file}" should exist)
+    end
+
+    %W(
+      #{name}/lib
+      #{name}/lib/#{name}
+    ).each do |file|
+      step %(a directory named "#{file}" should exist)
+    end
+  end
+end
+
+Given(/^git is configured with username "(.*?)" and email-address "(.*?)"$/) do |name, email|
+  step %(I successfully run `git config --global user.email "#{email}"`)
+  step %(I successfully run `git config --global user.name "#{name}"`)
+end
+
+Given(/^a user config file for middleman\-presentation with:$/) do |string|
+  step 'a file named "~/.config/middleman-presentation/application.yaml" with:', string
+end
+
+Given(/^a presentation config file for middleman\-presentation with:$/) do |string|
+  step 'a file named ".middleman-presentation.yaml" with:', string
+end
+
+Then(/^the user config file for middleman\-presentation should contain:$/) do |string|
+  step 'the file "~/.config/middleman-presentation/application.yaml" should contain:', string
+end
+
+Then(/^the presentation config file for middleman\-presentation should contain:$/) do |string|
+  step 'the file ".middleman-presentation.yaml" should contain:', string
+end
+
+Then(%r{^a presentation theme named "(.*?)" should exist( with default files/directories created)?$}) do |name, default_files|
+  name = "middleman-presentation-theme-#{name}"
+
+  step %(a directory named "#{name}" should exist)
+
+  if default_files
+    step %(a directory named "#{name}/stylesheets" should exist)
+    step %(a directory named "#{name}/javascripts" should exist)
+  end
+end
+
+Then(/^I go to "([^"]*)" and see the following error message:$/) do |url, message|
+  message = capture :stderr do
+    # rubocop:disable Lint/HandleExceptions:
+    begin
+      @browser.get(URI.escape(url))
+    rescue StandardError
+    end
+    # rubocop:enable Lint/HandleExceptions:
+  end
+
+  expect(message).to include message
+end
+
+Then(/^a directory named "(.*?)" is a git repository$/) do |name|
+  step %(a directory named "#{name}/.git" should exist)
+end
+
+Given(/^a slide named "(.*?)" does not exist$/) do |name|
+  FileUtils.rm_rf absolute_path('source', 'slides', name)
+end
+
+Then(/^a slide named "(.*?)" should exist$/) do |name|
+  step %(a file named "source/slides/#{name}" should exist)
+end
+
+Then(/^a slide named "(.*?)" should exist with:$/) do |name, string|
+  step %(the file "source/slides/#{name}" should contain:), string
+end
+
+When(/^I successfully run `([^`]+)` in clean environment$/) do |command|
+  Bundler.with_clean_env do
+    step %(I successfully run `#{command}`)
+  end
+end
+
+Given(/^I add a stylesheet asset named "(.*?)" to the presentation$/) do |asset|
+  import_string = "@import '#{asset}';"
+
+  step 'I append to "source/stylesheets/application.scss" with:', import_string
+end
+
+When(/^I successfully run `([^`]+)` in debug mode$/) do |cmd|
+  step "I run `#{cmd}` in debug mode"
+end
+
+When(/^I run `([^`]+)` in debug mode$/) do |cmd|
+  in_current_dir do
+    # rubocop:disable Lint/Debugger
+    require 'pry'
+    binding.pry
+    # rubocop:enable Lint/Debugger
+    system(cmd)
+  end
+end
+
+Then(/^the size of "(.*?)" should be much smaller than from  "(.*?)"$/) do |file1, file2|
+  in_current_dir do
+    expect(File.size(file1)).to be < File.size(file2)
+  end
+end

data/lib/middleman-presentation-core/syntax_highlighter.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+require 'kramdown'
+
+# External
+module Kramdown
+  # External
+  module Converter
+    # External
+    module SyntaxHighlighter
+      # Middleman Presentation Converter
+      module MiddlemanPresentation
+        def self.call(converter, text, lang, type, _unused_opts)
+          opts = converter.options[:syntax_highlighter_opts].dup
+          text = ERB::Util.html_escape(text)
+
+          case type
+          when :span
+            %(<code class=\"#{opts[:inline_code_class]}\">#{text}</code>)
+          when :block
+            %(<pre class=\"#{opts[:code_block_class]}\"><code class=\"#{opts[:language_prefix]}#{lang}\">#{text}</code></pre>)
+          else
+            %(<pre class=\"#{opts[:code_block_class]}\"><code class=\"#{opts[:language_prefix]}#{lang}\">#{text}</code></pre>)
+          end
+        end
+      end
+    end
+  end
+end
+
+# External
+module Kramdown
+  # External
+  module Converter
+    klass   = ::Kramdown::Converter::SyntaxHighlighter::MiddlemanPresentation
+    kn_down = :middleman_presentation
+
+    add_syntax_highlighter(kn_down) do |converter, text, lang, type, opts|
+      add_syntax_highlighter(kn_down, klass)
+      syntax_highlighter(kn_down).call(converter, text, lang, type, opts)
+    end
+  end
+end

data/lib/middleman-presentation-core/test_helpers.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # Test helpers
+    module TestHelpers
+      # Helpers for tests
+      def ci?
+        ENV.key?('CI') || ENV.key?('TRAVIS')
+      end
+
+      def temporary_fixture_path(name)
+        File.expand_path("../../../tmp/fixtures/#{name}", __FILE__)
+      end
+
+      def temporary_fixture_exist?(name)
+        File.exist? File.expand_path("../../../tmp/fixtures/#{name}", __FILE__)
+      end
+
+      module_function :temporary_fixture_path
+    end
+  end
+end

data/lib/middleman-presentation-core/transformers/file_keeper.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    module Transformers
+      # Keep slide if it is a file
+      class FileKeeper
+        def transform(slides)
+          slides.keep_if { |slide| File.file? slide.path }
+        end
+      end
+    end
+  end
+end

data/lib/middleman-presentation-core/transformers/group_slides.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    module Transformers
+      # Group slides together
+      class GroupSlides
+        private
+
+        attr_reader :template
+
+        public
+
+        def initialize(template:)
+          @template = template
+        end
+
+        def transform(slides)
+          groups = Set.new
+
+          new_slides = slides.map do |slide|
+            if slide.group && groups.none? { |g| g.name == slide.group }
+              slide = group = SlideGroup.new name: slide.group, slides: slides.select { |s| s.group? slide.group }, template: template
+              groups << group
+            end
+
+            slide
+          end
+
+          new_slides - groups.map(&:slides).flatten
+        end
+      end
+    end
+  end
+end

data/lib/middleman-presentation-core/transformers/ignore_slides.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    module Transformers
+      # Ignore slides in list: delete them from list
+      class IgnoreSlides
+        private
+
+        attr_reader :ignore_file
+
+        public
+
+        def initialize(ignore_file:, ignore_file_builder: IgnoreFile)
+          @ignore_file = ignore_file_builder.new(ignore_file)
+
+          invalid_ignore_file = Pathname.new(ignore_file).dirname + Pathname.new('.slideignore')
+
+          message = "Invalid ignore file \"#{invalid_ignore_file}\" detected. I'm going to ignore it. Please use the correct one \"#{ignore_file}\"."
+          Middleman::Presentation.logger.warn message if invalid_ignore_file.exist?
+        end
+
+        def transform(slides)
+          slides.delete_if { |slide| ignore_file.ignore? slide }
+        end
+      end
+    end
+  end
+end

data/lib/middleman-presentation-core/transformers/remove_duplicate_slides.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    module Transformers
+      # Remove duplicates slides from list
+      class RemoveDuplicateSlides
+        private
+
+        attr_reader :additional_slides, :raise_error
+
+        public
+
+        def initialize(additional_slides: [], raise_error: false)
+          @additional_slides = additional_slides
+          @raise_error       = raise_error
+        end
+
+        def transform(slides)
+          temp_slides = (Array(slides) + Array(additional_slides)).uniq
+
+          duplicate_slides = temp_slides.each_with_object([]) do |e, a|
+            a << slides.select { |s| e.similar?(s) && !e.eql?(s) }
+          end.flatten
+
+          fail ArgumentError, Middleman::Presentation.t('errors.duplicate_slide_names', slide_names: duplicate_slides.map(&:file_name).to_list) if !duplicate_slides.blank? && raise_error
+
+          slides - duplicate_slides
+        end
+      end
+    end
+  end
+end

data/lib/middleman-presentation-core/transformers/sort_slides.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    module Transformers
+      # Sort slides
+      class SortSlides
+        def transform(slides)
+          slides.sort
+        end
+      end
+    end
+  end
+end

data/lib/middleman-presentation-core/utils.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # Utils module
+    module Utils
+      # Create zip archive from directory
+      #
+      # @param [String] source_directory
+      #   The source directory
+      #
+      # @param [String] destination_file
+      #   The zip file which should be created
+      #
+      # @param [String] prefix
+      #   A prefix for the zip file, e.g. dir1/dir2/ => dir1/dir2/zip_file.
+      #   Please mind the trailing '/'.
+      def zip(source_directory, destination_file, prefix: nil)
+        Zip.setup do |c|
+          c.on_exists_proc          = true
+          c.continue_on_exists_proc = true
+          c.unicode_names           = true
+          c.default_compression     = Zlib::BEST_COMPRESSION
+        end
+
+        Zip::File.open(destination_file, Zip::File::CREATE) do |file|
+          Dir.glob(File.join(source_directory, '**', '*')).each do |filename|
+
+            path = ''
+            path << prefix if prefix
+            path << Pathname.new(filename).relative_path_from(Pathname.new(source_directory)).to_s
+
+            file.add(path, filename)
+          end
+        end
+      end
+
+      module_function :zip
+    end
+  end
+end

data/lib/middleman-presentation-core/version.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+# Middleman
+module Middleman
+  # Presentation
+  module Presentation
+    VERSION = '0.16.0.alpha'
+  end
+end