Add full width option for Adaptive card

[msd117c]

No description provided.

[huNt-FMJ]

I'm not a fan of the parameter name. I see that full_width is mapped/converted here, so the main value is a string called full or default.
What I would like to see is either differentiating this new API from the API/params that are used by the MSTeams endpoint or lean more into what the MSTeam JSON values ought to be.

The parameter changed just slightly by adding the prefix full.
However, the word full is used by Microsoft, here, so you combined the key + (potential) value, but converted it into a bool.

So either you use something like:
use_full_width, use_max_width, stretch_card_to_max_width
i.e. something that makes it more obvious that this parameter accepts a bool and is more explanatory about what it does
or
you let the user assign a constant, which you pre-define as a module.

module MSTAdaptiveCardWidth
  DEFAULT = 'default'
  FULL = 'full'

  def self.all
    [DEFAULT, FULL]
  end
end

where width can be (as of now), default and full.

Suggested change

	def initialize(body:, actions: nil, entities: [], full_width: false)
	def initialize(body:, actions: nil, entities: [], width: DEFAULT)

Then you can do MSTAdaptiveCardWidth::DEFAULT, while potentially even omit the MSTAdaptiveCardWidth prefix, if you define the module in this very same file.

The advantage is of course that you can basically delete the method set_width(full_width:).
On top of that extending this class to support a new size would be trivial.

[huNt-FMJ]

If you keep this method you should be able to omit the variable:

Edit:
I see we want to support Ruby 2.7.1, so my suggestion is invalid.

[huNt-FMJ]

The prefix set appears to be less fitting for me, because this getter/setter convention is not ruby-ish, rather Java-ish

[huNt-FMJ]

Suggested change

	context "with full width" do
	context "with full width set to `true`" do

[huNt-FMJ]

Suggested change

	context "with not full width" do
	context "with full_width set to `false`" do

or

Suggested change

	context "with not full width" do
	context "with default width" do

[huNt-FMJ]

Suggested change

	it "renders the hash object with default width" do
	it "renders the hash object including a width entry showing `default`" do

or

Suggested change

	it "renders the hash object with default width" do
	it "renders the hash object including a default width" do

[huNt-FMJ]

Suggested change

	it "renders the hash object with full width" do
	it "renders the hash object including the width field set to `full`" do

[huNt-FMJ]

Your call

[huNt-FMJ]

does this work? To incorporate a "private" structure into this class such that any outside caller would still be able to
AdaptiveCard.new(body: xyz, with: default)?

[huNt-FMJ]

I'd encourage you to use a module to encapsulate said constants, instead of a hash.

https://stackoverflow.com/questions/75759/how-to-implement-enums-in-ruby

[huNt-FMJ]

In ruby, when you want to create a constant, ruby encourages to capitalize them.

[huNt-FMJ]

The idea is to also use a guard to protect against someone using a not accepted constant/string.

raise "You can only use constants defined in  <MSTAdaptiveCardWidth>" unless MSTAdaptiveCardWidth.all.include? width

[huNt-FMJ]

LGTM 🚀