mdt-dummy 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5bdc95e57177f77afb40727c83c98ea87be6bbee8b7d0821becf57541863747
-  data.tar.gz: bd2dbf46306de2f4e4f07572c61426295413574e0e45955455fc9da9e76e4117
+  metadata.gz: 4c78432341e262c31fc4cab857453024828bbb405b2a5bd715e91e7ccc4743ba
+  data.tar.gz: cd6827ae665fd25a140d473daac57f6fbc92e0f3adfd9c3427fe62a9bbcba7af
 SHA512:
-  metadata.gz: 8e239c5471af33155d1c32d6e577a51dc60743ce0217b1f216ec3977fa2db9fb2c9e1da72146fff98d74167de006dbda1151e45cd4cc5a27656894496c008ffd
-  data.tar.gz: 7035e7c8fbe9c383f93c33808d028a60065ebd94c2b4f639ed4a919a3d3879569fd40bafcc203a5c6c80e4d7877a2e00effeef5d613127fb1a76699347eebe2f
+  metadata.gz: da9d95d8787bed68499f17382bc6ebe7cda15f423eb68d399d2a577cd02a66b7f323d5848db22955948dab036448d1957836cb8f086231a4703cd5bf7b2173e6
+  data.tar.gz: 2da3246cf90af8a9488fb03c5a9caacf57b820de2c844f8ccba4f9d303ce2178f7c4ba12ec94387f45546e2c1e111ee276a45f1fd09d0ca484ff1d7b6ac0ee48

data/README.md

@@ -0,0 +1,43 @@
+# MDT - Dummy module
+
+A dummy module for [MDT](https://github.com/Phitherek/mdt-core "MDT").
+
+## Requirements
+
+* [mdt-core](https://github.com/Phitherek/mdt-core "mdt-core") >= 0.0.1
+* Ruby (tested with 2.5.0, earlier versions down to 2.0 may also work)
+* RubyGems
+
+## Installation
+
+`gem install mdt-dummy`
+
+## Usage
+
+The module is automatically loaded by `mdt`. All you need to do is to use appropriate keys in your `mdt-deploy.yml`.
+
+## Objects defined by module
+
+### Command modifiers
+
+* `dummy.dummy` - prints the diagnostic message and returns exactly the command or expression that it is given with no changes
+
+### Commands
+
+* `dummy.dummy` - prints the diagnostic message, executes all of the given command modifiers in order with command being empty string and returns 0 (success)
+
+### Directory choosers
+
+* `dummy.dummy` - `mkdir` prints the diagnostic message and returns 0 (success), `cd` prints the diagnostic message and returns 0 (success), `rm` prints the diagnostic message and returns 0 (success)
+
+### Fetchers
+
+* `dummy.dummy` - prints the diagnostic message and returns 0 (success)
+
+## Contributing
+
+You can contribute to the development of this MDT module by submitting an issue or pull request.
+
+## Documentation
+
+Generated RDoc documentation can be found [here](http://www.rubydoc.info/github/Phitherek/mdt-dummy "here").

data/lib/mdt/command_modifiers/dummy.rb

@@ -1,15 +1,30 @@
 require 'mdt-core'
 module MDT
+  # A module containing all command modifiers
   module CommandModifiers
+    # A class that implements dummy command modifiers
     class Dummy < MDT::CommandModifiers::Base
+      # A method that defines a key for command modifiers class.
+      # Returns:
+      # * "dummy"
       def self.key
         'dummy'
       end
 
+      # A method that defines keys for available command modifiers.
+      # Returns:
+      # * +["dummy"]+
       def self.subkeys
         ['dummy']
       end
 
+      # A method that defines how to prepend command modifiers to commands.
+      # Arguments:
+      # * +key+ - a key identifier of a particular command modifier
+      # * +command+ - a command to apply command modifier on
+      # * +options+ - options for modifier as a Hash
+      # Returns:
+      # * Unmodified value of +command+
       def prepend(key, cmd, options = {})
         case key
         when 'dummy'

data/lib/mdt/commands/dummy.rb

@@ -1,15 +1,30 @@
 require 'mdt-core'
 module MDT
+  # A module containing all commands
   module Commands
+    # A class that implements dummy commands
     class Dummy < MDT::Commands::Base
+      # A method that defines a key for commands class.
+      # Returns:
+      # * "dummy"
       def self.key
         'dummy'
       end
 
+      # A method that defines keys for available commands.
+      # Returns:
+      # * +["dummy"]+
       def self.subkeys
         ['dummy']
       end
 
+      # A method that defines how to execute a command and how to apply command modifiers.
+      # Arguments:
+      # * +key+ - a key identifier of a particular command
+      # * +modifiers+ - an array of command modifier configurations - each configuration is a Hash that includes modifier type and modifier options
+      # * +options+ - options for command as a Hash
+      # Returns:
+      # * 0
       def execute(key, modifiers = [], options = {})
         case key
         when 'dummy'

data/lib/mdt/directory_choosers/dummy.rb

@@ -1,15 +1,29 @@
 require 'mdt-core'
 module MDT
+  # A module containing all directory choosers
   module DirectoryChoosers
+    # A class that implements dummy directory choosers
     class Dummy < MDT::DirectoryChoosers::Base
+      # A method that defines a key for directory choosers class.
+      # Returns:
+      # * "dummy"
       def self.key
         'dummy'
       end
 
+      # A method that defines keys for available directory choosers.
+      # Returns:
+      # * +["dummy"]+
       def self.subkeys
         ['dummy']
       end
 
+      # A method that defines how to create a deploy directory with directory choosers.
+      # Arguments:
+      # * +key+ - a key identifier of a particular directory chooser
+      # * +options+ - options for directory chooser as a Hash
+      # Returns:
+      # * 0
       def mkdir(key, options = {})
         case key
         when 'dummy'
@@ -18,6 +32,12 @@ module MDT
         end
       end
 
+      # A method that defines how to change working directory to a deploy directory with directory choosers.
+      # Arguments:
+      # * +key+ - a key identifier of a particular directory chooser
+      # * +options+ - options for directory chooser as a Hash
+      # Returns:
+      # * 0
       def cd(key, options = {})
         case key
         when 'dummy'
@@ -26,6 +46,12 @@ module MDT
         end
       end
 
+      # A method that defines how to remove a deploy directory with directory choosers.
+      # Arguments:
+      # * +key+ - a key identifier of a particular directory chooser
+      # * +options+ - options for directory chooser as a Hash
+      # Returns:
+      # * 0
       def rm(key, options = {})
         case key
         when 'dummy'

data/lib/mdt/fetchers/dummy.rb

@@ -1,15 +1,29 @@
 require 'mdt-core'
 module MDT
+  # A module containing all fetchers
   module Fetchers
+    # A class that implements dummy fetchers
     class Dummy < MDT::Fetchers::Base
+      # A method that defines a key for fetchers class.
+      # Returns:
+      # * "dummy"
       def self.key
         'dummy'
       end
 
+      # A method that defines keys for available fetchers.
+      # Returns:
+      # * +["dummy"]+
       def self.subkeys
         ['dummy']
       end
 
+      # A method that defines how to fetch project contents to a deploy directory with fetchers.
+      # Arguments:
+      # * +key+ - a key identifier of a particular fetcher
+      # * +options+ - options for fetchers as a Hash
+      # Returns:
+      # * 0
       def fetch(key, options = {})
         case key
         when 'dummy'

data/lib/mdt/version.rb

@@ -1,5 +1,8 @@
+# Global module for MDT
 module MDT
+  # A module specific to mdt-dummy
   module Dummy
-    VERSION = '0.0.1'
+    # mdt-dummy gem version
+    VERSION = '0.0.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdt-dummy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Phitherek_
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mdt-core
@@ -24,13 +24,29 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
 description: Dummy module for MDT
 email:
 - phitherek@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
+- README.md
 - lib/mdt-dummy.rb
 - lib/mdt/command_modifiers.rb
 - lib/mdt/command_modifiers/dummy.rb
@@ -44,9 +60,16 @@ files:
 homepage: https://github.com/Phitherek/mdt-dummy
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: http://www.rubydoc.info/github/Phitherek/mdt-dummy
+  source_code_uri: https://github.com/Phitherek/mdt-dummy
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--title"
+- MDT Dummy module
+- "--main"
+- README.md
+- "--line-numbers"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement