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.

Sign up for GitHub

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

Add column names method #311

Merged
merged 10 commits into from
Aug 21, 2024
Merged

Add column names method #311

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2a3ee89
feat: Add column_names method from field_names
hatsu38 Jul 3, 2024
46c1fca
test: Add column_names test
hatsu38 Jul 3, 2024
0540d03
refactor: Optimize field name conversion by using Symbol#name
hatsu38 Jul 4, 2024
45adef8
docs: Add comment for rdoc
hatsu38 Jul 4, 2024
ac1e220
refactor: no need cache
hatsu38 Jul 6, 2024
2f6b35d
fix: Made it work with Ruby versions prior to 3.0
hatsu38 Jul 7, 2024
fa3feb6
Merge branch 'master' of ssh://github.com/hatsu38/active_hash into ad…
hatsu38 Jul 8, 2024
0306858
refactor: change to map(&:name)
hatsu38 Jul 8, 2024
034e9d2
test: Add column_names spec
hatsu38 Jul 8, 2024
9679a89
test: Add skip test if RUBY_VERSION < "3.0.0"
hatsu38 Jul 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions lib/active_hash/base.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,25 @@ def field_names
@field_names ||= []
end

#
# Useful for CSV integration needing column names as strings.
#
# @return [Array<String>] An array of column names as strings.
#
# @example Usage
# class Country < ActiveHash::Base
# fields :name, :code
# end
#
# Country.column_names
# # => ["id", "name", "code"]
#
def column_names
field_names.map do |field|
field.respond_to?(:name) ? field.name : field.to_s.freeze
end
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now field names are all symbols, so I think we can simplify this:

Suggested change
field_names.map do |field|
field.respond_to?(:name) ? field.name : field.to_s.freeze
end
fields.map(&:name)

Does that work for you?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After merging the latest master, the code worked perfectly! 0306858

end

def the_meta_class
class << self
self
Expand Down
10 changes: 10 additions & 0 deletions spec/active_yaml/aliases_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ class KeyProduct < ActiveYaml::Base
model.all
expect(model.field_names).to match_array [:name, :flavor, :price]
end

it 'excludes them from column_names' do
model.all
expect(model.column_names).to match_array ["name", "flavor", "price"]
end
end
end

Expand Down Expand Up @@ -70,6 +75,11 @@ class KeyProduct < ActiveYaml::Base
model.all
expect(model.field_names).to match_array [:name, :flavor, :price, :slogan, :key]
end

it 'excludes them from column_names' do
model.all
expect(model.column_names).to match_array ["name", "flavor", "price", "slogan", "key"]
end
end
end

Expand Down
Loading