camaleon_cms_rails6 2.5.0

data/lib/ext/string.rb

@@ -0,0 +1,162 @@
+class String
+  def to_bool
+    return true if self == true || self =~ (/(true|t|yes|y|1)$/i)
+    return false if self == false || self.blank? || self =~ (/(false|f|no|n|0)$/i)
+    raise ArgumentError.new("invalid value for Boolean: \"#{self}\"")
+  end
+
+  def strip_tags
+    ActionController::Base.helpers.strip_tags(self)
+  end
+
+  def is_float?
+    self.to_f.to_s == self.to_s
+  end
+
+  def is_number?
+    self.to_f.to_s == self.to_s || self.to_i.to_s == self.to_s
+  end
+
+  def is_bool?
+    self == 'false' || self == 'true'
+  end
+
+  # check if current string is true or false
+  # cases for true: '1' | 'true'
+  # cases for false: '0' | 'false' | ''
+  # return boolean
+  def cama_true?
+    self == 'true' || self == '1'
+  end
+
+  def to_var
+    if is_float?
+      self.to_f
+    elsif is_number?
+      self.to_i
+    elsif is_bool?
+      self.to_bool
+    else
+      self
+    end
+  end
+
+  # parse string into slug format
+  def slug
+    #strip the string
+    ret = self.strip
+
+    #blow away apostrophes
+    ret.gsub! /['`]/,""
+
+    # @ --> at, and & --> and
+    ret.gsub! /\s*@\s*/, " at "
+    ret.gsub! /\s*&\s*/, " and "
+
+    #replace all non alphanumeric, underscore or periods with underscore
+    ret.gsub! /\s*[^A-Za-z0-9\.\-]\s*/, '_'
+
+    #convert double underscores to single
+    ret.gsub! /_+/,"_"
+
+    #strip off leading/trailing underscore
+    ret.gsub! /\A[_\.]+|[_\.]+\z/,""
+    ret
+  end
+
+  # parse string into domain
+  # http://owem.tuzitio.com into owem.tuzitio.com
+  def parse_domain
+    url = self
+    uri = URI.parse(url)
+    uri = URI.parse("http://#{url}") if uri.scheme.nil?
+    host = (uri.host || self).downcase
+    h = host.start_with?('www.') ? host[4..-1] : host
+    "#{h}#{":#{uri.port}" unless [80, 443].include?(uri.port)}"
+  end
+
+  # parse all codes in current text to replace with values
+  # sample: "Hello [c1]".cama_replace_codes({c1: 'World'}) ==> Hello World
+  def cama_replace_codes(values, format_code = '[')
+    res = self
+    values.each do |k, v|
+      v = v.join(',') if v.is_a?(Array)
+      res = res.gsub("[#{k}]", v.to_s) if format_code == '['
+      res = res.gsub("{#{k}}", v.to_s) if format_code == '{'
+      res = res.gsub("%{#{k}}", v.to_s) if format_code == '%{'
+    end
+    res
+  end
+
+  # remove double or more secuencial slashes, like: '/a//b/c/d///abs'.cama_fix_slash => /a/b/c/d/abs
+  def cama_fix_slash
+    self.gsub(/(\/){2,}/, "/")
+  end
+
+  # fix file media keys: avoid duplicated slashes and force to start with slash
+  def cama_fix_media_key
+    res = self.gsub('../', '/').gsub('./', '/').gsub(/(\/){2,}/, "/")
+    res = "/#{res}" unless res.start_with?('/')
+    res = res.slice(0...-1) if res.end_with?('/') && res.length > 1
+    res
+  end
+
+  def cama_fix_filename
+    # Sanitize the filename, to prevent hacking
+    # https://github.com/carrierwaveuploader/carrierwave/blob/6a1445e0daef29a5d4f799a016359b62d82dbc24/lib/carrierwave/sanitized_file.rb#L322
+    sanitize_regexp = /[^[:word:]\.\-\+]/
+    name = self.tr("\\", "/") # work-around for IE
+    name = File.basename(name)
+    name = name.gsub(sanitize_regexp, "_")
+    name = "_#{name}" if name =~ /\A\.+\z/
+    name = "unnamed" if name.size == 0
+    name.mb_chars.to_s
+  end
+
+  # return cleaned model class name
+  # remove decorate
+  # remove Cama prefix
+  def parseCamaClass
+    self.gsub("Decorator","").gsub("CamaleonCms::","")
+  end
+
+  # convert url into custom url with postfix,
+  # sample: "http://localhost/company/rack_multipart20160124_2288_8xcdjs.jpg".cama_add_postfix_url('thumbs/') into http://localhost/company/thumbs/rack_multipart20160124_2288_8xcdjs.jpg
+  def cama_add_postfix_url(postfix)
+    File.join(File.dirname(self), "#{postfix}#{File.basename(self)}")
+  end
+
+  # Sample:
+  #  '/var/www/media/132/logo.png'.cama_add_postfix_file_name('_2') ==> /var/www/media/132/logo_2.png
+  def cama_add_postfix_file_name(postfix)
+    File.join(File.dirname(self), "#{File.basename(self, File.extname(self))}#{postfix}#{File.extname(self)}")
+  end
+
+  # Parse the url to get the image version
+  #   version_name: (String, default empty) version name,
+  #     if this is empty, this will return the image version for thumb of the image, sample: 'http://localhost/my_image.png'.cama_parse_image_version('') => http://localhost/thumb/my_image.png
+  #     if this is present, this will return the image version generated, sample: , sample: 'http://localhost/my_image.png'.cama_parse_image_version('200x200') => http://localhost/thumb/my_image_200x200.png
+  #   check_url: (boolean, default false) if true the image version will be verified, i.e. if the url exist will return version url, if not will return current url
+  def cama_parse_image_version(version_name = '', check_url = false)
+    res = File.join(File.dirname(self), 'thumb', "#{File.basename(self).parameterize}#{File.extname(self)}")
+    res = res.cama_add_postfix_file_name("_#{version_name}") if version_name.present?
+    return self if check_url && !res.cama_url_exist?
+    res
+  end
+
+  # check if the url exist
+  # sample: "https://mydomain.com/myimg.png".cama_url_exist?
+  # return (Boolean) true if the url exist
+  def cama_url_exist?
+    Net::HTTP.get_response(URI.parse(self)).is_a?(Net::HTTPSuccess)
+  rescue
+    false
+  end
+
+  # Colorized Ruby output
+  # color: (:red, :green, :blue, :pink, :light_blue, :yellow)
+  def cama_log_style(color = :red)
+    colors = {red: 31, green: 32, blue: 34, pink: 35, light_blue: 36, yellow: 33}
+    "\e[#{colors[color]}m#{self}\e[0m"
+  end
+end

data/lib/ext/translator.rb

@@ -0,0 +1,84 @@
+class String
+
+  # return translation value of locale
+  # if locale is nil, it will use I18n.locale
+
+  # Usage
+  # The default value if translation is not provided is all text
+  #
+  #  $ WpPost.post_title
+  #  $ => "<!--:en-->And this is how the Universe ended.<!--:--><!--:fr-->Et c'est ainsi que l'univers connu cessa d'exister.<!--:-->"
+  #  $ I18n.locale = :en
+  #  $ WpPost.post_title.translate
+  #  $ => "And this is how the Universe ended."
+  #  $ WpPost.post_title.translate(:en)
+  #  $ => "And this is how the Universe ended."
+  #
+  #  Spits the same text out if no translation tags are applied
+  #  $ WpPost.post_title
+  #  $ => "And this is how the Universe ended."
+  #  $ WpPost.post_title.translate(:fr)
+  #  $ => "And this is how the Universe ended."
+
+  def translate(locale = nil)
+    locale ||= I18n.locale
+    locale = locale.to_sym
+    return self if !self.squish.starts_with?("<!--") or self.blank?
+    return translations[locale] if translations.has_key?(locale)
+    return translations[I18n.default_locale] if translations.has_key?(I18n.default_locale)
+    return '' if translations.keys.any?
+    self
+  end
+
+  # return hash of translations for this string
+  # sample: {es: "hola mundo", en: "Hello World"}
+  def translations
+    @translations ||= split_locales
+    @translations
+  end
+
+  # return aray of translations for this string
+  # sample: ["hola mundo", "Hello World"]
+  def translations_array
+    r = translations.map{|key, value| value}
+    return r.present? ? r : [self]
+  end
+
+  protected
+  def split_locales
+    translations_per_locale = {}
+    return translations_per_locale if !self.squish.starts_with?("<!--") or self.blank?
+
+    self.split('<!--:-->').each do |t|
+      t.match(/^<!--:([\w||-]{2,5})/) do |lang|
+        lt = lang[1].sub("--", "")
+        translations_per_locale[lt.to_sym] = t.gsub(/<!--:#{lt}-->(.*)/, '\1')
+      end
+    end
+    translations_per_locale
+  end
+end
+
+
+class Hash
+  # convert hash to translation string structure
+  # sample: {es: "hola mundo", en: "Hello World"}
+  # ==> <!--:es-->Hola Mundo<!--:--><!--:en-->Hello World<!--:-->
+  def to_translate
+    res = []
+    self.each do|key, val|
+      res << "<!--:#{key}-->#{val}<!--:-->"
+    end
+    res.join("")
+  end
+end
+
+class Array
+  # translate array values
+  # return the same array translated
+  def translate(locale = nil)
+    self.collect do |val|
+      val.to_s.translate(locale)
+    end
+  end
+end

data/lib/generators/camaleon_cms/gem_plugin_generator.rb

@@ -0,0 +1,140 @@
+require 'rails/generators/base'
+require 'securerandom'
+module CamaleonCms
+  module Generators
+    class GemPluginGenerator < Rails::Generators::Base
+      source_root File.expand_path("../gem_plugin_template", __FILE__)
+      argument :plugin_name, :type => :string, :default => "my_plugin"
+      desc "This generator create all basic gem plugin structure."
+
+      def create_initializer_file
+        plugin_dir = Rails.root.join("apps", "plugins", get_plugin_name).to_s
+        plugin_dir_path = "apps/plugins/#{get_plugin_name}"
+        if behavior == :revoke
+          FileUtils.rm_r(plugin_dir) if Dir.exist?(plugin_dir)
+          append_to_file Rails.root.join("Gemfile") do
+            "\n\ngem '#{get_plugin_name}', path:  '#{plugin_dir_path}'"
+          end
+        else
+          plugin_app = File.join($camaleon_engine_dir, "lib", "generators", "camaleon_cms", "gem_plugin_#{get_plugin_name}")
+          FileUtils.rm_r(plugin_app) if Dir.exist?(plugin_app)
+
+          FileUtils.mkdir_p(plugin_dir)
+          system("cd #{Rails.root} & rails plugin new apps/plugins/#{get_plugin_name} --full")
+
+          FileUtils.cp_r(File.join($camaleon_engine_dir, "lib", "generators", "camaleon_cms", "gem_plugin_template"), plugin_app)
+
+          # tmp copy
+          helper_path = File.join(plugin_app, "app", "helpers", "plugins", get_plugin_name)
+          model_path = File.join(plugin_app, "app", "models", "plugins", get_plugin_name)
+          views_path = File.join(plugin_app, "app", "views", "plugins", get_plugin_name)
+          controller_path = File.join(plugin_app, "app", "controllers", "plugins", get_plugin_name)
+          FileUtils.mv(File.join(plugin_app, "app", "controllers", "plugins", "my_plugin"), controller_path) rescue nil
+          FileUtils.mv(File.join(plugin_app, "app", "helpers", "plugins", "my_plugin"), helper_path) rescue nil
+          FileUtils.mv(File.join(plugin_app, "app", "models", "plugins", "my_plugin"), model_path) rescue nil
+          FileUtils.mv(File.join(plugin_app, "app", "views", "plugins", "my_plugin"), views_path) rescue nil
+          FileUtils.mv(File.join(plugin_app, "app", "assets", "images", "plugins", "my_plugin"), File.join(plugin_app, "app", "assets", "images", "plugins", get_plugin_name)) rescue nil
+          FileUtils.mv(File.join(plugin_app, "app", "assets", "javascripts", "plugins", "my_plugin"), File.join(plugin_app, "app", "assets", "javascripts", "plugins", get_plugin_name)) rescue nil
+          FileUtils.mv(File.join(plugin_app, "app", "assets", "stylesheets", "plugins", "my_plugin"), File.join(plugin_app, "app", "assets", "stylesheets", "plugins", get_plugin_name)) rescue nil
+
+          # configuration
+          t = fix_text(File.read(File.join(plugin_app, "config", "camaleon_plugin.json")))
+          File.open(File.join(plugin_app, "config", "camaleon_plugin.json"), "w"){|f| f << t }
+
+          # helper
+          t = fix_text(File.read(File.join(helper_path, "main_helper.rb")))
+          File.open(File.join(helper_path, "main_helper.rb"), "w"){|f|  f << t }
+
+          # controllers
+          t = fix_text(File.read(File.join(controller_path, "admin_controller.rb")))
+          File.open(File.join(controller_path, "admin_controller.rb"), "w"){|f| f << t }
+          t = fix_text(File.read(File.join(controller_path, "front_controller.rb")))
+          File.open(File.join(controller_path, "front_controller.rb"), "w"){|f| f << t }
+
+          # models
+          model_file = File.join(model_path, "my_plugin.rb")
+          t = fix_text(File.read(model_file))
+          File.open(model_file, "w"){|f| f << t }
+          FileUtils.mv(model_file, File.join(File.dirname(model_file), "#{get_plugin_name}.rb")) rescue nil
+
+
+          directory(plugin_app, plugin_dir)
+          gsub_file File.join(plugin_dir, "config", "routes.rb"), /.+/ do
+"require 'plugin_routes'
+require 'camaleon_cms/engine'
+Rails.application.routes.draw do
+  scope PluginRoutes.system_info[\"relative_url_root\"] do
+    scope '(:locale)', locale: /\#{PluginRoutes.all_locales}/, :defaults => {  } do
+      # frontend
+      namespace :plugins do
+        namespace '#{get_plugin_name}' do
+          get 'index' => 'front#index'
+        end
+      end
+    end
+
+    #Admin Panel
+    scope :admin, as: 'admin', path: PluginRoutes.system_info['admin_path_name'] do
+      namespace 'plugins' do
+        namespace '#{get_plugin_name}' do
+          controller :admin do
+            get :index
+            get :settings
+            post :save_settings
+          end
+        end
+      end
+    end
+
+    # main routes
+    #scope '#{get_plugin_name}', module: 'plugins/#{get_plugin_name}/', as: '#{get_plugin_name}' do
+    #  Here my routes for main routes
+    #end
+  end
+end"
+          end
+
+          if PluginRoutes.isRails4?
+            append_to_file Rails.root.join("Gemfile") do
+              "\n\ngem '#{get_plugin_name}', path:  '#{plugin_dir_path}'"
+            end
+          end
+
+          # destroy non used files
+          FileUtils.rm_r(plugin_app)
+          FileUtils.rm_r(File.join(plugin_dir, "app", "assets", "images", get_plugin_name))
+          FileUtils.rm_r(File.join(plugin_dir, "app", "assets", "javascripts", get_plugin_name))
+          FileUtils.rm_r(File.join(plugin_dir, "app", "assets", "stylesheets", get_plugin_name))
+
+          # remove TODO text from gem
+          gemspec_file = File.join(plugin_dir, "#{get_plugin_name}.gemspec")
+          t = File.read(gemspec_file).gsub("TODO", "")
+          # add Camaleon as plugin dependency
+          t.sub!(/s\.add_dependency "rails".*\n/, "s.add_dependency \"camaleon_cms\", \"~> 2.0\"\n")
+          File.open(gemspec_file, "w"){|f| f << t }
+        end
+      end
+
+      def fix_text(text = "")
+        text.gsub("pluginTitle", get_plugin_title).gsub("PluginClass", get_plugin_class).gsub("pluginKey", get_plugin_name)
+      end
+
+      def self.next_migration_number(dir)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      private
+      def get_plugin_name
+        plugin_name.underscore.singularize
+      end
+
+      def get_plugin_title
+        plugin_name.titleize
+      end
+      def get_plugin_class
+        get_plugin_name.classify
+      end
+
+    end
+  end
+end

data/lib/generators/camaleon_cms/gem_plugin_template/app/controllers/plugins/my_plugin/admin_controller.rb

@@ -0,0 +1,18 @@
+class Plugins::PluginClass::AdminController < CamaleonCms::Apps::PluginsAdminController
+  include Plugins::PluginClass::MainHelper
+  def index
+  end
+
+  # show settings form
+  def settings
+  end
+
+  # save values from settings form
+  def save_settings
+    @plugin.set_options(params[:options]) if params[:options].present? # save option values
+    @plugin.set_metas(params[:metas]) if params[:metas].present? # save meta values
+    @plugin.set_field_values(params[:field_options]) if params[:field_options].present? # save custom field values
+    redirect_to url_for(action: :settings), notice: 'Settings Saved Successfully'
+  end
+  # add custom methods below ....
+end

data/lib/generators/camaleon_cms/gem_plugin_template/app/controllers/plugins/my_plugin/front_controller.rb

@@ -0,0 +1,8 @@
+class Plugins::PluginClass::FrontController < CamaleonCms::Apps::PluginsFrontController
+  include Plugins::PluginClass::MainHelper
+  def index
+    # actions for frontend module
+  end
+
+  # add custom methods below
+end

data/lib/generators/camaleon_cms/gem_plugin_template/app/helpers/plugins/my_plugin/main_helper.rb

@@ -0,0 +1,29 @@
+module Plugins::PluginClass::MainHelper
+  def self.included(klass)
+    # klass.helper_method [:my_helper_method] rescue "" # here your methods accessible from views
+  end
+
+  # here all actions on going to active
+  # you can run sql commands like this:
+  # results = ActiveRecord::Base.connection.execute(query);
+  # plugin: plugin model
+  def pluginKey_on_active(plugin)
+  end
+
+  # here all actions on going to inactive
+  # plugin: plugin model
+  def pluginKey_on_inactive(plugin)
+  end
+
+  # here all actions to upgrade for a new version
+  # plugin: plugin model
+  def pluginKey_on_upgrade(plugin)
+  end
+
+  # hook listener to add settings link below the title of current plugin (if it is installed)
+  # args: {plugin (Hash), links (Array)}
+  # permit to add unlimmited of links...
+  def pluginKey_on_plugin_options(args)
+    args[:links] << link_to('Settings', admin_plugins_pluginKey_settings_path)
+  end
+end

data/lib/generators/camaleon_cms/gem_plugin_template/app/models/plugins/my_plugin/my_plugin.rb

@@ -0,0 +1,6 @@
+# class Plugins::PluginClass::PluginClass < ActiveRecord::Base
+  # belongs_to :site, class_name: "CamleonCms::Site"
+
+  # here create your models normally
+  # notice: your tables in database will be plugins_pluginKey in plural (check rails documentation)
+# end