Delegate JEKYLL_ENV into netlify CONTEXT

Author: bekicot

lib/jekyll/netlify/environment.rb

@@ -0,0 +1,45 @@
+module Jekyll
+  module Netlify
+    # :no_doc:
+    class Environment
+      attr_reader :jekyll_env
+
+      def initialize
+        @netlify_context = ENV['CONTEXT']
+        if netlify?
+          @jekyll_env = 'production'
+        else
+          @jekyll_env = Jekyll.env
+        end
+      end
+
+      def prefixed_env
+        if suffix_context?
+          @jekyll_env
+        else
+          [@jekyll_env, @netlify_context].join('-')
+        end
+      end
+
+      def netlify?
+        ENV['DEPLOY_URL'] && (!ENV['JEKYLL_ENV'] || ENV['JEKYLL_ENV'].empty?)
+      end
+
+      private
+
+      def production_context?
+        @netlify_context == 'production'
+      end
+
+      def netlify_context_blank?
+        (!@netlify_context || @netlify_context.empty?)
+      end
+
+      def suffix_context?
+        @jekyll_env && ((@jekyll_env == @netlify_context) ||
+            netlify_context_blank? ||
+            production_context?)
+      end
+    end
+  end
+end

lib/jekyll/netlify/generator.rb

@@ -1,16 +1,17 @@
+require_relative 'environment'
 module Jekyll
   module Netlify
     # Netlify plugin generator
     class Generator < Jekyll::Generator
       safe true
 
       def generate(site)
+        env = Environment.new
         if netlify?
+          ENV['JEKYLL_ENV'] = env.jekyll_env
+          site.config['environment'] = env.jekyll_env
           site.config['netlify'] = load_netlify_env
-          if production?
-            ENV['JEKYLL_ENV'] = 'production'
-            site.config['environment'] = 'production'
-          end
+          site.config['netlify']['environment'] = env.prefixed_env
         else
           site.config['netlify'] = false
         end

test/test_netlify.rb

@@ -39,7 +39,7 @@ class Jekyll::NetlifyTest < Minitest::Test
     end
   end
 
-  context 'netlify production deploy' do
+  context 'netlify production context' do
     setup do
       Jekyll.instance_variable_set(
         :@logger, Jekyll::LogAdapter.new(Jekyll::Stevenson.new, :error)
@@ -79,6 +79,7 @@ class Jekyll::NetlifyTest < Minitest::Test
 
       should 'be production' do
         assert_equal 'production', @site.config['environment']
+        assert_equal 'production', @netlify['environment']
       end
 
       should 'not be a pull request' do
@@ -92,6 +93,39 @@ class Jekyll::NetlifyTest < Minitest::Test
       end
     end
   end
+  context 'netlify deploy-preview context' do
+    setup do
+      Jekyll.instance_variable_set(
+        :@logger, Jekyll::LogAdapter.new(Jekyll::Stevenson.new, :error)
+      )
+
+      ENV.clear
+      ENV['CONTEXT'] = 'deploy-preview'
+      ENV['JEKYLL_ENV'] = 'staging'
+
+      ENV['PULL_REQUEST'] = 'false'
+      ENV['DEPLOY_URL'] = 'https://578ab634d5d5cf960d620--open-api.netlify.com'
+      ENV['DEPLOY_PRIME_URL'] = 'https://beta--open-api.netlify.com'
+
+      config = Jekyll.configuration(
+        source: jekyll_test_site,
+        destination: File.join(jekyll_test_site, '_site'),
+      )
+      @site = Jekyll::Site.new(config)
+      @site.read
+      @site.generate
+    end
+
+    context 'info' do
+      setup do
+        @netlify = @site.config['netlify']
+      end
+      should 'be staging-deploy-preview' do
+        assert_equal 'staging', @site.config['environment']
+        assert_equal 'staging-deploy-preview', @netlify['environment']
+      end
+    end
+  end
 
   context 'netlify unrecognised pull request' do
     setup do
@@ -131,8 +165,9 @@ class Jekyll::NetlifyTest < Minitest::Test
         assert_equal 'https://example.com', @netlify['url']
       end
 
-      should 'not be production' do
-        assert_operator @site.config['environment'], :!=, 'production'
+      should 'be production' do
+        assert_equal 'production', @site.config['environment']
+        assert_equal 'production-deploy-preview', @netlify['environment']
       end
 
       should 'be a pull request' do