18. Ruby Gems. Подредба на кода. Ruby Stdlib. Разни

8 януари 2014

Днес

Полезни Ruby gems
Добри практики при структуриране на кода
Ruby Standard Library (продължение)

Дати за изпита

(повторение)

Вторият тест ще се проведе на 9 февруари 2014 г., от 09 ч. в зала 01
За защита на проекти сте разделени на две групи
Четните факултетни номера ще защитават на 9 февруари, от 11:00 ч., в зала 01
Нечетните факултетни номера ще защитават на 22 февруари, от 09:00 ч., в зала 307
Ако имате уважителна причина да не можете на определената за вас дата, пишете ни навреме

Ruby ядро и стандартна библиотека

Функционалността, която идва с Ruby, е разделена на две
Ruby Core – винаги заредени в паметта (документация)
Ruby Stdlib (стандартна библиотека) – като gem-ове (документация)

Полезни класове от Ruby core

които разгледахме на предната сбирка

Struct – мини-класове, представляващи колекция от атрибути (документация)
Comparable – дава ви методи <, <=, ==, >=, > и between? (документация)
Marshal – сериализиране и десериализиране на Ruby обекти (документация)

IO и File

Все още не сме говорили за работа с файлове в Ruby
Употребата е тривиална; достатъчно ви е да разгледате документацията на File и IO
IO е родителят на файл и представлява входно-изходен поток от данни
Други класове, наследяващи от IO са TCPSocket и UDPSocket
Много от методите на File идват от IO

File - два примера

Прочитане на цял файл като низ:

File.read('/etc/resolv.conf') # => "The contents of the file as a string."

Отваряне на файл, работа с обекта и автоматично затваряне на файла при излизане от блока:

File.open('foo/bar.txt', 'w') do |file|
  file.write 'Some data.'
  file.puts  'Some other data, with a newline at the end.'
  file.puts  'File will be closed automatically, even in case of an exception in the block.'
end

RubyVM::InstructionSequence

Не толкова полезен, колкото забавен клас
Дава поглед към начина, по който парче Ruby код изглежда, компилиран в Ruby bytecode
Специфичен за MRI (CRuby), може да го няма в други имплементации като JRuby, Rubinius и прочее
Документаця

RubyVM::InstructionSequence

пример

code = 'puts ["a" * 10].first'
compiled = RubyVM::InstructionSequence.compile(code)
puts compiled.disasm

Резултат:

== disasm: <RubyVM::InstructionSequence:<compiled>@<compiled>>==========
0000 trace            1                                               (   1)
0002 putself
0003 putstring        "a"
0005 putobject        10
0007 opt_mult         <callinfo!mid:*, argc:1, ARGS_SKIP>
0009 newarray         1
0011 opt_send_simple  <callinfo!mid:first, argc:0, ARGS_SKIP>
0013 opt_send_simple  <callinfo!mid:puts, argc:1, FCALL|ARGS_SKIP>
0015 leave

RubyVM::InstructionSequence

още един пример

puts RubyVM::InstructionSequence.compile('a, b = 1, 2').disasm

Можем да видим, че a, b = 1, 2 минава през създаване на един обект тип Array:

== disasm: <RubyVM::InstructionSequence:<compiled>@<compiled>>==========
local table (size: 3, argc: 0 [opts: 0, rest: -1, post: 0, block: -1, keyword: 0@4] s1)
[ 3] a          [ 2] b
0000 trace            1                                               (   1)
0002 duparray         [1, 2]
0004 dup
0005 expandarray      2, 0
0008 setlocal_OP__WC__0 3
0010 setlocal_OP__WC__0 2
0012 leave

Стандартната библиотека на Ruby

Мислете за нея като за една купчина съвсем обикновени gem-ове, които вървят пакетирани с Ruby
Част от нея е написана на C, друга част – на Ruby
В документацията на stdlib може да видите списъка с "gem"-ове
За да ползвате нещо от нея, трябва да направите require 'somelib', например require 'bigdecimal'
Множество дребни и интересни библиотеки - разгледайте ги, за да знаете какво имате наготово

Налични библиотеки

abbrev       base64          benchmark    bigdecimal          cgi            cmath
coverage     csv             curses       date                dbm            debug
delegate     digest          dl           drb                 e2mmap         English
erb          etc             extmk        fcntl               fiddle         fileutils
find         forwardable     gdbm         getoptlong          gserver        io/console
io/nonblock  io/wait         ipaddr       irb                 json           logger
mathn        matrix          minitest     minitest/benchmark  minitest/spec  mkmf
monitor      mutex_m         net/ftp      net/http            net/imap       net/pop
net/smtp     net/telnet      nkf          objspace            observer       open-uri
open3        openssl         optparse     ostruct             pathname       pp
prettyprint  prime           profile      profiler            pstore         psych
pty          racc            racc/parser  rake                rdoc           readline
resolv       resolv-replace  rexml        rinda               ripper         rss
rubygems     scanf           sdbm         securerandom        set            shell
shellwords   singleton       socket       stringio            strscan        sync
syslog       tempfile        test/unit    thread              thwait         time
timeout      tk              tmpdir       tracer              tsort          un
uri          weakref         webrick      win32ole            xmlrpc         yaml
zlib

Какво сме ползвали досега от Stdlib?

bigdecimal
benchmark
minitest
И много, много други, пряко и непряко...

OpenStruct

Ще разгледаме само един пример от Stdlib - OpenStruct
Наподобява хеш, но дава достъп до полетата си през методи
Получавате го, като направите require 'ostruct'
Имплементиран на Ruby, може да разгледате кода
Дефинира marshal_load и marshal_dump, може да видите как за пример
Имплементира и част от интерфейса на Hash, като each_pair и методите [] и []=
Вижте цялата му документация

OpenStruct - пример

require 'ostruct'

john = OpenStruct.new
john.name = 'John Doe'
john.age  = 33

john.name     # "John Doe"
john.age      # 33
john.address  # nil

Въпроси?

Ако имате въпроси по стандартната библиотека, Ruby core или друго, може да ги зададете.

Полезни Ruby gem-ове и поуки

Ще разгледаме някои популярни и полезни Ruby библиотеки
По пътя ще се опитаме да научим нещо ново
Например, добри практики при структуриране на проект
"Boilerplate" неща, необходими на един Ruby gem
Други интересни Ruby трикове от практиката
Но преди това...

Third-party software – disclaimer

Долното е извадка от GNU GPL лиценза за отворен код:

15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Third-party software – disclaimer

Долното е извадка от GNU GPL лиценза за отворен код:

15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

“AS IS” WITHOUT WARRANTY OF ANY KIND

Ние, програмистите, не вярваме на собствения си код, та какво остава за чуждия такъв?

Така и трябва. Колкото по-малко зависимости от чужд (third-party) код – толкова по-добре.

Изобщо, колкото по-малко код – толкова по-добре. Но това е тема за друг ден.

Откриване на нови Ruby Gems

Статистики за популярни/най-използвани gem-ове (търсете в Google)
The Ruby Toolbox
Помощ от приятел

Оценка качеството на съществуващи gem-ове

Знаете името на gem и се чудите какво прави и дали е качествен?
rubygems.org/gems/именабиблиотеката → линк "Source code" или "Homepage"
Или търсите направо в GitHub
Гледате колко хора са добавили и fork-нали проекта, откога е последния commit, дали има много issues и pull requests и прочее
Разглеждате кода