dekiru 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f6da61a0077b7b3bfc1d8d7218534e338decd1d8dfa148f88a3ea5ffd7d1bc1
-  data.tar.gz: 204207fef71355046599563e241eef01c613fde164ec4ebd44c0ab4c4e05eb94
+  metadata.gz: 52638cf1b48eda2cccf9bc53435a8c361e17a43a3145457eba5fbfdd68b5f9ac
+  data.tar.gz: 5ced1fe987c0999fdff91eeef663cd664c3bdafd58a466dd40dd21c6e8b64bda
 SHA512:
-  metadata.gz: 69d2b73da661888ee0a4da75d6c4e7dd97fcc9f9fba64ce7f5104ac79caa9191cdc0c9d714ae3ef8d07ce74f52638c273445f04cc7d6fa4972188ea8e9f816f2
-  data.tar.gz: 96ee35a0094409e45a883227a8249ab8b5bea7fd614831c84ca6bac0bcbaca21c1006f7087bb7e083e97c2ac251325d3f56c5ebc840f667d29df12af4e2e5833
+  metadata.gz: 2dc00bbe336a2381355d72b5da39a398a36640af30a425696c9f145773b1c7c0fe3844d985d533af8f2336dc2e0591cc1cb2f6980fddbacfa587e1b50c759d94
+  data.tar.gz: 0f81e7e83a43ac4a335b89e42a5c08cf5f3573792a4afd958aa5744fe3ef3b59546ba82195c36e60f2ec420f52b5bc7dd484c41747e908dc81ff7274f7402027

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+2.7.1

data/.travis.yml

@@ -1,7 +1,8 @@
 rvm:
-  - 2.3.3
-  - 2.4.4
-  - 2.5.1
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+  - 2.7.1
 
 # NOTE: https://github.com/travis-ci/travis-ci/issues/8978
 before_install:

data/README.md

@@ -48,6 +48,30 @@ end
 click_on 'Button in modal'
 ```
 
+## Capybara Matchers
+
+以下の設定をすると Capybara 用のマッチャーが使えるようになる。
+
+```ruby
+require 'dekiru/capybara/matchers'
+RSpec.configure do |config|
+  config.include Dekiru::Capybara::Matchers, type: :feature
+end
+```
+
+### examples
+
+```ruby
+# javascriptエラーがあったらテスト失敗するように
+RSpec.configure do |config|
+  config.after(:each, type: :feature) do |example|
+    if example.metadata[:js] == true
+      expect(page).to have_no_js_errors
+    end
+  end
+end
+```
+
 ## Rake Task
 
 以下の設定をすると Rake タスクの実行前後にログ出力されるようになる。(Ruby2.4 以降が必要)
@@ -85,10 +109,69 @@ Rails.application.load_tasks
 Rake::Task['db:migrate'].enhance(['db:migrate:check_conflict']) if Rails.env.development?
 ```
 
+## Mail Security Hook
+
+以下の設定をすると、宛先を指定しないメールを配信しようとした時に`Dekiru::MailSecurityInterceptor::NoToAdreessError`例外を発生させる。
+
+※ to に空文字や空配列を指定してメールを配信しようとすると、bcc 内のアドレスが to に転記されるといった問題がある。これを未然に防ぐことができる。
+
+```ruby
+# config/initializer/dekiru.rb
+Dekiru.configure do |config|
+  config.mail_security_hook = true # default: false
+end
+```
+
+## Data Migration Operator
+
+実行しながら進捗を表示したり、処理の最後に実行の確認をしたりといった、データ移行作業をするときに必要な処理を以下のような script を作成することで、実現できるようになります。
+
+```ruby
+# scripts/demo.rb
+Dekiru::DataMigrationOperator.execute('Demo migration') do
+  targets = User.where("email LIKE '%sonicgarden%'")
+
+  log "all targets count: #{targets.count}"
+  find_each_with_progress(targets) do |user|
+    user.update(admin: true)
+  end
+
+  log "updated user count: #{User.where("email LIKE '%sonicgarden%'").where(admin: true).count}"
+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
+
+Are you sure to commit? (yes/no) > yes
+
+Finished successfully: Demo migration
+Total time: 6.35 sec
+```
+
+## Refinements
+
+### Dekiru::CamelizeHash
+
+```ruby
+using Dekiru::CamelizeHash
+
+{ dekiru_rails: true }.camelize_keys(:lower)
+# => { dekiruRails: true }
+
+{ dekiru_rails: { dekiru_rails: true } }.deep_camelize_keys(:lower)
+# => { dekiruRails: { dekiruRails: true } }
+```
+
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1.  Fork it
+2.  Create your feature branch (`git checkout -b my-new-feature`)
+3.  Commit your changes (`git commit -am 'Added some feature'`)
+4.  Push to the branch (`git push origin my-new-feature`)
+5.  Create new Pull Request

data/dekiru.gemspec

@@ -15,8 +15,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Dekiru::VERSION
 
+  gem.required_ruby_version = '>= 2.4.0'
+
   gem.add_dependency 'http_accept_language', [">= 2.0.0"]
   gem.add_dependency 'rails'
+  gem.add_dependency 'ruby-progressbar'
   gem.add_development_dependency 'rake', [">= 0"]
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'rubocop'

data/lib/dekiru.rb

@@ -3,9 +3,29 @@ require 'dekiru/railtie' if defined?(::Rails)
 require 'dekiru/helper'
 require 'dekiru/controller_additions'
 require 'dekiru/validators/existence'
+require 'dekiru/data_migration_operator'
+require 'dekiru/mail_security_interceptor'
+require 'dekiru/camelize_hash'
 
 require 'active_support'
 require 'active_support/all'
 
 module Dekiru
+  class << self
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
+
+  class Configuration
+    attr_accessor :mail_security_hook
+
+    def initialize
+      @mail_security_hook = false # default
+    end
+  end
 end

data/lib/dekiru/camelize_hash.rb

@@ -0,0 +1,25 @@
+module Dekiru
+  module CamelizeHash
+    refine ::Hash do
+      def camelize_keys(first_letter = :upper)
+        transform_keys do |k|
+          if k.is_a?(Symbol)
+            k.to_s.camelize(first_letter).to_sym
+          else
+            k.camelize(first_letter)
+          end
+        end
+      end
+
+      def deep_camelize_keys(first_letter = :upper)
+        deep_transform_keys do |k|
+          if k.is_a?(Symbol)
+            k.to_s.camelize(first_letter).to_sym
+          else
+            k.camelize(first_letter)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dekiru/capybara/matchers.rb

@@ -0,0 +1,30 @@
+module Dekiru
+  module Capybara
+    module Matchers
+      class JsNoErrorMatcher
+        def matches?(page_or_logs)
+          logs = page_or_logs.respond_to?(:driver) ? page.driver.browser.manage.logs.get(:browser) : page_or_logs
+          logs.find_all { |log| log.level == 'WARNING' }.each do |log|
+            STDERR.puts 'WARN: javascript warning'
+            STDERR.puts log.message
+          end
+
+          @severe_errors = logs.find_all { |log| log.level == 'SEVERE' }
+          @severe_errors.empty?
+        end
+
+        def description
+          'have no js errors'
+        end
+
+        def failure_message
+          @severe_errors.map(&:message).join("\n")
+        end
+      end
+
+      def have_no_js_errors
+        JsNoErrorMatcher.new
+      end
+    end
+  end
+end

data/lib/dekiru/data_migration_operator.rb

@@ -0,0 +1,82 @@
+require 'ruby-progressbar'
+
+module Dekiru
+  class DataMigrationOperator
+    attr_reader :title, :stream, :result, :canceled, :started_at, :ended_at, :error
+
+    def self.execute(title, options = {}, &block)
+      self.new(title, options).execute(&block)
+    end
+
+    def initialize(title, options = {})
+      @title = title
+      @stream = options[:output] || $stdout
+    end
+
+    def log(message)
+      stream.puts(message)
+    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?")
+      end
+      log "Finished successfully: #{title}" if @result == true
+    rescue => e
+      @error = e
+      @result = false
+    ensure
+      @ended_at = Time.current
+      log "Total time: #{self.duration.round(2)} sec"
+
+      raise error if error
+
+      return @result
+    end
+
+    def duration
+      ((self.ended_at || Time.current) - self.started_at)
+    end
+
+    def find_each_with_progress(target_scope, options = {})
+      opt = {
+        format: '%a |%b>>%i| %p%% %t',
+      }.merge(options).merge(
+        total: target_scope.count,
+        output: stream
+      )
+      pb = ::ProgressBar.create(opt)
+      target_scope.find_each do |target|
+        yield target
+        pb.increment
+      end
+      pb.finish
+    end
+
+    def confirm?(message = 'Are you sure?')
+      loop do
+        stream.print "#{message} (yes/no) > "
+        case STDIN.gets.strip
+        when 'yes'
+          newline
+          return true
+        when 'no'
+          newline
+          cancel!
+        end
+      end
+    end
+
+    def newline
+      log ''
+    end
+
+    def cancel!
+      log "Canceled: #{title}"
+      raise ActiveRecord::Rollback
+    end
+  end
+end

data/lib/dekiru/helper.rb

@@ -19,8 +19,8 @@ module Dekiru
       end
     end
 
-    def null_check_localization(*args)
-      localize(*args) if args.try(:first).present?
+    def null_check_localization(object, **options)
+      localize(object, **options) if object.present?
     end
     alias nl null_check_localization
 

data/lib/dekiru/mail_security_interceptor.rb

@@ -0,0 +1,11 @@
+module Dekiru
+  class MailSecurityInterceptor
+
+    class Dekiru::MailSecurityInterceptor::NoToAdreessError < StandardError ; end
+    def delivering_email(mail)
+      if mail.to.blank?
+        raise Dekiru::MailSecurityInterceptor::NoToAdreessError
+      end
+    end
+  end
+end

data/lib/dekiru/railtie.rb

@@ -10,6 +10,14 @@ module Dekiru
       end
     end
 
+    config.after_initialize do
+      if Dekiru.configuration.mail_security_hook
+        Rails.logger.info '[dekiru] mail_security_hook enabled'
+        interceptor = Dekiru::MailSecurityInterceptor.new
+        ActionMailer::Base.register_interceptor(interceptor)
+      end
+    end
+
     rake_tasks do
       load 'dekiru/tasks/smtp_check.rake'
       load 'dekiru/tasks/db.rake'

data/lib/dekiru/task_with_logger.rb

@@ -3,11 +3,10 @@ module TaskWithLogger
     private
 
       def task(*args, &block)
-        scope_path = Rake.application.current_scope.path
-        new_block = proc do
-          __echo__ "[START] #{scope_path}: #{args.inspect} (#{Time.current})"
-          yield
-          __echo__ "[END] #{scope_path}: #{args.inspect} (#{Time.current})"
+        new_block = proc do |_task, _args|
+          __echo__ "[START] #{_task.name} #{_args.to_h} (#{Time.current})"
+          yield(_task, _args)
+          __echo__ "[END] #{_task.name} #{_args.to_h} (#{Time.current})"
         end
         super(*args, &new_block)
       end

data/lib/dekiru/version.rb

@@ -1,3 +1,3 @@
 module Dekiru
-  VERSION = '0.1.2'
+  VERSION = '0.1.7'
 end

data/spec/dekiru/camelize_hash_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe Dekiru::CamelizeHash do
+  using Dekiru::CamelizeHash
+
+  let(:hash) do
+    hash = {
+      dekiru_rails: {
+         dekiru_rails: 'dekiru'
+      },
+      'dekiru_ruby' => {
+        'dekiru_ruby' => 'dekiru'
+      }
+    }
+  end
+
+  describe '#camelize_keys' do
+    it '一階層目のキーがキャメルケースに変換される' do
+      expect(hash.camelize_keys(:lower)).to match({
+        dekiruRails: {
+           dekiru_rails: 'dekiru'
+        },
+        'dekiruRuby' => {
+          'dekiru_ruby' => 'dekiru'
+        }
+      })
+    end
+
+    it '一階層目のキーがアッパーキャメルケースに変換される' do
+      expect(hash.camelize_keys).to match({
+        DekiruRails: {
+           dekiru_rails: 'dekiru'
+        },
+        'DekiruRuby' => {
+          'dekiru_ruby' => 'dekiru'
+        }
+      })
+    end
+  end
+
+  describe '#deep_camelize_keys' do
+    it '2階層目以降のキーもキャメルケースに変換される' do
+      expect(hash.deep_camelize_keys(:lower)).to match({
+        dekiruRails: {
+           dekiruRails: 'dekiru'
+        },
+        'dekiruRuby' => {
+          'dekiruRuby' => 'dekiru'
+        }
+      })
+    end
+
+    it '2階層目以降のキーもアッパーキャメルケースに変換される' do
+      expect(hash.deep_camelize_keys).to match({
+        DekiruRails: {
+           DekiruRails: 'dekiru'
+        },
+        'DekiruRuby' => {
+          'DekiruRuby' => 'dekiru'
+        }
+      })
+    end
+  end
+end

data/spec/dekiru/data_migration_operator_spec.rb

@@ -0,0 +1,113 @@
+require "spec_helper"
+
+describe Dekiru::DataMigrationOperator do
+  let(:dummy_stream) do
+    class Dekiru::DummyStream
+      attr_reader :out
+
+      def initialize
+        @out = ''
+      end
+
+      def puts(text)
+        @out = out << "#{text}\n"
+      end
+
+      def print(text)
+        @out = out << text
+      end
+
+      def tty?
+        false
+      end
+
+      def flush
+      end
+    end
+    Dekiru::DummyStream.new
+  end
+  let(:operator) { Dekiru::DataMigrationOperator.new('dummy', output: dummy_stream) }
+
+  describe '#execute' do
+    it 'confirm で yes' do
+      allow(STDIN).to receive(:gets) do
+        "yes\n"
+      end
+
+      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).to include('Are you sure to commit?')
+      expect(operator.stream.out).to include('Finished successfully:')
+      expect(operator.stream.out).to include('Total time:')
+    end
+
+    it 'confirm で no' do
+      allow(STDIN).to receive(:gets) do
+        "no\n"
+      end
+
+      expect do
+        operator.execute { log 'processing'; sleep 1.0 }
+      end.to raise_error(ActiveRecord::Rollback)
+
+      expect(operator.result).to eq(false)
+      expect(operator.duration).to be_within(0.1).of(1.0)
+      expect(operator.error.class).to eq(ActiveRecord::Rollback)
+      expect(operator.stream.out).to include('Are you sure to commit?')
+      expect(operator.stream.out).to include('Canceled:')
+      expect(operator.stream.out).to include('Total time:')
+    end
+
+    it '処理中に例外' do
+      expect do
+        operator.execute { raise ArgumentError }
+      end.to raise_error(ArgumentError)
+
+      expect(operator.result).to eq(false)
+      expect(operator.error.class).to eq(ArgumentError)
+      expect(operator.stream.out).not_to include('Are you sure to commit?')
+      expect(operator.stream.out).not_to include('Canceled:')
+      expect(operator.stream.out).to include('Total time:')
+    end
+  end
+
+  describe '#find_each_with_progress' do
+    it '進捗が表示される' do
+      class Dekiru::DummyRecord
+        def self.count
+          10
+        end
+
+        def self.find_each
+          (0...count).to_a.each do |num|
+            yield(num)
+          end
+        end
+      end
+
+      allow(STDIN).to receive(:gets) do
+        "yes\n"
+      end
+
+      sum = 0
+      operator.execute do
+        find_each_with_progress(Dekiru::DummyRecord, title: 'count up number') do |num|
+          sum += num
+        end
+      end
+
+      expect(sum).to eq(45)
+      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('count up number:')
+      expect(operator.stream.out).to include('Finished successfully:')
+      expect(operator.stream.out).to include('Total time:')
+    end
+  end
+end

data/spec/dekiru/mail_security_interceptor_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+class TestMailer < ActionMailer::Base 
+  default from: 'no-reply@dekiru.test'
+
+  def test(to)
+    mail to: to, subject: 'test', body: 'test'
+  end
+end
+
+describe Dekiru::MailSecurityInterceptor do  
+  before do
+    interceptor = Dekiru::MailSecurityInterceptor.new
+    ActionMailer::Base.register_interceptor(interceptor)
+  end
+
+  context '宛先（to）が空配列の場合' do 
+    let(:to_address) { [] }
+    it '例外が発生すること' do 
+      expect { TestMailer.test(to_address).deliver_now }.to raise_error(Dekiru::MailSecurityInterceptor::NoToAdreessError)
+    end
+  end
+  context '宛先（to）が空文字の場合' do 
+    let(:to_address) { '' }
+    it '例外が発生すること' do 
+      expect { TestMailer.test(to_address).deliver_now }.to raise_error(Dekiru::MailSecurityInterceptor::NoToAdreessError)
+    end
+  end
+  context '宛先（to）がnilの場合' do 
+    let(:to_address) { nil }
+    it '例外が発生すること' do 
+      expect { TestMailer.test(to_address).deliver_now }.to raise_error(Dekiru::MailSecurityInterceptor::NoToAdreessError)
+    end
+  end
+  context '宛先（to）が文字列の場合' do 
+    let(:to_address) { 'test@dekiru.test' }
+    it '例外が発生しないこと' do 
+      expect { TestMailer.test(to_address).deliver_now }.not_to raise_error
+    end
+  end
+  context '宛先（to）が配列の場合' do
+    let(:to_address) { ['test@dekiru.test'] }
+    it '例外が発生しないこと' do 
+      expect { TestMailer.test(to_address).deliver_now }.not_to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,16 +8,14 @@ require 'active_support/core_ext/object'
 require "active_record"
 require "action_view"
 require "action_view/helpers"
+require 'action_mailer'
 
 PROJECT_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
 
 $LOAD_PATH << File.join(PROJECT_ROOT, 'lib')
 
 require 'dekiru'
-
-Dir.glob(File.join(PROJECT_ROOT, 'spec', 'support', '**', '*.rb')).each do |file|
-  require(file)
-end
+Dir.glob(File.join(PROJECT_ROOT, 'spec/supports/**/*.rb')).each { |f| require f }
 
 RSpec.configure do |config|
 end

data/spec/supports/action_mailer.rb

@@ -0,0 +1 @@
+ActionMailer::Base.delivery_method = :test

data/spec/supports/mock_active_record.rb

@@ -0,0 +1,5 @@
+class ActiveRecord::Base
+  def self.transaction(*args)
+    yield(*args)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dekiru
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Akihiro Matsumura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-23 00:00:00.000000000 Z
+date: 2020-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_accept_language
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -110,9 +124,13 @@ files:
 - Rakefile
 - dekiru.gemspec
 - lib/dekiru.rb
+- lib/dekiru/camelize_hash.rb
 - lib/dekiru/capybara/helpers.rb
+- lib/dekiru/capybara/matchers.rb
 - lib/dekiru/controller_additions.rb
+- lib/dekiru/data_migration_operator.rb
 - lib/dekiru/helper.rb
+- lib/dekiru/mail_security_interceptor.rb
 - lib/dekiru/railtie.rb
 - lib/dekiru/smtp_check_mailer.rb
 - lib/dekiru/task_with_logger.rb
@@ -120,9 +138,14 @@ files:
 - lib/dekiru/tasks/smtp_check.rake
 - lib/dekiru/validators/existence.rb
 - lib/dekiru/version.rb
+- spec/dekiru/camelize_hash_spec.rb
+- spec/dekiru/data_migration_operator_spec.rb
 - spec/dekiru/helper_spec.rb
+- spec/dekiru/mail_security_interceptor_spec.rb
 - spec/dekiru/validators/existence_spec.rb
 - spec/spec_helper.rb
+- spec/supports/action_mailer.rb
+- spec/supports/mock_active_record.rb
 homepage: ''
 licenses: []
 metadata: {}
@@ -134,19 +157,23 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Usefull helper methods for Ruby on Rails
 test_files:
+- spec/dekiru/camelize_hash_spec.rb
+- spec/dekiru/data_migration_operator_spec.rb
 - spec/dekiru/helper_spec.rb
+- spec/dekiru/mail_security_interceptor_spec.rb
 - spec/dekiru/validators/existence_spec.rb
 - spec/spec_helper.rb
+- spec/supports/action_mailer.rb
+- spec/supports/mock_active_record.rb