awesome_rails_console 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 3b21ae5b1489bf38e1ab61738d799ff4f87040c2
4
+ data.tar.gz: 86be896318ce17f05305cf43c0faddd29c9f4f21
5
+ SHA512:
6
+ metadata.gz: 8b27511eb5f8655ae87957705bdc0a19ac4c19e01b556c4f11d892cdc8640cd9c7a33f5562b37c0e2c3c2534c39493b797daae9756ccdcae2c64d3f23347d337
7
+ data.tar.gz: 4fd367f0354ca88da57718e0a20f527e7a59b15183916f4151ee7e71aed18121066e6d19604e4c1331db5ca6c193d150b994634f1027c15fb3ede2df901bbcaa
data/.gitignore ADDED
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
data/.travis.yml ADDED
@@ -0,0 +1,3 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.1
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in awesome_rails_console.gemspec
4
+ gemspec
data/README.md ADDED
@@ -0,0 +1,89 @@
1
+ # AwesomeRailsConsole
2
+
3
+ This gem was inspired by [Using pry in production](https://bugsnag.com/blog/production-pry), [jazz_hands](https://github.com/nixme/jazz_hands) and [jazz_fingers](https://github.com/plribeiro3000/jazz_fingers).
4
+
5
+ The pros of AwesomeRailsConsole are:
6
+
7
+ * Less gem dependances (Require infrequent used gems only when you want it)
8
+ * Simpler prompt modification (More like the default pry prompt you're familiar with)
9
+ * No configurable options at all (You don't need to worry about configuration)
10
+
11
+ > If you really want to do a lot of customization. You may consider just editing your `Gemfile`, `.pryrc` and `config/initializers/pry.rb`. Or fork this project.
12
+
13
+ ## Features
14
+
15
+ ### Show Rails env and project name in the prompt
16
+
17
+ Prevents you from accidentally changing production data to the wrong project.
18
+
19
+ ![](http://i.imgur.com/fVDu0Oj.png)
20
+
21
+ ### Beautiful formatting with pry and awesome_print
22
+
23
+ Make it easy to read. Reduce the pain while debugging.
24
+
25
+ ```ruby
26
+ # Try following statements in rails console:
27
+ [:apple, :orange, :banana]
28
+ { a: 1, b: 2, c: 3 }
29
+ 1.methods
30
+ (1..100).to_a
31
+ ap (1..100).to_a, limit: 5
32
+ ```
33
+
34
+ ![](http://i.imgur.com/I5zE8Jp.png)
35
+
36
+ ### Print ascii table with Hirb
37
+
38
+ Helpful for exporting a set of records for documenting.
39
+
40
+ > This only works in development and test mode.
41
+
42
+ ```ruby
43
+ extend Hirb::Console # include the `table` statement
44
+ Hirb::View.resize # resize to your terminal window size
45
+
46
+ table [1, 2, 3]
47
+ table User.last(3), markdown: true
48
+ ```
49
+
50
+ ![](http://i.imgur.com/KRqvaBA.png)
51
+
52
+ ### More
53
+
54
+ This gem depends on following gems. Thus you can use all functionalities they provide.
55
+
56
+ * pry-rails
57
+ * pry-debugger / pry-byebug (depending on your ruby version)
58
+ * pry-stack_explorer
59
+ * awesome_print
60
+ * hirb
61
+ * hirb-unicode
62
+
63
+ ## Installation
64
+
65
+ Add this line to your application's Gemfile:
66
+
67
+ ```ruby
68
+ gem 'awesome_rails_console'
69
+ ```
70
+
71
+ And then execute:
72
+
73
+ $ bundle
74
+
75
+ And restart your rails console.
76
+
77
+ ## Development
78
+
79
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
80
+
81
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
82
+
83
+ ## Contributing
84
+
85
+ 1. Fork it ( https://github.com/ascendbruce/awesome_rails_console/fork )
86
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
87
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
88
+ 4. Push to the branch (`git push origin my-new-feature`)
89
+ 5. Create a new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,41 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'awesome_rails_console/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "awesome_rails_console"
8
+ spec.version = AwesomeRailsConsole::VERSION
9
+ spec.authors = ["Bruce Li"]
10
+ spec.email = ["ascendbruce@gmail.com"]
11
+
12
+ spec.summary = %q{Simple and useful rails console enhancements}
13
+ spec.description = %q{Enhance rails console by using awesome_print, pry and several pry plugins. And useful prompt tweaks. Makes rails console awesome by default.}
14
+ spec.homepage = "https://github.com/ascendbruce/awesome_rails_console"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
17
+ spec.bindir = "exe"
18
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
19
+ spec.require_paths = ["lib"]
20
+
21
+ # Runtime dependencies
22
+ spec.add_dependency "railties"
23
+ spec.add_dependency "pry-rails"
24
+ spec.add_dependency "awesome_print"
25
+
26
+ # Following are only required in development and test mode (in lib/awesome_rails_console/railtie.rb)
27
+ spec.add_dependency "pry-stack_explorer"
28
+ spec.add_dependency "hirb"
29
+ spec.add_dependency "hirb-unicode"
30
+
31
+ if RUBY_VERSION > "2"
32
+ spec.add_dependency "pry-byebug"
33
+ else
34
+ spec.add_dependency "pry-debugger"
35
+ end
36
+
37
+ # gem development dependency
38
+ spec.add_development_dependency "bundler", "~> 1.9"
39
+ spec.add_development_dependency "rake", "~> 10.0"
40
+ spec.add_development_dependency "rspec", "~> 3.2"
41
+ end
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "awesome_rails_console"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
data/bin/setup ADDED
@@ -0,0 +1,7 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+
5
+ bundle install
6
+
7
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,58 @@
1
+ require "pry-rails"
2
+ require "awesome_print"
3
+
4
+ if Rails.env.development? || Rails.env.test?
5
+ require "pry-stack_explorer"
6
+ require "hirb"
7
+ require "hirb-unicode"
8
+
9
+ if RUBY_VERSION > "2"
10
+ require "pry-byebug"
11
+ else
12
+ require "pry-debugger"
13
+ end
14
+ end
15
+
16
+ module AwesomeRailsConsole
17
+ class Railtie < Rails::Railtie
18
+ initializer "awesome_rails_console.initialize" do |app|
19
+ disables_pry_plugin_loading
20
+ use_awesome_print_for_formatting
21
+ set_prompt_name_to_project_name
22
+ show_rails_env_name_before_prompt
23
+ end
24
+
25
+ private
26
+
27
+ def disables_pry_plugin_loading
28
+ Pry.config.should_load_plugins = false
29
+ end
30
+
31
+ def use_awesome_print_for_formatting
32
+ AwesomePrint.pry!
33
+ end
34
+
35
+ def set_prompt_name_to_project_name
36
+ Pry.config.prompt_name = Rails.application.class.parent_name.underscore.dasherize
37
+ end
38
+
39
+ def show_rails_env_name_before_prompt
40
+ old_prompt = Pry.config.prompt
41
+
42
+ # TODO: Change to Pry::Helpers::Text.red/red/yellow(...) someday.
43
+ # See https://github.com/pry/pry/issues/493 for detail.
44
+ env = if Rails.env.production?
45
+ "\001\e[0;31m\002#{Rails.env.upcase}\001\e[0m\002"
46
+ elsif Rails.env.development?
47
+ "\001\e[0;32m\002#{Rails.env.upcase}\001\e[0m\002"
48
+ else
49
+ "\001\e[0;33m\002#{Rails.env.upcase}\001\e[0m\002"
50
+ end
51
+
52
+ Pry.config.prompt = [
53
+ proc { |*a| "#{env} #{old_prompt.first.call(*a)}" },
54
+ proc { |*a| "#{env} #{old_prompt.second.call(*a)}" }
55
+ ]
56
+ end
57
+ end
58
+ end
@@ -0,0 +1,3 @@
1
+ module AwesomeRailsConsole
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,2 @@
1
+ require "awesome_rails_console/version"
2
+ require "awesome_rails_console/railtie" if defined?(Rails)
metadata ADDED
@@ -0,0 +1,196 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: awesome_rails_console
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Bruce Li
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2015-05-02 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: railties
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ">="
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ">="
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
27
+ - !ruby/object:Gem::Dependency
28
+ name: pry-rails
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: awesome_print
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - ">="
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :runtime
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: pry-stack_explorer
57
+ requirement: !ruby/object:Gem::Requirement
58
+ requirements:
59
+ - - ">="
60
+ - !ruby/object:Gem::Version
61
+ version: '0'
62
+ type: :runtime
63
+ prerelease: false
64
+ version_requirements: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - ">="
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ - !ruby/object:Gem::Dependency
70
+ name: hirb
71
+ requirement: !ruby/object:Gem::Requirement
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ version: '0'
76
+ type: :runtime
77
+ prerelease: false
78
+ version_requirements: !ruby/object:Gem::Requirement
79
+ requirements:
80
+ - - ">="
81
+ - !ruby/object:Gem::Version
82
+ version: '0'
83
+ - !ruby/object:Gem::Dependency
84
+ name: hirb-unicode
85
+ requirement: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ type: :runtime
91
+ prerelease: false
92
+ version_requirements: !ruby/object:Gem::Requirement
93
+ requirements:
94
+ - - ">="
95
+ - !ruby/object:Gem::Version
96
+ version: '0'
97
+ - !ruby/object:Gem::Dependency
98
+ name: pry-byebug
99
+ requirement: !ruby/object:Gem::Requirement
100
+ requirements:
101
+ - - ">="
102
+ - !ruby/object:Gem::Version
103
+ version: '0'
104
+ type: :runtime
105
+ prerelease: false
106
+ version_requirements: !ruby/object:Gem::Requirement
107
+ requirements:
108
+ - - ">="
109
+ - !ruby/object:Gem::Version
110
+ version: '0'
111
+ - !ruby/object:Gem::Dependency
112
+ name: bundler
113
+ requirement: !ruby/object:Gem::Requirement
114
+ requirements:
115
+ - - "~>"
116
+ - !ruby/object:Gem::Version
117
+ version: '1.9'
118
+ type: :development
119
+ prerelease: false
120
+ version_requirements: !ruby/object:Gem::Requirement
121
+ requirements:
122
+ - - "~>"
123
+ - !ruby/object:Gem::Version
124
+ version: '1.9'
125
+ - !ruby/object:Gem::Dependency
126
+ name: rake
127
+ requirement: !ruby/object:Gem::Requirement
128
+ requirements:
129
+ - - "~>"
130
+ - !ruby/object:Gem::Version
131
+ version: '10.0'
132
+ type: :development
133
+ prerelease: false
134
+ version_requirements: !ruby/object:Gem::Requirement
135
+ requirements:
136
+ - - "~>"
137
+ - !ruby/object:Gem::Version
138
+ version: '10.0'
139
+ - !ruby/object:Gem::Dependency
140
+ name: rspec
141
+ requirement: !ruby/object:Gem::Requirement
142
+ requirements:
143
+ - - "~>"
144
+ - !ruby/object:Gem::Version
145
+ version: '3.2'
146
+ type: :development
147
+ prerelease: false
148
+ version_requirements: !ruby/object:Gem::Requirement
149
+ requirements:
150
+ - - "~>"
151
+ - !ruby/object:Gem::Version
152
+ version: '3.2'
153
+ description: Enhance rails console by using awesome_print, pry and several pry plugins.
154
+ And useful prompt tweaks. Makes rails console awesome by default.
155
+ email:
156
+ - ascendbruce@gmail.com
157
+ executables: []
158
+ extensions: []
159
+ extra_rdoc_files: []
160
+ files:
161
+ - ".gitignore"
162
+ - ".rspec"
163
+ - ".travis.yml"
164
+ - Gemfile
165
+ - README.md
166
+ - Rakefile
167
+ - awesome_rails_console.gemspec
168
+ - bin/console
169
+ - bin/setup
170
+ - lib/awesome_rails_console.rb
171
+ - lib/awesome_rails_console/railtie.rb
172
+ - lib/awesome_rails_console/version.rb
173
+ homepage: https://github.com/ascendbruce/awesome_rails_console
174
+ licenses: []
175
+ metadata: {}
176
+ post_install_message:
177
+ rdoc_options: []
178
+ require_paths:
179
+ - lib
180
+ required_ruby_version: !ruby/object:Gem::Requirement
181
+ requirements:
182
+ - - ">="
183
+ - !ruby/object:Gem::Version
184
+ version: '0'
185
+ required_rubygems_version: !ruby/object:Gem::Requirement
186
+ requirements:
187
+ - - ">="
188
+ - !ruby/object:Gem::Version
189
+ version: '0'
190
+ requirements: []
191
+ rubyforge_project:
192
+ rubygems_version: 2.4.5
193
+ signing_key:
194
+ specification_version: 4
195
+ summary: Simple and useful rails console enhancements
196
+ test_files: []