gene_system 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 559379df624aadc40f65cb1c3c9ab01f152fbbbaa238e1b5e2f71fcb97d84874
-  data.tar.gz: a0dbf8ab2cba60a31d8022601922660d93c87d8e6bf3c0a2653c344ce9e6aeed
+  metadata.gz: 4aa7960e15136bb83ad4d59cee4f04eb90329849e4afb122b71aa3c154221061
+  data.tar.gz: fd63a576848edc472d677278fbe0e59014fbefbc2341e8dc63accf6b8539fd8f
 SHA512:
-  metadata.gz: 79a46d8e6cfbe40d422ba6fdb8c7de1575dd52a94664c4550e4cfc54f5f9be72a0d541137e0dee65cbc535ea98a02a8d5f57e698f0ca3e23e5c9b5531815a83d
-  data.tar.gz: f052a0aea8250f8ec4e6a412c0a4af883f315ef2a2e6a85021cbcded1adfab4165a9efdc3c92d95d0c98b56ae64ff053a0e2ed289d0342c0a783e4ecab338ae9
+  metadata.gz: c8fa68614f9a03faa1e4e79bafe180e30016b913d0f5d92216295f252c83e0564941b4f16a6acc2ae3a9e52b28a028c8db58b777e2d3ba89154f9294785837ba
+  data.tar.gz: 43dce4572183820584a8c1a0a9c0d2f28cc6f33eb85d123b9f973c220ea1fef8f6bd1a05e24c9a04452399713f46444718d41626e13c829f0d993e28584d053b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gene_system (0.4.0)
+    gene_system (0.5.0)
       hashie
       highline (~> 2.0)
       jsonnet

data/lib/gene_system/cli.rb

@@ -43,6 +43,18 @@ module GeneSystem
       desc: 'Path to manifest (i.e. manifest.json)'
     )
 
+    method_option(
+      :include_tags,
+      type: :array,
+      desc: 'List of tags to include'
+    )
+
+    method_option(
+      :exclude_tags,
+      type: :array,
+      desc: 'List of tags to exclude'
+    )
+
     def install
       cmd = GeneSystem::Commands::InstallManifest.new(options)
       cmd.run
@@ -56,6 +68,18 @@ module GeneSystem
       desc: 'Path to manifest (i.e. manifest.json)'
     )
 
+    method_option(
+      :include_tags,
+      type: :array,
+      desc: 'List of tags to include'
+    )
+
+    method_option(
+      :exclude_tags,
+      type: :array,
+      desc: 'List of tags to exclude'
+    )
+
     def remove
       cmd = GeneSystem::Commands::RemoveManifest.new(options)
       cmd.run

data/lib/gene_system/commands/helpers.rb

@@ -0,0 +1,107 @@
+module GeneSystem
+  module Commands
+    # Install/Remove shared helper functions
+    module Helpers
+      ##
+      # Asks for user input when given prompts
+      #
+      # @param prompts [Array]
+      #
+      # @return Hashie::Mash
+      #
+      def ask(prompts = [])
+        answers = @manifest.variables
+        return answers if prompts.nil? || prompts.empty?
+
+        prompts.each do |prompt|
+          resp = @prompt.ask(prompt.prompt)
+          answers[prompt.var] = resp
+        end
+
+        answers
+      end
+
+      ##
+      # Determines whether to skip a step
+      #
+      # @param [GeneSystem::Step] step
+      # @param [GeneSystem::Platform] platform
+      #
+      # @return [Boolean]
+      #
+      def skip?(direction, step, platform)
+        return false if step.send(direction).skip.nil?
+
+        platform.execute_command(
+          step.send(direction).skip
+        ).zero?
+      end
+
+      ##
+      # Returns manifest steps that match command
+      # options
+      #
+      # If there are no inclusions or exclusions then
+      # all of the steps are returned.
+      #
+      # If there is an include and/or an exclude filter
+      # then the steps are filtered
+      #
+      # @return [GeneSystem::StepCollection]
+      #
+      def steps
+        steps = @manifest.steps
+        return steps unless filters?
+
+        filters.each do |matcher, tags|
+          steps = steps.filter(
+            matcher, tags: tags
+          )
+        end
+
+        steps
+      end
+
+      ##
+      # Constructs a filter function hash
+      #
+      # The key of the hash is the filter function
+      # and the value is the tags to filter by
+      #
+      # If no inclusions or exclusions are specified
+      # then an empty hash is returned
+      #
+      # @return [Hash]
+      #
+      def filters
+        filters = {}
+
+        if @options.include_tags
+          filters[StepCollection::STEP_INCLUDE_ANY_TAG] = @options.include_tags
+        end
+
+        if @options.exclude_tags
+          filters[StepCollection::STEP_EXCLUDE_ANY_TAG] = @options.exclude_tags
+        end
+
+        filters
+      end
+
+      ##
+      # Returns true when an inclusion filter
+      # and/or an exclusion filter is specified
+      # in command options.
+      #
+      # Otherwise it returns false
+      #
+      # @return [Boolean]
+      #
+      def filters?
+        return true if @options.include_tags
+        return true if @options.exclude_tags
+
+        false
+      end
+    end
+  end
+end

data/lib/gene_system/commands/install_manifest.rb

@@ -2,6 +2,8 @@ module GeneSystem
   module Commands
     # Install manifest command
     class InstallManifest
+      include GeneSystem::Commands::Helpers
+
       ##
       # Default name of gene system manifest
       #
@@ -29,8 +31,8 @@ module GeneSystem
 
         puts("INSTALL #{@manifest.name_and_version}")
 
-        @manifest.steps.each do |step|
-          next if skip?(step, platform)
+        steps.each do |step|
+          next if skip?(:install, step, platform)
 
           vars = ask(step.install.prompts)
 
@@ -44,43 +46,6 @@ module GeneSystem
           "✔ Manifest #{@manifest.name_and_version} successfully installed"
         )
       end
-
-      private
-
-      ##
-      # Asks for user input when given prompts
-      #
-      # @param prompts [Array]
-      #
-      # @return Hashie::Mash
-      #
-      def ask(prompts = [])
-        answers = @manifest.variables
-        return answers if prompts.nil? || prompts.empty?
-
-        prompts.each do |prompt|
-          resp = @prompt.ask(prompt.prompt)
-          answers[prompt.var] = resp
-        end
-
-        answers
-      end
-
-      ##
-      # Determines whether to skip a step
-      #
-      # @param [GeneSystem::Step] step
-      # @param [GeneSystem::Platform] platform
-      #
-      # @return [Boolean]
-      #
-      def skip?(step, platform)
-        return false if step.install.skip.nil?
-
-        platform.execute_command(
-          step.install.skip
-        ).zero?
-      end
     end
   end
 end

data/lib/gene_system/commands/remove_manifest.rb

@@ -2,6 +2,8 @@ module GeneSystem
   module Commands
     # Remove manifest command
     class RemoveManifest
+      include GeneSystem::Commands::Helpers
+
       ##
       # Default name of gene system manifest
       #
@@ -29,8 +31,8 @@ module GeneSystem
 
         puts("REMOVE #{@manifest.name_and_version}")
 
-        @manifest.steps.each do |step|
-          next if skip?(step, platform)
+        steps.each do |step|
+          next if skip?(:remove, step, platform)
 
           vars = ask(step.remove.prompts)
 
@@ -44,43 +46,6 @@ module GeneSystem
           "✔ Manifest #{@manifest.name_and_version} successfully removed"
         )
       end
-
-      private
-
-      ##
-      # Asks for user input when given prompts
-      #
-      # @param prompts [Array]
-      #
-      # @return Hashie::Mash
-      #
-      def ask(prompts = [])
-        answers = @manifest.variables
-        return answers if prompts.nil?
-
-        prompts.each do |prompt|
-          resp = @prompt.ask(prompt.prompt)
-          answers[prompt.var] = resp
-        end
-
-        answers
-      end
-
-      ##
-      # Determines whether to skip a step
-      #
-      # @param [GeneSystem::Step] step
-      # @param [GeneSystem::Platform] platform
-      #
-      # @return [Boolean]
-      #
-      def skip?(step, platform)
-        return false if step.remove.skip.nil?
-
-        platform.execute_command(
-          step.remove.skip
-        ).zero?
-      end
     end
   end
 end

data/lib/gene_system/manifest.rb

@@ -144,26 +144,12 @@ module GeneSystem
     end
 
     ##
-    # Steps executes a query function in a select call against each step to
-    # return a list of steps relevant to an operation.
+    # Returns a steps as a step collection
     #
-    # The given query function should evaluate to true when the desired step
-    # should be in the return set.
+    # @return [GeneSystem::StepCollection]
     #
-    # By default a all steps will be returned.
-    #
-    # Example:
-    # query = ->(step) { step.tags.include?("foo") }
-    # manifest.steps(query)
-    #
-    # @param [Lambda] query
-    #
-    # @return [Array]
-    #
-    def steps(query = DEFAULT_QUERY)
-      @steps.select do |step|
-        query.call(step)
-      end
+    def steps
+      GeneSystem::StepCollection.new(@steps)
     end
 
     ##

data/lib/gene_system/step_collection.rb

@@ -0,0 +1,95 @@
+require 'forwardable'
+
+module GeneSystem
+  # Filterable and mergable collection of steps
+  class StepCollection
+    attr_reader :steps
+    extend Forwardable
+
+    ##
+    # Default filter will match each step
+    #
+    DEFAULT_QUERY = lambda do |_step, _query = {}|
+      true
+    end
+
+    ##
+    # Function that returns true if step has
+    # any of the provided tags
+    #
+    # @param [GeneSystem::Step] step
+    # @param [Hash] query
+    #
+    # @return [Boolean]
+    #
+    STEP_INCLUDE_ANY_TAG = lambda do |step, query = {}|
+      raise 'query must include tags' unless query[:tags]&.is_a?(Array)
+
+      results = query[:tags].map do |tag|
+        step.tags.include?(tag)
+      end
+
+      results.any?(true)
+    end
+
+    ##
+    # Function that returns true if step does
+    # not have any of the provided tags
+    #
+    # @param [GeneSystem::Step] step
+    # @param [Hash] query
+    #
+    # @return [Boolean]
+    #
+    STEP_EXCLUDE_ANY_TAG = lambda do |step, query = {}|
+      raise 'query must include tags' unless query[:tags]&.is_a?(Array)
+
+      results = query[:tags].map do |tag|
+        step.tags.include?(tag)
+      end
+
+      results.all?(false)
+    end
+
+    def initialize(steps = [])
+      @steps = steps
+    end
+
+    def_delegators(:@steps, :count, :map, :each)
+
+    ##
+    # Filters steps by given matcher function
+    #
+    # The matcher function must take a step as an
+    # argument and return true or false as to whether
+    # it should be in the returned collection.
+    #
+    # @param [Proc] matcher
+    # @param [Hash] query
+    #
+    # @returns [GeneSystem::StepCollection]
+    #
+    def filter(matcher = DEFAULT_FILTER, query = {})
+      GeneSystem::StepCollection.new(
+        @steps.select do |step|
+          matcher.call(step, query)
+        end
+      )
+    end
+
+    ##
+    # Creates a collection which is a union
+    # of the given collection and this
+    # collection.
+    #
+    # @param [GeneSystem::StepCollection] collection
+    #
+    # @return [GeneSystem::StepCollection]
+    #
+    def merge(collection)
+      GeneSystem::StepCollection.new(
+        @steps + collection.steps
+      )
+    end
+  end
+end

data/lib/gene_system/version.rb

@@ -1,3 +1,3 @@
 module GeneSystem
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/lib/gene_system.rb

@@ -1,4 +1,5 @@
 require 'gene_system/version'
+require 'gene_system/step_collection'
 require 'gene_system/generators'
 require 'gene_system/manifest'
 require 'gene_system/step'

data/spec/gene_system/commands/helpers_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+RSpec.describe GeneSystem::Commands::Helpers do
+  let(:manifest) { double(GeneSystem::Manifest) }
+  let(:step) { double(GeneSystem::Step) }
+  let(:steps) { [step, step] }
+  let(:options) { Hashie::Mash.new }
+
+  subject { GeneSystem::Commands::RemoveManifest.new(options) }
+
+  before do
+    subject.instance_variable_set(:@manifest, manifest)
+    allow(manifest).to receive(:steps).and_return(steps)
+  end
+
+  describe '#steps' do
+    context 'when there are no filters' do
+      it 'returns all manifest steps' do
+        expect(subject.steps).to eq steps
+      end
+    end
+
+    context 'when there are filters' do
+      let(:options) do
+        Hashie::Mash.new(exclude_tags: %w[bags of tags])
+      end
+
+      before do
+        allow(steps).to receive(:filter)
+        subject.steps
+      end
+
+      it 'filters steps' do
+        expect(steps)
+          .to have_received(:filter)
+          .with(
+            GeneSystem::StepCollection::STEP_EXCLUDE_ANY_TAG,
+            tags: %w[bags of tags]
+          )
+      end
+    end
+  end
+
+  describe '#filters' do
+    context 'when include_tags is enabled' do
+      let(:options) do
+        Hashie::Mash.new(include_tags: %w[bags of tags])
+      end
+
+      it 'has STEP_INCLUDE_ANY_TAG function and tags' do
+        expect(subject.filters).to eq(
+          GeneSystem::StepCollection::STEP_INCLUDE_ANY_TAG => %w[bags of tags]
+        )
+      end
+    end
+
+    context 'when exclude_tags is enabled' do
+      let(:options) do
+        Hashie::Mash.new(exclude_tags: %w[bags of tags])
+      end
+
+      it 'has STEP_EXCLUDE_ANY_TAG function and tags' do
+        expect(subject.filters).to eq(
+          GeneSystem::StepCollection::STEP_EXCLUDE_ANY_TAG => %w[bags of tags]
+        )
+      end
+    end
+  end
+
+  describe '#filters?' do
+    context 'when neither include_tags or exclude_tags' do
+      it 'returns false' do
+        expect(subject.filters?).to be false
+      end
+    end
+
+    context 'when include_tags is enabled' do
+      let(:options) do
+        Hashie::Mash.new(include_tags: 'true')
+      end
+
+      it 'returns true' do
+        expect(subject.filters?).to be true
+      end
+    end
+
+    context 'when exclude_tags is enabled' do
+      let(:options) do
+        Hashie::Mash.new(exclude_tags: 'true')
+      end
+
+      it 'returns true' do
+        expect(subject.filters?).to be true
+      end
+    end
+  end
+end

data/spec/gene_system/commands/install_manifest_spec.rb

@@ -182,7 +182,10 @@ RSpec.describe GeneSystem::Commands::InstallManifest do
       it 'prints success message' do
         expect(subject)
           .to have_received(:puts)
-          .with("✔ Manifest #{manifest_name} v#{version} successfully installed")
+          .with(
+            "✔ Manifest #{manifest_name} v#{version} "\
+            'successfully installed'
+          )
       end
     end
 
@@ -251,7 +254,10 @@ RSpec.describe GeneSystem::Commands::InstallManifest do
       it 'prints success message' do
         expect(subject)
           .to have_received(:puts)
-          .with("✔ Manifest #{manifest_name} v#{version} successfully installed")
+          .with(
+            "✔ Manifest #{manifest_name} v#{version} "\
+            'successfully installed'
+          )
       end
     end
   end

data/spec/gene_system/manifest_spec.rb

@@ -255,23 +255,7 @@ RSpec.describe GeneSystem::Manifest do
     end
 
     it 'returns all steps by defualt' do
-      expect(@manifest.steps).to eq steps
-    end
-
-    context 'when given a query' do
-      let(:target_step) { double(GeneSystem::Step) }
-      let(:steps) { [step, target_step, step] }
-
-      before do
-        query = ->(step) { step == target_step }
-        @manifest.instance_variable_set(:@steps, steps)
-
-        @result = @manifest.steps(query)
-      end
-
-      it 'returns steps responding to query' do
-        expect(@result).to eq [target_step]
-      end
+      expect(@manifest.steps.steps).to eq steps
     end
   end
 

data/spec/gene_system/step_collection_spec.rb

@@ -0,0 +1,199 @@
+require 'spec_helper'
+
+RSpec.describe GeneSystem::StepCollection do
+  let(:step_name) { 'step-name' }
+  let(:step) do
+    double(GeneSystem::Step, name: step_name)
+  end
+
+  let(:steps) { [step, step] }
+  subject { described_class.new(steps) }
+
+  describe 'DEFAULT_QUERY' do
+    it 'returns true' do
+      expect(
+        described_class::DEFAULT_QUERY.call(step)
+      ).to be true
+    end
+  end
+
+  describe 'STEP_INCLUDE_ANY_TAG' do
+    let(:tag) { 'foo' }
+
+    context 'when query does not include tags' do
+      it 'raises runtime error' do
+        expect do
+          described_class::STEP_INCLUDE_ANY_TAG.call(step)
+        end.to raise_error(
+          RuntimeError,
+          'query must include tags'
+        )
+      end
+    end
+
+    context 'when step has tag' do
+      let(:step) do
+        double(GeneSystem::Step, tags: [tag, 'bar', 'biz'])
+      end
+
+      before do
+        @result = described_class::STEP_INCLUDE_ANY_TAG.call(
+          step,
+          tags: [tag]
+        )
+      end
+
+      it 'returns true' do
+        expect(@result).to be true
+      end
+    end
+
+    context 'when step does not have tag' do
+      let(:step) do
+        double(GeneSystem::Step, tags: %w[bar biz])
+      end
+
+      before do
+        @result = described_class::STEP_INCLUDE_ANY_TAG.call(
+          step,
+          tags: [tag]
+        )
+      end
+
+      it 'returns false' do
+        expect(@result).to be false
+      end
+    end
+  end
+
+  describe 'STEP_EXCLUDE_ANY_TAG' do
+    let(:tag) { 'foo' }
+
+    context 'when query does not include tags' do
+      it 'raises runtime error' do
+        expect do
+          described_class::STEP_EXCLUDE_ANY_TAG.call(step)
+        end.to raise_error(
+          RuntimeError,
+          'query must include tags'
+        )
+      end
+    end
+
+    context 'when step has tag' do
+      let(:step) do
+        double(GeneSystem::Step, tags: [tag, 'bar', 'biz'])
+      end
+
+      before do
+        @result = described_class::STEP_EXCLUDE_ANY_TAG.call(
+          step,
+          tags: [tag]
+        )
+      end
+
+      it 'returns false' do
+        expect(@result).to be false
+      end
+    end
+
+    context 'when step does not have tag' do
+      let(:step) do
+        double(GeneSystem::Step, tags: %w[bar biz])
+      end
+
+      before do
+        @result = described_class::STEP_EXCLUDE_ANY_TAG.call(
+          step,
+          tags: [tag]
+        )
+      end
+
+      it 'returns true' do
+        expect(@result).to be true
+      end
+    end
+  end
+
+  describe '#count' do
+    it 'returns step count' do
+      expect(subject.count).to eq steps.count
+    end
+  end
+
+  describe '#map' do
+    before do
+      @result = subject.map(&:name)
+    end
+
+    it 'maps step names' do
+      expect(@result).to eq [step_name, step_name]
+    end
+  end
+
+  describe '#each' do
+    before do
+      @result = []
+
+      subject.each do |step|
+        @result << step.name
+      end
+    end
+
+    it 'can iterate through steps' do
+      expect(@result).to eq [step_name, step_name]
+    end
+  end
+
+  describe '#filter' do
+    let(:matching_step) do
+      double(GeneSystem::Step, tags: %w[target foo])
+    end
+
+    let(:steps) do
+      [step, step, matching_step]
+    end
+
+    before do
+      allow(matching_step)
+        .to receive(:tags)
+        .and_return(%w[target foo])
+
+      allow(step)
+        .to receive(:tags)
+        .and_return([])
+
+      @steps = subject
+               .filter(
+                 described_class::STEP_INCLUDE_ANY_TAG,
+                 tags: ['target']
+               )
+    end
+
+    it 'returns a step collection' do
+      expect(@steps).to be_a(GeneSystem::StepCollection)
+    end
+
+    it 'only returns matching step' do
+      expect(@steps.steps.count).to be 1
+      expect(@steps.steps.first).to eq matching_step
+    end
+  end
+
+  describe '#merge' do
+    let(:another_collection) { described_class.new(steps) }
+
+    before do
+      @merged = subject.merge(another_collection)
+    end
+
+    it 'returns a new step collection' do
+      expect(@merged).not_to eq subject
+      expect(@merged).not_to eq another_collection
+    end
+
+    it 'is a union of the 2 collections' do
+      expect(@merged.count).to eq 2 * subject.count
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gene_system
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrew Bigger
@@ -330,6 +330,7 @@ files:
 - lib/gene_system/cli.rb
 - lib/gene_system/commands.rb
 - lib/gene_system/commands/create_manifest.rb
+- lib/gene_system/commands/helpers.rb
 - lib/gene_system/commands/install_manifest.rb
 - lib/gene_system/commands/print_version.rb
 - lib/gene_system/commands/remove_manifest.rb
@@ -337,16 +338,19 @@ files:
 - lib/gene_system/manifest.rb
 - lib/gene_system/platform.rb
 - lib/gene_system/step.rb
+- lib/gene_system/step_collection.rb
 - lib/gene_system/version.rb
 - manifest.json
 - spec/gene_system/cli_spec.rb
 - spec/gene_system/commands/create_manifest_spec.rb
+- spec/gene_system/commands/helpers_spec.rb
 - spec/gene_system/commands/install_manifest_spec.rb
 - spec/gene_system/commands/print_version_spec.rb
 - spec/gene_system/commands/remove_manifest_spec.rb
 - spec/gene_system/generators_spec.rb
 - spec/gene_system/manifest_spec.rb
 - spec/gene_system/platform_spec.rb
+- spec/gene_system/step_collection_spec.rb
 - spec/gene_system/step_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/andrewbigger/gene_system
@@ -375,11 +379,13 @@ summary: System configuration tool for applying settings
 test_files:
 - spec/gene_system/cli_spec.rb
 - spec/gene_system/commands/create_manifest_spec.rb
+- spec/gene_system/commands/helpers_spec.rb
 - spec/gene_system/commands/install_manifest_spec.rb
 - spec/gene_system/commands/print_version_spec.rb
 - spec/gene_system/commands/remove_manifest_spec.rb
 - spec/gene_system/generators_spec.rb
 - spec/gene_system/manifest_spec.rb
 - spec/gene_system/platform_spec.rb
+- spec/gene_system/step_collection_spec.rb
 - spec/gene_system/step_spec.rb
 - spec/spec_helper.rb