vtk 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbb2159bd782736d6f9647826b073ab189e0e7d40d69dcb1664c16f62a688f09
-  data.tar.gz: 36386f949cd2c08013e97d3689ebc6f2c86c95ce0ca9fd7344223c35cb3ff261
+  metadata.gz: d6b58311e9937247860415f80c363b1581cd3d3bf837ca5e6e134e53478168b3
+  data.tar.gz: 8de8e128edfd1c0a2e8eba8ca96cca82ab9fe3126ce7be8ee098222ea0f62f9b
 SHA512:
-  metadata.gz: b375532131584051a1ad0c3036f68bab2304e8bdeb47cbfe7e3806fba24a5838be3e2229663cc836ae429eb17ebc2dc86a771589d83934226ea011dd80a8edc5
-  data.tar.gz: e28c0bbfa60f7ef3b15948e355171a8e9f2b8cb17fca8f4094217b75423b337e1e693d7226b42a80cc2b1165da08f7ac3951a284c26c68fc5178da2fef5504d9
+  metadata.gz: 46abbf43265d2b03f78ea898ad2a3561dc63d1e54d90f2d403c0ad36d7222b77f0f530d2e83d6834e17bcc7163046df7cf8cdf40060418349ef6697bfe5c3ee4
+  data.tar.gz: 7ab9d5c8efd22832a1bfcbf91fd49a44237fcc1a8b108b83f39bce1107cef9ac1f0628fffb843e8f70af5a28499e81b02714ba9a1af3b552429b4c151574ea7c

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [v0.3.0](https://github.com/department-of-veterans-affairs/vtk/tree/v0.3.0) (2021-02-16)
+
+[Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/v0.2.6...v0.3.0)
+
+**Merged pull requests:**
+
+- SOCKS On/Off Commands [\#9](https://github.com/department-of-veterans-affairs/vtk/pull/9) ([ericboehs](https://github.com/ericboehs))
+
 ## [v0.2.6](https://github.com/department-of-veterans-affairs/vtk/tree/v0.2.6) (2021-02-03)
 
 [Full Changelog](https://github.com/department-of-veterans-affairs/vtk/compare/v0.2.5...v0.2.6)

data/README.md

@@ -1,6 +1,6 @@
-# VSP Toolkit (`vtk`)
+# Platform Developer Toolkit
 
-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 purpose of this gem is to allow VFS engineers to quickly begin developing on VA.gov. 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*
 
@@ -9,6 +9,10 @@ The purpose of this gem is to allow VFS engineers to quickly begin developing on
 Install it yourself as:
 
     $ gem install vtk
+    
+To update to the latest version:
+
+    $ gem update vtk
 
 ## Usage
 
@@ -18,12 +22,12 @@ Teams developing for vets-api should create their code as a module. This allows
 
     $ 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>*
+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>`. You can specify the name of the module component by including `-n <component name>` after the module name. If you do not specify a module component name then the component will have the same name as the module.
 	
-    $ vtk module controller <module name>
-    $ vtk module model <module name>
-    $ vtk module serializer <module name>
-    $ vtk module service <module name>
+    $ vtk module controller <module name> -n <component name>
+    $ vtk module model <module name> -n <component name>
+    $ vtk module serializer <module name> -n <component name>
+    $ vtk module service <module name> -n <component 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)
 
@@ -50,6 +54,7 @@ For helpful information about commands and subcommands run the following:
 
     $ vtk -h
     $ vtk module -h
+    $ vtk socks -h
 
 ### Docker
 

data/lib/vtk/commands/module.rb

@@ -9,8 +9,8 @@ module Vtk
       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'
+      method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
+      method_option :component_name, aliases: '-n', type: :string, desc: 'Specify the service name'
       def service(name)
         if options[:help]
           invoke :help, ['service']
@@ -21,8 +21,8 @@ module Vtk
       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'
+      method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
+      method_option :component_name, aliases: '-n', type: :string, desc: 'Specify the serializer name'
       def serializer(name)
         if options[:help]
           invoke :help, ['serializer']
@@ -33,8 +33,8 @@ module Vtk
       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'
+      method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
+      method_option :component_name, aliases: '-n', type: :string, desc: 'Specify the model name'
       def model(name)
         if options[:help]
           invoke :help, ['model']
@@ -45,8 +45,8 @@ module Vtk
       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'
+      method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
+      method_option :component_name, aliases: '-n', type: :string, desc: 'Specify the controller name'
       def controller(name)
         if options[:help]
           invoke :help, ['controller']
@@ -57,8 +57,7 @@ module Vtk
       end
 
       desc 'add <module name>', 'Add a new module to vets-api'
-      method_option :help, aliases: '-h', type: :boolean,
-                           desc: 'Display usage information'
+      method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
       def add(name)
         if options[:help]
           invoke :help, ['add']

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

@@ -17,13 +17,14 @@ module Vtk
         end
 
         def execute(_input: $stdin, _output: $stdout)
-          create_controller(name)
+          create_controller(name, options)
         end
 
         private
 
-        def create_controller(name)
-          system("rails g module_component #{name} controller")
+        def create_controller(name, options)
+          component_name = options[:component_name] || name
+          system("rails g module_component #{name} method:controller component_name:#{component_name}")
         end
       end
     end

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

@@ -17,13 +17,14 @@ module Vtk
         end
 
         def execute(_input: $stdin, _output: $stdout)
-          create_model(name)
+          create_model(name, options)
         end
 
         private
 
-        def create_model(name)
-          system("rails g module_component #{name} model")
+        def create_model(name, options)
+          component_name = options[:component_name] || name
+          system("rails g module_component #{name} method:model component_name:#{component_name}")
         end
       end
     end

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

@@ -17,13 +17,14 @@ module Vtk
         end
 
         def execute(_input: $stdin, _output: $stdout)
-          create_serializer(name)
+          create_serializer(name, options)
         end
 
         private
 
-        def create_serializer(name)
-          system("rails g module_component #{name} serializer")
+        def create_serializer(name, options)
+          component_name = options[:component_name] || name
+          system("rails g module_component #{name} method:serializer component_name:#{component_name}")
         end
       end
     end

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

@@ -17,13 +17,14 @@ module Vtk
         end
 
         def execute(_input: $stdin, _output: $stdout)
-          create_service(name)
+          create_service(name, options)
         end
 
         private
 
-        def create_service(name)
-          system("rails g module_component #{name} service")
+        def create_service(name, options)
+          component_name = options[:component_name] || name
+          system("rails g module_component #{name} method:service component_name:#{component_name}")
         end
       end
     end

data/lib/vtk/version.rb

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

data/vtk.gemspec

@@ -9,12 +9,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Eric Boehs', 'Lindsey Hattamer', 'Travis Hilton']
   spec.email         = ['eric.boehs@oddball.io', 'lindsey.hattamer@oddball.io', 'travis.hilton@oddball.io']
 
-  spec.summary       = 'A CLI for the VSP platform'
-  spec.description   = 'This is a CLI tool for the VSP platform for developer usage'
-  spec.homepage      = 'https://github.com/department-of-veterans-affairs/vsp-toolkit'
+  spec.summary       = 'A CLI for the platform'
+  spec.description   = 'This is a platform CLI tool for VFS developer usage.'
+  spec.homepage      = 'https://github.com/department-of-veterans-affairs/vtk'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['documentation_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
   spec.metadata['changelog_uri'] = 'https://github.com/department-of-veterans-affairs/vtk/blob/master/CHANGELOG.md'
 

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: vtk
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Eric Boehs
 - Lindsey Hattamer
 - Travis Hilton
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-16 00:00:00.000000000 Z
+date: 2021-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -124,7 +124,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
-description: This is a CLI tool for the VSP platform for developer usage
+description: This is a platform CLI tool for VFS developer usage.
 email:
 - eric.boehs@oddball.io
 - lindsey.hattamer@oddball.io
@@ -166,14 +166,15 @@ files:
 - lib/vtk/templates/module/add/.gitkeep
 - lib/vtk/version.rb
 - vtk.gemspec
-homepage: https://github.com/department-of-veterans-affairs/vsp-toolkit
+homepage: https://github.com/department-of-veterans-affairs/vtk
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/department-of-veterans-affairs/vsp-toolkit
-  source_code_uri: https://github.com/department-of-veterans-affairs/vsp-toolkit
+  homepage_uri: https://github.com/department-of-veterans-affairs/vtk
+  documentation_uri: https://github.com/department-of-veterans-affairs/vtk
+  source_code_uri: https://github.com/department-of-veterans-affairs/vtk
   changelog_uri: https://github.com/department-of-veterans-affairs/vtk/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -188,8 +189,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.1
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
-summary: A CLI for the VSP platform
+summary: A CLI for the platform
 test_files: []