lato_core 1.1.1 → 1.1.3

data/config/initializers/ram.rb

@@ -1,50 +1,14 @@
 include LatoCore::Interface
 
-# Insieme di variabili globali che mantengono dati altrimenti
-# memorizzati in file yaml.
-# Solitamente contengono la lettura del file di configurazione.
-# Cambiare l'ordine in cui sono inserite potrebbe compromettere il corretto
-# funzionamento del modulo.
+# This file contains list of informations for the application.
 
-# IMPOSTAZIONE VOCI DI NAVIGAZIONE
-# Contiene la lista di voci di navigazione di lato
 CORE_NAVIGATION = core_getNavbarItems
-
-# IMPOSTAZIONE NOME APPLICAZIONE
-# Contiene il nome dell'applicazione
 CORE_APPNAME = core_getApplicationName
-
-# IMPOSTAZIONE URL APPLICAZIONE
-# Cotiene l'url base del progetto
 CORE_APPURL = core_getApplicationURL
-
-# IMPOSTAZIONE ROOT PANNELLO GESTIONALE
-# Contiene l'url della pagina di benvenuto custom
 CORE_APPLOGINROOT = core_getApplicationLoginRoot
-
-# IMPOSTAZIONE LINGUE DELL'APPLICAZIONE
-# Continene la lista delle lingue dell'applicazione gestita con lato
 CORE_APPLANGUAGES = core_getApplicationLanguages
-
-# IMPOSTAZIONE INDIRIZZO EMAIL DI SERVIZIO
-# Contiene l'indirizzo email usato cdi default come mittente del mailer
 CORE_APPSERVICEMAIL = core_getApplicationServiceEmail
-
-# IMPOSTAZIONE DATI SU UTENTI NASCOSTI
-# Contiene la lista di permessi utente che rappresentano gli utenti da non
-# mostrare nella pagina users.
 CORE_SUPERUSERSHIDESETTINGS = core_getHideUsersSettings
-
-# IMPOSTAZIONE PERMESSI UTENTE DA NASCONDERE ALL'UTENTE
-# Contiene la lista di permessi utente da non mostrare nel form di creazione/modifica
-# utenti
 CORE_SUPERUSERSPERMISSIONSHIDESETTINGS = core_getHideUsersPermissionsSettings
-
-# IMPOSTAZIONE NOMI DEI PERMESSI UTENTE
-# Contiene la lista di traduzioni da numero permesso utente a valore testuale
 CORE_SUPERUSERSPERMISSIONSNAMESSETTINGS = core_getUsersPermissionsNamesSettings
-
-# IMPOSTAZIONI VISUALIZZAZIONE SEZIONE RECUPERO PASSWORD
-# Contiene un valore booleano indicante se e' possibile o meno utilizzare il
-# recupero password per gli utenti
 CORE_RECOVERYPASSWORDPERMISSION = core_getRecoveryPasswordPermission

data/config/routes.rb

@@ -1,4 +1,5 @@
 LatoCore::Engine.routes.draw do
+  
   root 'back/back#home'
 
   # Authentication
@@ -6,15 +7,13 @@ LatoCore::Engine.routes.draw do
   post 'exec_login', to: 'back/authentication#exec_login', as: 'exec_login'
   delete 'exec_logout', to: 'back/authentication#exec_logout', as: 'exec_logout'
 
-  # view richiesta email
+  # Password recovery
   get 'password_forget', to: 'back/authentication#password_forget', as: 'password_forget'
-  # invio email recupero psw
   post 'password_recover', to: 'back/authentication#password_recover', as: 'password_recover'
-  # view inserimento nuova psw
   get 'password_edit/:token', to: 'back/authentication#password_edit', as: 'password_edit'
-  # aggiornamento password
   post 'password_update', to: 'back/authentication#password_update', as: 'password_update'
-  # Users
+
+  # Superusers
   resources :superusers, module: 'back'
 
 end

data/lib/lato_core.rb

@@ -1,11 +1,7 @@
-# Lato Core e' una gemma che si occupa di generare un pannello di amministrazione
-# con gestione delle utenze da utilizzare nello sviluppo di cms e gestionali.
-# Lato Core e' stato sviluppato per supportare l'integrazione con altri moduli
-# e necessita della gemma 'lato_view' per funzionare in modo corretto.
 module LatoCore
 
-  # Includo interface e engine
+  # include engine and interface
   require "lato_core/engine"
   require "lato_core/interface"
-  
+
 end

data/lib/lato_core/engine.rb

@@ -1,11 +1,8 @@
 module LatoCore
-  # Classe che gestisce l'inizializzazione del modulo.
-  # Principalmente si occupa di rendere obbligatorie le migrazioni nell'app
-  # principale e di inserire nel Rails.application.routes le routes del modulo.
   class Engine < ::Rails::Engine
     isolate_namespace LatoCore
 
-    # Aggiunta del supporto alle migrazioni
+    # Add migration support
     initializer 'Add migration support' do |app|
       unless app.root.to_s.match root.to_s
         config.paths['db/migrate'].expanded.each do |expanded_path|
@@ -14,13 +11,16 @@ module LatoCore
       end
     end
 
-    # Aggiunta del supporto ai routes
+    # Add routes support
     initializer 'Add gem routes to application',
                 before: :load_config_initializers do
       Rails.application.routes.append do
-        # modificare '/lato/starter' con l'url di base dei routes del modulo
         mount LatoCore::Engine, at: '/lato/core'
       end
     end
+
+    # Add interface to main application
+    config.autoload_paths << LatoCore::Engine.root.join('lib/interface')
+
   end
 end

data/lib/lato_core/interface.rb

@@ -1,27 +1,24 @@
 module LatoCore
-  # L'interfaccia contiene un insieme di funzioni utilizzabili in maniera
-  # universale dall'applicazione principale o da alti moduli
   module Interface
 
-    # Azioni principali per la gestione della cache
+    require 'lato_core/interface/authentication'
+    include LatoCore::Interface::Authentication
+
     require 'lato_core/interface/cache'
     include LatoCore::Interface::Cache
-    # Azioni principali per la gestione delle comunicazioni
+
     require 'lato_core/interface/communication'
     include LatoCore::Interface::Communication
-    # Azioni principali per la gestione delle sessioni
-    require 'lato_core/interface/session'
-    include LatoCore::Interface::Session
-    # Azioni principali per la gestione della navigazione
-    require 'lato_core/interface/navigation'
-    include LatoCore::Interface::Navigation
-    # Azioni principali per il controllo dell'autenticazione
-    require 'lato_core/interface/authentication'
-    include LatoCore::Interface::Authentication
-    # Azioni principali per la gestione delle lingue
+
     require 'lato_core/interface/languages'
     include LatoCore::Interface::Languages
-    # Azioni principali per la gestione delle impostazioni superusers
+
+    require 'lato_core/interface/navigation'
+    include LatoCore::Interface::Navigation
+
+    require 'lato_core/interface/session'
+    include LatoCore::Interface::Session
+
     require 'lato_core/interface/superusers'
     include LatoCore::Interface::Superusers
 

data/lib/lato_core/interface/authentication.rb

@@ -1,34 +1,26 @@
 module LatoCore
-  module Interface
-    # Insieme di funzioni che permettono di gestire l'autenticazione degli
-    # utenti che vogliono accedere al backoffice
-    module Authentication
+  # This module contains functions for authetication.
+  module Interface::Authentication
 
-      # Funzione che controlla se l'utente ha i permessi di accedere al
-      # backoffice. Se l'utente non ha i permessi viene rimandato alla pagina di login.
-      def core_controlUser
-        redirect_to lato_core.login_path unless core_controlSession
-      end
-
-      # Funzione che ritorna l'oggetto utente loggato.
-      # * *Returns* :
-      # - user_id se la sessione dell'utente risulta valida
-      # - false se la sessione non esiste o non e' valida
-      def core_getCurrentUser
-        user = LatoCore::Superuser.find(session[:user])
-        return user if session[:user] && session[:session_code] && user
-      end
+    # This function check if user is logged and redirect to login path if
+    # is not logged.
+    def core_controlUser
+      redirect_to lato_core.login_path unless core_controlSession
+    end
 
-      # Funzione che controlla se i permessi dell'utente sono superiori al
-      # livello ricevuto come parametro
-      # * *Returns* :
-      # - true se la sessione dell'utente ha permessi maggiori o uguali del parametro ricevuto
-      # - false se la sessione non esiste o non ha i permessi necessari
-      def core_controlPermission(permission)
-        user = core_getCurrentUser
-        user && user.permission >= permission
-      end
+    # This function search current user on database and return it if is
+    # logged.
+    def core_getCurrentUser
+      user = LatoCore::Superuser.find(session[:user])
+      return user if session[:user] && session[:session_code] && user
+    end
 
+    # This function control if current user has a permission level like
+    # value set as params and return a boolean value.
+    def core_controlPermission(permission)
+      user = core_getCurrentUser
+      user && user.permission >= permission
     end
+
   end
 end

data/lib/lato_core/interface/cache.rb

@@ -1,28 +1,22 @@
 module LatoCore
-  module Interface
-    # Insieme di funzioni che gestiscono la cache dei moduli sulla
-    # applicazione principale.
-    module Cache
-
-      # Funzione che ritorna il percorso alla directory di cache usata dai
-      # moduli lato per memorizzare informazioni sull'applicazione principale.
-      # La directory dell'app principale usata come cache si trova nel percorso
-      # #{Rails.root}/config/lato
-      def core_getCacheDirectory
-        # creo le directory per gli assets se non esistono
-        dirname = "#{Rails.root}/app/assets/images/lato"
-        FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
-        dirname = "#{Rails.root}/app/assets/stylesheets/lato"
-        FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
-        dirname = "#{Rails.root}/app/assets/javascripts/lato"
-        FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
-        # creo la directory di cache se non esiste
-        dirname = "#{Rails.root}/config/lato"
-        FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
-        # ritorno la directory di cache
-        return dirname
-      end
+  # This module contains functions for cache information.
+  module Interface::Cache
 
+    # This function return a string with the path of cache directory on
+    # main project.
+    def core_getCacheDirectory
+      # directories for assets
+      dirname = "#{Rails.root}/app/assets/images/lato"
+      FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
+      dirname = "#{Rails.root}/app/assets/stylesheets/lato"
+      FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
+      dirname = "#{Rails.root}/app/assets/javascripts/lato"
+      FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
+      # main cache directory
+      dirname = "#{Rails.root}/config/lato"
+      FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
+      # return directory
+      return dirname
     end
 
   end

data/lib/lato_core/interface/communication.rb

@@ -1,103 +1,86 @@
 module LatoCore
-  module Interface
-    # Insieme di funzioni che permettono di ottenere informazioni sulla
-    # applicazione principale e sulle altre gemme che lavorano su di essa
-    module Communication
+  # This module contains functions for the communication with other modules.
+  module Interface::Communication
 
-      # Ritorna l'url relativo della directory a cui rimandare dopo
-      # aver effettuato il login in lato. Se tale valore non e' settato
-      # nel file di configurazione di lato allora ritorna semplicemente false.
-      def core_getApplicationLoginRoot
-        return CORE_APPLOGINROOT if defined? CORE_APPLOGINROOT
-        directory = core_getCacheDirectory
-        if File.exist? "#{directory}/config.yml"
-          config = YAML.load(
-            File.read(File.expand_path("#{directory}/config.yml", __FILE__))
-          )
-          return config['login_home'] if config && config['login_home']
-        else
-          return false
-        end
-      end
-
-      # Ritorna il nome dell'applicazione principale settato nel file
-      # config/lato/config.yml.
-      # Se l'applicazione principale non specifica nessun nome allora
-      # la funzione ritorna il valore 'Lato'
-      def core_getApplicationName
-        return CORE_APPNAME if defined? CORE_APPNAME
-        directory = core_getCacheDirectory
-        if File.exist? "#{directory}/config.yml"
-          config = YAML.load(
-            File.read(File.expand_path("#{directory}/config.yml", __FILE__))
-          )
-          if config && config['app_name']
-            return config['app_name']
-          else
-            return 'Lato'
-          end
-        end
+    # This function return the login root set for the application (the url
+    # where user is redirect after login).
+    def core_getApplicationLoginRoot
+      return CORE_APPLOGINROOT if defined? CORE_APPLOGINROOT
+      directory = core_getCacheDirectory
+      if File.exist? "#{directory}/config.yml"
+        config = YAML.load(
+          File.read(File.expand_path("#{directory}/config.yml", __FILE__))
+        )
+        return config['login_home'] if config && config['login_home']
+      else
+        return false
       end
+    end
 
-      # Legge il file di configurazione e verifica se e' stato impostato un root url
-      # per l'applicazione. Se non è stato impostato utilizza di default 'localhost'
-      def core_getApplicationURL
-        return CORE_APPURL if defined? CORE_APPURL
-        directory = core_getCacheDirectory
-        if File.exist? "#{directory}/config.yml"
-          config = YAML.load(
-            File.read(File.expand_path("#{directory}/config.yml", __FILE__))
-          )
-          if config && config['root_url']
-            return config['root_url']
-          else
-            return 'http://localhost:3000'
-          end
+    # This function return the application name.
+    def core_getApplicationName
+      return CORE_APPNAME if defined? CORE_APPNAME
+      directory = core_getCacheDirectory
+      if File.exist? "#{directory}/config.yml"
+        config = YAML.load(
+          File.read(File.expand_path("#{directory}/config.yml", __FILE__))
+        )
+        if config && config['app_name']
+          return config['app_name']
+        else
+          return 'Lato'
         end
       end
+    end
 
-      # Legge il file di configurazione e verifica se è stato impostato un indirizzo
-      # email di servizio. Se non e' stata impostata allora utilizza quella di
-      # default 'service@lato.com'
-      def core_getApplicationServiceEmail
-        return CORE_APPSERVICEMAIL if defined? CORE_APPSERVICEMAIL
-        directory = core_getCacheDirectory
-        if File.exist? "#{directory}/config.yml"
-          config = YAML.load(
-            File.read(File.expand_path("#{directory}/config.yml", __FILE__))
-          )
-          if config && config['service_email']
-            return config['service_email']
-          else
-            return 'service@lato.com'
-          end
+    # This function return the application url set on the config file.
+    def core_getApplicationURL
+      return CORE_APPURL if defined? CORE_APPURL
+      directory = core_getCacheDirectory
+      if File.exist? "#{directory}/config.yml"
+        config = YAML.load(
+          File.read(File.expand_path("#{directory}/config.yml", __FILE__))
+        )
+        if config && config['root_url']
+          return config['root_url']
+        else
+          return 'http://localhost:3000'
         end
       end
+    end
 
-      # Esamina tutte le gemme della applicazione principale e ritorna
-      # solamente quelle appartenenti al progetto Lato.
-      # * *Returns* :
-      # - array di stringhe con i nomi delle gemme del progetto Lato usate dall'applicazione
-      def core_getLatoGems
-        gems = core_getGems
-        lato_gems = []
-        # controllo ogni gemma
-        gems.each do |name|
-          lato_gems.push(name) if name.start_with? 'lato'
+    # This function return the default service email set on the config file.
+    def core_getApplicationServiceEmail
+      return CORE_APPSERVICEMAIL if defined? CORE_APPSERVICEMAIL
+      directory = core_getCacheDirectory
+      if File.exist? "#{directory}/config.yml"
+        config = YAML.load(
+          File.read(File.expand_path("#{directory}/config.yml", __FILE__))
+        )
+        if config && config['service_email']
+          return config['service_email']
+        else
+          return 'service@lato.com'
         end
-        # ritorno il risultato
-        lato_gems
       end
+    end
 
-      # Ritorna la lista dei nomi delle gemme utilizzate dalla applicazione
-      # principale
-      # * *Returns* :
-      # - array di stringhe con i nomi delle gemme dell'applicazione
-      def core_getGems
-        require 'bundler'
-        Bundler.load.specs.map { |spec| spec.name }
+    # This function return the list of lato gems used by the application.
+    def core_getLatoGems
+      gems = core_getGems
+      lato_gems = []
+      # check every gem
+      gems.each do |name|
+        lato_gems.push(name) if name.start_with? 'lato'
       end
+      # return result
+      lato_gems
+    end
 
+    # This function return the list of gems used by the application.
+    def core_getGems
+      require 'bundler'
+      Bundler.load.specs.map { |spec| spec.name }
     end
 
   end

data/lib/lato_core/interface/languages.rb

@@ -1,59 +1,50 @@
 module LatoCore
-  module Interface
-    # Insieme di funzioni che determinano e gestiscono le informazioni riguardo
-    # alle lingue dell'applicazione tra le sezioni offerte dai moduli lato
-    module Languages
+  # This module contains functions used to get languages info.
+  module Interface::Languages
 
-      # Funzione che ritorna true se l'applicazione ha piu' lingue, false se
-      # l'applicazione ha una singola lingua
-      def core_applicationHasLanguages
-        return (CORE_APPLANGUAGES.length > 1) if defined? CORE_APPLANGUAGES
-        languages = core_getApplicationLanguages
-        languages.length > 1
-      end
+    # This function return a boolean value to tells if applications has
+    # languages set to config file.
+    def core_applicationHasLanguages
+      return (CORE_APPLANGUAGES.length > 1) if defined? CORE_APPLANGUAGES
+      languages = core_getApplicationLanguages
+      return languages.length > 1
+    end
 
-      # Funzione che ritorna un array contenente le lingue gestite
-      # dall'applicazione
-      def core_getApplicationLanguages
-        return CORE_APPLANGUAGES if defined? CORE_APPLANGUAGES
-        # definisco variabile di ritorno
-        languages = false
-        if File.exist? "#{Rails.root}/config/lato/config.yml"
-          # accedo al config.yml
-          config = YAML.load(
-            File.read(File.expand_path("#{Rails.root}/config/lato/config.yml",
-                                       __FILE__))
-          )
-          if config['languages']
-            languages = config['languages'].split(',')
+    # This function return an array of languages used by application.
+    def core_getApplicationLanguages
+      return CORE_APPLANGUAGES if defined? CORE_APPLANGUAGES
+      languages = false
+      if File.exist? "#{Rails.root}/config/lato/config.yml"
+        config = YAML.load(
+          File.read(File.expand_path("#{Rails.root}/config/lato/config.yml", __FILE__))
+        )
+        if config['languages']
+          languages = config['languages'].split(',')
 
-            languages.each do |language|
-              language.downcase.delete(' ')
-            end
+          languages.each do |language|
+            language.downcase.delete(' ')
           end
         end
-        # ritorno il risultato
-        return languages
       end
+      # return result
+      return languages
+    end
 
-      # Funzione che ritorna la lettura del file di lingua corretto per
-      # il modulo il cui nome e' ricevuto come parametro
-      def core_loadModuleLanguages(module_name)
-        module_root = module_name.camelize.constantize::Engine.root
-        application_lang = Rails.application.config.i18n.default_locale
-        if File.exist? "#{module_root}/lang/#{application_lang}.yml"
-          return YAML.load(
-            File.read(File.expand_path("#{module_root}/lang/#{application_lang}.yml",
-                                       __FILE__))
-          )
-        else
-          return YAML.load(
-            File.read(File.expand_path("#{module_root}/lang/default.yml",
-                                       __FILE__))
-          )
-        end
+    # This function load and return the languages for a lato module.
+    def core_loadModuleLanguages(module_name)
+      module_root = module_name.camelize.constantize::Engine.root
+      application_lang = Rails.application.config.i18n.default_locale
+      if File.exist? "#{module_root}/lang/#{application_lang}.yml"
+        return YAML.load(
+          File.read(File.expand_path("#{module_root}/lang/#{application_lang}.yml",
+                                     __FILE__))
+        )
+      else
+        return YAML.load(
+          File.read(File.expand_path("#{module_root}/lang/default.yml",
+                                     __FILE__))
+        )
       end
-
     end
 
   end