dekiru 0.1.10 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6561c9b0821c11571527dc126a5014304352c8b58a5915e03dcaffdcfe9987b
-  data.tar.gz: d599fef1eb98d58389da140f638ef317c2866583c77d29c403e2d72ad4a1517b
+  metadata.gz: '0293842d02fc6417c18e53f353a842aec6bb0b41425a00afecae9fb6a11c7848'
+  data.tar.gz: 28f30a08869901b5f0621fba78a8d259bafe8e0c4630925baa5606b604a9840c
 SHA512:
-  metadata.gz: 8bcbe875ecbbab54ca72d7dbed1d63988d7a5dfa403c5aeb75d657a606d64e1669e3470daaacbf459a6b72a321b32bea70efed6a0b058b4a88938708d03a0b5a
-  data.tar.gz: b53319d34f655be66216a88c71c31d4119289a1beea0929bcf20bee6eed6edd4f8350c540ca5d53cfd785ff0ac2422ab0c03154ebf4bb3774f61146cba88e412
+  metadata.gz: fdb142b9f203cb3e47a4b2305a2b67f1b0c649f36710bef29c9cbdf34be4d55cf2c8475f59bc370281e8d7e90a1603d2b2a47bb8ea3adb80c190328f115945ed
+  data.tar.gz: f92cf2b65aacb0da17014580b537cbf9eac9fa190b3f3c5032590cccfc46b01f8bdea6fac453f3015a4899beef9c4bd25a27c72a907006c297bf258353435fcb

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

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/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/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/data_migration_operator.rb

@@ -12,6 +12,7 @@ module Dekiru
       @title = title
       @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
@@ -20,13 +21,14 @@ module Dekiru
     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
-        if @options[:warning_side_effects]
-          warning_side_effects(&block)
-        else
-          instance_eval(&block)
+      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
-        confirm?("\nAre you sure to commit?")
       end
       log "Finished successfully: #{title}" if @result == true
     rescue => e
@@ -46,10 +48,11 @@ module Dekiru
     end
 
     def find_each_with_progress(target_scope, options = {})
+      total = options.delete(:total)
       opt = {
         format: '%a |%b>>%i| %p%% %t',
       }.merge(options).merge(
-        total: target_scope.count,
+        total: total || target_scope.count,
         output: stream
       )
       pb = ::ProgressBar.create(opt)
@@ -117,5 +120,13 @@ module Dekiru
         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/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.10'
+  VERSION = '0.2.2'
 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
@@ -109,5 +127,36 @@ describe Dekiru::DataMigrationOperator do
       expect(operator.stream.out).to include('Finished successfully:')
       expect(operator.stream.out).to include('Total time:')
     end
+
+    it 'total をオプションで渡すことができる' do
+      class Dekiru::DummyRecord
+        def self.count
+          raise "won't call"
+        end
+
+        def self.find_each
+          yield 99
+        end
+      end
+
+      allow(STDIN).to receive(:gets) do
+        "yes\n"
+      end
+
+      sum = 0
+      operator.execute do
+        find_each_with_progress(Dekiru::DummyRecord, title: 'pass total as option', total: 1) do |num|
+          sum += num
+        end
+      end
+
+      expect(sum).to eq(99)
+      expect(operator.result).to eq(true)
+      expect(operator.error).to eq(nil)
+      expect(operator.stream.out).to include('Are you sure to commit?')
+      expect(operator.stream.out).to include('pass total as option:')
+      expect(operator.stream.out).to include('Finished successfully:')
+      expect(operator.stream.out).to include('Total time:')
+    end
   end
 end

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.10
+  version: 0.2.2
 platform: ruby
 authors:
 - Akihiro Matsumura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2022-01-17 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
@@ -126,6 +140,8 @@ files:
 - lib/dekiru.rb
 - lib/dekiru/camelize_hash.rb
 - lib/dekiru/capybara/helpers.rb
+- lib/dekiru/capybara/helpers/wait_for_position_stable.rb
+- lib/dekiru/capybara/legacy_helpers.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