vtk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 548575ce6bef53e2e3e617e8151e056879c569821d24cdcb0c9ab1ded7cde684
-  data.tar.gz: 1a087c94d0c2f30076cbd312c020a59dcc995185a4cf5a658a9fe3fd35adde45
+  metadata.gz: b7583033a5831dfb0161f71d5ab8721382be7412148ab1d9c226586b14f79105
+  data.tar.gz: 3fabac91fa94bbedd1b33234ec76b2f21d9caaa5b7ec1d8f735d0395f7b28870
 SHA512:
-  metadata.gz: 9772f4461e30d1fb40da791790c851aada39362d18dff6d9b903ad45a2b35017201066c724397a99175d923f2aa4940563b6af65c360f86920e826fdcd51944d
-  data.tar.gz: 63a40c81a3f42214db2a46cc9ccd68a562ce570c5b1557a5d9937f156ad850ea7ec98774c481ed18f759e05b71d29da9396ac9b581e9267437405537096a6674
+  metadata.gz: 0f4d8d91956e7e0bfd3bbe01cfee7cd83ffedfd1b163b708f633c5346c27ff4ed41c9674f22c39e17b9b2a14e808443987e99f184c02d3de5a749a033f97c674
+  data.tar.gz: 0d04131d2c1de00edfd0a09196d7ef15f38651837870b2e1b24bf070deb84144f9845bcd344b34494aac686ba3088e8dd40be6e61fd3dc1f4304a0160274188d

data/.rubocop.yml

@@ -3,3 +3,7 @@ AllCops:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/integration/module_spec.rb'

data/README.md

@@ -2,7 +2,7 @@
 
 The purpose of this gem is to allow VFS engineers to quickly begin developing on the platform. It does this by providing a command line interface that allows the use of simple commands and parameters to do everything from setting up a development environment to building out a directory structure and creating necessary files for separating code into its own module.
 
-*The following assumes you have Ruby 2.6.6 or higher installed.*
+*The following assumes you have Ruby 2.6.6 or higher installed*
 
 ## Installation
 
@@ -14,6 +14,21 @@ Install it yourself as:
 
 ### Modules
 
-Teams developing for vets-api should create their code as a module. This allows for the separation and easy identification of different projects. To scaffold a directory structure for your module, first cd into the vets-api directory, then enter the command below, substituting the name of your module for *<module name>*. This will build out a directory structure and create necessary files in the `modules/` directory.
+Teams developing for vets-api should create their code as a module. This allows for the separation and easy identification of different projects. To scaffold a directory structure for your module, first cd into the vets-api directory, then enter the command below, substituting the name of your module for `<module name>`. This will build out a directory structure and create necessary files in the `modules/` directory.
 
     $ vtk module add <module name>
+	
+To add additional functionality to your module, the commands listed below are available for use. These commands can build out common functionality needed when working with a module and will be created within the given module space. When creating a new module component for a module space that does not currently exist, users will be prompted with the choice to create the module directory structure. As above, first cd into the vets-api directory, then enter the command below, substituting the name of your module for *<module name>*
+	
+    $ vtk module controller <module name>
+    $ vtk module model <module name>
+    $ vtk module serializer <module name>
+    $ vtk module service <module name>
+    
+This above command runs a custom rails generator. For more information see the [module generator documentation](https://github.com/department-of-veterans-affairs/vets-api/blob/master/lib/generators/module/USAGE)
+    
+### Help
+
+For helpful information about commands and subcommands run the following:
+
+    $ vtk -h

data/lib/vtk/commands/module.rb

@@ -8,6 +8,54 @@ module Vtk
     class Module < Thor
       namespace :module
 
+      desc 'service <module name>', 'Add new service class to a module in vets-api'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def service(name)
+        if options[:help]
+          invoke :help, ['service']
+        else
+          require_relative 'module/service'
+          Vtk::Commands::Module::Service.new(name, options).execute
+        end
+      end
+
+      desc 'serializer <module name>', 'Add new serializer to a module in vets-api'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def serializer(name)
+        if options[:help]
+          invoke :help, ['serializer']
+        else
+          require_relative 'module/serializer'
+          Vtk::Commands::Module::Serializer.new(name, options).execute
+        end
+      end
+
+      desc 'model <module name>', 'Add new model to a module in vets-api'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def model(name)
+        if options[:help]
+          invoke :help, ['model']
+        else
+          require_relative 'module/model'
+          Vtk::Commands::Module::Model.new(name, options).execute
+        end
+      end
+
+      desc 'controller <module name>', 'Add new controller to a module in vets-api'
+      method_option :help, aliases: '-h', type: :boolean,
+                           desc: 'Display usage information'
+      def controller(name)
+        if options[:help]
+          invoke :help, ['controller']
+        else
+          require_relative 'module/controller'
+          Vtk::Commands::Module::Controller.new(name, options).execute
+        end
+      end
+
       desc 'add <module name>', 'Add a new module to vets-api'
       method_option :help, aliases: '-h', type: :boolean,
                            desc: 'Display usage information'

data/lib/vtk/commands/module/add.rb

@@ -23,7 +23,12 @@ module Vtk
         private
 
         def create_module(name)
-          `rails g module #{name}`
+          # create a new module from the vets-api generator
+          if `gem which rails` == ''
+            output.puts 'Please install Rails - This command runs a Rails generator and Rails is a dependency of vtk'
+          else
+            system("rails g module #{name}")
+          end
         end
       end
     end

data/lib/vtk/commands/module/controller.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+
+module Vtk
+  module Commands
+    class Module
+      # Adds a new module controller to vets-api
+      class Controller < Vtk::Command
+        attr_accessor :name, :options
+
+        def initialize(name, options)
+          @name = name
+          @options = options
+
+          super()
+        end
+
+        def execute(_input: $stdin, _output: $stdout)
+          create_controller(name)
+        end
+
+        private
+
+        def create_controller(name)
+          `rails g module_component #{name} controller`
+        end
+      end
+    end
+  end
+end

data/lib/vtk/commands/module/model.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+
+module Vtk
+  module Commands
+    class Module
+      # Adds a new module model to vets-api
+      class Model < Vtk::Command
+        attr_accessor :name, :options
+
+        def initialize(name, options)
+          @name = name
+          @options = options
+
+          super()
+        end
+
+        def execute(_input: $stdin, _output: $stdout)
+          create_model(name)
+        end
+
+        private
+
+        def create_controller(name)
+          `rails g module_component #{name} model`
+        end
+      end
+    end
+  end
+end

data/lib/vtk/commands/module/serializer.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+
+module Vtk
+  module Commands
+    class Module
+      # Adds a new module serializer to vets-api
+      class Serializer < Vtk::Command
+        attr_accessor :name, :options
+
+        def initialize(name, options)
+          @name = name
+          @options = options
+
+          super()
+        end
+
+        def execute(_input: $stdin, _output: $stdout)
+          create_serializer(name)
+        end
+
+        private
+
+        def create_controller(name)
+          `rails g module_component #{name} serializer`
+        end
+      end
+    end
+  end
+end

data/lib/vtk/commands/module/service.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../../command'
+
+module Vtk
+  module Commands
+    class Module
+      # Adds a new module service class to vets-api
+      class Service < Vtk::Command
+        attr_accessor :name, :options
+
+        def initialize(name, options)
+          @name = name
+          @options = options
+
+          super()
+        end
+
+        def execute(_input: $stdin, _output: $stdout)
+          create_service(name)
+        end
+
+        private
+
+        def create_controller(name)
+          `rails g module_component #{name} service`
+        end
+      end
+    end
+  end
+end

data/lib/vtk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vtk
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vtk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eric Boehs
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-05 00:00:00.000000000 Z
+date: 2021-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -127,6 +127,10 @@ files:
 - lib/vtk/commands/.gitkeep
 - lib/vtk/commands/module.rb
 - lib/vtk/commands/module/add.rb
+- lib/vtk/commands/module/controller.rb
+- lib/vtk/commands/module/model.rb
+- lib/vtk/commands/module/serializer.rb
+- lib/vtk/commands/module/service.rb
 - lib/vtk/templates/.gitkeep
 - lib/vtk/templates/module/add/.gitkeep
 - lib/vtk/version.rb