middleman-presentation-core 0.16.0.alpha

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

@@ -0,0 +1,198 @@
+# encoding, utf-8
+module Middleman
+  module Presentation
+    # Configuration for presentation extension
+    class ApplicationConfig < FeduxOrgStdlib::AppConfig
+      option :title, nil
+      option :subtitle, nil
+      option :project_id, nil
+      option :version, nil
+
+      option :date, Time.now.strftime('%Y-%m-%d %H:%M:%S')
+      option :speaker, process_environment.fetch('USER')
+      option :license, 'CC BY 4.0'
+      option :bower_directory, 'vendor/assets/components'
+      option :author, `git config user.name`.strip.blank? ? process_environment.fetch('USER') : `git config user.name`.strip
+      option :email, `git config user.email`.strip.blank? ? 'noemail@example.org' : `git config user.email`.strip
+      option :description,  nil
+      option :homepage,  nil
+      option :company,  nil
+      option :location,  nil
+      option :audience,  nil
+      option :phone_number,  nil
+      option :email_address,  nil
+      option :github_url,  nil
+
+      option :theme, name: 'middleman-presentation-theme-default',
+                     github: 'maxmeyer/middleman-presentation-theme-default',
+                     importable_files: [
+                       %r{stylesheets/middleman-presentation-theme-default.scss$}
+                     ],
+                     loadable_files: [
+                       /.*\.png$/
+                     ]
+
+      option :plugin_prefix, 'middleman-presentation'
+
+      option :components, []
+
+      option :width, 960
+      option :height, 700
+      option :margin, 0.1
+      option :min_scale, 0.2
+      option :max_scale, 1.0
+      option :activate_center, true
+      option :activate_controls, true
+      option :activate_embedded, false
+      option :activate_fragments, true
+      option :activate_history, true
+      option :activate_keyboard, true
+      option :activate_loop, false
+      option :activate_mouse_wheel, true
+      option :activate_overview, true
+      option :activate_progress, true
+      option :activate_rtl, false
+      option :activate_slide_number, true
+      option :activate_touch, true
+      option :auto_slide, 0
+      option :auto_slide_stoppable, true
+      option :default_background_transition, 'default'
+      option :default_transition_speed, 'default'
+      option :default_transition_type, 'linear'
+      option :hide_address_bar, true
+      option :parallax_background_image, ''
+      option :parallax_background_size, ''
+      option :preview_links, false
+      option :view_distance, 3
+
+      option :install_assets, true
+      option :initialize_git, true
+      option :check_for_bower, true
+      option :clear_source, true
+      option :create_predefined_slides, true
+      option :presentation_language, nil
+      option :cli_language, nil
+      option :default_version_number, 'v0.0.1'
+
+      option :plugins, []
+
+      option :slides_directory, 'slides'
+      option :slides_ignore_file, '.slidesignore'
+
+      option :create_stylesheets_directory, true
+      option :create_javascripts_directory, true
+      option :create_images_directory, true
+      option :theme_prefix, 'middleman-presentation-theme'
+
+      option :edit_created_slide, false
+      option :edit_changed_slide, false
+      option :editor_command, FeduxOrgStdlib::Editor.new.path
+      option :error_on_duplicates, true
+
+      option :force_create_presentation, false
+      option :debug_mode, false
+      option :exportable_options, %w(
+        activate_center
+        activate_controls
+        activate_embedded
+        activate_fragments
+        activate_history
+        activate_keyboard
+        activate_loop
+        activate_mouse_wheel
+        activate_overview
+        activate_progress
+        activate_rtl
+        activate_slide_number
+        activate_touch
+        activeate_history
+        audience
+        author
+        auto_slide
+        auto_slide_stoppable
+        bower_directory
+        company
+        date
+        default_background_transition
+        default_transition_speed
+        default_transition_type
+        description
+        email_address
+        github_url
+        height
+        hide_address_bar
+        homepage
+        license
+        location
+        margin
+        max_scale
+        min_scale
+        parallax_background_image
+        parallax_background_size
+        phone_number
+        preview_links
+        project_id
+        speaker
+        subtitle
+        title
+        version
+        view_distance
+        width
+      )
+
+      option :loadable_assets_for_installed_components, [
+        /\.png$/,
+        /\.gif$/,
+        /\.jpg$/,
+        /\.jpeg$/,
+        /\.svg$/,
+        /\.webp$/,
+        /\.eot$/,
+        /\.otf$/,
+        /\.svc$/,
+        /\.woff$/,
+        /\.ttf$/
+      ]
+
+      option :sources_directory, 'source'
+      option :images_directory, 'images'
+      option :scripts_directory, 'javascripts'
+      option :stylesheets_directory, 'stylesheets'
+      option :fonts_directory, 'fonts'
+      option :build_directory, 'build'
+
+      option :minify_assets, false
+
+      option :runtime_environment, ENV['MP_ENV'].to_s.to_sym
+      option :use_regex, false
+
+      option :debugging_libraries, %w(pry byebug)
+
+      def preferred_configuration_file
+        ::File.expand_path(::File.join('~', '.config', _application_name, _config_file))
+      end
+
+      private
+
+      def _application_name
+        'middleman-presentation'
+      end
+
+      def _config_name
+        'application'
+      end
+
+      def _allowed_config_file_paths
+        [
+          ::File.expand_path(::File.join(ConfigurationFile.new(raise_error: false).directory.to_s, format('.%s%s', _application_name, _config_file_suffix))),
+          ::File.expand_path(::File.join(ConfigurationFile.new(raise_error: false).directory.to_s, format('%s%s', _application_name, _config_file_suffix))),
+          ::File.expand_path(::File.join('~', '.config', _application_name, _config_file)),
+          ::File.expand_path(::File.join('~', format('.%s', _application_name), _config_file)),
+          ::File.expand_path(::File.join('~', format('.%s%s', _application_name, _config_file_suffix))),
+          ::File.expand_path(::File.join('~', format('.%src', _application_name))),
+          ::File.expand_path(::File.join('/etc', _application_name, _config_file))
+        ]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,103 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # External asset
+    #
+    # It represents a single asset - an image, a stylesheets, a font etc. An
+    # assets will be placed in a default directory by `middleman-sprockes`. To
+    # change the default directory one needs to tell the `Asset`-class that on
+    # initialization.
+    class Asset
+      include Comparable
+      include FeduxOrgStdlib::Roles::Typable
+
+      private
+
+      attr_reader :importable, :loadable
+
+      public
+
+      attr_reader :source_path, :destination_path, :relative_source_path
+      attr_writer :importable, :loadable
+
+      # Create instance
+      #
+      # @param [String] source_path
+      #   The source path for the asset
+      #
+      # @param [String] destination_path
+      #   The directory where the asset should be placed when building the
+      #   static version of the web application
+      def initialize(source_path:, relative_source_path:, destination_path:, importable: false, loadable: false)
+        @source_path          = Pathname.new(source_path)
+        @relative_source_path = Pathname.new(relative_source_path)
+        @importable           = importable
+        @loadable             = loadable
+
+        self.destination_path = destination_path
+      end
+
+      def import_path
+        relative_source_path.dirname + relative_source_path.basename('.*')
+      end
+
+      def load_path
+        relative_source_path
+      end
+
+      def destination_path=(value)
+        @destination_path = value.blank? ? nil : Pathname.new(value)
+      end
+
+      # Destination path resolver
+      def destination_path_resolver
+        return proc { |_| destination_path } if destination_path
+
+        proc {}
+      end
+
+      # @private
+      def hash
+        source_path.hash
+      end
+
+      # @private
+      def eql?(other)
+        source_path.eql? other.source_path
+      end
+
+      # @private
+      def <=>(other)
+        source_path <=> other.source_path
+      end
+
+      # Is this asset importable?
+      #
+      # If it is importable, one can use it in `application.js` or
+      # `application.scss`.
+      #
+      # @return [true, false]
+      #   The result of check
+      def importable?
+        importable == true
+      end
+
+      # Is this asset loadable?
+      #
+      # If it is importable, it will be placed in build directory by sprockets.
+      #
+      # @return [true, false]
+      #   The result of check
+      def loadable?
+        loadable == true
+      end
+
+      # Merge data from other asset
+      def merge!(other)
+        self.importable            = true if other.importable?
+        self.loadable              = true if other.loadable?
+        self.destination_path = other.destination_path if destination_path.blank?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # A asset component
+    #
+    # It represents a asset component. A asset component can contain
+    # JavaScript-files, stylesheets, images, fonts, ... . A asset component
+    # knows where to get a the files from in filesystem, which version of the
+    # component is required and which JavaScript-files and stylesheets should
+    # be includes in "javascripts/application.js" and
+    # "stylesheets"application.scss".
+    class AssetComponent < Component
+      attr_reader :path, :base_path
+
+      # An asset component
+      #
+      # @see [Component] For all other params
+      #
+      # @param [String] path
+      #   The directory where all assets files can be found which belong to this component
+      def initialize(path:, base_path: path, name: path, **args)
+        super(**args)
+
+        @path = Pathname.new(path)
+        @name = name
+        @base_path = Pathname.new(base_path)
+      end
+
+      def root_directory; end
+
+      def root_directory=(*); end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # List of assets
+    #
+    # The class takes a list of components and generates a list of assets from
+    # this. It also includes `Enumerable`
+    class AssetList
+      include Enumerable
+
+      private
+
+      attr_reader :directory, :creator, :store, :components
+
+      public
+
+      def initialize(components, creator: Asset, store: AssetStore.new)
+        @components = components
+        @store     = store
+        @creator   = creator
+
+        read_in_assets
+      end
+
+      # Iternate over each component and execute block
+      #
+      # @yield
+      #   Block which is executed for each component
+      def each(&block)
+        to_a.each(&block)
+      end
+
+      private
+
+      def to_a
+        store.assets
+      end
+
+      def read_in_assets
+        components.each do |c|
+          add_assets(
+            c.path,
+            base_path: c.base_path,
+            output_paths: c.output_paths,
+            loadable_files: c.loadable_files,
+            importable_files: c.importable_files,
+            ignorable_files: c.ignorable_files
+          )
+        end
+      end
+
+      def add_assets(search_path, base_path:, output_paths:, loadable_files:, importable_files:, ignorable_files:)
+        search_path = File.join(File.expand_path(search_path), '**', '*')
+
+        Dir.glob(search_path).sort.each do |p|
+          next unless File.file? p
+
+          # rubocop:disable Style/CaseEquality
+          next if !ignorable_files.blank? && Array(ignorable_files).any? { |f| Regexp.new(f) === p }
+          # rubocop:enable Style/CaseEquality
+
+          # assets will be find multiple times: vendor/ will find assets in vendor/assets as well
+          new_path   = File.join(*Pathname.new(p).relative_path_from(Pathname.new(base_path)).each_filename.to_a)
+          next if new_path.to_s.start_with?('assets')
+
+          # rubocop:disable Style/CaseEquality
+          output_path = output_paths.find(proc { [] }) { |pattern, _| pattern === p }.last
+          # rubocop:enable Style/CaseEquality
+
+          asset = creator.new(source_path: p, relative_source_path: new_path, destination_path: output_path)
+
+          # rubocop:disable Style/CaseEquality
+          asset.loadable   = true if loadable_files.any? { |regexp| regexp === p }
+          asset.importable = true if importable_files.any? { |regexp| regexp === p }
+          # rubocop:enable Style/CaseEquality
+
+          store.add asset
+        end
+
+        store
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # Store which stores assets
+    #
+    # @example Add asset
+    #
+    #   store = AssetStore.new
+    #   store.add <asset>
+    class AssetStore
+      include Enumerable
+
+      private
+
+      attr_reader :store
+
+      public
+
+      def initialize
+        @store = []
+      end
+
+      # Add asset
+      def add(asset)
+        if (existing_asset = @store.find { |a| a.source_path == asset.source_path })
+          existing_asset.merge! asset
+        else
+          store << asset
+        end
+      end
+
+      # Merge list
+      #
+      # @param [#each] list_or_store
+      #   The list to merge
+      def merge(list_or_store)
+        list_or_store.each { |a| add a }
+      end
+
+      # All uniq assets
+      def assets
+        store.uniq
+      end
+
+      # Iterate over assets
+      def each(&block)
+        assets.each(&block)
+      end
+
+      # Find all assets matching criteria
+      #
+      # @param [String] source_path (optional)
+      #   Source path to be used
+      #
+      # @yield
+      #   Search criteria
+      def find_all(source_path: nil, &block)
+        if block_given?
+          store.select(&block)
+        else
+          store.select { |a| a.source_path == source_path }
+        end
+      end
+
+      # Find asset matching criteria
+      #
+      # @see #find_all
+      def find(**args, &block)
+        find_all(**args, &block).first
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # Loads all default helpers, plugins, components
+    class AssetsLoader
+      private
+
+      attr_reader :application, :bower_directory
+
+      public
+
+      def initialize(bower_directory:)
+        @application     = Middleman::Presentation
+        @bower_directory = bower_directory
+      end
+
+      def load_for_bower_update
+        set_bower_directory
+
+        activate_core_plugins
+        activate_user_plugins
+
+        add_components_required_in_config_file
+        add_theme_component
+      end
+
+      def load_for_asset_aggregators
+        set_bower_directory
+
+        activate_core_plugins
+        activate_user_plugins
+
+        add_components_required_in_config_file
+        add_theme_component
+
+        add_assets_from_components
+      end
+
+      def load_at_presentation_runtime
+        set_bower_directory
+
+        add_assets_from_bower_directory
+
+        activate_core_plugins
+        activate_user_plugins
+
+        add_components_required_in_config_file
+        add_theme_component
+
+        add_assets_from_components
+      end
+
+      private
+
+      def set_bower_directory
+        application.components_manager.bower_directory = bower_directory if bower_directory
+      end
+
+      def activate_core_plugins
+        application.plugins_manager.activate_plugin('middleman-presentation-helpers')
+      end
+
+      def activate_user_plugins
+        application.plugins_manager.activate_plugin(*application.config.plugins)
+      end
+
+      def add_components_required_in_config_file
+        return if application.config.components.blank?
+
+        application.config.components.each do |c|
+          application.components_manager.add FrontendComponent.new(**c)
+        end
+      end
+
+      def add_theme_component
+        return if application.config.theme.blank?
+
+        application.components_manager.add FrontendComponent.new(**application.config.theme)
+      end
+
+      def add_assets_from_bower_directory
+        application.components_manager.add AssetComponent.new(path: bower_directory, loadable_files: Middleman::Presentation.config.loadable_assets_for_installed_components)
+      end
+
+      # Load default components
+      def add_assets_from_components
+        components_list = Middleman::Presentation::AssetList.new(
+          application.components_manager.available_components
+        )
+
+        application.assets_manager.load_from_list components_list
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # Manager for assets
+    #
+    # It knows about all assets. This information is used when adding assets to
+    # `sprockets`. It gets its information normally from through `plugins` or
+    # through reading the bower components directory in filesystem.
+    class AssetsManager
+      private
+
+      attr_reader :store
+
+      public
+
+      def initialize(
+        store: AssetStore.new
+      )
+        @store   = store
+      end
+
+      # Add asset
+      def add(asset)
+        store.add asset
+      end
+
+      # Return assets
+      def know?(asset)
+        store.include? asset
+      end
+
+      # Show assets which should be imported
+      def to_s
+        data = store.assets.sort.reduce([]) do |a, e|
+          a << {
+            source_path: e.relative_source_path,
+            destination_path: e.destination_path,
+            loadable: e.loadable?,
+            importable: e.importable?
+          }
+        end
+
+        List.new(data).to_s(fields: [:source_path, :destination_path, :loadable, :importable])
+      end
+
+      # Iterate over each loadable asset
+      def each_loadable_asset(&block)
+        store.select { |a| a.valid? && a.loadable? }.each(&block)
+      end
+
+      # Iterate over each importable asset
+      def each_importable_stylesheet(&block)
+        each_importable_asset.select(&:stylesheet?).each(&block)
+      end
+
+      # Iterate over each importable asset
+      def each_importable_javascript(&block)
+        each_importable_asset.select(&:script?).each(&block)
+      end
+
+      # Load assets from list
+      def load_from_list(*lists)
+        lists.flatten.each { |l| store.merge l }
+      end
+
+      private
+
+      def each_importable_asset(&_block)
+        store.select { |a| a.valid? && a.importable? }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# encoding: utf-8
+module Middleman
+  module Presentation
+    # Cache for objects
+    #
+    # It can be used to run 'block' on `#map` only if new objects have been
+    # added.
+    class Cache
+      include Enumerable
+
+      private
+
+      attr_reader :store
+      attr_accessor :clean
+
+      public
+
+      def initialize(store: [])
+        @store = store
+        @clean = true
+      end
+
+      def add(obj)
+        store << obj
+        self.clean = false
+
+        self
+      end
+
+      def mark_dirty
+        self.clean = false
+
+        self
+      end
+
+      def each(&block)
+        return if clean
+
+        self.clean = true
+
+        store.each(&block)
+      end
+
+      def to_a
+        store.to_a
+      end
+    end
+  end
+end