fastlane-plugin-ionic 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d179eb835417527f3cc1322e07b8ed8ff4d90d3
-  data.tar.gz: 84c7810e7f7a295f64dd3ea752904cd6f4f1da38
+  metadata.gz: 3f9a5b7b3ba70799970af36c04b593d103a24c94
+  data.tar.gz: 1beb8a562abe037dcfc1b3d63ff36ca2eccaf1df
 SHA512:
-  metadata.gz: fa39f9ffff6e6897bfc10eb1842a4f8ef95479c8089c4475824bb858287761c4c9e88fd126e90c410aff44c5af418924ea5188e4f13b095a7f6f3b3cfbb58342
-  data.tar.gz: 73778a6dda9e2e4477d4c02e49d7de8ece739ec52881bd56a9f11e7ac344853cf6b365fd7e3b3083d21736d550661676a89aa0b6bc1a87ffe959f833f2f9e281
+  metadata.gz: 415582a5eb8c2c010c8bd19c2835b5606b2399b5a2d37723ee7d03b2e4001248f98a0c0078b0536563d16d32c1a9c72e101762ee68f3a4dfb75da1dfa7390f24
+  data.tar.gz: bd765bb631defb1237c6a331a01531e391d1d24dd863d5118addc08f4f947decbd4e310b9fb6dae805d5382f9aa6a27112872b26b573e608e649ecd5fec0ae15

data/README.md

@@ -1,12 +1,10 @@
-# Ionic Plugin
+# _fastlane_ Plugin for Ionic CLI
 
-[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-ionic)
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-ionic) [![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/ionic-zone/fastlane-plugin-ionic/blob/master/LICENSE)
+[![Gem](https://img.shields.io/gem/v/fastlane-plugin-ionic.svg?style=flat)](http://rubygems.org/gems/fastlane-plugin-ionic)
 
-> Work in Progress: This is a simple fork of the fastlane cordova plugin with "cordova" replaced with "ionic". It is not tested yet at all. Soon it will support all options of `ionic cordova build`.
-
-## Features
-
-- Build your Ionic project inside a lane
+This _fastlane_ plugin lets you build your Ionic Cordova project via the [Ionic Command line tool](https://ionicframework.com/docs/cli/), `ionic`, and its `ionic cordova build` command in a _fastlane_ lane.  
+It is based on [fastlane-plugin-cordova](https://github.com/bamlab/fastlane-plugin-cordova) (where it borrows most of its code).
 
 ## Getting Started
 
@@ -16,7 +14,26 @@ This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To ge
 fastlane add_plugin ionic
 ```
 
-Then you can integrate it into your Fastlane setup:
+## Actions
+
+### `ionic`
+
+Run `ionic cordova build` to build your Ionic project.
+
+```ruby
+ionic(
+  platform: 'ios', # Build your iOS Ionic project
+) 
+ionic(
+  platform: 'android', # Build your Android Ionic project
+  release: false # Build a "Debug" app
+) 
+```
+
+
+## Examples
+
+Lanes using these actions could look like this:
 
 ```ruby
 platform :ios do
@@ -52,7 +69,7 @@ apple_id "apple@id.com"
 team_id "28323HT"
 ```
 
-If using **Crosswalk**, replace `supply(apk: ENV['CORDOVA_ANDROID_RELEASE_BUILD_PATH'])` by:
+If you're using **Crosswalk**, replace `supply(apk: ENV['CORDOVA_ANDROID_RELEASE_BUILD_PATH'])` (and equivalents) by:
 ```
 supply(
   apk_paths: [

data/lib/fastlane/plugin/ionic/actions/ionic_action.rb

@@ -6,6 +6,9 @@ module Fastlane
     end
 
     class IonicAction < Action
+
+      # valid action params
+
       ANDROID_ARGS_MAP = {
         keystore_path: 'keystore',
         keystore_password: 'storePassword',
@@ -20,6 +23,7 @@ module Fastlane
         provisioning_profile: 'provisioningProfile',
       }
 
+      # do rewriting and copying of action params
       def self.get_platform_args(params, args_map)
         platform_args = []
         args_map.each do |action_key, cli_param|
@@ -32,6 +36,8 @@ module Fastlane
         return platform_args.join(' ')
       end
 
+      # map action params to the cli param they will be used for
+
       def self.get_android_args(params)
         if params[:key_password].empty?
           params[:key_password] = params[:keystore_password]
@@ -44,7 +50,7 @@ module Fastlane
         app_identifier = CredentialsManager::AppfileConfig.try_fetch_value(:app_identifier)
 
         if params[:provisioning_profile].empty?
-          params[:provisioning_profile] = ENV['SIGH_UUID'] || ENV["sigh_#{app_identifier}_#{params[:type].sub("-","")}"]
+          params[:provisioning_profile] = ENV['SIGH_UUID'] || ENV["sigh_#{app_identifier}_#{params[:type].sub("-","")}"] # TODO What does this do? Does it also work for `match`?
         end
 
         if params[:type] == 'adhoc'
@@ -57,17 +63,20 @@ module Fastlane
         return self.get_platform_args(params, IOS_ARGS_MAP)
       end
 
-      def self.check_platform(platform)
+      # add cordova platform if missing (run #1)
+      def self.check_and_add_platform(platform)
         if platform && !File.directory?("./platforms/#{platform}")
           sh "ionic cordova platform add #{platform}"
         end
       end
 
+      # app_name
       def self.get_app_name()
         config = REXML::Document.new(File.open('config.xml'))
-        return config.elements['widget'].elements['name'].first.value
+        return config.elements['widget'].elements['name'].first.value # TODO Simplify!? (Check logic in cordova)
       end
 
+      # actual building! (run #2)
       def self.build(params)
         args = [params[:release] ? '--release' : '--debug']
         args << '--device' if params[:device]
@@ -75,8 +84,9 @@ module Fastlane
         android_args = self.get_android_args(params) if params[:platform].to_s == 'android'
         ios_args = self.get_ios_args(params) if params[:platform].to_s == 'ios'
 
+        # TODO Extract param string for prepare and compile here
         if params[:cordova_prepare]
-          sh "ionic cordova prepare #{params[:platform]} #{args.join(' ')} #{ios_args} -- #{android_args}"
+          sh "ionic cordova prepare #{params[:platform]} #{args.join(' ')} -- #{ios_args} -- -- #{android_args}" # TODO only attach set args - makes a nicer command
         end
 
         if params[:platform].to_s == 'ios' && !params[:build_number].to_s.empty?
@@ -90,19 +100,22 @@ module Fastlane
           )
         end
 
-        sh "ionic cordova compile #{params[:platform]} #{args.join(' ')} #{ios_args} -- #{android_args}"
+        sh "ionic cordova compile #{params[:platform]} #{args.join(' ')} -- #{ios_args} -- -- #{android_args}" # TODO only attach set args - makes a nicer command
       end
 
+      # export build paths (run #3)
       def self.set_build_paths(is_release)
         app_name = self.get_app_name()
         build_type = is_release ? 'release' : 'debug'
 
         ENV['CORDOVA_ANDROID_RELEASE_BUILD_PATH'] = "./platforms/android/build/outputs/apk/android-#{build_type}.apk"
         ENV['CORDOVA_IOS_RELEASE_BUILD_PATH'] = "./platforms/ios/build/device/#{app_name}.ipa"
+
+        # TODO https://github.com/bamlab/fastlane-plugin-cordova/issues/7
       end
 
       def self.run(params)
-        self.check_platform(params[:platform])
+        self.check_and_add_platform(params[:platform])
         self.build(params)
         self.set_build_paths(params[:release])
       end
@@ -235,7 +248,7 @@ module Fastlane
       end
 
       def self.authors
-        ['almouro']
+        ['Jan Piotrowski']
       end
 
       def self.is_supported?(platform)

data/lib/fastlane/plugin/ionic/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Ionic
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-ionic
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jan Piotrowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-06 00:00:00.000000000 Z
+date: 2017-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -106,7 +106,7 @@ files:
 - lib/fastlane/plugin/ionic/actions/ionic_action.rb
 - lib/fastlane/plugin/ionic/helper/ionic_helper.rb
 - lib/fastlane/plugin/ionic/version.rb
-homepage: https://github.com/janpio/fastlane-plugin-ionic
+homepage: https://github.com/ionic-zone/fastlane-plugin-ionic
 licenses:
 - MIT
 metadata: {}