ios_analytics_cli 1.0.0

data/lib/ios_analytics_cli/serializers/objc/event.rb

@@ -0,0 +1,182 @@
+require_relative '../base'
+
+module Analytics
+  module Serializer
+    class ObjC < Base
+      class Event
+        def initialize(src)
+          @src = src
+        end
+
+        def save(path)
+          @class_name = 'AnalyticsEvent'
+
+          @file_name = @class_name + '.h'
+          output_path = File.join(path, @file_name)
+          File.write(output_path, render_h)
+
+          @file_name = @class_name + '.m'
+          output_path = File.join(path, @file_name)
+          File.write(output_path, render_m)
+        end
+
+        private
+
+        def render_h
+          ERB.new(template_h, nil, '-').result(binding)
+        end
+
+        def template_h
+          <<~TEMPLATE
+            <%= ERB.new(Analytics::Templates.tmpl_at('header.erb')).result(binding) %>
+
+            #import <Foundation/Foundation.h>
+            #import "AnalyticsEnums.h"
+
+            NS_ASSUME_NONNULL_BEGIN
+
+            __swift_unavailable("This class is only available in ObjC.")
+            @interface <%= @class_name %> : NSObject
+
+            @property (nonatomic, strong, readonly) NSString *name;
+            @property (nonatomic, strong, readonly, nullable) NSDictionary<NSString *, id> *properties;
+
+            - (instancetype)init NS_UNAVAILABLE;
+            + (instancetype)new NS_UNAVAILABLE;
+
+            # pragma mark - Events
+
+            <% @src["events"].each do |event| -%>
+            /// <%= event["description"]  %>
+            <% if event["properties"].nil? -%>
+            + (instancetype)<%= event["name"].camel_case %>;
+            <% else -%>
+            <% event['properties'].each do |property| -%>
+            /// @param <%= property['name'].camel_case %> <%= property['description'] %>
+            <% end -%>
+            + (instancetype)<%= event["name"].camel_case -%><%= format_method_params(event['properties']) %>;
+            <% end %>
+            <% end -%>
+            @end
+
+            NS_ASSUME_NONNULL_END
+          TEMPLATE
+        end
+
+        def render_m
+          ERB.new(template_m, nil, '-').result(binding)
+        end
+
+        def template_m
+          <<~TEMPLATE
+            <%= ERB.new(Analytics::Templates.tmpl_at('header.erb')).result(binding) %>
+
+            #import "<%= @class_name + '.h' %>"
+
+            @implementation <%= @class_name %>
+
+            - (instancetype)initWithName:(NSString *)name properties:(NSDictionary<NSString *, id> *)properties
+            {
+                if (self = [super init]) {
+                    _name = name;
+                    _properties = properties;
+                }
+                return self;
+            }
+
+            # pragma mark - Events
+
+            <% @src['events'].each do |event| -%>
+            <% if event['properties'].nil? -%>
+            + (instancetype)<%= event['name'].camel_case %>
+            {
+                return [[self alloc] initWithName:@"<%= event['name'] %>" properties: nil];
+            }
+            <% else -%>
+            + (instancetype)<%= event['name'].camel_case -%><%= format_method_params(event['properties']) %>
+            {
+            <% Interactor::Event.enum_properties_from_event(event).each do |property| -%>
+                NSString *<%= property['name'].camel_case %>Value;
+                switch (<%= property['name'].camel_case %>) {
+            <% property['values'].each do |value| -%>
+                    case <%= 'AE' + property['name'].pascal_case + value.pascal_case %>:
+                        <%= property['name'].camel_case %>Value = @"<%= value %>";
+                        break;
+            <% end -%>
+                }
+
+            <% end -%>
+                return [[self alloc] initWithName:@"<%= event['name'] %>" properties: <%= format_init_properties(event['properties']) %>];
+            }
+            <% end -%>
+
+            <% end -%>
+            @end
+          TEMPLATE
+        end
+
+        ## Helper methods called from the ERB template
+
+        # Formats the parameters in ObjC method.
+        def format_method_params(properties)
+          params = properties.map.with_index do |property, i|
+            name = if i == 0
+                     property['name'].pascal_case # 'num_of_items' -> 'NumOfItems'
+                   else
+                     property['name'].camel_case # 'num_of_items' -> 'numOfItems'
+                   end
+
+            "#{name}:(#{format_property_type(property)})#{property['name'].camel_case}"
+          end
+
+          "With#{params.join(' ')}"
+        end
+
+        # Maps the property type to ObjC type.
+        def format_property_type(property)
+          # if it doesn't have values, it's not an enum,
+          # and if it does, we'll return capitalized property name prefixed with 'AE',
+          # because an enum with the same name will be generated as well
+          if property['values'].nil?
+            case property['type']
+            when 'text'
+              'NSString *'
+            when 'number'
+              'NSInteger'
+            when 'decimal'
+              'double'
+            else
+              'unknown-type'
+            end
+          else
+            'AE' + property['name'].pascal_case
+          end
+        end
+
+        # Formats the properties passed to Event's init.
+        def format_init_properties(properties)
+          result = properties
+                   .map.with_index { |property, _i| "@\"#{property['name']}\": #{format_init_property_value(property)}" }
+                   .join(', ')
+
+          "@{#{result}}"
+        end
+
+        # Formats the property's value (used as NSDictionary's value) value depending on the property's type.
+        def format_init_property_value(property)
+          # if it doesn't have values, it's not an enum
+          if property['values'].nil?
+            case property['type']
+            when 'number', 'decimal'
+              "@(#{property['name'].camel_case})"
+            else
+              property['name'].camel_case
+            end
+          else
+            property['name'].camel_case + 'Value'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ios_analytics_cli/serializers/objc/logger.rb

@@ -0,0 +1,53 @@
+require_relative '../base'
+
+module Analytics
+  module Serializer
+    class ObjC < Base
+      class Logger
+        def initialize(src)
+          @src = src
+        end
+
+        def save(path)
+          @protocol_name = 'AnalyticsLogger'
+
+          @file_name = @protocol_name + '.h'
+          output_path = File.join(path, @file_name)
+          File.write(output_path, render_h)
+        end
+
+        private
+
+        def render_h
+          ERB.new(template_h, nil, '-').result(binding)
+        end
+
+        def template_h
+          <<~TEMPLATE
+            <%= ERB.new(Analytics::Templates.tmpl_at('header.erb')).result(binding) %>
+
+            #import <Foundation/Foundation.h>
+
+            @class AnalyticsEvent;
+            @class AnalyticsScreen;
+            @class AnalyticsUserProperty;
+
+            NS_ASSUME_NONNULL_BEGIN
+            
+            __swift_unavailable("This protocol is only available in ObjC.")
+            @protocol <%= @protocol_name %> <NSObject>
+
+            - (void)setEnabled:(BOOL)enabled;
+            - (void)logEvent:(AnalyticsEvent *)event;
+            - (void)trackScreen:(AnalyticsScreen *)screen;
+            - (void)setUserProperty:(AnalyticsUserProperty *)userProperty;
+
+            @end
+
+            NS_ASSUME_NONNULL_END
+          TEMPLATE
+        end
+      end
+    end
+  end
+end

data/lib/ios_analytics_cli/serializers/objc/objc.rb

@@ -0,0 +1,23 @@
+require_relative '../base'
+
+module Analytics
+  module Serializer
+    class ObjC < Base
+      # An abstract method used to save a file at provided path.
+      def save(path)
+        files = [
+          AnalyticsFile,
+          Enums,
+          Event,
+          Logger,
+          Screen,
+          UserProperty
+        ]
+
+        files.each do |f|
+          f.new(@src).save(path)
+        end
+      end
+    end
+  end
+end

data/lib/ios_analytics_cli/serializers/objc/screen.rb

@@ -0,0 +1,90 @@
+require_relative '../base'
+
+module Analytics
+  module Serializer
+    class ObjC < Base
+      class Screen
+        def initialize(src)
+          @src = src
+        end
+
+        def save(path)
+          @class_name = 'AnalyticsScreen'
+
+          @file_name = @class_name + '.h'
+          output_path = File.join(path, @file_name)
+          File.write(output_path, render_h)
+
+          @file_name = @class_name + '.m'
+          output_path = File.join(path, @file_name)
+          File.write(output_path, render_m)
+        end
+
+        private
+
+        def render_h
+          ERB.new(template_h, nil, '-').result(binding)
+        end
+
+        def template_h
+          <<~TEMPLATE
+            <%= ERB.new(Analytics::Templates.tmpl_at('header.erb')).result(binding) %>
+
+            #import <Foundation/Foundation.h>
+
+            NS_ASSUME_NONNULL_BEGIN
+
+            __swift_unavailable("This class is only available in ObjC.")
+            @interface <%= @class_name %> : NSObject
+
+            @property (nonatomic, strong, readonly) NSString *name;
+
+            - (instancetype)init NS_UNAVAILABLE;
+            + (instancetype)new NS_UNAVAILABLE;
+
+            #pragma mark - Screens
+            <% @src['screens'].each do |screen| %>
+            /// <%= screen['description'] %>
+            + (instancetype)<%= screen['name'].camel_case %>;
+            <% end %>
+            @end
+
+            NS_ASSUME_NONNULL_END
+          TEMPLATE
+        end
+
+        def render_m
+          ERB.new(template_m, nil, '-').result(binding)
+        end
+
+        def template_m
+          <<~TEMPLATE
+            <%= ERB.new(Analytics::Templates.tmpl_at('header.erb')).result(binding) %>
+
+            #import "<%= @class_name + '.h' %>"
+
+            @implementation <%= @class_name %>
+
+            - (instancetype)initWithName:(NSString *)name
+            {
+                if (self = [super init]) {
+                    _name = name;
+                }
+                return self;
+            }
+
+            #pragma mark - Screens
+            <% @src['screens'].each do |screen| %>
+            + (instancetype)<%= screen['name'].camel_case %>
+            {
+                return [[self alloc] initWithName:@"<%= screen['name'] %>"];
+            }
+            <% end -%>
+
+            @end
+          TEMPLATE
+        end
+      end
+    end
+  end
+end

data/lib/ios_analytics_cli/serializers/objc/user_property.rb

@@ -0,0 +1,120 @@
+require_relative '../base'
+
+module Analytics
+  module Serializer
+    class ObjC < Base
+      class UserProperty
+        def initialize(src)
+          @src = src
+        end
+
+				def save(path)
+					@class_name = 'AnalyticsUserProperty'
+
+          @file_name = @class_name + '.h'
+          output_path = File.join(path, @file_name)
+					File.write(output_path, render_h)
+					
+					@file_name = @class_name + '.m'
+          output_path = File.join(path, @file_name)
+          File.write(output_path, render_m)
+        end
+
+        private
+
+        def render_h
+          ERB.new(template_h, nil, '-').result(binding)
+        end
+
+        def template_h
+					<<~TEMPLATE
+            <%= ERB.new(Analytics::Templates.tmpl_at('header.erb')).result(binding) %>
+
+            #import <Foundation/Foundation.h>
+            #import "AnalyticsEnums.h"
+            
+            NS_ASSUME_NONNULL_BEGIN
+
+            __swift_unavailable("This class is only available in ObjC.")
+            @interface <%= @class_name %> : NSObject
+
+            @property (nonatomic, strong, readonly) NSString *name;
+            @property (nonatomic, strong, readonly, nullable) NSString *value;
+
+            - (instancetype)init NS_UNAVAILABLE;
+            + (instancetype)new NS_UNAVAILABLE;
+
+            #pragma mark - User properties
+            <% @src["userProperties"].each do |user_property| %>
+            /// <%= user_property['description'] %>
+            <% if user_property['values'].nil? -%>
+            /// @param value The value of the user property, or `nil` if You want to remove the user property.
+            <% else -%>
+            /// @param value The value of the user property, or use `<%= 'AUP' + user_property['name'].pascal_case + 'Nil' %>` if You want to remove the user property.
+            <% end -%>
+            + (instancetype)<%= user_property['name'].camel_case %>WithValue:(<%= format_method_parameter(user_property) %>)value;
+            <% end %>
+            @end
+
+            NS_ASSUME_NONNULL_END
+          TEMPLATE
+				end
+				
+				def render_m
+          ERB.new(template_m, nil, '-').result(binding)
+        end
+
+        def template_m
+					<<~TEMPLATE
+            <%= ERB.new(Analytics::Templates.tmpl_at('header.erb')).result(binding) %>
+
+            #import "<%= @class_name + '.h' %>"
+
+            @implementation <%= @class_name %>
+            
+            - (instancetype)initWithName:(NSString *)name value:(NSString * _Nullable)value
+            {
+                if (self = [super init]) {
+                    _name = name;
+                    _value = value;
+                }
+                return self;
+            }
+
+            #pragma mark - User properties
+            <% @src["userProperties"].each do |user_property| %>
+            + (instancetype)<%= user_property['name'].camel_case %>WithValue:(<%= format_method_parameter(user_property) %>)value
+            {
+            <% unless user_property['values'].nil? -%>
+                NSString *rawValue;
+                switch (value) {
+            <% user_property['values'].each do |value| -%>
+                    case <%= 'AUP' + user_property['name'].pascal_case + value.pascal_case %>:
+                        rawValue = @"<%= value %>";
+                        break;
+            <% end -%>
+                    case <%= 'AUP' + user_property['name'].pascal_case + 'Nil' %>:
+                        rawValue = nil;
+                        break;
+                }
+                return [[self alloc] initWithName:@"<%= user_property['name'] %>" value:rawValue];
+            <% else -%>
+                return [[self alloc] initWithName:@"<%= user_property['name'] %>" value:value];
+            <% end -%>
+            }
+						<% end %>
+            @end
+          TEMPLATE
+        end
+
+        def format_method_parameter(user_property)
+          if user_property['values'].nil?
+            "NSString * _Nullable"
+          else
+            'AUP' + user_property['name'].pascal_case
+          end
+        end
+      end
+    end
+  end
+end