hotwire_native_version_gate 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0a28510bb2899f691c79be862996ac02742b107db5bc52d22ee719a7a20f10fe
+  data.tar.gz: 55475a89e88294e1e26432c8cdc16cb0db8c9eba448e5359c8218d837f23ed75
+SHA512:
+  metadata.gz: 7ca0c3871d000b4d5f42c3ebcfa77b888b036d5159739be890f9c98a2b725d2a67883d49e8379def5708db5916453191f120082be6231484c6d69619685d0cf3
+  data.tar.gz: 88a94760a3c596121ca665951f20444a69e4e66791f29414abeeaa41fc94de848aea8e6e0c4c5a4ef660c6299598e61559e96a5e69c328567a2c542c95399409

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/hotwire_native_version_gate/concern.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module HotwireNativeVersionGate
+  module Concern
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def native_feature(feature, ios: false, android: false)
+        VersionGate.native_feature(feature, ios: ios, android: android)
+      end
+
+      def native_version_regex=(regex)
+        VersionGate.native_version_regex = regex
+      end
+    end
+
+    included do
+      if respond_to?(:helper_method)
+        helper_method :native_feature_enabled?
+      end
+    end
+
+    def native_feature_enabled?(feature)
+      user_agent = if respond_to?(:request) && request.respond_to?(:user_agent)
+        request.user_agent
+      else
+        nil
+      end
+
+      VersionGate.feature_enabled?(feature, user_agent, context: self)
+    end
+  end
+end

data/lib/hotwire_native_version_gate/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module HotwireNativeVersionGate
+  VERSION = File.read(
+    File.expand_path('../../VERSION', __dir__)
+  ).strip.freeze
+end

data/lib/hotwire_native_version_gate/version_gate.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module HotwireNativeVersionGate
+  class VersionGate
+    # Default regex example: Hotwire Native App iOS/1.0.0;
+    # Expected capture groups: platform = (iOS|Android), version = semantic version
+    DEFAULT_NATIVE_VERSION_REGEX = /\bHotwire Native App (?<platform>iOS|Android)\/(?<version>\d+(?:\.\d+)*)\b/
+
+    @native_features = {}
+    @native_version_regex = DEFAULT_NATIVE_VERSION_REGEX
+
+    class << self
+      attr_reader :native_features, :native_version_regex
+
+      def native_version_regex=(regex)
+        unless regex.is_a?(Regexp)
+          raise ArgumentError, "native_version_regex must be a Regexp"
+        end
+        @native_version_regex = regex
+      end
+
+      def native_feature(feature, ios: false, android: false)
+        @native_features ||= {}
+        @native_features[feature] = { ios: ios, android: android }
+      end
+
+      def feature_enabled?(feature, user_agent, context: nil)
+        @native_features ||= {}
+        return false unless @native_features.key?(feature)
+
+        platform = match_platform(user_agent)
+        return false if platform.nil?
+
+        platform_key = platform.downcase.to_sym
+        feature_config = @native_features[feature][platform_key]
+        handle_feature(feature_config, user_agent, context: context)
+      end
+
+      private
+
+      def match_platform(user_agent)
+        match = user_agent.to_s.match(@native_version_regex)
+        return match[:platform] if match
+        nil
+      end
+
+      def handle_feature(feature_config, user_agent, context: nil)
+        # if false or nil, return false
+        return false unless feature_config
+        # if true, return true
+        return true if feature_config == true
+        # if a string, compare the version
+        if feature_config.is_a?(String)
+          match = user_agent.to_s.match(@native_version_regex)
+          return false unless match
+          return Gem::Version.new(feature_config) <= Gem::Version.new(match[:version])
+        end
+        # if a symbol, call the method on the context (if provided) or self
+        if feature_config.is_a?(Symbol)
+          if context
+            return context.send(feature_config)
+          else
+            return send(feature_config)
+          end
+        end
+        # else, raise an error
+        raise InvalidVersionGateError, "Invalid version gate: #{feature_config}"
+      end
+    end
+  end
+end

data/lib/hotwire_native_version_gate.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require_relative "hotwire_native_version_gate/version"
+require_relative "hotwire_native_version_gate/version_gate"
+require_relative "hotwire_native_version_gate/concern"
+
+module HotwireNativeVersionGate
+  class Error < StandardError; end
+  class InvalidVersionGateError < StandardError; end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: hotwire_native_version_gate
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stuart Yamartino
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: HotwireNativeVersionGate provides functionality to version gate Hotwire
+  Native apps in Rails.
+email:
+- stu@stuyam.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- VERSION
+- lib/hotwire_native_version_gate.rb
+- lib/hotwire_native_version_gate/concern.rb
+- lib/hotwire_native_version_gate/version.rb
+- lib/hotwire_native_version_gate/version_gate.rb
+homepage: https://github.com/stuyam/hotwire_native_version_gate
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stuyam/hotwire_native_version_gate
+  source_code_uri: https://github.com/stuyam/hotwire_native_version_gate
+  changelog_uri: https://github.com/stuyam/hotwire_native_version_gate/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A gem for version gating Hotwire Native apps in Rails
+test_files: []