wootaw

Ruby 里的展开操作符

wootaw — Fri, 20 Sep 2019 20:53:18 +0800

ES6 中 Hash 有一个展开操作符 (spread operator) (...) 功能强大，在 ruby 中也有一个类似功能的操作符 (**)

用在函数参数中

def fun1(**options)
  puts "options #{options}"
end

fun1(one: 1, two: 2) # 输出 options {:one=>1, :two=>2}
fun1({one: 1, two: 2}) # 输出 options {:one=>1, :two=>2}

def fun2(one:, two:, **options)
  puts "options #{options}"
end

fun2(one: 1, two: 2) # 输出 options {}
fun2(one: 1, two: 2, three: 3) # 输出 options {:three=>3}
fun2(one: 1, two: 2, { three: 3 }) # 输出 SyntaxError: unexpected ')', expecting =>

用在 Hash 的合并中

合并两个 Hash：

a = { one: 1, two: 2 }
b = { two: 22, three: 3 }
{ **a, **b } # = {:one=>1, :two=>22, :three=>3}

还可以这么写：

b = { two: 22, three: 3 }
{ one: 1, two: 2, **b } # = {:one=>1, :two=>22, :three=>3}

看看基准测试

require 'benchmark'
n = 5000000
def merge
  hash = { one: 1 }
  { two: 2 }.merge(hash)
end

def spread
  hash = { one: 1 }
  { two: 2, **hash }
end

Benchmark.bm(2) do |x|
  x.report('merge: ') { n.times { merge } }
  x.report('spread:') { n.times { spread } }
end

结果：（ruby 2.6.2）(**) 操作符会比 merge 稍稍快一点点

         user     system      total        real
merge:   1.640279   0.014161   1.654440 (  1.800680)
spread:  1.460447   0.010523   1.470970 (  1.550659)

需要注意的几个地方

(**) 操作符只能用在 key 为 symbol 的 Hash

c = { "two" => 22, "three" => 33 }
{ one: 1, two: 2, **c } # TypeError: wrong argument type String (expected Symbol)

另外，在 Rails 中的 controller 里

def fun3(**options); end

object_params = params.permit(:one, :two)
fun3(object_params) # 这样用是不行的 ActionController::UnfilteredParameters - unable to convert unpermitted parameters to hash:

因为 params 不是一个 Hash

fun3(object_params.to_h.symbolize_keys)

这样就可以了

Rails 6 中的 enum 现在可以使用非 scopes

wootaw — Fri, 08 Mar 2019 10:39:21 +0800

以前我们在 model 中定义了 enum 属性：

class Post < ActiveRecord::Base
  enum status: %i[drafted active trashed]
end

Rails 会添加一些默认的 scopes，那么可以这么使用：

Post.drafted # => where(status: :drafted)
Post.active  # => where(status: :active)

Rails6 中现在还会添加一些非 scopes，现在可以这么写了：

Post.not_drafted # => where.not(status: :drafted)
Post.not_active  # => where.not(status: :active)

使用 RSpec 在 Rails 5 下测试邮件的发送

wootaw — Mon, 22 May 2017 10:51:15 +0800

假设有这样的电子邮件：

class UserMailer < ApplicationMailer
  def welcome_email(user)
    @user = user
    mail(to: @user.email, subject: 'Welcome')
  end
end

然后这样发邮件：

class User < ApplicationRecord
  def self.register(email, password)
    user = create(email: email, password: password)
    UserMailer.welcome_email(user).deliver_later
  end
end

使用 deliver_later 方法需要在 application.rb 里加上：

config.active_job.queue_adapter = :sidekiq # 可以换成其它的 adapter

如果邮件模板中有外链，还需要在 environments/test.rb 里加上：

config.action_mailer.default_url_options = { host: 'test.mysite.com' }

在 user_spec.rb 里：

require 'rails_helper'

RSpec.describe User, type: :model do

  describe '.register' do
    include ActiveJob::TestHelper

    it 'should be created mail job' do
      ActiveJob::Base.queue_adapter = :test
      expect {
        User.register('jane@website.com', '123123')
      }.to have_enqueued_job.on_queue('mailers')
    end

    it 'should be sent welcome mail' do
      expect {
        perform_enqueued_jobs do
          User.register('jane@website.com', '123123')
        end
      }.to change { ActionMailer::Base.deliveries.size }.by(1)
    end

    it 'should be sent to the right user' do
      perform_enqueued_jobs do
        User.register('jane@website.com', '123123')
      end

      mail = ActionMailer::Base.deliveries.last
      expect(mail.to[0]).to eq "jane@mysite.com"
    end
  end
end

在项目中使用 AASM enum 全面替换 state_machines 的 migration

wootaw — Wed, 22 Feb 2017 12:29:53 +0800

把一个老项目中的 state_machines 全部替换掉，使用 AASM enum，因为字段类型变了，字段名称不想变（强迫症犯了）。

class ReplaceStateMachines < ActiveRecord::Migration
  def change

    [Order, Customer].each do |clazz|
      ActiveRecord::Base.connection.execute("select * from #{clazz.table_name}").each do |r|
        ActiveRecord::Base.connection.execute("update #{clazz.table_name} set state = #{clazz.states[r["state"]]} where id = #{r["id"]}")
      end
      ActiveRecord::Base.connection.execute("ALTER TABLE #{clazz.table_name} ALTER COLUMN state TYPE integer USING (trim(state)::integer)")
    end

  end
end

一个地区字段的小工具类

wootaw — Thu, 16 Feb 2017 11:53:33 +0800

看到社区里有人问地区字段的处理，想到我们项目里用到一个小工具类，还挺方便的，贡献出来，大家轻拍。

地区用一个表存储（districts），只有两个字段：name，code
code 表示地区代码，2 位表示省/直辖市，4 位表示市，6 位表示区/县
需要关联地区的表中都有一个 district_code 字段

然后有一个 Concern：

module Districtable

  extend ActiveSupport::Concern

  included do

    def descendant_and_self_districts
      District.where("code LIKE ?", "#{district_code}%")
    end

    def descendant_districts
      descendant_and_self_districts.order(:code).offset(1)
    end

    def children_districts
      District.where("code LIKE ?", "#{district_code}__")
    end

    def ancestor_and_self_districts
      District.where("? ~ code", district_code)
    end

    def ancestor_districts(start=1)
      ancestor_and_self_districts.order("code DESC").offset(start)
    end

    def parent_district
      ancestor_districts.take
    end

    def sibling_districts
      District.where("code LIKE ?", "#{district_code[0..-3]}__")
    end

    def district_name(split='')
      district_code.nil? ? nil : ancestor_and_self_districts.order(:code).map(&:name).join(split)
    end

  end

end

使用的时候，在关联地区的 Model 中

class Organization < ActiveRecord::Base
  include Districtable
end

使用 rack-cors 在 production 环境下不能响应 PUT、DELETE

wootaw — Wed, 21 Oct 2015 16:11:48 +0800

在 rails 项目中使用 grape 写 api，使用 rack-cors 在 development 环境下没问题，但到了 production 环境下，所有 PUT、DELETE 请求都是 405，而 PUT、DELETE 请求之前的 OPTIONS 都是 200

在 application.rb 中

config.middleware.insert_before ActionDispatch::Static, Rack::Cors do
  allow do
    origins '*'
    resource '*', :headers => :any, :methods => [:get, :post, :delete, :put, :options]
  end
end

nginx 配置：

upstream my_unicorn {
 server unix:/srv/www/myapp/shared/sockets/unicorn.sock;
}

server {
  listen 80;
  server_name www.mysite.com;

  access_log /var/log/nginx/myapp.access.log;

  root /srv/www/myapp/current/public/;

  location / {
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header Host $http_host;
    proxy_redirect off;

    proxy_pass http://my_unicorn;
  }

}

Mina 部署时遇到 GitHub 的校验问题

wootaw — Wed, 12 Aug 2015 17:56:00 +0800

在服务器上 ssh -vT git@github.com，可以得到成功但是在 mina 中加入 queue %[ssh -vT "git@github.com"]，却始终 Permission denied (publickey) 好像问题出在 key_parse_private_pem: PEM_read_PrivateKey failed

ssh 到服务器与 mina 中使用的同一账号

使用 Webmock 和 VCR 搭建测试，对调用第三方 API 库的支持

wootaw — Tue, 21 Jul 2015 13:51:52 +0800

因为我们的接口中调用了第三方 API，最近在编写测试时遇到一些问题：

对方不提供沙箱服务器
对方的 API 有调用次数的限制
有些服务只有接口文档，但还没有实现功能
如果网络不好的时候，还会让测试跑起来龟速；有时候是网络原因，造成测试用例跑不过
跑单元测试时却向真实 API 发送请求

直到发现 rest-client 里用到了Webmock

Webmock

首先在 Gemfile 中加入：

# Gemfile
group :test do
  gem 'webmock'
end

我开始时犯了一个错误，这么写：

# Gemfile
group :test, :development do
  gem 'rspec-rails'
  gem 'factory_girl_rails'
  gem 'simplecov'
  gem 'webmock'
end

结果导致在开发环境下，API 调用都不能用了：

WebMock::NetConnectNotAllowedError - Real HTTP connections are disabled. Unregistered request:

接着在 spec_helper.rb 里加入：

# spec/spec_helper.rb
require 'webmock/rspec'
WebMock.disable_net_connect!(allow_localhost: true)

现在可以按 API 文档的输入输出伪造一些 URL 了：

before(:each) do
  @valid_token = "blablabla"
  @valid_id = "blabla"
  stub_request(:post, "http://api.example.com/api/auth")
    .with(body: { token: @valid_token })
    .to_return(status: 201, body: { id: @valid_id, token: @valid_token }.to_json)

  @invalid_token = "invalidblablabla"
  stub_request(:post, "http://api.example.com/api/auth")
    .with(body: { token: @invalid_token })
    .to_return(status: 401)
end

但是这样写，在每个调用了第三方 API 的测试里，开头都得定义一堆这样的东西，乱乱的。又发现一个好东西 VCR

VCR

这东西有个最大的好处就是可以让我们按第三方 API 文档的说明，集中的定义好所有伪造 URL

首先在 spec_helper.rb 里加入：

# spec/spec_helper.rb
RSpec.configure do |config|
  config.before(:each) do
    stub_request(:any, /api.example.com/).to_rack(BlaApi)
  end
end

然后在 spec/support/下创建一个：

# spec/support/bla_api.rb
class BlaApi < Grape::API   # 我们用的Grape
  prefix :api
  format :json

  namespace :auth do

    post do
      case params[:token]
      when "blablabla" # valid token
        { id: "blabla", token: "blablabla" }
      when "invalidblablabla" # invalid token
        error!({ "error" => "bla bla bla" }, 401)
      else
        error!({ "error" => "bla bla bla" }, 401)
      end
    end

  end
end

现在就可以按照 API 文档尽情伪造 URL 了

后记

还有一些想法，没有实现，有兴趣的大虾们可以就此展开

对于返回数据量大的 API，我们可以把数据存到一个 yml 文件中，在 BlaApi 里读出返回，这样就可以灵活配置修改返回的数据了
是不是可以在第一次调用时请求真实的 API，然后把数据缓存起来，之后的请求就可以一直使用被缓存的数据
有些 API 会回调请求调用者的服务器（调用者可能会对数据库做修改），再根据调用者的返回组装数据，生成他们的 API 返回。这样的 API 怎么测试