app_archetype 1.5.0 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be0d0a9624d6408fce0b1b397a87dcdb1498fcce7f087106bcf89bf170dcd501
-  data.tar.gz: 01220c7659a2d799f79ab847a69751e1e928e41f0c280998cbfe51436c53bc85
+  metadata.gz: a4960f16cbaf3034a7facdbebc02ff0b0df95819b8f9fa36f74d663112e1d74f
+  data.tar.gz: ab95112f6710e036ac76f95e6656b49dd47c0502331587513ba9dc4bdb894dd6
 SHA512:
-  metadata.gz: 50252b085dea58b00217c4a9e8d553564d0bc7bfddd12f8061344b91f75fb62a83388a191a4eff278e41de39c895133794d59cc6ba9d8f7f1adb46b165c9f1fc
-  data.tar.gz: a67a216ec48665fcbf23a24e3a882ef2219b4cb170f50842cd976b88bbfabdb582980532a2be614e483238752d83111c8c88e4b4070a7433957069c8e500f6ef
+  metadata.gz: '093ab09ba553ef8329890ae26e7b048fdb0d2296223796269282b48ec71d103a4b0f353556211304d53ba6a74984aeb1bab4d175af6fa1178f391378529472ff'
+  data.tar.gz: 8e399efb92ef27a6a4a9a24455b8fc0d50517b1ac8b7ac96eb3401b80fcd37abdd6461d82c9c9a5420481a514c092fdd9c32bae71635a8ad2939117d76524da3

data/.rubocop.yml

@@ -16,9 +16,21 @@
 
   Metrics/MethodLength:
     Max: 20
+    Exclude: 
+      - 'lib/app_archetype/renderer.rb'
   
   Metrics/AbcSize:
     Max: 20
+    Exclude: 
+      - 'lib/app_archetype/renderer.rb'
+  
+  Metrics/CyclomaticComplexity:
+    Exclude: 
+      - 'lib/app_archetype/renderer.rb'
+
+  Metrics/PerceivedComplexity:
+    Exclude: 
+      - 'lib/app_archetype/renderer.rb'
   
   Lint/AssignmentInCondition:
     Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    app_archetype (1.5.0)
+    app_archetype (1.5.2)
       cli-format
       hashie
       highline
@@ -19,7 +19,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.6)
+    activesupport (6.1.7.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -33,14 +33,14 @@ GEM
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
     bump (0.10.0)
-    cli-format (0.2.2)
+    cli-format (0.5.0)
       activesupport
       text-table
       zeitwerk
     coderay (1.1.3)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.5.0)
@@ -57,24 +57,24 @@ GEM
       ruby_parser (~> 3.1, > 3.1.0)
       sexp_processor (~> 4.8)
     hashie (5.0.0)
-    highline (2.0.3)
-    i18n (1.10.0)
+    highline (2.1.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    json (2.6.2)
-    json-schema (3.0.0)
+    json (2.7.1)
+    json-schema (4.1.1)
       addressable (>= 2.8)
-    jsonnet (0.4.0)
+    jsonnet (0.5.3)
       mini_portile2 (>= 2.2.0)
     kwalify (0.7.2)
     launchy (2.5.0)
       addressable (~> 2.7)
-    logger (1.5.1)
+    logger (1.6.0)
     method_source (1.0.0)
-    mini_portile2 (2.8.0)
-    minitest (5.16.1)
+    mini_portile2 (2.8.5)
+    minitest (5.20.0)
     os (1.1.4)
-    ostruct (0.5.5)
+    ostruct (0.6.0)
     parallel (1.21.0)
     parser (3.1.0.0)
       ast (~> 2.4.1)
@@ -161,13 +161,13 @@ GEM
       tty-cursor (~> 0.7)
       tty-screen (~> 0.8)
       wisper (~> 2.0)
-    tty-screen (0.8.1)
+    tty-screen (0.8.2)
     tty-table (0.12.0)
       pastel (~> 0.8)
       strings (~> 0.2.0)
       tty-screen (~> 0.8)
     tty-which (0.4.2)
-    tzinfo (2.0.4)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
     unicode_utils (1.4.0)
@@ -180,7 +180,7 @@ GEM
     wisper (2.0.1)
     yard (0.9.27)
       webrick (~> 1.7.0)
-    zeitwerk (2.6.0)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   ruby

data/lib/app_archetype/renderer.rb

@@ -44,6 +44,8 @@ module AppArchetype
           render_erb_file(file)
         elsif file.source_hbs?
           render_hbs_file(file)
+        elsif file.source_template?
+          render_template_file(file)
         elsif file.source_file?
           copy_file(file)
         end
@@ -100,7 +102,27 @@ module AppArchetype
     end
 
     ##
-    # Copies source file to planned path only ovewriting if permitted by the
+    # Copies source file only overwriting if permitted by the
+    # renderer.
+    #
+    # The output file name removes the `.template` suffix. This
+    # is for circumstances where the template includes a hbs or erb
+    # file that we want to render untouched.
+    #
+    # @param [AppArchetype::OutputFile] file
+    #
+    def render_template_file(file)
+      raise 'cannot overwrite file' if file.exist? && !@overwrite
+
+      path = file.path.gsub('.template', '')
+
+      print_message("RENDER template ->: #{path}")
+
+      FileUtils.cp(file.source_file_path, path)
+    end
+
+    ##
+    # Copies source file to planned path only overwriting if permitted by the
     # renderer.
     #
     # @param [AppArchetype::Template::OutputFile] file

data/lib/app_archetype/template/manifest.rb

@@ -204,6 +204,24 @@ module AppArchetype
       def valid?
         validate.empty?
       end
+
+      ##
+      # Setter for variables
+      #
+      # @param [Hash] value
+      def variables=(value)
+        var_values = {}
+        
+        value.each do |name, value|
+          var_values[name] = {
+            name: name,
+            description: name,
+            value: value
+          }
+        end
+
+        @variables = AppArchetype::Template::VariableManager.new(var_values)
+      end
     end
   end
 end

data/lib/app_archetype/template/plan.rb

@@ -149,6 +149,18 @@ module AppArchetype
         File.extname(@source_file_path) == '.hbs'
       end
 
+      ##
+      # Evaluates whether the source file is a template.
+      #
+      # This is for cases where one wants to render a hbs or
+      # erb file without processing as a template file.
+      #
+      # @return [Boolean]
+      #
+      def source_template?
+        File.extname(@source_file_path) == '.template'
+      end
+
       ##
       # Evaluates whether the source file is a file as opposed to
       # being a directory.

data/lib/app_archetype/version.rb

@@ -2,5 +2,5 @@ module AppArchetype
   ##
   # AppArchetype version
   #
-  VERSION = '1.5.0'.freeze
+  VERSION = '1.5.2'.freeze
 end

data/lib/app_archetype.rb

@@ -38,12 +38,14 @@ module AppArchetype
     collection_dir: ENV.fetch('ARCHETYPE_TEMPLATE_DIR'),
     template_name: '',
     destination_path: '',
-    overwrite: false
+    overwrite: false,
+    variables: nil
   )
     manager = AppArchetype::TemplateManager.new(collection_dir)
     manager.load
 
     manifest = manager.find_by_name(template_name)
+    manifest.variables = variables unless variables.nil?
 
     template = manifest.template
     template.load

data/spec/app_archetype/renderer_spec.rb

@@ -47,6 +47,13 @@ RSpec.describe AppArchetype::Renderer do
       )
     end
 
+    let(:template) do
+      AppArchetype::Template::OutputFile.new(
+        'path/to/template.hbs.template',
+        'path/to/destination/template'
+      )
+    end
+
     let(:directory) do
       AppArchetype::Template::OutputFile.new(
         'path/to/source/dir',
@@ -60,6 +67,7 @@ RSpec.describe AppArchetype::Renderer do
       allow(subject).to receive(:write_dir)
       allow(subject).to receive(:render_erb_file)
       allow(subject).to receive(:render_hbs_file)
+      allow(subject).to receive(:render_template_file)
       allow(subject).to receive(:copy_file)
 
       allow(File).to receive(:new).and_return(file_double)
@@ -67,11 +75,12 @@ RSpec.describe AppArchetype::Renderer do
       allow(file).to receive(:source_file?).and_return(true)
       allow(erb_template).to receive(:source_erb?).and_return(true)
       allow(hbs_template).to receive(:source_hbs?).and_return(true)
+      allow(template).to receive(:source_template?).and_return(true)
       allow(directory).to receive(:source_directory?).and_return(true)
 
       plan.instance_variable_set(
         :@files,
-        [file, erb_template, hbs_template, directory]
+        [file, erb_template, hbs_template, template, directory]
       )
 
       subject.render
@@ -93,6 +102,10 @@ RSpec.describe AppArchetype::Renderer do
       expect(subject).to have_received(:render_hbs_file).with(hbs_template)
     end
 
+    it 'renders template' do
+      expect(subject).to have_received(:render_template_file).with(template)
+    end
+
     it 'copies file' do
       expect(subject).to have_received(:copy_file).with(file)
     end
@@ -247,6 +260,48 @@ RSpec.describe AppArchetype::Renderer do
     end
   end
 
+  describe '#render_template_file' do
+    let(:source_path) { 'path/to/template/file.hbs.template' }
+    let(:dest_path) { 'path/to/destination/file' }
+
+    let(:file) do
+      AppArchetype::Template::OutputFile.new(source_path, dest_path)
+    end
+
+    let(:exists) { false }
+
+    before do
+      allow(FileUtils).to receive(:cp)
+      allow(file).to receive(:exist?).and_return(exists)
+    end
+
+    it 'copies file' do
+      subject.render_template_file(file)
+      expect(FileUtils).to have_received(:cp).with(source_path, dest_path)
+    end
+
+    context 'when file already exists and overwrite not allowed' do
+      let(:exists) { true }
+
+      it 'raises error' do
+        expect do
+          subject.render_template_file(file)
+        end.to raise_error('cannot overwrite file')
+      end
+    end
+
+    context 'when file already exists and overwrite is allowed' do
+      let(:exists) { true }
+      let(:overwrite) { true }
+
+      it 'raises error' do
+        expect do
+          subject.render_template_file(file)
+        end.not_to raise_error
+      end
+    end
+  end
+
   describe '#copy_file' do
     let(:source_path) { 'path/to/template/file' }
     let(:dest_path) { 'path/to/destination/file' }

data/spec/app_archetype/template/manifest_spec.rb

@@ -272,4 +272,30 @@ RSpec.describe AppArchetype::Template::Manifest do
       end
     end
   end
+
+  describe '#variables=' do
+    let(:path) { 'path/to/manifest.json' }
+
+    let(:data) do
+      {
+        'name' => 'test_manifest',
+        'version' => '0.1.0',
+        'variables' => {}
+      }
+    end
+
+    let(:vars) do
+      {
+        'foo' => 'bar'
+      }
+    end
+
+    before do
+      subject.variables = vars
+    end
+
+    it 'sets variables from given hash' do
+      expect(subject.variables.get('foo').value).to eq 'bar'
+    end
+  end
 end

data/spec/app_archetype/template/plan_spec.rb

@@ -167,6 +167,31 @@ RSpec.describe AppArchetype::Template::OutputFile do
     end
   end
 
+  describe '#source_template?' do
+    let(:ext) { '.template' }
+
+    before do
+      allow(File).to receive(:extname).and_return(ext)
+      @result = subject.source_template?
+    end
+
+    it 'delegates source file template check to File' do
+      expect(File).to have_received(:extname).with(source_file)
+    end
+
+    it 'returns true if file is template' do
+      expect(@result).to be true
+    end
+
+    context 'when not template' do
+      let(:ext) { 'doc' }
+
+      it 'returns false' do
+        expect(@result).to be false
+      end
+    end
+  end
+
   describe '#source_file?' do
     before do
       allow(File).to receive(:file?)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: app_archetype
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.2
 platform: ruby
 authors:
 - Andrew Bigger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-27 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cli-format