check_dependencies 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a73f424d5cc5e08111750a3b039462c0e300fc84fbe1d87764a1130bb44c016
-  data.tar.gz: 7267576a8ff4408a1aafad2298538c1a7b93303723a0940d8a22faad9715bb1b
+  metadata.gz: b59a47c5d8d3061675a6e65e54208c165f191889dff8e155fafe30bee1427b4a
+  data.tar.gz: 9a53f687b2dd4502ddb42a38be5d2b48e41f839d6eb2923bac1258aee057bf61
 SHA512:
-  metadata.gz: 3bc20fb056d628e70992ccf439e02d5f68d44d659df56460d39bf90d9d6fe325dcef69425ea11eef7a11dabc74dd550893c09433d558ba4f46a48ad0e7dc1dfe
-  data.tar.gz: 117ce102e6919275d7aa9b9cd7ad2d448e0bf5f9cfd620cb93f638b01b0d0868519c29d038b35cbcb7e26cdc6f7e58d07b422b647c9dd2026d5f5a628e4c5aa2
+  metadata.gz: a585576604889412b7b2e9b628841e1ac641c49e33b0716ef1fa57962a3830a362c5e42bad867e23110c662c87d0bf2eb81fab1d336bd165f43884438a20bf4b
+  data.tar.gz: 8e360c2429323cd223abefb702918867917f4276bc3a278b06635a2b00b123c3f3c5c6861cceca5bf9302e33bd4eb7a267dc8a4c3319f62cd622e28547c129c8

data/CODE_OF_CONDUCT.md

@@ -1,39 +1,79 @@
-# CheckDependencies
+```markdown
+# check_dependencies Gem
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/check_dependencies`. To experiment with that code, run `bin/console` for an interactive prompt.
+check_dependencies Gem is a Ruby gem that offers utilities to assist in managing CocoaPods dependencies within iOS projects. This gem provides functionality to dynamically switch between local path-based dependencies and remote git branch-based dependencies.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Install the gem by adding it to your Gemfile:
+
+```ruby
+gem 'check_dependencies', git: 'https://github.com/ITxiansheng/check_dependencies.git'
+```
 
-Install the gem and add to the application's Gemfile by executing:
+And then execute:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+$ bundle install
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it yourself as:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+$ gem install check_dependencies
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+The gem provides a command-line interface for interacting with its functionalities. You can use the `check_dependencies` command followed by appropriate options.
+```bash
+check_dependencies --help
+``` 
+### Command Syntax
+
+```bash
+check_dependencies --lockPath LOCK_PATH --depWay DEP_WAY --configPath CONFIG_PATH
+```
+
+### Options
+
+- `--lockPath LOCK_PATH`: Specifies the path to your Podfile.lock file.
+- `--depWay DEP_WAY`: Specifies the dependency mode. This can be either `path` for local path dependencies or `branch` for remote git branch dependencies.
+- `--configPath CONFIG_PATH`: Specifies the path to the configuration file containing dependency configurations.
+
+### Example
+
+```bash
+check_dependencies --lockPath ./Podfile.lock --depWay path --configPath ./repo_configs.txt
+```
 
-## Development
+## Functions Overview
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+The gem provides the following key functionalities:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- Parsing `Podfile.lock` content to extract pod dependencies.
+- Generating Podfile entries for local path or remote git branch dependencies.
+- Processing and formatting dependencies for correct integration into Podfiles.
+
+## Workflow
+
+1. **Configuration Preparation**: Prepare the `repo_configs` file with the necessary configuration for each library. This file should map library names to their configuration, including local path, branch name, and git URL.
+
+2. **Running the Gem**: Execute the gem with the required options. Based on the specified `depWay`, the gem will process the `Podfile.lock` file and the `repo_configs` to output the necessary Podfile entries.
+
+3. **Integration**: After generating the Podfile entries, integrate them into your Podfile as needed. This allows you to switch between using local versions of libraries (for development or debugging) and their remote versions (for production or shared development).
+
+## Note
+
+- Ensure that the `repo_configs` file is properly formatted and from a trusted source to avoid potential security risks.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/check_dependencies. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/check_dependencies/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at [example/check_dependencies](https://github.com/ITxiansheng/check_dependencies). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ITxiansheng/check_dependencies/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```
 
-## Code of Conduct
-
-Everyone interacting in the CheckDependencies project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/check_dependencies/blob/main/CODE_OF_CONDUCT.md).
+This README provides an overview of the gem's installation, usage, functions, workflow, notes, contributing guidelines, and license information. Adjust as needed for your specific project and preferences.

data/README.md

@@ -1,39 +1,79 @@
-# CheckDependencies
+```markdown
+# check_dependencies Gem
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/check_dependencies`. To experiment with that code, run `bin/console` for an interactive prompt.
+check_dependencies Gem is a Ruby gem that offers utilities to assist in managing CocoaPods dependencies within iOS projects. This gem provides functionality to dynamically switch between local path-based dependencies and remote git branch-based dependencies.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Install the gem by adding it to your Gemfile:
+
+```ruby
+gem 'check_dependencies', git: 'https://github.com/ITxiansheng/check_dependencies.git'
+```
 
-Install the gem and add to the application's Gemfile by executing:
+And then execute:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+$ bundle install
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it yourself as:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+```bash
+$ gem install check_dependencies
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+The gem provides a command-line interface for interacting with its functionalities. You can use the `check_dependencies` command followed by appropriate options.
+```bash
+check_dependencies --help
+``` 
+### Command Syntax
+
+```bash
+check_dependencies --lockPath LOCK_PATH --depWay DEP_WAY --configPath CONFIG_PATH
+```
+
+### Options
+
+- `--lockPath LOCK_PATH`: Specifies the path to your Podfile.lock file.
+- `--depWay DEP_WAY`: Specifies the dependency mode. This can be either `path` for local path dependencies or `branch` for remote git branch dependencies.
+- `--configPath CONFIG_PATH`: Specifies the path to the configuration file containing dependency configurations.
+
+### Example
+
+```bash
+check_dependencies --lockPath ./Podfile.lock --depWay path --configPath ./repo_configs.txt
+```
 
-## Development
+## Functions Overview
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+The gem provides the following key functionalities:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+- Parsing `Podfile.lock` content to extract pod dependencies.
+- Generating Podfile entries for local path or remote git branch dependencies.
+- Processing and formatting dependencies for correct integration into Podfiles.
+
+## Workflow
+
+1. **Configuration Preparation**: Prepare the `repo_configs` file with the necessary configuration for each library. This file should map library names to their configuration, including local path, branch name, and git URL.
+
+2. **Running the Gem**: Execute the gem with the required options. Based on the specified `depWay`, the gem will process the `Podfile.lock` file and the `repo_configs` to output the necessary Podfile entries.
+
+3. **Integration**: After generating the Podfile entries, integrate them into your Podfile as needed. This allows you to switch between using local versions of libraries (for development or debugging) and their remote versions (for production or shared development).
+
+## Note
+
+- Ensure that the `repo_configs` file is properly formatted and from a trusted source to avoid potential security risks.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/check_dependencies. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/check_dependencies/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at [example/check_dependencies](https://github.com/ITxiansheng/check_dependencies). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ITxiansheng/check_dependencies/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```
 
-## Code of Conduct
-
-Everyone interacting in the CheckDependencies project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/check_dependencies/blob/main/CODE_OF_CONDUCT.md).
+This README provides an overview of the gem's installation, usage, functions, workflow, notes, contributing guidelines, and license information. Adjust as needed for your specific project and preferences.

data/bin/check_dependencies

@@ -203,7 +203,7 @@ end.parse!
 
 # Check if all required arguments were provided
 if options[:lockPath].nil? || options[:depWay].nil? || options[:configPath].nil?
-  puts "Please provide lockPath, depWay, and configPath parameters.\n  you can run:\n ruby MapHelper.rb --help "
+  puts "Please provide lockPath, depWay, and configPath parameters.\n  you can run:\n check_dependencies --help "
   exit
 end
 

data/check_dependencies.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "check_dependencies"
-  spec.version       = "0.1.1"
+  spec.version       = "0.1.2"
   spec.authors       = ["ITxiansheng"]
   spec.email         = ["itxiansheng@gmail.com"]
 

data/lib/check_dependencies.rb

@@ -203,7 +203,7 @@ end.parse!
 
 # Check if all required arguments were provided
 if options[:lockPath].nil? || options[:depWay].nil? || options[:configPath].nil?
-  puts "Please provide lockPath, depWay, and configPath parameters.\n  you can run:\n ruby MapHelper.rb --help "
+  puts "Please provide lockPath, depWay, and configPath parameters.\n  you can run:\n check_dependencies --help "
   exit
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: check_dependencies
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - ITxiansheng