ios_analytics_cli 1.0.0

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

@@ -0,0 +1,63 @@
+module Analytics
+  module Serializer
+    class Swift < 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)
+          @file_name = 'Analytics.swift'
+          output_path = File.join(path, @file_name)
+          File.write(output_path, render)
+        end
+
+        private
+
+        def render
+          ERB.new(template, nil, '-').result(binding)
+        end
+
+        def template
+          <<~TEMPLATE
+            <%= ERB.new(Analytics::Templates.tmpl_at('header.erb')).result(binding) %>
+
+            import Foundation
+
+            final class Analytics {
+
+                private let loggers: [AnalyticsLogger]
+
+                init(loggers: [AnalyticsLogger]) {
+                    self.loggers = loggers
+                }
+            }
+
+            // MARK: - AnalyticsLogger
+
+            extension Analytics: AnalyticsLogger {
+
+                func set(enabled: Bool) {
+                    loggers.forEach { $0.set(enabled: enabled) }
+                }
+
+                func log(event: Analytics.Event) {
+                    loggers.forEach { $0.log(event: event) }
+                }
+
+                func track(screen: Analytics.Screen) {
+                    loggers.forEach { $0.track(screen: screen) }
+                }
+
+                func set(userProperty: Analytics.UserProperty) {
+                    loggers.forEach { $0.set(userProperty: userProperty) }
+                }
+            }
+          TEMPLATE
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,121 @@
+module Analytics
+  module Serializer
+    class Swift < Base
+      class Event
+        def initialize(src)
+          @src = src
+        end
+
+        def save(path)
+          @file_name = 'AnalyticsEvent.swift'
+          output_path = File.join(path, @file_name)
+          File.write(output_path, render)
+        end
+
+        private
+
+        def render
+          ERB.new(template, nil, '-').result(binding)
+        end
+
+        def template
+          <<~TEMPLATE
+            <%= ERB.new(Analytics::Templates.tmpl_at('header.erb')).result(binding) %>
+
+            import Foundation
+
+            extension Analytics {
+
+                struct Event {
+
+                    let name: String
+                    let properties: [String: Any]
+
+                    private init(name: String, properties: [String: Any] = [:]) {
+                        self.name = name
+                        self.properties = properties
+                    }
+                }
+            }
+
+            // MARK: - Events
+
+            extension Analytics.Event {
+            <% @src["events"].each do |event| -%>
+
+                /// <%= event["description"] -%>
+                <% if event["properties"].nil? %>
+                static var <%= event["name"].camel_case %>: Analytics.Event {
+                    return .init(name: "<%= event["name"] %>")
+                }
+                <% else %>
+                <% event["properties"].each do |property| -%>
+            /// - Parameter <%= property["name"] %>: <%= property["description"] %>
+                <% end -%>
+            static func <%= event["name"].camel_case %>(<%= format_method_params(event["properties"])-%>) -> Analytics.Event {
+                    return .init(name: "<%= event["name"] %>", properties: <%= format_init_properties(event["properties"]) %>)
+                }
+                <% end -%>
+            <% end %>
+            }
+
+            // MARK: - Event Property Enums
+
+            extension Analytics.Event {
+            <% Interactor::Event.all_enum_properties(@src['events']).each do |property| -%>
+
+                /// <%= property["description"] %>
+                enum <%= property["name"].pascal_case -%>: String {
+                <% property["values"].each do |value| -%>
+                case <%= value.camel_case -%> = "<%= value %>"
+                <% end -%>
+            }
+            <% end -%>
+            }
+          TEMPLATE
+        end
+
+        ## Helper methods called from the ERB template
+
+        # Formats the parameters in Swift method.
+        def format_method_params(properties)
+          result = properties.map do |property|
+            "#{property['name'].camel_case}: #{format_property_type(property)}"
+          end
+
+          return result.join(', ')
+        end
+
+        # Maps the property type to Swift 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,
+          # because an enum with the same name will be generated as well
+          if property['values'].nil?
+            case property['type']
+            when 'text'
+              'String'
+            when 'number'
+              'Int'
+            when 'decimal'
+              'Double'
+            else
+              'unknown-type'
+            end
+          else
+            property['name'].pascal_case
+          end
+        end
+
+        # Formats the properties passed to Event's init.
+        def format_init_properties(properties)
+          result = properties.map do |property|
+            "\"#{property['name']}\": #{property['name'].camel_case}#{'.rawValue' unless property['values'].nil?}"
+          end
+          
+          results = "[#{result.join(', ')}]"          
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module Analytics
+  module Serializer
+    class Swift < Base
+      class Logger
+        def initialize(src)
+          @src = src
+        end
+
+        def save(path)
+          @file_name = 'AnalyticsLogger.swift'
+          output_path = File.join(path, @file_name)
+          File.write(output_path, render)
+        end
+
+        private
+
+        def render
+          ERB.new(template, nil, '-').result(binding)
+        end
+
+        def template
+          <<~TEMPLATE
+            <%= ERB.new(Analytics::Templates.tmpl_at('header.erb')).result(binding) %>
+
+            import Foundation
+
+            protocol AnalyticsLogger {
+            	func set(enabled: Bool)
+            	func log(event: Analytics.Event)
+            	func track(screen: Analytics.Screen)
+            	func set(userProperty: Analytics.UserProperty)
+            }
+          TEMPLATE
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module Analytics
+  module Serializer
+    class Swift < Base
+      class Screen
+        def initialize(src)
+          @src = src
+        end
+
+        def save(path)
+          @file_name = 'AnalyticsScreen.swift'
+          output_path = File.join(path, @file_name)
+          File.write(output_path, render)
+        end
+
+        private
+
+        def render
+          ERB.new(template, nil, '-').result(binding)
+        end
+
+        def template
+          <<~TEMPLATE
+            <%= ERB.new(Analytics::Templates.tmpl_at('header.erb')).result(binding) %>
+
+            import Foundation
+
+            extension Analytics {
+
+                struct Screen {
+
+                    let name: String
+
+                    private init(name: String) {
+                        self.name = name
+                    }
+                }
+            }
+
+            // MARK: - Screens
+
+            extension Analytics.Screen {
+            <% @src["screens"].each do |screen| -%>
+
+                /// <%= screen["description"] %>
+                static var <%= screen["name"].camel_case -%>: Analytics.Screen {
+                    return .init(name: "<%= screen["name"] -%>")
+                }
+            <% end -%>
+            }
+          TEMPLATE
+        end
+      end
+    end
+  end
+end

data/lib/ios_analytics_cli/serializers/swift/swift.rb

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

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

@@ -0,0 +1,69 @@
+module Analytics
+  module Serializer
+    class Swift < Base
+      class UserProperty
+        def initialize(src)
+          @src = src
+        end
+
+        def save(path)
+          @file_name = 'AnalyticsUserProperty.swift'
+          output_path = File.join(path, @file_name)
+          File.write(output_path, render)
+        end
+
+        private
+
+        def render
+          ERB.new(template, nil, '-').result(binding)
+        end
+
+        def template
+          <<~TEMPLATE
+            <%= ERB.new(Analytics::Templates.tmpl_at('header.erb')).result(binding) %>
+
+            import Foundation
+
+            extension Analytics {
+
+                struct UserProperty {
+
+                    let name: String
+                    let value: String?
+
+                    private init(name: String, value: String?) {
+                        self.name = name
+                        self.value = value
+                    }
+                }
+            }
+
+            // MARK: - User properties
+
+            extension Analytics.UserProperty {
+            <% @src["userProperties"].each do |user_property| -%>
+
+                /// <%= user_property["description"] %>
+                /// - Parameter value: The value of the user property, or `nil` if You want to remove the user property.
+                static func <%= user_property["name"].camel_case -%>(with value: <%= user_property["values"].nil? ? 'String?' : user_property["name"].pascal_case %>) -> Analytics.UserProperty {
+                    return .init(name: "<%= user_property["name"] -%>", value: <%= user_property["values"].nil? ? 'value' : 'value.rawValue' %>)
+                }
+            <% end -%>
+            }
+
+            extension Analytics.UserProperty {
+            <% Interactor::UserProperty.all_enum_user_properties(@src["userProperties"]).each do |user_property| -%>
+
+                enum <%= user_property["name"].pascal_case %>: String {
+            <% user_property["values"].each do |value| -%>
+                    case <%= value.camel_case %> = "<%= value -%>"
+            <% end -%>
+                }
+            <% end -%>
+            }
+          TEMPLATE
+        end
+      end
+    end
+  end
+end

data/lib/ios_analytics_cli/templates/header.erb

@@ -0,0 +1,7 @@
+//
+//  <%= @file_name %>
+//  Please, don't edit this file manually.
+//
+//  Created by Analytics CLI on <%= Time.now.strftime("%d/%m/%Y") %>.
+//  Copyright (c) <%= Time.now.strftime("%Y") %> Infinum. All rights reserved.
+//

data/lib/ios_analytics_cli/templates/templates.rb

@@ -0,0 +1,12 @@
+module Analytics
+  module Templates
+    # Returns the template at provided path.
+    # Path is relative to the path of this file.
+    # E.g. to get file at templates/swift/test,
+    # call tmpl_at('swift/test').
+    def self.tmpl_at(path)
+      final_path = File.join(__dir__, path)
+      File.open(final_path, &:read)
+    end
+  end
+end

data/lib/ios_analytics_cli/version.rb

@@ -0,0 +1,4 @@
+module Analytics
+  # Current gem's version.
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: ios_analytics_cli
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mario Galijot
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.82.0
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.5.2
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+description: |2
+      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.
+email:
+- mario.galijot@infinum.com
+executables:
+- analytics
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/analytics
+- ios_analytics_cli.gemspec
+- lib/ios_analytics_cli.rb
+- lib/ios_analytics_cli/commands/command.rb
+- lib/ios_analytics_cli/commands/generate.rb
+- lib/ios_analytics_cli/commands/init.rb
+- lib/ios_analytics_cli/error_handler.rb
+- lib/ios_analytics_cli/helpers/terminal.rb
+- lib/ios_analytics_cli/info.rb
+- lib/ios_analytics_cli/interactors/event.rb
+- lib/ios_analytics_cli/interactors/interactor.rb
+- lib/ios_analytics_cli/interactors/user_property.rb
+- lib/ios_analytics_cli/io/config.rb
+- lib/ios_analytics_cli/io/io.rb
+- lib/ios_analytics_cli/serializers/base.rb
+- lib/ios_analytics_cli/serializers/objc/analytics.rb
+- lib/ios_analytics_cli/serializers/objc/enums.rb
+- lib/ios_analytics_cli/serializers/objc/event.rb
+- lib/ios_analytics_cli/serializers/objc/logger.rb
+- lib/ios_analytics_cli/serializers/objc/objc.rb
+- lib/ios_analytics_cli/serializers/objc/screen.rb
+- lib/ios_analytics_cli/serializers/objc/user_property.rb
+- lib/ios_analytics_cli/serializers/swift/analytics.rb
+- lib/ios_analytics_cli/serializers/swift/event.rb
+- lib/ios_analytics_cli/serializers/swift/logger.rb
+- lib/ios_analytics_cli/serializers/swift/screen.rb
+- lib/ios_analytics_cli/serializers/swift/swift.rb
+- lib/ios_analytics_cli/serializers/swift/user_property.rb
+- lib/ios_analytics_cli/templates/header.erb
+- lib/ios_analytics_cli/templates/templates.rb
+- lib/ios_analytics_cli/version.rb
+homepage: https://github.com/infinum/ios-analytics-cli/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: CLI tool that generates Analytics files, for iOS project, from a JSON file.
+test_files: []