Git Product home page Git Product logo

best-ruby's Introduction

Ruby Tricks, Idiomatic Ruby, Refactorings and Best Practices

Do you know why experienced Ruby programmers tend to reach for basic collections and hashes while programmers from other languages go for more specialized classes? Do you know the difference between strip, chop, and chomp; and why there are three such similar methods when apparently one might suffice (Not to mention lstrip and rstrip!)? Do you know the downsides of dynamic typing? Do you know why the differences between strings and symbols get so blurry, even to experienced Ruby developers? How about metaprogramming? What the heck is an eigenclass? How about protected methods? Do you know what they’re really about? Really? Are you sure? Eloquent Ruby

Absolutely the best way to learn to write idiomatic Ruby code is to read idiomatic Ruby code. Eloquent Ruby

This repository aims to help everyone write more idiomatic, clean, and tricky ruby code and also document good refactoring techniques. You can add your own technique or paste it from some website. Do not forget the source, of course. All the tricks are in the /tricks folder.

For the sake of clarity, you should paste in the markdown format. At the end, if the code is not your own, paste a reference to the author and source of the technique.

In this part we can review some obscure or awesome features from the and the standard ruby library which we normally forget.

You can write Ruby code, but it can sometimes look like Java code. Here you can find some tips to write more naturally and take advantage of idiomatic Ruby.

Small (and big) improvements you can apply to your code and improve it's readability and maintenance. Change the internal structure of the code without changing it's behaviour.

If you keep your house cleaned constantly you'll never need to waste a weekend cleaning it. The same applies to your code. Be disciplined and keep your code looking good with those tips.

Contributors

A big thanks to the following people

Contributing

  1. Fork it
  2. Create a branch with your idea: git checkout -b my-idea
  3. Check in which category it should be: best practice, idiomatic ruby, refactoring or trick. If you don't know, please open an issue and ask.
  4. Add your idea to the collection of .md files in the correct folder (tricks, refactorings, idiomatic_ruby or best_practices) folder
  5. Commit your changes: git commit -am 'Add my idea'
  6. Push to the branch: git push origin my-idea
  7. Create a new Pull Request and explain your technique in the markdown file

best-ruby's People

Contributors

0x0dea avatar abarrak avatar alebian avatar ciaoben avatar dansandland avatar eftakhairul avatar ezekg avatar filipebarcos avatar franzejr avatar fredkelly avatar gitter-badger avatar ilyaumanets avatar jadercorrea avatar josephgrossberg avatar jtmarmon avatar latortuga avatar lightyrs avatar marceloboeira avatar marcosx avatar matugm avatar peterwilson avatar rafaelsales avatar sagareganesh avatar sergii avatar shadefinale avatar skylerrogers avatar sojinsamuel avatar taw avatar tdkn avatar xzgyb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

best-ruby's Issues

(head, *tail)

I don't know if this is "tricky" enough but I thought this was cool

(head, *tail) = array # break off the first element of the array, and keep the rest separately

source

Display all options list in README.

Hi,
It will be better if we display all options list in README like faker gem.
There are 2 advantage of this

  1. Easy to understand.

  2. Decrease one step in search engine.

    Is it make sense?
    thoughts?

    I can create PR, just let me know

Fixnum#times

On the page addressing Fixnum#times you state that the developer should favor for loops over Fixnum#times. We generally avoid for loops in Ruby and I've often heard people argue that they should be removed entirely. I think an entire section discussing looping in Ruby would be appropriate. There you could mention that we stay away from for.

The file in question.

Why not put together?

Hi, It seems more convenient to read them in a row without opening each file. What do you think?

Add more Best Practices

So far, we just have one best practice for pure Ruby.

Looking forward to see more best practices.

Inner assignment conditional is a pretty bad example...

Why would you ever do

retval = if vals.any?
           do_something(vals)
         else
           do_something_different
         end

over

retval = vals.any? ? do_something(vals) : do_something_different

I think the inner assignment conditional only makes sense when more logic needs to be performed inside the conditions

Suggestion for inject

In "Idiomatic Ruby / Combine..." the first statement is extraneous.

hash = {}     # not needed, even misleading
values.inject({}) do |hash, value|
  hash.merge(value => value ** 2)
end

In older versions of ruby, the hash var would collide with the block arg; in modern ruby, they're scoped, so the hash being injected is the {} arg to inject, not the variable.

A more idiomatic version might be:

result = values.inject({}) do |hash, value|
  hash.merge(value => value ** 2)
end 

It would also be useful to note that the use of merge with inject is a bit tricky, and only works because merge returns the hash itself. If the last expression in the block doesn't return the injected value, the inject will fail in weird ways. A less error-prone way to code it is to always return the injected value:

result = values.inject({}) do |hash, value|
  hash[value] = value ** 2
  hash
end

or, as a one-liner:

result = values.inject({}) {|hash, value| hash[value] = value ** 2; hash}

best-ruby/idiomatic_ruby/each_vs_map.md

This code:

users_ids = users.map &:id

Is anything but idiomatic. Something like this:

users_ids = users.map(&:id)

would look like proper Ruby.

Freely floating &: just looks weird.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.