fastlane-plugin-json 0.1.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a322af1714b480f2e163f6b1fbd7cc1ed54e07852e0db684abffb526a888cdc
-  data.tar.gz: bff1e8ed76220e6a7e4ce6ae5eedaf91973ac8d52d5dbe6b42f787184b29e25c
+  metadata.gz: 171f876162ae4aa8045970d6375243fcb2a4f05c8effb677806ca5634e3ca359
+  data.tar.gz: 499dea3eb82ee7cd6390260d13d0218eb347c467f9c6f0544b36aa5b8a12e0be
 SHA512:
-  metadata.gz: 65df970c792ec75c1e41baaa9a3f3a815e6138c96e2ad8dd0f9f79d690c8473b40967f5b112bd337cebc0ff5164f4452e9a19b9f5912a7b5ba2b0dab613a3017
-  data.tar.gz: 33b204d134516933c17c1318ebcb9bc32938933b92b2c066e78d18876c1d2757c3e92097ad65b1fe2eb77ce3bad3f156cbdf4d7479a3eef8b062682503daf338
+  metadata.gz: bc2c2ac056904781c571dbdd3f5c92bc0d50d0f6d46556efd3e8d4491b5fb86148debee6400fbd7df3c9a26e1d8250e15588d193054e0cc0bba04e757b209ba9
+  data.tar.gz: 84c7f37783ee3933209c546ff64df6e08df0517879813c199895899fbb93a30d48c9067edfcb252fbad74ef7aa19cd0b7eb9ed61ed1e3b18d4826361386b52fe

data/README.md

@@ -1,6 +1,19 @@
-# Fastlane Json plugin
-
-[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-json)
+# Fastlane Json plugin <!-- omit in toc -->
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-json) ![Gem Version](https://badge.fury.io/rb/fastlane-plugin-json.svg) ![](https://ruby-gem-downloads-badge.herokuapp.com/fastlane-plugin-json) [![YourActionName Actions Status](https://github.com/MartinGonzalez/fastlane-plugin-json/workflows/Test-Build-Publish/badge.svg)](https://github.com/MartinGonzalez/fastlane-plugin-json/actions)
+
+- [Getting Started](#getting-started)
+- [Actions](#actions)
+  - [read_json](#read_json)
+  - [download_json](#download_json)
+  - [write_json](#write_json)
+  - [merge_jsons](#merge_jsons)
+- [Example](#example)
+- [Run tests for this plugin](#run-tests-for-this-plugin)
+- [Issues and Feedback](#issues-and-feedback)
+- [Troubleshooting](#troubleshooting)
+- [Using _fastlane_ Plugins](#using-fastlane-plugins)
+- [About _fastlane_](#about-fastlane)
 
 ## Getting Started
 
@@ -10,12 +23,17 @@ This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To
 fastlane add_plugin json
 ```
 
-## About json
+## Actions
 
 This plugin provide several actions that will allow you to manipulate and create json files.
 
 ### read_json
 
+| Key       | Description       | Env Var | Default |
+|-----------|-------------------|---------|---------|
+| json_path | Path to json file |         |         |
+| verbose   | verbose           |         |  false  |
+
 Read a json file at specific path as a hash object.
 
 _Having a json file at `path/to/my.json` with the following content:_
@@ -40,6 +58,11 @@ puts my_json[:age]
 
 ### download_json
 
+| Key       | Description       | Env Var | Default |
+|-----------|-------------------|---------|---------|
+| json_url  | Url to json file  |         |         |
+| verbose   | verbose           |         |  false  |
+
 Downloads a json file from server and convert it to a hash object.
 
 ```ruby
@@ -57,6 +80,12 @@ puts my_json[:isDev]
 
 ### write_json
 
+| Key       | Description                               | Env Var | Default |
+|-----------|-------------------------------------------|---------|---------|
+| hash      | Hash that you want to save as a json file |         |         |
+| file_path | Path where you want to save your json     |         |         |
+| verbose   | verbose                                   |         |  false  |
+
 Creates a json file from a hash.
 
 ```ruby
@@ -88,11 +117,53 @@ Will create a my_json.json file with the following content:
 }
 ```
 
-## Example
+### merge_jsons
+
+| Key         | Description                               | Env Var | Default |
+|-------------|-------------------------------------------|---------|---------|
+| jsons_paths | Array of json files paths                 |         |         |
+| output_path | Output path where result will be saved    |         |         |
+| verbose     | verbose                                   |         |  false  |
+
+Merges several json files into one hash as output. Also you can set the `output_path` to save the merged hash into a json file.
+
+Having this files:
+
+`example.json`
+```json
+{
+  "name": "Martin",
+  "age": 30
+}
+```
 
-Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+`example2.json`
+```json
+{
+  "lastName": "Gonzalez",
+  "age": 40,
+  "isDev": true
+}
+```
+
+```ruby
+output_path = "#{__dir__}/tmp/merged.json"
+
+merged_hash = merge_jsons(
+    jsons_paths: [
+      "path/to/example.json",
+      "path/to/example2.json"
+    ],
+    output_path: output_path
+  )
+
+# {:name=>"Martin", :age=>40, :lastName=>"Gonzalez", :isDev=>true}
+```
+
+
+## Example
 
-**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane all`.
 
 ## Run tests for this plugin
 

data/lib/fastlane/plugin/json/actions/download_json_action.rb

@@ -25,6 +25,7 @@ module Fastlane
 
       def self.puts_error!(message)
         UI.user_error!(message)
+        raise StandardError, message
       end
 
       def self.description
@@ -47,14 +48,14 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :verbose,
                                        description: "verbose",
                                        optional: true,
-                                       data_type: Boolean,
+                                       type: Boolean,
                                        default_value: false)
 
         ]
       end
 
       def self.print_params(options)
-        table_title = "Params for read_json #{Fastlane::Json::VERSION}"
+        table_title = "Params for download_json #{Fastlane::Json::VERSION}"
         FastlaneCore::PrintTable.print_values(config: options,
                                               hide_keys: [],
                                               title: table_title)

data/lib/fastlane/plugin/json/actions/merge_jsons_action.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Fastlane
+  module Actions
+    class MergeJsonsAction < Action
+      def self.run(params)
+        jsons_paths = params[:jsons_paths]
+        output_path = params[:output_path]
+        @is_verbose = params[:verbose]
+
+        print_params(params) if @is_verbose
+        put_error!("jsons_path cannot be empty ❌") if jsons_paths.empty?
+
+        hashes = jsons_paths.map do |json_path|
+          put_error!("json_path: #{json_path} is not valid ❌") unless File.exist?(json_path)
+          json_content = File.read(File.expand_path(json_path))
+          begin
+            JSON.parse(json_content, symbolize_names: true)
+          rescue
+            put_error!("File at path #{json_path} has invalid content. ❌")
+          end
+        end
+
+        merged_hash = hashes.reduce({}, :merge)
+
+        write_hash_at(output_path, merged_hash) unless output_path.to_s.empty?
+
+        merged_hash
+      end
+
+      def self.write_hash_at(output_path, hash)
+        file_path_expanded = File.expand_path(output_path)
+        file_dir = File.dirname(file_path_expanded)
+        Dir.mkdir(file_dir) unless File.directory?(file_dir)
+
+        begin
+          File.open(output_path, "w") { |f| f.write(JSON.pretty_generate(hash)) }
+        rescue
+          put_error!("Failed to write json at #{output_path}. ❌")
+        end
+      end
+
+      def self.put_error!(message)
+        UI.user_error!(message)
+        raise StandardError, message
+      end
+
+      def self.description
+        "Merge a group of jsons files and expose a hash with symbolized names as result. Last json predominate over the rest"
+      end
+
+      def self.details
+        "Use this action to merge jsons files and access to it as Hash with symbolized names. Also you can set the output_path to save the result"
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :jsons_paths,
+                                       description: "Array of json files paths",
+                                       type: Array,
+                                       optional: false,
+                                       verify_block: proc do |value|
+                                         UI.user_error!("You must set jsons_paths") unless value && !value.empty?
+                                       end),
+          FastlaneCore::ConfigItem.new(key: :output_path,
+                                       description: "Output path where result will be saved",
+                                       type: String,
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :verbose,
+                                       description: "verbose",
+                                       optional: true,
+                                       default_value: false,
+                                       type: Boolean)
+
+        ]
+      end
+
+      def self.print_params(options)
+        table_title = "Params for merge_json #{Fastlane::Json::VERSION}"
+        FastlaneCore::PrintTable.print_values(config: options,
+                                              hide_keys: [],
+                                              title: table_title)
+      end
+
+      def self.return_value
+        "Hash"
+      end
+
+      def self.authors
+        ["Martin Gonzalez"]
+      end
+
+      def self.is_supported?(_platform)
+        true
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/json/actions/read_json_action.rb

@@ -7,16 +7,27 @@ module Fastlane
     class ReadJsonAction < Action
       def self.run(params)
         json_path = params[:json_path]
+        json_string = params[:json_string]
         @is_verbose = params[:verbose]
 
+        if json_path.nil? && json_string.nil?
+          put_error!("You need to provide a json_path (file to path) or json_string (json as string) ❌")
+          return nil
+        end
+
         print_params(params) if @is_verbose
 
-        unless File.file?(json_path)
-          put_error!("File at path #{json_path} does not exist. Verify that the path is correct ❌")
-          return nil
+        json_content = json_string
+
+        unless json_path.nil?
+          unless File.file?(json_path)
+            put_error!("File at path #{json_path} does not exist. Verify that the path is correct ❌")
+            return nil
+          end
+
+          json_content = File.read(json_path)
         end
 
-        json_content = File.read(json_path)
         begin
           JSON.parse(json_content, symbolize_names: true)
         rescue
@@ -26,6 +37,7 @@ module Fastlane
 
       def self.put_error!(message)
         UI.user_error!(message)
+        raise StandardError, message
       end
 
       def self.description
@@ -41,14 +53,15 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :json_path,
                                        description: "Path to json file",
                                        is_string: true,
-                                       optional: false,
-                                       verify_block: proc do |value|
-                                         UI.user_error!("You must set json_path pointing to a json file") unless value && !value.empty?
-                                       end),
+                                       optional: true),
+          FastlaneCore::ConfigItem.new(key: :json_string,
+                                        description: "A json as string",
+                                        is_string: true,
+                                        optional: true),
           FastlaneCore::ConfigItem.new(key: :verbose,
                                        description: "verbose",
                                        optional: true,
-                                       data_type: Boolean)
+                                       type: Boolean)
 
         ]
       end

data/lib/fastlane/plugin/json/actions/write_json_action.rb

@@ -11,19 +11,12 @@ module Fastlane
         @is_verbose = params[:verbose]
         print_params(params) if @is_verbose
 
-        if file_path.nil? || file_path.empty?
-          put_error!("file_path: value cannot be nil or empty")
-          return
-        end
-
-        if hash.nil?
-          put_error!("hash: value cannot be nil")
-          return
-        end
+        put_error!("file_path: value cannot be nil or empty") if file_path.nil? || file_path.empty?
+        put_error!("hash: value cannot be nil") if hash.nil?
 
-        file_dir = File.dirname(file_path)
+        file_path_expanded = File.expand_path(file_path)
+        file_dir = File.dirname(file_path_expanded)
         Dir.mkdir(file_dir) unless File.directory?(file_dir)
-        print_params(params) if @is_verbose
 
         begin
           File.open(file_path, "w") do |f|
@@ -36,6 +29,7 @@ module Fastlane
 
       def self.put_error!(message)
         UI.user_error!(message)
+        raise StandardError, message
       end
 
       def self.description
@@ -51,7 +45,7 @@ module Fastlane
           FastlaneCore::ConfigItem.new(key: :hash,
                                        description: "Hash that you want to save as a json file",
                                        optional: false,
-                                       data_type: Hash,
+                                       type: Hash,
                                        verify_block: proc do |value|
                                          UI.user_error!("You must set hash: parameter") unless value && !value.empty?
                                        end),
@@ -60,12 +54,12 @@ module Fastlane
                                        is_string: true,
                                        optional: false,
                                        verify_block: proc do |value|
-                                         UI.user_error!("You must set file_path: parameter") unless value.nil?
+                                         UI.user_error!("You must set file_path: parameter") unless value && !value.empty?
                                        end),
           FastlaneCore::ConfigItem.new(key: :verbose,
                                        description: "verbose",
                                        optional: true,
-                                       data_type: Boolean)
+                                       type: Boolean)
         ]
       end
 

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Json
-    VERSION = "0.1.2"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-json
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Martin Gonzalez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2022-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -146,11 +146,12 @@ files:
 - README.md
 - lib/fastlane/plugin/json.rb
 - lib/fastlane/plugin/json/actions/download_json_action.rb
+- lib/fastlane/plugin/json/actions/merge_jsons_action.rb
 - lib/fastlane/plugin/json/actions/read_json_action.rb
 - lib/fastlane/plugin/json/actions/write_json_action.rb
 - lib/fastlane/plugin/json/helper/json_helper.rb
 - lib/fastlane/plugin/json/version.rb
-homepage: 
+homepage: https://github.com/martingonzalez/fastlane-plugin-json
 licenses:
 - MIT
 metadata: {}
@@ -169,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: actions related to json files