capistrano-typo3-cms-base 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58719010c7f2a57209a81cf70b0362fd23f9c77c
+  data.tar.gz: 61a1f1a488dd6c4af9e554fe10e1b907b9b36d1a
+SHA512:
+  metadata.gz: b46f94d1d8c66ff96789599980546da2eb7da3cf2ab46b675cb40f1cf7af7ef715a005b0babd1b8820c980e0112fae9e35afcd5ccdfa9485746369d06661dce3
+  data.tar.gz: a620589365c5c0e1307948510b59ca22b10ecbe84d2fe0ce29d7f5474c19a6ee31f574ea8b2bf1c813f5de87da3212827d5c7b0c770247e31215dfe9b63ca5d4

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-typo3-cms-base.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jose Antonio Guerra
+
+MIT License
+
+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,54 @@
+# Capistrano::Typo3::Cms::Base
+
+Deploy TYPO3 CMS projects with Capistrano 3
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-typo3-cms-base'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-typo3-cms-base
+
+## Usage
+
+Require the module in your `Capfile`:
+
+```ruby
+require 'capistrano/typo3/cms/base'
+
+# Uncomment the following line if you have installed EXT:typo3-console and EXT:coreapi into TYPO3
+# and you want to activate automatic cache clearing and DB schema update on deploy.
+#require 'capistrano/typo3/cms/base/deploy'
+```
+
+
+### Configuration
+
+The gem makes the following configuration variables available (shown with defaults)
+
+```ruby
+set :typo3_cms_environment, "Production"
+set :typo3_cms_basedir, false
+set :typo3_cms_roles, :all
+set :typo3_cms_configuration_file, -> { Capistrano::Typo3::Cms::Base.basedir_prepend('typo3conf/AdditionalConfiguration.php') }
+set :typo3_cms_linked_files, []
+set :typo3_cms_linked_dirs, %w{fileadmin uploads typo3conf/l10n}
+set :typo3_cms_symlink_core, false
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/jaguerra/capistrano-typo3-cms-base/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/capistrano-typo3-cms-base.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/typo3/cms/base/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-typo3-cms-base"
+  spec.version       = Capistrano::Typo3::Cms::Base::VERSION
+  spec.authors       = ["Jose Antonio Guerra"]
+  spec.email         = ["balderiano@gmail.com"]
+  spec.summary       = %q{Deploy TYPO3 CMS projects with Capistrano 3}
+  spec.description   = %q{Lean approach for deploying TYPO3 projects}
+  spec.homepage      = "https://github.com/jaguerra/capistrano-typo3-cms-base"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "capistrano", "~> 3.2"
+end

data/lib/capistrano/typo3/cms/base.rb

@@ -0,0 +1,40 @@
+require "capistrano/typo3/cms/base/version"
+require "capistrano/typo3/cms/base/typo3console"
+#require "capistrano/typo3/cms/base/deploy"
+require "capistrano/typo3/cms/base/install_tool"
+require "capistrano/typo3/cms/base/configuration"
+require "capistrano/typo3/cms/base/typo3core"
+require "securerandom"
+require "digest"
+
+namespace :load do
+  task :defaults do
+    load 'capistrano/typo3/cms/base/defaults.rb'
+  end
+end
+
+module Capistrano
+  module Typo3
+    module Cms
+      module Base
+
+        def self.basedir_prepend(path)
+          if fetch(:typo3_cms_basedir) then
+            File.join( fetch(:typo3_cms_basedir), path)
+          else
+            path
+          end
+        end
+
+        def self.basedir_append(path)
+          if fetch(:typo3_cms_basedir) then
+            File.join( path, fetch(:typo3_cms_basedir))
+          else
+            path
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/capistrano/typo3/cms/base/configuration.rb

@@ -0,0 +1 @@
+load File.expand_path("../tasks/configuration.rake", __FILE__)

data/lib/capistrano/typo3/cms/base/defaults.rb

@@ -0,0 +1,19 @@
+set :typo3_cms_environment, fetch(:typo3_cms_environment, "Production")
+set :typo3_cms_basedir, fetch(:typo3_cms_basedir, false)
+set :typo3_cms_roles, fetch(:typo3_cms_roles, :all)
+set :typo3_cms_configuration_file, -> { Capistrano::Typo3::Cms::Base.basedir_prepend('typo3conf/AdditionalConfiguration.php') }
+set :typo3_cms_linked_files, []
+set :typo3_cms_linked_dirs, %w{fileadmin uploads typo3conf/l10n}
+set :typo3_cms_symlink_core, fetch(:typo3_cms_symlink_core, false)
+
+set :linked_files, -> { fetch(:typo3_cms_linked_files, []).push(fetch(:typo3_cms_configuration_file)) }
+
+set :linked_dirs, -> {
+  linked_dirs = []
+  fetch(:typo3_cms_linked_dirs).each do |dir|
+    linked_dirs.push( Capistrano::Typo3::Cms::Base.basedir_prepend dir )
+  end
+  linked_dirs
+}
+
+set :composer_working_dir, -> { Capistrano::Typo3::Cms::Base.basedir_append fetch(:release_path) }

data/lib/capistrano/typo3/cms/base/deploy.rb

@@ -0,0 +1 @@
+load File.expand_path("../tasks/deploy.rake", __FILE__)

data/lib/capistrano/typo3/cms/base/install_tool.rb

@@ -0,0 +1 @@
+load File.expand_path("../tasks/install_tool.rake", __FILE__)

data/lib/capistrano/typo3/cms/base/tasks/configuration.rake

@@ -0,0 +1,32 @@
+namespace :typo3cms do
+  desc "Generate a basic configuration file"
+  task :generate_config do
+    set :typo3_cms_database_name, ask('Enter the database name:', '')
+    set :typo3_cms_database_username, ask('Enter the database username:', '')
+    set :typo3_cms_database_password, ask('Enter the database password:', '', echo: false)
+    set :typo3_cms_database_host, ask('Enter the database host:', 'localhost')
+    set :typo3_cms_database_port, ask('Enter the database port:', '3306')
+
+    set :typo3_cms_install_password, ask('Enter the install tool password:', '', echo: false)
+
+    template = <<-EOF
+<?php
+$GLOBALS['TYPO3_CONF_VARS']['DB']['database'] = '<%= fetch(:typo3_cms_database_name) %>';
+$GLOBALS['TYPO3_CONF_VARS']['DB']['username'] = '<%= fetch(:typo3_cms_database_username) %>';
+$GLOBALS['TYPO3_CONF_VARS']['DB']['password'] = '<%= fetch(:typo3_cms_database_password) %>';
+$GLOBALS['TYPO3_CONF_VARS']['DB']['host'] = '<%= fetch(:typo3_cms_database_host) %>';
+$GLOBALS['TYPO3_CONF_VARS']['BE']['installToolPassword'] = '<%= Digest::MD5.hexdigest(fetch(:typo3_cms_install_password)) %>';
+$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] = '<%= SecureRandom.hex 48 %>';
+<%= fetch(:typo3_cms_configuration_additional, '') %>
+?>
+EOF
+
+    config = ERB.new(template)
+    io = StringIO.new(config.result(binding))
+
+    on release_roles(fetch(:typo3_cms_roles)) do
+      invoke "deploy:check:make_linked_dirs"
+      upload! io, File.join(shared_path, fetch(:typo3_cms_configuration_file))
+    end
+  end
+end

data/lib/capistrano/typo3/cms/base/tasks/deploy.rake

@@ -0,0 +1,13 @@
+namespace :deploy do
+
+  desc 'Clear caches'
+  after :published, :clear_cache do
+    invoke "typo3cms:typo3console:clear_cache"
+  end
+
+  desc 'Compare and update DB schema'
+  after :symlink_typo3core, :update_db_schema do
+    invoke "typo3cms:typo3console:update_db_schema"
+  end
+
+end

data/lib/capistrano/typo3/cms/base/tasks/install_tool.rake

@@ -0,0 +1,17 @@
+namespace :typo3cms do
+
+  desc 'Enable install tool'
+  task :enable_install_tool do
+    on roles(:app) do
+      execute :touch, release_path.join(Capistrano::Typo3::Cms::Base.basedir_prepend 'typo3conf/ENABLE_INSTALL_TOOL')
+    end
+  end
+
+  desc 'Disable install tool'
+  task :disable_install_tool do
+    on roles(:app) do
+      execute :rm, release_path.join(Capistrano::Typo3::Cms::Base.basedir_prepend 'typo3conf/ENABLE_INSTALL_TOOL')
+    end
+  end
+
+end

data/lib/capistrano/typo3/cms/base/tasks/typo3console.rake

@@ -0,0 +1,47 @@
+SSHKit.config.command_map.prefix[:typo3cms].unshift('php')
+
+namespace :typo3cms do
+
+  namespace :typo3console do
+
+    desc "Execute a provided typo3console command"
+    task :execute, :command_name do |t, args|
+      # ask only runs if argument is not provided
+      ask(:cmd, "help")
+      command = args[:command_name] || fetch(:cmd)
+
+      on release_roles(fetch(:typo3_cms_roles)), in: :sequence do
+        within Capistrano::Typo3::Cms::Base.basedir_append(release_path) do
+          with typo3_context: fetch(:typo3_cms_environment) do
+            execute :typo3cms, command, *args.extras
+          end
+        end
+      end
+    end
+
+    desc 'Clear caches'
+    task :clear_cache do
+      on release_roles(fetch(:typo3_cms_roles)), in: :sequence do
+        within Capistrano::Typo3::Cms::Base.basedir_append(release_path) do
+          with typo3_context: fetch(:typo3_cms_environment) do
+            execute :typo3cms, 'cache:flush'
+            execute :typo3cms, 'cache:warmup'
+          end
+        end
+      end
+    end
+
+    desc 'Compare and update DB schema'
+    task :update_db_schema do
+      on release_roles(fetch(:typo3_cms_roles)), in: :sequence do
+        within Capistrano::Typo3::Cms::Base.basedir_append(release_path) do
+          with typo3_context: fetch(:typo3_cms_environment) do
+            execute :typo3cms, 'databaseapi:databasecompare', '2,3,4'
+          end
+        end
+      end
+    end
+
+  end
+
+end

data/lib/capistrano/typo3/cms/base/tasks/typo3core.rake

@@ -0,0 +1,26 @@
+namespace :typo3cms do
+
+  task :symlink_core do
+    if fetch(:typo3_cms_symlink_core, false)
+      on release_roles :all do
+        unless test("[ -e #{fetch(:typo3_cms_symlink_core)} ]")
+          error ":typo3cms_symlink_core does not exist or it is not readable on host #{host}. Aborting..."
+          exit 1
+        end
+        within Capistrano::Typo3::Cms::Base.basedir_append(release_path) do
+          execute :rm, '-Rf', 'typo3_src'
+          execute :ln, '-s', fetch(:typo3_cms_symlink_core), 'typo3_src'
+        end
+      end
+    end
+  end
+
+end
+
+namespace :deploy do
+
+  after :updated, :symlink_typo3core do
+    invoke "typo3cms:symlink_core"
+  end
+
+end

data/lib/capistrano/typo3/cms/base/typo3console.rb

@@ -0,0 +1 @@
+load File.expand_path("../tasks/typo3console.rake", __FILE__)

data/lib/capistrano/typo3/cms/base/typo3core.rb

@@ -0,0 +1 @@
+load File.expand_path("../tasks/typo3core.rake", __FILE__)

data/lib/capistrano/typo3/cms/base/version.rb

@@ -0,0 +1,9 @@
+module Capistrano
+  module Typo3
+    module Cms
+      module Base
+        VERSION = "0.0.1"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-typo3-cms-base
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jose Antonio Guerra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Lean approach for deploying TYPO3 projects
+email:
+- balderiano@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-typo3-cms-base.gemspec
+- lib/capistrano/typo3/cms/base.rb
+- lib/capistrano/typo3/cms/base/configuration.rb
+- lib/capistrano/typo3/cms/base/defaults.rb
+- lib/capistrano/typo3/cms/base/deploy.rb
+- lib/capistrano/typo3/cms/base/install_tool.rb
+- lib/capistrano/typo3/cms/base/tasks/configuration.rake
+- lib/capistrano/typo3/cms/base/tasks/deploy.rake
+- lib/capistrano/typo3/cms/base/tasks/install_tool.rake
+- lib/capistrano/typo3/cms/base/tasks/typo3console.rake
+- lib/capistrano/typo3/cms/base/tasks/typo3core.rake
+- lib/capistrano/typo3/cms/base/typo3console.rb
+- lib/capistrano/typo3/cms/base/typo3core.rb
+- lib/capistrano/typo3/cms/base/version.rb
+homepage: https://github.com/jaguerra/capistrano-typo3-cms-base
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Deploy TYPO3 CMS projects with Capistrano 3
+test_files: []