RubyGems - foliokit - Versions diffs - 1.4.0 - Mend

foliokit 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (37) hide show

checksums.yaml +7 -0
data/README.md +17 -0
data/assets/foliokit.css +2 -0
data/assets/foliokit.js +18 -0
data/bin/foliokit +4 -0
data/lib/foliokit.rb +39 -0
data/lib/foliokit/article.rb +47 -0
data/lib/foliokit/asset_rendition.rb +54 -0
data/lib/foliokit/base.rb +7 -0
data/lib/foliokit/command.rb +81 -0
data/lib/foliokit/content_stack.rb +57 -0
data/lib/foliokit/event.rb +88 -0
data/lib/foliokit/exporter.rb +106 -0
data/lib/foliokit/issue.rb +92 -0
data/lib/foliokit/manifest.rb +72 -0
data/lib/foliokit/manifest_article.rb +55 -0
data/lib/foliokit/manifest_folio.rb +9 -0
data/lib/foliokit/modules/core.rb +9 -0
data/lib/foliokit/modules/element.rb +99 -0
data/lib/foliokit/overlay.rb +20 -0
data/lib/foliokit/overlay/overlay360.rb +50 -0
data/lib/foliokit/overlay/overlay_audio.rb +29 -0
data/lib/foliokit/overlay/overlay_base.rb +108 -0
data/lib/foliokit/overlay/overlay_button.rb +24 -0
data/lib/foliokit/overlay/overlay_container.rb +10 -0
data/lib/foliokit/overlay/overlay_hyperlink.rb +87 -0
data/lib/foliokit/overlay/overlay_image.rb +18 -0
data/lib/foliokit/overlay/overlay_imagepan.rb +36 -0
data/lib/foliokit/overlay/overlay_video.rb +42 -0
data/lib/foliokit/overlay/overlay_webview.rb +57 -0
data/lib/foliokit/package.rb +123 -0
data/lib/foliokit/slide.rb +9 -0
data/lib/foliokit/state.rb +6 -0
data/lib/foliokit/types/bounds.rb +47 -0
data/lib/foliokit/types/source.rb +9 -0
data/lib/foliokit/version.rb +3 -0
metadata +269 -0

data/lib/foliokit/issue.rb ADDED

@@ -0,0 +1,92 @@
+module Foliokit
+  class Issue
+    attr_reader :dir, :pages, :slides, :title, :description, :width, :height, :package
+    def initialize(file, dir, from: nil, to: nil)
+      @dir = dir
+      # Convert article to folio
+      @package = Foliokit::Package.new(file, dir, dir)
+      @title = package.manifest.title
+      @description = package.manifest.description
+      @width = package.manifest.device_width
+      @height = package.manifest.device_height
+      @from = from
+      @to = to
+      @pages = []
+      # Add Sub-Folio Content Stacks
+      if @package.manifest.article
+        convert_article!
+      else
+        if package.subfolios(package).any?
+          convert_folio!
+        else
+          convert_sub_folio!
+        end
+      end
+    end
+    def store_assets(assets_dir)
+      assets_dir.delete
+      dir.dir("assets").copy(assets_dir)
+    end
+    def export
+      document = Nokogiri::HTML("<html><head><title>#{title}</title><body></body></html>")
+      body = document.at("body")
+      pages.each do |page|
+        body << page.export(document)
+      end
+      document
+    end
+    def to_html
+      export.to_html
+    end
+    private
+    def convert_article!
+      manifest = package.subfolios(package).first.manifest
+      articles = manifest.content_stacks.first.articles[from..to]
+      if manifest.layout == "vertical"
+        @slides = [Slide.new(articles)]
+      else
+        @slides = articles.map do |article|
+          Slide.new([article])
+        end
+      end
+    end
+    def convert_folio!
+      subpackages = package.subfolios(package)[from..to]
+      @slides = subpackages.map do |subpackage|
+        slide = Slide.new
+        subpackage.manifest.content_stacks.each do |content_stack|
+          slide.articles.push(*content_stack.articles)
+        end
+        slide
+      end
+    end
+    def convert_sub_folio!
+      package.root_package = package
+      manifest = package.manifest
+      articles = manifest.content_stacks.first.articles[from..to]
+      @slides = [Slide.new(articles)]
+    end
+    def from
+      @from || 0
+    end
+    def to
+      if package.manifest.article
+        @to || (package.subfolios(package).first.manifest.content_stacks.first.articles.count - 1)
+      else
+        @to || (package.subfolios(package).count - 1)
+      end
+    end
+  end
+end

data/lib/foliokit/manifest.rb ADDED

@@ -0,0 +1,72 @@
+require 'foliokit/modules/element'
+module Foliokit
+  class Manifest
+    include Modules::Element
+    def self.element_base
+      element_reader :id, type: :s
+      element_reader :version, type: :s
+      element_reader :targetViewer, type: :s
+      element_reader :lastUpdated, type: :s
+      element_reader :date, type: :s
+      element_reader :bindingDirection, type: :s
+      element_reader :orientation, type: :s
+      element_reader :title, type: :s, selector: "metadata > magazineTitle", text: true
+      element_reader :description, type: :s, selector: "metadata > description", text: true
+      element_reader :article, type: :bool
+    end
+    def target_dimension
+      element.css("targetDimensions targetDimension").first
+    end
+    def wide_dimension
+      target_dimension["wideDimension"].to_i
+    end
+    def narrow_dimension
+      target_dimension["narrowDimension"].to_i
+    end
+    def device_height
+      (orientation == "landscape") ? narrow_dimension : wide_dimension
+    end
+    def device_width
+      (orientation == "landscape") ? wide_dimension : narrow_dimension
+    end
+    def referenced_ids
+      @_referenced_ids ||= begin
+        element.css("action[@target]").map { |action| hashify(action["target"]) } | element.css("action[@state]").map { |action| hashify(action["state"]) }
+      end
+    end
+    def valid_overlay_id?(id)
+      overlay_ids.include?(id)
+    end
+    def valid_referenced_id?(id)
+      referenced_ids.include?(id)
+    end
+    def overlay_ids
+      @_overlay_ids ||= begin
+        element.css("overlay[@id]").map { |overlay| hashify(overlay["id"]) }
+      end
+    end
+    def content_stack_ids
+      element.css("contentStacks contentStack").map { |s| s["id"] }
+    end
+    def content_stacks
+      element.css("contentStacks contentStack:not(:empty)").map { |element| ContentStack.new(element, package) }
+    end
+    def subfolios
+      element.css("contentStacks contentStack[@subfolio]:empty")
+    end
+  end
+end

data/lib/foliokit/manifest_article.rb ADDED

@@ -0,0 +1,55 @@
+module Foliokit
+  class ManifestArticle < Manifest
+    element_base
+    element_reader :layout, type: :s
+    def initialize(file, package)
+      article = Nokogiri::XML(file.read).css("article").first
+      # article["smoothScrolling"] = true
+      article.css("content page rendition").each do |rendition|
+        rendition.name = "assetRendition"
+        rendition["source"] = rendition.remove_attribute("href")
+      end
+      article.css("content page").each do |page|
+        page.name = "asset"
+      end
+      # build manifest
+      root_manifest = package.root_package.manifest
+      xml = Nokogiri::XML::Builder.new do |b|
+        b.folio(id: file.dir.name, version: root_manifest.version, targetViewer: root_manifest.target_viewer, lastUpdated: root_manifest.last_updated, date: root_manifest.date, bindingDirection: root_manifest.binding_direction, orientation: root_manifest.orientation, layout: article["layout"]) do
+          b.metadata do
+            b.description root_manifest.description
+            b.magazineTitle root_manifest.title
+            b.folioNumber root_manifest.title
+          end
+          b.targetDimensions do
+            b.targetDimension(wideDimension: root_manifest.wide_dimension, narrowDimension: root_manifest.narrow_dimension)
+          end
+          b.contentStacks do
+            b.contentStack(id: file.dir.name, version: article["version"], lastUpdated: article["lastUpdated"], smoothScrolling: article["smoothScrolling"], layout: article["layout"], alwaysDisplayOverlays: article["alwaysDisplayOverlays"], orientation: article["orientation"]) do
+              b.content do
+                b.regions do
+                  b.region do
+                    b.bounds do
+                      b.rectangle(x: 0, y: 0, width: article[:width], height: article[:height])
+                    end
+                  end
+                end
+                b.assets do |assets_node|
+                  article.css("content asset").each do |asset|
+                    b.parent << asset
+                  end
+                end
+                if file.dir.file("Overlays.xml").exists?
+                  b.parent << Nokogiri::XML(file.dir.file("Overlays.xml").read).css("overlays").first
+                end
+              end
+            end
+          end
+        end
+      end
+      super(xml.doc.root, package)
+    end
+  end
+end

data/lib/foliokit/manifest_folio.rb ADDED

@@ -0,0 +1,9 @@
+module Foliokit
+  class ManifestFolio < Manifest
+    element_base
+    def initialize(file, package)
+      super(Nokogiri::XML(file.read).root, package)
+    end
+  end
+end

data/lib/foliokit/modules/core.rb ADDED

@@ -0,0 +1,9 @@
+module Foliokit
+  module Modules
+    module Core
+      extend ActiveSupport::Concern
+      included do
+      end
+    end
+  end
+end

data/lib/foliokit/modules/element.rb ADDED

@@ -0,0 +1,99 @@
+module Foliokit
+  module Modules
+    module Element
+      extend ActiveSupport::Concern
+      included do |cls|
+        class << cls
+          attr_accessor :element_reader_attributes
+        end
+        def self.element_reader(name, options = {})
+          attr_accessor name.to_s.underscore
+          self.element_reader_attributes ||= {}
+          self.element_reader_attributes[name] = options
+        end
+        def hashify(value)
+          hashable = "#{package.id}/#{value}"
+          "id_#{Digest::MD5.hexdigest(hashable)}"
+        end
+        def self.element_collection(name, selector, klass = nil)
+          define_method :"#{name}" do
+            (element > selector).map do |el|
+              if klass and klass.class == Module
+                klass.factory(el, package)
+              elsif klass
+                klass.new(el, @package)
+              else
+                el
+              end
+            end
+          end
+        end
+        def self.element_xpath(name, selector, klass)
+          define_method :"#{name}" do
+            el = element.xpath(selector).first
+            if klass.class == Module
+              klass.factory(el, package)
+            else
+              klass.new(el, @package)
+            end
+          end
+        end
+        def self.element_xpath_collection(name, selector, klass)
+          define_method :"#{name}" do
+            element.xpath(selector).map do |el|
+              if klass.class == Module
+                klass.factory(el, package)
+              else
+                klass.new(el, @package)
+              end
+            end
+          end
+        end
+        attr_reader :package
+        private
+        attr_reader :element
+      end
+      def initialize(element, package)
+        @element = element
+        @package = package
+        self.class.element_reader_attributes.each do |name, options|
+          key = name.to_s.underscore
+          value = nil
+          target = element
+          if options[:selector]
+            if options[:selector].respond_to?(:call)
+              target = (target > instance_exec(options, &(options[:selector]))).first
+            else
+              target = (target > options[:selector]).first
+            end
+          end
+          unless target.nil?
+            if options[:type].class == Class
+              value = options[:type].convert(target, name, options)
+            else
+              attribute_name = options[:attribute] || name
+              value = options[:text] ? target.text.strip : target[attribute_name]
+              unless value.nil?
+                value = value.send(:"to_#{options[:type]}") unless options[:type].nil?
+                value.gsub!(/\s/, "_") if options[:clean]
+                value = hashify(value) if options[:hash]
+              end
+            end
+          end
+          value = options[:default] if value.nil? and options[:default]
+          instance_variable_set("@#{key}", value)
+        end
+      end
+    end
+  end
+end

data/lib/foliokit/overlay.rb ADDED

@@ -0,0 +1,20 @@
+module Foliokit
+  module Overlay
+    extend ActiveSupport::Autoload
+    autoload :OverlayBase
+    autoload :OverlayContainer
+    autoload :OverlayHyperlink
+    autoload :OverlayImage
+    autoload :OverlayButton
+    autoload :Overlay360
+    autoload :OverlayImagepan
+    autoload :OverlayAudio
+    autoload :OverlayVideo
+    autoload :OverlayWebview
+    def self.factory(el, package)
+      klass = "Foliokit::Overlay::Overlay#{el[:type].camelcase}".constantize
+      klass.new(el, package)
+    end
+  end
+end

data/lib/foliokit/overlay/overlay360.rb ADDED

@@ -0,0 +1,50 @@
+module Foliokit
+  module Overlay
+    class Overlay360 < OverlayBase
+      element_base
+      element_reader :clockwise, type: "bool", selector: "data", attribute: "clockwise"
+      element_reader :loopCount, type: "i", selector: "data > loopCount", text: true
+      element_reader :autoStart, type: "bool", selector: "data > autoStart", text: true
+      element_reader :autoStartDelay, type: "f", selector: "data > autoStartDelay", text: true
+      element_reader :tapEnabled, type: "bool", selector: "data > tapEnabled", text: true
+      element_reader :swipeEnabled, type: "bool", selector: "data > swipeEnabled", text: true
+      element_reader :circularViewEnabled, type: "bool", selector: "data > circularViewEnabled", text: true
+      element_reader :autoPlayStopAtLast, type: "bool", selector: "data > autoPlayStopAtLast", text: true
+      element_reader :framesPerSecond, type: "f", selector: "data > framesPerSecond", text: true
+      element_collection :images, "data > overlayAsset"
+      def tagname
+        "div"
+      end
+      def export(document, options = {})
+        node = super(document, options)
+        node["clockwise"] = clockwise
+        node["auto-start"] = auto_start
+        node["auto-start-delay"] = auto_start_delay
+        node["tap-enabled"] = tap_enabled
+        node["swipe-enabled"] = swipe_enabled
+        node["circular-view-enabled"] = circular_view_enabled
+        node["auto-play-stop-at-last"] = auto_play_stop_at_last
+        node["frames-per-second"] = frames_per_second
+        # build container
+        container = Nokogiri::XML::Node.new("div", document)
+        container["class"] = "circlr-container"
+        if node["swipe-enabled"] == "true"
+          container["class"] += " prevent-swipe-horizontal prevent-swipe-vertical"
+          container["touchable"] = true
+        end
+        node << container
+        # build images
+        images.each do |image|
+          img = Nokogiri::XML::Node.new("img", document)
+          img["src"] = package.store_asset(image.text)
+          container << img
+        end
+        node
+      end
+    end
+  end
+end

data/lib/foliokit/overlay/overlay_audio.rb ADDED

@@ -0,0 +1,29 @@
+module Foliokit
+  module Overlay
+    class OverlayAudio < OverlayBase
+      element_base
+      element_reader :audio_url, selector: "data > audioUrl", text: true
+      element_reader :keep_alive, type: "bool", selector: "data > continuePlayingInBackground", text: true
+      element_reader :autoStart, type: "bool", selector: "data > autoStart", text: true
+      element_reader :autoStartDelay, type: "f", selector: "data > autoStartDelay", text: true
+      def tagname
+        "audio"
+      end
+      def export(document, options = {})
+        node = super(document, options)
+        if audio_url.present?
+          source = Nokogiri::XML::Node.new("source", document)
+          package.apply_asset(source, "src", audio_url)
+          source["type"] = "audio/mpeg"
+          node << source
+        end
+        node["auto-start"] = true if auto_start
+        node["keep-alive"] = true if keep_alive
+        node["data-ignore"] = true
+        node
+      end
+    end
+  end
+end

data/lib/foliokit/overlay/overlay_base.rb ADDED

@@ -0,0 +1,108 @@
+module Foliokit
+  module Overlay
+    class OverlayBase
+      include Modules::Element
+      attr_reader :state, :section_index
+      def self.element_base
+        element_reader :id, hash: true
+        element_reader :type
+        element_reader :lastUpdated, type: :datetime
+        element_reader :bounds, type: Types::Bounds, selector: ->(options) { "#{package.manifest.orientation}Bounds > rectangle" }
+        element_reader :stateTransitionDuration, type: :f, selector: "data > stateTransitionDuration", text: true, default: 0.5
+        element_reader :swipe_event, attribute: "type", selector: "data > eventHandling > event"
+        element_reader :swipe_handler, attribute: "handler", selector: "data > eventHandling > event"
+        element_collection :states, "data > states > state", State
+        element_collection :events, "data > bindings > onevent", Event
+        element_collection :overlays, "data > children > overlay", Overlay
+      end
+      def tagname
+        "div"
+      end
+      def initialize(element, package)
+        super(element, package)
+        # calculate bounds
+        bounds_target = element.css("#{package.manifest.orientation}Bounds > rectangle")
+        bounds_target = element if bounds_target.empty?
+        bounds_target = bounds_target.first if bounds_target.kind_of?(Nokogiri::XML::NodeSet)
+        @bounds = Types::Bounds.convert(bounds_target, "bounds")
+        # set initial state
+        @state = states.first
+      end
+      def stateful?
+        !!state
+      end
+      def export(document, parent: nil, section_index: nil)
+        @section_index = section_index
+        node = Nokogiri::XML::Node.new(tagname.to_s, document)
+        # node["id"] = id if package.manifest.valid_referenced_id?(id)
+        node["id"] = id
+        node["class"] = "overlay-#{type}" unless tagname.include? "overlay"
+        style = {
+          width: "#{bounds.width}px",
+          height: "#{bounds.height}px",
+          left: "#{bounds.x}px",
+          top: "#{bounds.y}px"
+        }
+        if parent&.stateful?
+          node["name"] = id
+          if state_transition_duration != 0
+            style[:transition] = "opacity #{state_transition_duration}s"
+          elsif parent.state_transition_duration != 0
+            style[:transition] = "opacity #{parent.state_transition_duration}s"
+          else
+            style[:transition] = "opacity 0s"
+          end
+        end
+        node["style"] = style.map { |k, v| "#{k}:#{v}" }.join(";")
+        # stateful behaviour
+        node["active-state"] = state.id if state
+        # event / action behaviour
+        bindings = {}
+        unless swipe_event.nil?
+          if swipe_event == "verticalSwipe"
+            node["class"] += " prevent-swipe-vertical"
+          elsif swipe_event == "horizontalSwipe"
+            node["class"] += " prevent-swipe-horizontal"
+          else
+            node["class"] += " prevent-swipe-horizontal prevent-swipe-vertical"
+          end
+          node["touchable"] = true
+          if swipe_handler == "changeState"
+            bindings[swipe_event] = { selector: swipe_handler.downcase }
+          elsif swipe_handler == "scroll"
+            node["scroll"] = swipe_event.gsub("Swipe", "")
+          end
+        end
+        if events.any?
+          events.each do |event|
+            actions = event.all_actions
+            if actions.any?
+              bindings[event.name] = event.all_actions.map(&:to_hash)
+            end
+          end
+        end
+        if bindings.any?
+          node["bindings"] = JSON.dump(bindings)
+          if bindings["click"] or bindings["horizontalSwipe"] or bindings["verticalSwipe"]
+            node["touchable"] = true
+          end
+        end
+        overlays.each do |overlay|
+          child_node = overlay.export(document, parent: self, section_index: section_index)
+          node << child_node unless child_node.nil?
+        end
+        node
+      end
+    end
+  end
+end