markdown_videos 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: bca9063d5eb7dd88466325ac8100073c5111e805
-  data.tar.gz: d2a304156bb0a6a24753a98ca4e810353d72d9e7
+  metadata.gz: b322a4f32f6b252011b2d3f74c86bbdc11ca30b0
+  data.tar.gz: a1a965e73e842d1e1e873ea3646d69e21e09dbc6
 SHA512:
-  metadata.gz: a0da59e38bf6f22c6ae1ae9d1c4b29160f39cb124f61edb8549587c87aabb13bac1e9aae8dcc5182907f736e14b067e51971b2a40a4f458eac6ad8211172231f
-  data.tar.gz: b4388cf7f60178543d928c332da087ce20f3fe030d52f1608ba7341ff2e864014e29e1a077d5448998ccb7786ca06ce418ea9731ed05474048ca4f26c2692bb2
+  metadata.gz: 7c7b519ac8d8995cc303ec22de89f2e83acbb6e29364905f5d8967538f09370a08c998c6221499831f1eb180265c77a95896b9d6703a35fbbbca3772838c5177
+  data.tar.gz: e03271030f4aa77d050533300d4a8ee503ec08c44aa8a777b9619d85e638a21a57e0f65f21a13ca9bc2362912fd189dd2295ba202a88730b5ca9eb4dbbf727c4

data/lib/markdown_videos/base.rb

@@ -1,5 +1,5 @@
-require "markdown_videos/renderer"
 require "markdown_videos/services"
+require "markdown_videos/renderer"
 require "markdown_videos/configuration"
 
 module MarkdownVideos

data/lib/markdown_videos/configuration.rb

@@ -3,9 +3,9 @@ module MarkdownVideos
   class Configuration
 
     attr_accessor :wrapper,
-                   :classname
+                  :class_name
 
-    # if defined, needs to contain `%s` where HTML markup should be included
+    # if defined, needs to contain `%s` where rendered HTML element should be included
     # e.g.: WRAPPER = '<p class="embed-responsive embed-responsive-16by9">%s</p>'.freeze
     def wrapper
       @wrapper || nil
@@ -16,9 +16,9 @@ module MarkdownVideos
       @wrapper = wrapper
     end
 
-    # extra classname(s) added to embed HTML markup
-    def classname
-      @classname || nil
+    # extra class_name(s) added to embed HTML element
+    def class_name
+      @class_name || nil
     end
 
   end

data/lib/markdown_videos/renderer.rb

@@ -4,51 +4,37 @@ module MarkdownVideos
 
   class Renderer
 
-    def initialize(string, options = {})
-      @string = string
+    attr_reader :markdown_text
+
+    def initialize(markdown_text, options = {})
+      @markdown_text = markdown_text
       @options = {
         wrapper: MarkdownVideos.defaults.wrapper,
-        classname: MarkdownVideos.defaults.classname
+        class_name: MarkdownVideos.defaults.class_name
       }.merge(options || {})
     end
 
     def render
-      MarkdownVideos::SERVICES.keys.each do |service|
-        @string = render_service(service)
-      end
-      @string
-    end
+      @markdown_text.gsub(/!\[([^\]]*)\]\(([^)]+)\)/) do
+        rendered = nil
+        match_data = Regexp.last_match
+        markdown = {
+          alt_text: match_data[1],
+          url: match_data[2]
+        }
 
-    private
+        service_class = find_service_for(markdown[:url])
 
-    def render_service(service)
-      values = MarkdownVideos::SERVICES[service]
-      @string.gsub(values[:regexp]) do |match|
-        match_data = Regexp.last_match
-        id = match_data[3]
-        title = match_data[1]
-        url = Addressable::URI.parse(match_data[2])
-        url_parameters = url.query_values || {}
-
-        html_markup = sprintf(values[:markup],
-                              CGI::escapeHTML(title),
-                              service_url(service, id, url_parameters),
-                              @options[:classname].nil? ? "" : " class=\"#{@options[:classname]}\"")
-
-        if @options[:wrapper].nil?
-          html_markup
+        if service_class
+          service_class.new(markdown[:alt_text], markdown[:url], @options).render
         else
-          sprintf(@options[:wrapper], html_markup)
+          match_data.string
         end
       end
     end
 
-    def service_url(service, id, url_parameters = {})
-      url = sprintf(MarkdownVideos::SERVICES[service][:url], id)
-      uri = Addressable::URI.parse(url)
-      url_parameters.select! { |k, v| MarkdownVideos::SERVICES[service][:url_parameters].include?(k.to_sym) && (!v.nil? || !v.empty?) } if url_parameters
-      uri.query_values = url_parameters unless url_parameters.nil? || url_parameters.empty?
-      uri.to_s
+    def find_service_for(url)
+      MarkdownVideos::SERVICES.find { |service_class| service_class.support(url) }
     end
 
   end

data/lib/markdown_videos/services/service_base.rb

@@ -0,0 +1,137 @@
+module MarkdownVideos
+  module Services
+
+    class ServiceBase
+
+      attr_accessor :resource_id,
+                    :alt_text,
+                    :markdown_url,
+                    :markdown_url_data,
+                    :width,
+                    :height,
+                    :wrapper,
+                    :class_name
+
+      def self.support(markdown_url)
+        markdown_url =~ regexp
+      end
+
+      # URL matcher
+      def self.regexp
+        raise NotImplementedError "#{self.class} should implement #regexp method"
+      end
+
+
+      def initialize(alt_text, markdown_url, options)
+        @alt_text = alt_text
+        @markdown_url = markdown_url
+        options.each { |option, value| self.send("#{option}=", value) }
+      end
+
+      # URL to be consumed by #to_html
+      def url
+        raise NotImplementedError "#{self.class} should implement #url method"
+      end
+
+      # List of authorized url parameters
+      #
+      # @return [Array<Symbol>] e.g.: [:start]
+      def url_parameters
+        []
+      end
+
+      def width
+        @width || 500
+      end
+
+      def height
+        @height || 281
+      end
+
+      # @return [String] escaped alternative text given through markdown syntax
+      def alt_text
+        CGI::escapeHTML(@alt_text)
+      end
+
+      # @return [String] resource ID of the service resource rendered base on given URL
+      def resource_id
+        @resource_id ||= markdown_url_data[2]
+      end
+
+      # @return [MatchData] match data from matching URL to service regexp
+      def markdown_url_data
+        @markdown_url_data ||= self.class.regexp.match(markdown_url)
+      end
+
+      # @return [String] service URL to be consumed by #to_html
+      def service_url
+        given_url = Addressable::URI.parse(markdown_url)
+        given_url_parameters = given_url.query_values || {}
+        given_url_parameters.select! { |attribute, value| url_parameters.include?(attribute.to_sym) && (!value.nil? || !value.empty?) }
+
+        service_url = Addressable::URI.parse(url)
+        service_url.query_values = given_url_parameters unless given_url_parameters.nil? || given_url_parameters.empty?
+        service_url.to_s
+      end
+
+      # Default HTML rendering
+      #
+      # @retun [String] markup to render
+      def to_html
+        "<iframe #{html_dom_properties}></iframe>"
+      end
+
+      # Renders the set of HTML attributes
+      #
+      # @return [String] string of dom properties
+      def html_dom_properties
+        html_attributes.map { |k, v| render_param(k, v) }.compact.join(" ")
+      end
+
+      # Default set of HTML attributes for default iframe element
+      #
+      # @return [Hash]
+      def html_attributes
+        {
+          title: alt_text,
+          src: service_url,
+          width: width,
+          height: height,
+          class: class_name,
+          frameborder: "0",
+          webkitallowfullscreen: true,
+          mozallowfullscreen: true,
+          allowfullscreen: true
+        }
+      end
+
+      def render
+        if wrapper
+          sprintf(wrapper, to_html)
+        else
+          to_html
+        end
+      end
+
+      private
+
+      # Renders HTML5 attribute, meant to be used with `Hash.map`
+      #
+      # @param attribute [Symbol, String]
+      # @param value [true, String, false] `true` if you want only the attribute. `false`, `nil` or empty String to skip attribute
+      #
+      # @return [String] attribute="value"
+      def render_param(attribute, value)
+        if value == true
+          attribute.to_s
+        elsif !value || value.to_s.empty?
+          nil
+        else
+          "#{attribute}=\"#{value}\""
+        end
+      end
+
+    end
+  end
+
+end

data/lib/markdown_videos/services/vimeo_service.rb

@@ -0,0 +1,15 @@
+module MarkdownVideos::Services
+
+  class VimeoService < ServiceBase
+
+    def self.regexp
+      /(https?:\/\/(?:(?:player\.)?vimeo.com\/(?:video\/)?)([0-9]{4,16})\??([\w\-\=]+)?)/
+    end
+
+    def url
+      "https://player.vimeo.com/video/#{resource_id}"
+    end
+
+  end
+
+end

data/lib/markdown_videos/services/youtube_service.rb

@@ -0,0 +1,27 @@
+module MarkdownVideos::Services
+
+  class YoutubeService < ServiceBase
+
+    def self.regexp
+      /(https?:\/\/(?:youtu.be\/|www.youtube.com\/(?:watch\?v=|embed\/))([\w\-]{4,16})\??([\w\-\=]+)?)/
+    end
+
+    def width
+      560
+    end
+
+    def height
+      315
+    end
+
+    def url
+      "https://www.youtube.com/embed/#{resource_id}"
+    end
+
+    def url_parameters
+      [:start]
+    end
+
+  end
+
+end

data/lib/markdown_videos/services.rb

@@ -1,33 +1,21 @@
 module MarkdownVideos
 
-  #
-  # Supported services list
-  #
-  # regexp:         Regexp must capture in 1) title, 2) full url and 3) video id
-  # markup:         HTML markup rendered with first %s being altertive text and second %s being the video URL (iFrame src)
-  #                   and third %s being class attribute declaration location (make sure there is only one space after, not before)
-  # url:            URL of service included in the markup, with first %s corresponding to video's ID
-  # url_parameters: List of authorized URL parameters
-  #
+  # This file `require` the ServiceBase class
+  # and all `_service` files present in services folder
 
-  SERVICES = {
+  require_relative "services/service_base"
 
-    # http://rubular.com/r/8Xb4s9ukXy
-    youtube: {
-      regexp: /!\[([^\]]*)\]\((https?:\/\/(?:youtu.be\/|www.youtube.com\/(?:watch\?v=|embed\/))([\w\-]{4,16})\??([\w\-\=]+)?)\)/,
-      markup: '<iframe width="560" height="315" title="%s" src="%s"%s frameborder="0" allowfullscreen></iframe>',
-      url: "https://www.youtube.com/embed/%s",
-      url_parameters: [:start]
-    },
+  Dir[File.expand_path("../services/*_service.rb", __FILE__)].each do |path|
+    require path
+  end
 
-    # http://rubular.com/r/Upo2dmGbIJ
-    vimeo: {
-      regexp: /!\[([^\]]*)\]\((https?:\/\/(?:(?:player\.)?vimeo.com\/(?:video\/)?)([0-9]{4,16})\??([\w\-\=]+)?)\)/,
-      markup: '<iframe title="%s" src="%s" width="500" height="281"%s frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>',
-      url: "https://player.vimeo.com/video/%s",
-      url_parameters: []
-    }
+  # Build a static list of available Service classes
+  service_classes = MarkdownVideos::Services.constants.select do |class_name|
+    MarkdownVideos::Services.const_get(class_name).is_a?(Class) && class_name =~ /Service$/
+  end
 
-  }.freeze
+  SERVICES = service_classes.map do |class_name|
+    Object.const_get("MarkdownVideos::Services::#{class_name}")
+  end
 
 end

data/lib/markdown_videos/version.rb

@@ -1,3 +1,3 @@
 module MarkdownVideos
-  VERSION = "0.1.1".freeze
+  VERSION = "1.0.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: markdown_videos
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Capripot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -52,7 +52,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.4'
-description: Markdown syntax video parser
+description: Markdown syntax parser to render embed services
 email: capripot@gmail.com
 executables: []
 extensions: []
@@ -63,6 +63,9 @@ files:
 - lib/markdown_videos/configuration.rb
 - lib/markdown_videos/renderer.rb
 - lib/markdown_videos/services.rb
+- lib/markdown_videos/services/service_base.rb
+- lib/markdown_videos/services/vimeo_service.rb
+- lib/markdown_videos/services/youtube_service.rb
 - lib/markdown_videos/version.rb
 homepage: https://github.com/capripot/markdown_videos
 licenses:
@@ -76,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
@@ -88,6 +91,6 @@ rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: A gem that provides ability to parse any string containing image markdown
-  syntax into appropriate video HTML embed based on URL.
+  syntax into appropriate HTML embed service based on URL.
 test_files: []
 has_rdoc: false