ios_analytics_cli 1.0.0

data/lib/ios_analytics_cli/commands/command.rb

@@ -0,0 +1,6 @@
+module Analytics
+  # Command module is used to namespace all the command-classes,
+  # i.e. classes that are handling all commands that can be run from the CLI.
+  module Command
+  end
+end

data/lib/ios_analytics_cli/commands/generate.rb

@@ -0,0 +1,77 @@
+require 'commander/blank'
+require 'commander/command'
+
+module Analytics
+  module Command
+    # A class that's called from CLI's 'generate' argument,
+    # and used to generate analytics files from the resource JSON file.
+    class Generate
+      include Helpers::Terminal
+
+      def perform
+        unless File.file?(config_src_path)
+          prompt.error("Unable to find #{config_src_path}")
+          return
+        end
+        prompt.say('Generating analytics files...')
+        generate
+        prompt.ok('Analytics files are successfully generated!')
+      end
+
+      ## The following methods are used to generate analytics files,
+      ## based on settings defined in 'analytics.yml' configuration file.
+
+      private
+
+      ## Retrieving values from configuration file.
+
+      def config
+        Analytics::IO::Config.read
+      end
+
+      def config_lang
+        config[:language]
+      end
+
+      def config_analytics_path
+        config[:analyticsFilesPath]
+      end
+
+      def config_src_path
+        config[:sourcePath]
+      end
+
+      ## Generating
+
+      def generate
+        json_file = File.open(config_src_path)
+        json_src = JSON.load(json_file)
+
+        case config_lang
+        when 'swift'
+          FileUtils.mkdir_p config_analytics_path unless File.exist? config_analytics_path
+          Analytics::Serializer::Swift.new(json_src).save(config_analytics_path)
+        when 'objc'
+          FileUtils.mkdir_p config_analytics_path unless File.exist? config_analytics_path
+          Analytics::Serializer::ObjC.new(json_src).save(config_analytics_path)
+        when 'swift-objc'
+          
+          swift_path = config_analytics_path + '/Swift'
+          objc_path = config_analytics_path + '/ObjC'
+
+          FileUtils.mkdir_p swift_path unless File.exist? swift_path
+          FileUtils.mkdir_p objc_path unless File.exist? objc_path
+
+          Analytics::Serializer::Swift.new(json_src).save(swift_path)
+          Analytics::Serializer::ObjC.new(json_src).save(objc_path)
+        else
+          prompt.error("Unsupported value '#{config_lang}' for 'language'. Supported values are:\n"\
+          "- 'swift' - if You're using only Swift in Your project,\n"\
+          "- 'objc' - if You're using only ObjC in Your project,\n"\
+          "- 'swift-objc' if You're using both Swift & ObjC in Your project.")
+          return
+        end
+      end
+    end
+  end
+end

data/lib/ios_analytics_cli/commands/init.rb

@@ -0,0 +1,55 @@
+require 'commander/blank'
+require 'commander/command'
+
+module Analytics
+  module Command
+    # A class called from CLI's 'init' argument,
+    # which generates the project's configuration file depending on the user's input.
+    class Init
+      include Helpers::Terminal
+
+      # Entry point of this class - the only public method in it.
+      def perform
+        lang = lang_selection
+        analytics_path = analytics_path_selection
+        src_path = src_path_selection
+
+        config = {
+          language: lang,
+          analyticsFilesPath: analytics_path,
+          sourcePath: src_path
+        }
+        Analytics::IO::Config.write(config)
+
+        prompt.ok('Configuration file is properly created. You\'re good to go!')
+      end
+
+      ## The following methods are used to retrieve project information,
+      ## in order to create analytitcs.yml configuration file.
+
+      private
+
+      # Prompts a user to select a programming language.
+      def lang_selection
+        languages = {
+          'Swift' => 'swift',
+          'Objective-C' => 'objc',
+          'Both' => 'swift-objc'
+        }
+        prompt.select('Select lang:', languages)
+      end
+
+      # Prompts a user to select a path to which the generated
+      # analytics files will be saved.
+      def analytics_path_selection
+        prompt.ask('Where would You like to store analytics files? (Press enter to use default path)', default: './Common/Analytics/')
+      end
+
+      # Prompts a user to select a path in which he'll hold a source json file,
+      # from which the analytics files will be generated.
+      def src_path_selection
+        prompt.ask('Where would You like to store json file from which analytics files will be generated? (Press enter to use default path)', default: 'analytics-source.json')
+      end
+    end
+  end
+end

data/lib/ios_analytics_cli/error_handler.rb

@@ -0,0 +1,22 @@
+module Analytics
+  class ErrorHandler
+    class << self
+      def rescuable
+        yield
+      rescue StandardError => e
+        handle(e)
+      end
+
+      def handle(e)
+        prompt.error(
+          case e
+          when Errno::ENOENT
+            "We could not find a file that we need:\n\n#{e.message}"
+          else
+            "An error happened. This might help:\n\n#{e.message}"
+          end
+        )
+        end
+    end
+  end
+end

data/lib/ios_analytics_cli/helpers/terminal.rb

@@ -0,0 +1,11 @@
+require 'tty-prompt'
+
+module Analytics
+  module Helpers
+    module Terminal
+      def prompt
+        @prompt ||= TTY::Prompt.new(interrupt: :exit)
+      end
+    end
+  end
+end

data/lib/ios_analytics_cli/info.rb

@@ -0,0 +1,16 @@
+module Analytics
+  def self.summary
+    <<-Summary
+    CLI tool that generates Analytics files, for iOS project, from a JSON file.
+    Summary
+  end
+
+  def self.description
+    <<-Desc
+    This gem is develop in order to reduce the time needed to even start with the implementation of Analytics in iOS apps,
+    by generating files, classes, methods & everything else that\'s required to call a specific event, change a user property,
+    or even track an open screen. By calling just 2 commands, analytics init & analytics generate,
+    all of these are generated for You from the appropriately configured JSON file.
+    Desc
+  end
+end

data/lib/ios_analytics_cli/interactors/event.rb

@@ -0,0 +1,22 @@
+require 'tty-prompt'
+
+module Analytics
+  module Interactor
+    class Event
+      # Returns all properties, from all events, which uses an enum as the value.
+      def self.all_enum_properties(events)
+        events
+          .reject { |event| event['properties'].nil? }
+          .flat_map { |event| event['properties'] }
+          .reject { |property| property['values'].nil? }
+      end
+
+      def self.enum_properties_from_event(event)
+        properties = event['properties']
+        return nil if properties.nil?
+
+        properties.reject { |property| property['values'].nil? }
+      end
+    end
+  end
+end

data/lib/ios_analytics_cli/interactors/interactor.rb

@@ -0,0 +1,8 @@
+require 'tty-prompt'
+
+module Analytics
+	# Interactor module is used to namespace all business logic
+	# specific to some use-case.
+  module Interactor
+  end
+end

data/lib/ios_analytics_cli/interactors/user_property.rb

@@ -0,0 +1,12 @@
+require 'tty-prompt'
+
+module Analytics
+  module Interactor
+    class UserProperty
+      # Returns all user properties which uses an enum as the value.
+      def self.all_enum_user_properties(user_properties)
+        user_properties.reject { |up| up['values'].nil? }
+      end
+    end
+  end
+end

data/lib/ios_analytics_cli/io/config.rb

@@ -0,0 +1,18 @@
+module Analytics::IO
+  # Config operates on .yml configuration file
+  # inside project's root folder.
+  class Config
+    # A path to the .yml configuration file.
+    CONFIG_PATH = "#{PROJ_DIR}/analytics.yml".freeze
+
+    # Writes to a configuration file.
+    def self.write(data)
+      File.open(CONFIG_PATH, 'w') { |file| YAML.dump(data, file) }
+    end
+
+    # Reads the configuration file.
+    def self.read
+      YAML.load_file(CONFIG_PATH)
+    end
+  end
+end

data/lib/ios_analytics_cli/io/io.rb

@@ -0,0 +1,10 @@
+module Analytics
+  # IO is a module that holds all IO stuff,
+  # such as reading/writing to a file or similar.
+  module IO
+    # The directory of the current project.
+    # Currently it's just a `Dir.pwd`, but we'll may
+    # receive a path in the CLI command in future.
+    PROJ_DIR = Dir.pwd.freeze
+  end
+end

data/lib/ios_analytics_cli/serializers/base.rb

@@ -0,0 +1,43 @@
+module Analytics
+  module Serializer
+    class Base
+      def initialize(src)
+        @src = src
+      end
+
+      # An abstract method used to save a file at provided path.
+      def save(_path)
+        raise NotImplementedError, 'Abstract Method'
+      end
+    end
+  end
+end
+
+# String extensions - will be moved somewhere else. Somewhere..
+class String
+  # Converts a string to snake_case.
+  def snake_case
+    gsub(/::/, '/')
+      .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+      .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+      .tr('-', '_')
+      .downcase
+ end
+
+  # Converts a string to camelCase.
+  def camel_case
+    gsub(' ', '_')
+      .gsub('-', '_')
+      .snake_case
+      .split('_')
+      .inject([]) { |buffer, e| buffer.push(buffer.empty? ? e : e.capitalize) }
+      .join
+  end
+
+  # Converts a string to PascalCase.
+  def pascal_case
+    val = camel_case
+    val[0] = val[0].capitalize
+    val
+  end
+end

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

@@ -0,0 +1,126 @@
+require_relative '../base'
+
+module Analytics
+  module Serializer
+    class ObjC < Base
+      # It's named AnalyticsFile instead of Analytics,
+      # because it failed to have a class which used the same name as the parent module.
+      class AnalyticsFile
+        def initialize(src)
+          @src = src
+        end
+
+        def save(path)
+          @class_name = 'Analytics'
+
+          @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 "AnalyticsLogger.h"
+            #import "AnalyticsEvent.h"
+            #import "AnalyticsScreen.h"
+            #import "AnalyticsUserProperty.h"
+
+            NS_ASSUME_NONNULL_BEGIN
+
+            __swift_unavailable("This class is only available in ObjC.")
+            @interface Analytics : NSObject <AnalyticsLogger>
+
+            - (instancetype)init NS_UNAVAILABLE;
+            + (instancetype)new NS_UNAVAILABLE;
+
+            - (instancetype)initWithLoggers:(NSArray<id<AnalyticsLogger>> *)loggers;
+
+            + (instancetype)analyticsWithLoggers:(NSArray<id<AnalyticsLogger>> *)loggers;
+
+            @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' %>"
+
+            @interface Analytics ()
+
+            @property (nonatomic, strong, readonly) NSArray<id<AnalyticsLogger>> *loggers;
+
+            @end
+
+            @implementation Analytics
+
+            - (instancetype)initWithLoggers:(NSArray<id<AnalyticsLogger>> *)loggers
+            {
+                if (self = [super init]) {
+                    _loggers = loggers;
+                }
+                return self;
+            }
+
+            + (instancetype)analyticsWithLoggers:(NSArray<id<AnalyticsLogger>> *)loggers
+            {
+                return [[self alloc] initWithLoggers:loggers];
+            }
+
+            #pragma mark - AnalyticsLogger
+
+            - (void)setEnabled:(BOOL)enabled
+            {
+                for (id<AnalyticsLogger> logger in self.loggers) {
+                    [logger setEnabled:enabled];
+                }
+            }
+
+            - (void)logEvent:(AnalyticsEvent *)event
+            {
+                for (id<AnalyticsLogger> logger in self.loggers) {
+                    [logger logEvent:event];
+                }
+            }
+
+            - (void)trackScreen:(AnalyticsScreen *)screen
+            {
+                for (id<AnalyticsLogger> logger in self.loggers) {
+                    [logger trackScreen:screen];
+                }
+            }
+
+            - (void)setUserProperty:(AnalyticsUserProperty *)userProperty
+            {
+                for (id<AnalyticsLogger> logger in self.loggers) {
+                    [logger setUserProperty:userProperty];
+                }
+            }
+
+            @end
+          TEMPLATE
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+require_relative '../base'
+
+module Analytics
+  module Serializer
+    class ObjC < Base
+      # It's named AnalyticsFile instead of Analytics,
+      # because it failed to have a class which used the same name as the parent module.
+      class Enums
+        def initialize(src)
+          @src = src
+        end
+
+        def save(path)
+          @class_name = 'AnalyticsEnums'
+
+          @file_name = @class_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>
+
+            NS_ASSUME_NONNULL_BEGIN
+
+            #pragma mark - Analytics Event Enums (AE)
+            <% Interactor::Event.all_enum_properties(@src['events']).each do |property| -%>
+            <% @enum_name = 'AE' + property['name'].pascal_case -%>
+
+            __swift_unavailable("This enum is only available in ObjC.")
+            typedef NS_CLOSED_ENUM(NSInteger, <%= @enum_name %>) {
+            <% property['values'].each do |value| -%>
+                <%= @enum_name + value.pascal_case %>,
+            <% end -%>
+            };
+            <% end -%>
+
+
+            #pragma mark - Analytics User Property Enums (AUP)
+            <% Interactor::UserProperty.all_enum_user_properties(@src['userProperties']).each do |property| -%>
+            <% @enum_name = 'AUP' + property['name'].pascal_case -%>
+
+            __swift_unavailable("This enum is only available in ObjC.")
+            typedef NS_CLOSED_ENUM(NSInteger, <%= @enum_name %>) {
+            <% property['values'].each do |value| -%>
+                <%= @enum_name + value.pascal_case %>,
+            <% end -%>
+                <%= @enum_name + 'Nil' %>
+            };
+            <% end -%>
+
+            NS_ASSUME_NONNULL_END
+          TEMPLATE
+        end
+      end
+    end
+  end
+end