github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-11-26 11:13:38 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Adds support for a description to user fields.

Browse Source
This commit is contained in:
Robin Ward 2014-10-02 15:56:28 -04:00
parent 295a3c108e
commit 381814fd5d
22 changed files with 157 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
app/assets/javascripts/admin/controllers/admin-user-field-item.js.es6
View File

@ -13,14 +13,18 @@ export default Ember.ObjectController.extend(BufferedContent, {
save: function() {
var self = this;
var attrs = this.get('buffered').getProperties('name', 'field_type', 'editable');
var attrs = this.get('buffered').getProperties('name', 'description', 'field_type', 'editable');
this.get('model').save(attrs).then(function(res) {
self.set('model.id', res.user_field.id);
self.set('editing', false);
self.commitBuffer();
}).catch(function() {
bootbox.alert(I18n.t('generic_error'));
}).catch(function(e) {
var msg = I18n.t("generic_error");
if (e.responseJSON && e.responseJSON.errors) {
msg = I18n.t("generic_error_with_reason", {error: e.responseJSON.errors.join('. ')});
}
bootbox.alert(msg);
});
},

5
app/assets/javascripts/admin/controllers/admin-user-fields.js.es6
View File

@ -3,6 +3,11 @@ import UserField from 'admin/models/user-field';
export default Ember.ArrayController.extend({
fieldTypes: null,
createDisabled: Em.computed.gte('model.length', 3),
userFieldsDescription: function() {
return I18n.t('admin.user_fields.description');
}.property(),
userFieldsName: function() {
return I18n.t('admin.user_fields.name');
}.property(),

43
app/assets/javascripts/admin/templates/user-fields.hbs
View File

@ -1,28 +1,36 @@
<div class='user-fields'>
<h2>{{i18n admin.user_fields.title}}</h2>
<p class="desc">{{i18n admin.user_fields.description}}</p>
<p class="desc">{{i18n admin.user_fields.help}}</p>
{{#if model}}
{{#each f in model itemController="admin-user-field-item" itemView="admin-user-field-item"}}
{{#if f.editing}}
<div class='form-element'>
{{input value=f.buffered.name class="user-field-name" placeholder=userFieldsName}}
<div class='row'>
<div class='form-element'>
{{input value=f.buffered.name class="user-field-name" placeholder=userFieldsName}}
</div>
<div class='form-element'>
{{combo-box content=fieldTypes valueAttribute="id" value=f.buffered.field_type}}
</div>
<div class='form-element'>
<label>
{{input type="checkbox" checked=f.buffered.editable}} {{i18n admin.user_fields.editable.title}}
</label>
</div>
<div class='form-element controls'>
<button {{action "save"}}class='btn btn-primary'>{{fa-icon 'check'}} {{i18n admin.user_fields.save}}</button>
<button {{action "cancel"}} class='btn btn-danger'>{{fa-icon 'times'}} {{i18n admin.user_fields.cancel}}</button>
</div>
</div>
<div class='form-element'>
{{combo-box content=fieldTypes valueAttribute="id" value=f.buffered.field_type}}
</div>
<div class='form-element'>
<label>
{{input type="checkbox" checked=f.buffered.editable}} {{i18n admin.user_fields.editable.title}}
</label>
</div>
<div class='form-element controls'>
<button {{action "save"}}class='btn btn-primary'>{{fa-icon 'check'}} {{i18n admin.user_fields.save}}</button>
<button {{action "cancel"}} class='btn btn-danger'>{{fa-icon 'times'}} {{i18n admin.user_fields.cancel}}</button>
<div class="row">
<div class='form-element'>
{{input value=f.buffered.description class="user-field-desc" placeholder=userFieldsDescription}}
</div>
</div>
{{else}}
<div class='form-display'>{{f.name}}</div>
<div class="row">
<div class='form-display'><strong>{{f.name}}</strong></div>
<div class='form-display'>{{f.fieldName}}</div>
<div class='form-display'>
{{#if f.editable}}
@ -35,6 +43,11 @@
<button {{action "edit"}}class='btn btn-default'>{{fa-icon 'pencil'}} {{i18n admin.user_fields.edit}}</button>
<button {{action "destroy"}}class='btn btn-danger'>{{fa-icon 'trash-o'}} {{i18n admin.user_fields.delete}}</button>
</div>
</div>
<div class="row">
{{f.description}}
</div>
{{/if}}
<div class='clearfix'></div>
{{/each}}

2
app/assets/javascripts/discourse/components/user-field.js.es6
View File

@ -1,5 +1,5 @@
export default Ember.Component.extend({
classNameBindings: [':user-field'],
classNameBindings: [':user-field', 'field.field_type'],
layoutName: function() {
return "components/user-fields/" + this.get('field.field_type');
}.property('field.field_type')

2
app/assets/javascripts/discourse/controllers/preferences.js.es6
View File

@ -22,7 +22,7 @@ export default ObjectController.extend(CanCheckEmails, {
var siteUserFields = this.site.get('user_fields');
if (!Ember.empty(siteUserFields)) {
var userFields = this.get('user_fields');
return siteUserFields.filterProperty('editable', true).map(function(uf) {
return siteUserFields.filterProperty('editable', true).sortBy('field_type').map(function(uf) {
var val = userFields ? userFields[uf.get('id').toString()] : null;
return Ember.Object.create({value: val, field: uf});
});

6
app/assets/javascripts/discourse/templates/components/user-fields/confirm.hbs
View File

@ -1,3 +1,3 @@
<label>
{{input checked=value type="checkbox"}} {{{field.name}}}
</label>
<div class='controls'>
<label>{{input checked=value type="checkbox"}} {{field.description}}</label>
</div>

7
app/assets/javascripts/discourse/templates/components/user-fields/text.hbs
View File

@ -1,4 +1,5 @@
<label>
{{{field.name}}}
<label>{{{field.name}}}</label>
<div class='controls'>
{{input value=value}}
</label>
<p>{{field.description}}</p>
</div>

1
app/assets/javascripts/discourse/templates/modal/create-account.hbs
View File

@ -71,6 +71,7 @@
</table>
{{log userFields}}
{{#if userFields}}
<div class='user-fields'>
{{#each userFields}}

8
app/assets/javascripts/discourse/templates/user/preferences.hbs
View File

@ -179,13 +179,13 @@
{{preference-checkbox labelKey="user.edit_history_public" checked=edit_history_public}}
{{/unless}}
{{#each userFields}}
{{user-field field=field value=value}}
{{/each}}
{{plugin-outlet "user_custom_preferences"}}
</div>
{{#each userFields}}
{{user-field field=field value=value}}
{{/each}}
<div class="control-group category">
<label class="control-label">{{i18n user.categories_settings}}</label>
<div class="controls category-controls">

36
app/assets/stylesheets/common/base/login.scss
View File

@ -12,27 +12,33 @@
display: none;
}
.user-fields {
h3 {
line-height: 1.5em;
color: scale-color($primary, $lightness: 20%);
border-bottom: 1px solid scale-color($primary, $lightness: 50%);
margin-bottom: 20px;
.create-account {
.user-field.confirm {
margin-top: 20px;
}
.user-field {
label: {
display: block;
label {
width: 92px;
float: left;
}
input[type=text] {
width: 80%;
display: block;
width: 220px;
margin-bottom: 0;
}
input[type=checkbox] {
margin-right: 5px;
.controls {
margin-left: 92px;
label {
width: auto;
text-align: left;
font-weight: normal;
float: auto;
}
p {
color: scale-color($primary, $lightness: 50%);
margin: 0;
}
}
margin-bottom: 20px;
clear: both;
}
}

1
app/assets/stylesheets/desktop/login.scss
View File

@ -59,4 +59,5 @@
.tos-agree {
margin-bottom: 12px;
}
}

42
app/assets/stylesheets/desktop/user.scss
View File

@ -75,6 +75,14 @@
}
}
.form-horizontal .control-group.other {
margin-bottom: 0;
}
.form-horizontal .control-group.category {
margin-top: 18px;
}
.user-navigation {
width: 21.62%;
margin-right: 1.8018%;
@ -427,12 +435,36 @@
background-color: #c22020;
}
.user-field.text {
padding-top: 18px;
}
.user-field {
margin-left: 160px;
margin-top: 10px;
input[type=text] {
width: 540px;
display: block;
label {
width: 140px;
float: left;
text-align: right;
font-weight: bold;
}
input[type=text] {
width: 530px;
}
.controls {
label {
width: auto;
text-align: left;
font-weight: normal;
float: auto;
}
p {
color: scale-color($primary, $lightness: 50%);
margin-top: 5px;
margin-bottom: 10px;
font-size: 80%;
line-height: 1.4em;
}
}
clear: both;
margin-bottom: 10px;
}
}

20
app/assets/stylesheets/mobile/login.scss
View File

@ -52,3 +52,23 @@ a#forgot-password-link {clear: left; float: left; }
}
}
}
.create-account {
.user-field.confirm {
margin-top: 10px;
margin-bottom: 10px;
}
.user-field {
margin-top: 10px;
label {
width: 85px;
}
input[type=text] {
margin-top: 0;
width: 184px;
}
.controls {
margin-left: 85px;
}
}
}

12
app/controllers/admin/user_fields_controller.rb
View File

@ -1,8 +1,10 @@
class Admin::UserFieldsController < Admin::AdminController
def create
field = UserField.create!(params.require(:user_field).permit(:name, :field_type, :editable))
render_serialized(field, UserFieldSerializer)
field = UserField.new(params.require(:user_field).permit(:name, :field_type, :editable, :description))
json_result(field, serializer: UserFieldSerializer) do
field.save
end
end
def index
@ -15,10 +17,12 @@ class Admin::UserFieldsController < Admin::AdminController
field = UserField.where(id: params.require(:id)).first
field.name = field_params[:name]
field.field_type = field_params[:field_type]
field.description = field_params[:description]
field.editable = field_params[:editable] == "true"
field.save!
render_serialized(field, UserFieldSerializer)
json_result(field, serializer: UserFieldSerializer) do
field.save
end
end
def destroy

1
app/controllers/users_controller.rb
View File

@ -51,6 +51,7 @@ class UsersController < ApplicationController
params[:custom_fields] ||= {}
UserField.where(editable: true).pluck(:id).each do |fid|
val = params[:user_fields][fid.to_s]
val = nil if val === "false"
return render_json_error(I18n.t("login.missing_user_field")) if val.blank?
params[:custom_fields]["user_field_#{fid}"] = val
end

1
app/models/site.rb
View File

@ -75,6 +75,7 @@ class Site
return {
periods: TopTopic.periods.map(&:to_s),
filters: Discourse.filters.map(&:to_s),
user_fields: UserField.all
}.to_json
end

3
app/models/user_field.rb
View File

@ -1,4 +1,3 @@
class UserField < ActiveRecord::Base
validates_presence_of :name, :field_type
validates_presence_of :name, :description, :field_type
end

2
app/models/user_field_serializer.rb
View File

@ -1,3 +1,3 @@
class UserFieldSerializer < ApplicationSerializer
attributes :id, :name, :field_type, :editable
attributes :id, :name, :description, :field_type, :editable
end

3
config/locales/client.en.yml
View File

@ -1999,11 +1999,12 @@ en:
user_fields:
title: "User Fields"
description: "Any fields added here will be required from users when they sign up."
help: "Any fields added here will be required from users when they sign up."
create: "Create User Field"
untitled: "Untitled"
name: "Field Name"
type: "Field Type"
description: "Field Description"
save: "Save"
edit: "Edit"
delete: "Delete"

7
db/migrate/20141002181613_add_description_to_user_fields.rb Normal file
View File

@ -0,0 +1,7 @@
class AddDescriptionToUserFields < ActiveRecord::Migration
def change
add_column :user_fields, :description, :string, null: true
execute "UPDATE user_fields SET description=name"
change_column :user_fields, :description, :string, null: false
end
end

4
spec/controllers/admin/user_fields_controller_spec.rb
View File

@ -12,7 +12,7 @@ describe Admin::UserFieldsController do
context '.create' do
it "creates a user field" do
-> {
xhr :post, :create, {user_field: {name: 'hello', field_type: 'text'} }
xhr :post, :create, {user_field: {name: 'hello', description: 'hello desc', field_type: 'text'} }
response.should be_success
}.should change(UserField, :count).by(1)
end
@ -44,7 +44,7 @@ describe Admin::UserFieldsController do
let!(:user_field) { Fabricate(:user_field) }
it "returns a list of user fields" do
xhr :put, :update, id: user_field.id, user_field: {name: 'fraggle', field_type: 'confirm'}
xhr :put, :update, id: user_field.id, user_field: {name: 'fraggle', field_type: 'confirm', description: 'muppet'}
response.should be_success
user_field.reload
user_field.name.should == 'fraggle'

1
spec/fabricators/user_field.rb
View File

@ -1,5 +1,6 @@
Fabricator(:user_field) do
name { sequence(:name) {|i| "field_#{i}" } }
description "user field description"
field_type 'text'
editable true
end