mono_repo_deps 0.1.13

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 753c01bf44250b01efb5d8cbc531c0dff8ffc286f4b188871c9918fac7b2e470
+  data.tar.gz: ef3809b782fc7dd37ea35c0cfa96e24ede49e29b3a99ab4392f27ee55a512a83
+SHA512:
+  metadata.gz: 9b913cf21b3d81488e457f2d258dafe97d6bb6b1315a62874b6ece02c6807c1350fdf4cc54c45e36f06d18acebbbdb9734a3dc518e1488f2b0e6b2a81728c310
+  data.tar.gz: 4f6f61ba7ae8e7d98d30eac631e60432b8ebcbbb2a88383bc8a0ce1aea63726dd4fb29e977d66085274e67ec26d8c30cb3df0c71557e525aa07dd206b1d7f7bf

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.7.6

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-09
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at vocrsz@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Nikita Kononov
+
+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,193 @@
+# MonoRepoDeps
+
+Dependency manager to split and organize Ruby modules and namespaces into highlevel packages and manage relations between them
+Next version of [Rdm gem](https://github.com/droidlabs/rdm)
+
+## Idea
+Main goal to implement the gem was to give developers an ability to keep a large codebase in the single git repository (monorepository) with easy access to:
+1) require only needed dependencies
+2) set up loading policies and inflection rules
+3) manage configuration for different environments
+4) run specific tasks on selected packages
+
+## Example Project File Structure
+```bash
+  ├── MonoRepoConfig.rb
+  ├── Gemfile
+  ├── Gemfile.lock
+  ├── bounded_contexts
+  │   ├── orders
+  │   │   ├── bin
+  │   │   │   └── run
+  │   │   ├── package
+  │   │   │   ├── orders
+  │   │   │   │   └── export_orders.rb
+  │   │   │   │
+  │   │   │   └── orders.rb
+  │   │   │
+  │   │   └── Package.rb
+  │   │
+  │   ├── orders_db
+  │   │   ├── package
+  │   │   │   └── orders_db.rb
+  │   │   │
+  │   │   └── Package.rb
+  │   │
+  │   └── cart
+  │       ├── package
+  │       │   └── orders.rb
+  │       │
+  │       └── Package.rb
+  │
+  └── configs
+      ├── orders_config
+      │   ├── default.yml
+      │   └── test.yml
+      │
+      └── api_client_config
+          ├── default.yml
+          └── test.yml
+```
+
+## Package
+  The main MonoRepoDeps entity is the "package".
+  Package configuration is defined in Package.rb file.
+  Each package also have an 'entrypoint' file, which can be defined as package namespace module.
+
+  For example for orders package from project structure above entrypoint file could look the following way:
+  ```ruby
+    module Orders
+    end
+
+    require 'some_gem'
+
+    SomeGem.example_initialization_for(__dir__)
+  ```
+
+  You can declare dependencies rules which will determine what packages should be imported before you will initialize current one
+  ```ruby
+    # ./bounded_contexts/orders/Package.rb
+
+    package do
+      name    'marketplace'
+    end
+
+    dependency do
+      import 'orders_db'
+    end
+
+    dependency :test do
+      import 'cart'
+    end
+  ```
+
+  Having that configuration you can call the following code in your bin/run file
+  ```bash
+    #!/usr/bin/env ruby
+    require 'bundler/setup'
+    require 'mono_repo_deps'
+    MonoRepoDeps.init_package
+
+    Orders::ExportOrders.new.call
+  ```
+
+  Let's take a look at ```MonoRepoDeps.init_package``` command. That is the core feature of MonoRepoDeps and it does the following actions
+  1. Detect which package the caller file belongs to
+  You can also provide that file directly using 'from:' parameter
+  ```MonoRepoDeps.init_package(from: __FILE__)```
+  or providing package name
+  ```MonoRepoDeps.init_package('orders')```
+  2. Build dependencies tree: inside each project we have ```dependency do; end``` block which is provide us information which packages should be loaded before the current one
+  3. For each file in dependency tree:
+      * Using Project Code Loader to autoload/preload package classes and modules
+      * Call ```require``` for entrypoint file
+
+## Configs
+  MonoRepoDeps Configs provides interface to declare and access key-value storage can be specified for certain environment
+
+  Instead of using ENV['SOME_VARIABLE_NAME'] in your ruby files you can set up MonoRepoDeps Configs and use env variables in your code like this:
+  ```ruby
+    MonoRepoDeps.configs.api_client.some_variable_name
+  ```
+  Let's define MonoRepoDeps Config for ```api_client```
+  ```yml
+    # ./configs/api_client/default.yml
+    api_client:
+      some_variable_name: ENV['SOME_VARIABLE_NAME']
+
+    # ./configs/api_client/test.yml
+    api_client:
+      some_variable_name: ENV['SOME_VARIABLE_NAME'] + ENV['TEST_ENV_NUMBER']
+  ```
+
+  Rdm looks up for configs in directory have been set in MonoRepoConfig.rb file with ```set_configs_dir``` method
+  Each config has at least default.yml configuration which can be complemented with :env.yml files
+  Running ```MonoRepoDeps.init_package``` with specified :env will check if corresponding :env.yml file exists and merge it's values to the default configuration
+
+## Project
+  The 2 main entities within MonoRepoDeps project are 'project' and 'package'
+  Project declaration stored in MonoRepoConfig.rb and a parent directory of the file is considered as the project root
+
+  ### Project Configuration File Example
+
+  ```ruby
+    setup do |project|
+      # set up project.env
+      set_env(ENV['RUBY_ENV'] || raise('RUBY_ENV environment variable is not set'))
+
+      # set up directory to look up for project configs
+      set_configs_dir 'configs'
+
+      # set up directory to look up for packages
+      set_package_dirname 'package'
+      set_packages_lookup_subdir 'bounded_contexts'
+
+      # code loader configuration
+      set_loader :zeitwerk do
+        # file patterns to exclude in ruby autoloading
+        ignore "**/schema_migrations"
+        ignore "**/data_migrations"
+
+        # rules to overwrite default filename-to-class strategy
+        overwrite ->(kname) { kname.gsub(/Foo/) { _1.upcase } }
+        overwrite ->(kname) { kname.gsub('Baz', 'BazBar') }
+
+        # another way to define inflection rules
+        inflect "uuid_generator" => "UUIDGenerator"
+      end
+
+      # definition of the task to run rspec on the specific package
+      register_task :rspec_run, on: :package do |package, args|
+        Dir.chdir(package.root_path) do
+          require 'rspec'
+
+          status = RSpec::Core::Runner.run(args, $stderr, $stdout).to_i
+
+          exit(status)
+        end
+      end
+    end
+  ```
+
+## Tasks
+  MonoRepoDeps tasks are an easy way to declare some procedures can be called on you packages/package
+
+  ### Examples
+  ```ruby
+    # MonoRepoConfig.rb
+      setup do |project|
+        # ...
+        register_task :puts_package_name, on: :package do |package, args|
+          puts [package.name, args].inspect
+        end
+        # ...
+      end
+  ```
+
+  You can call defined task that way:
+  ```ruby
+    MonoRepoDeps.tasks.puts_package_name(
+      packages: MonoRepoDeps.packages.filter(name: "orders"),
+      args: [1, 2, 3]
+    )
+  ```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/example/Gemfile

@@ -0,0 +1 @@
+gem 'mono_repo_deps', path: '../'

data/example/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: ..
+  specs:
+    mono_repo_deps (0.1.13)
+      dry-auto_inject (~> 1.0.1)
+      dry-configurable (~> 1.0.1)
+      dry-container (~> 0.11.0)
+      dry-core (~> 1.0.0)
+      dry-system (~> 1.0.1)
+      sorbet-static-and-runtime (~> 0.5.11105)
+      thor
+      zeitwerk (~> 2.6.12)
+
+GEM
+  specs:
+    concurrent-ruby (1.2.2)
+    dry-auto_inject (1.0.1)
+      dry-core (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-configurable (1.0.1)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-container (0.11.0)
+      concurrent-ruby (~> 1.0)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-system (1.0.1)
+      dry-auto_inject (~> 1.0, < 2)
+      dry-configurable (~> 1.0, < 2)
+      dry-core (~> 1.0, < 2)
+      dry-inflector (~> 1.0, < 2)
+    sorbet (0.5.11105)
+      sorbet-static (= 0.5.11105)
+    sorbet-runtime (0.5.11105)
+    sorbet-static (0.5.11105-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11105)
+      sorbet (= 0.5.11105)
+      sorbet-runtime (= 0.5.11105)
+    thor (1.3.0)
+    zeitwerk (2.6.12)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  mono_repo_deps!
+
+BUNDLED WITH
+   2.4.20

data/example/MonoRepoConfig.rb

@@ -0,0 +1,16 @@
+setup do |project|
+  set_env ->() { :test }
+
+  set_configs_dir 'configs'
+  set_package_dirname 'package'
+
+  set_loader :zeitwerk do |project|
+    inflect 'filename' => "FileName"
+    overwrite ->(klass_name) { klass_name.gsub(/Api/) { _1.upcase } }
+    ignore "**/schema_migrations"
+  end
+
+  register_task :print_package_name, on: :package do |package, args|
+    puts package.entrypoint_file
+  end
+end

data/example/bounded_contexts/cart/cart_app/Package.rb

@@ -0,0 +1,11 @@
+package do
+  name 'cart_app'
+end
+
+dependency do
+  import 'cart_core'
+end
+
+dependency :test do
+  import 'test_utils'
+end

data/example/bounded_contexts/cart/cart_app/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mono_repo_deps'
+
+# MonoRepoDeps.init(__dir__)
+
+MonoRepoDeps.import_package(:storefront_core)
+
+require 'irb'
+IRB.start

data/example/bounded_contexts/cart/cart_app/package/cart_app.rb

@@ -0,0 +1,2 @@
+module CartApp
+end

data/example/bounded_contexts/cart/cart_core/Package.rb

@@ -0,0 +1,12 @@
+package do
+  name 'cart_core'
+end
+
+dependency do
+  import 'cart_datasets'
+  import 'orders_query_api', only: ['orders_datasets']
+end
+
+dependency :test do
+  import 'test_utils'
+end

data/example/bounded_contexts/cart/cart_core/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mono_repo_deps'
+
+MonoRepoDeps.init(__dir__)
+
+require 'irb'
+IRB.start

data/example/bounded_contexts/cart/cart_core/package/cart_core.rb

@@ -0,0 +1,2 @@
+module CartCore
+end

data/example/bounded_contexts/cart/cart_datasets/Package.rb

@@ -0,0 +1,10 @@
+package do
+  name 'cart_datasets'
+end
+
+dependency do
+  import 'db_connection'
+end
+
+dependency :test do
+end

data/example/bounded_contexts/cart/cart_datasets/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mono_repo_deps'
+
+MonoRepoDeps.init(__dir__)
+
+require 'irb'
+IRB.start

data/example/bounded_contexts/cart/cart_datasets/package/cart_datasets.rb

@@ -0,0 +1,2 @@
+module CartDatasets
+end

data/example/bounded_contexts/orders/orders_app/Package.rb

@@ -0,0 +1,12 @@
+package do
+  name 'orders_app'
+end
+
+dependency do
+  import 'orders_core'
+end
+
+dependency :test do
+  import 'test_utils'
+  import 'storefront_core'
+end

data/example/bounded_contexts/orders/orders_app/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mono_repo_deps'
+
+MonoRepoDeps.init(__dir__)
+
+require 'irb'
+IRB.start

data/example/bounded_contexts/orders/orders_app/package/orders_app.rb

@@ -0,0 +1,2 @@
+module OrdersApp
+end

data/example/bounded_contexts/orders/orders_core/Package.rb

@@ -0,0 +1,13 @@
+package do
+  name 'orders_core'
+end
+
+dependency do
+  import 'orders_datasets'
+  import 'paypal_client'
+end
+
+dependency :test do
+  import 'test_utils'
+  import 'storefront_core'
+end

data/example/bounded_contexts/orders/orders_core/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mono_repo_deps'
+
+MonoRepoDeps.init(__dir__)
+
+require 'irb'
+IRB.start

data/example/bounded_contexts/orders/orders_core/package/orders_core.rb

@@ -0,0 +1,2 @@
+module OrdersCore
+end

data/example/bounded_contexts/orders/orders_datasets/Package.rb

@@ -0,0 +1,11 @@
+package do
+  name 'orders_datasets'
+end
+
+dependency do
+  import 'db_connection'
+end
+
+dependency :test do
+  import 'test_utils'
+end

data/example/bounded_contexts/orders/orders_datasets/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mono_repo_deps'
+
+MonoRepoDeps.init(__dir__)
+
+require 'irb'
+IRB.start

data/example/bounded_contexts/orders/orders_datasets/package/orders_datasets.rb

@@ -0,0 +1,2 @@
+module OrdersDatasets
+end

data/example/bounded_contexts/orders/orders_query_api/Package.rb

@@ -0,0 +1,13 @@
+package do
+  name 'cart_query_api'
+end
+
+dependency do
+  import 'orders_core'
+  import 'orders_datasets'
+end
+
+dependency :test do
+  import 'test_utils'
+  import 'storefront_core'
+end

data/example/bounded_contexts/orders/orders_query_api/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mono_repo_deps'
+
+MonoRepoDeps.init(__dir__)
+
+require 'irb'
+IRB.start

data/example/bounded_contexts/orders/orders_query_api/package/cart_query_api.rb

@@ -0,0 +1,2 @@
+module CartQueryApi
+end

data/example/bounded_contexts/orders/paypal_client/Package.rb

@@ -0,0 +1,9 @@
+package do
+  name 'paypal_client'
+end
+
+dependency do
+end
+
+dependency :test do
+end

data/example/bounded_contexts/orders/paypal_client/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mono_repo_deps'
+
+MonoRepoDeps.init(__dir__)
+
+require 'irb'
+IRB.start

data/example/bounded_contexts/orders/paypal_client/package/paypal_client.rb

@@ -0,0 +1,2 @@
+module PaypalClient
+end

data/example/bounded_contexts/shared/db_connection/Package.rb

@@ -0,0 +1,10 @@
+package do
+  name 'db_connection'
+end
+
+dependency do
+end
+
+dependency :test do
+  import 'test_utils'
+end

data/example/bounded_contexts/shared/db_connection/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mono_repo_deps'
+
+MonoRepoDeps.init(__dir__)
+
+require 'irb'
+IRB.start

data/example/bounded_contexts/shared/db_connection/package/db_connection.rb

@@ -0,0 +1,2 @@
+module DbConnection
+end