vime_view_components 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36f096f677d914a9ea6b94f10e0c343225fb420a89896e6fb8926e5cc7259cd9
+  data.tar.gz: 1def0ea3af02fa441578e156daa8d47f1299c678cc212eea2f3d0691d566c0e2
+SHA512:
+  metadata.gz: 694dc48794d951e1038ee3eedaae8d225a647165b8efed812e12c020ccbc506a0b2449057b38d915111c60b93dffc32cce7c5cabaf8534099717e83aa84150b7
+  data.tar.gz: 472aa8cd079430dc1a0a28668bf331b75aa498797cbee63ea39c1c0b732635b8dfaf28db5d3e8b819b499cfe0ad8fbdb975ac81c31fe8ecd7f1f159d824fe745

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 asgerb
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# vime_view_components
+
+![Ruby](https://github.com/asgerb/vime_view_components/workflows/Ruby/badge.svg)
+
+ViewComponents for vime.js
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vime_view_components'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vime_view_components
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/asgerb/vime_view_components.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/vime/component.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "dry-initializer"
+
+module Vime
+  class Component < ViewComponent::Base
+    extend Dry::Initializer
+
+    module Types
+      include Dry.Types()
+
+      CrossOrigin = String.enum("", "anonymous", "use-credentials")
+      Pin = String.enum("bottomLeft", "bottomRight", "topLeft", "topRight")
+      Preload = String.enum("", "auto", "metadata", "none")
+      TooltipDirection = String.enum("left", "right")
+      TooltipPosition = String.enum("bottom", "top")
+    end
+
+    option :class, type: Types::Array.of(Types::String).optional, optional: true, as: :classes
+    option :data, type: Types::Hash.optional, optional: true
+    option :style, type: Types::String.optional, optional: true
+
+    def dom_attrs
+      {
+        class: classes,
+        data: data,
+        style: style,
+      }
+    end
+
+    private
+      def process_attrs(attrs)
+        attrs
+          .deep_transform_keys(&:to_s)
+          .deep_transform_keys(&:dasherize)
+          .reject { |_, v| v.nil? }
+      end
+  end
+end

data/lib/vime/core/embed.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# @see https://vimejs.com/components/core/embed
+
+module Vime
+  module Core
+    class Embed < Component
+      option :embed_src, type: Types::String
+      option :media_title, type: Types::String, optional: true
+      option :origin, type: Types::String, optional: true
+      option :params, type: Types::String, optional: true
+
+      def call
+        content_tag "vime-embed", content, process_attrs(dom_attrs)
+      end
+
+      def dom_attrs
+        super.merge({
+          embed_src: embed_src,
+          media_title: media_title,
+          origin: origin,
+          params: params,
+        })
+      end
+    end
+  end
+end

data/lib/vime/core/player.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# @see https://vimejs.com/components/core/player
+
+module Vime
+  module Core
+    class Player < Component
+      option :aspect_ratio, type: Types::String, default: -> { "16:9" }
+      option :autopause, type: Types::Bool, default: -> { true }
+      option :autoplay, type: Types::Bool, default: -> { false }
+      option :controls, type: Types::Bool, default: -> { false }
+      option :current_time, type: Types::Integer, default: -> { 0 }
+      option :debug, type: Types::Bool, default: -> { false }
+      option :duration, type: Types::Integer, default: -> { -1 }
+      option :language, type: Types::String, default: -> { "en" }
+      option :loop, type: Types::Bool, default: -> { false }
+      option :media_title, type: Types::String, optional: true
+      option :muted, type: Types::Bool, default: -> { false }
+      option :paused, type: Types::Bool, default: -> { true }
+      option :playback_quality, type: Types::String, optional: true
+      option :playback_rate, type: Types::Integer, default: -> { 1 }
+      option :playsinline, type: Types::Bool, default: -> { false }
+      option :theme, type: Types::String, optional: true
+      option :volume, type: Types::Integer, default: -> { 50 }
+
+      def call
+        content_tag "vime-player", content, process_attrs(dom_attrs)
+      end
+
+      def dom_attrs
+        super.merge({
+          aspect_ratio: aspect_ratio,
+          autopause: autopause,
+          autoplay: autoplay,
+          controls: controls,
+          current_time: current_time,
+          debug: debug,
+          duration: duration,
+          language: language,
+          loop: loop,
+          media_title: media_title,
+          muted: muted,
+          paused: paused,
+          playback_quality: playback_quality,
+          playback_rate: playback_rate,
+          playsinline: playsinline,
+          theme: theme,
+          volume: volume,
+        })
+      end
+    end
+  end
+end

data/lib/vime/core/playground.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# @see https://vimejs.com/components/core/playground
+
+module Vime
+  module Core
+    class Playground < Component
+      option :poster, type: Types::String, optional: true
+      option :provider, type: Types::String.enum("Provider.Audio", "Provider.Dailymotion", "Provider.Dash", "Provider.FakeTube", "Provider.Video", "Provider.Vimeo", "Provider.YouTube"), default: -> { "Provider.Audio" }
+      option :show_custom_ui, type: Types::Bool, optional: true
+      option :src, type: Types::String
+      option :theme, type: Types::String.enum("", "dark", "light"), default: -> { "" }
+
+      def call
+        content_tag "vime-playground", content, process_attrs(dom_attrs)
+      end
+
+      def dom_attrs
+        super.merge({
+          poster: poster,
+          provider: provider,
+          show_custom_ui: show_custom_ui,
+          src: src,
+          theme: theme,
+        })
+      end
+    end
+  end
+end

data/lib/vime/providers/audio.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# @see https://vimejs.com/components/providers/audio
+
+module Vime
+  module Providers
+    class Audio < Component
+      option :cross_origin, type: Types::CrossOrigin, optional: true
+      option :media_title, type: Types::String, optional: true
+      option :preload, type: Types::Preload, default: -> { "metadata" }
+
+      def call
+        content_tag "vime-audio", content, process_attrs(dom_attrs)
+      end
+
+      def dom_attrs
+        super.merge({
+          cross_origin: cross_origin,
+          media_title: media_title,
+          preload: preload,
+        })
+      end
+    end
+  end
+end

data/lib/vime/providers/dailymotion.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# @see https://vimejs.com/components/providers/dailymotion
+
+module Vime
+  module Providers
+    class Dailymotion < Component
+      option :color, type: Types::String, optional: true
+      option :poster, type: Types::String, optional: true
+      option :should_autoplay_queue, type: Types::Bool, default: -> { false }
+      option :show_dailymotion_logo, type: Types::Bool, default: -> { false }
+      option :show_share_buttons, type: Types::Bool, default: -> { false }
+      option :show_up_next_queue, type: Types::Bool, default: -> { false }
+      option :show_video_info, type: Types::Bool, default: -> { true }
+      option :syndication, type: Types::String, optional: true
+      option :video_id, type: Types::String
+
+      def call
+        tag "vime-dailymotion", process_attrs(dom_attrs)
+      end
+
+      def dom_attrs
+        super.merge({
+          color: color,
+          poster: poster,
+          should_autoplay_queue: should_autoplay_queue,
+          show_dailymotion_logo: show_dailymotion_logo,
+          show_share_buttons: show_share_buttons,
+          show_up_next_queue: show_up_next_queue,
+          show_video_info: show_video_info,
+          syndication: syndication,
+          video_id: video_id,
+        })
+      end
+    end
+  end
+end

data/lib/vime/providers/dash.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# @see https://vimejs.com/components/providers/dash
+
+module Vime
+  module Providers
+    class Dash < Component
+      option :auto_pip, type: Types::Bool, optional: true
+      option :controls_list, type: Types::String, optional: true
+      option :cross_origin, type: Types::CrossOrigin, optional: true
+      option :disable_pip, type: Types::Bool, optional: true
+      option :disable_remote_playback, type: Types::Bool, optional: true
+      option :media_title, type: Types::String, optional: true
+      option :poster, type: Types::String, optional: true
+      option :preload, type: Types::Preload, default: -> { "metadata" }
+      option :src, type: Types::String
+      option :version, type: Types::String, default: -> { "latest" }
+
+      def call
+        content_tag "vime-dash", content, process_attrs(dom_attrs)
+      end
+
+      def dom_attrs
+        super.merge({
+          auto_pip: auto_pip,
+          controls_list: controls_list,
+          cross_origin: cross_origin,
+          disable_pip: disable_pip,
+          disable_remote_playback: disable_remote_playback,
+          media_title: media_title,
+          poster: poster,
+          preload: preload,
+          src: src,
+          version: version,
+        })
+      end
+    end
+  end
+end

data/lib/vime/providers/file.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# @see https://vimejs.com/components/providers/file
+
+module Vime
+  module Providers
+    class File < Component
+      option :auto_pip, type: Types::Bool, optional: true
+      option :controls_list, type: Types::String, optional: true
+      option :cross_origin, type: Types::CrossOrigin, optional: true
+      option :disable_pip, type: Types::Bool, optional: true
+      option :disable_remote_playback, type: Types::Bool, optional: true
+      option :media_title, type: Types::String, optional: true
+      option :poster, type: Types::String, optional: true
+      option :preload, type: Types::Preload, default: -> { "metadata" }
+      option :view_type, type: Types::String, optional: true
+
+      def call
+        content_tag "vime-file", content, process_attrs(dom_attrs)
+      end
+
+      def dom_attrs
+        super.merge({
+          auto_pip: auto_pip,
+          controls_list: controls_list,
+          cross_origin: cross_origin,
+          disable_pip: disable_pip,
+          disable_remote_playback: disable_remote_playback,
+          media_title: media_title,
+          poster: poster,
+          preload: preload,
+          view_type: view_type,
+        })
+      end
+    end
+  end
+end

data/lib/vime/providers/hls.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# @see https://vimejs.com/components/providers/hls
+
+module Vime
+  module Providers
+    class Hls < Component
+      option :config, type: Types::Any, optional: true
+      option :controls_list, type: Types::String, optional: true
+      option :cross_origin, type: Types::CrossOrigin, optional: true
+      option :media_title, type: Types::String, optional: true
+      option :poster, type: Types::String, optional: true
+      option :preload, type: Types::Preload, default: -> { "metadata" }
+      option :version, type: Types::String, default: -> { "latest" }
+
+      def call
+        content_tag "vime-hls", content, process_attrs(dom_attrs)
+      end
+
+      def dom_attrs
+        super.merge({
+          config: config,
+          controls_list: controls_list,
+          cross_origin: cross_origin,
+          media_title: media_title,
+          poster: poster,
+          preload: preload,
+          version: version,
+        })
+      end
+    end
+  end
+end

data/lib/vime/providers/video.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+# @see https://vimejs.com/components/providers/video
+
+module Vime
+  module Providers
+    class Video < Component
+      option :controls_list, type: Types::String, optional: true
+      option :cross_origin, type: Types::CrossOrigin, optional: true
+      option :media_title, type: Types::String, optional: true
+      option :poster, type: Types::String, optional: true
+      option :preload, type: Types::Preload, default: -> { "metadata" }
+
+      def call
+        content_tag "vime-video", content, process_attrs(dom_attrs)
+      end
+
+      def dom_attrs
+        super.merge({
+          controls_list: controls_list,
+          cross_origin: cross_origin,
+          media_title: media_title,
+          poster: poster,
+          preload: preload,
+        })
+      end
+    end
+  end
+end

data/lib/vime/providers/vimeo.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# @see https://vimejs.com/components/providers/vimeo
+
+module Vime
+  module Providers
+    class Vimeo < Component
+      option :byline, type: Types::Bool, default: -> { true }
+      option :color, type: Types::String, optional: true
+      option :no_auto_aspect_ratio, type: Types::Bool, default: -> { false }
+      option :portrait, type: Types::Bool, default: -> { true }
+      option :poster, type: Types::String, optional: true
+      option :video_id, type: Types::String
+
+      def call
+        tag "vime-vimeo", process_attrs(dom_attrs)
+      end
+
+      def dom_attrs
+        super.merge({
+          byline: byline,
+          color: color,
+          no_auto_aspect_ratio: no_auto_aspect_ratio,
+          portrait: portrait,
+          poster: poster,
+          video_id: video_id,
+        })
+      end
+    end
+  end
+end