ramen-rails 0.6.4 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4b6bf2f436424841a968e23d07e9f55a873cb40
-  data.tar.gz: 496743ad914cfc6b572e5c5d1e02c49c67f988b4
+  metadata.gz: 292dedebe37ea6d43abc9f6da0c8391936fd35bc
+  data.tar.gz: da2d1273bf8b03e205b8b790b3c932fa7fbb7fd5
 SHA512:
-  metadata.gz: 5c79e791ce639e5704f6311495d962b008e486d2efc43d4e882315b93acfdfe824c27554d7c9c9eea339842a46e641a0587fe7a9fa07cc6af8fb0dde7fdc7929
-  data.tar.gz: 5faf2cd7d1f02093d11729d8445780218cbd714024112dae4063890713e3715d0e81c7fbc4523dd6e8ddbe2e3e6809a7ae8cc25e0498f92097b81b19d78f78ad
+  metadata.gz: 17854a7e4ae7c4136dcc1651143fa832f615b082a4bb75e9e9e6408aa8b481352cc11a6eec68a6047983decf408a8bd888de9c269e23faa12c6b8272ae6c0da2
+  data.tar.gz: 3b338a49b73ca2a7f6879262ab4d0d37cef2228fca5cb428f7bf86a153787126b5b79e95fec9d82e8ffcf6e21d6fbb12ee136a6b018b5c96b9ed0d9800d89522

data/CHANGELOG

@@ -38,3 +38,10 @@ it.
 Version 0.6.4
 Run #to_s on name, email, id (Customer) and url, name, id (Company) to deal with (among other things)
 how MongoDB BSON::ObjectIds are serialized
+
+Version 0.7.0
+Added ability to set `config.enabled_environments` so that the after_filter will only be ran
+on selected environments.
+
+Version 0.7.1
+Because we yanked 0.7.0 to update this Changelog :)

data/lib/rails/generators/ramen/config/ramen.rb.erb

@@ -9,6 +9,10 @@ RamenRails.config do |config|
   # config.organization_secret = "SEKRIT"
   <%- end -%>
 
+  # Enabled environments
+  # Defaults to all environments, but you can limit it to not run
+  # in your test environment, for example:
+  # config.enabled_environments = ["development", "production"]
 
   ## Important note regarding `-> {}` vs. `Proc.new {}`
   ##

data/lib/ramen-rails/config.rb

@@ -10,7 +10,8 @@ module RamenRails
         :return_url,
         :return_label,
         :ramen_js_asset_uri,
-        :custom_links
+        :custom_links,
+        :enabled_environments
     
       def ensure_not_lambda!(v)
         if v.lambda?

data/lib/ramen-rails/ramen_after_filter.rb

@@ -19,9 +19,12 @@ module RamenRails
 
     def self.filter(controller)
       auto_include_filter = new(controller)
-      return unless auto_include_filter.include_javascript?
-
-      auto_include_filter.include_javascript!
+      
+      if auto_include_filter.include_javascript?
+        auto_include_filter.include_javascript!
+      elsif auto_include_filter.disabled_environment?
+        auto_include_filter.include_disabled_comment!
+      end
     end
 
     attr_reader :controller
@@ -34,14 +37,29 @@ module RamenRails
       controller.ramen_script_tag_options
     end
 
+    def include_disabled_comment! 
+      response.body = response.body.gsub(CLOSING_BODY_TAG, "<!-- Ramen not enabled for environment `#{Rails.env}`. Enabled for: #{RamenRails.config.enabled_environments.inspect} -->" + '\\0')
+    end
+
     def include_javascript! 
       response.body = response.body.gsub(CLOSING_BODY_TAG, ramen_script_tag + '\\0')
     end
 
+    def enabled_environment?
+      return true unless RamenRails.config.enabled_environments
+    
+      return RamenRails.config.enabled_environments.map(&:to_s).include?(Rails.env.to_s)
+    end
+
+    def disabled_environment?
+      !enabled_environment?
+    end
+
     def include_javascript?
       !ramen_script_tag_called_manually? &&
         html_content_type? &&
         response_has_closing_body_tag? &&
+        enabled_environment? &&
         ramen_org_id.present? &&
         ramen_user_object.present?
     end

data/lib/ramen-rails/version.rb

@@ -1,3 +1,3 @@
 module RamenRails
-  VERSION = "0.6.4"
+  VERSION = "0.7.1"
 end

data/spec/lib/ramen_after_filter_spec.rb

@@ -113,6 +113,20 @@ describe 'After filter' do
         end
       end
 
+      context "with enabled_environments set to empty" do
+        before :each do |c|
+          RamenRails.config do |c|
+            c.enabled_environments = []
+          end
+        end
+
+        it "not render script tag" do
+          filter = RamenRails::RamenAfterFilter.filter(@dummy)
+          expect(@dummy.response.body).to_not include("ramenSettings")
+          expect(@dummy.response.body).to include("Ramen not enabled for environment")
+        end
+      end
+
       context "with a value proc set" do
         before :each do |c|
           @dummy.current_user.set value: 1000

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ramen-rails
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.1
 platform: ruby
 authors:
 - Ryan Angilly
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack