cobra_commander 0.15.0 → 1.0.0

data/lib/cobra_commander/registry.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module CobraCommander
+  module Registry
+    def [](key)
+      Class.new(self) do
+        define_singleton_method(:key) { key }
+        define_method(:key) { key }
+
+        def self.inherited(base)
+          super
+          superclass.all[key] = base
+        end
+      end
+    end
+
+    def all
+      @all ||= {}
+    end
+
+    def select(**selector)
+      return all.values unless selector.values.any?
+
+      all.filter_map do |key, klass|
+        klass if selector[key]
+      end
+    end
+  end
+end

data/lib/cobra_commander/source.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "cobra_commander/package"
+require "cobra_commander/registry"
+
+module CobraCommander
+  class Source
+    Error = Class.new(StandardError)
+
+    include Enumerable
+    extend CobraCommander::Registry
+
+    attr_reader :path, :config
+
+    def initialize(path, config)
+      @path = Pathname.new(path)
+      @config = config || {}
+      super()
+    end
+
+    def to_ary
+      to_a
+    end
+
+    def each(&block)
+      packages.each(&block)
+    rescue Errno::ENOENT => e
+      raise Error, e.message
+    end
+
+    def self.load(path, config = nil, **selector)
+      select(**selector).map do |source|
+        source.new(path, config&.dig(source.key))
+      end
+    end
+  end
+end

data/lib/cobra_commander/umbrella.rb

@@ -1,40 +1,93 @@
 # frozen_string_literal: true
 
+require "yaml"
+
 module CobraCommander
   # An umbrella application
   class Umbrella
-    attr_reader :name, :path
+    attr_reader :path, :config
+
+    def self.load_config(path)
+      return {} unless path.exist?
+
+      YAML.safe_load(path.read, permitted_classes: [Symbol], aliases: true)
+    end
 
-    def initialize(name, path)
-      @root_component = Component.new(self, name)
-      @path = path
+    # Umbrella constructor. This will load the given source packages.
+    #
+    # @see Umbrella#load
+    # @param path [String,Pathname] path to umbrella app
+    # @param **source_selector [Symbol => Boolean] selector as explained above
+    #
+    def initialize(path, config = nil, **source_selector)
+      @path = Pathname.new(path)
       @components = {}
+      @config = config || Umbrella.load_config(@path.join("cobra.yml"))
+      load(**source_selector)
     end
 
+    #
+    # Finds a component by name
+    #
+    # @param name [String] the name of the component
+    # @return [::CobraCommander::Component,nil] the component with a matching name or nil
+    #
     def find(name)
       @components[name]
     end
 
-    def root
-      @root_component
-    end
-
-    def resolve(component_root_path)
-      return root if root.root_paths.include?(component_root_path)
-
+    #
+    # Resolve a component given the path.
+    #
+    # This method resolves the component if the given path is inside
+    # any of the packages composing this component.
+    #
+    # @param path [String,Pathname] the path to be resolved
+    # @return [::CobraCommander::Component,nil] the component where the path is
+    #
+    def resolve(path)
       components.find do |component|
-        component.root_paths.include?(component_root_path)
+        component.root_paths.any? do |component_path|
+          component_path.eql?(Pathname.new(path)) || path.to_s.start_with?("#{component_path.cleanpath}/")
+        end
       end
     end
 
-    def add_source(key, source)
-      @root_component.add_package key, source.root
-      source.packages.each do |packages|
-        @components[packages.name] ||= Component.new(self, packages.name)
-        @components[packages.name].add_package key, packages
+    #
+    # Loads the given sources, or all of none given. This method is fired
+    # by the constructor with the inital selector.
+    #
+    # I.e.:
+    #
+    #   If the environment has both ruby and yarn plugins loaded, this
+    #   would load the yarn workspaces packages and rubygems package
+    #   graphs:
+    #
+    #      umbrella.load(ruby: true, js: true)
+    #
+    #   If no selector is given, all plugins are loaded. So assuming the
+    #   same plugins exist, this would also load yarn and ruby packages:
+    #
+    #      umbrella.load()
+    #
+    #   Specifying plugins will only load what is specified, and this would
+    #   only load ruby packages:
+    #
+    #      umbrella.load(ruby: true)
+    #
+    # @see CobraCommander::Registry
+    #
+    def load(**source_selector)
+      Source.load(path, config["sources"], **source_selector).flatten.each do |package|
+        @components[package.name] ||= Component.new(self, package.name)
+        @components[package.name].add_package package
       end
     end
 
+    # All components in this umbrella
+    #
+    # @return [Array<CobraCommander::Component>]
+    #
     def components
       @components.values
     end

data/lib/cobra_commander/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CobraCommander
-  VERSION = "0.15.0"
+  VERSION = "1.0.0"
 end

data/lib/cobra_commander.rb

@@ -1,7 +1,13 @@
 # frozen_string_literal: true
 
-require "cobra_commander/dependencies"
+require "bundler"
+
+require "cobra_commander/affected"
 require "cobra_commander/component"
+require "cobra_commander/executor"
+require "cobra_commander/git_changed"
+require "cobra_commander/package"
+require "cobra_commander/source"
 require "cobra_commander/umbrella"
 require "cobra_commander/version"
 
@@ -9,20 +15,8 @@ require "cobra_commander/version"
 # Includes tools for graphing the components of an app and their relationships, as well as selectively
 # testing components based on changes made.
 module CobraCommander
-  UMBRELLA_APP_NAME = "App"
-
-  def self.umbrella(root_path, yarn: false, bundler: false, name: UMBRELLA_APP_NAME)
-    umbrella = Umbrella.new(name, root_path)
-    umbrella.add_source(:yarn, Dependencies::Yarn.new(root_path)) unless bundler
-    umbrella.add_source(:bundler, Dependencies::Bundler.new(root_path)) unless yarn
-    umbrella
-  end
-
-  def self.umbrella_tree(path)
-    CalculatedComponentTree.new(UMBRELLA_APP_NAME, path)
-  end
-
-  def self.tree_from_cache(cache_file)
-    CachedComponentTree.from_cache_file(cache_file)
+  # @deprecated Use Umbrella.new
+  def self.umbrella(root_path, **selector)
+    Umbrella.new(root_path, **selector)
   end
 end

data/mkdocs.yml

@@ -1,8 +1,8 @@
 site_name: Cobra Commander
 site_description: Cobra Commander Documentation
+repo_url: https://github.com/powerhome/cobra_commander
 nav:
   - "Home": "README.md"
   - "Changelog": "CHANGELOG.md"
-  - "Code of Conduct": "CODE_OF_CONDUCT.md"
 plugins:
   - techdocs-core

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cobra_commander
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ben Langfeld
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2022-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -40,20 +40,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: ruby-graphviz
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -158,6 +144,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: license_finder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -241,57 +241,51 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".github/workflows/ci.yml"
-- ".github/workflows/release.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - Gemfile
 - Guardfile
-- LICENSE.txt
 - Rakefile
-- _config.yml
 - bin/console
 - bin/setup
 - cobra_commander.gemspec
+- doc/dependency_decisions.yml
 - docs/CHANGELOG.md
-- docs/CODE_OF_CONDUCT.md
 - docs/README.md
 - exe/cobra
-- gemfiles/bundler1.gemfile
-- gemfiles/bundler2.gemfile
 - lib/cobra_commander.rb
 - lib/cobra_commander/affected.rb
-- lib/cobra_commander/change.rb
 - lib/cobra_commander/cli.rb
 - lib/cobra_commander/cli/filters.rb
+- lib/cobra_commander/cli/output/ascii_tree.rb
+- lib/cobra_commander/cli/output/change.rb
+- lib/cobra_commander/cli/output/dot_graph.rb
 - lib/cobra_commander/component.rb
-- lib/cobra_commander/dependencies.rb
-- lib/cobra_commander/dependencies/bundler.rb
-- lib/cobra_commander/dependencies/bundler/package.rb
-- lib/cobra_commander/dependencies/yarn.rb
-- lib/cobra_commander/dependencies/yarn/package.rb
 - lib/cobra_commander/executor.rb
-- lib/cobra_commander/executor/concurrent.rb
-- lib/cobra_commander/executor/context.rb
+- lib/cobra_commander/executor/command.rb
+- lib/cobra_commander/executor/execution.rb
+- lib/cobra_commander/executor/interactive_printer.rb
+- lib/cobra_commander/executor/job.rb
+- lib/cobra_commander/executor/markdown_printer.rb
+- lib/cobra_commander/executor/package_criteria.rb
+- lib/cobra_commander/executor/script.rb
+- lib/cobra_commander/executor/spinners.rb
 - lib/cobra_commander/git_changed.rb
-- lib/cobra_commander/output.rb
-- lib/cobra_commander/output/ascii_tree.rb
-- lib/cobra_commander/output/flat_list.rb
-- lib/cobra_commander/output/graph_viz.rb
-- lib/cobra_commander/output/interactive_printer.rb
-- lib/cobra_commander/output/markdown_printer.rb
+- lib/cobra_commander/package.rb
+- lib/cobra_commander/registry.rb
+- lib/cobra_commander/source.rb
 - lib/cobra_commander/umbrella.rb
 - lib/cobra_commander/version.rb
 - mkdocs.yml
-- portal.yml
-- renovate.json
 homepage: http://tech.powerhrg.com/cobra_commander/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: http://tech.powerhrg.com/cobra_commander/
+  source_code_uri: https://github.com/powerhome/cobra_commander
+  changelog_uri: https://github.com/powerhome/cobra_commander/blob/main/cobra_commander/docs/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -307,7 +301,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Tools for working with Component Based Rails Apps

data/.editorconfig

@@ -1,11 +0,0 @@
-# EditorConfig is awesome: https://EditorConfig.org
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file
-[*]
-end_of_line = lf
-insert_final_newline = true
-trim_trailing_whitespace = true
-indent_style = space
-indent_size = 2

data/.github/workflows/ci.yml

@@ -1,44 +0,0 @@
-name: CI
-
-on: push
-
-jobs:
-  test:
-    name: Tests
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby:
-          - "2.7"
-          - "3.0"
-        bundler:
-          - "1"
-          - "2"
-    env:
-      BUNDLE_GEMFILE: gemfiles/bundler${{ matrix.bundler }}.gemfile
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-        bundler: ${{ matrix.bundler }}
-        bundler-cache: true
-    - name: Install bundler v1 # Even if we're testing bundler v2, we need v1 available because the fixture components have it in their Gemfile.locks
-      run: gem install bundler -v "~> 1" --no-document
-    - name: Install Graphviz
-      run: sudo apt -qq install graphviz
-    - name: Run tests
-      run: bundle exec rake spec
-  lint:
-    name: Lint Ruby
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v3
-    - uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.0
-    - name: Bundle
-      run: bundle
-    - name: Run Rubocop
-      run: bundle exec rubocop

data/.github/workflows/release.yml

@@ -1,20 +0,0 @@
-name: Publish Gem
-
-on:
-  push:
-    branches:
-      - main
-    tags:
-      - v*
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Release Gem
-        uses: cadwallion/publish-rubygems-action@master
-        if: contains(github.ref, 'refs/tags/v')
-        env:
-          GITHUB_TOKEN: ${{ secrets.github_token }}
-          RUBYGEMS_API_KEY: ${{ secrets.rubygems_api_key }}
-          RELEASE_COMMAND: rake release

data/.rubocop_todo.yml

@@ -1,15 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2022-08-09 19:10:45 UTC using RuboCop version 1.30.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 8
-Performance/MethodObjectAsBlock:
-  Exclude:
-    - 'lib/cobra_commander/affected.rb'
-    - 'lib/cobra_commander/component.rb'
-    - 'lib/cobra_commander/dependencies/yarn_workspace.rb'
-    - 'lib/cobra_commander/output/interactive_printer.rb'

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Power Home Remodelling Group LLC
-
-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/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-architect

data/docs/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers 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, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at blangfeld@powerhrg.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/gemfiles/bundler1.gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec path: "../"
-
-gem "bundler", "~> 1.17.3"

data/gemfiles/bundler2.gemfile

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gemspec path: "../"
-
-gem "bundler", "~> 2.3.5"

data/lib/cobra_commander/change.rb

@@ -1,87 +0,0 @@
-# frozen_string_literal: true
-
-require "cobra_commander/git_changed"
-require "cobra_commander/affected"
-
-module CobraCommander
-  # Calculates and prints affected components & files
-  class Change
-    InvalidSelectionError = Class.new(StandardError)
-
-    def initialize(umbrella, oformat, branch, changes: nil)
-      @format = oformat
-      @branch = branch
-      @umbrella = umbrella
-      @changes = changes || GitChanged.new(umbrella.path, branch)
-    end
-
-    def run!
-      assert_valid_result_choice
-      if selected_format?("json")
-        puts affected.json_representation
-      else
-        show_full if selected_format?("full")
-        tests_to_run
-      end
-    rescue GitChanged::InvalidSelectionError => e
-      puts e.message
-    end
-
-  private
-
-    def affected
-      @affected ||= Affected.new(@umbrella, @changes)
-    end
-
-    def show_full
-      changes_since_last_commit
-      directly_affected_components
-      transitively_affected_components
-    end
-
-    def assert_valid_result_choice
-      return if %w[test full name json].include?(@format)
-
-      raise InvalidSelectionError, "--results must be 'test', 'full', 'name' or 'json'"
-    end
-
-    def selected_format?(result)
-      @format == result
-    end
-
-    def changes_since_last_commit
-      puts "<<< Changes since last commit on #{@branch} >>>"
-      puts(*@changes) if @changes.any?
-      puts blank_line
-    end
-
-    def directly_affected_components
-      puts "<<< Directly affected components >>>"
-      affected.directly.each { |component| puts display(**component) }
-      puts blank_line
-    end
-
-    def transitively_affected_components
-      puts "<<< Transitively affected components >>>"
-      affected.transitively.each { |component| puts display(**component) }
-      puts blank_line
-    end
-
-    def tests_to_run
-      puts "<<< Test scripts to run >>>" if selected_format?("full")
-      if selected_format?("name")
-        affected.names.each { |component_name| puts component_name }
-      else
-        affected.scripts.each { |component_script| puts component_script }
-      end
-    end
-
-    def display(name:, type:, **)
-      "#{name} - #{type}"
-    end
-
-    def blank_line
-      ""
-    end
-  end
-end