viewing ruby blossom rdrc2017

Transcript

View Slide

❤
 
Hello reddotrubyconf!
 
❤

View Slide

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

View Slide

OpenSource

View Slide

Hanami core

View Slide

ruby
rom-rb
dry-rb
rails
crystal
etc

View Slide

moscow.rb

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

General Ideas

View Slide

Modularity
Forget about fat models

View Slide

Simplicity and Lightweight
Framework is only tool

View Slide

Architecturally Sound
Isolation everywhere

View Slide

Pure Objects
If you know ruby you know hanami

View Slide

Zero Monkey-Patching
Don’t think framework or language

railshurts.com/quiz

railshurts.com/quiz

Threadsafe

hanami != rails

Typical parts
of any web project

View Slide

Web Project
Business 
logic
Data
ﬂow

View Slide

Data ﬂow

View Slide

Container Architecture
Clean Architecture

View Slide

apps/
├── admin
│ ├── application.rb
│ ├── assets
│ │ └── ...
│ ├── conﬁg
│ │ └── ...
│ ├── controllers
│ │ └── ...
│ ├── templates
│ │ └── ...
│ └── views
│ └── ...
└── web
├── ...

View Slide

apps/
├── admin
│ │ └── ...
│ │ └── ...
│ │ └── ...
│ │ └── ...
│ └── views
│ └── ...
└── web
├── ...

View Slide

apps/
├── admin
│ │ └── ...
│ │ └── ...
│ │ └── ...
│ │ └── ...
│ └── views
│ └── ...
└── web
├── ...

View Slide

App App App
lib
App App App
lib
App App App
lib
request

View Slide

App App App
lib
App App
lib
App App App
lib
request
App

View Slide

Business Logic

View Slide

lib/
├── project_name
│ ├── interactors
│ │ └── create_user.rb
│ ├── entities
│ │ └── user.rb
│ ├── mailers
│ │ └── templates
│ └── repositories
│ └── user_repository.rb
└── project_name.rb

lib/

lib/

lib/

Gems

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
assets - Assets management for Ruby
mailer - Mail for Ruby applications

View Slide

Differences

View Slide

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

View Slide

# hanami-router
class HelloApp
def call(env)
[200, { **env }, ['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, { **env }, ['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_failure, :p
aygate_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, :paygate_ca
llback_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
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_failure, :p
aygate_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, :paygate_ca
llback_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
end
end

View Slide

Rails and Hanami

View Slide

Controllers

View Slide

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

View Slide

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

View Slide

Controllers: hanami action
module Web::Controllers::Board
class Index
include Web::Action
params do
required(:email).filled
end
def call(params)
end
end
end

View Slide

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

View Slide

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

View Slide

Model

View Slide

class User < ActiveRecord::Base 
include Gravtastic
before_destroy :yank_gems
has_many :rubygems, through: :ownerships
validates :name, presence: true
# ...
end
Model: Rails

View Slide

include Gravtastic
# ...
end
Model: Rails

View Slide

include Gravtastic
# ...
end
Model: Rails

View Slide

include Gravtastic
# ...
end
Model: Rails

View Slide

include Gravtastic
# ...
end
Model: Rails

View Slide

Model: hanami
hanami + ROM = ❤

View Slide

Model: hanami entity
class User < Hanami::Entity
# ...
end

View Slide

>> user = User.new(id: 1)
=> #1}>
>> user.id
=> 1
>> user.id = 1
NoMethodError: undefined method `id=' for
#1}>
Did you mean? id

View Slide

>> user = User.new(id: 1)
=> #1}>
>> user.id
=> 1
>> user.id = 1
NoMethodError: undefined method `id=' for
#1}>
Did you mean? id

View Slide

class UserRepository < Hanami::Repository
associations do
has_many :books
end
def find_by_name(name)
users # => ROM relation
users.where(name: name).limit(1).one
end
end
Model: hanami repository

View Slide

>> repo = UserRepository.new
=> #
>> repo.find(1)
=> #
Model: hanami repository

View Slide

View

View Slide

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

View Slide

View: Hanami
hanami view (ruby class)
+
templates

Assets

Pros and Cons

No magic

class Index
include Web::Action
def call(params)
end
end
end

View Slide

Action 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

Action test
end
end

Action test
end
end

No monkey-patching

Best practices

Dependency Injection

The logic separation