capistrano-chewy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36801dffebe67a59da0de98084f1c2775d47371f
-  data.tar.gz: 50afbaef407413dd996110e7dc946690b8f63af9
+  metadata.gz: cc03aaa995d6e19dcf3628db3ee4ebe0ded4e093
+  data.tar.gz: 6d4d0d9068d11e6c3b2443fdf8f3cdeec181ef75
 SHA512:
-  metadata.gz: ee2759d696d557a1e858347dbc4c854b4d705de2447d31145c205e1ba7486cd2ff945839e461a1825254a88d6667850f46b1481d1e9bd5f85f02b15856574987
-  data.tar.gz: edf506dd5325071b2b06c28a3f9cac42d16bfea928029472117319da29551e8dda7b8c417ea5dc6ba41c16bf0450f0e866c6a88c8891d651cb1e73aa0a878971
+  metadata.gz: 66e508f1ee8d0c208bb70be8ab31bfadb579c01a7f4c1c8500beeb10e4d7ab8c073ce37afab9f453ca24555866ef6f360b4bedc2ff6e6197dc8cbc4742ec81b4
+  data.tar.gz: dba7535113a333ad4b302cf41bd3e0e719976de73e4bcba9d63e49c94615afabfd0da9b2cbfca0094f0d47222fd72b05b515a0170b490ae02919f21c2a3d87ac

data/README.md

@@ -4,7 +4,7 @@
 
 Manage and continuously rebuild your ElasticSearch indexes with [Chewy](https://github.com/toptal/chewy/) and [Capistrano](https://github.com/capistrano/capistrano) v3.
 
-`Capistrano::Chewy` gem adds automatic conditionally reset only modified Chewy indexes to your deploy flow so you do not have to build them manually.
+`Capistrano::Chewy` gem adds automatic conditionally reset of only modified Chewy indexes and the removal of deleted index files to your deploy flow so you do not have to do it manually.
 Moreover, it adds the possibility of manual index management with the base Chewy tasks on the remote server.
 
 ## Requirements
@@ -38,6 +38,12 @@ Or install it yourself as:
 $ gem install capistrano-chewy
 ```
 
+If you want to use the latest version from the `master`, then add the following line to your Gemfile:
+
+```ruby
+gem 'capistrano-chewy', git: 'https://github.com/nbulaj/capistrano-chewy.git'
+```
+
 ## Usage
 
 Require it in your `Capfile`:
@@ -45,7 +51,9 @@ Require it in your `Capfile`:
 ```ruby
 # Capfile
 
+...
 require 'capistrano/chewy'
+...
 ```
 
 then you can use `cap -T` to list `Capistrano::Chewy` tasks:
@@ -58,6 +66,9 @@ cap deploy:chewy:update             # Updates data to all the indexes
 cap deploy:chewy:update[indexes]    # Updates data to the specified indexes
 ```
 
+By default `Capistrano::Chewy` adds `deploy:chewy:rebuild` task after `deploy:updated` and `deploy:reverted`.
+If you want to change it, then you need to disable default gem hooks by setting `chewy_default_hooks` to `false` in your deployment config and manually define the order of the tasks.
+
 ## Configuration
 
 You can setup the following:
@@ -68,8 +79,8 @@ set :chewy_conditionally_reset, false # Reset only modified Chewy indexes, true
 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_skip, true # Skip processing Chewy indexes during deploy, false 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

data/{capistrano3-postgres.gemspec → capistrano-chewy.gemspec}

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.name          = 'capistrano-chewy'
   spec.version       = CapistranoChewy.gem_version
   spec.authors       = ['Nikita Bulai']
-  spec.date          = '2016-10-18'
-  spec.email         = ['bulainikita@gmail.com']
+  spec.date          = '2016-10-19'
+  spec.email         = ['bulajnikita@gmail.com']
   spec.summary       = 'Manage and continuously rebuild your ElasticSearch indexes with Chewy and Capistrano'
   spec.description   = 'Manage and continuously rebuild your ElasticSearch indexes with Chewy and Capistrano v3.'
   spec.homepage      = 'https://github.com/nbulaj/capistrano-chewy'

data/lib/capistrano-chewy/diff_parser.rb

@@ -8,6 +8,10 @@ module CapistranoChewy
         @changed = []
         @added = []
       end
+
+      def empty?
+        [@removed, @changed, @added].all?(&:empty?)
+      end
     end
 
     CHANGED_FILE_PATTERN = /Files\s+.+\s+and\s+(.+)\s+differ/i
@@ -15,7 +19,7 @@ module CapistranoChewy
 
     class << self
       def parse(diff, current_path, release_path)
-        raise ArgumentError, 'current_path can not be the same as release_path!' if current_path == release_path
+        return Result.new if current_path == release_path
 
         diff.split("\n").each_with_object(Result.new) do |line, result|
           # File was changed

data/lib/capistrano-chewy/version.rb

@@ -5,7 +5,7 @@ module CapistranoChewy
 
   module VERSION
     MAJOR = 0
-    MINOR = 1
+    MINOR = 2
     TINY = 0
 
     STRING = [MAJOR, MINOR, TINY].compact.join('.')

data/lib/capistrano/tasks/chewy.rake

@@ -1,11 +1,11 @@
 namespace :load do
   task :defaults do
+    set :chewy_default_hooks, -> { true }
     set :chewy_conditionally_reset, -> { true }
     set :chewy_path, -> { 'app/chewy' }
     set :chewy_env, -> { fetch(:rails_env, fetch(:stage)) }
     set :chewy_role, -> { :app }
-    set :chewy_skip, -> { false }
-    set :chewy_default_hooks, -> { true }
+    set :chewy_delete_removed_indexes, -> { true }
   end
 end
 
@@ -17,7 +17,8 @@ namespace :deploy do
   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:updated', 'deploy:chewy:rebuild'
+      after :'deploy:reverted', 'deploy:chewy:rebuild'
     end
 
     # Default Chewy rake tasks
@@ -60,11 +61,6 @@ namespace :deploy do
     desc 'Reset Chewy indexes if they have been added, changed or removed'
     task :rebuild do
       on roles fetch(:chewy_role) do
-        if fetch(:chewy_skip)
-          info 'Skipping task according to the deploy settings'
-          exit 0
-        end
-
         info "Checking Chewy directory (#{fetch(:chewy_path)})"
 
         chewy_path = File.join(release_path, fetch(:chewy_path))
@@ -91,11 +87,6 @@ namespace :deploy do
     desc 'Runs smart Chewy indexes rebuilding (only for changed files)'
     task :rebuilding do
       on roles fetch(:chewy_role) do
-        if fetch(:chewy_skip)
-          info 'Skipping task according to the deploy settings'
-          exit 0
-        end
-
         chewy_path = fetch(:chewy_path)
         info "Checking changes in #{chewy_path}"
 
@@ -107,25 +98,41 @@ namespace :deploy do
         # -Z, --ignore-trailing-space     ignore white space at line end
         # -B, --ignore-blank-lines        ignore changes where lines are all blank
         #
-        indexes_diff = capture(:diff, "-qZEB #{chewy_release_path} #{chewy_current_path}", raise_on_non_zero_exit: false)
+        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 indexes_diff.nil? || indexes_diff.strip.empty?
+        if changes.empty?
           info 'Skipping `deploy:chewy:rebuilding` (nothing changed in the Chewy path)'
+          exit 0
         else
-          within release_path do
-            with rails_env: fetch(:chewy_env) do
-              changes = ::CapistranoChewy::DiffParser.parse(indexes_diff, chewy_current_path, chewy_release_path)
+          indexes_to_reset = changes.changed.concat(changes.added)
+          indexes_to_delete = changes.removed
 
-              # Reset indexes that were changed or added
-              indexes_to_reset = changes.changed.concat(changes.added)
+          # 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(',')
 
-              if indexes_to_reset.any?
-                indexes = indexes_to_reset.map { |file| File.basename(file).gsub('_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
+
+          # 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)"
 
-              # TODO: destroy removed indexes?
+            # 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
         end

data/spec/diff_parser_spec.rb

@@ -4,6 +4,7 @@ describe CapistranoChewy::DiffParser do
   let(:current_path) { '/project/1/app/chewy' }
   let(:release_path) { '/project/2/app/chewy' }
 
+  # TODO: make a real diff
   let(:full_diff) do
     "Files #{current_path}/accounts_index.rb and #{release_path}/accounts_index.rb differ\n" \
     "Files #{current_path}/posts_index.rb and #{release_path}/posts_index.rb differ\n" \
@@ -20,6 +21,8 @@ describe CapistranoChewy::DiffParser do
         expect(result.changed).to eq(["#{release_path}/accounts_index.rb", "#{release_path}/posts_index.rb", "#{release_path}/comments_index.rb"])
         expect(result.added).to eq(["#{release_path}/applications_index.rb"])
         expect(result.removed).to eq(["#{current_path}/users_index.rb"])
+
+        expect(result.empty?).to be_falsey
       end
     end
 
@@ -30,12 +33,20 @@ describe CapistranoChewy::DiffParser do
         expect(result.changed).to be_empty
         expect(result.added).to be_empty
         expect(result.removed).to be_empty
+
+        expect(result.empty?).to be_truthy
       end
     end
 
     context 'with the same directories' do
-      it 'raises an error' do
-        expect { described_class.parse('', current_path, current_path) }.to raise_error(ArgumentError)
+      it 'returns blank result' do
+        result = described_class.parse('', current_path, current_path)
+
+        expect(result.changed).to be_empty
+        expect(result.added).to be_empty
+        expect(result.removed).to be_empty
+
+        expect(result.empty?).to be_truthy
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-chewy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nikita Bulai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -55,7 +55,7 @@ dependencies:
 description: Manage and continuously rebuild your ElasticSearch indexes with Chewy
   and Capistrano v3.
 email:
-- bulainikita@gmail.com
+- bulajnikita@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -68,7 +68,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- capistrano3-postgres.gemspec
+- capistrano-chewy.gemspec
 - lib/capistrano-chewy.rb
 - lib/capistrano-chewy/diff_parser.rb
 - lib/capistrano-chewy/version.rb