fastlane-plugin-json 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dfcdb6a3044272e9451d59fef9f49a0ee8120ee9c0f790d15b7c15ddccdc08b
-  data.tar.gz: c6576b58b55ba9c371355f78c7ed3c56bb2ce1f4502519c7d8dfe8064b36ea4b
+  metadata.gz: 8e5909b7bfad2af730c65240d5950b4c12d6b1ea8f7401253389168a3db91be7
+  data.tar.gz: e3c28f6c140c41647f3a0786d52331a5d52bf83eb760cd0b02de46e36c8db0f8
 SHA512:
-  metadata.gz: 59fc9b843dbb0879a200c531aeac537d4c52277afa2b13b21653eb48c8d42dd8f18734c6ced32d9629cad4777df0b585ab0fa6b7b1b06f90c26331b8331ae748
-  data.tar.gz: 7f6a36f21aba3af6675a6b676b254165640db476a14625ade18ee594aaf701f0bdd62d97e8fa0851252ad7f2ad42c47fa5b2bf5201c118d55f375a8c1e8fd51c
+  metadata.gz: b799ce4e3d0764eec789a46f3b5646dc4f4b8f3d7fba8a94fde0c0248d16d789010c5929fb778e2c53f7b0d9815110dda6de80e905bba2e1795f7e531d10ab94
+  data.tar.gz: 3b4a1d42f610efaffee8909fafc3d3a7463fb44638bc12d8f0caf95d5ed13977a90fdef04af2e16e0226fd8a88ac0e410e12d266c5f30ae3132789c7b1cbdcff

data/README.md

@@ -1,7 +1,21 @@
-# Fastlane Json plugin
+# 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)
 
+
+- [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
 
 This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-json`, add it to your project by running:
@@ -10,7 +24,7 @@ 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.
 
@@ -104,11 +118,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
@@ -54,7 +55,7 @@ module Fastlane
       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

@@ -26,6 +26,7 @@ module Fastlane
 
       def self.put_error!(message)
         UI.user_error!(message)
+        raise StandardError, message
       end
 
       def self.description

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

@@ -11,20 +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_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|
@@ -37,6 +29,7 @@ module Fastlane
 
       def self.put_error!(message)
         UI.user_error!(message)
+        raise StandardError, message
       end
 
       def self.description

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

@@ -1,5 +1,5 @@
 module Fastlane
   module Json
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-json
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Martin Gonzalez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-20 00:00:00.000000000 Z
+date: 2020-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -146,6 +146,7 @@ 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