20. Enumerator. Return от блокове. Още полезни библиотеки

4 януари 2017

Втори тест

напомняне

Ще го направим на 11. януари 2017г. (другата сряда)
Четните факултетни номера - от 19:00
Нечетните - от 20:00
Може да включва материал от целия курс

План до края на семестъра

09.01 (понеделник) - Конкурентност и паралелизъм
Задача
11.01 (сряда) - Тест
16.01 (понеделник) - Обектно-ориентирано програмиране - произход и основи
18.01 (сряда) - Rails или нещо друго :)

Проекти

Защитата е на 11. февруари 2017г. (събота)
Ще трябва да ни предадете проектите до 09. февруари 23:59
Ако не сте си избрали проект или не го предадете до тогава - септември
Ако сте пропуснали повече от 3 задачи, отново септември
Точките ви от семестъра се запазват за поправката

Enumerator-и

Някои методи на Enumerable могат да не вземат блок.

numbers = []
1.upto(5) { |x| numbers << x }

numbers               # => [1, 2, 3, 4, 5]

other = 1.upto(5)
other                 # => #<Enumerator: 1:upto(5)>
other.to_a            # => [1, 2, 3, 4, 5]

1.upto(5).map(&:succ) # => [2, 3, 4, 5, 6]

Enumerator-и

нещо като итератори

Енумераторите могат да се държат като итератори.

numbers = 1.upto(3)

numbers.next   # => 1
numbers.next   # => 2
numbers.next   # => 3
numbers.next   # => error: StopIteration

Kernel#loop

loop прави безкраен цикъл. Спира на StopIteration.

numbers = 1.upto(3)

loop do
  puts numbers.next
end

#=> 1
#=> 2
#=> 3

Enumerable и Enumerator

Методите на Enumerable връщат Enumerator, ако ги извикате без блок
Това позволява да "навръзвате" enumerator-и
Ако дефинирате обект, който е Enumerable, помислете и за съвместимост с enumerator-и

Enumerators 101

примери

enum = [1, 2].each # => #<Enumerator: [1, 2]:each>

enum.next # => 1
enum.next # => 2
enum.next # => error: StopIteration

Enumerators 102

примери

enum = Enumerator.new do |yielder|
  yielder << 1
  yielder << 2
end

enum.next # => 1
enum.next # => 2
enum.next # => error: StopIteration

Object#enum_for

Може да извадите енумератор от произволен метод с enum_for.

class Numbers
  def primes
    yield 2
    yield 3
    yield 5
    yield 7
  end
end

first_four_primes = Numbers.new.enum_for(:primes)
first_four_primes.to_a     # => [2, 3, 5, 7]

Object#enum_for

`enum_for` предава аргументите си на итериращия метод.

class Numbers
  def primes(offset)
    yield 2 + offset
    yield 3 + offset
    yield 5 + offset
    yield 7 + offset
  end
end

first_four_primes = Numbers.new.enum_for(:primes, 10)
first_four_primes.to_a     # => [12, 13, 15, 17]

Object#to_enum

примери

o = Object.new

def o.each
  yield
  yield 'hello'
  yield [1, 2]
end

enum = o.to_enum
enum.next # => nil
enum.next # => "hello"
enum.next # => [1, 2]

Enumerable и Enumerator (2)

пример

class Foo
  def each
    return to_enum unless block_given?

    yield 1
    yield 2
  end
end

f = Foo.new
f.each { |x| puts x } # => nil
f.each                # => #<Enumerator: #<Foo:0x002b12935aa4a8>:each>

#with_object и #with_index

Енумераторите имат някои интересни методи.

numbers = 1.upto(3)

numbers.with_index.to_a      # => [[1, 0], [2, 1], [3, 2]]
numbers.with_object(:x).to_a # => [[1, :x], [2, :x], [3, :x]]

map_with_index

навръзване на енумератори

Ако ви се е случвало да ви трябва индекс в map:

words = %w( foo bar baz ).map.with_index do |word, index|
  "#{index}: #{word.upcase}"
end

words # => ["0: FOO", "1: BAR", "2: BAZ"]

Мързеливи енумератори

Методът Enumerable#lazy връща "мързелив" енумератор
Има и Enumerator#lazy
Дадената стойност се оценява само когато потрябва

Примери

безкрайни поредици

(1..Float::INFINITY).map { |i| i * i }.first(5) # => ?

(1..Float::INFINITY).lazy.map { |i| i * i }.first(5) # => [1, 4, 9, 16, 25]

Примери

еднократно оценяване на целия chain

[
  ' a ',
  ' b ',
  ' c ',
].lazy.map { |x| p x.strip }.map { |x| p x.upcase }.take(1).to_a

Горното ще изведе на екрана:

"a"
"A"

И ще върне списъка ["A"].

LazyEnumerator methods

Методи имплементирани в Enumerator::Lazy (документация) към момента:

map / collect
flat_map / collect_concat
select / find_all
reject
grep
zip
take и take_while
drop и drop_while
slice_before, slice_after и slice_when (документация)

Методи, които "материализират" lazy колекцията:

to_a / force
each
next

Кога ни е полезно?

Първите 10 четни числа на Фибоначи

# Решение 1
Fib.lazy.select(&:even?).take(10).to_a

# Решение 2
a = []
Fib.each do |x|
  next if x.odd?
  a << x
  break if a.size == 10
end

Генератор на Fibonacci

Кодът по-долу няма да приключи никога:

class FibonacciNumbers
  def each
    current, previous = 1, 0

    while true
      yield current
      current, previous = current + previous, current
    end
  end
end

FibonacciNumbers.new.each { |number| puts number }

Генератор на Fibonacci с енумератори

Кодът по-долу ще работи:

class FibonacciNumbers
  def each
    current, previous = 1, 0

    while true
      yield current
      current, previous = current + previous, current
    end
  end
end

FibonacciNumbers.new.to_enum.take(5) # => [1, 1, 2, 3, 5]

Въпроси за Enumerator?

Задайте ги сега

The Ten Commandments of Egoless Programming

Стари, но добри
Заслужават си и са добър начин за начало на новата година
Може да ги видите в оригиналния контекст тук

The Ten Commandments of Egoless Programming

извадка

Understand and accept that you will make mistakes.
You are not your code.
Critique code instead of people – be kind to the coder, not to the code.
No matter how much "karate" you know, someone else will always know more.
Treat people who know less than you with respect, deference, and patience.
The only constant in the world is change.
The only true authority stems from knowledge, not from position.
Fight for what you believe, but gracefully accept defeat.

Class#new и Object#initialize

Всъщност, #initialize е просто instance метод.

Class#new е имплементиран горе-долу така:

class Class
  def new
    object = self.allocate
    object.send :initialize
    object
  end
end

Object#dup, Object#clone, #initialize_copy

#dup и #clone правят копие на обект
Копието е "shallow" копие, т.е. ако има instance променливи, те сочат на същото място
След като се направи, се вика #initialize_copy
Разликата между двете: #clone копира singleton методи и freeze-ва обекта, ако е замразен

retry в ensure

retry изпълнява begin блока отначало.

retries_left = 3

begin
  connect_to_facebook
rescue ConnectionError
  retries_left -= 1
  retry if retries_left > 0
end

next, break, redo, retry

retry може да се ползва в rescue/ensure клауза в метод
redo – просто рестартира блока
next – прекратява работата на блока
break – прекратява работата на метода, извикващ блока
next, redo и break могат да се използват само в блокове

next, break, redo, retry

next прекратява работата на блока:

def bar
  p "bar started"
  p yield
  p yield
  p "bar finished"
end

bar do
  p "block started"
  next "Return value"
  p "block finished"
end

Резултатът ще е:

"bar started"
"block started"
"Return value"
"block started"
"Return value"
"bar finished"
=> "bar finished"

next, break, redo, retry

break прекратява работата на блока и на метода, който го извиква:

def bar
  p "bar started"
  p yield
  p yield
  p "bar finished"
end

bar do
  p "block started"
  break "Return value"
  p "block finished"
end

Резултатът ще е:

"bar started"
"block started"
=> "Return value"

Документация в Ruby

Пишете ли документация? Как? Къде?
Както повечето други езици и платформи, и в Ruby има инструменти за автоматично генериране на документация
RDoc — Ruby documentation
Seattle.rb проект; дефакто стандарт
YARD — инструмент, разширяващ RDoc-стандарта

RDoc

YARD

Други - Rails API документацията

Други - API Dock

RDoc

Анализира статично вашата файлова структура, класове, модули, методи
Извлича коментарите над методи, класове и прочее и ги обработва
Дори да нямате коментари, пак ще генерира смислена и донякъде полезна документация
Във въпросните коментари може да използвате специален синтаксис

Подробно относно RDoc

Официална документация относно позволения маркъп (малко трудна за откриване):
http://docs.seattlerb.org/rdoc/RDoc/Markup.html
Обща документация на RDoc:
http://docs.seattlerb.org/rdoc/index.html

RubyDoc

rubydoc.info - място за преглеждане на RDoc
Генерирана документация от който и да е публикуван gem
Ако не можете да откриете документацията на даден gem, проверете там

Rails

rubyonrails.org

Безспорно най-популярното нещо в Ruby света
Може би ще направим една лекция-overview в края на курса
Може да разгледате миналогодишната

RuboCop

https://github.com/bbatsov/rubocop

Sidekiq

https://github.com/mperham/sidekiq

ActiveSupport

https://github.com/rails/rails/tree/master/activesupport

Ръководство - силно препоръчително

ActiveRecord

https://github.com/rails/rails/tree/master/activerecord

ORM
Може да работи с редица релационни бази данни - PostgreSQL, SQLite, MySQL и други
Обикновено имате нужда и от съответния DB driver (пак gem) - например mysql2, pg, sqlite3 и т.н.
Ръководство - силно препоръчително
Може да се ползва извън Rails