vinsol_spree_themes 0.0.1

data/app/controllers/spree/admin/themes_preview_controller.rb

@@ -0,0 +1,30 @@
+module Spree
+  module Admin
+    class ThemesPreviewController < Spree::Admin::BaseController
+
+      before_action :load_theme, only: [:show, :destroy]
+
+      def show
+        cookies[:preview] = @theme.name
+        @theme.open_preview
+        redirect_to root_path(theme: @theme.id, mode: 'preview')
+      end
+
+      def destroy
+        cookies.delete(:preview)
+        @theme.close_preview
+        redirect_to admin_themes_path
+      end
+
+      private
+
+        def load_theme
+          @theme = Spree::Theme.find_by(id: params[:theme_id])
+          unless @theme
+            redirect_to admin_themes_path
+          end
+        end
+
+    end
+  end
+end

data/app/controllers/spree/admin/themes_templates_controller.rb

@@ -0,0 +1,60 @@
+module Spree
+  module Admin
+    class ThemesTemplatesController < Spree::Admin::BaseController
+
+      before_action :load_theme, only: [:index, :new, :create, :edit, :update]
+      before_action :load_template, only: [:edit, :update]
+
+      def index
+      end
+
+      def new
+        @template = @theme.themes_templates.build
+      end
+
+      def create
+        @template = @theme.themes_templates.build(new_template_params)
+        @template.created_by_admin = true
+
+        if @template.save
+          redirect_to admin_theme_templates_path(@theme)
+        else
+          render :new
+        end
+      end
+
+      def edit
+      end
+
+      def update
+        @template.update(template_params)
+        render :edit
+      end
+
+      private
+
+        def load_theme
+          @theme = Spree::Theme.find_by(id: params[:theme_id])
+          unless @theme
+            redirect_to admin_themes_path
+          end
+        end
+
+        def load_template
+          @template = @theme.templates.find_by(id: params[:id])
+          unless @template
+            redirect_to admin_theme_templates_path(@theme)
+          end
+        end
+
+        def template_params
+          params.require(:themes_template).permit(:body)
+        end
+
+        def new_template_params
+          params.require(:themes_template).permit(:body, :name, :path)
+        end
+
+    end
+  end
+end

data/app/controllers/spree/fragment_cache_controller.rb

@@ -0,0 +1,13 @@
+module Spree
+  class FragmentCacheController < ActionController::Base
+
+    CACHE_PATH_REGEX = /\A(views\/spree_cache)/
+    CACHE_KEY = 'spree_cache'
+
+    def clear_cache
+      Rails.logger.info 'Expiring fragment caching for template...'
+      expire_fragment(CACHE_PATH_REGEX)
+    end
+
+  end
+end

data/app/controllers/spree/store_controller_decorator.rb

@@ -0,0 +1,37 @@
+Spree::StoreController::THEME_VIEW_LOAD_PATH = File.join(Spree::Theme::CURRENT_THEME_PATH, 'views')
+
+module Spree
+  StoreController.class_eval do
+
+    fragment_cache_key Spree::ThemesTemplate::CacheResolver::FRAGMENT_CACHE_KEY
+
+    before_action :set_view_path
+
+    before_action :set_preview_theme, if: [:preview_mode?, :preview_theme]
+
+    private
+
+      def set_preview_theme
+        params.merge!({ mode: 'preview', theme:  preview_theme.id })
+      end
+
+      def preview_mode?
+        cookies[:preview].present?
+      end
+      helper_method :preview_mode?
+
+      def set_view_path
+        path = preview_mode? ? theme_preview_path : Spree::StoreController::THEME_VIEW_LOAD_PATH
+        prepend_view_path path
+      end
+
+      def theme_preview_path
+        File.join(Spree::Theme::THEMES_PATH, cookies[:preview], 'views')
+      end
+
+      def preview_theme
+        @preview_theme ||= Spree::Theme.find_by(name: cookies[:preview])
+      end
+
+  end
+end

data/app/helpers/spree/base_helper_decorator.rb

@@ -0,0 +1,45 @@
+Spree::BaseHelper.class_eval do
+
+  DEFAULT_THEME_THUMBNAIL_NAME = 'snapshot.png'
+  INVALID_DIRECTORIES = ['.', '..', 'precompiled_assets', 'images', 'fonts']
+
+  def snapshot_path(theme)
+    File.join('/vinsol_spree_themes', theme.name, DEFAULT_THEME_THUMBNAIL_NAME)
+  end
+
+  def sorted_themes(themes)
+    themes.sort { |a, b| Spree::Theme::STATES.index(b.state) <=> Spree::Theme::STATES.index(a.state) }
+  end
+
+  # FIX_ME_PG:- This helper method needs to be defined here as it is used by spree_auth_devise extension templates.
+  # spree_auth_devise not able to load the helper method from the store_controller.
+  def preview_mode?
+    cookies[:preview].present?
+  end
+
+  # FIX_ME_PG:- Optimize the logic for building the directory files tree strucutre.
+  def display_filetree_structure(theme, path, name=nil)
+    html_string ||= ''
+    html_string << '<ul>'
+
+    Dir.foreach(path) do |entry|
+      next if INVALID_DIRECTORIES.include?(entry)
+      full_path = File.join(path, entry)
+
+      if File.directory?(full_path)
+        html_string << "<li><a href='javascript:void(0)'>#{ entry }</a>"
+        html_string << "#{ display_filetree_structure(theme, full_path, entry) }"
+      else
+        # FIX_ME_PG:- Currently need to load the template for every filepath on basis of path and name.
+        template_path = File.dirname(full_path.sub(Rails.root.to_s + '/', ''))
+        template = theme.templates.find_by(path: template_path, name: entry)
+        next unless template
+        html_string << "<li>#{ link_to entry, edit_admin_theme_template_path(theme, template), remote: true, class: 'file-link' }</li>"
+      end
+    end
+    html_string << '</ul>'
+
+    return html_string
+  end
+
+end

data/app/models/spree/theme.rb

@@ -0,0 +1,153 @@
+module Spree
+  class Theme < Spree::Base
+
+    DEFAULT_NAME = %w(default)
+    DEFAULT_STATE = 'drafted'
+    TEMPLATE_FILE_CONTENT_TYPE = 'application/zip'
+    STATES = %w(drafted compiled published)
+    THEMES_PATH = File.join(Rails.root, 'public', 'vinsol_spree_themes')
+    CURRENT_THEME_PATH = File.join(THEMES_PATH, 'current')
+    ASSET_CACHE_PATH = File.join(Rails.root, 'tmp', 'cache')
+
+    has_attached_file :template_file, storage: :filesystem,
+                                      path: 'public/system/spree/themes/:filename'
+
+    ## VALIDATIONS ##
+    validates_attachment :template_file, presence: true,
+                                         content_type: { content_type: TEMPLATE_FILE_CONTENT_TYPE }
+    do_not_validate_attachment_file_type :template_file
+
+    validates :name, presence: true,
+                     uniqueness: { case_sensitive: false }
+    validates :state, inclusion: { in: STATES }
+
+    # FIX_ME_PG:- check for atleast one published theme.
+    # validate :ensure_atleast_one_published_theme, if: :state_changed?, unless: :published?
+
+    ## ASSOCIATIONS ##
+    has_many :themes_templates, dependent: :destroy
+
+    ## CALLBACKS ##
+    before_validation :set_name, if: :template_file?
+    before_validation :set_state, unless: :state?
+    after_commit :extract_template_zip_file, on: :create
+    # before_destroy :ensure_not_published, prepend: true
+    after_destroy :delete_from_file_system
+
+    # FIX_ME_PG:- Need to have default state to compiled when uploading theme. Set state after zip file extraction.
+    # after_create :set_state_to_compile
+
+    ## SCOPES ##
+    scope :published, -> { where(state: 'published') }
+    scope :default, -> { where(name: DEFAULT_NAME) }
+
+    alias_method :templates, :themes_templates
+
+    self.whitelisted_ransackable_attributes = %w( name state )
+
+    ## STATE MACHINES ##
+    state_machine initial: :drafted do
+      before_transition drafted: :compiled do |theme, transition|
+        begin
+          theme.assets_precompile
+          theme.update_cache_timestamp
+        rescue Exception => e
+          theme.errors.add(:base, e)
+        end
+      end
+
+      before_transition compiled: :published do |theme, transition|
+        begin
+          theme.remove_current_theme
+          theme.apply_new_theme
+          theme.update_cache_timestamp
+        rescue Exception => e
+          theme.errors.add(:base, e)
+        end
+      end
+
+      event :draft do
+        transition from: [:published, :compiled], to: :drafted
+      end
+
+      event :compile do
+        transition from: :drafted, to: :compiled
+      end
+
+      event :publish do
+        transition from: [:compiled, :drafted], to: :published
+      end
+    end
+
+    def assets_precompile
+      AssetsPrecompilerService.new(self).minify
+    end
+
+    def remove_current_theme
+      Spree::Theme.published.each(&:draft)
+      File.delete(CURRENT_THEME_PATH) if File.exist?(CURRENT_THEME_PATH)
+    end
+
+    def apply_new_theme
+      source_path = File.join(THEMES_PATH, name)
+      FileUtils.ln_sf(source_path, CURRENT_THEME_PATH)
+      AssetsPrecompilerService.new(self).copy_assets
+    end
+
+    def open_preview
+      precompile_assets = AssetsPrecompilerService.new(self)
+      precompile_assets.minify
+      precompile_assets.copy_preview_assets
+      remove_cache
+      # update_cache_timestamp
+    end
+
+    def close_preview
+      remove_cache
+      # update_cache_timestamp
+    end
+
+    def update_cache_timestamp
+      Rails.cache.write(Spree::ThemesTemplate::CacheResolver.cache_key, Time.current)
+    end
+
+    private
+
+      # def ensure_atleast_one_published_theme
+      #   errors.add(:base, Spree.t('models.theme.minimum_active_error')) unless Spree::Theme.published.one?
+      # end
+
+      def remove_cache
+        FileUtils.remove_dir(ASSET_CACHE_PATH) if File.exists?(ASSET_CACHE_PATH)
+      end
+
+      def set_name
+        self.name = File.basename(template_file_file_name, File.extname(template_file_file_name))
+      end
+
+      def set_state
+        self.state = DEFAULT_STATE
+      end
+
+      def extract_template_zip_file
+        ZipFileExtractor.new(template_file.path, self).extract
+      end
+
+      def delete_from_file_system
+        source_dir = File.join(THEMES_PATH, name)
+        FileUtils.remove_dir(source_dir)
+      end
+
+      def ensure_not_published
+        if published?
+          errors.add(:base, Spree.t('models.theme.no_destory_error'))
+          throw(:abort)
+        end
+      end
+
+      # def set_state_to_compile
+      #   self.compile!
+      # end
+
+  end
+end

data/app/models/spree/themes_template.rb

@@ -0,0 +1,67 @@
+module Spree
+  class ThemesTemplate < Spree::Base
+
+    DEFAULT_LOCALE = 'en'
+    DEFAULT_PATH = File.join('public', 'vinsol_spree_themes')
+    ASSETS_FILE_EXTENSIONS = ['.js', '.css']
+
+    # this attr attribute is used when templates are created from admin end.
+    attr_accessor :created_by_admin
+
+    ## VALIDATIONS ##
+    validates :path, presence: true
+    validates :format, inclusion: Mime::SET.symbols.map(&:to_s),
+                       allow_nil: true
+    validates :locale, inclusion: I18n.available_locales.map(&:to_s)
+    validates :handler, inclusion: ActionView::Template::Handlers.extensions.map(&:to_s),
+                        allow_nil: true
+
+    ## ASSOCIATIONS ##
+    belongs_to :theme
+
+    ## CALLBACKS ##
+    before_validation :set_default_locale, unless: :locale?
+    before_create :set_public_path, if: :created_by_admin
+    after_save :update_cache_timestamp
+    after_save :update_public_file
+    after_save :precompile_assets, if: [:theme_published?, :assets_file?]
+
+    ## DELEGATES ##
+    delegate :name, to: :theme, prefix: true
+
+    self.whitelisted_ransackable_attributes = %w( name path format handler )
+
+    private
+
+      def update_cache_timestamp
+        Rails.cache.write(Spree::ThemesTemplate::CacheResolver.cache_key, Time.current)
+      end
+
+      def set_default_locale
+        self.locale = DEFAULT_LOCALE
+      end
+
+      def set_public_path
+        self.path = File.join(DEFAULT_PATH, theme_name, path)
+      end
+
+      def update_public_file
+        FileGeneratorService.create(self)
+      end
+
+      def precompile_assets
+        assets_compiler = AssetsPrecompilerService.new(theme)
+        assets_compiler.minify
+        assets_compiler.copy_assets
+      end
+
+      def theme_published?
+        theme.published?
+      end
+
+      def assets_file?
+        ASSETS_FILE_EXTENSIONS.include? File.extname(name)
+      end
+
+  end
+end

data/app/models/spree/themes_template/cache_resolver.rb

@@ -0,0 +1,37 @@
+module Spree
+  class ThemesTemplate::CacheResolver < ActionView::FileSystemResolver
+
+    FRAGMENT_CACHE_PATH_REGEX = /\A(views\/spree_cache)/
+    FRAGMENT_CACHE_KEY = 'spree_cache'
+
+    def initialize(path)
+      super(path)
+    end
+
+    def find_all(*args)
+      clear_cache_if_necessary
+      super
+    end
+
+    def self.cache_key
+      ActiveSupport::Cache.expand_cache_key('updated_at', 'loaded_templates')
+    end
+
+    private
+
+      def clear_cache_if_necessary
+        last_updated = Rails.cache.fetch(Spree::ThemesTemplate::CacheResolver.cache_key) { Time.current }
+
+        if @cache_last_updated.nil? || @cache_last_updated < last_updated
+          Rails.logger.info 'Expiring cache and reloading new template content....'
+          # expiring fragment caching used in spree views 
+          ActionController::Base.new().expire_fragment(FRAGMENT_CACHE_PATH_REGEX)
+          # clearing template caching.
+          clear_cache
+
+          @cache_last_updated = last_updated
+        end
+      end
+
+  end
+end