ds_media_library 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4545cb01d7748469b1a56e318ac1e9b486572cbe
+  data.tar.gz: bcc20e72bf15ec51768b1f9b761423f477f51952
+SHA512:
+  metadata.gz: e3ca176c347d840facdc99787dc619ec086054576448f1546f52a8568aac563c7f19f37461b6fbe1baddc04744f20da03e263a2ca9c6285b624e2f1da13abf2c
+  data.tar.gz: 6502f1776c07ed4845c535c4818b13a71c237c0f509a7f7d3198303a2721eea967f0342353376697ed64b9b2b2867908a82d3997f59fd4c25ee388465e6bf474

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.byebug_history
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+ds_media_library

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.6

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2
+cache: bundler
+addons:
+  apt:
+    packages:
+      - mplayer
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ds_media_library.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Micah Geisel
+
+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,77 @@
+# DSMediaLibrary
+[![Build Status](https://travis-ci.org/botandrose/ds_media_library.svg?branch=master)](https://travis-ci.org/botandrose/ds_media_library)
+
+A reusable Media Library for Downstream projects built as a Rails Engine.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ds_media_library'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+1. Mount the engine at the path of your choosing in your routes:
+```ruby
+# config/routes.rb
+Rails.application.routes.draw do
+  # ...
+  mount DSMediaLibrary::Engine => "/media_library"
+end
+```
+
+2. Require the app's JavaScript and CSS assets:
+```sass
+// application.sass
+@import ds_media_library
+```
+```coffeescript
+# application.coffee
+#= require ds_media_library
+```
+
+3. Add ds_node columns to your models:
+```ruby
+# app/models/widget.rb
+class Widget < ActiveRecord::Base
+  ds_resource :cat_picture
+  belongs_to_many_ds_resources :dog_pictures
+end
+```
+
+4. Use the `#media_library` form helper where you would normally use the `#file_field` form helper:
+```slim
+/ app/views/widgets/form.html.slim
+= form_for @widget do |form|
+  = form.label :cat_picture
+  = form.media_library :cat_picture
+
+  = form.label :dog_pictures
+  = form.media_library :dog_pictures, multiple: true
+```
+
+5. Profit!
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests.
+
+You can also run `bin/server` to start a dummy app at http://localhost:8080 that will allow you to experiment. Note that the state of the app is destroyed on exit.
+
+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). You can then run `bundle update ds_media_library` in projects that use it to update them to the newly-released version.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/botandrose/ds_media_library.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:cucumber)
+
+task :default => [:spec, :cucumber]
+

data/app/assets/javascripts/ds_media_library.coffee

@@ -0,0 +1,45 @@
+#= require jquery
+#= require jquery_ujs
+#= require jquery-ui/widgets/sortable
+#= require toggle_all_checkboxes
+
+$ ->
+  $("[data-media-library]").each ->
+    new MediaLibrary $(this)
+
+class MediaLibrary
+  constructor: (@$el) ->
+    baseId = @$el.attr("data-media-library")
+    @ids = JSON.parse(@$el.attr("data-media-library-ids"))
+    @$el.find(".media-choice:radio").change => @closeModal()
+    @$target = $("#selected_media_" + baseId)
+    @$modalToggle = $("#" + baseId)
+    @$modalToggle.change (event) =>
+      @showPreviews() unless event.target.checked
+    @showPreviews()
+
+  closeModal: ->
+    @$modalToggle.prop(checked: false).change()
+
+  showPreviews: ->
+    @$target.empty()
+    previews = @$el.find(".media-choice:checked ~ .media-preview-template").map (index, template) =>
+      template.innerHTML.replace(/{{index}}/g, index + 1)
+    previews = previews.toArray().sort (a,b) => @sortPreviews(a,b)
+    @$target.append previews.join("\n")
+    @$target.sortable()
+
+  isMultiple: ->
+    @$el.find(".media-choice").is(":checkbox")
+
+  sortPreviews: (a, b) ->
+    aId = @extractId(a)
+    bId = @extractId(b)
+    if @ids.indexOf(aId) < @ids.indexOf(bId)
+      -1
+    else
+      1
+
+  extractId: (html) ->
+    parseInt(html.match(/value="(\d+)"/)[1])
+

data/app/assets/javascripts/toggle_all_checkboxes.coffee

@@ -0,0 +1,6 @@
+$ ->
+  $("[data-toggle-all-checkboxes]").click (event) ->
+    event.preventDefault()
+    $checkboxes = $(this.getAttribute("data-toggle-all-checkboxes"))
+    $checkboxes.prop checked: !$checkboxes.is(":checked")
+

data/app/controllers/ds_media_library/folders_controller.rb

@@ -0,0 +1,37 @@
+module DSMediaLibrary
+  class FoldersController < ApplicationController
+    expose :folder
+
+    def new
+      @folder = DSMediaLibrary::Folder.new
+      render "ds_media_library/resources/folder_form"
+    end
+
+    def create
+      DSMediaLibrary::Folder.create! folder_params
+      redirect_to :resources, notice: "Folder created"
+    end
+
+    def edit
+      @folder = DSMediaLibrary::Folder.find(params[:id])
+      render "ds_media_library/resources/folder_form"
+    end
+
+    def update
+      DSMediaLibrary::Folder.update params[:id], folder_params
+      redirect_to :resources, notice: "Folder updated"
+    end
+
+    def destroy
+      DSMediaLibrary::Folder.destroy params[:id]
+      redirect_to :resources, notice: "Folder deleted"
+    end
+
+    private
+
+    def folder_params
+      params.require(:folder).permit(:parent_id, :name)
+    end
+  end
+end
+

data/app/controllers/ds_media_library/resources_controller.rb

@@ -0,0 +1,71 @@
+module DSMediaLibrary
+  class ResourcesController < ApplicationController
+    expose :root, :resource, :folders
+
+    def index
+      @root = DSMediaLibrary::Folder.root
+      @folders = folders_with_children
+    end
+
+    def new
+      @resource = DSNode::Resource.new
+      render :form
+    end
+
+    def create
+      resources_params.each do |resource_params|
+        DSNode::Resource.create! resource_params
+      end
+      redirect_to :resources, notice: "Media created"
+    end
+
+    def edit
+      render :form
+    end
+
+    def update
+      resource.update! resource_params
+      redirect_to :resources, notice: "Media updated"
+    end
+
+    def destroy
+      resource.update! hidden: true
+      redirect_to :resources, notice: "Media deleted"
+    end
+
+    def move_many
+      DSNode::Resource.where(resourcesid: params[:resource_ids]).update folder_id: params[:folder_id]
+      redirect_to :resources, notice: "Media updated"
+    end
+
+    private
+
+    def resource
+      @resource ||= DSNode::Resource.find(params[:id])
+    end
+
+    def folders_with_children
+      recurse_folders(DSMediaLibrary::Folder.roots.sort_by(&:name))
+    end
+
+    def recurse_folders folders
+      folders.flat_map do |folder|
+        [folder] + recurse_folders(folder.children)
+      end
+    end
+
+    def resource_params
+      resource_params = params.require(:ds_node_resource).permit(:folder_id, :file)
+      # FIXME extract to DSNode gem
+      resource_params.merge!(original_file_name: params[:ds_node_resource][:file].original_filename) if params[:ds_node_resource][:file]
+      resource_params
+    end
+
+    def resources_params
+      params[:ds_node_resource][:file].map do |file|
+        params.require(:ds_node_resource).permit(:folder_id).merge(file: file)
+      end
+    end
+  end
+end
+

data/app/models/ds_media_library/folder.rb

@@ -0,0 +1,43 @@
+require "awesome_nested_set"
+require "ds_node"
+
+module DSMediaLibrary
+  class Folder < ActiveRecord::Base
+    self.table_name = :folders
+
+    def self.root
+      klass = Struct.new(:children, :resources)
+      children = Folder.roots.to_a.sort_by(&:name)
+      resources = DSNode::Resource.where(folder_id: nil).order(:original_file_name)
+      klass.new(children, resources)
+    end
+
+    acts_as_nested_set
+
+    has_many :resources, -> { order(:original_file_name) }, class_name: "DSNode::Resource"
+
+    def children
+      super.order(:name)
+    end
+
+    def all_folders
+      self.class.all
+    end
+
+    before_destroy :move_all_contents_to_parent!
+
+    private
+
+    def move_all_contents_to_parent!
+      transaction do
+        resources.each do |resource|
+          resource.update! folder: parent
+        end
+        children.each do |resource|
+          resource.update! parent: parent
+        end
+      end
+    end
+  end
+end
+

data/app/views/ds_media_library/_folder.html.slim

@@ -0,0 +1,11 @@
+li
+  input.expand-input type="checkbox" id="#{helper.field}-folder-#{folder.id}"
+  .media-container
+    label.expand-label.folder-link for="#{helper.field}-folder-#{folder.id}" = folder.name
+
+  - if folder.children.any? || folder.resources.any?
+    ul.media-nest
+      - with_options locals: { form: form, helper: helper } do |options|
+        = options.render collection: folder.children, partial: "ds_media_library/folder", as: :folder
+        = options.render collection: folder.resources, partial: "ds_media_library/resource", as: :resource
+

data/app/views/ds_media_library/_form_helper.html.slim

@@ -0,0 +1,30 @@
+.media-library data-media-library=helper.html_id data-media-library-ids=helper.ids required=helper.required
+  = form.label helper.file_field_name, helper.label, class: helper.label_css_class
+
+  - if helper.helptext
+    .ratio-text = helper.helptext
+
+  label.media-button for=helper.html_id Media library
+  em or
+  = form.file_field helper.file_field_name, multiple: helper.multiple
+
+  input.modal-input type="checkbox" id=helper.html_id
+  .modal-wrapper
+    .modal-bg
+    .modal-content
+      label.modal-close for=helper.html_id
+        .borders
+      .media-wrapper
+        .info-text Choose a media file below to associate with this field.  You can manage media in the <a href="/media_library">Media Library</a>. <br />Note that changing a file in the library will update it across all associated media fields in this app.
+
+        = link_to "Open all folders", "#", class: "open-all-label", data: { "toggle-all-checkboxes" => ".expand-input" }
+
+        input.text#search_media type="text" placeholder="Type keywords to search media (case sensitive)"
+
+        ul.media-nav
+          - with_options locals: { form: form, helper: helper } do |options|
+            = options.render collection: helper.root_folders, partial: "ds_media_library/folder", as: :folder
+            = options.render collection: helper.root_resources, partial: "ds_media_library/resource", as: :resource
+
+  dl.playlist-media id="selected_media_#{helper.html_id}"
+

data/app/views/ds_media_library/_image_preview.html.slim

@@ -0,0 +1,17 @@
+- if !defined?(preview) then preview = true
+
+- if image.present?
+  dfn.preview-form
+    .preview-wrapper
+      - if preview
+        - if image.video?
+          = video_tag image.url, controls: true
+        - else
+          = image_tag image.url
+
+      = yield
+
+      - unless defined?(hide_file_name) && hide_file_name
+        dt
+          figcaption = image.original_file_name
+

data/app/views/ds_media_library/_resource.html.slim

@@ -0,0 +1,27 @@
+li.resource class=("hidden" if resource.hidden?)
+  .media-container
+    label.expand-label
+      - if helper.multiple
+        input.modal-input.media-choice type="checkbox" value=resource.id checked=form.object.send(helper.field_id_name).include?(resource.id)
+      - else
+        = form.radio_button helper.field_id_name, resource.id, class: "modal-input media-choice"
+
+      span.media-link alt=resource.original_file_name
+        = resource.original_file_name
+
+      script.media-preview-template type="text/x-html-template"
+        = render "ds_media_library/image_preview", image: resource, preview: helper.preview do
+          - if helper.multiple
+            = form.check_box helper.field_id_name, { multiple: true, checked: true }, resource.id, nil
+            = form.check_box helper.remove_field_name, { multiple: true }, resource.id, nil
+            = form.label :"#{helper.remove_field_name}_#{resource.id}" do
+              span Remove #{helper.label.downcase.singularize} {{index}}
+
+          - else
+            - if helper.optional
+              = form.check_box helper.remove_field_name
+              = form.label helper.remove_field_name do
+                span Remove #{helper.label.downcase}
+
+          - helper.block.call(resource) if helper.block
+

data/app/views/ds_media_library/resources/_folder.html.slim

@@ -0,0 +1,14 @@
+li
+  input type="checkbox" class="expand-input" id="folder-#{folder.id}"
+  .media-container
+    label.expand-label.folder-link for="folder-#{folder.id}" = folder.name
+    .media-links
+      = link_to "Edit folder", [:edit, folder], class: "edit-icon", title: "Edit folder"
+      = link_to "Delete folder", folder, method: :delete, class: "delete-icon", title: "Delete folder",
+        data: { confirm: "Are you sure you want to delete this folder? This will move any folders and resources it may contain up into its parent folder." }
+
+  - if folder.children.any? || folder.resources.any?
+    ul.media-nest
+      = render collection: folder.children, partial: "ds_media_library/resources/folder"
+      = render collection: folder.resources, partial: "ds_media_library/resources/resource"
+

data/app/views/ds_media_library/resources/_resource.html.slim

@@ -0,0 +1,12 @@
+li.resource class=("hidden" if resource.hidden?)
+  .media-container
+    input.move-input type="checkbox" name="resource_ids[]" id="media-#{resource.id}" value=resource.id
+    label.expand-label for="media-#{resource.id}"
+      = link_to resource.original_file_name, edit_resource_path(resource), class: resource.css_class, alt: resource.original_file_name
+      / span.move-span.media-link alt=resource.original_file_name = resource.original_file_name
+
+    .media-links
+      = link_to "Edit media", edit_resource_path(resource), class: "edit-icon", title: "Edit media"
+      = link_to "Delete media", resource_path(resource), method: :delete, class: "delete-icon", title: "Delete media",
+        data: { confirm: "Are you sure you want to delete this media item? Note that this will just remove it from the media library." }
+

data/app/views/ds_media_library/resources/folder_form.html.slim

@@ -0,0 +1,19 @@
+= content_for :breadcrumbs do
+  ul.breadcrumb-nav
+    li = link_to "Media Library", :root
+    li
+      = folder.new_record? ? "New" : "Edit"
+      |  folder
+
+
+= form_for folder do |form|
+  fieldset
+    .field
+      = form.label :parent_id, "Parent folder", class: "optional"
+      = form.collection_select :parent_id, form.object.all_folders, :id, :name, include_blank: " -- none -- "
+    .field
+      = form.label :name, "Folder name"
+      = form.text_field :name, class: "name-input"
+
+  = render "shared/submit", name: "folder"
+

data/app/views/ds_media_library/resources/form.html.slim

@@ -0,0 +1,31 @@
+= content_for :breadcrumbs do
+  ul.breadcrumb-nav
+    li = link_to "Media Library", :root
+    li
+      = resource.new_record? ? "New" : "Edit"
+      |  media
+
+
+= form_for resource, url: resource.new_record? ? resources_path : resource_path(resource) do |form|
+  fieldset
+    .flex
+      .field
+        .field
+          = form.label :folder_id, "Parent folder", class: "optional"
+          = form.collection_select :folder_id, DSMediaLibrary::Folder.all, :id, :name, include_blank: " -- none -- "
+
+        -# FIXME extract to super project
+        - if form.object.respond_to?(:expires_at)
+          .field
+            = form.label :expires_at, "Expiration date", class: "optional"
+            = form.date_field :expires_at
+            .warning-text Expired media items will appear with a <i class="fa fa-exclamation-triangle"></i> icon in the media library and an email will be sent upon expiration as a reminder to update it.
+
+      .field
+        = form.label :file, "Upload media"
+        = form.file_field :file, multiple: resource.new_record?
+        - unless form.object.new_record?
+          = render "shared/image_preview", image: form.object
+
+  = render "shared/submit", name: "media"
+

data/app/views/ds_media_library/resources/index.html.slim

@@ -0,0 +1,28 @@
+= content_for :breadcrumbs do
+  ul.breadcrumb-nav
+    li Media Library
+
+= form_tag nil, method: :put do
+  input type="checkbox" id="select-media"
+  .table-buttons-flex
+    .buttons-left
+      = link_to "Open all folders", "#", class: "open-all-label", data: { "toggle-all-checkboxes" => ".expand-input" }
+      label.select-media-button for="select-media" Select multiple media
+      .field.move-selected
+        label.move-selected-label for="folder_id" Move selected to:
+        select#folder_id name="folder_id"
+          - folders.each do |folder|
+            option value=folder.id
+              = "- " * folder.depth
+              = folder.name
+        button.move-button Move
+
+    .buttons-right
+      = link_to "Add new folder", [:new, :folder], class: "add-button"
+      = link_to "Add new media", [:new, :resource], class: "add-button"
+
+  input.text#search_media type="text" placeholder="Type keywords to search media (case sensitive)"
+  ul.media-nav
+    = render collection: root.children, partial: "ds_media_library/resources/folder"
+    = render collection: root.resources, partial: "ds_media_library/resources/resource"
+

data/app/views/shared/_image_preview.html.slim

@@ -0,0 +1,17 @@
+- if !defined?(preview) then preview = true
+
+- if image.present?
+  dfn.preview-form
+    .preview-wrapper
+      - if preview
+        - if image.video?
+          = video_tag image.url, controls: true
+        - else
+          = image_tag image.url
+
+      = yield
+
+      - unless defined?(hide_file_name) && hide_file_name
+        dt
+          figcaption = image.original_file_name
+

data/app/views/shared/_submit.html.slim

@@ -0,0 +1,6 @@
+.fixed-form
+  .field
+    .save-wrapper
+      input type="submit" value="Save #{name}"
+    = link_to "Cancel", :back, class: "cancel"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ds_media_library"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/server

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require "rack"
+require_relative "../dummy/app"
+Rack::Server.start(app: Dummy::App)
+

data/bin/setup

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+bundle check || bundle install

data/config/routes.rb

@@ -0,0 +1,8 @@
+DSMediaLibrary::Engine.routes.draw do
+  root to: redirect { |_, req| req.fullpath + "resources" }
+  resources :resources do
+    put "", on: :collection, action: :move_many
+  end
+  resources :folders
+end
+