dekiru 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ae4d2f88bf4f0db1e61e84464ea24df21523043c039f5b06fabf1a81d6a5f7d
-  data.tar.gz: a329f3991c66e86f0f76d859770291ce9d0a4b32391e7554a48183fde335445c
+  metadata.gz: 1d8df1d364e772bfe0abc6b281c3ff4678f367d0257d798e952955f531dcbee5
+  data.tar.gz: 617e9cf3e96ad6ef9d0407862aa2b1808475a61887d5360463fb66295c69ac5d
 SHA512:
-  metadata.gz: a5c8ff8add10ef86b6d165bb8ac9805cfd83bff5e3feca41b1d0237fcfefdcd81b9922b893d5f9f86f1408edb45c14903efafd3178b2fa8b66057d3bc8f2c057
-  data.tar.gz: 1f3724e621a879d91f43787c8b0a08cfd33a3b97b00069574753074337aab4abc1e18fd72a687017c54f3659fe5e88461335e381230342177c66a373de9907b9
+  metadata.gz: 47a8042edabdd3a3c5135af8fdf4eca91a7f265c1fbe6a4659490fb2600409a046c156aa533f8988baedc5012ebb796939e93e9880459eec050a1dbd95f59490
+  data.tar.gz: 89bbb4ec613d4ee1412a55c6bfa7d3f60b30ffb6d6fa2f40b3752c1f4b907f39613031a27945cf7547a00a8561d7d605577687389eaaa12296f0f5154ed20971

data/.github/workflows/rspec.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_JOBS: 4
+      BUNDLE_RETRY: 3
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.6", "2.7", "3.0"]
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Run rspec
+        run: bundle exec rspec

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+.byebug_history
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -36,16 +36,20 @@ end
 ### examples
 
 ```ruby
-# Ajax処理の終了待ち
-click_link 'Ajax link!'
-wait_for_ajax
-expect(page).to have_content 'created element!'
-
-# Bootstrap3 のモーダルの出現終了待ち(待たないとモーダル内のノードのクリックに失敗することがある)
-wait_for_event('shown.bs.modal') do
-  click_link 'Open bootstrap3 modal'
-end
-click_on 'Button in modal'
+# アニメーション終了待ちヘルパー(アニメーション中のクリックは失敗することがある)
+
+# CSSセレクタで指定した要素の位置が動かなくなるまで待つ
+wait_for_position_stable(:css, '[data-test-id="confirmation-modal"]')
+click_button 'OK'
+
+# チェックボックスの位置が0.5秒間停止し続けるまで待つ
+# タイムアウトは5秒
+wait_for_position_stable(:checkbox, 'Red', wait: 5, stable_wait: 0.5)
+check 'Red'
+
+# findした要素を指定してアニメーション終了待ち
+element = find('[data-test-id="confirmation-modal"]')
+wait_for_element_position_stable(element)
 ```
 
 ## Capybara Matchers
@@ -154,6 +158,34 @@ Finished successfully: Demo migration
 Total time: 6.35 sec
 ```
 
+また`warning_side_effects: true`オプションを付けて実行することで、データ移行作業で発生した副作用が表示されるようになります。
+
+```ruby
+Dekiru::DataMigrationOperator.execute('Demo migration', warning_side_effects: true) do
+  # ...
+end
+```
+
+```
+$ bin/rails r scripts/demo.rb
+Start: Demo migration at 2019-05-24 18:29:57 +0900
+
+all targets count: 30
+Time: 00:00:00 |=================>>| 100% Progress
+updated user count: 30
+
+Write Queries!!
+30 call: Update "users" SET ...
+
+Enqueued Jobs!!
+10 call: NotifyJob
+
+Deliverd Mailers!!
+10 call: UserMailer
+
+Are you sure to commit? (yes/no) > yes
+```
+
 ## Refinements
 
 ### Dekiru::CamelizeHash

data/dekiru.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rubocop'
   gem.add_development_dependency 'webmock', ['>= 1.19.0']
+  gem.add_development_dependency 'byebug'
 end

data/lib/dekiru/capybara/Legacy_helpers.rb

@@ -0,0 +1,40 @@
+module Dekiru
+  module Capybara
+    module LegacyHelpers
+      class Error < StandardError; end
+
+      def wait_for_event(event)
+        page.execute_script(<<~"EOS")
+          (function(){
+            var eventName = '#{event}';
+            window._dekiruCapybaraWaitEvents = window._dekiruCapybaraWaitEvents || {};
+            window._dekiruCapybaraWaitEvents[eventName] = 1;
+            jQuery(document).one(eventName, function(){window._dekiruCapybaraWaitEvents[eventName] = 0;});
+          })();
+        EOS
+        yield
+
+        script = <<~"EOS"
+          (function(){
+            var eventName = '#{event}';
+            return window._dekiruCapybaraWaitEvents && window._dekiruCapybaraWaitEvents[eventName];
+          })();
+        EOS
+        wait_until do
+          result = page.evaluate_script(script)
+          raise Error, 'wait_for_event: Missing context. probably moved to another page.' if result.nil?
+          result == 0
+        end
+      end
+
+      # https://robots.thoughtbot.com/automatically-wait-for-ajax-with-capybara
+      def wait_for_ajax
+        wait_until { finished_all_ajax_requests? }
+      end
+
+      def finished_all_ajax_requests?
+        page.evaluate_script('jQuery.active').zero?
+      end
+    end
+  end
+end

data/lib/dekiru/capybara/helpers/wait_for_position_stable.rb

@@ -0,0 +1,53 @@
+module Dekiru
+  module Capybara
+    module Helpers
+      module WaitForPositionStable
+        class StableTimer
+          def initialize(wait)
+            @wait = wait
+            @stable = false
+            @start_time = nil
+            @prev_obj = nil
+          end
+
+          def stable?(obj)
+            if @prev_obj && @prev_obj == obj
+              if @start_time.nil?
+                @start_time = current
+              elsif current - @start_time > @wait
+                return true
+              end
+            else
+              @start_time = nil
+            end
+            @prev_obj = obj
+            false
+          end
+
+          private
+
+          def current
+            ::Capybara::Helpers.monotonic_time
+          end
+        end
+
+        def wait_for_element_position_stable(element, wait: ::Capybara.default_max_wait_time, stable_wait: 0.5)
+          stable_timer = StableTimer.new(stable_wait)
+          timer = ::Capybara::Helpers.timer(expire_in: wait)
+          loop do
+            rect = element.rect
+            break if stable_timer.stable?(rect)
+            raise 'Timeout to wait animation finished' if timer.expired?
+
+            sleep 0.1
+          end
+        end
+
+        def wait_for_position_stable(selector, locator, **options)
+          element = find(selector, locator, **options.except(:stable_wait))
+          wait_for_element_position_stable(element, **options.slice(:wait, :stable_wait))
+        end
+      end
+    end
+  end
+end

data/lib/dekiru/capybara/helpers.rb

@@ -1,40 +1,9 @@
+require 'dekiru/capybara/helpers/wait_for_position_stable'
+
 module Dekiru
   module Capybara
     module Helpers
-      class Error < StandardError; end
-
-      def wait_for_event(event)
-        page.execute_script(<<~"EOS")
-          (function(){
-            var eventName = '#{event}';
-            window._dekiruCapybaraWaitEvents = window._dekiruCapybaraWaitEvents || {};
-            window._dekiruCapybaraWaitEvents[eventName] = 1;
-            jQuery(document).one(eventName, function(){window._dekiruCapybaraWaitEvents[eventName] = 0;});
-          })();
-        EOS
-        yield
-
-        script = <<~"EOS"
-          (function(){
-            var eventName = '#{event}';
-            return window._dekiruCapybaraWaitEvents && window._dekiruCapybaraWaitEvents[eventName];
-          })();
-        EOS
-        wait_until do
-          result = page.evaluate_script(script)
-          raise Error, 'wait_for_event: Missing context. probably moved to another page.' if result.nil?
-          result == 0
-        end
-      end
-
-      # https://robots.thoughtbot.com/automatically-wait-for-ajax-with-capybara
-      def wait_for_ajax
-        wait_until { finished_all_ajax_requests? }
-      end
-
-      def finished_all_ajax_requests?
-        page.evaluate_script('jQuery.active').zero?
-      end
+      include WaitForPositionStable
 
       def wait_until(timeout: ::Capybara.default_max_wait_time, interval: 0.2, **opts, &block)
         if defined?(Selenium::WebDriver::Wait)

data/lib/dekiru/data_migration_operator.rb

@@ -10,19 +10,25 @@ module Dekiru
 
     def initialize(title, options = {})
       @title = title
-      @stream = options[:output] || $stdout
-    end
-
-    def log(message)
-      stream.puts(message)
+      @options = options
+      @stream = @options[:output] || $stdout
+      @without_transaction = @options[:without_transaction] || false
+      @side_effects = Hash.new do |hash, key|
+        hash[key] = Hash.new(0)
+      end
     end
 
     def execute(&block)
       @started_at = Time.current
       log "Start: #{title} at #{started_at}\n\n"
-      @result = ActiveRecord::Base.transaction(requires_new: true, joinable: false) do
-        instance_eval(&block)
-        confirm?("\nAre you sure to commit?")
+      if @without_transaction
+        run(&block)
+        @result = true
+      else
+        @result = ActiveRecord::Base.transaction(requires_new: true, joinable: false) do
+          run(&block)
+          confirm?("\nAre you sure to commit?")
+        end
       end
       log "Finished successfully: #{title}" if @result == true
     rescue => e
@@ -56,6 +62,12 @@ module Dekiru
       pb.finish
     end
 
+    private
+
+    def log(message)
+      stream.puts(message)
+    end
+
     def confirm?(message = 'Are you sure?')
       loop do
         stream.print "#{message} (yes/no) > "
@@ -78,5 +90,42 @@ module Dekiru
       log "Canceled: #{title}"
       raise ActiveRecord::Rollback
     end
+
+    def handle_notification(*args)
+      event = ActiveSupport::Notifications::Event.new(*args)
+
+      increment_side_effects(:enqueued_jobs, event.payload[:job].class.name)  if event.payload[:job]
+      increment_side_effects(:deliverd_mailers, event.payload[:mailer]) if event.payload[:mailer]
+
+      if event.payload[:sql] && /\A\s*(insert|update|delete)/i.match?(event.payload[:sql])
+        increment_side_effects(:write_queries, event.payload[:sql])
+      end
+    end
+
+    def increment_side_effects(type, value)
+      @side_effects[type][value] += 1
+    end
+
+    def warning_side_effects(&block)
+      ActiveSupport::Notifications.subscribed(method(:handle_notification), /^(sql|enqueue|deliver)/) do
+        instance_eval(&block)
+      end
+
+      @side_effects.each do |name, items|
+        newline
+        log "#{name.to_s.titlecase}!!"
+        items.sort_by { |v, c| c }.reverse.slice(0, 20).each do |value, count|
+          log "#{count} call: #{value}"
+        end
+      end
+    end
+
+    def run(&block)
+      if @options[:warning_side_effects]
+        warning_side_effects(&block)
+      else
+        instance_eval(&block)
+      end
+    end
   end
 end

data/lib/dekiru/task_with_logger.rb

@@ -4,16 +4,17 @@ module TaskWithLogger
 
       def task(*args, &block)
         new_block = proc do |_task, _args|
-          __echo__ "[START] #{_task.name} #{_args.to_h} (#{Time.current})"
+          TaskWithLogger.echo("[START] #{_task.name} #{_args.to_h} (#{Time.current})")
           yield(_task, _args)
-          __echo__ "[END] #{_task.name} #{_args.to_h} (#{Time.current})"
+          TaskWithLogger.echo("[END] #{_task.name} #{_args.to_h} (#{Time.current})")
         end
         super(*args, &new_block)
       end
+  end
 
-      def __echo__(str)
-        Rails.logger.info(str)
-        puts(str)
-      end
+  def echo(str)
+    Rails.logger.info(str)
+    puts(str)
   end
+  module_function :echo
 end

data/lib/dekiru/validators/existence.rb

@@ -9,7 +9,7 @@ module ActiveModel
     class ExistenceValidator < EachValidator
       def validate_each(record, attribute, value)
         unless exists?(record, value)
-          record.errors.add(attribute, :existence, options.except(:in).merge!(value: value))
+          record.errors.add(attribute, :existence, **options.except(:in).merge!(value: value))
         end
       end
 

data/lib/dekiru/version.rb

@@ -1,3 +1,3 @@
 module Dekiru
-  VERSION = '0.1.8'
+  VERSION = '0.2.0'
 end

data/lib/generators/maintenance_script/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Create database maintenance script using Dekiru::DataMigrationOperator
+
+Example:
+    rails generate maintenance_script UpdateUserName
+
+    This will create:
+        scripts/XXX_update_user_name.rb

data/lib/generators/maintenance_script/maintenance_script_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+class MaintenanceScriptGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  def copy_maintenance_script_file
+    template 'maintenance_script.rb.erb', "scripts/#{filename_date}_#{file_name}.rb"
+  end
+
+  private
+
+  def filename_date
+    Time.current.strftime('%Y%m%d')
+  end
+end

data/lib/generators/maintenance_script/templates/maintenance_script.rb.erb

@@ -0,0 +1,3 @@
+Dekiru::DataMigrationOperator.execute('<%= @name %>') do
+  # write here
+end

data/spec/dekiru/data_migration_operator_spec.rb

@@ -26,7 +26,8 @@ describe Dekiru::DataMigrationOperator do
     end
     Dekiru::DummyStream.new
   end
-  let(:operator) { Dekiru::DataMigrationOperator.new('dummy', output: dummy_stream) }
+  let(:without_transaction) { false }
+  let(:operator) { Dekiru::DataMigrationOperator.new('dummy', output: dummy_stream, without_transaction: without_transaction) }
 
   describe '#execute' do
     it 'confirm で yes' do
@@ -74,6 +75,23 @@ describe Dekiru::DataMigrationOperator do
       expect(operator.stream.out).not_to include('Canceled:')
       expect(operator.stream.out).to include('Total time:')
     end
+
+    context 'without_transaction: true のとき' do
+      let(:without_transaction) { true }
+
+      it 'トランザクションがかからないこと' do
+        expect do
+          operator.execute { log 'processing'; sleep 1.0 }
+        end.not_to raise_error
+
+        expect(operator.result).to eq(true)
+        expect(operator.duration).to be_within(0.1).of(1.0)
+        expect(operator.error).to eq(nil)
+        expect(operator.stream.out).not_to include('Are you sure to commit?')
+        expect(operator.stream.out).to include('Finished successfully:')
+        expect(operator.stream.out).to include('Total time:')
+      end
+    end
   end
 
   describe '#find_each_with_progress' do

data/spec/spec_helper.rb

@@ -9,6 +9,7 @@ require "active_record"
 require "action_view"
 require "action_view/helpers"
 require 'action_mailer'
+require 'byebug'
 
 PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dekiru
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Akihiro Matsumura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_accept_language
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.19.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Usefull helper methods for Ruby on Rails
 email:
 - matsumura.aki@gmail.com
@@ -115,9 +129,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -125,7 +139,9 @@ files:
 - dekiru.gemspec
 - lib/dekiru.rb
 - lib/dekiru/camelize_hash.rb
+- lib/dekiru/capybara/Legacy_helpers.rb
 - lib/dekiru/capybara/helpers.rb
+- lib/dekiru/capybara/helpers/wait_for_position_stable.rb
 - lib/dekiru/capybara/matchers.rb
 - lib/dekiru/controller_additions.rb
 - lib/dekiru/data_migration_operator.rb
@@ -138,6 +154,9 @@ files:
 - lib/dekiru/tasks/smtp_check.rake
 - lib/dekiru/validators/existence.rb
 - lib/dekiru/version.rb
+- lib/generators/maintenance_script/USAGE
+- lib/generators/maintenance_script/maintenance_script_generator.rb
+- lib/generators/maintenance_script/templates/maintenance_script.rb.erb
 - spec/dekiru/camelize_hash_spec.rb
 - spec/dekiru/data_migration_operator_spec.rb
 - spec/dekiru/helper_spec.rb

data/.travis.yml

@@ -1,12 +0,0 @@
-rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
-  - 2.7.1
-
-# NOTE: https://github.com/travis-ci/travis-ci/issues/8978
-before_install:
-  - gem update --system --no-document
-
-sudo: false
-cache: bundler