feat(bdd): setup and /admin/users CRUD exmaple

Author: marsz

.rspec

@@ -1,4 +1,5 @@
 --color
 --require spec_helper
+--require turnip/rspec
 --profile
 --format progress

Gemfile

@@ -89,6 +89,7 @@ end
 group :test do
   gem 'database_cleaner'
   gem 'timecop'
+  gem 'turnip'
   gem 'webmock'
 end
 

Gemfile.lock

@@ -170,6 +170,7 @@ GEM
       fog-core
       nokogiri (>= 1.5.11, < 2.0.0)
     formatador (0.2.5)
+    gherkin (4.1.3)
     globalid (0.4.0)
       activesupport (>= 4.2.0)
     hashdiff (0.3.6)
@@ -433,6 +434,9 @@ GEM
     turbolinks (5.0.1)
       turbolinks-source (~> 5)
     turbolinks-source (5.0.3)
+    turnip (3.0.0)
+      gherkin (~> 4.0)
+      rspec (>= 3.0, < 4.0)
     tzinfo (1.2.3)
       thread_safe (~> 0.1)
     uglifier (3.2.0)
@@ -533,6 +537,7 @@ DEPENDENCIES
   spring-commands-rspec
   timecop
   turbolinks (~> 5)
+  turnip
   uglifier (>= 1.3.0)
   unicorn
   web-console (~> 3.0)

lib/tasks/spec.rake

@@ -0,0 +1,9 @@
+if Rails.env.development? || Rails.env.test?
+  namespace :spec do
+
+    RSpec::Core::RakeTask.new(:features) do |task|
+      file_list = FileList['spec/**/*.feature']
+      task.pattern = file_list
+    end
+  end
+end

spec/acceptance/.gitkeep

@@ -0,0 +1,18 @@
+Feature: 基本驗證
+  Scenario: 沒登入
+    When 前往 /admin
+      Then 頁面轉跳
+    When 前往 /sidekiq
+      Then 頁面轉跳
+  Scenario: 非 admin 登入
+    Given user 登入
+      When 前往 /admin
+        Then 頁面轉跳
+      When 前往 /sidekiq
+        Then 頁面回應 404
+  Scenario: 非 admin 登入
+    Given 管理者 登入
+      When 前往 /admin
+        Then 頁面回應 正常
+      When 前往 /sidekiq
+        Then 頁面回應 正常

spec/acceptance/admin/index.feature

@@ -0,0 +1,24 @@
+Feature: 從後台新增 user
+  Background:
+    Given 管理者 登入
+      And 已註冊 users:
+          | email  |
+          | marsz@5fpro.com  |
+  Scenario: 新增頁面可正常載入
+    When 前往 後台新增使用者頁面
+    Then 頁面回應 正常
+  Scenario: 不能新增重複 Email 的 user
+    When 後台建立使用者:
+         | email | marsz@5fpro.com |
+    Then 頁面回應 正常
+     And 使用者數 不變
+  Scenario: 成功建立 user
+    When 後台建立使用者:
+         | email | marsz123@5fpro.com |
+    Then 頁面轉跳
+     And 使用者數 +1
+  Scenario: 夾帶檔案（頭像）測試
+    When 後台建立使用者:
+         | name | marsz123 |
+         | avatar | y |
+    Then 使用者(marsz123)有頭像

spec/acceptance/admin/users/create.feature

@@ -0,0 +1,10 @@
+Feature: 從後台更新 user
+  Background:
+    Given 管理者 登入
+      And 已註冊 users:
+          | name | email  |
+          | marsz | marsz@5fpro.com  |
+  Scenario: 刪除使用者
+    When 後台刪除使用者 User(marsz)
+    Then 頁面轉跳
+     And User(marsz@5fpro.com) 不存在

spec/acceptance/admin/users/destroy.feature

@@ -0,0 +1,26 @@
+Feature: 使用者後台列表
+  Background:
+    Given 管理者 登入
+      And 已註冊 users:
+          | name  |
+          | Mars  |
+          | Peter |
+  Scenario: 基本列表
+    When 前往 /admin/users
+      Then 頁面回應 正常
+       And 頁面包含 Mars
+       And 頁面包含 Peter
+  Scenario: 可搜尋
+    When 前往 /admin/users?q[name_cont]=mars
+      Then 頁面回應 正常
+       And 頁面包含 Mars
+       And 頁面不包含 Peter
+  Scenario: 可 CSV 格式匯出
+    When 前往 /admin/users.csv
+      Then 頁面回應 正常
+       And 頁面包含 Mars
+       And 頁面包含 Peter
+    When 前往 /admin/users.csv?q[name_cont]=mars
+      Then 頁面回應 正常
+       And 頁面包含 Mars
+       And 頁面不包含 Peter

spec/acceptance/admin/users/index.feature

@@ -0,0 +1,9 @@
+Feature: 使用者後台列表
+  Background:
+    Given 管理者 登入
+      And 已註冊 users:
+          | name  |
+          | Mars  |
+  Scenario: 前往後台使用者頁面
+    When 前往 User(Mars) 的 後台使用者頁面
+    Then 頁面回應 正常

spec/acceptance/admin/users/show.feature

@@ -0,0 +1,20 @@
+Feature: 從後台更新 user
+  Background:
+    Given 管理者 登入
+      And 已註冊 users:
+          | name | email  |
+          | marsz | marsz@5fpro.com  |
+          | venus | venus@5fpro.com  |
+  Scenario: 編輯頁面可正常載入
+    When 前往 User(marsz) 的 後台使用者編輯頁面
+    Then 頁面回應 正常
+  Scenario: 不能把 email 更新為已存在的 user
+    When 後台更新使用者 User(marsz):
+         | email | venus@5fpro.com |
+    Then 頁面回應 200
+     And User(marsz) 的 email 沒有更新
+  Scenario: 成功更新 user
+    When 後台更新使用者 User(marsz):
+         | name | jupiter |
+    Then 頁面轉跳
+     And User(marsz@5fpro.com) 的 name 更新為 'jupiter'

spec/acceptance/admin/users/update.feature

@@ -0,0 +1,12 @@
+Feature: 首頁
+  Scenario: 首頁預設為 json
+    When 前往 API首頁
+      Then 頁面回應 正常
+      And 回應格式為 JSON
+  Scenario: 各種 404
+    When 對 API首頁 打 POST
+      Then 頁面回應 404
+    When 前往 /_dwr/interface/WbmemberDWR.js
+      Then 頁面回應 404
+    When 前往 /asdasads
+      Then 頁面回應 404

spec/acceptance/api/index.feature

@@ -0,0 +1,18 @@
+Feature: 基本頁面
+  Scenario: 首頁正常
+    When 前往 首頁
+      Then 頁面回應 正常
+  Scenario: robots.txt 正常回應
+    When 前往 /robots.txt
+      Then 頁面回應 正常
+      And 回應內容不含 '<html'
+      And 回應格式為 text
+    When 前往 /robots
+      Then 頁面回應 404
+  Scenario: 各種 404
+    When 對 首頁 打 POST
+      Then 頁面回應 404
+    When 前往 /_dwr/interface/WbmemberDWR.js
+      Then 頁面回應 404
+    When 前往 /asdasads
+      Then 頁面回應 404

spec/acceptance/index.feature

@@ -42,5 +42,9 @@
     factory :user_with_avatar do
       avatar { File.open(Rails.root.join('spec', 'fixtures', '5fpro.png')) }
     end
+
+    trait :admin_creation do
+      confirmed_at nil
+    end
   end
 end

spec/factories/users.rb

@@ -0,0 +1,29 @@
+step '後台建立使用者:' do |table|
+  @users_count = User.count
+  params = { user: attributes_for(:user, :admin_creation, table.rows_hash.symbolize_keys) }
+  params[:user][:avatar] = file_data if params[:user][:avatar].present?
+  post '/admin/users', params: params
+end
+
+step '後台更新使用者 :model_finder:' do |instance, table|
+  @user = instance
+  params = {
+    user: table.rows_hash.symbolize_keys
+  }
+  put "/admin/users/#{instance.id}", params: params
+end
+
+step '後台刪除使用者 :model_finder' do |instance|
+  @user = instance
+  delete "/admin/users/#{instance.id}"
+end
+
+step '使用者數 :count_changed' do |changed|
+  expect(@users_count + changed).to eq(User.count)
+end
+
+step '使用者(:name)有頭像' do |name|
+  @user ||= User.last
+  expect(@user.name).to eq(name)
+  expect(@user.avatar.url).to be_present
+end

spec/steps/.gitkeep

@@ -0,0 +1,3 @@
+step '已註冊 users:' do |table|
+  @users = table.hashes.map { |h| create(:user, h) }
+end

spec/steps/admin/users_steps.rb

@@ -0,0 +1,13 @@
+step ':model_finder 的 :attr :have更新' do |instance, attr, have|
+  expect {
+    instance.reload
+  }.public_send have ? :to : :not_to, change { instance.public_send(attr) }
+end
+
+step ':model_finder 的 :attr 更新為 \':value\'' do |instance, attr, value|
+  expect(instance.public_send(attr).to_s).to eq(value)
+end
+
+step ':model_finder 不存在' do |instance|
+  expect(instance).to eq(false)
+end

spec/steps/data_steps.rb

@@ -0,0 +1,7 @@
+placeholder :count_changed do
+  match /[\+\-][0-9]+/, &:to_i
+
+  match /不變/ do |_count|
+    0
+  end
+end

spec/steps/model_steps.rb

@@ -0,0 +1,9 @@
+placeholder :have do
+  match /沒有/ do
+    false
+  end
+
+  match /^有$/ do
+    true
+  end
+end

spec/steps/placeholders/count_changed_steps.rb

@@ -0,0 +1,15 @@
+MODEL_FINDER_MAP = {
+  'User' => [:name, :email, :id]
+}.freeze
+
+placeholder :model_finder do
+  match /([A-Z][a-zA-Z0-9:]+)\((.+?)\)/ do |klass, value|
+    klass = klass.constantize
+    instance = nil
+    MODEL_FINDER_MAP[klass.to_s].each do |col|
+      instance ||= klass.find_by(col => value)
+      break if instance
+    end
+    instance || false
+  end
+end

spec/steps/placeholders/have_steps.rb

@@ -0,0 +1,9 @@
+placeholder :page_caller do
+  match /後台使用者頁面/ do
+    ->(u) { "/admin/users/#{u.id}" }
+  end
+
+  match /後台使用者編輯頁面/ do
+    ->(u) { "/admin/users/#{u.id}/edit" }
+  end
+end

spec/steps/placeholders/model_finder_steps.rb

@@ -0,0 +1,17 @@
+placeholder :page do
+  match /API首頁/ do
+    '/api'
+  end
+
+  match /後台新增使用者頁面/ do
+    '/admin/users/new'
+  end
+
+  match /首頁/ do
+    '/'
+  end
+
+  match /\/.+/ do |page|
+    page
+  end
+end

spec/steps/placeholders/page_caller_steps.rb

@@ -0,0 +1,17 @@
+step '前往 :page' do |page|
+  get page
+end
+
+step '前往 :model_finder 的 :page_caller' do |model_finder, page_caller|
+  get page_caller.call(model_finder)
+end
+
+step '對 :page 打 :req_method' do |page, req_method|
+  public_send(req_method, page)
+end
+
+placeholder :req_method do
+  match /(POST|post|PUT|put|DELETE|delete)/ do |method|
+    method.to_s.downcase
+  end
+end

spec/steps/placeholders/page_steps.rb

@@ -0,0 +1,37 @@
+step '頁面回應 :http_status' do |http_status|
+  if http_status.is_a?(Integer)
+    expect(response.status).to eq(http_status)
+  end
+end
+
+placeholder :http_status do
+  match /正常/ do
+    200
+  end
+
+  match /\d+/, &:to_i
+end
+
+step '回應內容:is_matched \':matched_content\'' do |is_matched, matched_content|
+  if is_matched == '不含'
+    expect(response.body).not_to include(matched_content)
+  elsif is_matched.index('含')
+    expect(response.body).to include(matched_content)
+  end
+end
+
+step '回應格式為 :format' do |format|
+  expect(response.headers['Content-Type']).to include(format.to_s.downcase)
+end
+
+step '頁面轉跳' do
+  expect(response).to be_redirect
+end
+
+step '頁面包含 :content' do |content|
+  expect(response.body).to include(content)
+end
+
+step '頁面不包含 :content' do |content|
+  expect(response.body).not_to include(content)
+end

spec/steps/request_steps.rb

@@ -0,0 +1,14 @@
+step ':user 登入' do |user|
+  @current_user ||= user
+  signin_user(@current_user)
+end
+
+placeholder :user do
+  match /user/ do
+    create(:user)
+  end
+
+  match /管理者/ do
+    create(:admin_user)
+  end
+end

spec/steps/response_steps.rb

@@ -0,0 +1,11 @@
+Turnip.type = :request
+require 'rails_helper'
+Dir[Rails.root.join('spec/steps/**/*_steps.rb')].each { |f| load f }
+include FactoryGirl::Syntax::Methods
+
+RSpec.configure do |config|
+  config.raise_error_for_unimplemented_steps = true
+
+  config.include FactoryGirl::Syntax::Methods
+  config.include RequestClient, type: :request
+end