snappconfig 0.0.7 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14eb983b17f43b7bb6f16c65df5a8595ca02de9f
-  data.tar.gz: 2bd84af7c8bb5d396dd709fe79c7334140a5912d
+  metadata.gz: 6d4915af10d39c30322808dc8eca8686f71d1aa6
+  data.tar.gz: 82476c17726d99fcb073f35d25d88723c180b21e
 SHA512:
-  metadata.gz: 1135507a51adfd8544ec0cbba1b053626253f9e2a1fffd4c2b5663287246190ff6c4af99d22be5935aca389700fe3323a55d2cc43be2c53cb121a966004b5693
-  data.tar.gz: 500ed4fd39889e499f93f310564913babdddb30b957a028afaa328e73f8715f60bb51f526f5e17500efc5840898548e0450d2b9a0378e09102089119520f0c06
+  metadata.gz: 31dfaed8409d853d2cdd82e7288572032a1349ff9bc2e7a747bd5755dc704bc15b4ebab9c6d17969732a3f2c59a55a346fcd179c6d2c01619faa2ed8fe357638
+  data.tar.gz: 5430a096600d31a6febd48d1957b8352009ef2d0429ca079f8d09805e22f37882e00524e5ad652130f5e0512d12d1f576e7e39ebebc1cfc18a376da5a7c7f518

data/README.md

@@ -19,7 +19,7 @@ Smarter Rails configuration that works with Heroku. Here's why it rocks:
 
 **2)** Use the generator to create config files (optional):
 
-    $ rails generate snappconfig:install
+    $ rails generate snappconfig
 
 This will create:  
 
@@ -31,22 +31,34 @@ This will create:
 
 ## Usage
 
-To access config values, just use standard hash notation:
+To access configuration values, simply read from `CONFIG` using standard hash notation:
 
     token = CONFIG[:secret_token]
     stripe_secret = CONFIG[:stripe][:secret_key]
     
-Or if you wrote values to **ENV**, get them the way you normally would:
+Or if you wrote values to `ENV`, get them the way you normally would:
 
     token = ENV['SECRET_TOKEN']
 
+You can access `CONFIG` from anywhere in the app, including initializers and the application.rb file:
+
+**application.rb example:**
+
+    module MyApp
+      class Application < Rails::Application
+        config.action_mailer.smtp_settings = {
+          :user_name            => CONFIG[:mailer][:smtp_settings][:user_name],
+          :password             => CONFIG[:mailer][:smtp_settings][:password]
+          ...
+
 
 
 ## YAML file examples
 
 
 
-####Environment specfic (with defaults)
+**Environment specfic (with defaults):**
+
     mailer_host: "localhost:3000"
     development:
       mailer_host: "localhost:3000"
@@ -56,7 +68,8 @@ Or if you wrote values to **ENV**, get them the way you normally would:
       mailer_host: "blog.example.com"
 ( **NOTE:** Default values can also be put under a 'defaults' group key. )
 
-####Nested values:
+**Nested values:**
+
     stripe: 
       publishable_key: 5883eeb3cd43cee52585
       secret_key: 0df20bf20903c4404968 
@@ -70,7 +83,8 @@ Or if you wrote values to **ENV**, get them the way you normally would:
         publishable_key: e753e42725fe43d3994a
         secret_key: e8787290a07b1abecae9
 
-####ENV values:
+
+**ENV values:**
 
     ENV: 
         BLOG_USERNAME: "admin"
@@ -89,8 +103,8 @@ Snappconfig will load all files in the `config/` directory that start with **"ap
 For example, the following files would be processed in order:
 
 - **application**.yml
-- **application.2**.yml
 - **application.test**.yml
+- **application.test.2**.yml
 
 
 <a name='best_practices'/>
@@ -134,7 +148,7 @@ We can then fill in those values with a git-ignored file that only stores our se
       smtp_settings:
         password: 8675309
 
-And there it is- configuration without compromise!
+And there you have it- configuration without compromise!
 
 The `_REQUIRED` keyword is really handy. You can use it to stub out an entire config file template. If any of the required values are not present at runtime Snappconfig will raise an error, ensuring you never go live without a complete configuration.
 
@@ -142,13 +156,22 @@ The `_REQUIRED` keyword is really handy. You can use it to stub out an entire co
 
 The Heroku file system is read-only, so if you're git-ignoring your config files you won't be able to add them in manually.
 
-But don't worry, Snappconfig's got you covered- just run the custom rake task:
+But don't worry, Snappconfig provides a rake task to load your config files into Heroku. Just run:
+
+    $ rake heroku:config:load
+
+or:
+
+    $ rake heroku:config:load[my_app]
+
+to target a specific app. 
 
-    $ rake snappconfig:heroku
+Slick!
 
-and your app configuration will automatically be passed into Heroku for you. Slick!
 
+## Miscellaneous
 
+- Configuration is only loaded when an application starts up. Remember to **restart your app** whenever you make changes to your YAML files.
 
 ## Contributing
 

data/lib/generators/snappconfig/snappconfig_generator.rb

@@ -0,0 +1,23 @@
+class SnappconfigGenerator < Rails::Generators::Base
+  source_root File.expand_path("../templates", __FILE__)
+
+  # all public methods in here will be run in order
+
+  def create_configuration
+    template "application.yml", "config/application.yml"
+    template "application.secrets.yml", "config/application.secrets.yml"
+  end
+
+  def ignore_configuration
+    if File.exists?(".gitignore")
+      append_to_file(".gitignore") do
+        <<-EOF.strip_heredoc
+
+        # Ignore application secrets.
+        /config/application.secrets.yml
+        EOF
+      end
+    end
+  end
+
+end

data/lib/snappconfig/tasks.rake

@@ -1,15 +1,22 @@
 require "shellwords"
 
-namespace :snappconfig do
-  
-  task :heroku do   
-    puts "Passing application configuration to Heroku..."
-    merged_yaml = Snappconfig.merged_raw.to_yaml
-    shell_yaml = Shellwords.escape(merged_yaml)
-    puts `heroku config:set CONFIG=#{shell_yaml}`
+namespace :heroku do
+  namespace :config do
+
+    task :load, [:app] do |t, args|
+      puts "Loading configuration files into Heroku..."
+      merged_yaml = Snappconfig.merged_raw.to_yaml
+      shell_yaml = Shellwords.escape(merged_yaml)
+      
+      app_switch = args[:app] ? " --app #{args[:app]}" : ""
+      puts `heroku config:set CONFIG=#{shell_yaml}#{app_switch}`
+    end
+
   end
-  
 end
 
 
 
+
+
+

data/snappconfig.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "snappconfig"
-  spec.version       = "0.0.7"
+  spec.version       = "0.1.1"
   spec.authors       = ["Yarin Kessler"]
   spec.email         = "ykessler@appgrinders.com"
   spec.summary       = %q{Smarter Rails configuration with YAML}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snappconfig
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.1
 platform: ruby
 authors:
 - Yarin Kessler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,9 +49,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/generators/snappconfig/install/install_generator.rb
-- lib/generators/snappconfig/install/templates/application.secrets.yml
-- lib/generators/snappconfig/install/templates/application.yml
+- lib/generators/snappconfig/snappconfig_generator.rb
+- lib/generators/snappconfig/templates/application.secrets.yml
+- lib/generators/snappconfig/templates/application.yml
 - lib/snappconfig.rb
 - lib/snappconfig/railtie.rb
 - lib/snappconfig/tasks.rake

data/lib/generators/snappconfig/install/install_generator.rb

@@ -1,27 +0,0 @@
-module Snappconfig
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
-
-      # all public methods in here will be run in order
-    
-      def create_configuration
-        template "application.yml", "config/application.yml"
-        template "application.secrets.yml", "config/application.secrets.yml"
-      end
-
-      def ignore_configuration
-        if File.exists?(".gitignore")
-          append_to_file(".gitignore") do
-            <<-EOF.strip_heredoc
-
-            # Ignore application secrets.
-            /config/application.secrets.yml
-            EOF
-          end
-        end
-      end
-    
-    end
-  end
-end