add YARD docs for all files in lib/ and app/ #6

mftaff · 2017-12-18T13:08:09Z

No description provided.

houndci-bot · 2017-12-18T13:08:19Z

lib/passwordless/router_helpers.rb

+ # Generates passwordless routes for a Model that is connected to Passwordless.
+ # @param resource [Symbol] the pluralized symbol of your Model (e.g - :users).
+ # @param at [string] Optional - provide custom path (i.e controller) for routes (e.g "users").
+ # @param as [string] Optional - provide custom url for routes (e.g "special-users").


Line is too long. [88/80]

houndci-bot · 2017-12-18T13:08:19Z

lib/passwordless/router_helpers.rb

 module RouterHelpers
+ # Generates passwordless routes for a Model that is connected to Passwordless.
+ # @param resource [Symbol] the pluralized symbol of your Model (e.g - :users).
+ # @param at [string] Optional - provide custom path (i.e controller) for routes (e.g "users").


Line is too long. [98/80]

houndci-bot · 2017-12-18T13:08:19Z

lib/passwordless/router_helpers.rb

 module RouterHelpers
+ # Generates passwordless routes for a Model that is connected to Passwordless.
+ # @param resource [Symbol] the pluralized symbol of your Model (e.g - :users).


Line is too long. [82/80]

houndci-bot · 2017-12-18T13:08:19Z

lib/passwordless/router_helpers.rb

 module RouterHelpers
+ # Generates passwordless routes for a Model that is connected to Passwordless.


Line is too long. [82/80]

houndci-bot · 2017-12-18T13:08:19Z

lib/passwordless/model_helpers.rb

 module ModelHelpers
+ # Adds passwordless sign_in for SomeModel (examples: User, Admin). 


Trailing whitespace detected.

houndci-bot · 2017-12-18T13:08:20Z

lib/passwordless/controller_helpers.rb

@@ -1,7 +1,17 @@
 # frozen_string_literal: true

 module Passwordless
+ # Some helpers for controllers that are connected to passswordless Models. 


Trailing whitespace detected.

houndci-bot · 2017-12-18T13:08:20Z

app/models/passwordless/session.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true

 module Passwordless
- # The session responsible holding the connection between the record trying to
+ # The session responsible for holding the connection between the record trying to


Line is too long. [83/80]

houndci-bot · 2017-12-18T13:08:20Z

app/mailers/passwordless/mailer.rb

 class Mailer < ActionMailer::Base
 default from: Passwordless.default_from_address
-
+
+ # Sends a magic link (secret token) email to allow sign in with 


Trailing whitespace detected.

houndci-bot · 2017-12-18T13:08:21Z

app/mailers/passwordless/mailer.rb

 class Mailer < ActionMailer::Base
 default from: Passwordless.default_from_address
-
+


Trailing whitespace detected.

houndci-bot · 2017-12-18T13:08:21Z

app/controllers/passwordless/sessions_controller.rb

@@ -45,7 +58,11 @@ def show
 redirect_to main_app.root_path
 end
 end
-
+


Trailing whitespace detected.

houndci-bot · 2017-12-18T13:08:21Z

lib/passwordless/router_helpers.rb

+ # Generates passwordless routes for a Model that is connected to Passwordless.
+ # @param resource [Symbol] the pluralized symbol of your Model (e.g - :users).
+ # @param at [string] Optional - provide custom path (i.e controller) for routes (e.g "users").
+ # @param as [string] Optional - provide custom url for routes (e.g "special-users").


Line is too long. [88/80]

houndci-bot · 2017-12-18T13:08:21Z

lib/passwordless/router_helpers.rb

 module RouterHelpers
+ # Generates passwordless routes for a Model that is connected to Passwordless.
+ # @param resource [Symbol] the pluralized symbol of your Model (e.g - :users).
+ # @param at [string] Optional - provide custom path (i.e controller) for routes (e.g "users").


Line is too long. [98/80]

houndci-bot · 2017-12-18T13:08:21Z

lib/passwordless/router_helpers.rb

 module RouterHelpers
+ # Generates passwordless routes for a Model that is connected to Passwordless.
+ # @param resource [Symbol] the pluralized symbol of your Model (e.g - :users).


Line is too long. [82/80]

houndci-bot · 2017-12-18T13:08:22Z

lib/passwordless/router_helpers.rb

 module RouterHelpers
+ # Generates passwordless routes for a Model that is connected to Passwordless.


Line is too long. [82/80]

houndci-bot · 2017-12-18T13:08:22Z

lib/passwordless/model_helpers.rb

 module ModelHelpers
+ # Adds passwordless sign_in for SomeModel (examples: User, Admin). 


Trailing whitespace detected.

houndci-bot · 2017-12-18T13:08:22Z

lib/passwordless/controller_helpers.rb

@@ -1,7 +1,17 @@
 # frozen_string_literal: true

 module Passwordless
+ # Some helpers for controllers that are connected to passswordless Models. 


Trailing whitespace detected.

houndci-bot · 2017-12-18T13:08:22Z

app/models/passwordless/session.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true

 module Passwordless
- # The session responsible holding the connection between the record trying to
+ # The session responsible for holding the connection between the record trying to


Line is too long. [83/80]

houndci-bot · 2017-12-18T13:08:22Z

app/mailers/passwordless/mailer.rb

 class Mailer < ActionMailer::Base
 default from: Passwordless.default_from_address
-
+
+ # Sends a magic link (secret token) email to allow sign in with 


Trailing whitespace detected.

houndci-bot · 2017-12-18T13:08:23Z

app/mailers/passwordless/mailer.rb

 class Mailer < ActionMailer::Base
 default from: Passwordless.default_from_address
-
+


Trailing whitespace detected.

houndci-bot · 2017-12-18T13:08:23Z

app/controllers/passwordless/sessions_controller.rb

@@ -45,7 +58,11 @@ def show
 redirect_to main_app.root_path
 end
 end
-
+


Trailing whitespace detected.

mikker · 2017-12-18T13:10:47Z

You can check all those Hound warnings locally using $ rubocop in the project dir :)

mftaff · 2017-12-18T13:11:29Z

Awesome, good to know 😄
I will go fix 'em now.

mftaff · 2017-12-18T13:25:05Z

lib/passwordless/url_safe_base_64_generator.rb

 class UrlSafeBase64Generator
+ # Generates a url safe base64 secure random number. :-)
+ # @param _session [Object] some Object that contains this class.


@mikker I wasn't sure if I fully understood how to use this param. Maybe there is a better way to describe it?

We pass the session to the generator so that if you wanted to use it in any way in your custom token generator you can. Say your user has a name, you could make a custom generator that uses that for the tokens:

class NameTokenGenerator def self.call(session) "#{session.authenticatable.name}-gets-a-token" end end

Happens here:
https://github.com/mikker/passwordless/blob/master/app/models/passwordless/session.rb#L25

mftaff · 2017-12-18T13:27:24Z

lib/passwordless/router_helpers.rb

 module RouterHelpers
+ # Generates passwordless routes for any Model connected to Passwordless.
+ # @param resource [Symbol] the pluralized symbol of a Model (e.g - :users).
+ # @param at [string] Optional - provide custom path (i.e controller)


@mikker I also wasn't sure if I understood what could be provided for at and as.
Can you review these lines as well?

Perhaps it's best shown with examples:

passwordless_for :users, at: 'session_stuff', as: :user_session_things

The passwordless engine get's mounted at at, eg your urls end up like:

/session_stuff/sign_in

Your url helpers get scoped under as, eg in a view:

<%= link_to 'Sign in', user_session_things.sign_in_path %>

mftaff · 2017-12-19T10:35:30Z

@mikker Okay, I made those changes 😃 thanks for clarifying
How does it look now?
(I just realized that by amending to the old commit to keep the PR down to 1 commit means you can't easily see the new changes.... Whoops)

mikker · 2017-12-27T11:14:52Z

Merged in #7
Thank you for your help! 💙💚💛💜❤️

mftaff · 2017-12-27T11:20:23Z

😃 If I can ever be of service again, please feel free to reach out.

mikker · 2017-12-27T11:30:28Z

Sure, how about this: #8 😃
What do you think?

houndci-bot reviewed Dec 18, 2017

View reviewed changes

mftaff force-pushed the api-docs branch from afa55c9 to baad1dc Compare December 18, 2017 13:22

mftaff commented Dec 18, 2017

View reviewed changes

add YARD docs for all files in lib/ and app/

8b370a4

mftaff force-pushed the api-docs branch from baad1dc to 8b370a4 Compare December 19, 2017 10:33

mikker closed this Dec 27, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add YARD docs for all files in lib/ and app/ #6

add YARD docs for all files in lib/ and app/ #6

mftaff commented Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

houndci-bot Dec 18, 2017

mikker commented Dec 18, 2017

mftaff commented Dec 18, 2017

mftaff Dec 18, 2017

mikker Dec 18, 2017 •

edited

mftaff Dec 18, 2017

mikker Dec 18, 2017

mftaff commented Dec 19, 2017 •

edited

mikker commented Dec 27, 2017

mftaff commented Dec 27, 2017

mikker commented Dec 27, 2017

		module RouterHelpers
		# Generates passwordless routes for a Model that is connected to Passwordless.

		module ModelHelpers
		# Adds passwordless sign_in for SomeModel (examples: User, Admin).

		class Mailer < ActionMailer::Base
		default from: Passwordless.default_from_address

add YARD docs for all files in lib/ and app/ #6

add YARD docs for all files in lib/ and app/ #6

Conversation

mftaff commented Dec 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikker commented Dec 18, 2017

mftaff commented Dec 18, 2017

Choose a reason for hiding this comment

mikker Dec 18, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mftaff commented Dec 19, 2017 • edited

mikker commented Dec 27, 2017

mftaff commented Dec 27, 2017

mikker commented Dec 27, 2017

mikker Dec 18, 2017 •

edited

mftaff commented Dec 19, 2017 •

edited