fastlane-plugin-ios_readme_generate 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8b4765a2a202416b8ad2dd9782e3703c3707dbc
+  data.tar.gz: 273a30f319e166fb247a781d2ff07a5ea992f2ce
+SHA512:
+  metadata.gz: 502deaf167a86b688844be5a257d8e8e0df02abc18d9d4cc0e60b28d9a5a1e38adbab563becf7e0f1cb10f19085d0378271a9b229315466e3665d752268afede
+  data.tar.gz: 584671a21f226a02ecac36b8ea44bbcb9d0f991781b9f5fb821fcf1d5796ad6892b9ec4d5abb9eec4311701f987757b2dd303e2de21ae4ea5008850a302a0cb0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Erik Flores <erikfloresq@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# ios_readme_generate plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-ios_readme_generate)
+
+## Getting Started
+
+This project is a [fastlane](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-ios_readme_generate`, add it to your project by running:
+
+```bash
+fastlane add_plugin ios_readme_generate
+```
+
+## About ios_readme_generate
+
+Create readme for with some data for iOS projects
+
+## Example
+
+```ruby
+ios_readme_generate(
+  app_name: "Orbis Mobile",
+  app_id: "pe.orbis.urbania",
+  app_version: "6.6.6",
+  build: "46",
+  language: "Swift",
+  deployment_target: "iOS 9",
+  file_destination: "./docs/README.md"
+)
+```
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using `fastlane` Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About `fastlane`
+
+`fastlane` is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/ios_readme_generate.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/ios_readme_generate/version'
+
+module Fastlane
+  module IosReadmeGenerate
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::IosReadmeGenerate.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/ios_readme_generate/actions/ios_readme_generate_action.rb

@@ -0,0 +1,100 @@
+module Fastlane
+  module Actions
+    class IosReadmeGenerateAction < Action
+      def self.run(params)
+
+        ios_readme = Helper::IosReadmeGenerateHelper.new
+
+        app_name = ios_readme.addValue("app_name",params[:app_name])
+        app_id = ios_readme.addValue("app_id",params[:app_id])
+        app_version = ios_readme.addValue("app_version",params[:app_version])
+        build = ios_readme.addValue("build",params[:build])
+        language = ios_readme.addValue("language",params[:language])
+        deployment_target = ios_readme.addValue("deployment_target",params[:deployment_target])
+        file_destination = ios_readme.addValue("file_destination",params[:file_destination])
+
+        begin
+          command = ["ios-readme-generator",
+                    app_name,
+                    app_id,
+                    app_version,
+                    build,
+                    language,
+                    deployment_target,
+                    file_destination].compact.join(" ")
+          Action.sh(command,
+                    print_command: true,
+                    print_command_output: true)
+        rescue Exception => e
+          UI.error("ios-readme-generator not installed, please install with npm or yarn in global mode.")
+        end
+
+      end
+
+      def self.description
+        "Create readme for ios projects :D"
+      end
+
+      def self.authors
+        ["Erik Flores"]
+      end
+
+      def self.return_value
+        # If your method provides a return value, you can describe here what it does
+      end
+
+      def self.details
+        # Optional:
+        "Create readme for ios projects"
+      end
+
+      def self.available_options
+        [
+           FastlaneCore::ConfigItem.new(key: :app_name,
+                                   env_name: "IOS_README_APP_NAME",
+                                description: "Add the name of the app",
+                                   optional: true,
+                                       type: String),
+           FastlaneCore::ConfigItem.new(key: :app_id,
+                                   env_name: "IOS_README_APP_ID",
+                                description: "Add the ID of the app",
+                                   optional: true,
+                                       type: String),
+           FastlaneCore::ConfigItem.new(key: :app_version,
+                                   env_name: "IOS_README_APP_VERSION",
+                                description: "Add the App Version of the app",
+                                   optional: true,
+                                       type: String),
+           FastlaneCore::ConfigItem.new(key: :build,
+                                   env_name: "IOS_README_BUILD",
+                                description: "Add the build of the app",
+                                   optional: true,
+                                       type: String),
+           FastlaneCore::ConfigItem.new(key: :language,
+                                   env_name: "IOS_README_LANGUAGE",
+                                description: "Add the language with development the app",
+                                   optional: true,
+                                       type: String),
+           FastlaneCore::ConfigItem.new(key: :deployment_target,
+                                   env_name: "IOS_README_DEPLOYMENT_TARGET",
+                                description: "Add the deployment of the app",
+                                   optional: true,
+                                       type: String),
+           FastlaneCore::ConfigItem.new(key: :file_destination,
+                                   env_name: "IOS_README_file_destination",
+                                description: "Add the destination of the README",
+                                   optional: true,
+                                       type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
+        # See: https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Platforms.md
+        #
+        # [:ios, :mac, :android].include?(platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/ios_readme_generate/helper/ios_readme_generate_helper.rb

@@ -0,0 +1,21 @@
+module Fastlane
+  module Helper
+    class IosReadmeGenerateHelper
+      # class methods that you define here become available in your action
+      # as `Helper::IosReadmeGenerateHelper.your_method`
+      #
+
+      def addValue(key,value)
+        if !value.to_s.empty?
+          return "--#{key} \"#{value}\""
+        else
+          return nil
+        end
+      end
+
+      def self.show_message
+        UI.message("Hello from the ios_readme_generate plugin helper!")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module IosReadmeGenerate
+    VERSION = "0.3.0"
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-ios_readme_generate
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Erik Flores
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+description: 
+email: erikfloresq@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/ios_readme_generate.rb
+- lib/fastlane/plugin/ios_readme_generate/actions/ios_readme_generate_action.rb
+- lib/fastlane/plugin/ios_readme_generate/helper/ios_readme_generate_helper.rb
+- lib/fastlane/plugin/ios_readme_generate/version.rb
+homepage: https://github.com/erikfloresq/fastlane-plugin-ios_readme_generate
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Create readme for ios projects
+test_files: []