capistrano-chewy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36801dffebe67a59da0de98084f1c2775d47371f
+  data.tar.gz: 50afbaef407413dd996110e7dc946690b8f63af9
+SHA512:
+  metadata.gz: ee2759d696d557a1e858347dbc4c854b4d705de2447d31145c205e1ba7486cd2ff945839e461a1825254a88d6667850f46b1481d1e9bd5f85f02b15856574987
+  data.tar.gz: edf506dd5325071b2b06c28a3f9cac42d16bfea928029472117319da29551e8dda7b8c417ea5dc6ba41c16bf0450f0e866c6a88c8891d651cb1e73aa0a878971

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+.idea
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+Gemfile.lock
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.rubocop.yml

@@ -0,0 +1,12 @@
+LineLength:
+  Max: 120
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+  DisplayCopNames: true
+Rails:
+  Enabled: true
+Documentation:
+  Enabled: false
+Style/EndOfLine:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+before_install: gem install bundler
+bundler_args: --without yard guard benchmarks
+script: "rake spec"
+rvm:
+  - 2.2.4
+  - 2.3.1
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Nikita Bulai
+
+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,81 @@
+# Capistrano::Chewy
+[![Gem Version](https://badge.fury.io/rb/capistrano-chewy.svg)](http://badge.fury.io/rb/capistrano-chewy)
+[![Build Status](https://travis-ci.org/nbulaj/capistrano-chewy.svg?branch=master)](https://travis-ci.org/nbulaj/capistrano-chewy)
+
+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.
+Moreover, it adds the possibility of manual index management with the base Chewy tasks on the remote server.
+
+## Requirements
+
+* Capistrano >= 3.0
+* Chewy >= 0.4
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-chewy', require: false
+```
+
+or:
+
+```ruby
+gem 'capistrano-chewy', require: false, group: :development
+```
+
+And then run bundler:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install capistrano-chewy
+```
+
+## Usage
+
+Require it in your `Capfile`:
+
+```ruby
+# Capfile
+
+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
+```
+
+## Configuration
+
+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_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
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/nbulaj/capistrano-chewy/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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/capistrano3-postgres.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano-chewy/version'
+
+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.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'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  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', '~> 3.0'
+  spec.add_dependency 'chewy', '~> 0.4'
+
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/capistrano-chewy.rb

@@ -0,0 +1,5 @@
+require 'capistrano-chewy/version'
+require 'capistrano-chewy/diff_parser'
+
+module CapistranoChewy
+end

data/lib/capistrano-chewy/diff_parser.rb

@@ -0,0 +1,40 @@
+module CapistranoChewy
+  class DiffParser
+    class Result
+      attr_reader :removed, :changed, :added
+
+      def initialize
+        @removed = []
+        @changed = []
+        @added = []
+      end
+    end
+
+    CHANGED_FILE_PATTERN = /Files\s+.+\s+and\s+(.+)\s+differ/i
+    NEW_OR_REMOVED_FILE_PATTERN = /Only in (.+):\s+(.+)/i
+
+    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
+
+        diff.split("\n").each_with_object(Result.new) do |line, result|
+          # File was changed
+          CHANGED_FILE_PATTERN.match(line) do |match|
+            result.changed << match[1]
+            next
+          end
+
+          # File was removed or added
+          NEW_OR_REMOVED_FILE_PATTERN.match(line) do |match|
+            # if file placed in current path, then it was removed from the release path
+            if match[1] == current_path.chomp(File::SEPARATOR)
+              result.removed << File.join(match[1], match[2])
+            else
+              result.added << File.join(match[1], match[2])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capistrano-chewy/version.rb

@@ -0,0 +1,13 @@
+module CapistranoChewy
+  def self.gem_version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    TINY = 0
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
+end

data/lib/capistrano/chewy.rb

@@ -0,0 +1,5 @@
+# Ensure deploy tasks are loaded before we run
+require 'capistrano/deploy'
+require 'capistrano-chewy'
+
+load File.expand_path('../tasks/chewy.rake', __FILE__)

data/lib/capistrano/tasks/chewy.rake

@@ -0,0 +1,135 @@
+namespace :load do
+  task :defaults do
+    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 }
+  end
+end
+
+namespace :deploy do
+  before :starting, :check_chewy_hooks do
+    invoke :'deploy:chewy:add_default_hooks' if fetch(:chewy_default_hooks)
+  end
+
+  namespace :chewy do
+    # Adds default Capistrano::Chewy hooks to the deploy flow
+    task :add_default_hooks do
+      after 'deploy:updated', 'deploy: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
+          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
+          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
+        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))
+        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
+        else
+          info 'Running chewy:reset:all'
+          invoke :'deploy: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
+        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}"
+
+        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
+        #
+        indexes_diff = capture(:diff, "-qZEB #{chewy_release_path} #{chewy_current_path}", raise_on_non_zero_exit: false)
+
+        # If diff is empty then indices have not changed
+        if indexes_diff.nil? || indexes_diff.strip.empty?
+          info 'Skipping `deploy:chewy:rebuilding` (nothing changed in the Chewy path)'
+        else
+          within release_path do
+            with rails_env: fetch(:chewy_env) do
+              changes = ::CapistranoChewy::DiffParser.parse(indexes_diff, chewy_current_path, chewy_release_path)
+
+              # Reset indexes that were changed or added
+              indexes_to_reset = changes.changed.concat(changes.added)
+
+              if indexes_to_reset.any?
+                indexes = indexes_to_reset.map { |file| File.basename(file).gsub('_index.rb', '') }.join(',')
+                execute :rake, "chewy:reset[#{indexes}]"
+              end
+
+              # TODO: destroy removed indexes?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/diff_parser_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe CapistranoChewy::DiffParser do
+  let(:current_path) { '/project/1/app/chewy' }
+  let(:release_path) { '/project/2/app/chewy' }
+
+  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" \
+    "Only in #{release_path}: applications_index.rb\n" \
+    "Files #{current_path}/comments_index.rb and #{release_path}/comments_index.rb differ\n" \
+    "Only in #{current_path}: users_index.rb\n"
+  end
+
+  describe '#parse' do
+    context 'with difference between directories' do
+      it 'returns result object with removed, added and changed files' do
+        result = described_class.parse(full_diff, current_path, release_path)
+
+        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"])
+      end
+    end
+
+    context 'without differences' do
+      it 'returns result object with removed, added and changed files' do
+        result = described_class.parse('', current_path, release_path)
+
+        expect(result.changed).to be_empty
+        expect(result.added).to be_empty
+        expect(result.removed).to be_empty
+      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)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'capistrano-chewy'
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-chewy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikita Bulai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: chewy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Manage and continuously rebuild your ElasticSearch indexes with Chewy
+  and Capistrano v3.
+email:
+- bulainikita@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- capistrano3-postgres.gemspec
+- lib/capistrano-chewy.rb
+- lib/capistrano-chewy/diff_parser.rb
+- lib/capistrano-chewy/version.rb
+- lib/capistrano/chewy.rb
+- lib/capistrano/tasks/chewy.rake
+- spec/diff_parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nbulaj/capistrano-chewy
+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.6.3
+signing_key: 
+specification_version: 4
+summary: Manage and continuously rebuild your ElasticSearch indexes with Chewy and
+  Capistrano
+test_files:
+- spec/diff_parser_spec.rb
+- spec/spec_helper.rb
+has_rdoc: