engines/adva_themes/test/fixtures/theme-for-import.zip @@ -84,3 +84,4 @@ Marko Seppä Clemens Kofler Priit Tamboom Thomas R. Koll +Joshua Harvey README @@ -38,22 +38,6 @@ map.connect 'admin/sites/:site_id/sections', :action => 'update_all', :conditions => { :method => :put } -map.resources :themes, :controller => 'admin/themes', - :path_prefix => 'admin/sites/:site_id', - :name_prefix => 'admin_', - :collection => { :import => :any }, - :member => { :export => :get } - -map.admin_site_selected_themes 'admin/sites/:site_id/themes/selected', - :controller => 'admin/themes', - :action => 'select', - :conditions => { :method => :post } - -map.admin_site_selected_theme 'admin/sites/:site_id/themes/selected/:id', - :controller => 'admin/themes', - :action => 'unselect', - :conditions => { :method => :delete } - map.connect 'cached_pages', :controller => 'admin/cached_pages', :action => 'clear', :path_prefix => 'admin/sites/:site_id', @@ -68,11 +52,6 @@ map.resources :plugins, :controller => 'admin/plugins', # TODO map manu :path_prefix => 'admin/sites/:site_id', :name_prefix => 'admin_' -map.resources :files, :controller => 'admin/theme_files', - :path_prefix => 'admin/sites/:site_id/themes/:theme_id', - :name_prefix => 'admin_theme_', - :collection => { :import => :any } - map.resources :articles, :path_prefix => "admin/sites/:site_id/sections/:section_id", :name_prefix => "admin_", :namespace => "admin/" engines/adva_cms/routes.rb @@ -2,7 +2,7 @@ class Admin::ThemesController < Admin::BaseController layout "admin" before_filter :set_theme, :only => [:show, :use, :edit, :update, :destroy, :export, :select, :unselect] - before_filter :ensure_uploaded_theme_file_saved!, :only => :import + # before_filter :ensure_uploaded_theme_file_saved!, :only => :import guards_permissions :theme, :update => [:select, :unselect], :manage => [:index, :show, :export], :create => :import @@ -53,11 +53,13 @@ class Admin::ThemesController < Admin::BaseController end def import - return unless request.post? + render and return unless request.post? # renders the import form - if params[:theme][:file].blank? + # uploads and imports the theme + file = params[:theme] ? params[:theme][:file] : nil + if file.blank? flash.now[:error] = t(:'adva.themes.flash.import.error_filename_blank') - elsif @site.themes.import @file + elsif @site.themes.import(file) flash.now[:notice] = t(:'adva.themes.flash.import.success') redirect_to admin_themes_path else @@ -69,7 +71,7 @@ class Admin::ThemesController < Admin::BaseController zip_path = @theme.export send_file(zip_path.to_s, :stream => false) rescue raise "Error sending #{zip_path} file" ensure - FileUtils.rm_r File.dirname(zip_path) + FileUtils.rm_r File.dirname(zip_path) rescue nil end def select @@ -95,6 +97,7 @@ class Admin::ThemesController < Admin::BaseController end def ensure_uploaded_theme_file_saved! + return return if request.get? || params[:theme][:file].blank? file = params[:theme][:file] engines/adva_themes/app/controllers/admin/themes_controller.rb @@ -1,45 +1,45 @@ -class ThemeController < ApplicationController - before_filter :set_file, :only => :file - after_filter :cache_file, :only => :file - - def file - if @file.text? - headers['Content-Type'] = @file.content_type - render :text => @file.data - else - send_data @file.data, :filename => @file.basename.to_s, :type => @file.content_type, :disposition => 'inline' - end - end - - def error - render :nothing => true, :status => 404 - end - -private - - def set_file - theme = find_theme or return error - @file = if params[:file].first == 'preview.png' - theme.preview - else - theme.files.find Theme::File.to_id(params.values_at(:type, :file)) - end or return error - end - - def find_theme - if params[:subdir] - Theme.find(params[:theme_id], params[:subdir]) - else - site = Site.find_by_host(request.host_with_port) - site.themes.find(params[:theme_id]) - end - end - - def cache_file - self.class.cache_page response.body, request.request_uri - rescue - STERR.puts "Cache Exception: #{$!}" - end -end +# class ThemeController < ApplicationController +# before_filter :set_file, :only => :file +# after_filter :cache_file, :only => :file +# +# def file +# if @file.text? +# headers['Content-Type'] = @file.content_type +# render :text => @file.data +# else +# send_data @file.data, :filename => @file.basename.to_s, :type => @file.content_type, :disposition => 'inline' +# end +# end +# +# def error +# render :nothing => true, :status => 404 +# end +# +# private +# +# def set_file +# theme = find_theme or return error +# @file = if params[:file].first == 'preview.png' +# theme.preview +# else +# theme.files.find Theme::File.to_id(params.values_at(:type, :file)) +# end or return error +# end +# +# def find_theme +# if params[:subdir] +# Theme.find(params[:theme_id], params[:subdir]) +# else +# site = Site.find_by_host(request.host_with_port) +# site.themes.find(params[:theme_id]) +# end +# end +# +# def cache_file +# self.class.cache_page response.body, request.request_uri +# rescue +# STERR.puts "Cache Exception: #{$!}" +# end +# end engines/adva_themes/app/controllers/theme_controller.rb @@ -1,5 +1,5 @@ require_dependency 'theme/file' - + # root_dir » #{RAILS_ROOT}/public/themes # base_dir » #{RAILS_ROOT}/public/themes/#{site.host} # path » #{RAILS_ROOT}/public/themes/#{site.host}/#{theme.theme_id} @@ -15,7 +15,7 @@ class Theme < ActiveRecord::Base "#{root_dir}/themes" end end - + belongs_to :site has_many :files, :dependent => :destroy has_many :templates @@ -23,54 +23,103 @@ class Theme < ActiveRecord::Base has_many :javascripts has_many :stylesheets has_one :preview - - has_permalink :name, :url_attribute => :theme_id, :scope => :site_id, + + has_permalink :name, :url_attribute => :theme_id, :scope => :site_id, :only_when_blank => false, :sync_url => true - + validates_presence_of :name - + after_create :create_theme_dir, :create_preview after_destroy :delete_theme_dir - + + class << self + def import(file) + name = file.original_filename.gsub(/(^.*(\\|\/))|(\.zip$)/, '').gsub(/[^\w\.\-]/, '_') + returning Theme.create(:name => name) do |theme| + theme.import(file) + end + end + + def make_tmp_dir + random = Time.now.to_i.to_s.split('').sort_by{rand} + returning Pathname.new(Rails.root + "/tmp/themes/tmp_#{random}/") do |dir| + FileUtils.mkdir_p dir unless dir.exist? + end + end + end + + def about + %w(name author version homepage summary).inject({}) do |result, key| + result[key] = send(key) + result + end + end + def activate! update_attributes! :active => true end - + def deactivate! update_attributes! :active => false end - + def author_link name = author.blank? ? I18n.t(:'adva.common.unknown') : author homepage.blank? ? name : %(<a href="#{homepage}">#{name}</a>) end - + def path - Site.multi_sites_enabled ? - "#{self.class.base_dir}/site-#{site.id}/#{theme_id}" : + Site.multi_sites_enabled ? + "#{self.class.base_dir}/site-#{site.id}/#{theme_id}" : "#{self.class.base_dir}/#{theme_id}" end - + def url - Site.multi_sites_enabled ? - "themes/#{site.perma_host}/#{theme_id}" : + Site.multi_sites_enabled ? + "themes/#{site.perma_host}/#{theme_id}" : "themes/#{theme_id}" end - + + def import(file) + file = returning ActionController::UploadedTempfile.new("uploaded-theme") do |f| + f.write file.read + f.original_path = file.original_path + f.read # no idea why we need this here, otherwise the zip can't be opened + end unless file.path + + Zip::ZipFile.open(file.path) do |zip| + zip.each do |entry| + files << Theme::File.new(:theme => self, :path => entry.name, :data => entry.get_input_stream) + end + end + end + + def export + tmp_dir = Theme.make_tmp_dir + returning(tmp_dir + "#{name}.zip") do |file_name| + file_name.unlink if file_name.exist? + Zip::ZipFile.open(file_name, Zip::ZipFile::CREATE) do |zip| + ::File.open(tmp_dir + 'about.yml', 'w') { |file| file.write(about.to_yaml) } + zip.add('about.yml', tmp_dir + 'about.yml') + files.flatten.each { |file| zip.add(file.base_path, file.path) if File.exists?(file.path) } + end + end + end + # def to_param # theme_id # end - + protected - + def create_theme_dir FileUtils.mkdir_p(path) end - + def create_preview self.preview = Preview.create! :theme => self, :data => ::File.new(@@default_preview) end - + def delete_theme_dir FileUtils.rm_rf(path) end engines/adva_themes/app/models/theme.rb @@ -78,6 +78,10 @@ class Theme < ActiveRecord::Base [theme.path, directory, name].to_path if name end + def base_path + [directory, name].to_path if name + end + def url [theme.url, directory, name].to_path if name end engines/adva_themes/app/models/theme/file.rb @@ -2,8 +2,29 @@ # :controller => 'theme', # :action => 'file', # :requirements => { :type => /stylesheets|javascripts|images/ } +# +# map.connect 'themes/:theme_id/:type/*file', +# :controller => 'theme', +# :action => 'file', +# :requirements => { :type => /stylesheets|javascripts|images/ } + +map.resources :themes, :controller => 'admin/themes', + :path_prefix => 'admin/sites/:site_id', + :name_prefix => 'admin_', + :collection => { :import => :any }, + :member => { :export => :get } + +map.admin_site_selected_themes 'admin/sites/:site_id/themes/selected', + :controller => 'admin/themes', + :action => 'select', + :conditions => { :method => :post } + +map.admin_site_selected_theme 'admin/sites/:site_id/themes/selected/:id', + :controller => 'admin/themes', + :action => 'unselect', + :conditions => { :method => :delete } -map.connect 'themes/:theme_id/:type/*file', - :controller => 'theme', - :action => 'file', - :requirements => { :type => /stylesheets|javascripts|images/ } +map.resources :files, :controller => 'admin/theme_files', + :path_prefix => 'admin/sites/:site_id/themes/:theme_id', + :name_prefix => 'admin_theme_', + :collection => { :import => :any } engines/adva_themes/routes.rb @@ -6,6 +6,7 @@ theme = site.themes.create! :name => 'a theme', :author => 'author', :summary => 'summary' + # theme.templates.create! :name => 'template.html.erb', # :data => File.new("#{File.dirname(__FILE__)}/fixtures/template.html.erb") # engines/adva_themes/test/fixtures.rb @@ -3,6 +3,7 @@ require File.expand_path(File.dirname(__FILE__) + "/../../test_helper") # With.aspects << :access_control class AdminThemesControllerTest < ActionController::TestCase + include ThemeTestHelper tests Admin::ThemesController with_common :a_site, :a_theme, :is_superuser @@ -215,6 +216,38 @@ class AdminThemesControllerTest < ActionController::TestCase end end + describe "POST to :import" do + action { post :import, @params } + + it_guards_permissions :create, :theme + + with :access_granted do + with "valid uploaded theme zip file" do + before { @params = default_params.merge(:theme => { :file => theme_fixture }) } + it_redirects_to { admin_themes_path } + it_assigns_flash_cookie :notice => :not_nil + end + + with "no theme zip file uploaded" do + before { @params = default_params.merge(:theme => { :file => nil }) } + it_renders :template, :import + it_assigns_flash_cookie :error => :not_nil + end + end + end + + describe "GET to :export" do + action { get :export, default_params.merge(:id => @theme.id) } + + it_guards_permissions :manage, :theme + + with :access_granted do + # send file matcher? + # it_sends_file ... + # deletes temp file? + end + end + # # FIXME specify with valid params # describe "POST to :import, without a file" do # action { post :import, default_params.merge(:theme => {:file => ''}) } engines/adva_themes/test/functional/admin/themes_controller_test.rb @@ -13,18 +13,31 @@ module IntegrationTests test "Admin creates a new theme, updates its attributes and deletes it" do login_as_superuser - visits_themes_index_page - creates_a_new_theme - updates_the_themes_attributes - deletes_the_theme + visit_themes_index_page + create_a_new_theme + update_the_themes_attributes + delete_the_theme end + + test "Admin creates a new theme with some files, exports the theme and reimports it" do + login_as_superuser + visit_themes_index_page + create_a_new_theme + + click_link 'Edit' + creates_a_new_theme_file :filename => 'layouts/default.html.erb', :data => 'the theme default layout' + creates_a_new_theme_file :filename => 'effects.js', :data => 'alert("booom!")' - def visits_themes_index_page + export_theme + reimport_theme + end + + def visit_themes_index_page visit @admin_themes_index_page assert_template "admin/themes/index" end - def creates_a_new_theme + def create_a_new_theme click_link 'New theme' assert_template "admin/themes/new" @@ -32,8 +45,19 @@ module IntegrationTests click_button 'Save' assert_template "admin/themes/index" end + + def creates_a_new_theme_file(attributes) + click_link 'Create a new file' + assert_template "admin/theme_files/new" + + attributes.each do |name, value| + fill_in name, :with => value + end + click_button 'Save' + assert_template "admin/theme_files/show" + end - def updates_the_themes_attributes + def update_the_themes_attributes click_link 'Edit' assert_template "admin/themes/show" @@ -45,9 +69,26 @@ module IntegrationTests assert_template "admin/themes/show" end - def deletes_the_theme + def delete_the_theme click_link 'Delete theme' assert_template "admin/themes/index" end + + def export_theme + click_link 'Download theme' + @exported_theme = Rails.root + "/tmp/themes/imported-theme.zip" + ::File.open(@exported_theme, 'w') { |file| file.write(@response.body) } + end + + def reimport_theme + assert_difference 'Theme.count' do + visit_themes_index_page + click_link 'Import theme' + attach_file 'Zip file', @exported_theme + click_button 'Import' + assert_template 'admin/themes/index' + has_tag 'h4[title=?]', 'imported-theme', 'imported-theme' + end + end end end \ No newline at end of file engines/adva_themes/test/integration/admin/themes_test.rb @@ -40,4 +40,8 @@ module ThemeTestHelper def uploaded_stylesheet Theme::File.create! :theme => @theme, :path => 'styles.css', :data => stylesheet_fixture end + + def theme_fixture + File.new("#{File.dirname(__FILE__)}/fixtures/theme-for-import.zip") + end end \ No newline at end of file engines/adva_themes/test/test_helper.rb @@ -83,4 +83,8 @@ class ThemeFileTest < ActiveSupport::TestCase # INSTANCE METHODS + test "base_path returns the path relative to the theme directory" do + uploaded_template.base_path.should == 'templates/foo/bar/template.html.erb' + end + end \ No newline at end of file engines/adva_themes/test/unit/models/theme_file_test.rb @@ -80,29 +80,48 @@ class ThemeTest < ActiveSupport::TestCase # CLASS METHODS + test "imports a zip theme" do + theme_file = theme_fixture + + assert_difference '@site.themes.size', +1 do + @site.themes.import(theme_file) + end + end + # INSTANCE METHODS + test "returns about hash" do + about_hash = { "name" => "a theme", "author" => "author", "version" => "1.0.0", + "homepage" => "http://homepage.org", "summary" => "summary" } + @theme.about.should == about_hash + end + + test "creates a file when exporting a theme" do + theme = @site.themes.create!(:name => 'export-theme') + zip_path = theme.export + zip_path.should be_file + end + + test "created ZIP file includes all theme files" do + theme = @site.themes.create!(:name => 'export-theme') + theme.files += [uploaded_stylesheet, uploaded_javascript, uploaded_image, uploaded_template] +p theme.preview.path +p File.exists?(theme.preview.path) + zip_path = theme.export + zip_file = Zip::ZipFile.new(zip_path) + + theme.files.each do |file| + zip_file.entries.map(&:name).should include(file.base_path) + end + end test "activate! activates the theme" do @theme.activate! @theme.active?.should be_true end - # nope, we stopped doing that - # test "activate! exports the theme to the theme base directory" do - # @theme.activate! - # @theme.path.should be_directory - # end - test "deactivate! deactivates the theme" do @theme.update_attributes :active => true @theme.deactivate! @theme.active?.should be_false end - - # nope, we stopped doing that - # test "activate! removes the theme to the theme base directory" do - # @theme.activate! # make sure the directory was there - # @theme.deactivate! - # @theme.path.should_not be_directory - # end end \ No newline at end of file engines/adva_themes/test/unit/models/theme_test.rb 09d833c9f9c24c1df7016cab0165f41a5f286145 Sven Fuchs svenfuchs@artweb-design.de http://github.com/svenfuchs/adva_cms/commit/0f11cf000d8efe9602bf226688f5e028ac61804b 0f11cf000d8efe9602bf226688f5e028ac61804b 2009-02-13T05:56:45-08:00 2009-02-12T06:19:26-08:00 Theme import/export efe25dcc0de4f171b482443507c52ea0c1c0b41b Joshua Harvey joshmh@gmail.com