bearonrails 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a0c39d4988e2e9e45e126ec557f211252f0eb19
-  data.tar.gz: 5caa57e31539ff3b00adeebf3d50b6e62eafec29
+  metadata.gz: 0ab9b0cc218afb82e132197cf4d762f32e65184d
+  data.tar.gz: 8ea90704fac6e625c04cd47e304401180d17beae
 SHA512:
-  metadata.gz: e0a85eea5229996a12e4e1527b0368bbae458feb441a5d1b7d8b886613caad730f47894c7aabe8636c20fec537fbb9ccea6168788f9e8d4198942639595ba46a
-  data.tar.gz: d85ada2a623d59cffc0f16f53ce4122d1284bf2e02820ee5e00de2a84b395da1829371cd2493d2622bfaee1fee6a57a6e3e806894fb6a5aec375d41604a3b772
+  metadata.gz: 28b36dfee3ae5faced2580eaca83709a39678a48718c007cb4b802a45f9b7e0eb894c70b15c70069e942d59a4103469184285704d7fd48a202ebde6574fb4a6e
+  data.tar.gz: 971d2eb6a96b8cf0d06e64aba0850ba1c12ebdbcc1202b8406830fb9c11aa13fc0b07a48b14136731efca272b3df5449c8182123c5d872006ea15989a39e2bc9

data/README.md

@@ -1,5 +1,8 @@
 # Bearonrails
 
+[![RubyGems][gem_version_badge]][ruby_gems]
+[![RubyGems][gem_downloads_badge]][ruby_gems]
+
 Bearonrails is the base Rails application generator.(For Rails 4.2+)
 
 ## Installation
@@ -12,31 +15,77 @@ Then run:
 
     $ bearonrails project_name
 
+## New Relic
+
+For New Relic, edit `.env`, set New Relic License key to `NEW_RELIC_LICENSE_KEY`
+
+```shell
+NEW_RELIC_APP_NAME=change-this-to-your-app-name
+NEW_RELIC_LICENSE_KEY=change-this-to-your-new-relic-license-key
+
+```
+
+## Rubocop
+
+For code style, edit `.rubocop.yml` to customize coding style rules. See sample(https://github.com/bbatsov/rubocop/blob/master/config/default.yml).
+
+You could integrate your editor with rubocop, see [rubocop editor-integration](https://github.com/bbatsov/rubocop#editor-integration).
+
+## Dotenv
+
+Use `.env` to manage environment varibales. And load environment varibales set in `.env` file when Rails Application start.
+
+See `config/application.rb`
+
+```
+# Added this line
+Dotenv.load
+```
+
 ## Gems
 
-* [pry-rails](https://github.com/rweng/pry-rails)
-* [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug)
-* [awesome_print](https://github.com/michaeldv/awesome_print)
-* [hirb](https://github.com/cldwalker/hirb)
-* [hirb-unicode](https://github.com/miaout17/hirb-unicode)
-* [better_errors](https://github.com/charliesome/better_errors)
-* [binding_of_caller](https://github.com/banister/binding_of_caller)
+#### Rails console
+
+* [awesome_rails_console](https://github.com/michaeldv/awesome_print)
+  * [pry-rails](https://github.com/rweng/pry-rails)
+  * [pry-byebug](https://github.com/deivid-rodriguez/pry-byebug)
+  * [awesome_print](https://github.com/michaeldv/awesome_print)
+  * [hirb](https://github.com/cldwalker/hirb)
+  * [hirb-unicode](https://github.com/miaout17/hirb-unicode)
+
+#### Developing
+
 * [quiet_assets](https://github.com/evrone/quiet_assets)
 * [capistrano-rails](https://github.com/capistrano/rails/)
 * [capistrano-bundler](https://github.com/capistrano/bundler/)
+
+#### Coding Style
+
 * [rubocop](https://github.com/bbatsov/rubocop)
 * [brakeman](https://github.com/presidentbeef/brakeman)
+
+#### Testing
+
 * [rspec-rails](https://github.com/rspec/rspec-rails)
 * [database_cleaner](https://github.com/DatabaseCleaner/database_cleaner)
 * [factory_girl_rails](https://github.com/thoughtbot/factory_girl_rails)
 * [faker](https://github.com/stympy/faker)
 
+#### Environment
+
+* [dotenv](https://github.com/bkeepers/dotenv)
+
+#### Metric
+
+* [newrelic_rpm](https://github.com/newrelic/rpm)
+
 ## Reference:
 
 [xdite/bootstrappers](https://github.com/xdite/bootstrappers)
 
 [超棒的 rails console 設定](http://toyroom.bruceli.net/tw/2014/08/13/awesome-rails-console-customization-using-pry.html)
 
+[Rails Application Template Guide](http://guides.rubyonrails.org/rails_application_templates.html)
 
 ## MIT License
 

data/lib/bearonrails/app_builder.rb

@@ -24,6 +24,26 @@ module Bearonrails
       copy_file '.rubocop.yml', '.rubocop.yml'
     end
 
+    def add_new_relic_config
+      copy_file 'config/newrelic.yml', 'config/newrelic.yml'
+
+      replace_in_file(
+        '.env',
+        /change-this-to-your-app-name/m,
+        "#{app_name}"
+      )
+    end
+
+    def add_dot_env
+      copy_file '.env', '.env'
+
+      inject_into_file(
+        'config/application.rb',
+        "Dotenv.load\n\n",
+        before: /^module/
+      )
+    end
+
     def install_rspec
       run 'bundle exec rails g rspec:install'
     end
@@ -46,14 +66,6 @@ module Bearonrails
       )
     end
 
-    def add_pryrc
-      copy_file '.pryrc', '.pryrc'
-    end
-
-    def add_pry_config
-      copy_file 'config/initializers/pry.rb', 'config/initializers/pry.rb'
-    end
-
     private
 
     def replace_in_file(relative_path, find, replace)

data/lib/bearonrails/generators/app_generator.rb

@@ -16,7 +16,7 @@ module Bearonrails
       invoke :customize_gemfile
       invoke :install_rspec
       invoke :add_rubocop_config
-      invoke :add_pry_config
+      invoke :add_new_relic_config
       invoke :remove_routes_comment_lines
       invoke :init_git
     end
@@ -35,6 +35,11 @@ module Bearonrails
     def customize_gemfile
       build :add_custom_gems
       bundle_command 'install'
+
+      # skip origin `bundle install` step
+      new_options = options.dup
+      options = new_options
+      options.merge!(skip_bundle: true)
     end
 
     def add_rubocop_config
@@ -42,10 +47,10 @@ module Bearonrails
       build :add_rubocop_config
     end
 
-    def add_pry_config
-      say 'Add pry config'
-      build :add_pryrc
-      build :add_pry_config
+    def add_new_relic_config
+      say 'Add New Relic config'
+      build :add_dot_env
+      build :add_new_relic_config
     end
 
     def install_rspec

data/lib/bearonrails/version.rb

@@ -1,4 +1,4 @@
 #
 module Bearonrails
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/templates/.env

@@ -0,0 +1,2 @@
+NEW_RELIC_APP_NAME=change-this-to-your-app-name
+NEW_RELIC_LICENSE_KEY=change-this-to-your-new-relic-license-key

data/templates/Gemfile_additions

@@ -1,26 +1,26 @@
 
-gem 'pry-rails'
-gem 'pry-byebug'
-gem 'awesome_print', :require => false
-
-group :development, :test do
-  gem 'hirb', :require => false
-  gem 'hirb-unicode', :require => false
-end
-
 group :development do
-  gem 'better_errors'
-  gem 'binding_of_caller'
   gem 'quiet_assets'
+
   gem 'capistrano-rails'
   gem 'capistrano-bundler'
+
   gem 'rubocop', require: false
   gem 'brakeman', require: false
 end
 
+# use rspec to test
 group :test do
   gem 'rspec-rails'
   gem 'database_cleaner'
   gem 'factory_girl_rails'
   gem 'faker'
 end
+
+# environment
+gem 'dotenv'
+
+# new relic agent
+gem 'newrelic_rpm'
+
+gem 'awesome_rails_console'

data/templates/config/newrelic.yml

@@ -0,0 +1,221 @@
+#
+# This file configures the New Relic Agent.  New Relic monitors Ruby, Java,
+# .NET, PHP, Python and Node applications with deep visibility and low
+# overhead.  For more information, visit www.newrelic.com.
+
+
+# Here are the settings that are common to all environments
+common: &default_settings
+  # ============================== LICENSE KEY ===============================
+
+  # You must specify the license key associated with your New Relic
+  # account.  This key binds your Agent's data to your account in the
+  # New Relic service.
+  license_key: <%= ENV['NEW_RELIC_LICENSE_KEY'] %>
+
+  # Agent Enabled (Ruby/Rails Only)
+  # Use this setting to force the agent to run or not run.
+  # Default is 'auto' which means the agent will install and run only
+  # if a valid dispatcher such as Mongrel is running.  This prevents
+  # it from running with Rake or the console.  Set to false to
+  # completely turn the agent off regardless of the other settings.
+  # Valid values are true, false and auto.
+  #
+  # agent_enabled: auto
+
+  # Application Name Set this to be the name of your application as
+  # you'd like it show up in New Relic. The service will then auto-map
+  # instances of your application into an "application" on your
+  # dashboard page. If you want to map this instance into multiple
+  # apps, like "AJAX Requests" and "All UI" then specify a semicolon
+  # separated list of up to three distinct names, or a yaml list.
+  # Defaults to the capitalized RAILS_ENV or RACK_ENV (i.e.,
+  # Production, Staging, etc)
+  #
+  # Example:
+  #
+  #   app_name:
+  #       - Ajax Service
+  #       - All Services
+  #
+  # Caution: If you change this name, a new application will appear in the New
+  # Relic user interface with the new name, and data will stop reporting to the
+  # app with the old name.
+  #
+  # See https://newrelic.com/docs/site/renaming-applications for more details
+  # on renaming your New Relic applications.
+  #
+  app_name: <%= ENV['NEW_RELIC_APP_NAME'] %>
+
+  # When "true", the agent collects performance data about your
+  # application and reports this data to the New Relic service at
+  # newrelic.com. This global switch is normally overridden for each
+  # environment below. (formerly called 'enabled')
+  monitor_mode: true
+
+  # Developer mode should be off in every environment but
+  # development as it has very high overhead in memory.
+  developer_mode: false
+
+  # The newrelic agent generates its own log file to keep its logging
+  # information separate from that of your application. Specify its
+  # log level here.
+  log_level: info
+
+  # Optionally set the path to the log file This is expanded from the
+  # root directory (may be relative or absolute, e.g. 'log/' or
+  # '/var/log/') The agent will attempt to create this directory if it
+  # does not exist.
+  # log_file_path: 'log'
+
+  # Optionally set the name of the log file, defaults to 'newrelic_agent.log'
+  # log_file_name: 'newrelic_agent.log'
+
+  # The newrelic agent communicates with the service via https by default.  This
+  # prevents eavesdropping on the performance metrics transmitted by the agent.
+  # The encryption required by SSL introduces a nominal amount of CPU overhead,
+  # which is performed asynchronously in a background thread.  If you'd prefer
+  # to send your metrics over http uncomment the following line.
+  # ssl: false
+
+  #============================== Browser Monitoring ===============================
+  # New Relic Real User Monitoring gives you insight into the performance real users are
+  # experiencing with your website. This is accomplished by measuring the time it takes for
+  # your users' browsers to download and render your web pages by injecting a small amount
+  # of JavaScript code into the header and footer of each page.
+  browser_monitoring:
+      # By default the agent automatically injects the monitoring JavaScript
+      # into web pages. Set this attribute to false to turn off this behavior.
+      auto_instrument: true
+
+  # Proxy settings for connecting to the New Relic server.
+  #
+  # If a proxy is used, the host setting is required.  Other settings
+  # are optional. Default port is 8080.
+  #
+  # proxy_host: hostname
+  # proxy_port: 8080
+  # proxy_user:
+  # proxy_pass:
+
+  # The agent can optionally log all data it sends to New Relic servers to a
+  # separate log file for human inspection and auditing purposes. To enable this
+  # feature, change 'enabled' below to true.
+  # See: https://newrelic.com/docs/ruby/audit-log
+  audit_log:
+    enabled: false
+
+  # Tells transaction tracer and error collector (when enabled)
+  # whether or not to capture HTTP params.  When true, frameworks can
+  # exclude HTTP parameters from being captured.
+  # Rails: the RoR filter_parameter_logging excludes parameters
+  # Java: create a config setting called "ignored_params" and set it to
+  #     a comma separated list of HTTP parameter names.
+  #     ex: ignored_params: credit_card, ssn, password
+  capture_params: false
+
+  # Transaction tracer captures deep information about slow
+  # transactions and sends this to the New Relic service once a
+  # minute. Included in the transaction is the exact call sequence of
+  # the transactions including any SQL statements issued.
+  transaction_tracer:
+
+    # Transaction tracer is enabled by default. Set this to false to
+    # turn it off. This feature is only available at the Professional
+    # and above product levels.
+    enabled: true
+
+    # Threshold in seconds for when to collect a transaction
+    # trace. When the response time of a controller action exceeds
+    # this threshold, a transaction trace will be recorded and sent to
+    # New Relic. Valid values are any float value, or (default) "apdex_f",
+    # which will use the threshold for an dissatisfying Apdex
+    # controller action - four times the Apdex T value.
+    transaction_threshold: apdex_f
+
+    # When transaction tracer is on, SQL statements can optionally be
+    # recorded. The recorder has three modes, "off" which sends no
+    # SQL, "raw" which sends the SQL statement in its original form,
+    # and "obfuscated", which strips out numeric and string literals.
+    record_sql: obfuscated
+
+    # Threshold in seconds for when to collect stack trace for a SQL
+    # call. In other words, when SQL statements exceed this threshold,
+    # then capture and send to New Relic the current stack trace. This is
+    # helpful for pinpointing where long SQL calls originate from.
+    stack_trace_threshold: 0.500
+
+    # Determines whether the agent will capture query plans for slow
+    # SQL queries.  Only supported in mysql and postgres.  Should be
+    # set to false when using other adapters.
+    # explain_enabled: true
+
+    # Threshold for query execution time below which query plans will
+    # not be captured.  Relevant only when `explain_enabled` is true.
+    # explain_threshold: 0.5
+
+  # Error collector captures information about uncaught exceptions and
+  # sends them to New Relic for viewing
+  error_collector:
+
+    # Error collector is enabled by default. Set this to false to turn
+    # it off. This feature is only available at the Professional and above
+    # product levels.
+    enabled: true
+
+    # To stop specific errors from reporting to New Relic, set this property
+    # to comma-separated values.  Default is to ignore routing errors,
+    # which are how 404's get triggered.
+    ignore_errors: "ActionController::RoutingError,Sinatra::NotFound"
+
+  # If you're interested in capturing memcache keys as though they
+  # were SQL uncomment this flag. Note that this does increase
+  # overhead slightly on every memcached call, and can have security
+  # implications if your memcached keys are sensitive
+  # capture_memcache_keys: true
+
+# Application Environments
+# ------------------------------------------
+# Environment-specific settings are in this section.
+# For Rails applications, RAILS_ENV is used to determine the environment.
+# For Java applications, pass -Dnewrelic.environment <environment> to set
+# the environment.
+
+# NOTE if your application has other named environments, you should
+# provide newrelic configuration settings for these environments here.
+
+development:
+  <<: *default_settings
+  # Turn on communication to New Relic service in development mode
+  monitor_mode: true
+  app_name: <%= ENV['NEW_RELIC_APP_NAME'] %> (Development)
+
+  # Rails Only - when running in Developer Mode, the New Relic Agent will
+  # present performance information on the last 100 transactions you have
+  # executed since starting the mongrel.
+  # NOTE: There is substantial overhead when running in developer mode.
+  # Do not use for production or load testing.
+  developer_mode: true
+
+test:
+  <<: *default_settings
+  # It almost never makes sense to turn on the agent when running
+  # unit, functional or integration tests or the like.
+  monitor_mode: false
+
+# Turn on the agent in production for 24x7 monitoring. NewRelic
+# testing shows an average performance impact of < 5 ms per
+# transaction, you can leave this on all the time without
+# incurring any user-visible performance degradation.
+production:
+  <<: *default_settings
+  monitor_mode: true
+  app_name: <%= ENV['NEW_RELIC_APP_NAME'] %> (Production)
+
+# Many applications have a staging environment which behaves
+# identically to production. Support for that environment is provided
+# here.  By default, the staging environment has the agent turned on.
+staging:
+  <<: *default_settings
+  monitor_mode: true
+  app_name: <%= ENV['NEW_RELIC_APP_NAME'] %> (Staging)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bearonrails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - timfanda35
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -50,10 +50,10 @@ files:
 - lib/bearonrails/app_builder.rb
 - lib/bearonrails/generators/app_generator.rb
 - lib/bearonrails/version.rb
-- templates/.pryrc
+- templates/.env
 - templates/.rubocop.yml
 - templates/Gemfile_additions
-- templates/config/initializers/pry.rb
+- templates/config/newrelic.yml
 - templates/spec/rails_helper_addon
 - templates/tasks/dev.rake
 homepage: https://github.com/timfanda35/bearonrails

data/templates/.pryrc

@@ -1,21 +0,0 @@
-require "awesome_print"
-AwesomePrint.pry!
-
-begin
-  require "hirb"
-  require "hirb-unicode"
-  extend Hirb::Console
-rescue LoadError => e
-end
-
-if defined?(PryByebug)
-  Pry.commands.alias_command 'c', 'continue'
-  Pry.commands.alias_command 's', 'step'
-  Pry.commands.alias_command 'n', 'next'
-  Pry.commands.alias_command 'f', 'finish'
-end
-
-# Hit Enter to repeat last command
-Pry::Commands.command /^$/, "repeat last command" do
-  _pry_.run_command Pry.history.to_a.last
-end

data/templates/config/initializers/pry.rb

@@ -1,24 +0,0 @@
-## config/initializers/pry.rb
-## encoding: utf-8
-## 預設的 prompt_name 是 pry，下面這行會把 prompt_name 變成該 project 的名稱 (自動抓)
-Pry.config.prompt_name = Rails.application.class.parent_name.underscore.dasherize
-
-unless Rails.env.development?
-  old_prompt = Pry.config.prompt
-
-  if Rails.env.production?
-    # 這邊本來應該是 Pry::Helpers::Text.red(Rails.env.upcase)
-    #   相當於 "\e[0;31m#{Rails.env.upcase}\e[0m"
-    #   但因為一個 readline 引起的 bug 導致輸入游標錯位，因此需加上 \001 \002 來跳過此問題，下同
-    #   此問題的討論串在 https://github.com/pry/pry/issues/493
-    env = "\001\e[0;31m\002#{Rails.env.upcase}\001\e[0m\002" # 紅色 的 env 名稱
-  else
-    env = "\001\e[0;33m\002#{Rails.env.upcase}\001\e[0m\002" # 黃色 的 env 名稱
-  end
-
-  # 替換 pry prompt 的方法在 https://github.com/pry/pry/wiki/Customization-and-configuration#Config_prompt 有教學
-  Pry.config.prompt = [
-    proc { |*a| "#{env} #{old_prompt.first.call(*a)}"  },
-    proc { |*a| "#{env} #{old_prompt.second.call(*a)}" }
-  ]
-end