check_dependencies 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b09ec9dbfff4ae05a366698f0c9a3cfa88ff6f6e22b00a8fb87a714fc779337
-  data.tar.gz: 9813997bb97acac6fee25a7167d28427ef7a20ee4d13acc2620a6cb13b7fcf57
+  metadata.gz: 0a73f424d5cc5e08111750a3b039462c0e300fc84fbe1d87764a1130bb44c016
+  data.tar.gz: 7267576a8ff4408a1aafad2298538c1a7b93303723a0940d8a22faad9715bb1b
 SHA512:
-  metadata.gz: 2c0482690d841b1ac71f8a75a7c73d4b582ed0875b35a6902ed1fce6cf98d4e192114017677785390bb49c25c0a9ac280b4ce986732a4d69ee20663227ed8cde
-  data.tar.gz: 95b16ef3c5a139b0f0a888a5eed4e51ef1c52ce5cf960b4b940e9a5d39b073524014cb44a8a867547e2fd3852bf886a2fd846b5392ae28aece9428d9d9e4d469
+  metadata.gz: 3bc20fb056d628e70992ccf439e02d5f68d44d659df56460d39bf90d9d6fe325dcef69425ea11eef7a11dabc74dd550893c09433d558ba4f46a48ad0e7dc1dfe
+  data.tar.gz: 117ce102e6919275d7aa9b9cd7ad2d448e0bf5f9cfd620cb93f638b01b0d0868519c29d038b35cbcb7e26cdc6f7e58d07b422b647c9dd2026d5f5a628e4c5aa2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-13
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -1,77 +1,39 @@
-```markdown
-# check_dependencies Gem
+# CheckDependencies
 
-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.
+TODO: Delete this and the text below, and describe your gem
 
-## Installation
+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.
 
-Install the gem by adding it to your Gemfile:
+## Installation
 
-```ruby
-gem 'check_dependencies', git: 'https://github.com/ITxiansheng/check_dependencies.git'
-```
+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.
 
-And then execute:
+Install the gem and add to the application's Gemfile by executing:
 
-```bash
-$ bundle install
-```
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
 
-Or install it yourself as:
+If bundler is not being used to manage dependencies, install the gem by executing:
 
-```bash
-$ gem install check_dependencies
-```
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
 
 ## Usage
 
-The gem provides a command-line interface for interacting with its functionalities. You can use the `check_dependencies` command followed by appropriate options.
-
-### 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
-```
+TODO: Write usage instructions here
 
-## Functions Overview
+## Development
 
-The gem provides the following key functionalities:
+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.
 
-- 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.
+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).
 
 ## Contributing
 
-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).
+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).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-```
 
-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.
+## 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).

data/Gemfile

@@ -1,6 +1,10 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in check_all_depencies.gemspec
+# Specify your gem's dependencies in check_dependencies.gemspec
 gemspec
+
+gem "rake", "~> 13.0"
+
+gem "standard", "~> 1.3"

data/README.md

@@ -1,77 +1,39 @@
-```markdown
-# check_dependencies Gem
+# CheckDependencies
 
-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.
+TODO: Delete this and the text below, and describe your gem
 
-## Installation
+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.
 
-Install the gem by adding it to your Gemfile:
+## Installation
 
-```ruby
-gem 'check_dependencies', git: 'https://github.com/ITxiansheng/check_dependencies.git'
-```
+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.
 
-And then execute:
+Install the gem and add to the application's Gemfile by executing:
 
-```bash
-$ bundle install
-```
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
 
-Or install it yourself as:
+If bundler is not being used to manage dependencies, install the gem by executing:
 
-```bash
-$ gem install check_dependencies
-```
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
 
 ## Usage
 
-The gem provides a command-line interface for interacting with its functionalities. You can use the `check_dependencies` command followed by appropriate options.
-
-### 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
-```
+TODO: Write usage instructions here
 
-## Functions Overview
+## Development
 
-The gem provides the following key functionalities:
+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.
 
-- 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.
+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).
 
 ## Contributing
 
-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).
+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).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-```
 
-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.
+## 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).

data/Rakefile

@@ -1,2 +1,6 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-task :default => :spec
+require "standard/rake"
+
+task default: :standard

data/bin/check_dependencies

@@ -165,7 +165,7 @@ require 'json'
 
 options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: check_all_depencies --lockPath LOCK_PATH --depWay DEP_WAY --configPath CONFIG_PATH"
+  opts.banner = "Usage: check_dependencies --lockPath LOCK_PATH --depWay DEP_WAY --configPath CONFIG_PATH"
 
   opts.on("--lockPath LOCK_PATH", "Specify the Podfile.lock path") do |lockPath|
     options[:lockPath] = lockPath

data/bin/console

@@ -1,14 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
-require "check_all_depencies"
+require "check_dependencies"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
 require "irb"
 IRB.start(__FILE__)

data/check_dependencies.gemspec

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

data/lib/check_dependencies/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CheckDependencies
+  VERSION = "0.1.0"
+end

data/lib/{check_all_depencies.rb → check_dependencies.rb}

@@ -165,7 +165,7 @@ require 'json'
 
 options = {}
 OptionParser.new do |opts|
-  opts.banner = "Usage: check_all_depencies --lockPath LOCK_PATH --depWay DEP_WAY --configPath CONFIG_PATH"
+  opts.banner = "Usage: check_dependencies --lockPath LOCK_PATH --depWay DEP_WAY --configPath CONFIG_PATH"
 
   opts.on("--lockPath LOCK_PATH", "Specify the Podfile.lock path") do |lockPath|
     options[:lockPath] = lockPath

data/sig/check_dependencies.rbs

@@ -0,0 +1,4 @@
+module CheckDependencies
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: check_dependencies
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - ITxiansheng
@@ -48,6 +48,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -57,8 +58,9 @@ files:
 - bin/console
 - bin/setup
 - check_dependencies.gemspec
-- lib/check_all_depencies.rb
-- lib/check_all_depencies/version.rb
+- lib/check_dependencies.rb
+- lib/check_dependencies/version.rb
+- sig/check_dependencies.rbs
 homepage: https://github.com/ITxiansheng/check_dependencies
 licenses:
 - MIT

data/lib/check_all_depencies/version.rb

@@ -1,3 +0,0 @@
-module CheckAllDepencies
-  VERSION = "0.1.0"
-end