capistrano-alchemy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23b06236d8630f276cc6449283e6ed27b8f4bc87
+  data.tar.gz: 64dc5c41fc122c2e272b2a2aa8243da990c34dfc
+SHA512:
+  metadata.gz: a4360e229f218c1813783cfe50ce07ef866758a2234aaea8ead73d038a15110bdb604887c9e5ebf5c884e124ab242214f62fe662e975d887610869a2395a652e
+  data.tar.gz: 66939c594c735184266cf6e58033b2d6b2c8376f43497a5e37e97f518cb546ddb7b3e12bbf847b7d65d4a7c339d58a5762f39d625e9769b361c86cd8482ab5ea

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-alchemy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Martin Meyerhoff
+
+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,70 @@
+# Capistrano Tasks for Alchemy CMS
+
+Capistrano::Alchemy adds four folders to Capistranos `shared_folders` array: `uploads/pictures`, `uploads/attachments`, `tmp/cache/assets`, and Alchemy's picture cache. It also runs Alchemy's Seeder after migrating the database.
+
+In addition, it offers several tasks to synchronize your shared folders and your database between environments.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-alchemy', github: 'AlchemyCMS/capistrano-alchemy', branch: 'master', group: :development, require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-alchemy
+
+If your application is not prepared for capistrano yet, you need to do so now:
+
+    $ bundle exec cap install
+
+You have to add the `Capistrano::Alchemy` and Rails specific tasks to your `Capfile`
+
+```ruby
+require 'capistrano/rails'
+require 'capistrano/alchemy'
+```
+
+## Usage
+
+
+### Synchronize your data
+
+Alchemy Capistrano receipts offer much more then only deployment related tasks. We also have tasks to make your local development easier. To get a list of all receipts type:
+
+```shell
+$ bundle exec cap -T alchemy
+```
+
+#### Import data from server
+
+```shell
+$ bundle exec cap staging alchemy:import:all
+```
+
+This imports your staging server's data onto your local development machine. This is very handy if you want to clone the current server state. Replace `staging` for `production` if you need the production data.
+
+#### Export data to server
+
+That even works the other way around:
+
+```shell
+$ bundle exec cap staging alchemy:export:all
+```
+
+**NOTE:** This will **overwrite the database** on your `staging` server. But calm down my dear friend, Alchemy will ask you to perform a backup before overwriting it.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/capistrano-alchemy/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-alchemy.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/alchemy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-alchemy"
+  spec.version       = Capistrano::Alchemy::VERSION
+  spec.authors       = ["Martin Meyerhoff"]
+  spec.email         = ["mamhoff@googlemail.com"]
+  spec.summary       = %q{Capistrano Tasks for AlchemyCMS.}
+  spec.homepage      = "https://alchemy-cms.com"
+  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_dependency "capistrano-rails", "~> 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'alchemy_cms', "~> 3.0"
+end

data/lib/capistrano/alchemy/deploy_support.rb

@@ -0,0 +1,55 @@
+require 'spinner'
+
+module Capistrano::Alchemy::DeploySupport
+  # Makes a backup of the remote database and stores it in db/ folder
+  def backup_database
+    puts 'Backing up database'
+    timestamp = Time.now.strftime('%Y-%m-%d-%H-%M')
+    rake "RAILS_ENV=#{fetch(:rails_env, 'production')} alchemy:db:dump DUMP_FILENAME=db/dump-#{timestamp}.sql"
+  end
+
+  # Sends the database via ssh to the server
+  def export_database(server)
+    puts "Exporting the database. Please wait..."
+    system db_export_cmd(server)
+  end
+
+  def db_import_cmd(server)
+    raise "No server given" if !server
+    dump_cmd = "cd #{release_path} && bundle exec rake RAILS_ENV=#{fetch(:rails_env, 'production')} alchemy:db:dump"
+    sql_stream = "#{ssh_command(server)} '#{dump_cmd}'"
+    "#{sql_stream} | #{database_import_command(database_config['adapter'])} 1>/dev/null 2>&1"
+  end
+
+  # The actual export command that sends the data
+  def db_export_cmd(server)
+    raise "No server given" if !server
+    import_cmd = "cd #{release_path} && bundle exec rake RAILS_ENV=#{fetch(:rails_env, 'production')} alchemy:db:import"
+    ssh_cmd = "#{ssh_command(server)} '#{import_cmd}'"
+    "#{database_dump_command(database_config['adapter'])} | #{ssh_cmd}"
+  end
+
+  # Sends files of given type via rsync to server
+  def send_files(type, server)
+    raise "No server given" if !server
+    FileUtils.mkdir_p "./uploads/#{type}"
+    system "rsync --progress -rue 'ssh -p #{ssh_port(server)}' uploads/#{type} #{server.user}@#{server.hostname}:#{shared_path}/uploads/"
+  end
+
+  def get_files(type, server)
+    raise "No server given" if !server
+    FileUtils.mkdir_p "./uploads"
+    puts "Importing #{type}. Please wait..."
+    system "rsync --progress -rue 'ssh -p #{ssh_port(server)}' #{server.user}@#{server.hostname}:#{shared_path}/uploads/#{type} ./uploads/"
+  end
+
+  private
+
+  def ssh_command(server)
+    "ssh -p #{ssh_port(server)} #{server.user}@#{server.hostname}"
+  end
+
+  def ssh_port(server)
+    server.port || 22
+  end
+end

data/lib/capistrano/alchemy/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Alchemy
+    VERSION = "0.1.0"
+  end
+end

data/lib/capistrano/alchemy.rb

@@ -0,0 +1,16 @@
+require "capistrano/alchemy/version"
+
+require 'fileutils'
+require 'alchemy/tasks/helpers'
+# Loading the rails app
+# require './config/environment.rb'
+# so we can read the current mount point of Alchemy
+require 'alchemy/mount_point'
+require 'capistrano/alchemy/deploy_support'
+
+include Alchemy::Tasks::Helpers
+include Capistrano::Alchemy::DeploySupport
+
+load File.expand_path('../tasks/alchemy.rake', __FILE__)
+load File.expand_path('../tasks/alchemy_capistrano_hooks.rake', __FILE__)
+

data/lib/capistrano/tasks/alchemy.rake

@@ -0,0 +1,168 @@
+namespace :alchemy do
+
+  # TODO: split up this namespace into something that runs once on `cap install` and
+  # once on every deploy
+  desc "Prepare Alchemy for deployment."
+  task :default_paths do
+    set :alchemy_picture_cache_path,
+      -> { File.join('public', Alchemy::MountPoint.get, 'pictures') }
+
+    set :linked_dirs, fetch(:linked_dirs, []) + [
+      "uploads/pictures",
+      "uploads/attachments",
+      fetch(:alchemy_picture_cache_path),
+      "tmp/cache/assets"
+    ]
+
+    # TODO: Check, if this is the right approach to ensure that we don't overwrite existing settings?
+    # Or does Capistrano already handle this for us?
+    set :linked_files, fetch(:linked_files, []) + %w(config/database.yml)
+  end
+
+  # TODO: Do we really need this in Alchemy or should we release an official Capistrano plugin for that?
+  namespace :database_yml do
+    desc "Creates the database.yml file"
+    task create: ['alchemy:default_paths', 'deploy:check'] do
+      set :db_environment, ask("the environment", fetch(:rails_env, 'production'))
+      set :db_adapter, ask("database adapter (mysql or postgresql)", 'mysql')
+      set :db_adapter, fetch(:db_adapter).gsub(/\Amysql\z/, 'mysql2')
+      set :db_name, ask("database name", nil)
+      set :db_username, ask("database username", nil)
+      set :db_password, ask("database password", nil)
+      default_db_host = fetch(:db_adapter) == 'mysql2' ? 'localhost' : '127.0.0.1'
+      set :db_host, ask("database host", default_db_host)
+      db_config = ERB.new <<-EOF
+#{fetch(:db_environment)}:
+  adapter: #{fetch(:db_adapter)}
+  encoding: utf8
+  reconnect: false
+  pool: 5
+  database: #{fetch(:db_name)}
+  username: #{fetch(:db_username)}
+  password: #{fetch(:db_password)}
+  host: #{fetch(:db_host)}
+EOF
+      on roles :app do
+        execute :mkdir, '-p', "#{shared_path}/config"
+        upload! StringIO.new(db_config.result), "#{shared_path}/config/database.yml"
+      end
+    end
+  end
+
+  namespace :db do
+    desc "Seeds the database with essential data."
+    task seed: ['alchemy:default_paths', 'deploy:check'] do
+      on roles :db do
+        within release_path do
+          with rails_env: fetch(:rails_env, 'production') do
+            execute :rake, 'db:seed'
+          end
+        end
+      end
+    end
+
+    desc "Dumps the database into 'db/dumps' on the server."
+    task dump: ['alchemy:default_paths', 'deploy:check'] do
+      on roles :db do
+        within release_path do
+          timestamp = Time.now.strftime('%Y-%m-%d-%H-%M')
+          execute :mkdir, '-p', 'db/dumps'
+          with dump_filename: "db/dumps/#{timestamp}.sql", rails_env: fetch(:rails_env, 'production') do
+            execute :rake, 'alchemy:db:dump'
+          end
+        end
+      end
+    end
+  end
+
+  namespace :import do
+    desc "Imports all data (Pictures, attachments and the database) into your local development machine."
+    task all: ['alchemy:default_paths', 'deploy:check'] do
+      on roles [:app, :db] do
+        invoke('alchemy:import:pictures')
+        puts "\n"
+        invoke('alchemy:import:attachments')
+        puts "\n"
+        invoke('alchemy:import:database')
+      end
+    end
+
+    desc "Imports the server database into your local development machine."
+    task database: ['alchemy:default_paths', 'deploy:check'] do
+      on roles :db do |server|
+        puts "Importing database. Please wait..."
+        system db_import_cmd(server)
+        puts "Done."
+      end
+    end
+
+    desc "Imports attachments into your local machine using rsync."
+    task attachments: ['alchemy:default_paths', 'deploy:check'] do
+      on roles :app do |server|
+        get_files(:attachments, server)
+      end
+    end
+
+    desc "Imports pictures into your local machine using rsync."
+    task pictures: ['alchemy:default_paths', 'deploy:check'] do
+      on roles :app do |server|
+        get_files(:pictures, server)
+      end
+    end
+  end
+
+  namespace :export do
+    desc "Sends all data (Pictures, attachments and the database) to your remote machine."
+    task all: ['alchemy:default_paths', 'deploy:check'] do
+      invoke 'alchemy:export:pictures'
+      invoke 'alchemy:export:attachments'
+      invoke 'alchemy:export:database'
+    end
+
+    desc "Imports the server database into your local development machine."
+    task database: ['alchemy:default_paths', 'deploy:check'] do
+      on roles :db do |host|
+        within release_path do
+          if ask(:backup_confirm, 'WARNING: This task will overwrite your remote database. Do you want me to make a backup? (y/n)') == "y"
+            backup_database
+            export_database(host)
+          else
+            if ask(:overwrite_confirm, 'Are you sure? (y/n)') == "y"
+              export_database(host)
+            else
+              backup_database
+              export_database(host)
+            end
+          end
+        end
+      end
+    end
+
+    desc "Sends attachments to your remote machine using rsync."
+    task attachments: ['alchemy:default_paths', 'deploy:check'] do
+      on roles :app do |host|
+        send_files :attachments, host
+      end
+    end
+
+    desc "Sends pictures to your remote machine using rsync."
+    task pictures: ['alchemy:default_paths', 'deploy:check'] do
+      on roles :app do |host|
+        send_files :pictures, host
+      end
+    end
+  end
+
+  desc "Upgrades production database to current Alchemy CMS version"
+  task upgrade: ['alchemy:default_paths', 'deploy:check'] do
+    on roles [:app, :db] do
+      within release_path do
+        with rails_env: fetch(:rails_env, 'production') do
+          execute :rake, 'alchemy:upgrade'
+        end
+      end
+    end
+  end
+end
+
+

data/lib/capistrano/tasks/alchemy_capistrano_hooks.rake

@@ -0,0 +1,10 @@
+namespace :load do
+  task :defaults do
+    invoke 'alchemy:default_paths'
+  end
+end
+
+namespace :deploy do
+  after :migrate, 'alchemy:db:seed'
+end
+

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-alchemy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Meyerhoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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: alchemy_cms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- mamhoff@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-alchemy.gemspec
+- lib/capistrano-alchemy.rb
+- lib/capistrano/alchemy.rb
+- lib/capistrano/alchemy/deploy_support.rb
+- lib/capistrano/alchemy/version.rb
+- lib/capistrano/tasks/alchemy.rake
+- lib/capistrano/tasks/alchemy_capistrano_hooks.rake
+homepage: https://alchemy-cms.com
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Capistrano Tasks for AlchemyCMS.
+test_files: []