variable-media-field (empty) → 0.1.0.0

raw patch · 5 files changed

+137/−0 lines, 5 filesdep +basedep +text

Dependencies added: base, text

Files

• ChangeLog.md +5/−0
• LICENSE +30/−0
• README.md +22/−0
• src/Media/VF.hs +44/−0
• variable-media-field.cabal +36/−0

@@ -0,0 +1,5 @@+# Changelog for variable-media-field++## v0.1.0.0++Export `VF` and `VFC` data types.

@@ -0,0 +1,30 @@+Copyright Daniel Firth (c) 2021++All rights reserved.++Redistribution and use in source and binary forms, with or without+modification, are permitted provided that the following conditions are met:++    * Redistributions of source code must retain the above copyright+      notice, this list of conditions and the following disclaimer.++    * Redistributions in binary form must reproduce the above+      copyright notice, this list of conditions and the following+      disclaimer in the documentation and/or other materials provided+      with the distribution.++    * Neither the name of Daniel Firth nor the names of other+      contributors may be used to endorse or promote products derived+      from this software without specific prior written permission.++THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

@@ -0,0 +1,22 @@+# variable-media-field++Variable media field is a simple GADT for representing a media element.+It is defined:++```+data VF u where+  Blank :: VF u+  RawText :: Text -> VF u+  Image :: u -> VF u+  Audio :: u -> VF u+  Video :: u -> VF u+```++You can specify `u` as the mechanism for including media elements in your+type. Either by paths, uris or some other method.++Also defined is a collection of media elements.++```+data VFC u = VFC { unVFC :: [VF u] }+```

@@ -0,0 +1,44 @@+{-# LANGUAGE DeriveFunctor #-}+{-# LANGUAGE DeriveGeneric #-}+{-# LANGUAGE DerivingStrategies #-}+{-# LANGUAGE GADTs #-}+{-# LANGUAGE StandaloneDeriving #-}++-- | --   Module    : Media.VF+--   License   : MIT+--   Stability : experimental+--+-- Simple Variable Media Type+module Media.VF+  ( VF (..),+    VFC (..),+  )+where++import Data.Text+import GHC.Generics++-- | Variable Media Field, specify `u` to+-- determine where media will be sourced.+--+-- @since 0.1.0.0+data VF u where+  Blank :: VF u+  RawText :: Text -> VF u+  Image :: u -> VF u+  Audio :: u -> VF u+  Video :: u -> VF u++deriving stock instance Eq u => Eq (VF u)++deriving stock instance Functor VF++deriving stock instance Generic (VF u)++deriving stock instance Show u => Show (VF u)++-- | Variable Media Field Collection+--+-- @since 0.1.0.0+newtype VFC u = VFC {unVFC :: [VF u]}+  deriving stock (Eq, Show, Generic, Functor)

@@ -0,0 +1,36 @@+cabal-version: 1.12++-- This file has been generated from package.yaml by hpack version 0.34.4.+--+-- see: https://github.com/sol/hpack++name:           variable-media-field+version:        0.1.0.0+synopsis:       Simple type for representing one of several media types.+description:    Simple type for representing one of several media types.+category:       Media+author:         Daniel Firth+maintainer:     dan.firth@homotopic.tech+copyright:      dan.firth@homotopic.tech+license:        MIT+license-file:   LICENSE+build-type:     Simple+extra-source-files:+    README.md+    ChangeLog.md++source-repository head+  type: git+  location: https://gitlab.com/homotopic-tech/variable-media-field++library+  exposed-modules:+      Media.VF+  other-modules:+      Paths_variable_media_field+  hs-source-dirs:+      src+  build-depends:+      base >=4.7 && <5+    , text >=1.0 && <1.3+  default-language: Haskell2010