real cra smen create eir - zenspider.com · cascadia ruby 2013, ... create "eir own tools can)...

Craftsmen Create Their Own Tools

Cascadia Ruby 2013, Portland, OR

Ryan Davis, Seattle.rb

Real Cra!smen Create "eir Own Tools

(can)




akaMake Your OwnCode Climate!


Ryan Davis, Seattle.rbCraftsmen Create Their Own Tools

Setting Expectations

• ~150 Slides in 30 min. ~5 spm

• Semi-Technical Talk

• Slides at: http://www.zenspider.com/presentations

• Twit me @the_zenspider

TODO

http://www.zenspider.com/presentations

http://www.zenspider.com/presentations



Let's get this out of the

way…



My Tick



Um…



There will be more



Remember



Youare NOT

your code!!!



Let's Get Started



90+% of the time



SoftwareEngineering

is a

Lie



NASA?



JPL?



Rocket Surgery?



☑ Engineering



Websites?



Devops?



☒Engineering



Hell No



We may write software



Not Even Close to

"Engineering"



NotInsulting



Quitethe

Opposite



Engineeringcan be really

Boring



We're Craftsmen.



We Craft Software.



craftsmannoun ( pl. craftsmen )a person who is skilled in a particular craft.

craftswomannoun ( pl. craftswomen )a woman who is skilled in a particular craft.



Cut



Chisel



Sand



Our Code



Fitit

Together



like good woodworking

http://www.woodthatworks.com





Each Piece is Unique.



WhenCrafting



Unique Tool



Specialized



Specific Task



Uniquely Suited



To how You Work



http://www.flickr.com/photos/wsdot/8260834957/





You make these tools…



Right?



Right?!?



You Should



at least,You ShouldBe Able To



Not Widely Adopted Practice



Why?



I Blame



Algol



Or, the history of Algol-based

languages



Algol Matrix abs maxproc abs max = ([,]real a, ref real y, ref int i, k)real:comment The absolute greatest element of the matrix a, of size ⌈a by 2⌈a is transferred to y, and the subscripts of this element to i and k; commentbegin real y := 0; i := ⌊a; k := 2⌊a; for p from ⌊a to ⌈a do for q from 2⌊a to 2⌈a do if abs a[p, q] > y then y := abs a[p, q]; i := p; k := q fi od od; yend # abs max #



C Quicksortvoid quick_sort (int *a, int n) { if (n < 2) return; int p = a[n / 2]; int *l, *r, t = a, a + n - 1, 0; while (l <= r) { if (*l < p) { l++; continue; } if (*r > p) { r--; continue; } t = *l; *l++ = *r; *r-- = t; } quick_sort(a, r - a + 1); quick_sort(l, a + n - l);}



Static a Opaque



Complex Grammars



Complex Semantics



Complex Memory Models



Disempowering



Tool-Making is for the Elite



Vim?Emacs?



Do You Extend Them?



Do You Write Tools to Help

You Code?



Whynot?



I'm Here to Help



Language Tools



Flog and Flayh!p://ruby.sadi.st/

http://ruby.sadi.st

http://ruby.sadi.st



Flog?



AnalyzesComplexity



class LameExample def blah a = eval "1+1" # 1.2 + 6.0 + if a == 2 then # 1.2 + 1.2 + 0.4 + puts "yay" # 1.2 end # = 11.2 endend

Example



Flay?



FindsSimilarCode



Structurally Similardef x(n) n + 1end

def y m m + 2end

Names

(Styles)

Literals



"Fuzzily" Similardef a f1; f2; f3; f4; f5; f6end

def b f2; f3; f4; f5; f6end

def c f2; f3; f4; f5; f6; f7end



Basic Ar"#e$ure



Notfor

Regexps



Needto know

the Language



Builda model



Walkthe model



"3+4*2"

(3 + (4 * 2))

["3", "+", "4","*", "2"]

call: +

lit: 3 call: *

lit: 4 lit: 2



Ruby Parser



RubyParser.new.parse " 3+4*2"

Converts This:



To This::call

:lit

3

:+ :call

:lit

4

:* :lit

2



s(:call, s(:lit, 3), :+, s(:call, s(:lit, 4), :*, s(:lit, 2)))

Or This:



Sexp Processor



Dispatches



Node Type



SexpProcessorclass MyLanguageTool def process_lit s # ... end def process_call s # ... endend

call: +

lit: 3 call: *

lit: 4 lit: 2

TODO:add interpreterslide



Flog Working Details



Knowledgable ScoringSCORES = Hash.new 1SCORES.merge! { :module_eval => 5, :define_method => 5, :class_eval => 5, :send => 3, :method_defined? => 2, :eval => 5, :extend => 2, :instance_eval => 5, :inject => 2, # ...}



process_ifdef process_if exp add_to_score :branch

process exp.shift # cond

penalize_by 0.1 do process exp.shift # true process exp.shift # false end

s()end



process_calldef process_call exp penalize_by 0.2 do process exp.shift # recv end

name = exp.shift

penalize_by 0.2 do process_until_empty exp end

add_to_score name, SCORES[name] s()end



acetera



Flay Working Details



The Algorithm

sexps[sexp.structure.hash] << sexp

…really




call: +

lit: 3 call: *

lit: 4 lit: 2

42

call

lit call

lit lit



42 => [

]


sexps

call

lit call

lit lit



42 => [

]

call

lit call

lit lit

call

lit call

lit lit

call

lit call

lit lit


sexps



Make Your Own



Lint



Start Small



Very Small



ReportSingle CharVariables



Test Infrastructurerequire "minitest/autorun"require "lint"

describe Lint do # nothing yetend



Premature Refactoringdescribe Lint do def assert_lint src, out = "" lint = Lint.new rp = RubyParser.new sexp = rp.parse src, "file.rb"

assert_output out, "" do lint.process sexp end endend



Happy Pathit "should be silent on compliant code" do assert_lint "1+1"end



Sad Pathit "should be bitch about small var names" do assert_lint("a=1", "Short variable: 'a' on file.rb:1\n")end



Infrastructurerequire "sexp_processor"require "ruby_parser"

class Lint < MethodBasedSexpProcessor # nothing yetend

if $0 == __FILE__ then lint = Lint.new

ARGV.each do |path| sexp = RubyParser.new.parse File.read(path), path lint.process sexp endend



Red# Running:

.F

Finished in 0.021296s, 93.9144 runs/s, 187.8287 assertions/s.

1) Failure:Lint#test_0002_should be bitch about small var names [./test_lint.rb:22]:In stdout.--- expected+++ actual@@ -1,2 +1 @@-"Short variable: 'a' on file.rb:1-"+""

2 runs, 4 assertions, 1 failures, 0 errors, 0 skips



Implementation, 1class Lint < MethodBasedSexpProcessor def process_lasgn sexp _, name, val = sexp

err = case name.to_s when /^.$/ then "Short variable" end

puts "%s: '%s' on %s:%d" % [err, name, sexp.file, sexp.line] if err

s() # ignore me endend



Green# Running:

..





More Sad Pathit "should be bitch about small global names" do assert_lint("$a=1", "Short variable: '$a' on file.rb:1\n")end

it "should be bitch about small ivar names" do assert_lint("@a=1", "Short variable: '@a' on file.rb:1\n")end



Red# Running:

F..F


1) Failure:Lint#test_0003_should be bitch about small global names [./test_lint.rb:26]:In stdout.--- expected+++ actual@@ -1,2 +1 @@-"Short variable: '$a' on file.rb:1-"+""

2) Failure:Lint#test_0004_should be bitch about small ivar names [./test_lint.rb:31]:In stdout.--- expected+++ actual@@ -1,2 +1 @@-"Short variable: '@a' on file.rb:1-"+""




Implementation, 2 def process_lasgn sexp _, name, val = sexp

err = case name.to_s when /^(\$|@@?)?.$/ then "Short variable" end


s() # ignore me end



Implementation, 2.5class Lint < MethodBasedSexpProcessor def var sexp # ... end

alias :process_lasgn :var # local alias :process_iasgn :var # ivars alias :process_gasgn :var # globalend



GreenRun options: --seed 8130

# Running:

....





ReportcamelCaseVariables



Add a New Testit "should be bitch about camel case names" do assert_lint("aThing=1", "Bad variable name: 'aThing' on file.rb:1\n")end



RedRun options: --seed 12656

# Running:

..F


1) Failure:Lint#test_0003_should be bitch about camel case names [./test_lint.rb:33]:In stdout.--- expected+++ actual@@ -1,2 +1 @@-"Bad variable name: 'aThing' on file.rb:1-"+""




Implementation, 3 def var sexp _, name, val = sexp

err = case name.to_s when /^(\$|@@?)?.$/ then "Short variable" when /^[a-z]+[A-Z]/ then "Bad variable name" end


s() end




# Running:

.....





Add More Tests it "should be bitch about camel case globals" do assert_lint("$aThing=1", "Bad variable name: '$aThing' on file.rb:1\n") end

it "should be bitch about camel case ivars" do assert_lint("@aThing=1", "Bad variable name: '@aThing' on file.rb:1\n") end



Red# Running:

...F.F.


1) Failure:Lint#test_0007_should be bitch about camel case ivars [./test_lint.rb:46]:In stdout.--- expected+++ actual@@ -1,2 +1 @@-"Bad variable name: '@aThing' on file.rb:1-"+""

2) Failure:Lint#test_0006_should be bitch about camel case globals [./test_lint.rb:41]:In stdout.--- expected+++ actual@@ -1,2 +1 @@-"Bad variable name: '$aThing' on file.rb:1-"+""




Implementation, 4 def var sexp _, name, val = sexp

err = case name.to_s when /^(\$|@@?)?.$/ then "Short variable" when /^(\$|@@?)?[a-z]+[A-Z]/ then "Bad variable name" end


s() end




# Running:

.......





What'd We Do?



7 Tests it "should be silent on compliant code" do assert_lint "1+1" end

it "should be bitch about small var names" do assert_lint("a=1", "Short variable: 'a' on file.rb:1\n") end

it "should be bitch about small global names" do assert_lint("$a=1", "Short variable: '$a' on file.rb:1\n") end

it "should be bitch about small ivar names" do assert_lint("@a=1", "Short variable: '@a' on file.rb:1\n") end

it "should be bitch about camel case names" do assert_lint("aThing=1", "Bad variable name: 'aThing' on file.rb:1\n") end

it "should be bitch about camel case globals" do assert_lint("$aThing=1", "Bad variable name: '$aThing' on file.rb:1\n") end

it "should be bitch about camel case ivars" do assert_lint("@aThing=1", "Bad variable name: '@aThing' on file.rb:1\n") end



50 LOC Implementationclass Lint < MethodBasedSexpProcessor def var sexp _, name, val = sexp

err = case name.to_s when /^(\$|@@?)?.$/ then "Short variable" when /^(\$|@@?)?[a-z]+[A-Z]/ then "Bad variable name" end


s() end

alias :process_lasgn :var alias :process_iasgn :var alias :process_gasgn :varend



Easy to Test



Easy to Extend



Keep Going



ComplexityAnalysis



Refactoring Analysis



Dependency Analysis



Give it a grade A-F



Sooner or Later



Take on Code Climate



Probably Later




"ank You…One more thing…

@[email protected]://blog.zenspider.com/

mailto:[email protected]


http://blog.zenspider.com




2011:Fresh

Black Pepper



2012:Ginger Ale



2013:Hot Sauce!



http://www.flickr.com/photos/dinnerseries/8557776408/

http://www.flickr.com/photos/dinnerseries/8557776408/sizes/l/in/photostream/

http://www.flickr.com/photos/dinnerseries/8557776408/sizes/l/in/photostream/



5 Minute Hot Sauce350 g hot peppers of your choice, stems removed, roughly chopped7 whole cloves of garlic3 T honey apple cider vinegar

1. Add all ingredients to pressure cooker.2. Add enough apple cider vinegar to cover.3. Seal pressure cooker, bring to 15psi, cook for 1 min.4. Take off heat, let cool naturally until pressure released.5. Transfer to blender and roughly purée.6. (opt) Bring back to stove and reduce to thickness you desire.7. Enjoy the noms.

Adapted from:

http://www.hippressurecooking.com/pressure-cooker-hot-sauce/http://www.bluekaleroad.com/2013/01/homemade-sriracha.html

http://www.hippressurecooking.com/pressure-cooker-hot-sauce/

http://www.hippressurecooking.com/pressure-cooker-hot-sauce/

http://www.bluekaleroad.com/2013/01/homemade-sriracha.html

http://www.bluekaleroad.com/2013/01/homemade-sriracha.html



Who Wants Some?




"ank You@the_zenspider

[email protected]://blog.zenspider.com/





real cra smen create eir - zenspider.com · cascadia ruby 2013, ... create "eir own tools can)...

Documents