Slide 1

Slide 1 text

OPENSTRUCT BUILDING A BETTER ARIEL CAPLAN

Slide 2

Slide 2 text

OPENSTRUCT LET’S TALK ABOUT

Slide 3

Slide 3 text

OPENSTRUCT IS RUBY’S JAVASCRIPT OBJECT require 'ostruct' open_struct = OpenStruct.new(foo: :bar) open_struct.baz = 4 open_struct[:something] = 'whatever'

Slide 4

Slide 4 text

OPENSTRUCT IS RUBY’S JAVASCRIPT OBJECT require 'ostruct' open_struct = OpenStruct.new(foo: :bar) open_struct.baz = 4 open_struct[:something] = 'whatever' open_struct[:foo] => :bar open_struct["baz"] => 4 open_struct[:quux] => nil open_struct.foo => :bar open_struct.baz => 4 open_struct.quux => nil

Slide 5

Slide 5 text

WHY USE OPENSTRUCT? 3 common use cases for OpenStruct (Erik Michaels-Ober's list): • Consume an API • Configuration object • Simple test double

Slide 6

Slide 6 text

CONSUME AN API hash = JSON.parse(APICall.execute) results = OpenStruct.new(hash) class APICall < OpenStruct def self.execute response = Net::HTTP.get(URI('domain.com/endpoint')) new(JSON.parse(response)) end end results = APICall.execute SIMPLE STRATEGY: PASS RESPONSE INTO AN OPENSTRUCT ADVANCED STRATEGY: SUBCLASS OPENSTRUCT

Slide 7

Slide 7 text

CONSUME AN API { "thing": [1, 2, 3], "other_thing": "hello" } If the API response is… results.thing => [1, 2, 3] You can write this instead! Instead of… results['thing'] => [1, 2, 3]

Slide 8

Slide 8 text

CONSUME AN API You can also define your own methods! class User < OpenStruct def name "#{first_name} #{last_name}" end end api_call = JSON.parse(API.get('/users/1')) # => {"first_name"=>"Ariel","last_name"=>"Caplan"} User.new(api_call).name # => "Ariel Caplan"

Slide 9

Slide 9 text

CONFIGURATION OBJECT class MyGem def self.configure yield configuration end def self.configuration @configuration ||= OpenStruct.new end end MyGem.configure do |configuration| configuration.setting = true end

Slide 10

Slide 10 text

TEST DOUBLE class Order def initialize(payment_gateway, products) @payment_gateway = payment_gateway @products = products end def pay payment_gateway.total = total_cost payment_gateway.charge end def total_cost # sum up the products end end

Slide 11

Slide 11 text

TEST DOUBLE class Order def initialize(payment_gateway, products) @payment_gateway = payment_gateway @products = products end def pay payment_gateway.total = total_cost payment_gateway.charge end def total_cost # sum up the products end end Expensive to test!

Slide 12

Slide 12 text

TEST DOUBLE # Stub out methods payment_gateway = OpenStruct.new(charge: :PAID) # Run the test payment_result = Order.new(payment_gateway, products).pay # Assert a value is returned assert_equal payment_result, :PAID # Assert a value is set on the OpenStruct assert_equal payment_gateway.total, total_cost(products)

Slide 13

Slide 13 text

HOW DOES IT WORK?

Slide 14

Slide 14 text

WARNING! CODE HAS BEEN BRUTALLY EDITED

Slide 15

Slide 15 text

HOW DOES IT WORK? • Under the hood, OpenStruct defines attribute setter/getter methods on the object’s singleton class.

Slide 16

Slide 16 text

HOW DOES IT WORK? • Under the hood, OpenStruct defines attribute setter/getter methods on the object’s singleton class. foo = Object.new def foo.bar "hello from bar" end foo.bar => "hello from bar" foo.singleton_methods => [:bar]

Slide 17

Slide 17 text

HOW DOES IT WORK? • Under the hood, OpenStruct defines attribute setter/getter methods on the object’s singleton class. OpenStruct.new(foo: :bar)

Slide 18

Slide 18 text

HOW DOES IT WORK? • Under the hood, OpenStruct defines attribute setter/getter methods on the object’s singleton class. def initialize(hash=nil) @table = {} if hash hash.each_pair do |k, v| k = k.to_sym @table[k] = v new_ostruct_member(k) end end end OpenStruct.new(foo: :bar)

Slide 19

Slide 19 text

HOW DOES IT WORK? • Under the hood, OpenStruct defines attribute setter/getter methods on the object’s singleton class. def initialize(hash=nil) @table = {} if hash hash.each_pair do |k, v| k = k.to_sym @table[k] = v new_ostruct_member(k) end end end OpenStruct.new(foo: :bar) open_struct.baz = 4

Slide 20

Slide 20 text

HOW DOES IT WORK? • Under the hood, OpenStruct defines attribute setter/getter methods on the object’s singleton class. def initialize(hash=nil) @table = {} if hash hash.each_pair do |k, v| k = k.to_sym @table[k] = v new_ostruct_member(k) end end end OpenStruct.new(foo: :bar) open_struct.baz = 4 open_struct.send(:baz=, 4)

Slide 21

Slide 21 text

HOW DOES IT WORK? • Under the hood, OpenStruct defines attribute setter/getter methods on the object’s singleton class. def initialize(hash=nil) @table = {} if hash hash.each_pair do |k, v| k = k.to_sym @table[k] = v new_ostruct_member(k) end end end def method_missing(mid, *args) mname = mid.id2name if mname.chomp!('=') @table[new_ostruct_member(mname)] = args[0] else @table[mid] end end OpenStruct.new(foo: :bar) open_struct.baz = 4 open_struct.send(:baz=, 4)

Slide 22

Slide 22 text

HOW DOES IT WORK? • Under the hood, OpenStruct defines attribute setter/getter methods on the object’s singleton class. def initialize(hash=nil) @table = {} if hash hash.each_pair do |k, v| k = k.to_sym @table[k] = v new_ostruct_member(k) end end end def method_missing(mid, *args) mname = mid.id2name if mname.chomp!('=') @table[new_ostruct_member(mname)] = args[0] else @table[mid] end end OpenStruct.new(foo: :bar) open_struct.baz = 4 open_struct.send(:baz=, 4)

Slide 23

Slide 23 text

HOW DOES IT WORK? • Under the hood, OpenStruct defines attribute setter/getter methods on the object’s singleton class. def initialize(hash=nil) @table = {} if hash hash.each_pair do |k, v| k = k.to_sym @table[k] = v new_ostruct_member(k) end end end def method_missing(mid, *args) mname = mid.id2name if mname.chomp!('=') @table[new_ostruct_member(mname)] = args[0] else @table[mid] end end OpenStruct.new(foo: :bar) open_struct.baz = 4 open_struct.baz open_struct.send(:baz=, 4)

Slide 24

Slide 24 text

HOW DOES IT WORK? • Under the hood, OpenStruct defines attribute setter/getter methods on the object’s singleton class. def new_ostruct_member(name) name = name.to_sym unless respond_to?(name) define_singleton_method(name) { @table[name] } define_singleton_method("#{name}=") { |x| @table[name] = x } end name end

Slide 25

Slide 25 text

HOW DOES IT WORK? • Under the hood, OpenStruct defines attribute setter/getter methods on the object’s singleton class. def new_ostruct_member(name) name = name.to_sym unless respond_to?(name) define_singleton_method(name) { @table[name] } define_singleton_method("#{name}=") { |x| @table[name] = x } end name end This is the singleton class version of: attr_reader :foo attr_writer :foo but it uses the internal @table, not instance variables!

Slide 26

Slide 26 text

• No 2 OpenStructs share a set of methods • The methods must be defined each time! • Under the hood, OpenStruct defines attribute setter/getter methods on the object’s singleton class. HOW DOES IT WORK?

Slide 27

Slide 27 text

• Q: How slow is OpenStruct? • A: OPENSTRUCT IS SLOW !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! • Translation: 10-40x slower than an explicitly defined class • Q: Why is OpenStruct slow? • Defining methods is slow • method_missing is slow • In < 2.1, reset the global method cache, no longer a problem

Slide 28

Slide 28 text

METHOD LOOKUP IN RUBY DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL

Slide 29

Slide 29 text

METHOD LOOKUP IN RUBY cat = Cat.new cat.to_s DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL

Slide 30

Slide 30 text

METHOD LOOKUP IN RUBY cat = Cat.new cat.to_s DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL #TO_S Method Location Cat#to_s Kernel GLOBAL METHOD CACHE

Slide 31

Slide 31 text

class Cat def to_s "I'm a cat!" end end METHOD LOOKUP IN RUBY DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL Method Location Cat#to_s Kernel GLOBAL METHOD CACHE

Slide 32

Slide 32 text

class Cat def to_s "I'm a cat!" end end METHOD LOOKUP IN RUBY DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL Method Location Cat#to_s Kernel GLOBAL METHOD CACHE

Slide 33

Slide 33 text

METHOD LOOKUP IN RUBY DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL Method Location Cat#to_s Kernel GLOBAL METHOD CACHE

Slide 34

Slide 34 text

METHOD LOOKUP IN RUBY DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL OpenStruct.new(foo: :bar) Method Location Cat#to_s Kernel GLOBAL METHOD CACHE

Slide 35

Slide 35 text

METHOD LOOKUP IN RUBY DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL OpenStruct.new(foo: :bar) Method Location Cat#to_s Kernel GLOBAL METHOD CACHE

Slide 36

Slide 36 text

METHOD LOOKUP IN RUBY DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL OpenStruct.new(foo: :bar) Method Location Cat#to_s Kernel GLOBAL METHOD CACHE Looking up methods can be really expensive!

Slide 37

Slide 37 text

METHOD LOOKUP IN RUBY Cat.ancestors => [Cat (call 'Cat.connection' to establish a connection), Cat::GeneratedAssociationMethods, #<#: 0x007fd72c534e58>, ApplicationRecord(abstract), ApplicationRecord::GeneratedAssoc
 iationMethods, #<#: 0x007fd72c6e5ae0>, ActiveRecord::Base, GlobalID::Identification, ActiveRecord::Suppressor, ActiveRecord::SecureToken, ActiveRecord::Store, ActiveRecord::Serialization, ActiveModel::Serializers::JSON, ActiveModel::Serialization, ActiveRecord::Reflection, ActiveRecord::TouchLater, ActiveRecord::NoTouching, ActiveRecord::Transactions, ActiveRecord::Aggregations, ActiveRecord::NestedAttributes, ActiveRecord::AutosaveAssociation, ActiveModel::SecurePassword, ActiveRecord::Associations, ActiveRecord::Timestamp, ActiveModel::Validations::Callbacks, ActiveRecord::Callbacks, ActiveRecord::AttributeMethods::Serializ ation, ActiveRecord::AttributeMethods::Dirty, ActiveModel::Dirty, ActiveRecord::AttributeMethods::TimeZone Conversion, ActiveRecord::AttributeMethods::Primary
 Key, ActiveRecord::AttributeMethods::Query, ActiveRecord::AttributeMethods::Before
 TypeCast, ActiveRecord::AttributeMethods::Write, ActiveRecord::AttributeMethods::Read, ActiveRecord::Base::GeneratedAssociation Methods, #<#: 0x007fd72d296f60>, ActiveRecord::AttributeMethods, ActiveModel::AttributeMethods, ActiveRecord::Locking::Pessimistic, ActiveRecord::Locking::Optimistic, ActiveRecord::AttributeDecorators, ActiveRecord::Attributes, ActiveRecord::CounterCache, ActiveRecord::Validations, ActiveModel::Validations::HelperMethods, ActiveSupport::Callbacks, ActiveModel::Validations, ActiveRecord::Integration, ActiveModel::Conversion, ActiveRecord::AttributeAssignment, ActiveModel::AttributeAssignment, ActiveModel::ForbiddenAttributesPro
 tection, ActiveRecord::Sanitization, ActiveRecord::Scoping::Named, ActiveRecord::Scoping::Default, ActiveRecord::Scoping, ActiveRecord::Inheritance, ActiveRecord::ModelSchema, ActiveRecord::ReadonlyAttributes, ActiveRecord::Persistence, ActiveRecord::Core, ActiveSupport::ToJsonWithActiveSup
 portEncoder, Object, ActiveSupport::Dependencies::Load
 able, PP::ObjectMixin, JSON::Ext::Generator::Generator
 Methods::Object, ActiveSupport::Tryable, Kernel, BasicObject]

Slide 38

Slide 38 text

METHOD LOOKUP IN RUBY • James Golick found that 10% of Rails CPU time was rebuilding the method cache… • So he implemented a better solution: A hierarchical method cache! • It was included in Ruby 2.1

Slide 39

Slide 39 text

Method Location #to_s Kernel ANIMAL METHOD CACHE HIERARCHICAL METHOD CACHE DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL Method Location #to_s Kernel CAT METHOD CACHE

Slide 40

Slide 40 text

Method Location #to_s Kernel ANIMAL METHOD CACHE HIERARCHICAL METHOD CACHE DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL Method Location #to_s Kernel CAT METHOD CACHE

Slide 41

Slide 41 text

Method Location #to_s Kernel ANIMAL METHOD CACHE HIERARCHICAL METHOD CACHE DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL Method Location #to_s Kernel CAT METHOD CACHE

Slide 42

Slide 42 text

HIERARCHICAL METHOD CACHE DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL Method Location #to_s Kernel CAT METHOD CACHE Method Location #to_s Kernel DOG METHOD CACHE

Slide 43

Slide 43 text

HIERARCHICAL METHOD CACHE DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL Method Location #to_s Kernel CAT METHOD CACHE Method Location #to_s Kernel DOG METHOD CACHE

Slide 44

Slide 44 text

HIERARCHICAL METHOD CACHE DOG OBJECT ANIMAL BASIC
 OBJECT MEOWABLE CAT KERNEL Method Location #to_s Kernel CAT METHOD CACHE Method Location #to_s Kernel DOG METHOD CACHE "

Slide 45

Slide 45 text

http://jamesgolick.com/2013/4/14/
 mris-method-caches.html

Slide 46

Slide 46 text

IN RUBY >= 2.1, WE CAN CREATE OPENSTRUCTS WITHOUT SLOWING DOWN THE REST OF OUR APPLICATION!

Slide 47

Slide 47 text

BUT OPENSTRUCT ITSELF IS STILL SLOW… #

Slide 48

Slide 48 text

HI EVERYONE! MY NAME IS ARIEL CAPLAN. YOU CAN FIND ME ONLINE AT @AMCAPLAN AND AMCAPLAN.NINJA

Slide 49

Slide 49 text

I WORK FOR WE PAY PEOPLE TO USE HIGH-QUALITY, LOW-COST HEALTHCARE.

Slide 50

Slide 50 text

WE USE A SYSTEM OF MICROSERVICES AND EXTERNAL APIS COMMUNICATING VIA JSON PARSED INTO RUBY HASHES FED INTO OPENSTRUCTS

Slide 51

Slide 51 text

PROFILING
 INDICATED THAT OPENSTRUCT WAS A MAJOR CULPRIT

Slide 52

Slide 52 text

In our app: gem 'stackprof' StackProf.run(mode: :cpu, out: 'tmp/stackprof-cpu-myapp.dump') do # The block we wanted to test end Then, in the terminal: $ stackprof tmp/stackprof-cpu-myapp.dump --text

Slide 53

Slide 53 text

================================== Mode: cpu(1000) Samples: 2020 (3.72% miss rate) GC: 413 (20.45%) ================================== TOTAL (pct) SAMPLES (pct) FRAME 264 (13.1%) 264 (13.1%) OpenStruct#new_ostruct_member 158 (7.8%) 158 (7.8%) Nokogiri::XML::Document#decorate 62 (3.1%) 62 (3.1%) Nokogiri::XML::Node#content= 52 (2.6%) 51 (2.5%) Nokogiri::XML::Node#write_to 48 (2.4%) 48 (2.4%) Nokogiri::XML::Node#[]= 62 (3.1%) 48 (2.4%) RSolr::Xml::Document#add_field 47 (2.3%) 47 (2.3%) Time.zone_offset 45 (2.2%) 45 (2.2%) block in OpenStruct#new_ostruct_member 43 (2.1%) 43 (2.1%) block in Sunspot::Setup#get_inheritable_hash 41 (2.0%) 41 (2.0%) OpenStruct#method_missing

Slide 54

Slide 54 text

================================== Mode: cpu(1000) Samples: 2020 (3.72% miss rate) GC: 413 (20.45%) ================================== TOTAL (pct) SAMPLES (pct) FRAME 264 (13.1%) 264 (13.1%) OpenStruct#new_ostruct_member 158 (7.8%) 158 (7.8%) Nokogiri::XML::Document#decorate 62 (3.1%) 62 (3.1%) Nokogiri::XML::Node#content= 52 (2.6%) 51 (2.5%) Nokogiri::XML::Node#write_to 48 (2.4%) 48 (2.4%) Nokogiri::XML::Node#[]= 62 (3.1%) 48 (2.4%) RSolr::Xml::Document#add_field 47 (2.3%) 47 (2.3%) Time.zone_offset 45 (2.2%) 45 (2.2%) block in OpenStruct#new_ostruct_member 43 (2.1%) 43 (2.1%) block in Sunspot::Setup#get_inheritable_hash 41 (2.0%) 41 (2.0%) OpenStruct#method_missing

Slide 55

Slide 55 text

CONGRATULATIONS, NOW YOU KNOW HOW TO PROFILE!

Slide 56

Slide 56 text

WE WANTED TO KEEP OPENSTRUCT BECAUSE IT GAVE US FLEXIBILITY

Slide 57

Slide 57 text

CAN WE BUILD A BETTER OPENSTRUCT?

Slide 58

Slide 58 text

NO. #

Slide 59

Slide 59 text

THANK YOU! ARIEL CAPLAN @AMCAPLAN

Slide 60

Slide 60 text

No content

Slide 61

Slide 61 text

YES.

Slide 62

Slide 62 text

4 (MORE) STORIES

Slide 63

Slide 63 text

ROUND 1: OpenFastStruct

Slide 64

Slide 64 text

” “ — Ruby Weekly, March 26, 2015

Slide 65

Slide 65 text

” “ — https://github.com/arturoherrero/ofstruct

Slide 66

Slide 66 text

— https://github.com/arturoherrero/ofstruct/blob/master/lib/ofstruct.rb OpenFastStruct.new(baz: 4)

Slide 67

Slide 67 text

— https://github.com/arturoherrero/ofstruct/blob/master/lib/ofstruct.rb def initialize(args = {}) @members = {} update(args) end OpenFastStruct.new(baz: 4)

Slide 68

Slide 68 text

def update(args) args.each { |k, v| assign(k, v) } end — https://github.com/arturoherrero/ofstruct/blob/master/lib/ofstruct.rb def initialize(args = {}) @members = {} update(args) end OpenFastStruct.new(baz: 4)

Slide 69

Slide 69 text

def assign(key, value) @members[key.to_sym] = value end def update(args) args.each { |k, v| assign(k, v) } end — https://github.com/arturoherrero/ofstruct/blob/master/lib/ofstruct.rb def initialize(args = {}) @members = {} update(args) end OpenFastStruct.new(baz: 4)

Slide 70

Slide 70 text

def assign(key, value) @members[key.to_sym] = value end def update(args) args.each { |k, v| assign(k, v) } end — https://github.com/arturoherrero/ofstruct/blob/master/lib/ofstruct.rb def initialize(args = {}) @members = {} update(args) end def method_missing(name, *args) @members.fetch(name) do if name[-1] == "=" assign(name[0..-2], args.first) else assign(key, self.class.new) end end end OpenFastStruct.new(baz: 4)

Slide 71

Slide 71 text

def assign(key, value) @members[key.to_sym] = value end def update(args) args.each { |k, v| assign(k, v) } end — https://github.com/arturoherrero/ofstruct/blob/master/lib/ofstruct.rb def initialize(args = {}) @members = {} update(args) end def method_missing(name, *args) @members.fetch(name) do if name[-1] == "=" assign(name[0..-2], args.first) else assign(key, self.class.new) end end end open_fast_struct.baz # baz exists OpenFastStruct.new(baz: 4)

Slide 72

Slide 72 text

def assign(key, value) @members[key.to_sym] = value end def update(args) args.each { |k, v| assign(k, v) } end — https://github.com/arturoherrero/ofstruct/blob/master/lib/ofstruct.rb def initialize(args = {}) @members = {} update(args) end def method_missing(name, *args) @members.fetch(name) do if name[-1] == "=" assign(name[0..-2], args.first) else assign(key, self.class.new) end end end open_fast_struct.baz = 4 open_fast_struct.baz # baz exists OpenFastStruct.new(baz: 4)

Slide 73

Slide 73 text

def assign(key, value) @members[key.to_sym] = value end def update(args) args.each { |k, v| assign(k, v) } end — https://github.com/arturoherrero/ofstruct/blob/master/lib/ofstruct.rb def initialize(args = {}) @members = {} update(args) end def method_missing(name, *args) @members.fetch(name) do if name[-1] == "=" assign(name[0..-2], args.first) else assign(key, self.class.new) end end end open_fast_struct.baz = 4 open_fast_struct.baz # baz does not exist open_fast_struct.baz # baz exists OpenFastStruct.new(baz: 4)

Slide 74

Slide 74 text

OPENFASTSTRUCT DOESN’T PAY THE UPFRONT COST OF DEFINING METHODS

Slide 75

Slide 75 text

OPENFASTSTRUCT IS GOOD WHEN PROPERTIES ARE NOT ACCESSED REPEATEDLY

Slide 76

Slide 76 text

OPENFASTSTRUCT DOESN’T WORK IN OUR APP DUE TO DIFFERENT BEHAVIOR

Slide 77

Slide 77 text

” “ — https://github.com/arturoherrero/ofstruct

Slide 78

Slide 78 text

” “ — https://github.com/arturoherrero/ofstruct

Slide 79

Slide 79 text

OpenStruct.new.foo => nil OpenFastStruct.new.foo => #

Slide 80

Slide 80 text

OpenStruct.new.foo => nil OpenFastStruct.new.foo => # if open_struct_response.foo “ falsey “ truthy if open_fast_struct_response.foo

Slide 81

Slide 81 text

A DROP-IN REPLACEMENT SHOULD BE A DROP-IN REPLACEMENT

Slide 82

Slide 82 text

CAN WE DO BETTER?

Slide 83

Slide 83 text

ROUND 2: PersistentOpenStruct

Slide 84

Slide 84 text

SAMPLE USAGE PersistentOpenStruct class Animal < PersistentOpenStruct def speak "The #{type} makes a #{sound} sound!" end end dog = Animal.new(type: 'dog', sound: 'woof') # => # dog.speak # => "The dog makes a woof sound!" dog.ears = 'droopy' dog[:nose] = ['cold', 'wet'] dog['tail'] = 'waggable' dog # => # Animal.instance_methods(false) # => [:speak, :type=, :type, :sound=, :sound, :ears=, :ears,
 :nose=, :nose, :tail=, :tail]

Slide 85

Slide 85 text

HOW IT WORKS PersistentOpenStruct def new_ostruct_member(name) name = name.to_sym unless respond_to?(name) self.class.send(:define_method, name) { @table[name] } self.class.send(:define_method, "#{name}=") { |x| @table[name] = x } end name end def new_ostruct_member(name) name = name.to_sym unless respond_to?(name) define_singleton_method(name) { @table[name] } define_singleton_method("#{name}=") { |x| @table[name] = x } end name end OpenStruct PersistentOpenStruct def new_ostruct_member(name) name = name.to_sym unless respond_to?(name) define_singleton_method(name) { @table[name] } define_singleton_method("#{name}=") { |x| @table[name] = x } end name end def new_ostruct_member(name) name = name.to_sym unless respond_to?(name) self.class.send(:define_method, name) { @table[name] } self.class.send(:define_method, "#{name}=") { |x| @table[name] = x } end name end

Slide 86

Slide 86 text

THIS IS A TERRIBLE HACK. IT MAY HAVE SECURITY IMPLICATIONS. AND IT MADE OUR APP 10% FASTER.

Slide 87

Slide 87 text

Comparison: RegularClass: 3673779.6 i/s PersistentOpenStruct: 764359.4 i/s - 4.81x slower OpenFastStruct: 546808.8 i/s - 6.72x slower OpenStruct: 155130.1 i/s - 23.68x slower

Slide 88

Slide 88 text

WHERE’S THE MATH?

Slide 89

Slide 89 text

THE INFORMATION YOU CRAVE • Let n = number of methods to define • Let o = objects to create • Using PersistentOpenStruct: O(n) • Using OpenStruct: O(no) USING THE NOTATION YOU LOVE!

Slide 90

Slide 90 text

MATH PROVIDES A USEFUL FRAMEWORK FOR THINKING ABOUT PROBLEMS. AS ENGINEERS, WE NEED ANSWERS GROUNDED IN REALITY.

Slide 91

Slide 91 text

BENCHMARK YOUR LIBRARY BENCHMARK YOUR APP BENCHMARK ALL THE THINGS!

Slide 92

Slide 92 text

HOW DO I BENCHMARK?

Slide 93

Slide 93 text

$ gem install benchmark-ips Then, in a Ruby program: require ‘benchmark/ips' Benchmark.ips do |x| x.report('old code') do #run old code end x.report('new code') do # run new code end x.compare! end

Slide 94

Slide 94 text

Warming up -------------------------------------- old code 48.250k i/100ms new code 37.676k i/100ms Calculating ------------------------------------- old code 561.458k (± 8.0%) i/s - 2.799M in 5.019311s new code 437.953k (± 4.8%) i/s - 2.185M in 5.001528s Comparison: old code: 561458.3 i/s new code: 437953.4 i/s - 1.28x slower

Slide 95

Slide 95 text

CONGRATULATIONS, NOW YOU KNOW HOW TO BENCHMARK!

Slide 96

Slide 96 text

PERSISTENTOPENSTRUCT IS GOOD WHEN REPEATEDLY CREATING DATA OBJECTS WITH THE SAME SHAPE

Slide 97

Slide 97 text

ROUND 3: OpenStruct

Slide 98

Slide 98 text

No content

Slide 99

Slide 99 text

No content

Slide 100

Slide 100 text

INTRODUCED IN RUBY 2.3!

Slide 101

Slide 101 text

THIS IS A DRAMATIC IMPROVEMENT WHEN SOME KEYS ARE NEVER ACCESSED

Slide 102

Slide 102 text

ROUND 4: DynamicClass

Slide 103

Slide 103 text

SAMPLE USAGE DynamicClass Animal = DynamicClass.new do def speak "The #{type} makes a #{sound} sound!" end end dog = Animal.new(type: 'dog', sound: 'woof') # => # dog.speak # => "The dog makes a woof sound!" dog.ears = 'droopy' dog[:nose] = ['cold', 'wet'] dog['tail'] = 'waggable' dog # => # Animal.instance_methods(false) # => [:to_h, :speak, :type=, :type, :sound=, :sound, :ears=, :ears,
 :nose=, :nose, :tail=, :tail]

Slide 104

Slide 104 text

HOW IT WORKS DynamicClass class << self def attributes @attributes ||= Set.new end def add_methods!(key) class_exec do attr_writer key unless method_defined?("#{key}=") attr_reader key unless method_defined?("#{key}") attributes << key end end end

Slide 105

Slide 105 text

HOW IT WORKS DynamicClass Animal.new(baz: 4)

Slide 106

Slide 106 text

HOW IT WORKS DynamicClass def initialize(attributes = {}) attributes.each_pair do |key, value| __send__(:"#{key}=", value) end end Animal.new(baz: 4)

Slide 107

Slide 107 text

HOW IT WORKS DynamicClass def method_missing(mid, *args) if (mname = mid[/.*(?==\z)/m]) self[mname] = args.first else self[mid] end end def initialize(attributes = {}) attributes.each_pair do |key, value| __send__(:"#{key}=", value) end end Animal.new(baz: 4)

Slide 108

Slide 108 text

HOW IT WORKS DynamicClass def method_missing(mid, *args) if (mname = mid[/.*(?==\z)/m]) self[mname] = args.first else self[mid] end end def initialize(attributes = {}) attributes.each_pair do |key, value| __send__(:"#{key}=", value) end end animal.baz = 4 Animal.new(baz: 4)

Slide 109

Slide 109 text

HOW IT WORKS DynamicClass def method_missing(mid, *args) if (mname = mid[/.*(?==\z)/m]) self[mname] = args.first else self[mid] end end def initialize(attributes = {}) attributes.each_pair do |key, value| __send__(:"#{key}=", value) end end animal.baz = 4 animal.baz Animal.new(baz: 4)

Slide 110

Slide 110 text

HOW IT WORKS DynamicClass def method_missing(mid, *args) if (mname = mid[/.*(?==\z)/m]) self[mname] = args.first else self[mid] end end def []=(key, value) key = key.to_sym instance_variable_set(:"@#{key}", value) unless self.class.attributes.include?(key) self.class.add_methods!(key) end end def [](key) instance_variable_get(:"@#{key}") end def initialize(attributes = {}) attributes.each_pair do |key, value| __send__(:"#{key}=", value) end end animal.baz = 4 animal.baz Animal.new(baz: 4)

Slide 111

Slide 111 text

HOW IT WORKS DynamicClass def method_missing(mid, *args) if (mname = mid[/.*(?==\z)/m]) self[mname] = args.first else self[mid] end end def []=(key, value) key = key.to_sym instance_variable_set(:"@#{key}", value) unless self.class.attributes.include?(key) self.class.add_methods!(key) end end def [](key) instance_variable_get(:"@#{key}") end def initialize(attributes = {}) attributes.each_pair do |key, value| __send__(:"#{key}=", value) end end animal.baz = 4 animal.baz Instead of an internal hash @table, we use instance variables just as you would in a standard class! Animal.new(baz: 4)

Slide 112

Slide 112 text

IS IT FAST? Comparison: RegularClass: 3757567.8 i/s DynamicClass: 1250634.2 i/s - 3.00x slower PersistentOpenStruct: 766792.7 i/s - 4.90x slower OpenFastStruct: 525565.1 i/s - 7.15x slower OpenStruct: 147361.4 i/s - 25.50x slower

Slide 113

Slide 113 text

DYNAMICCLASS IS GOOD FOR THE SAME PURPOSES AS PERSISTENTOPENSTRUCT BUT IT’S FASTER

Slide 114

Slide 114 text

DYNAMICCLASS WORKS INTERNALLY THE WAY THAT PERSISTENTOPENSTRUCT REALLY SHOULD

Slide 115

Slide 115 text

PERSISTENTOPENSTRUCT MADE ME HAPPY. DYNAMICCLASS
 MADE ME HAPPIER. THAT’S THE BOTTOM LINE.

Slide 116

Slide 116 text

ROUNDUP: WHAT HAVE WE LEARNED?

Slide 117

Slide 117 text

1. EVEN THE STANDARD LIBRARY MAY HAVE ROOM FOR IMPROVEMENT!

Slide 118

Slide 118 text

2. OPTIMIZE FOR YOUR USE CASE

Slide 119

Slide 119 text

3. BENCHMARK, BENCHMARK, BENCHMARK!

Slide 120

Slide 120 text

4. EXPERIMENTS ARE AWESOME

Slide 121

Slide 121 text

5. YOU HAVE SOMETHING TO OFFER!

Slide 122

Slide 122 text

1 PERSON CAN INVENT A GREAT TOOL. IT TAKES A COMMUNITY TO ADAPT IT FOR THE COMMUNITY.

Slide 123

Slide 123 text

THANK YOU! ARIEL CAPLAN @AMCAPLAN AMCAPLAN.NINJA