marco-polo 0.1.1 → 1.0.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjhlMmIwZmY2Yzc4N2JiZTBmYTBlMDRmZDIzY2Q4YmM4ZmUyODJmMg==
+    OGY1Yjg3YTMxYjU1MmQxMTAzNGZlMGY4ZjRmZTkwNTY2Y2NiMjY5NA==
   data.tar.gz: !binary |-
-    YTdiZjNiY2MwZTVhMGRjMjVhZTVhYWJiYWRmNWQxMDc5NDI4ZGI3Zg==
+    OTE3OWM2ZWY4YmNmZjVkYzU0MWM2OTAzMmFlOTBhZjZiOTg1ODk1Yg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZTk5YmI5MjNjNjJhY2NhMTc2YmVjNzlkNjM4NjQzMzRiYzkxMDdjN2NlNmNl
-    MzdmOGM3NmQ2YzE5ZTE3MWU3ZDliZGJlMmY0NjM1NGM2YjY2ZGIwMGJlYzUz
-    YjRjNTRjZmFhMjQ5MzBiM2M2ODI2NjkzM2JlYmY3YWYzOWY4MDg=
+    ZTc1NGZiZTU5YmViOWUwNmNiMDE3NmMxODhlNzMzZmQ0NWVhYjY1NWJhMTEw
+    ODg0YjQxOTlhMDNkOGRlNzRhNmM5NTVjZTkwMTE1OGU2NDk3NGE3OGUyNjJk
+    ODA5NDYyNDhjNTI0ZDg0MTA5YzlhNTVhNGY3NjY1YmY0NjAwNGM=
   data.tar.gz: !binary |-
-    NGRjNzYzMTdjODA1OTEwMGQxNDgwOGIzZmM2NmViNGY0MWEwODkwNTQ4YTcw
-    NWI0YTIzNGNkYzE0NzBmNzRkMDUzODkxNThlMjhiZWJjMDU2NjkwMjQ2ZmYy
-    MmI5YmFhYTRkMjg4ZDJjNGE4OTA1N2FhMzA0YzlhZWM3YTI1Mjg=
+    ODg1ZGU4MTUwYzc1YjY3YmE4NmI0YzMzNDM5ZWYzNWI5YmFiMWRhODdiMmEy
+    NjdhMTk0ZGJmZjczY2MxMDQ3YTUwZGYzNDg2YjE0YTIwZjkwMWE1MWIyYzVm
+    NTg2MzFlOThjYzA2YWU4N2I4ZmJkNTNhY2U2YzQxNDgxNjRmMDQ=

data/README.md

@@ -0,0 +1,64 @@
+# marco-polo
+
+MarcoPolo shows your app name and environment in your console prompt so you don't accidentally break production
+
+## Installation
+
+    In your Gemfile: gem "marco-polo", "~> 0.1.0"
+    $ bundle install
+  
+## Usage
+
+There's nothing to do! Just install the gem and bask in your newfound console security.
+
+Before marco-polo:
+
+    ~/Sites/myapp$ rails c
+    >
+
+    ~/Sites/myapp$ heroku run console -a myapp
+    >
+
+After marco-polo: 
+
+    ~/Sites/myapp$ rails c
+    myapp(dev)>
+  
+    ~/Sites/myapp$ heroku run console -a myapp
+    myapp(prod)>
+
+## Help!
+
+So far this has been verified on:
+
+    Ruby Version | Rails Version
+    -------------|---------------
+    1.9.3        | 3.2           
+                 | 4.0
+    2.0.0        | 3.2
+                 | 4.0
+
+If you're using it with different versions please let me know so we can
+fill out this table. Tweet me @archslide or submit a PR to update this README.
+If it doesn't work for you please file a bug instead. Thanks everyone!
+
+## Secret Feature: custom .irbrc
+
+The central mechanism of marco-polo is adding a `require` flag to the rails command that's starting IRB,
+using it to require a file that changes the prompt. It will also let you load your own irbrc, to set up
+any console tools you like! And since this file is required after your app is required, you can use all
+your app objects inside it.
+
+For example, one of my projects uses the sentient_user gem to help assign
+actors to all our papertrail events. Papertrail works great in my app code, but I always forget
+to set User.current when I'm in the console. Solution? Prompt myself to "log in" when my console
+loads.
+
+    print "Who are you? "
+    email = gets.chomp.downcase
+    user = User.find_by_email(email)
+    user.make_current
+    PaperTrail.whodunnit = user
+
+This code lives in a file called `.irbrc.rb` in my project root and is automatically loaded into my console
+by marco-polo.

data/lib/marco-polo/version.rb

@@ -1,3 +1,3 @@
 module MarcoPolo
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marco-polo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris Doyle
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-09 00:00:00.000000000 Z
+date: 2013-11-15 00:00:00.000000000 Z
 dependencies: []
 description: MarcoPolo shows your app name and environment in your console prompt
   so you don't accidentally break production
@@ -17,7 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.rdoc
+- README.md
 - lib/marco-polo.rb
 - lib/marco-polo/marco-polo.irbrc.rb
 - lib/marco-polo/version.rb

data/README.rdoc

@@ -1,29 +0,0 @@
-= marco-polo
-
-MarcoPolo shows your app name and environment in your console prompt so you don't accidentally break production
-
-== Installation
-
-  In your Gemfile: gem "marco-polo", "~> 0.1.0"
-  $ bundle install
-  
-== Usage
-
-There's nothing to do! Just install the gem and bask in your newfound console security.
-
-Before marco-polo:
-
-  ~/Sites/myapp$ rails c
-  >
-
-  ~/Sites/myapp$ heroku run console -a myapp
-  >
-
-After marco-polo: 
-
-  ~/Sites/myapp$ rails c
-  myapp(dev)>
-  
-  ~/Sites/myapp$ heroku run console -a myapp
-  myapp(prod)>
-