ferry 1.3.3 → 2.0.0

data/lib/ferry/setup.rb

@@ -0,0 +1,22 @@
+include Ferry::DSL
+
+namespace :load do
+  task :defaults do
+    load 'ferry/defaults.rb'
+  end
+end
+
+stages.each do |stage|
+  Rake::Task.define_task(stage) do
+    set(:stage, stage.to_sym)
+
+    invoke 'load:defaults'
+    load deploy_config_path
+    load stage_config_path.join("#{stage}.rb")
+    load "ferry/#{fetch(:scm)}.rb"
+    I18n.locale = fetch(:locale, :en)
+    configure_backend
+  end
+end
+
+require 'ferry/dotfile'

data/lib/ferry/tasks/deploy.rake

@@ -0,0 +1,226 @@
+namespace :deploy do
+
+  task :starting do
+    invoke 'deploy:check'
+    invoke 'deploy:set_previous_revision'
+  end
+
+  task :updating => :new_release_path do
+    invoke "#{scm}:create_release"
+    invoke "deploy:set_current_revision"
+    invoke 'deploy:symlink:shared'
+  end
+
+  task :reverting do
+    invoke 'deploy:revert_release'
+  end
+
+  task :publishing do
+    invoke 'deploy:symlink:release'
+  end
+
+  task :finishing do
+    invoke 'deploy:cleanup'
+  end
+
+  task :finishing_rollback do
+    invoke 'deploy:cleanup_rollback'
+  end
+
+  task :finished do
+    invoke 'deploy:log_revision'
+  end
+
+  desc 'Check required files and directories exist'
+  task :check do
+    invoke "#{scm}:check"
+    invoke 'deploy:check:directories'
+    invoke 'deploy:check:linked_dirs'
+    invoke 'deploy:check:make_linked_dirs'
+    invoke 'deploy:check:linked_files'
+  end
+
+  namespace :check do
+    desc 'Check shared and release directories exist'
+    task :directories do
+      on release_roles :all do
+        execute :mkdir, '-p', shared_path, releases_path
+      end
+    end
+
+    desc 'Check directories to be linked exist in shared'
+    task :linked_dirs do
+      next unless any? :linked_dirs
+      on release_roles :all do
+        execute :mkdir, '-p', linked_dirs(shared_path)
+      end
+    end
+
+    desc 'Check directories of files to be linked exist in shared'
+    task :make_linked_dirs do
+      next unless any? :linked_files
+      on release_roles :all do |host|
+        execute :mkdir, '-p', linked_file_dirs(shared_path)
+      end
+    end
+
+    desc 'Check files to be linked exist in shared'
+    task :linked_files do
+      next unless any? :linked_files
+      on release_roles :all do |host|
+        linked_files(shared_path).each do |file|
+          unless test "[ -f #{file} ]"
+            error t(:linked_file_does_not_exist, file: file, host: host)
+            exit 1
+          end
+        end
+      end
+    end
+  end
+
+  namespace :symlink do
+    desc 'Symlink release to current'
+    task :release do
+      on release_roles :all do
+        tmp_current_path = release_path.parent.join(current_path.basename)
+        execute :ln, '-s', release_path, tmp_current_path
+        execute :mv, tmp_current_path, current_path.parent
+      end
+    end
+
+    desc 'Symlink files and directories from shared to release'
+    task :shared do
+      invoke 'deploy:symlink:linked_files'
+      invoke 'deploy:symlink:linked_dirs'
+    end
+
+    desc 'Symlink linked directories'
+    task :linked_dirs do
+      next unless any? :linked_dirs
+      on release_roles :all do
+        execute :mkdir, '-p', linked_dir_parents(release_path)
+
+        fetch(:linked_dirs).each do |dir|
+          target = release_path.join(dir)
+          source = shared_path.join(dir)
+          unless test "[ -L #{target} ]"
+            if test "[ -d #{target} ]"
+              execute :rm, '-rf', target
+            end
+            execute :ln, '-s', source, target
+          end
+        end
+      end
+    end
+
+    desc 'Symlink linked files'
+    task :linked_files do
+      next unless any? :linked_files
+      on release_roles :all do
+        execute :mkdir, '-p', linked_file_dirs(release_path)
+
+        fetch(:linked_files).each do |file|
+          target = release_path.join(file)
+          source = shared_path.join(file)
+          unless test "[ -L #{target} ]"
+            if test "[ -f #{target} ]"
+              execute :rm, target
+            end
+            execute :ln, '-s', source, target
+          end
+        end
+      end
+    end
+  end
+
+  desc 'Clean up old releases'
+  task :cleanup do
+    on release_roles :all do |host|
+      releases = capture(:ls, '-xtr', releases_path).split
+      if releases.count >= fetch(:keep_releases)
+        info t(:keeping_releases, host: host.to_s, keep_releases: fetch(:keep_releases), releases: releases.count)
+        directories = (releases - releases.last(fetch(:keep_releases)))
+        if directories.any?
+          directories_str = directories.map do |release|
+            releases_path.join(release)
+          end.join(" ")
+          execute :rm, '-rf', directories_str
+        else
+          info t(:no_old_releases, host: host.to_s, keep_releases: fetch(:keep_releases))
+        end
+      end
+    end
+  end
+
+  desc 'Remove and archive rolled-back release.'
+  task :cleanup_rollback do
+    on release_roles(:all) do
+      last_release = capture(:ls, '-xt', releases_path).split.first
+      last_release_path = releases_path.join(last_release)
+      if test "[ `readlink #{current_path}` != #{last_release_path} ]"
+        execute :tar, '-czf',
+          deploy_path.join("rolled-back-release-#{last_release}.tar.gz"),
+        last_release_path
+        execute :rm, '-rf', last_release_path
+      else
+        debug 'Last release is the current release, skip cleanup_rollback.'
+      end
+    end
+  end
+
+  desc 'Log details of the deploy'
+  task :log_revision do
+    on release_roles(:all) do
+      within releases_path do
+        execute %{echo "#{revision_log_message}" >> #{revision_log}}
+      end
+    end
+  end
+
+  desc 'Revert to previous release timestamp'
+  task :revert_release => :rollback_release_path do
+    on release_roles(:all) do
+      set(:revision_log_message, rollback_log_message)
+    end
+  end
+
+  task :new_release_path do
+    set_release_path
+  end
+
+  task :rollback_release_path do
+    on release_roles(:all) do
+      releases = capture(:ls, '-xt', releases_path).split
+      if releases.count < 2
+        error t(:cannot_rollback)
+        exit 1
+      end
+      last_release = releases[1]
+      set_release_path(last_release)
+      set(:rollback_timestamp, last_release)
+    end
+  end
+
+  desc "Place a REVISION file with the current revision SHA in the current release path"
+  task :set_current_revision  do
+    invoke "#{scm}:set_current_revision"
+    on release_roles(:all) do
+      within release_path do
+        execute :echo, "\"#{fetch(:current_revision)}\" >> REVISION"
+      end
+    end
+  end
+
+  task :set_previous_revision do
+    on release_roles(:all) do
+      target = release_path.join('REVISION')
+      if test "[ -f #{target} ]"
+        set(:previous_revision, capture(:cat, target, '2>/dev/null'))
+      end
+    end
+  end
+
+  task :restart
+  task :failed
+
+end

data/lib/ferry/tasks/framework.rake

@@ -0,0 +1,52 @@
+namespace :deploy do
+
+  desc "Preparing ferry for deployment."
+  task :starting do
+  end
+
+  desc 'Started'
+  task :started do
+  end
+
+  desc 'Revert database to previous release.'
+  task :reverting do
+  end
+
+  desc 'Reverted'
+  task :reverted do
+  end
+
+  desc 'Finish the deployment, cleaning up.'
+  task :finishing do
+  end
+
+  desc 'Finish the rollback, clean up.'
+  task :finishing_rollback do
+  end
+
+  desc 'Finished'
+  task :finished do
+  end
+
+  desc 'Rollback to previous release.'
+  task :rollback do
+    %w{ starting started
+        reverting reverted
+        publishing published
+        finishing_rollback finished }.each do |task|
+      invoke "deploy:#{task}"
+    end
+  end
+end
+
+desc 'Deploy a new release.'
+task :deploy do
+  set(:deploying, true)
+  %w{ starting started
+      updating updated
+      publishing published
+      finishing finished }.each do |task|
+    invoke "deploy:#{task}"
+  end
+end
+task default: :deploy

data/lib/ferry/tasks/install.rake

@@ -0,0 +1,41 @@
+require 'erb'
+require 'pathname'
+desc 'Install Ferry, ferry install STAGES=test,development,production'
+task :install do
+  envs = ENV['STAGES'] || 'test,development,production'
+
+  tasks_dir = Pathname.new('lib/ferry/tasks')
+  config_dir = Pathname.new('config')
+  deploy_dir = config_dir.join('deploy_ferry')
+
+  deploy_rb = File.expand_path("../../templates/deploy_ferry.rb.erb", __FILE__)
+  stage_rb = File.expand_path("../../templates/stage.rb.erb", __FILE__)
+  ferryfile = File.expand_path("../../templates/Ferryfile", __FILE__)
+
+  mkdir_p deploy_dir
+
+  entries = [{template: deploy_rb, file: config_dir.join('deploy.rb')}]
+  entries += envs.split(',').map { |stage| {template: stage_rb, file: deploy_dir.join("#{stage}.rb")} }
+
+  entries.each do |entry|
+    if File.exists?(entry[:file])
+      warn "[skip] #{entry[:file]} already exists"
+    else
+      File.open(entry[:file], 'w+') do |f|
+        f.write(ERB.new(File.read(entry[:template])).result(binding))
+        puts I18n.t(:written_file, scope: :ferry, file: entry[:file])
+      end
+    end
+  end
+
+  mkdir_p tasks_dir
+
+  if File.exists?('Ferryfile')
+    warn "[skip] Ferryfile already exists"
+  else
+    FileUtils.cp(ferryfile, 'Ferryfile')
+    puts I18n.t(:written_file, scope: :ferry, file: 'Ferryfile')
+  end
+
+  puts I18n.t :set_sail, scope: :deploy
+end

data/lib/ferry/templates/Ferryfile

@@ -0,0 +1,8 @@
+# Load DSL and set up stages
+require 'ferry/setup'
+
+# Include default deployment tasks
+require 'ferry/deploy'
+
+# Load custom tasks from `lib/ferry/tasks` if you have any defined
+Dir.glob('lib/ferry/tasks/*.rake').each { |r| import r }

data/lib/ferry/templates/deploy_ferry.rb.erb

@@ -0,0 +1,21 @@
+# config valid only for current version of Ferry
+lock '<%= Ferry::VERSION %>'
+
+set :database, 'my_db_name'
+set :db_role, 'my_db_role'
+set :server, 'my_ip'
+set :server_role, 'my_server_role'
+
+namespace :deploy do
+
+  after :restart, :clear_cache do
+    on roles(:web), in: :groups, limit: 3, wait: 10 do
+      # Here we can do anything such as:
+      # within release_path do
+      #   execute :rake, 'cache:clear'
+      #   # or execute anything that we define in tasks
+      # end
+    end
+  end
+
+end

data/lib/ferry/templates/stage.rb.erb

@@ -0,0 +1 @@
+# still deciding what we can use this for

data/lib/ferry/upload_task.rb

@@ -0,0 +1,9 @@
+require 'rake/file_creation_task'
+
+module Ferry
+  class UploadTask < Rake::FileCreationTask
+    def needed?
+      true # always needed because we can't check remote hosts duhhhhhh
+    end
+  end
+end

data/lib/ferry/utilities.rb

@@ -28,18 +28,6 @@ module Ferry
       `#{command}`
     end
 
-    def make_starter_file
-      if !File.exist?("lib/tasks/ferry.rake")
-        install_dir = `bundle show ferry`.chomp
-        starter_file_contents = File.open("#{install_dir}/doc/ferry_rake_contents.rb", "rb")
-        contents = starter_file_contents.read
-        File.open("lib/tasks/ferry.rake", 'w') {|f| f.write(contents)}
-        puts "/lib/tasks/ferry.rake created!"
-      else
-        puts "/lib/tasks/ferry.rake already exists - but you knew that already ... didn't you?"
-      end
-    end
-
     def print_version
       puts "Ferry #{Ferry::VERSION}"
     end

data/lib/ferry/version.rb

@@ -1,3 +1,3 @@
 module Ferry
-  VERSION = "1.3.3"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ferry
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Anthony Corletti
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2016-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -213,16 +213,40 @@ files:
 - README.md
 - Rakefile
 - bin/ferry
-- doc/ferry_rake_contents.rb
-- doc/ferry_readme_icon.png
-- doc/ferry_readme_icon_2.png
 - ferry.gemspec
+- img/ferry_readme_icon.png
+- img/ferry_readme_icon_2.png
+- lib/Ferryfile
 - lib/ferry.rb
-- lib/ferry/dsl/captain.rb
+- lib/ferry/all.rb
+- lib/ferry/configuration.rb
+- lib/ferry/configuration/filter.rb
+- lib/ferry/configuration/question.rb
+- lib/ferry/configuration/server.rb
+- lib/ferry/configuration/servers.rb
+- lib/ferry/defaults.rb
+- lib/ferry/deploy.rb
+- lib/ferry/dotfile.rb
+- lib/ferry/dsl.rb
+- lib/ferry/dsl/env.rb
+- lib/ferry/dsl/paths.rb
+- lib/ferry/dsl/stages.rb
+- lib/ferry/dsl/task_enhancements.rb
 - lib/ferry/dumper.rb
 - lib/ferry/exporter.rb
 - lib/ferry/filler.rb
+- lib/ferry/framework.rb
+- lib/ferry/i18n.rb
 - lib/ferry/importer.rb
+- lib/ferry/install.rb
+- lib/ferry/setup.rb
+- lib/ferry/tasks/deploy.rake
+- lib/ferry/tasks/framework.rake
+- lib/ferry/tasks/install.rake
+- lib/ferry/templates/Ferryfile
+- lib/ferry/templates/deploy_ferry.rb.erb
+- lib/ferry/templates/stage.rb.erb
+- lib/ferry/upload_task.rb
 - lib/ferry/utilities.rb
 - lib/ferry/version.rb
 - spec/config/database.yml
@@ -273,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ferry is a data migration and visualization command line tool rubygem