Skip to content

Fix README #494

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Jul 25, 2017
Merged

Fix README #494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7096719
Fix InstallGenerator to require annotate
yhirano55 Jul 25, 2017
45200d8
Fix README
yhirano55 Jul 25, 2017
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
4 changes: 2 additions & 2 deletions README.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,11 @@ Also, if you pass the -r option, it'll annotate routes.rb with the output of

Into Gemfile from rubygems.org:

gem 'annotate'
gem 'annotate', require: false

Into Gemfile from Github:

gem 'annotate', git: 'https://github.com/ctran/annotate_models.git'
gem 'annotate', github: 'ctran/annotate_models', require: false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will cause an non-secure warning, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This block is which was declared on the top of Gemfile:

git_source(:github) {|repo_name| "https://github.com/#{repo_name}.git" }

Its a workaround for a bug in Bundler which can cause sources from github to loaded via HTTP and not HTTPS - which makes it vulnerable to man in the middle attacks. We'll usually not remove it.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for pointing this out to me. The short form doesn't seem to gain us much and has a security downside. I would rather use the longer form in this case.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I see. I'll fix it, soon.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yhirano55 don't worry about it, I already started #496.


Into environment gems from rubygems.org:

Expand Down
4 changes: 3 additions & 1 deletion lib/generators/annotate/install_generator.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
require 'annotate'

module Annotate
module Generators
class InstallGenerator < Rails::Generators::Base
desc 'Copy annotate_models rakefiles for automatic annotation'
source_root File.expand_path('../templates', __FILE__)
source_root File.expand_path('templates', __dir__)

# copy rake tasks
def copy_tasks
Expand Down