dekiru 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c0bb6ed019dee9b851e2f68be25d4bb213a96c7d482fe9a1025ff89534809f2
-  data.tar.gz: 71ab7770a0b3d111f1fb62668bfff4a3bf3e23a548c1217a1d15da40edc74169
+  metadata.gz: fa88f3d2cf47df7ed8a071acc0dbb0b86fa20e42c5ad3e72b3f23fb8c6f593b5
+  data.tar.gz: ddabf00fc5c3dfcfb8a22f9103f7a8d90ea5e92b6c158bd2b4ea1936d48ebc81
 SHA512:
-  metadata.gz: 8930b878569914b971c14d5521091060ecf2079deec914a96e5d9ef9461e067df7b44d2d877988dbb40df15e94114dc05dda361c81985062427d4d7366d688fd
-  data.tar.gz: e30b62a917913f8abfaaa2aadf9b4d56c584d24e107401f4cd855e089aa0d440a5eca0bacdba7d812d3feb8a911c2b9cae8679607191af938deb1d53bc6a15f2
+  metadata.gz: 02ed8451df03137d882758e3adb2fb06f7d8aa3b9e240ec84cd0e59a3bf460945f18919717010c44f58f13abbd6f468d39a33d37a29c9ad809334385ecbd6adc
+  data.tar.gz: be1798f99193883c7bb7978f52b9e52e40bcd2e01e1b041159f110c1be6517922b7a6067978a423e3c9315bf9a870bceb465fae1234b2929a318d191d486066c

data/README.md

@@ -109,6 +109,51 @@ 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
+```
+
 ## Contributing
 
 1.  Fork it

data/dekiru.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |gem|
 
   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,28 @@ 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 '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/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) 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/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/version.rb

@@ -1,3 +1,3 @@
 module Dekiru
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 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.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Akihiro Matsumura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-29 00:00:00.000000000 Z
+date: 2019-06-01 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
@@ -113,7 +127,9 @@ files:
 - 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
@@ -121,9 +137,13 @@ files:
 - lib/dekiru/tasks/smtp_check.rake
 - lib/dekiru/validators/existence.rb
 - lib/dekiru/version.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: {}
@@ -148,6 +168,10 @@ signing_key:
 specification_version: 4
 summary: Usefull helper methods for Ruby on Rails
 test_files:
+- 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