hanami Minsk

Transcript

View Slide

English transcription
https://goo.gl/morJTT

View Slide

Hello Minsk!
❤

View Slide

Anton Davydov
github.com/davydovanton 
twitter.com/anton_davydov
davydovanton.com

View Slide

OpenSource

View Slide

Sidekiq
Hanami

View Slide

ruby-doc
rails
crystal
etc

View Slide

moscow.rb
rubyunderhood

View Slide

hanami (ᜰ憎)
Hanami (ᜰ憎, lit. "flower viewing") is the
Japanese traditional custom of enjoying
the transient beauty of flowers, flowers
("hana") in this case almost always
referring to those of the cherry ("sakura")
or, less frequently, plum ("ume") trees.

View Slide

Luca Guidi
github.com/jodosha

View Slide

Alfonso Uceda
github.com/AlfonsoUceda
Trung Lê
github.com/joneslee85

View Slide

The Base Ideas

View Slide

Modularity
Forget about fat models

View Slide

Simplicity
Framework is only tool

View Slide

Less DSLs
No magic

View Slide

Few Conventions
Come with us or against us

View Slide

Pure Objects
If you know ruby you know hanami

View Slide

Zero Monkey-Patching
Don’t think framework or language

View Slide

Threadsafe

View Slide

hanami != rails

View Slide

Typical parts of
web app

View Slide

Web App
Business 
logic
Data
ﬂow

View Slide

Application Architecture
Monolith First

View Slide

app/
ʮʒʒ application.rb
ʮʒʒ assets
ʔ ʦʒʒ ...
ʮʒʒ conﬁg
ʔ ʦʒʒ ...
ʮʒʒ controllers
ʔ ʦʒʒ ...
ʮʒʒ templates
ʔ ʦʒʒ ...
ʦʒʒ views
ʦʒʒ ...

View Slide

app/
ʮʒʒ assets
ʔ ʦʒʒ ...
ʮʒʒ conﬁg
ʔ ʦʒʒ ...
ʮʒʒ controllers
ʔ ʦʒʒ ...
ʮʒʒ templates
ʔ ʦʒʒ ...
ʦʒʒ views
ʦʒʒ ...

View Slide

app/
ʮʒʒ assets
ʔ ʦʒʒ ...
ʮʒʒ conﬁg
ʔ ʦʒʒ ...
ʮʒʒ controllers
ʔ ʦʒʒ ...
ʮʒʒ templates
ʔ ʦʒʒ ...
ʦʒʒ views
ʦʒʒ ...

View Slide

app/
ʮʒʒ assets
ʔ ʦʒʒ ...
ʮʒʒ conﬁg
ʔ ʦʒʒ ...
ʮʒʒ controllers
ʔ ʦʒʒ ...
ʮʒʒ templates
ʔ ʦʒʒ ...
ʦʒʒ views
ʦʒʒ ...

View Slide

Container Architecture
Clean Architecture

View Slide

apps/
ʮʒʒ admin
ʔ ʮʒʒ application.rb
ʔ ʮʒʒ assets
ʔ ʔ ʦʒʒ ...
ʔ ʮʒʒ conﬁg
ʔ ʔ ʦʒʒ ...
ʔ ʮʒʒ controllers
ʔ ʔ ʦʒʒ ...
ʔ ʮʒʒ templates
ʔ ʔ ʦʒʒ ...
ʔ ʦʒʒ views
ʔ ʦʒʒ ...
ʦʒʒ web
ʮʒʒ ...

View Slide

apps/
ʮʒʒ admin
ʔ ʮʒʒ assets
ʔ ʔ ʦʒʒ ...
ʔ ʮʒʒ conﬁg
ʔ ʔ ʦʒʒ ...
ʔ ʔ ʦʒʒ ...
ʔ ʮʒʒ templates
ʔ ʔ ʦʒʒ ...
ʔ ʦʒʒ views
ʔ ʦʒʒ ...
ʦʒʒ web
ʮʒʒ ...

View Slide

apps/
ʮʒʒ admin
ʔ ʮʒʒ assets
ʔ ʔ ʦʒʒ ...
ʔ ʮʒʒ conﬁg
ʔ ʔ ʦʒʒ ...
ʔ ʔ ʦʒʒ ...
ʔ ʮʒʒ templates
ʔ ʔ ʦʒʒ ...
ʔ ʦʒʒ views
ʔ ʦʒʒ ...
ʦʒʒ web
ʮʒʒ ...

View Slide

lib/
ʮʒʒ conﬁg
ʔ ʦʒʒ mapping.rb
ʮʒʒ project_name
ʔ ʮʒʒ entities
ʔ ʔ ʦʒʒ user.rb
ʔ ʮʒʒ mailers
ʔ ʔ ʦʒʒ templates
ʔ ʦʒʒ repositories
ʔ ʦʒʒ user_repository.rb
ʦʒʒ project_name.rb

View Slide

lib/
ʮʒʒ conﬁg
ʮʒʒ project_name
ʔ ʮʒʒ entities
ʔ ʮʒʒ mailers

View Slide

lib/
ʮʒʒ conﬁg
ʮʒʒ project_name
ʔ ʮʒʒ entities
ʔ ʮʒʒ mailers

View Slide

lib/
ʮʒʒ conﬁg
ʮʒʒ project_name
ʔ ʮʒʒ entities
ʔ ʮʒʒ mailers

View Slide

General Parts

View Slide

hanami - base repository, CLI
router - Rack compatible HTTP router for Ruby
controller - Full featured and fast actions for Rack
utils - Ruby core extensions and class utilities
model - Persistence with entities and repositories

View Slide

validations - Validations mixin for Ruby objects
helpers - View helpers for Ruby applications
view - Presentation with a separation between views and templates
assets - Assets management for Ruby
mailer - Mail for Ruby applications

View Slide

Differences

View Slide

– Linus Torvalds
“Talk is cheap. Show me the code.”

View Slide

# rack
class HelloApp
def call(env)
[200, {}, ['Hello!']]
end
end

View Slide

# hanami
class HelloApp
def call(env)
[200, {}, ['Hello!']]
end
end
router = Hanami::Router.new
router.get '/', to: 'hello_app'

View Slide

# sinatra
class Hello < Sinatra
get '/' do
'Hello!'
end
end

View Slide

# hanami
Hanami::Router.new do
get '/' do
[200, {}, ['Hello!']]
end
end

View Slide

class InstitutionsController < ApplicationController
load_and_authorize_resource :only => [:destroy,:edit,:new,:create,:update]
before_filter :authenticate_user!, :except =>
[:student_registration, :show, :validate_registration_pin, :result, :admission, :buy_registration_pin,:paygate_callback_fai
lure, :paygate_cancel, :paygate_pending, :paygate_callback_success, :pin_transaction_info_print]
before_filter :find_institution, :except =>
[:show,:index, :new, :create, :semesters_for_institute_type, :start_end_date_for_assessment_period, :courses_for_batch, :pa
ygate_callback_failure, :paygate_cancel, :paygate_pending, :paygate_callback_success, :pin_transaction_info_print]
before_filter :add_bread_crumb,:except => [:show]
def paygate_callback_success
@pay_gate_config = YAML::load(File.open("#{Rails.root}/config/pay_gate_config.yml"))[Rails.env]
@payment = TransactionRecord.find_by_order_number(params[:OrderID])
uri = URI("https://fidelitypaygate.fidelitybankplc.com/cipg/MerchantServices/UpayTransactionStatus.ashx")
parameters = {:MERCHANT_ID => "#{@pay_gate_config['merchant_id']}", :ORDER_ID => "#{@payment.order_number}"}
uri.query = URI.encode_www_form(parameters)
result =open(uri).read
result_hash = Hash.from_xml(result)
record_payment_details(result_hash)
if result_hash["CIPG"]["StatusCode"] == PaymentRecord::PAYMENT_SUCCESS_CODE
if @payment.transactionable_type.eql?("PaymentRecord")
redirect_to institution_fees_path(@payment.transactionable_type.fee.institution), :notice => "Payment transaction
has been #{result_hash['CIPG']['Status']}"
elsif @payment.transactionable_type.eql?("PinBuyerInfo")
unless @payment.transactionable.pin_id.present?
@registration = @payment.transactionable.registration
@valid_registration_pin_groups = @registration.valid_registration_pin_groups
@online_valid_registration_pin_groups = @valid_registration_pin_groups.where(:pin_available_type => 'Online')
@offline_valid_registration_pin_groups = @valid_registration_pin_groups.where(:pin_available_type => 'Offline')
@available_pin = nil
@online_valid_registration_pin_groups.each do |vpg|
if vpg.available_pins.present?
@available_pin = vpg.available_pins.first
break
else
next
end
end
if !@available_pin.present?
@offline_valid_registration_pin_groups.each do |vpg|
break
else
next

View Slide

class InstitutionsController < ApplicationController
load_and_authorize_resource :only => [:destroy,:edit,:new,:create,:update]
before_filter :authenticate_user!, :except =>
[:student_registration, :show, :validate_registration_pin, :result, :admission, :buy_registration_pin,:paygate_callback_fai
lure, :paygate_cancel, :paygate_pending, :paygate_callback_success, :pin_transaction_info_print]
before_filter :find_institution, :except =>
[:show,:index, :new, :create, :semesters_for_institute_type, :start_end_date_for_assessment_period, :courses_for_batch, :pa
ygate_callback_failure, :paygate_cancel, :paygate_pending, :paygate_callback_success, :pin_transaction_info_print]
before_filter :add_bread_crumb,:except => [:show]
def paygate_callback_success
@pay_gate_config = YAML::load(File.open("#{Rails.root}/config/pay_gate_config.yml"))[Rails.env]
@payment = TransactionRecord.find_by_order_number(params[:OrderID])
uri = URI("https://fidelitypaygate.fidelitybankplc.com/cipg/MerchantServices/UpayTransactionStatus.ashx")
parameters = {:MERCHANT_ID => "#{@pay_gate_config['merchant_id']}", :ORDER_ID => "#{@payment.order_number}"}
uri.query = URI.encode_www_form(parameters)
result =open(uri).read
result_hash = Hash.from_xml(result)
record_payment_details(result_hash)
if result_hash["CIPG"]["StatusCode"] == PaymentRecord::PAYMENT_SUCCESS_CODE
if @payment.transactionable_type.eql?("PaymentRecord")
redirect_to institution_fees_path(@payment.transactionable_type.fee.institution), :notice => "Payment transaction
has been #{result_hash['CIPG']['Status']}"
elsif @payment.transactionable_type.eql?("PinBuyerInfo")
unless @payment.transactionable.pin_id.present?
@registration = @payment.transactionable.registration
@valid_registration_pin_groups = @registration.valid_registration_pin_groups
@online_valid_registration_pin_groups = @valid_registration_pin_groups.where(:pin_available_type => 'Online')
@offline_valid_registration_pin_groups = @valid_registration_pin_groups.where(:pin_available_type => 'Offline')
@available_pin = nil
@online_valid_registration_pin_groups.each do |vpg|
break
else
next
end
end
if !@available_pin.present?
@offline_valid_registration_pin_groups.each do |vpg|
break
else
next

Rails and Hanami

Rails and Hanami

Controllers

Controllers: Rails
class UsersController < AC
def new
end
def send_sms
end
end

View Slide

class Cats::CruelsController < AC
def index
end
def show
end
end
Controllers: DHH style

View Slide

module Web::Controllers::Board
class Index
include Web::Action
def call(params)
end
end
end
Controllers: hanami

View Slide

Model

View Slide

class User < ActiveRecord::Base
validates :name, presence: true
# ...
end
Model: Rails

View Slide

Model: ROM

View Slide

Model: hanami entity
class User
include Hanami::Entity
attributes :name
# ...
end

View Slide

Model: hanami repository
class UserRepository
include Hanami::Repository
def find_by_name(name)
query do
# ...
end
end
end

View Slide

Utils

View Slide

# rails
class String
def pluralize
# ...
end
end
# hanami
module Hanami
module Utils
class String
def pluralize
# ...
end
end
end
end
Utils

View Slide

View

View Slide

View: Rails
rails view (partials?) + rails helper

View Slide

View: Hanami
hanami view (ruby class) + partial

Assets

Pros and Cons

No magic

Controller test
describe Web::Controllers::Board::Index do
let(:action){ Board::Index.new }
let(:params){ Hash[] }
it 'is successful' do
response = action.call(params)
response[0].must_equal 200
end
end

View Slide

Controller test
end
end

View Slide

Controller test
end
end

No monkey-patching

Best practices

Modularity

The logic separation