chid 0.1.6.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07e50f1ef170df37a4371d430f3e9489ec399a008d72c6a456c88ea96e6f1731
-  data.tar.gz: 324f150e53d9481e0ea8eed0297faecba52bc65c95c66dfe0faebfaf6b974543
+  metadata.gz: 2ccada7ec3ff5e03b4ec9558080fe93be00c88326544b796612bdb22d470fec5
+  data.tar.gz: 2dae7d98b4f2b41c1d48a2c1276f899610832b44b93c97515f31d2726ed228b9
 SHA512:
-  metadata.gz: b3a08a8b99acaa5bf889ffe460a25676378c8556b3ee6eaa4ad661854b82272eaf25b2949927bc762e593495002052df56af265bbea9ecf197764ee269dc9296
-  data.tar.gz: 40b6a3b51980481880acb530f4da92bdd9a75ce69a4d32263702b736a514d50bf23308cbe3d8b3d509673dc7ea0ef52297bfd26d160f92651cd7d0daa84e4ee3
+  metadata.gz: 9e8dfb7a099a8a7837d52a8bb125c3e6e908e9f566a0ff6b47322b8e070d0343097211b0e5e0673fa79d8b85c6c4fdec7d56d7a0cf003fe37675d8dacdd864ce
+  data.tar.gz: cf7e3cca3f6261f1a12750f5aac0ecd07c67c0b932428158e2bd38d9e2f4746ed6dc3ff89e57d2d2ae8e732cacd5e53dd11c6a4c3739f08109872817b0a20ead

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### 0.2.0
+
+* Add:  
+  - Chid config Command
+  - Chid currency Commands
+  - Chid github Command
+
+* Remove:  
+  - All unecessary rake tasks
+  - Translate feature
+
 ### 0.1.6.1
 
 * Update:  

data/CONTRIBUTING.md

@@ -1,4 +1,78 @@
 # Contrinuting to Chid
 
 ## How run chid gem locally
-`ruby -Ilib bin/chid [COMMANDS]`
+`$ ruby -Ilib bin/chid [COMMAND]`
+
+## Adding a new Command
+
+### When the command has no sub-command
+An example of no sub-command is the `chid news` command. 
+
+This command is straightforward, execute the `news` command.
+### When the command has sub-command
+An example of no sub-command is the `chid workstation` command. 
+
+For this command we have the following sub-commands:
+- `create`
+- `destroy`
+- `list`
+- `open`
+
+A usage for it is `chid workstation open`
+
+#### Structure
+As we need many sub-commands, is necessary create a new module (folder) inside the `./lib/chid/commands/` folder.
+
+For example we want to add `currency` with follwing commands:
+- `current`
+- `convert`
+- `list`
+
+The first thing is create the folder with those sub-commands:
+- `./lib/chid/commands/currency/current.rb`
+- `./lib/chid/commands/currency/convert.rb`
+- `./lib/chid/commands/currency/list.rb`
+
+**Class structure**: 
+
+This initial structure must exists to follow the command pattern to work on chid. The structure will be automatically added on helper command, when the user calls for example `chid currency now -h`
+
+```ruby
+# ./lib/chid/commands/currency/current.rb
+
+module Chid
+  module Commands
+    module Currency
+      class Now < Command
+
+        command :'currency current' # COMMAND_NAME
+
+        self.summary = 'Summary of your new Command'
+        self.description = <<-DESC
+
+Usage:
+
+  $ chid currency now
+
+    SOME_DESCRIPTION_OF_THE_COMMAND
+
+
+Options: # These are not required, only if your command demands for options.
+
+  -to TEXT_TO_EXPLAIN
+  -from TEXT_TO_EXPLAIN
+
+      DESC
+      self.arguments = ['-to', '-from']
+
+
+		# This method will be executed automatically
+		# To access all given arguments, you have available the attr_reader :options to get
+        def run
+        end
+
+      end
+    end
+  end
+end
+```

data/Gemfile.lock

@@ -1,46 +1,39 @@
 PATH
   remote: .
   specs:
-    chid (0.1.6)
-      easy_translate
+    chid (0.1.6.2)
       http
-      rake
       tty-prompt
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.1)
     diff-lcs (1.3)
-    domain_name (0.5.20180417)
+    domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    easy_translate (0.5.1)
-      thread
-      thread_safe
-    equatable (0.5.0)
-    hitimes (1.2.6)
-    http (3.3.0)
+    equatable (0.6.1)
+    http (4.1.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
       http-form_data (~> 2.0)
       http_parser.rb (~> 0.6.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    http-form_data (2.1.0)
+    http-form_data (2.1.1)
     http_parser.rb (0.6.0)
     method_source (0.8.2)
-    necromancer (0.4.0)
-    pastel (0.7.2)
-      equatable (~> 0.5.0)
-      tty-color (~> 0.4.0)
+    necromancer (0.5.0)
+    pastel (0.7.3)
+      equatable (~> 0.6)
+      tty-color (~> 0.5)
     pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    public_suffix (3.0.2)
-    rake (12.3.1)
+    public_suffix (4.0.1)
     rspec (3.6.0)
       rspec-core (~> 3.6.0)
       rspec-expectations (~> 3.6.0)
@@ -55,26 +48,20 @@ GEM
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
     slop (3.6.0)
-    thread (0.2.2)
-    thread_safe (0.3.6)
-    timers (4.1.2)
-      hitimes
-    tty-color (0.4.2)
-    tty-cursor (0.5.0)
-    tty-prompt (0.16.1)
-      necromancer (~> 0.4.0)
+    tty-color (0.5.0)
+    tty-cursor (0.7.0)
+    tty-prompt (0.19.0)
+      necromancer (~> 0.5.0)
       pastel (~> 0.7.0)
-      timers (~> 4.0)
-      tty-cursor (~> 0.5.0)
-      tty-reader (~> 0.3.0)
-    tty-reader (0.3.0)
-      tty-cursor (~> 0.5.0)
-      tty-screen (~> 0.6.4)
+      tty-reader (~> 0.6.0)
+    tty-reader (0.6.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.7)
       wisper (~> 2.0.0)
-    tty-screen (0.6.4)
+    tty-screen (0.7.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
+    unf_ext (0.0.7.6)
     wisper (2.0.0)
 
 PLATFORMS
@@ -86,4 +73,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.16.1
+   1.17.2

data/README.md

@@ -6,162 +6,212 @@ installations, news, configurations, workstations and more.
 
 ## Installation
 
-To get started follow those steps:
-
-1- Clone the project:
+### Via Gem
 
 ```bash
-git clone https://github.com/rachidcalazans/chid.git
+$ gem install chid
 ```
 
-2- Install the dependcy if you do not have already installed:
+#### Initialize the chid config file
 
 ```bash
-$ gem install bundler
-$ bundle install
+$ chid init
 ```
 
-3- Inside the folder project run:
-
-```bash
-$ rake init
-```
+Creates a .chid.config file on root directory if none `~/.chid.config` file exists.
 
-**Note:** Chid will automatically install a *.chid.config* file and create an 
-alias on your **.bashrc** or **.zshrc** (if you have zsh installed). After the 
-installation **Chid** will give you the *bash command* to reload your **sources**
-file.
+To access that file will be created in `~/.chid.config`
 
 ## Upgrading
 
 To update the chid is easy.
 
 ```bash
-$ chid update
+$ gem update chid
 ```
 
 ## Usage
 
-**Chid** is an app based on **Rake Tasks**. You are available to use all features 
-as rake tasks or run as a **terminal app**:
+**Chid** is an gem app based on **Commands**. You are available to use all features running on **terminal**:
 
-**Note:** All tasks are available for **osx** and **linux**. The *chid* will automatically 
+To see all commands and how to use on Terminal, run:
+
+`$ chid -h`
+
+**Note:** All Commands are available for **osx** and **linux**. The *chid* will automatically 
 knows how run the specific **comand** for each plataform.
 
 All features are listed bellow:  
 
-#### Install chid configuration
+### Install chid configuration
 
 * `$ chid init` - Will install all necessary confiuration.
 
-#### Start the app
+### Chid configuration
 
-* `$ chid` - To start the **chid** terminal app
+* `$ chid config` - Open the **.chid.config** file using any source you want. By default is **vim**.
+* `$ chid config -editor vim`
 
-**Note:** To run the commands listed bellow you must started the chid app.
+### Feature Commands
 
-#### Help
+- [Git Commit](#git-commit)
+- [Install apps](#install-apps)
+- [Run apps](#run)
+- [currency](#currency) 
+- [News](#news)
+- [Search on StackOverflow](#search-on-stackOverflow)
+- [Search GitHub repositories](#search-gitHub-repositories)
+- [Workstations](#workstations)
+- [Tmux](#tmux)
+- [Configure and customize your workstations](#configure-workstation)
+ 
+### <a name="git-commit"></a> Git Commit
 
-* `help` or `:h` - Show all tasks available
+Create a commits in based on gitFlow pattern.
 
-#### Quit
+* `$ chid commit` - Start the process of commiting
+* `$ chid commit -h` - To see all options you can use as shortcut
 
-* `:q` or `quit` or `bye` or `exit` - Will finish the **chid** app
+#### An easy way to create commits following simple steps:
 
-#### Currency
+**First**:
+  Choose your commit type in this options (add,Remove, Update, Refactor, Fix)
 
-* `current` - Get the current conversion for USD to BRL amount
-* `currency list` - Show all types of currencies available to convert
-* `convert [amount] [type_from] to [type_to]` - You can convert an amount between 
-types. Eg.: **convert 10 USD to BRL**
+**Second**:
+  Type your commit title, a brief description of your changes
 
-#### Install apps
+**Third**:
+  Add your description lines, describing exactly what you did
+
+Thats it! Your commit will be created and pushed like this sample:
+
+```YAML
+feature/#123 Add specific file needed to app
+
+- specific file have now this line
+- this is the description line two
+
+Signed-off-by: "YourName" "yourEmail@mail.com"
+```
+
+### <a name="install-apps"></a> Install apps
 
 **Note:** All install tasks, chid will always ask if you really want to install it. Also 
 will install the dependencies if necessary.
 
-* `install dotfiles` - Install [YADR Dotfiles](https://github.com/skwp/dotfiles)
-* `install node` - Install Node
-* `install postgres` - Install Postgres
-* `install rvm` - Install stable RVM version
-* `install vim and/or gvim` - Install Vim
+* `$ chid install dotfiles` - Install [YADR Dotfiles](https://github.com/skwp/dotfiles)
+* `$ chid install node` - Install Node
+* `$ chid install postgres` - Install Postgres
+* `$ chid install rvm` - Install stable RVM version
+* `$ chid install vim and/or gvim` - Install Vim
 
-#### Run
+### <a name="run"></a> Run
 
 * `run postgres` - Run the postgresql if you already have installed.
 
-#### Update
+### <a name="currency"></a> Currency
 
-* `update os` or `update` - Will update the linux os. For osx is not available
+* `$ chid currency now` - Get the now converstion. Default -from USD -to BRL
+* `$ chid currency list` - All list of available Source to use on `now` and `convert commands`
+* `$ chid currency convert -amount [amount]` - You can convert an amount between types. Default -to BRL, -from USD 
 
-#### News
+### <a name="news"></a> News
 
-* `news` - Will show all news from some sites. BBC news, CNN, Espn, 
+* `$ chid news` - Will show all news from some sites. BBC news, CNN, Espn, 
 Mashable, Google, Techcrunch, Reddit
 
-#### Translate
-
-* `t [TEXT]` or `t [TEXT] [FROM] to [TO]` - Will translate the given text. By
-default the **from** is **en** and **to** is **pt**
-
-Example:
-`t hello world` or `t hello world en to pt`
+### <a name="search-on-stackOverflow"></a> Search on StackOverflow
 
-#### Search on StackOverflow
 
 A simple search in StackOverflow 
 
-* `stack [TEXT_TO_SEACH]` - Will search on StackOverflow all results for that 
+* `$ chid stack -search [TEXT_TO_SEACH]` - Will search on StackOverflow all results for that 
 text.
 
-* `stack` - Will ask what you want to search on StackOverflow all results for that 
-    
 <p align="left">
   <img src="etc/img/stack.png" alt="stack sample" />
 </p>
 
-#### Search GitHub repositories
+### <a name="search-gitHub-repositories"></a> Search GitHub repositories
 
 A simple search for repository name
 
-* `github [SEARCH_EXPRESSION]` - Show results for expression paginated every 10
+* `$ chid github -name [SEARCH_EXPRESSION]` - Show results for expression paginated every 10
     
-#### Workstations
+### <a name="workstations"></a> Workstations
 
 Workstations are a way to make it easy for you to open a set of applications by 
 simple commands.
 
 The set of configurations are saved on **.chid.config** file.
 
-**Note:** All commands bellow is possible run with prefix: `workstation [command]` 
-or `work [command]`.
+**Note:** All commands bellow is possible run with prefix: `$ chid workstation [command]` 
 
-* `work list` - List all workstations
-* `work create` - Create a new workstation. Chid will ask for a name to set the 
+* `$ chid workstation list` - List all workstations
+* `$ chid workstation create` - Create a new workstation. Chid will ask for a name to set the 
 new workstation and after that will list all **applications** available on your 
 system to chosse witch one you wanna add
-* `work destroy` - Chid will ask which workstation you want to destroy and chid 
+* `$ chid workstation destroy` - Chid will ask which workstation you want to destroy and chid 
 will destroy it after choose
-* `work open` - Open a specific workstation. Chid will list all workstations to 
+* `$ chid workstation open` - Open a specific workstation. Chid will list all workstations to 
 choose one of them to open all applications
-* `work open [workstation_name]` - Open a specific workstation without choose 
-from a list. Eg.: `work open base` - It will open all applications inside the 
+* `$ chid workstation open -name [workstation_name]` - Open a specific workstation without choose 
+from a list. Eg.: `$ chid workstation open -name base` - It will open all applications inside the 
 **base** workstation
 
 ![](http://g.recordit.co/WFqNuxORRd.gif)
 
-**Note:** For linux users the **work create** is not working. You need create 
+**Note:** For linux users the `$chid workstation create` is not working. You need create 
 manually (editing the .chid.config file). Will be explained how on
 **How configure and customize your workstations** topic
 
-#### Chid configuration
+### <a name="tmux"></a> Tmux
+
+If you use Tmux as I do for development, this is a nice Command Feature!
+
+This feature is based on some templates you will create on `~/.chid.config` file to open easily all your Dev Env
+
+This Feature have **2** commands, `list` and `open`
 
-* `chid config` or `config` - Open the **.chid.config** file
+* `$ chid tmux list` - List all existent tmux template
+* `$ chid tmux create` - Open a specific tmux template
+
+#### An example of Template you will add on **~/.chid.config**:
+
+```YAML
+---
+:chid:
+  :workstations: {}
+  :tmux_templates:
+    :NAME_YOUR_PROJECT:
+    - tmux new -s $$template_name$$ -n app -d;
+    - tmux send-keys -t $$template_name$$ 'cd DIRECTORY_PROJECT_PATH'
+      C-m;
+    - tmux send-keys -t $$template_name$$ 'vim' C-m C-m;
+    - tmux new-window -n tests -t $$template_name$$;
+    - tmux send-keys -t $$template_name$$ 'cd DIRECTORY_PROJECT_PATH'
+      C-m;
+    - tmux new-window -n server -t $$template_name$$;
+    - tmux send-keys -t $$template_name$$ 'cd DIRECTORY_PROJECT_PATH'
+      C-m;
+    - tmux attach -t $$template_name$$;
+```
+
+The example above each line is a tmux command. You can do what you need. In this case we have only two variables to replace:
+- NAME_YOUR_PROJECT -> the name which will appear on `tmux list`
+- DIRECTORY_PROJECT_PATH -> the full path of the your directory project. Ex.: `~/Workspaces/ruby-workspace/chid/`
+
+The commands above means those steps:  
+1- Create a new Tmux session with `app` name for the first tab or Find an existent one and Open it  
+2- Open the folder project on the tmux tab `app`  
+3- Open a new tab called `vim` and open the vim on the folder project  
+4- Open a new tab called `server` and go to the folder project  
+
+**base** workstation
 
-## How configure and customize your workstations
+## <a name="configure-workstation"></a> How configure and customize your workstations
 
-The chid configuration file is installed on **~/.chid.config**. You can open: `$ chid 
-chid_config`
+The chid configuration file is installed on **~/.chid.config**. You can open: `$ chid config`
 
 Chid config is a **YAML** file.
 
@@ -172,8 +222,8 @@ The initial chid config file will be like:
 ```YAML
 ---
 :chid:
-  :chid_path: "[CHID_FOLDER_PROJECT_PATH]"
   :workstations: {}
+  :tmux_templates: {}
 ```
 
 #### Base configuration
@@ -183,18 +233,18 @@ To add a new *workstation* you can edit like:
 ```YAML
 ---
 :chid:
-  :chid_path: "[CHID_FOLDER_PROJECT_PATH]"
   :workstations:
     :base: # Workstation Name
     - iTerm #Application Name
     - Safari
     - Slack
+  :tmux_templates: {}
 ```
 
 After edit you can open the **base** workstation running:
 
-* `$ chid workstation:open['base']` - As rake task
-* `work open base` - With the **chid** app running
+* `$ chid workstation open -name base`
+* `$ chid workstation open -n base`
 
 ![](http://g.recordit.co/VqTjUsQ9fy.gif)
 
@@ -209,13 +259,13 @@ Is possible you can customize some options with each Application when will open
 ```YAML
 ---
 :chid:
-  :chid_path: "[CHID_FOLDER_PROJECT_PATH]"
   :workstations:
     :base: # Workstation Name
-    - iTerm ~/Workspaces/rake-workspace/chid/ & rake tmux_config  # Will open 
-    # in a specific folder and will run some Rake Task
+    - iTerm ~/Workspaces/rake-workspace/chid/ & rspec  # Will open 
+    # in a specific folder and will run the rspec (run all tests)
     - Safari https://github.com/rachidcalazans/chid # Will open the Safari 
     # in a specific URL
+  :tmux_templates: {}
 ```
 
 ![](http://g.recordit.co/40rFYBBR1t.gif)