Skip to content

Add introduction #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 28 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
a7df509
Add content to design patterns section and add anti-patterns and idio…
Oct 28, 2016
e9df3a3
Add brief introduction
Oct 28, 2016
72a43bc
Add more content to introduction and start Rust section
Oct 28, 2016
cdddae3
Complete the introduction section
Oct 28, 2016
d44bb8d
Remove paragraph
Oct 28, 2016
bf1194a
Add imperative and declarative topics under the Rust section
Oct 28, 2016
28d2700
Add more content to the imperative and declarative sections
Oct 28, 2016
f12550e
Add types and ownership sections
Oct 28, 2016
b1e07bd
Add more content to declarative section
Oct 28, 2016
76a5434
Add design pattern descriptions and criticism
Oct 28, 2016
3b8d5e2
Add refactoring section
Oct 28, 2016
1e134f2
Add tests and small changes sections
Oct 28, 2016
3c95850
Break sections into separate documents
Oct 28, 2016
5f03a18
Remove the use of I
Oct 28, 2016
7b04d85
Add wikipedia link for idiom
Oct 28, 2016
ac82f18
Move about.md to README.md for all subfolders
Nov 3, 2016
d9c62d8
Update anti-patterns introduction
Nov 3, 2016
2a35866
Rewrite the refactoring sentence
Nov 3, 2016
88c2de9
Remove traditional design patterns content and add functional usage s…
Nov 3, 2016
9028cd6
Separate functional section from design patterns
Nov 3, 2016
6aa6d90
Update links in introduction and add a Rust Rocks section
Nov 3, 2016
34a9e09
Add the Rust Rocks section
Nov 3, 2016
3dad440
Separate rust rocks and patterns more
Nov 3, 2016
2e1b8de
Remove explanation for builder link
Nov 3, 2016
4923556
Update refactoring introduction
Nov 3, 2016
3ededeb
Move content from refactoring to idioms
Nov 3, 2016
8d92d74
Fix rust rocks link
Nov 3, 2016
d2df883
Make the quote more clever
Nov 3, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions anti_patterns/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Anti-patterns

An [anti-pattern](https://en.wikipedia.org/wiki/Anti-pattern) is a solution to a "recurring problem that is usually ineffective and risks being highly counterproductive". Just as valuable as knowing how to solve a problem, is knowing how _not_ to solve it. Anti-patterns give us great counter-examples to consider relative to design patterns. Anti-patterns are not confined to code. A process can be an anti-pattern.
54 changes: 54 additions & 0 deletions functional/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Functional Usage of Rust

Rust is an imperative language, but it follows many functional programming paradigms. One of the biggest hurdles to understanding functional programs when coming from an imperative background is the shift in thinking. Imperative programs describe __how__ to do something, whereas declarative programs describe __what__ to do. Let's sum the numbers from 1 to 10 to show this.

## Imperative

```rust
let mut sum = 0;
for i in 1..11 {
sum += i;
}
println!("{}", sum);
```

With imperative programs, we have to play compiler to see what is happening. Here, we start with a `sum` of `0`. Next, we iterate through the range from 1 to 10. Each time through the loop, we add the corresponding value in the range. Then we print it out.

| `i` | `sum` |
| --- | --- |
| 1 | 1 |
| 2 | 3 |
| 3 | 6 |
| 4 | 10 |
| 5 | 15 |
| 6 | 21 |
| 7 | 28 |
| 8 | 36 |
| 9 | 45 |
| 10 | 55 |

This is how most of us start out programming. We learn that a program is a set of steps.

## Declarative

```rust
println!("{}", (1..11).fold(0, |a, b| a + b));
```

Whoa! This is really different! What's going on here? Remember that with declarative programs we are describing __what__ to do, rather than __how__ to do it. `fold` is a function that [composes](https://en.wikipedia.org/wiki/Function_composition) functions. The name is a convention from Haskell.

Here, we are composing functions of addition (this closure: `|a, b| a + b)`) with a range from 1 to 10. The `0` is the starting point, so `a` is `0` at first. `b` is the first element of the range, `1`. `0 + 1 = 1` is the result. So now we `fold` again, with `a = 1`, `b = 2` and so `1 + 2 = 3` is the next result. This process continues until we get to the last element in the range, `10`.

| `a` | `b` | result |
| --- | --- | --- |
| 0 | 1 | 1 |
| 1 | 2 | 3 |
| 3 | 3 | 6 |
| 6 | 4 | 10 |
| 10 | 5 | 15 |
| 15 | 6 | 21 |
| 21 | 7 | 28 |
| 28 | 8 | 36 |
| 36 | 9 | 45 |
| 45 | 10 | 55 |

8 changes: 8 additions & 0 deletions idioms/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Idioms

[Idioms](https://en.wikipedia.org/wiki/Programming_idiom) are commonly used styles and patterns largely agreed upon by a community. They are guidelines. Writing idiomatic code allows other developers to understand what is happening because they are familiar with the form that it has.

The computer understands the machine code that is generated by the compiler. The language is therefore mostly beneficial to the developer. Since we have this abstraction layer, why not put it to good use and make it simple? Remember the KISS principle.

> Code is there for humans, not computers, to understand.

8 changes: 2 additions & 6 deletions intro.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
# Introduction

## Design patterns
When developing programs, we have to solve many problems. A program can be viewed as a solution to a problem. It can also be viewed as a collection of solutions to many different problems. All of these solutions work together to solve a bigger problem.

What are design patterns? What are idioms? Anti-patterns.

## Design patterns in Rust

Why Rust is a bit special - functional elements, type system - borrow checker
There are many problems that share the same form. While the details are different, since they have the same form they can be solved using the same methods. [Design patterns](patterns/README.md) are methods to solve common problems when writing software. [Anti-patterns](anti_patterns/README.md) are methods to solve these same common problems. However, while design patterns give us benefits, anti-patterns create more problems. There are some problems that we don't need to solve because [Rust rocks](rust_rocks.md)! [Idioms](idioms/README.md) are guidelines to follow when coding. They are social norms of the community. You can break them, but if you do you should have a good reason for it. [Refactoring](refactoring/README.md) is the process by which you convert code that works, but is hard to understand, into code that works and is easy to understand.
24 changes: 24 additions & 0 deletions patterns/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Design patterns

[Design patterns](https://en.wikipedia.org/wiki/Software_design_pattern) are "general reusable solutions to a commonly occurring problem within a given context in software design". Design patterns are a great way to describe some of the culture and 'tribal knowledge' of programming in a language. Design patterns are very language-specific - what is a pattern in one language may be unnecessary in another due to a language feature, or impossible to express due to a missing feature.

If overused, design patterns can add unnecessary complexity to programs. However, they are a great way to share intermediate and advanced level knowledge about a programming language.

# Design patterns in Rust

Rust has many very unique features. These features give us great benefit by removing whole classes of problems. For more about this, read why [Rust rocks](/rust_rocks.md)! There are also some patterns that are unique to Rust.

- [Builder](patterns/builder.md)

TODO: Add links to all the pattern files.

# YAGNI

If you're not familiar with it, YAGNI is an acronym that stands for You Aren't Going to Need It. It's an important software design principle to apply as you write code.

> The best code I ever wrote was code I never wrote.

If we apply YAGNI to design patterns, we see that the features of Rust allow us to throw out many patterns. For instance, there is no need for the [strategy pattern](https://en.wikipedia.org/wiki/Strategy_pattern) in Rust because we can just use [traits](https://doc.rust-lang.org/book/traits.html).

TODO: Maybe include some code to illustrate the traits.

15 changes: 15 additions & 0 deletions refactoring/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Refactoring

Refactoring is very important in relation to these topics. Just as important as the other topics covered here, is how to take good code and turn it into great code.

We can use [design patterns](patterns/README.md) to DRY up code and generalize abstractions. We must avoid [anti-patterns](anti_patterns/README.md) while we do this. While they may be tempting to employ, their costs outweigh their benefits.

> Shortcuts make for long days.

We can also use [idioms](idioms/README.md) to structure our code in a way that is understandable.

## Tests

Tests are of vital importance during refactoring.

## Small changes
13 changes: 13 additions & 0 deletions rust_rocks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Rust Rocks!

Consider this the unofficial Rust sales pitch.

# Types

Rust has strong static types. This can be very different than what you are used to if you are coming from a loosely-typed language. Don't worry, though. Once you get used to them, you'll find the types actually make your life easier. Why? Because you are making implicit assumptions explicit.

TODO: Show an example that illustrates the importance of data types.

# Ownership

Ownership is arguably the central concept of Rust. The ownership system is __the__ reason for the safety guarantees in Rust.