drg_rotator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 827b78e800738e6f7bc9fcde23a3ebe8d0038290
+  data.tar.gz: 2eb87df99979f2ed07663f26ab105c55a5740766
+SHA512:
+  metadata.gz: f5c520e155d282102605fd0ae76e94fca7d662e1d0f7460c563dcc894d2649ad19b9c570ec669f0134af7f2f6c053f9f4487cad707f8a101a34f06ca59b05a0c
+  data.tar.gz: 258cfad57d1ca92d4562903fff4a1fdd4e5a982d0c1de0a2744fbd567bed4820def0f5fb9e56a4fc3baeb9d84149aa2a0264ffcdbe06e061ef8a1e454e82f27a

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Damjan Rems
+
+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,29 @@
+# DrgRotator
+DrgRotator implements rotating web element for DRG CMS.
+
+## Usage
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'drg_rotator'
+```
+and then put this line in page design code.
+
+```irb 
+<%= dc_render(:dc_rotator) %>
+```
+
+It is possible to implement more then one rotator element on page.
+
+```irb
+<%= dc_render(:dc_rotator, element: 'rotator1') %>
+<%= dc_render(:dc_rotator, element: 'rotator2') %>
+```
+
+When you implement more then one rotator on page or rotators on more pages or have implemented rotators on different sites it is possible to define categories under which rotator will be selecting rotating data documents. Categories must be defined in CMS Advanced menu in option Big Table under key dc_rotator.
+
+## Contributing
+Fork this repository on GitHub and issue a pull request
+
+## 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,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'DrgRotator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/forms/dc_rotator.yml

@@ -0,0 +1,78 @@
+# Form for dc_rotator
+table: dc_rotator
+
+index:
+  filter: id as text_field, naziv, kats, active
+  actions: standard
+  
+result_set:
+  actions: standard
+
+  columns:
+    10:  
+      name: description
+    20: 
+      name: created_at
+      format: '%d.%m.%Y'
+    30: 
+      name: created_by
+      eval: dc_name4_id,dc_user,name
+    40: 
+      name: active
+      eval: dc_icon4_boolean
+
+form:
+  title:
+    field: description
+
+  actions: standard
+  tabs:
+    0main:
+      10:
+        name: description
+        type: text_field
+        size: 50
+      20:
+        name: valid_from
+        type: datetime_picker
+      30:
+        name: valid_until
+        type: datetime_picker
+      40:
+        name: kats
+        type: select
+        multiple: true
+        eval: dc_big_table 'dc_rotator'
+        html:
+          include_blank: true        
+      50:
+        name: order
+        type: text_field
+        size: 3
+      60:
+        name: active
+        type: check_box
+    1content:
+      10:
+        name: link
+        type: text_field
+        size: 50
+      20:
+        name: target
+        type: text_with_select
+        size: 10
+      30:
+        name: picture
+        type: file_select
+        size: 50
+      50:
+        name: text_over
+        type: check_box
+      60:
+        name: css_over
+        type: text_area
+        size: 50x10
+      70:
+        name: text
+        type: html_field
+        options: 'height: 400' 

data/app/forms/dc_rotator_settings.yml

@@ -0,0 +1,33 @@
+## Form for rotator settings
+table: dc_memory
+title: helpers.dc_rotator.settings
+controls: design_element_settings
+
+form:
+  actions: 
+    1: save
+
+  fields:
+    10:
+      name: delay
+      text: helpers.dc_rotator.delay
+      help: helpers.dc_rotator.delay_help
+      type: text_field
+      size: 3
+     
+    20:
+      name: kats
+      text: helpers.label.dc_rotator.kats
+      help: helpers.help.dc_rotator.kats
+      type: select
+      multiple: true
+      eval: dc_big_table 'rotator'
+      css: '#td_record_kats .ms-container {min-width: 250px;}'
+
+    30:
+      name: klass
+      text: helpers.dc_rotator.klass
+      help: helpers.dc_rotator.klass_help
+      type: text_field
+      size: 20
+

data/app/helpers/dc_rotator_renderer.rb

@@ -0,0 +1,153 @@
+#--
+# Copyright (c) 2018+ Damjan Rems
+#
+# 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.
+#++
+
+########################################################################
+# Renderer for rotator web element
+########################################################################
+class DcRotatorRenderer
+  
+########################################################################
+#
+########################################################################
+def initialize( parent, opts={} )
+  @parent    = parent
+  @opts      = opts
+  @opts[:element] ||= 'rotator'  
+  @parts_css = ''
+  self
+end
+
+########################################################################
+# Fetch documents displayed by rorator
+########################################################################
+def rotator_documents()
+  kats  = @opts.dig(:settings, @opts[:element], 'kats')
+  query = if kats
+    DcRotator.where(:kats.in => kats, active: true)
+  else
+    DcRotator.where(active: true)
+  end
+  query = query.and({"$or" => [{:valid_from => nil}, {:valid_from.lt => Time.now}]}, 
+                    {"$or" => [{:valid_until => nil}, {:valid_until.gt => Time.now}]}) 
+                  
+  query.order_by(order: 1).limit(10)
+end
+
+########################################################################
+# Prepares code for displaying single element
+########################################################################
+def one_element(doc)
+  html = if doc.picture.empty?
+%Q[<div class="orbit-text">#{doc.text.html_safe}</div>]
+    else  
+%Q[<div class="orbit-pic-with-text" style="position: relative;"><img class="orbit-image" src="#{doc.picture}" alt="#{doc.description}">] +
+   (doc.text_over ? "<div style=\"#{doc.css_over}\">#{doc.text}</div>" : '') + '</div>'
+  end.html_safe
+  html = @parent.link_to(html, doc.link, target: doc.target) unless doc.link.empty?
+  html
+end
+
+########################################################################
+# Render rotator for display.
+########################################################################
+def rotator_4display
+  delay = @opts.dig(:settings, @opts[:element], 'delay') || 2000
+  html = %Q[
+<div class="orbit" role="region" aria-label="" data-orbit data-timer-delay="#{delay}">
+  <div class="orbit-wrapper">
+    <ul class="orbit-container">
+]
+  nav = '<nav class="orbit-bullets">' 
+# each document
+  n, is_active = 0, 'is-active'
+  rotator_documents.each do |doc|
+    html << %Q[<li class="#{is_active} orbit-slide"> <figure class="orbit-figure">]
+    html << one_element(doc)
+    html << '</figure> </li>'
+    nav  << %Q[<button class="#{is_active}" data-slide="#{n}"><span class="show-for-sr">Slide #{n+1} details.</span></button>]
+#    
+    is_active = ''
+    n+=1
+  end
+  "#{html}</ul>#{nav}</nav></div></div>"
+end
+
+########################################################################
+# Create code for rotator settings link
+########################################################################
+def link_for_rotator_settings
+  table = @opts[:table] || @parent.page.class.to_s
+  id = (table == 'dc_site') ? @parent.site.id : @parent.page.id
+%Q[  
+  #{@parent.dc_link_for_edit(table: 'dc_memory', title: 'helpers.dc_rotator.settings', 
+                             form_name: 'dc_rotator_settings', icon: 'cog lg',
+                             id: id, location: table, action: 'new',
+                             element: @opts[:element] )}
+  #{@parent.dc_link_for_create(table: 'dc_rotator', title: 'helpers.dc_rotator.create')}
+]
+end
+
+########################################################################
+# Render rotator for edit.
+########################################################################
+def rotator_4edit
+  html = %Q[<div class="orbit">#{link_for_rotator_settings}]
+# each document
+  rotator_documents.each do |doc|
+    html << %Q[<div class="orbit-slide">#{@parent.dc_link_for_edit(table: 'dc_rotator', id: doc.id, title: 'helpers.dc_rotator.edit')}</div>]
+    html << one_element(doc)
+  end
+  "#{html}</div>"
+end
+
+########################################################################
+# Default rorator renderer method.
+########################################################################
+def default
+  clas = @opts.dig(:settings, @opts[:element], 'class')
+  clas = "#{clas} #{@opts[:div_class]}" if @opts[:div_class]
+  html = clas.blank? ? '' : "<div class=\"#{clas}\">"
+  html << if @opts[:edit_mode] > 1
+    rotator_4edit
+  else
+    rotator_4display
+  end
+  html << (clas.blank? ? '' : '</div>')
+end
+
+########################################################################
+#
+########################################################################
+def render_html
+  method = @opts[:method] || 'default'
+  respond_to?(method) ? send(method) : "Error rotator: Method #{method} doesn't exist!"
+end
+
+########################################################################
+#
+########################################################################
+def render_css
+  @parts_css
+end
+
+end

data/app/models/dc_rotator.rb

@@ -0,0 +1,85 @@
+#--
+# Copyright (c) 2018+ Damjan Rems
+#
+# 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.
+#++
+
+##########################################################################
+# DcRotator model definition.
+##########################################################################
+class DcRotator
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  
+  field :description, type: String
+  field :link,        type: String
+  field :target,      type: String,  default: ''
+  field :picture,     type: String
+  field :text,        type: String
+  field :css_over,    type: String
+  field :text_over,   type: Boolean, default: false
+  
+  field :valid_from,  type: DateTime
+  field :valid_until, type: DateTime
+  field :order,       type: Integer, default: 10
+  field :kats,        type: Array        
+  
+  field :active,      type: Boolean, default: true 
+  field :created_by,  type: BSON::ObjectId
+  field :updated_by,  type: BSON::ObjectId
+  
+  index( { kats: 1 } )
+  
+  validates :description,  presence: true  
+
+  validate :additional_controls
+  
+  before_save :do_before_save  
+  
+private
+  
+##########################################################################
+# 
+##########################################################################
+def do_before_save
+#
+end  
+
+######################################################################
+# Additional controls if required. Will see.
+######################################################################
+def additional_controls # 
+  if kats.nil? or kats.size == 0
+#    errors.add('kats', 'At least one category should be selected!')
+  end
+  if text_over
+    errors.add('css_over', 'helpers.help.rotator.css_over_error') if css_over.blank?
+    errors.add('picture', 'helpers.help.rotator.picture_error') if picture.blank?
+  end
+end
+
+######################################################################
+# Returns values for categories
+######################################################################
+def self.choices4_kats
+  DcSite.where(active: true).inject([]) {|r, site| r << [site.name, site.name] }
+end
+
+end

data/config/locales/dc_rotator_en.yml

@@ -0,0 +1,78 @@
+#--
+# Copyright (c) 2018+ Damjan Rems
+#
+# 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.
+#++
+
+en:
+  helpers:
+    label:      
+
+      dc_rotator:
+        tabletitle: Table for defining rotator web element
+        0main: Main
+        1content: Content
+        choices4_target: New window:_blank
+
+        description: Description
+        link: Link
+        picture: Picture
+        text: Text
+        valid_from: Valid from date
+        valid_until: Valid to date
+        kats: Kategories
+        order: Order
+        active: Active
+        created_by: Created by
+        created_at: Created at
+        updated_at: Updated at
+        text_over: Text over
+        css_over: CSS za text
+
+# help labels ####################################################
+    help:
+
+      dc_rotator:
+        description: Short description of rotator element
+        link: Destination link when clicked on rotator element
+        picture: Picture used for rotator element
+        text: HTML text used for rotator element or text over picture
+        valid_from: Start time when rotator element appears
+        order: Order on which elements are displayed
+        valid_until: End time for displaying rotator element
+        kats: Rotator element categories. Categories choices can be set in Big table under document named dc_rotator.
+        active: Rotator element is active.
+        class: Additional CSS class for rotator div 
+        text_over: Check, if you want text to be displayed over picture
+        css_over: CSS for positioning and styling text over picture
+        css_over_error: CSS text must be present
+        picture_error: Picture data must be present
+
+ # Settings fields
+    dc_rotator:
+      create: Rotator - Create new rotator element
+      edit: Rotator - Edit rotator element
+      settings: Rotator settings
+      kats: Categories
+      kats_help: Kategories selected for this rotator
+      delay: Delay
+      delay_help: Delay between rotator elements in miliseconds
+      klass: CSS Class
+      klass_help: Class name used for rotator element

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/drg_rotator.rb

@@ -0,0 +1,7 @@
+require "drg_rotator/engine"
+
+module DrgRotator
+  # Your code goes here...
+end
+
+DrgCms.add_forms_path File.expand_path("../../app/forms", __FILE__)

data/lib/drg_rotator/engine.rb

@@ -0,0 +1,4 @@
+module DrgRotator
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/drg_rotator/version.rb

@@ -0,0 +1,3 @@
+module DrgRotator
+  VERSION = '0.1.0'
+end

data/lib/tasks/drg_rotator_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :drg_rotator do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: drg_rotator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damjan Rems
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: drg_cms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: foundation-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: DRG Rotator implements rotating image or HTML text on DRG CMS enabled
+  web site. It requirers Foundation library for implementing rotating web element.
+email:
+- damjan.rems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/drg_rotator_manifest.js
+- app/forms/dc_rotator.yml
+- app/forms/dc_rotator_settings.yml
+- app/helpers/dc_rotator_renderer.rb
+- app/models/dc_rotator.rb
+- config/locales/dc_rotator_en.yml
+- config/routes.rb
+- lib/drg_rotator.rb
+- lib/drg_rotator/engine.rb
+- lib/drg_rotator/version.rb
+- lib/tasks/drg_rotator_tasks.rake
+homepage: https://www.drgcms.org
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: 'DRG Rotator: Implements rotating web element for DRG CMS.'
+test_files: []