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

feature/property-description-builder #558

Open
wants to merge 2 commits into
base: development
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
57 changes: 57 additions & 0 deletions lib/concierge/property_description.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
module Concierge

# +Concierge::PropertyDescription+
#
# If property does not have description this class helps to build
# it from property attributes. If some of required attributes is missed empty string will be returned.
#
# Usage:
#
# PropertyDescription.new(property).build # => String
class PropertyDescription
attr_reader :property

def initialize(property)
@property = property
end

def build
result = ''
if valid?
result = "This is a charming #{property.type} in #{property.city}, which can accommodate "\
"#{pluralize(property.max_guests, 'guest', 'guests')}."

rooms_part_start = if property.surface
"The #{property.surface} square metres apartment"
else
"It"
end

result += "#{rooms_part_start} has #{pluralize(property.number_of_bedrooms, 'bedroom', 'bedrooms')} and "\
"#{pluralize(property.number_of_bathrooms, 'bathroom', 'bathrooms')}."
end

result
end

private

def valid?
property.type &&
property.city &&
property.max_guests.to_i > 0 &&
property.number_of_bedrooms.to_i > 0 &&
property.number_of_bathrooms.to_i > 0
end

def pluralize(n, singular, plural=nil)
if n == 1
"1 #{singular}"
elsif plural
"#{n} #{plural}"
else
"#{n} #{singular}s"
end
end
end
end
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ def build(property, details, availabilities, extras)
set_security_deposit!(roomorama_property, details)
set_cleaning_info!(roomorama_property, extras)

if roomorama_property.description.to_s.empty?
roomorama_property.description = description_builder(roomorama_property).build
end
Result.new(roomorama_property)
end

Expand Down Expand Up @@ -98,7 +101,7 @@ def set_security_deposit!(roomorama_property, details)
end

def build_descriptions(details)
[details.get('description.indoor'), details.get('description.outdoor')].compact.join("\n\n")
[details.get('description.indoor'), details.get('description.outdoor')].select { |d| !d.to_s.empty? }.join("\n\n")
end

def set_images!(result, details)
Expand Down Expand Up @@ -225,6 +228,10 @@ def calc_cleaning_extra_price(cleaning_extra)
price['value'] if price
end

def description_builder(property)
Concierge::PropertyDescription.new(property)
end

def to_stay(availability, mandatory_services)
Roomorama::Calendar::Stay.new(
{
Expand Down
70 changes: 70 additions & 0 deletions spec/lib/concierge/property_description_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
require "spec_helper"

RSpec.describe Concierge::PropertyDescription do

describe "#build" do
context 'when property does not have required fields' do
it "returns empty string if property does not have required fields" do
p = Roomorama::Property.new('15')

subject = described_class.new(p)
expect(subject.build).to eq ''
end

it "returns empty string if property does not have required fields" do
p = Roomorama::Property.load(
{
identifier: '15',
disabled: true, # to make property valid
type: 'apartment',
max_guests: 4,
number_of_bedrooms: 3,
number_of_bathrooms: 2
}
).value

subject = described_class.new(p)
expect(subject.build).to eq ''
end
end

context 'when property does not have surface' do
it "returns appropriate description" do
p = Roomorama::Property.load(
{
identifier: '15',
disabled: true, # to make property valid
type: 'apartment',
max_guests: 4,
city: 'Omsk',
number_of_bedrooms: 3,
number_of_bathrooms: 2
}
).value

subject = described_class.new(p)
expect(subject.build).to eq 'This is a charming apartment in Omsk, which can accommodate 4 guests.It has 3 bedrooms and 2 bathrooms.'
end
end

context 'when property has all required fields' do
it "returns appropriate description" do
p = Roomorama::Property.load(
{
identifier: '15',
disabled: true, # to make property valid
type: 'apartment',
max_guests: 4,
city: 'Omsk',
number_of_bedrooms: 3,
number_of_bathrooms: 2,
surface: 56
}
).value

subject = described_class.new(p)
expect(subject.build).to eq 'This is a charming apartment in Omsk, which can accommodate 4 guests.The 56 square metres apartment has 3 bedrooms and 2 bathrooms.'
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's add a space after . between two sentences for a better view

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed

end
end
end
end