alchemy-custom-model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e6c70590f98f7fe1059a6473d7040a66c9db41c
+  data.tar.gz: 18f20f4575cafc620bddda500c480fdc625ea86d
+SHA512:
+  metadata.gz: 51728d319fc807d859f16377af2b92184f6ade99a46371f55c7677488d078c029c24ba192f2de4a5431443418d968a503aa20887ac1e07b2d3ea60ff16f42fde
+  data.tar.gz: b78843f5e537763eef6dc5e75e0bffcb66ed99a7395ce9ff3a404a9e3f31a74699557ec13dd2c7d791df309be61c31c786eaf86e90b182535d6cad7b1f5c5593

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Alessandro Baccanelli
+
+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,147 @@
+# Alchemy::Custom::Model [WIP]
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alchemy-custom-model'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install alchemy-custom-model
+```
+
+Then run the installer
+```bash
+bin/rails  alchemy_custom_model:install
+```
+
+## Usage
+
+* Generate your model
+
+  * remember to append a column for language:
+    ```ruby
+            t.integer :language_id
+    ```
+  * if this model would have a custom url and the relative layout, go to the 
+    [friendly_id page](https://github.com/norman/friendly_id) to make the correct install
+  * we can define on the model this attributes to be used for page SEO:
+    * text    :meta_description
+    * text    :meta_keywords
+    * string  :meta_title
+    * boolean :robot_follow
+    * boolean :robot_index
+    
+* include the model decorator
+```ruby
+
+     include Alchemy::Custom::Model::ModelDecoration
+
+```
+* attach yours belongs_to relations to alchemy_elements
+```ruby
+
+    # For attachments, the foreign_key is the key defined in the model, can be omitted if it's standard Rails naming
+    belongs_to :file, class_name: "Alchemy::Attachment", optional: true, foreign_key: :file_id
+    global_id_setter :file
+
+    # For Pictures
+    belongs_to :picture, class_name: 'Alchemy::Picture', optional: true, touch: true
+    global_id_setter :picture
+```
+* Generate your controller:
+```ruby
+    bin/rails g controller Admin::Posts
+```
+* inherit from Alchemy::Custom::Model::Admin::BaseController
+* Create the routes (prepend it to alchemy routes and  alchemy_custom_model routes)
+* Build the ability for your recipe:
+```ruby
+  class PostAbility
+    include CanCan::Ability
+
+    def initialize(user)
+      if user.present? && (user.is_admin? or user.has_role?("editor"))
+        can :manage, Post #model
+        can :manage, :admin_posts #routes to the posts withouth _path
+      end
+    end
+
+  end
+```
+
+* build the abilities in ad initializer Es: "menu_and_abilities.rb"
+```ruby
+    Alchemy::Modules.register_module({
+                                         name: 'Posts', # custom name
+                                         order: 2,
+                                         navigation: {
+                                             name: 'modules.posts',
+                                             controller: '/admin/posts', #controller path
+                                             action: 'index', #action
+                                             icon: "question" # custom icon
+                                         }
+                                     })
+    Alchemy.register_ability(PostAbility)
+```
+
+* Costruisci la form per il modello
+```ruby
+
+<%= base_form_container do %>
+  <div class="form_in_page">
+    <%= simple_form_for [:admin,@obj] do |f| %>
+      <fieldset>
+
+        <%= f.input :name %>
+        <%= rich_text_editor(f, :description) %>
+        <%= single_image_input(f, :picture) %>
+        <%= single_attachment_input(f, :file) %>
+...
+
+```
+
+* Per elementi come subobject seguire l'esempio di codice nei test che rivedono le varie opzioni
+* Per modelli che si legano direttamente con componenti di alchemy è necessario utilizzare delle relazioni generiche che identificato il record:
+```ruby
+  belongs_to :picture, class_name: 'Alchemy::Picture', touch: true
+  belongs_to :alchemy_file_instance, class_name: 'Alchemy::Picture', foreign_key: :picture_id #relazione generica per i files utilizzata nel volume di elfinder
+```
+* Per la visualizzazione creare quindi un layout in Alchemy con attributi custom_model e custom_model_action che serve per identificare 
+la generazione dei link index e show
+```yml
+- name: layout_name_list
+  elements: [element_for_list]
+  custom_model: "CustomModelClass"
+  custom_model_action: "index"
+  cache: false
+
+- name: layout_name_show
+  elements: [element_for_show]
+  custom_model: "CustomModelClass"
+  custom_model_action: "show"
+  cache: false
+```  
+* E' necessario quindi creare le due pagine nella struttura di alchemy 
+
+## Development
+
+git clone --recursive git@github.com:ArchimediaZerogroup/alchemy-custom-model.git
+
+docker build -t alchemy_custom_image .
+
+docker run -it -p3000:3000 --rm -v "$(pwd)":/app alchemy_custom_image bin/rails s -b 0.0.0.0
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'Alchemy::Custom::Model'
+  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", __dir__)
+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/assets/config/alchemy_custom_model_manifest.js

@@ -0,0 +1,3 @@
+//= link_directory ../javascripts/alchemy-custom-model .js
+//= link_directory ../stylesheets/alchemy-custom-model .css
+//= link_directory ../images/alchemy-custom-model .png

data/app/assets/javascripts/alchemy-custom-model/change_language.js

@@ -0,0 +1,11 @@
+
+$(document).on("page:change turbolinks:load",function () {
+
+    $('select#change_language').on('change',function (e){
+        var url = window.location.pathname;
+        var delimiter = url.match(/\?/) ? '&' : '?';
+        Turbolinks.visit(url+delimiter+"language_id="+$(this).val());
+    });
+
+});
+

data/app/assets/javascripts/alchemy-custom-model/common_init.js

@@ -0,0 +1,16 @@
+$(document).on("'page:change turbolinks:load", function(){
+    $(".datepicker-date").datetimepicker({
+        scrollInput: false,
+        format: "d/m/Y",
+        timepicker: false,
+        datepicker: true,
+        dayOfWeekStart: 0
+    })
+
+    $(".datepicker-time").datetimepicker({
+        format:'H:i',
+        timepicker: true,
+        datepicker: false,
+        step: 15
+    })
+});

data/app/assets/javascripts/alchemy-custom-model/custom_admin_element_editor.js.coffee

@@ -0,0 +1,25 @@
+#= require 'alchemy/alchemy.element_editors'
+
+
+
+window.CustomProxedElementEditor = $.extend {}, Alchemy.ElementEditors
+
+
+$.extend window.CustomProxedElementEditor,
+  init: (selector = "#element_area")->
+    @element_area = $(selector)
+    @bindEvents()
+
+    @initialize_tinymce()
+    return
+
+  initialize_tinymce: ()->
+    ids = []
+    @element_area.find('.has_tinymce').each (i, e)->
+      ids.push($(e).attr("id").match(/[0-9]+/)[0])
+    Alchemy.Tinymce.init(ids)
+
+
+# disattivazione del check di reload pagina
+$(document).on 'submit', '.simple_form.alchemy', (e)=>
+  window.onbeforeunload = null;

data/app/assets/javascripts/alchemy-custom-model/custom_tiny_mce.js.coffee.erb

@@ -0,0 +1,95 @@
+#= require 'lodash/lodash.js'
+
+#duplichiamo la classe
+class CustomTinyMce extends Alchemy.Tinymce
+
+
+  #per come è stato fatto dobbiamo estendere la classe tramite i metodi che usa jquery
+$.extend CustomTinyMce,
+
+
+#  {
+#    skin: 'alchemy',
+#    width: 'auto',
+#    resize: true,
+#    autoresize_min_height: '105',
+#    autoresize_max_height: '480',
+#    menubar: false,
+#    statusbar: true,
+#    toolbar: [
+#      'bold italic underline | strikethrough subscript superscript | numlist bullist indent outdent | removeformat | fullscreen',
+#      'pastetext charmap hr | undo redo | alchemy_link unlink anchor | code'
+#    ],
+#    fix_list_elements: true,
+#    convert_urls: false,
+#    entity_encoding: 'raw',
+#    paste_as_text: true,
+#    element_format: 'html',
+#    branding: false
+#  }
+
+  getDefaultConfig: (id) ->
+    configs = $.extend true, {}, Alchemy.Tinymce.getDefaultConfig(id)
+    configs.init_instance_callback = @initInstanceCallback
+
+    configs.plugins += ",image"
+    configs.toolbar[1] += ' | link image'
+    configs.file_picker_callback = (callback, value, meta)->
+
+      volumes = []
+
+      if (meta.filetype == 'file')
+        volumes.push('AlchemyFiles');
+
+
+      #            // Provide image and alt text for the image dialog
+      if (meta.filetype == 'image')
+        volumes.push('AlchemyImages');
+
+      tinymce.activeEditor.windowManager.open({
+        file: '<%= Alchemy::Custom::Model::Engine.routes.url_helpers.admin_elfinder_ui_path() %>?'+$.param({volumes:volumes}),# Routes.admin_elfinder_ui_path(volumes:volumes), #// use an absolute path!
+        title: 'elFinder 2.1',
+        width: 900,
+        height: 450,
+        resizable: 'yes'
+      }, {
+        oninsert: (file, fm)->
+#            // URL normalization
+          url = fm.convAbsUrl(file.url);
+
+          #            // Make file info
+          info = file.name + ' (' + fm.formatSize(file.size) + ')';
+
+          #            // Provide file and text for the link dialog
+          if (meta.filetype == 'file')
+            callback(file.original_url, {text: info, title: info})
+
+
+          #            // Provide image and alt text for the image dialog
+          if (meta.filetype == 'image')
+            callback(file.original_url, {alt: info})
+
+
+          #            // Provide alternative source and posted for the media dialog
+          if (meta.filetype == 'media')
+            callback(url)
+
+          return false;
+      });
+
+    return configs
+
+
+
+  initInstanceCallback: (editor) ->
+    $this = $("##{editor.id}")
+    element = $this.closest('.tinymce_container')
+    element.on 'parent_stop_sorted', _.debounce(()=>
+      id = editor.getElement().id.replace(/^tinymce_/, '')
+      editor.remove();
+      CustomTinyMce.initEditor(id)
+    , 100)
+    element.find('.spinner').remove()
+
+
+@CustomTinyMce = CustomTinyMce

data/app/assets/javascripts/alchemy-custom-model/el_finder.js.coffee.erb

@@ -0,0 +1,241 @@
+#= require elfinder/js/elfinder.full
+# require js-routes
+#= require 'eventemitter3/umd/eventemitter3'
+
+##
+# Classe di elfinder per autoconfigurarsi rispetto a determinate opzioni
+# mode: Modalità di selezione:
+#   - single_selection   -> indica la selezione singola
+#   - multiple_selection -> selection multipla dei files
+# volumes            -> Elenco dei volumi da montare come stringa divisa da ,
+#                       AlchemyImages      -> solo immagini
+#                       AlchemyFiles       -> solo attachments
+#                       non settato        -> tutti -> Alchemy
+#                       nome_inventato     -> dovrà avere la relativa configurazione nella volumes_cfgs e le informazioni
+#                                             per identificare correttamente che volume montare
+# volumes_cfgs       -> oggetto con configurazioni per i volumi
+#                       l'oggetto dovrà essere composto da chiave=nome del volume usato in volumes e un oggetto con
+#                       le configurazioni:
+#                       {
+#                         - volume      = nome del volume da utilizzare in ruby come connettore
+#                         - attribute   = attributo nell'oggetto a cui si riferisce il collegamento del volume
+#                         - object      = oggetto identificato con un global_id signed
+#                       }
+#
+class ElFinderConfigurator
+
+  constructor: (opts)->
+    @ee = new EventEmitter3;
+
+    {@mode, @volumes, @volumes_cfgs}=opts
+
+    @mode = opts.mode ? 'single_selection'
+    @volumes = opts.volumes ? null
+    @volumes_cfgs = opts.volumes_cfgs ? null
+
+    @height = opts.height ? 400 #TODO automatizzare dinamicamente l'altezza?
+
+    @el_finder = null
+
+  start: (container)->
+    @el_finder = container.elfinder(@configurations())
+    @attach_events()
+
+  configurations: ->
+    cfgs = {
+      url:'<%= Alchemy::Custom::Model::Engine.routes.url_helpers.admin_elfinder_path() %>'
+#lang: 'it',
+      cssAutoLoad: false               # Disable CSS auto loading
+      baseUrl: './'
+      height: @height,
+      commands: ['*'],
+      soundPath:'<%= asset_path('/assets/elfinder/sounds') %>',
+      reloadClearHistory: true
+      rememberLastDir: false
+      useBrowserHistory: false
+      commandsOptions:
+        search:
+          incsearch:
+            enable: false # // is enable true or false
+#            minlen: 1 #    // minimum number of characters
+#            wait: 10000 #  // wait milliseconds
+          searchTypes:
+            SearchMime: #           // The key is search type that send to the connector
+              name: 'btnMime'#    // Button text to be processed in i18n()
+              title: 'searchMime' #// Button title to be processed in i18n()
+            AlchemyTags:
+              name: 'Alchemy Tags'
+              title: 'Ricerca per tags di alchemy'
+      uiOptions: {
+        toolbar: [
+#['home', 'back', 'forward', 'up', 'reload'],
+#['netmount'],
+#['mkdir', 'mkfile', 'upload'],
+          ['upload'],
+          ['open', 'download', 'getfile'],
+          #['undo', 'redo'],
+          ['rm'],
+          #['copy', 'cut', 'paste', 'rm', 'empty', 'hide'],
+          ['duplicate', 'rename', 'edit', 'resize'], #, 'chmod'
+          ['selectall', 'selectnone', 'selectinvert'],
+          ['quicklook'], #, 'info'
+          #['extract', 'archive'],
+          ['search'],
+          ['view', 'sort'],
+          #['preference', 'help'],
+          #['fullscreen']
+        ]
+      }
+    }
+
+    if(@volumes)
+      cfgs.customData = cfgs.customData || {}
+      cfgs.customData['volumes'] = @volumes.split(',')
+      if(@volumes_cfgs)
+        cfgs.customData['volumes_cfgs'] = @volumes_cfgs
+
+    if(@mode == 'single_selection')
+      cfgs.getFileCallback = (file, fm)=>
+        @emit('file_select', file, fm)
+
+    cfgs
+
+  attach_events: ()->
+    @elfinder_instance().bind 'paste', (event, fm)=>
+      @emit('paste_files', event, fm)
+      @emit('change', event, fm)
+    @elfinder_instance().bind 'upload', (event,fm)=>
+      @emit('upload', event, fm)
+    @elfinder_instance().bind 'remove', (event, fm)=>
+      @emit('remove_files', event, fm)
+      @emit('change', event, fm)
+
+
+  on: ()->
+    @ee.on.apply(@ee, arguments)
+
+  once: ()->
+    @ee.once.apply(@ee, arguments)
+
+  emit: ()->
+    @ee.emit.apply(@ee, arguments)
+
+  remove: ()->
+    @el_finder.remove();
+
+  elfinder_instance: ()->
+    @el_finder.elfinder('instance')
+
+@ElFinderConfigurator = ElFinderConfigurator
+
+##
+# Classe per la gestione e configurazione di elfinder e della sua apertura in modal
+#
+# Configurazioni presenti su data dell'activator(bottone o altro che lancia l'evento di el finder)
+#
+# elfinderTarget             -> indica la input in cui posizionare il valore selezionato nella single selection
+#                               oppure il selector da utilizzare per rimpiazzare con il contenuto proveniente dal
+#                               partial generato
+#
+# elfinderThumbTarget        -> tag in cui settare la src con la thumb dell'immagine
+#
+# elfinderMimeIconUpdater    -> selettore css dove applicare le classi di elfinder per l'incona dell'imagine
+#
+#
+# Configurazioni che vengono riportare poi verso ElFinderConfigurator
+# elfinderMode: Modalità di selezione:
+#   - single_selection   -> indica la selezione singola
+#   - multiple_selection -> selection multipla dei files
+# elfinderVolumes            -> Elenco dei volumi da montare
+#                       AlchemyImages      -> solo immagini
+#                       AlchemyFiles       -> solo attachments
+#                       non settato        -> tutti -> Alchemy
+class ElFinderDialog
+
+  constructor: (@activator)->
+    options = $(@activator).data()
+
+    @opts = {
+      target: options['elfinderTarget'],
+      thumb_target: options['elfinderThumbTarget'],
+      mime_icon_updater: options['elfinderMimeIconUpdater']
+      target_upgrader: options['elfinderTargetUpgrader']
+    }
+
+    @elfinder = new ElFinderConfigurator({
+      mode: options['elfinderMode'],
+      volumes: options['elfinderVolumes'],
+      volumes_cfgs: options['elfinderVolumesCfgs'],
+      height: 700
+    })
+
+    @dialog_container = $("<div><div class='el_finder'></div></div>")
+    $('body').append(@dialog_container)
+
+
+  attach_events: ()->
+    if(@elfinder.mode == 'single_selection')
+      @elfinder.once('file_select', (file, fm)=>
+        $(@opts.target).val(file.global_id)
+        if(@opts.thumb_target)
+          $(@opts.thumb_target).attr('src', file.tmb)
+        if(@opts.mime_icon_updater)
+          $(@opts.mime_icon_updater).attr('class', '').addClass("elfinder-cwd-icon #{fm.mime2class(file.mime)}")
+
+        @close()
+      )
+
+    if(@elfinder.mode == 'multiple_selection')
+      @elfinder.on 'change', (event)=>
+        reload_target_url.call(this)
+
+      @elfinder.on 'upload', (event)=>
+        reload_target_url.call(this)
+
+  reload_target_url = ->
+    $.ajax
+      url: @opts.target_upgrader
+      success: (data)=>
+        elemento_gallery = $(data).find(@opts.target)
+        $(@opts.target).html($(elemento_gallery).html())
+
+
+  open: ->
+    @dialog_container.dialog
+      width: $(document).width() * 0.7
+      modal: true
+      position: { my: "top", at: "top", of: window }
+
+      open: ()=>
+        @elfinder.start(@dialog_container.find('.el_finder'))
+        @attach_events()
+
+
+  close: ->
+    @elfinder.remove();
+    @dialog_container.dialog('close').dialog("destroy");
+
+
+$(document).on 'click', '.open_el_finder', (e)->
+  e.preventDefault()
+  dialog = new ElFinderDialog(this)
+  dialog.open();
+
+
+##
+# Pulizia selezione
+$(document).on 'click', '.clear_selection', (e)->
+  e.preventDefault()
+  opts = $(this).data();
+  $(opts.clearfieldTarget).val(null)
+  if(opts.clearfieldThumbTarget)
+    $(opts.clearfieldThumbTarget).attr('src', opts.clearfieldThumbTargetReplace)
+  if(opts.clearfieldIcon)
+    $(opts.clearfieldIcon).attr('class','')
+
+
+
+
+
+
+