Skip to content

Commit

Permalink
Move Chewy tasks out of deploy namespace
Browse files Browse the repository at this point in the history
  • Loading branch information
@nbulaj
nbulaj committed Oct 20, 2016
1 parent c304302 commit d26a4d9
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 112 deletions.
23 changes: 12 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Moreover, it adds the possibility of manual index management with the base Chewy

## Requirements

* Ruby >= 1.9.3
* Capistrano >= 3.0
* Chewy >= 0.4

Expand Down Expand Up @@ -59,11 +60,11 @@ require 'capistrano/chewy'
then you can use `cap -T` to list `Capistrano::Chewy` tasks:

```ruby
cap deploy:chewy:rebuild # Reset only modified Chewy indexes
cap deploy:chewy:reset # Destroy, recreate and import data to all the indexes
cap deploy:chewy:reset[indexes] # Destroy, recreate and import data to the specified indexes
cap deploy:chewy:update # Updates data to all the indexes
cap deploy:chewy:update[indexes] # Updates data to the specified indexes
cap chewy:rebuild # Reset only modified Chewy indexes
cap chewy:reset # Destroy, recreate and import data to all the indexes
cap chewy:reset[indexes] # Destroy, recreate and import data to the specified indexes
cap chewy:update # Updates data to all the indexes
cap chewy:update[indexes] # Updates data to the specified indexes
```

By default `Capistrano::Chewy` adds `deploy:chewy:rebuild` task after `deploy:updated` and `deploy:reverted`.
Expand All @@ -75,12 +76,12 @@ You can setup the following:

```ruby
# deploy.rb
set :chewy_conditionally_reset, false # Reset only modified Chewy indexes, true by default
set :chewy_path, 'app/my_indexes' # Path to Chewy indexes, 'app/chewy' by default
set :chewy_env, :chewy_production # Environment variable for Chewy, equal to RAILS_ENV by default
set :chewy_role, :web # Chewy role, :app by default
set :chewy_default_hooks, false # Add default capistrano-chewy hooks to your deploy flow, true by default
set :chewy_delete_removed_indexes, false # Delete indexes which files have been deleted, true by default
set :chewy_conditionally_reset, false # Reset only modified Chewy indexes, true by default
set :chewy_path, 'app/my_indexes' # Path to Chewy indexes, 'app/chewy' by default
set :chewy_env, :chewy_production # Environment variable for Chewy, equal to RAILS_ENV by default
set :chewy_role, :web # Chewy role, :app by default
set :chewy_default_hooks, false # Add default capistrano-chewy hooks to your deploy flow, true by default
set :chewy_delete_removed_indexes, false # Delete indexes which files have been deleted, true by default
```

## Contributing
Expand Down
210 changes: 109 additions & 101 deletions lib/capistrano/tasks/chewy.rake
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,129 +11,137 @@ end

namespace :deploy do
before :starting, :check_chewy_hooks do
invoke :'deploy:chewy:add_default_hooks' if fetch(:chewy_default_hooks)
invoke :'chewy:add_default_hooks' if fetch(:chewy_default_hooks)
end
end

namespace :chewy do
def delete_indexes(index_files)
index_classes = index_files.map { |file| File.basename(file, '.rb').camelize }.uniq
runner_code = "[#{index_classes.join(', ')}].each(&:delete)"

# Removed index files exists only in the old (current) release
within current_path do
with rails_env: fetch(:chewy_env) do
info "Removing indexes: #{index_classes.join(',')}"
execute :rails, "runner '#{runner_code}'"
end
end
end

def reset_modified_indexes(index_files)
index_names = index_files.map { |file| File.basename(file, '_index.rb') }.join(',')

namespace :chewy do
# Adds default Capistrano::Chewy hooks to the deploy flow
task :add_default_hooks do
after :'deploy:updated', 'deploy:chewy:rebuild'
after :'deploy:reverted', 'deploy:chewy:rebuild'
within release_path do
with rails_env: fetch(:chewy_env) do
info "Modified or new indexes: #{index_names}"
execute :rake, "chewy:reset[#{index_names}]"
end
end
end

# Adds default Capistrano::Chewy hooks to the deploy flow
task :add_default_hooks do
after :'deploy:updated', 'chewy:rebuild'
after :'deploy:reverted', 'chewy:rebuild'
end

# Default Chewy rake tasks
desc 'Destroy, recreate and import data to all or specified (pass with [one,two]) indexes'
task :reset do |_task, args|
indexes = args.extras

on roles fetch(:chewy_role) do
within release_path do
with rails_env: fetch(:chewy_env) do
if indexes.any?
execute :rake, "chewy:reset[#{indexes.join(',')}]"
else
# Simply chewy:reset / chewy:update for Chewy > 0.8.4
execute :rake, 'chewy:reset:all'
end
# Default Chewy rake tasks
desc 'Destroy, recreate and import data to all or specified (pass with [one,two]) indexes'
task :reset do |_task, args|
indexes = args.extras

on roles fetch(:chewy_role) do
within release_path do
with rails_env: fetch(:chewy_env) do
if indexes.any?
execute :rake, "chewy:reset[#{indexes.join(',')}]"
else
# Simply chewy:reset / chewy:update for Chewy > 0.8.4
execute :rake, 'chewy:reset:all'
end
end
end
end
end

desc 'Updates data to all or specified (passed with [one,two]) indexes'
task :update do |_task, args|
indexes = args.extras

on roles fetch(:chewy_role) do
within release_path do
with rails_env: fetch(:chewy_env) do
if indexes.any?
execute :rake, "chewy:update[#{indexes.join(',')}]"
else
execute :rake, 'chewy:update:all'
end
desc 'Updates data to all or specified (passed with [one,two]) indexes'
task :update do |_task, args|
indexes = args.extras

on roles fetch(:chewy_role) do
within release_path do
with rails_env: fetch(:chewy_env) do
if indexes.any?
execute :rake, "chewy:update[#{indexes.join(',')}]"
else
execute :rake, 'chewy:update:all'
end
end
end
end
end

# Smart rebuild of modified Chewy indexes
desc 'Reset Chewy indexes if they have been added, changed or removed'
task :rebuild do
on roles fetch(:chewy_role) do
info "Checking Chewy directory (#{fetch(:chewy_path)})"
# Smart rebuild of modified Chewy indexes
desc 'Reset Chewy indexes if they have been added, changed or removed'
task :rebuild do
on roles fetch(:chewy_role) do
info "Checking Chewy directory (#{fetch(:chewy_path)})"

chewy_path = File.join(release_path, fetch(:chewy_path))
unless test("[ -d #{chewy_path} ]")
error "Directory #{chewy_path} doesn't exist!"
exit 1
end
chewy_path = File.join(release_path, fetch(:chewy_path))
unless test("[ -d #{chewy_path} ]")
error "Directory #{chewy_path} doesn't exist!"
exit 1
end

if fetch(:chewy_conditionally_reset)
if test('diff -v')
info 'Running smart indexes reset...'
invoke :'deploy:chewy:rebuilding'
else
error "Can't check the difference between Chewy indexes - install 'diff' tool first!"
exit 1
end
if fetch(:chewy_conditionally_reset)
if test('diff -v')
info 'Running smart indexes reset...'
invoke :'chewy:rebuilding'
else
info 'Running chewy:reset:all'
invoke :'deploy:chewy:reset:all'
error "Can't check the difference between Chewy indexes - install 'diff' tool first!"
exit 1
end
else
info 'Running chewy:reset:all'
invoke :'chewy:reset:all'
end
end
end

desc 'Runs smart Chewy indexes rebuilding (only for changed files)'
task :rebuilding do
on roles fetch(:chewy_role) do
chewy_path = fetch(:chewy_path)
info "Checking changes in #{chewy_path}"

chewy_release_path = File.join(release_path, chewy_path)
chewy_current_path = File.join(current_path, chewy_path)

# -q, --brief report only when files differ
# -E, --ignore-tab-expansion ignore changes due to tab expansion
# -Z, --ignore-trailing-space ignore white space at line end
# -B, --ignore-blank-lines ignore changes where lines are all blank
#
diff_args = "-qZEB #{chewy_release_path} #{chewy_current_path}"
indexes_diff = capture :diff, diff_args, raise_on_non_zero_exit: false
changes = ::CapistranoChewy::DiffParser.parse(indexes_diff, chewy_current_path, chewy_release_path)

# If diff is empty then indices have not changed
if changes.empty?
info 'Skipping `deploy:chewy:rebuilding` (nothing changed in the Chewy path)'
else
indexes_to_reset = changes.changed.concat(changes.added)
indexes_to_delete = changes.removed

# Reset indexes which have been modified or added
if indexes_to_reset.any?
indexes = indexes_to_reset.map { |file| File.basename(file, '_index.rb') }.join(',')

within release_path do
with rails_env: fetch(:chewy_env) do
info "Modified or new indexes: #{indexes}"
execute :rake, "chewy:reset[#{indexes}]"
end
end
end
desc 'Runs smart Chewy indexes rebuilding (only for changed files)'
task :rebuilding do
on roles fetch(:chewy_role) do
chewy_path = fetch(:chewy_path)
info "Checking changes in #{chewy_path}"

chewy_release_path = File.join(release_path, chewy_path)
chewy_current_path = File.join(current_path, chewy_path)

# -q, --brief report only when files differ
# -E, --ignore-tab-expansion ignore changes due to tab expansion
# -Z, --ignore-trailing-space ignore white space at line end
# -B, --ignore-blank-lines ignore changes where lines are all blank
#
diff_args = "-qZEB #{chewy_release_path} #{chewy_current_path}"
indexes_diff = capture :diff, diff_args, raise_on_non_zero_exit: false
changes = ::CapistranoChewy::DiffParser.parse(indexes_diff, chewy_current_path, chewy_release_path)

# If diff is empty then indices have not changed
if changes.empty?
info 'Skipping `chewy:rebuilding` (nothing changed in the Chewy path)'
else
indexes_to_reset = changes.changed.concat(changes.added)
indexes_to_delete = changes.removed

# Reset indexes which have been modified or added
if indexes_to_reset.any?
reset_modified_indexes(indexes_to_reset)
end

# Delete indexes which have been removed
if indexes_to_delete.any? && fetch(:chewy_delete_removed_indexes)
indexes = indexes_to_delete.map { |file| File.basename(file, '.rb').camelize }.uniq
runner_code = "[#{indexes.join(', ')}].each(&:delete)"

# Removed index files exists only in the old (current) release
within current_path do
with rails_env: fetch(:chewy_env) do
info "Removing indexes: #{indexes.join(',')}"
execute :rails, "runner '#{runner_code}'"
end
end
end
# Delete indexes which have been removed
if indexes_to_delete.any? && fetch(:chewy_delete_removed_indexes)
delete_indexes(indexes_to_delete)
end
end
end
Expand Down

0 comments on commit d26a4d9

Please sign in to comment.