Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate SHOW_PAGE_ATTRIBUTES as an explicit array #364

Merged
merged 1 commit into from
Jan 8, 2016
Merged

Conversation

c-lliope
Copy link
Contributor

Closes #130

Problem:

The dashboard generator specifies:

SHOW_PAGE_ATTRIBUTES = ATTRIBUTE_TYPES.keys

This means that the order of the show page attributes
is dependent on the order of keys in the ATTRIBUTE_TYPES hash.

Ruby hashes happen to be ordered,
but we shouldn't make an assumption that hashes are ordered
because that is not a property that hashes are designed to have.

Solution:

Because we assume that users will be editing SHOW_PAGE_ATTRIBUTES
to customize the contents and order of show page attributes,
we'll generate an explicit array for them to modify.

@zamith
Copy link

zamith commented Dec 22, 2015

My experience was that I ended up having to do this anyway, because I don't always want to show every attribute on the show page, plus this is much more explicit. 👍

@c-lliope
Copy link
Contributor Author

@mcmire, thoughts?

@mcmire
Copy link

mcmire commented Dec 23, 2015

Yup! That's exactly what I had in mind. 👍

Closes #130

Problem:

The dashboard generator specifies:

```ruby
SHOW_PAGE_ATTRIBUTES = ATTRIBUTE_TYPES.keys
```

This means that the order of the show page attributes
is dependent on the order of keys in the `ATTRIBUTE_TYPES` hash.

Ruby hashes happen to be ordered,
but we shouldn't make an assumption that hashes are ordered
because that is not a property that hashes are designed to have.

Solution:

Because we assume that users will be editing `SHOW_PAGE_ATTRIBUTES`
to customize the contents and order of show page attributes,
we'll generate an explicit array for them to modify.
@c-lliope c-lliope merged commit 05eb53b into master Jan 8, 2016
@c-lliope c-lliope deleted the gw-show-array branch January 8, 2016 05:59
c-lliope added a commit that referenced this pull request Jan 22, 2016
Changes:

```
* [#269] [FEATURE] Add a generator for copying default layout files
* [#328] [FEATURE] Add a generator for copying default sidebar partial
* [#362] [FEATURE] Add a generator for only the dashboard manifest.
  Customizing this manifest before running the `administrate:install` generator
  will change which dashboards get generated.
* [#295] [FEATURE] Add dashboard detection for ActiveRecord::Enum fields.
* [#364] [FEATURE] Improve dashboard generator by explicitly listing out the
  generated `SHOW_PAGE_ATTRIBUTES` array elements.
* [#416] [UI] Add an accessibility label to the search input
* [#411] [UI] Use tabular figures in table cells
* [#409] [UI] Use default system fonts
* [#424] [BUGFIX] Fix a bug where running `rails destroy GENERATOR_NAME`
  would not work for several of the generators
* [#390] [BUGFIX] Fix timestamp deprecation warnings
* [#365] [COMPAT] Remove dependency on `inline_svg`
* [#396] [I18n] Ukrainian
* [#297] [I18n] Italian
* [#307] [I18n] Fix German grammatical errors
* [#363] [DOC] Move documentation into main repository, at the root URL
* [#395] [DOC] Update inline documentation for collection partial
* [#387] [DOC] Fix incorrect path for generators in the docs
```
@c-lliope c-lliope mentioned this pull request Jan 22, 2016
c-lliope added a commit that referenced this pull request Jan 22, 2016
Changes:

```
* [#269] [FEATURE] Add a generator for copying default layout files
* [#328] [FEATURE] Add a generator for copying default sidebar partial
* [#362] [FEATURE] Add a generator for only the dashboard manifest.
  Customizing this manifest before running the `administrate:install` generator
  will change which dashboards get generated.
* [#295] [FEATURE] Add dashboard detection for ActiveRecord::Enum fields.
* [#364] [FEATURE] Improve dashboard generator by explicitly listing out the
  generated `SHOW_PAGE_ATTRIBUTES` array elements.
* [#416] [UI] Add an accessibility label to the search input
* [#411] [UI] Use tabular figures in table cells
* [#409] [UI] Use default system fonts
* [#424] [BUGFIX] Fix a bug where running `rails destroy GENERATOR_NAME`
  would not work for several of the generators
* [#390] [BUGFIX] Fix timestamp deprecation warnings
* [#365] [COMPAT] Remove dependency on `inline_svg`
* [#396] [I18n] Ukrainian
* [#297] [I18n] Italian
* [#307] [I18n] Fix German grammatical errors
* [#363] [DOC] Move documentation into main repository, at the root URL
* [#395] [DOC] Update inline documentation for collection partial
* [#387] [DOC] Fix incorrect path for generators in the docs
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants