pkg-maintainer 1.1.14 → 1.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f3770178f2a2c576955b2974a54b644413f54bb4a3d6743056c7d74a75318a8
-  data.tar.gz: 625b256cc12dac6f5bea970a4046b18840e60f4842945639507ad8bce6209f50
+  metadata.gz: 9e7269affb685917b58beb84c3185bc698ffe5eacbdcd34bc0ca337e666bd120
+  data.tar.gz: 75767bdd65a9110aae0e03abf6b7d6534083730e60df99639bab8f7b21b96c3f
 SHA512:
-  metadata.gz: d793559b855850da2128ff56b1376ca0413a1a6b5789577d31b6b14eab5164aaa66a662b32e9706636d00a10b8e38c2bb09b826110e70d654f1592c42951874d
-  data.tar.gz: bda6d6d0b5642a403948e9f5a4740e713c6e29b41c672c78c79e40cc6226e6ecca2690675d9e748d6e931fce97ed7e97bd142e21ff1a34093ab47423f323ac34
+  metadata.gz: 9962486e0772c56ff6f2f2bca64f675d06b046de4e102317c716acf84b45a21d5478c50c2535fd566968452e00d08426dd065734741c6afa47ed3495350c9ea3
+  data.tar.gz: e58b254631dd2ddf9c54a63a6019d2b7969047cc8f96dbbffbbb137da626ec8abd2fc4fa87e8b208cb46886e8ac046697503847b08951a34715422567eec6f0b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pkg-maintainer (1.1.14)
+    pkg-maintainer (1.1.15)
       colorize
       commander
 

data/README.md

@@ -34,6 +34,10 @@ Or install it yourself as:
 | pod `podname`| Install a pod |
 | install cocoapods| Installs cocoapods |
 | uninstall cocoapods| Uninstalls cocoapods|
+| pip `package`| Install a python package|
+| install pip| Installs pip|
+| uninstall pip| Uninstalls pip|
+
 
 ## Development
 
@@ -43,7 +47,56 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/maintainer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+### Overview
+
+Any project, be it big or small, usually makes use of someone elses code. Your options to add this outside code into your project are:
+
+- Add the source code to your codebase
+- Use a package manager
+
+Typically, developers use the 2nd option. 
+
+When installing python packages, developers use the `pip` package manager
+When installing ruby packages, developers use the `gems` or `bundler` package manager
+When installing swift/obj-c packages, developers use `SPM` or `Cocoapods`
+
+and this list goes on. 
+
+Clearly we have a bunch of independent packages managers, all of which must be kept up to date. All of which have their own unique commands. 
+
+The maintainer is a single layer of abstraction, a wrapper, that makes installing packages, or dependencies, easy.
+
+### How it works
+
+Remember, the maintainer is only a wrapper. Under the hood you will still be using `pip`, `npm`, `gems`, `bundler`, `cocoapods`, `spm`..etc but since the maintainer deals with them, you don't have to. If you try to install a `pip` package without pip installed the maintainer will proceed the package installation with an installation of pip itself. 
+
+Lets take an example:
+
+You want to install the `pip` package `numpy`
+
+Without the maintainer you would: 
+
+1. Install `pip`
+2. Install `numpy`
+
+With mainatiner you would:
+
+1. Install `numpy`
+
+How do you install `pip`? Does not matter. We know, and we have taught the maintainer to do it.
+
+The maintainer also allows for enhanced control such as updating all your Pods and Pip packages, installing multiple packages as a time across multiple langauges and more. Even updating a dependency that occurs across multiple projects (For example, lets say it had a security flaw).
+
+### How to building process works
+
+The steps are pretty simple and thats the main goal. Since all package managers contain similar abilties we want to make the process of adding new package managers a breeze.
+
+The `/bin/maintain` file is where everything begins. A user will type `maintain <cmd>` to use the maintainer. It looks like an executable but if you right-click and open with your text-editor youll see its just ruby :D. The `/bin/maintain` files only job so far is read the arguments and call the Runner class inside the `maintainer` file to run the proper command. From there you can follow the functions to see what they do.
+
+The process of installing works as follows:
+
+In the `commands.rb` file there are many similar classes which contain inner-classes that have a `require_sudo` and `command!` function. The `requires_sudo` is a boolean that tells the commandRunner if it needs to run this command in sudo, the `command!` function should, check which OS the user is running (using the `OS` class) and then return an array of strings where each string is a command to run in that perticular order. Later down the line these inner-classes will become more complex, able to handle errors thrown etc.
+
 
 ## License
 

data/lib/maintainer_core/commandRunner.rb

@@ -71,12 +71,10 @@ module Maintainer
 
                 output = []
 
-                cmd = command.join(" ") if command.kind_of?(Array)
-
-                Writer.write(message: "#{cmd}")
+                Writer.write(message: "#{command}")
 
                 begin
-                    status = Maintainer::MaintainerPty.spawn(cmd) do |command_stdout, command_stdin, pid|
+                    status = Maintainer::MaintainerPty.spawn(command) do |command_stdout, command_stdin, pid|
                     command_stdout.each do |l|
                         line = l.strip # strip so that \n gets removed
                         output << line

data/lib/maintainer_core/commands.rb

@@ -12,7 +12,7 @@ module Maintainer
                     end
                     def command!()
                         if OS.isLinix?
-                            return ['apt-get install python3-pip']
+                            return ['apt install python3-pip']
                         elsif OS.isMac?
                             return ['brew install python', 'brew unlink python && brew link python']
                         elsif OS.isWindows?

data/lib/maintainer_core/pipRunner.rb

@@ -14,20 +14,19 @@ module Maintainer
             end
 
             def install(pkg: nil)
-                if not self.is_pip_installed!
-                    self.install_pip!
-                end
+                # if not self.is_pip_installed!
+                #     self.install_pip!
+                # end
                 CommandRunner.execute(command: "pip3 install #{pkg}", error: nil)
             end
 
             def is_pip_installed!()
                 version = CommandRunner.execute(command: Commands::Pip::Version, error: nil)
-                
                 if  /^(\d+)(.\d+)?(.\d+)?$/ =~ version 
                     return true
                 end
                 puts "pip not installed"
-                return false
+                return true
             end
         end
     end

data/lib/maintainer_core/version.rb

@@ -1,3 +1,3 @@
 module Maintainer
-  VERSION = "1.1.14"
+  VERSION = "1.1.15"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pkg-maintainer
 version: !ruby/object:Gem::Version
-  version: 1.1.14
+  version: 1.1.15
 platform: ruby
 authors:
 - Ehud Adler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-01 00:00:00.000000000 Z
+date: 2019-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander