caperoma 4.0.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a648f676cfe9c4062e1598073274c668162b813e7ddfeba586d3c46479bfe76
-  data.tar.gz: 91239642ce5d990d056f72c2c1147ce37ba9252bbe69c180cdd11e7232f2d229
+  metadata.gz: 67af398ebdf45f5e2e1f10a6a95a2794681b559d120008d1e31397499e3e68aa
+  data.tar.gz: 7a5836a2d061e3e6bda0c24028fb17c4731a42564d6d6d1bc26f9089451b8506
 SHA512:
-  metadata.gz: afa44dd7474666982ee43221b177cc6c27837df1ac5dbe472abbe2a6b3a4260c0e8618924d82d0bbcb204dadbefb8784f694b43be1237b28997fdf4f51bdf19e
-  data.tar.gz: b5414cb1fa697731ebdf4172519862506a0531fb3f554c4307503e62100ec821e5800585d40848a604b3ca0990cf88fb62e9f0a670fe6511fde6f9dbd34360fd
+  metadata.gz: 3ffc2a6c69b8b362b809e25ef7197685399f8a674a2c9527794d4c2b70d0689e27e946ffe30e455e2ad24f105ac32fbd935c8b6d734d642a23481bea462adb50
+  data.tar.gz: 16efe9f7c82c5d09079fc0f29af56b9036e7b0aee8657c1f8995aca623e9a74f1835b3f7927d06aa07c8ae16346477fc865ec464e8480818e638da5aacfab465

data/Capefile

@@ -16,18 +16,18 @@ github_repo: zoopyserg/caperoma
 
 # --- JIRA SETTINGS:
 ## The full URL of your Jira server where you will create tasks.
-jira_url: https://zoopyserg.atlassian.net/
+jira_url: https://sergevinogradoff.atlassian.net/
 
 ## The ID of this project on your Jira system.
 jira_project_id: 10001
 
 ## Issue identifiers of various types on your Jira system.
 jira_issue_type_ids:
-  feature: 10101
-  bug: 10103
-  chore: 10100
-  fix: 10101
-  meeting: 10100
+  feature: 10001
+  bug: 10004
+  chore: 10001
+  fix: 10001
+  meeting: 10001
 
 ## Jira conversion identifiers.
 jira_transition_ids:

data/Capefile.template

@@ -19,9 +19,11 @@
 # jira_url: https://example.atlassian.net/
 
 ## The ID of this project on your Jira system.
+## If you are not sure what is Jira ID of this project, run the command "caperoma get_jira_project_ids" and paste here the ID that you see in the result.
 # jira_project_id: 12345
 
 ## Issue identifiers of various types on your Jira system.
+## If you are not sure what are Jira Issue Type IDs of this project, run the command "caperoma get_jira_issue_type_ids" and paste here the IDs that you see in the result.
 # jira_issue_type_ids:
 #   feature: 10101
 #   bug: 10103
@@ -29,7 +31,8 @@
 #   fix: 10101
 #   meeting: 10100
 
-## Jira conversion identifiers.
+## Jira transition identifiers.
+## If you are not sure what are Jira Transition IDs of this project, run the command "caperoma get_jira_transition_ids" and paste here the IDs that you see in the result.
 # jira_transition_ids:
 #   todo: 11
 #   in_progress: 21

data/Gemfile

@@ -2,17 +2,13 @@
 
 source 'https://rubygems.org'
 
-ruby '2.6.3'
-
 # Runtime dependencies
 gem 'actionpack'
 gem 'actionview'
 gem 'activerecord'
-gem 'activesupport'
 gem 'faraday'
 gem 'gmail'
 gem 'jbuilder'
-gem 'pivotal-tracker'
 gem 'rubocop'
 gem 'sqlite3'
 gem 'time_difference'
@@ -21,7 +17,7 @@ gem 'whenever', require: false
 group :development do
   gem 'bundler'
   gem 'database_cleaner'
-  gem 'factory_bot_rails'
+  gem 'factory_girl'
   gem 'juwelier'
   gem 'rdoc'
   gem 'rspec'

data/Gemfile.lock

@@ -32,21 +32,14 @@ GEM
     builder (3.2.3)
     chronic (0.10.2)
     concurrent-ruby (1.1.5)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
     crass (1.0.4)
     database_cleaner (1.7.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.3)
-    domain_name (0.5.20190701)
-      unf (>= 0.0.5, < 1.0.0)
     erubi (1.8.0)
-    factory_bot (5.0.2)
-      activesupport (>= 4.2.0)
-    factory_bot_rails (5.0.2)
-      factory_bot (~> 5.0.2)
-      railties (>= 4.2.0)
+    factory_girl (4.9.0)
+      activesupport (>= 3.0.0)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
     git (1.5.0)
@@ -63,8 +56,6 @@ GEM
       oauth (>= 0.3.6)
     hashie (3.6.0)
     highline (2.0.2)
-    http-cookie (1.0.3)
-      domain_name (~> 0.5)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
@@ -90,21 +81,14 @@ GEM
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    method_source (0.9.2)
-    mime-types (3.2.2)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.11.3)
     multi_json (1.13.1)
     multi_xml (0.6.0)
     multipart-post (2.1.1)
-    netrc (0.11.0)
     nokogiri (1.10.3)
       mini_portile2 (~> 2.4.0)
-    nokogiri-happymapper (0.8.1)
-      nokogiri (~> 1.5)
     oauth (0.5.4)
     oauth2 (1.4.1)
       faraday (>= 0.8, < 0.16.0)
@@ -115,12 +99,6 @@ GEM
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
-    pivotal-tracker (0.5.13)
-      builder
-      crack
-      nokogiri (>= 1.5.5)
-      nokogiri-happymapper (>= 0.5.4)
-      rest-client (>= 1.8.0)
     psych (3.1.0)
     public_suffix (3.1.1)
     rack (2.0.7)
@@ -131,19 +109,9 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.0.4)
       loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.3)
-      actionpack (= 5.2.3)
-      activesupport (= 5.2.3)
-      method_source
-      rake (>= 0.8.7)
-      thor (>= 0.19.0, < 2.0)
     rainbow (3.0.0)
     rake (12.3.3)
     rdoc (6.1.1)
-    rest-client (2.0.2)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -165,22 +133,17 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
-    safe_yaml (1.0.5)
     semver2 (3.4.2)
     shoulda (2.11.3)
     shoulda-matchers (4.1.1)
       activesupport (>= 4.2.0)
     sqlite3 (1.4.1)
-    thor (0.20.3)
     thread_safe (0.3.6)
     time_difference (0.7.0)
       activesupport (~> 5.1)
     timecop (0.9.1)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.7.6)
     unicode-display_width (1.6.0)
     whenever (1.0.0)
       chronic (>= 0.6.3)
@@ -192,15 +155,13 @@ DEPENDENCIES
   actionpack
   actionview
   activerecord
-  activesupport
   bundler
   database_cleaner
-  factory_bot_rails
+  factory_girl
   faraday
   gmail
   jbuilder
   juwelier
-  pivotal-tracker
   rdoc
   rspec
   rubocop
@@ -211,8 +172,5 @@ DEPENDENCIES
   timecop
   whenever
 
-RUBY VERSION
-   ruby 2.6.3p62
-
 BUNDLED WITH
    1.17.3

data/HELP

@@ -8,9 +8,15 @@ Available commands
 ### Initialize
 `caperoma init` - initializes Caperoma inside a project (creates Capefile).
 
+### Get Project IDs from Jira 
+`caperoma get_jira_project_ids` - see what project IDs does your Jira support, to put them into the Capefile.
+
 ### Get Issue IDs from Jira 
 `caperoma get_jira_issue_type_ids` - see what issue IDs does your Jira support, to put them into the Capefile.
 
+### Get Transition IDs from Jira 
+`caperoma get_jira_transition_ids` - see what transition IDs does your Jira support, to put them into the Capefile.
+
 ### Status
 `caperoma status` - shows a task you are working on now.
 Example:
@@ -30,6 +36,7 @@ $ caperoma status
 You are not working on anything now.
 ```
 
+### Projects List
 `caperoma projects` - shows the list of projects on this computer.
 Example:
 ```bash
@@ -52,16 +59,24 @@ $ caperoma projects
 - *If the -p parameter is specified, Caperoma starts Pivotal task with this ID.*
 - *If the -p parameter is not specified, Caperoma will create a new task in Pivotal, start it and use its ID.*
 - *The creation of certain types of tasks in Pivotal (when -p is absent) can be turned on or off in Capefile.*
-- *If you are already working on something, you won't be able to start a new task. You will have to finish or pause the current task.*
+- *If you are already working on something, you won't be able to start a new task. First, you will have to finish or pause the current task.*
 
 `options`:
-`-t, --title` - The name of the feature (for a commit, pull request, tasks in Jira and Pivotal). ` -t` and `--title` are different versions of the same option.
-`-d, --description` - The description (for a task in Jira and Pivotal).
-`-p, -ptid, --pivotal_task_id` - ID of task in Pivotal (automatically gets started/finished during the work on it in Caperoma).
-`-a, --additional_time` - Additional time (in minutes). Intended for cases when you want to indicate that you started working on it X minutes ago (X minutes before starting Caperoma timer). For example, for 1 hour you tried to reproduce the problem before you realized that you need to start a new task. Or if you forgot to start Caperoma. Additional time is always in minutes. Adding 125 minutes (-a 125) will mean that you spent 2h 5m on the task before turning on Caperoma timer.
 
-*The order of options is not important.
-Immediately after the operator must be a value.*
+`-t`, `--title` - The name of the feature (for a commit, pull request, tasks in Jira and Pivotal). ` -t` and `--title` are different versions of the same option.
+
+
+`-d`, `--description` - The description (for a task in Jira and Pivotal).
+
+
+`-p`, `-ptid`, `--pivotal_task_id` - ID of task in Pivotal (automatically gets started/finished during the work on it in Caperoma).
+
+
+`-a`, `--additional_time` - Additional time (in minutes). Intended for cases when you want to indicate that you started working on it X minutes ago (X minutes before starting Caperoma timer). For example, for 1 hour you tried to reproduce the problem before you realized that you need to start a new task. Or if you forgot to start Caperoma. Additional time is always in minutes. Adding 125 minutes (-a 125) will mean that you spent 2h 5m on the task before turning on Caperoma timer.
+
+*The order of options is not important.*
+
+*Immediately after the operator must be a value.*
 
 Examples:
 ```bash
@@ -76,12 +91,18 @@ caperoma feature -t "title" -d "description" -p 4830184 -a 48
 
 caperoma feature --title "title" --description "description" --pivotal_task_id 1000001 --additional_time 5
 # (create the feature "title" with the description of "description" and Pivotal ID #1000001, on which you started working 5 minutes ago)
+
+caperoma feature -p 12345678
+# (it will take title and description from Pivotal task with id 12345678)
 ```
 
 #### Start a Bug 
 `caperoma bug [options]` - Creates a bug in the new branch.
+
 Does almost the same thing as `caperoma feature`, just starts everywhere the tasks of a type "bug".
+
 `options`: same as for `caperoma feature`
+
 Example:
 ```bash
 caperoma bug -t "something isn't working" -a 20
@@ -90,13 +111,18 @@ caperoma bug -t "something isn't working" -a 20
 
 #### Start a Fix  
 `caperoma fix [options]` - Creates a fix in the CURRENT branch, doing at the end just "git push" into the branch, not a pull request.
+
 Everything else is almost the same as `caperoma feature`.
+
 This command is created for the cases when you already have a remote branch, or if you already made a pull request, and you need to go back to it and add something.
+
 This command considers the specifics of work with open pull requests and remote branches:
 - Downloads the latest version of the current branch before starting the work and again before pushing the changes.
 - Changes are made in a new commit instead of a potentially conflicting amend.
 - Leaves the title and description of pull requests.
+
 `options`: same as for `caperoma feature`
+
 Example:
 ```bash
 caperoma fix --title "Spelling fix" -d "Fix the spelling mistake"
@@ -105,15 +131,23 @@ caperoma fix --title "Spelling fix" -d "Fix the spelling mistake"
 
 #### Start a Meeting 
 `caperoma meeting [options]` - Creates a meeting.
+
 For cases when you need to record to Jira the facts of talking on the phone with your coworkers.
+
 Jira ID for the meeting (as for other types of tasks) can be set in Capefile (by default it has the same value as a chore).
+
 In Pivotal creating meetings is off by default. It can be turned on in Capefile. If it is on, Caperoma will create "chores".
+
 `options`: same as for `caperoma feature`
 
 This feature is sometimes used to automate logging phone calls to Jira.
+
 For example, in Skype, you could configure it to call the command `caperoma meeting -t "meeting"` when you pick up the phone and call `caperoma finish` when you hang up.
+
 As a result, Skype conversations will automatically be entered into Jira with accuracy up to a minute.
+
 5-10 people can participate in a conference call, so if each of them sets up Caperoma, you can save a couple of man-hours for each call.
+
 Example:
 ```bash
 caperoma meeting -t "title"
@@ -121,9 +155,13 @@ caperoma meeting -t "title"
 
 #### Start a Chore
 `caperoma chore [options]` - Creates a chore. Without branch and commit.
+
 For cases when the goal of the task is not committing code.
+
 For example, you need to configure something on a remote server.
+
 `options`: same as for `caperoma feature`
+
 Example:
 ```bash
 caperoma chore -t "going downtown to pick up a new computer" -a 10
@@ -134,6 +172,7 @@ caperoma chore -t "going downtown to pick up a new computer" -a 10
 
 #### Finish current task
 `caperoma finish [optional comment]` - ends a task of any type.
+
 Do everything that you usually do after finishing a task:
 - git commit (feature, bug, fix) [commit name consists of the task title, Jira ID and Pivotal ID]
 - runs style guide checks (rubocop -a)
@@ -155,29 +194,39 @@ caperoma finish "completed"
 
 #### Abort current task
 `caperoma abort [optional comment]` - finish without committing / pushing changes.
+
 This command does what you usually need to do to interrupt the task:
 - Logs time to Jira.
 - changes the status of Jira task to "done"
 - changes the status of Pivotal task to "finished"
 - switches to the main branch
+
 All changes to files remain uncommitted.
+
 Examples:
 ```bash
 caperoma abort "can't reproduce"
 # interrupt + write a comment "can't reproduce" in Jira
 
 caperoma abort
+# keep comment blank
 ```
 
 #### Abort current task without logging time
 `caperoma abort_without_time [optional comment]` - same as abort, but does not log time to Jira
+
 Only changes the status of Jira task to "done".
+
 Pivotal task remains started.
+
 Files remain uncommitted.
 
 Example:
+
 Suppose you started a task and fall asleep.
+
 You wake up, the timer is still running.
+
 You stop the timer without logging time to Jira:
 ```
 caperoma abort_without_time
@@ -185,6 +234,7 @@ caperoma abort_without_time
 
 #### Pause current task
 `caperoma pause [optional comment]` — stop work on the task, but not consider it completed (don't make a pull request).
+
 What it will do:
 - git commit (feature, bug, fix) [commit name consists of the task title, Jira ID and Pivotal ID]
 - runs style guide checks (rubocop -a)
@@ -200,6 +250,7 @@ To finish the paused task, you will need to manually switch into its branch and
 Finishing the task will be done by new independent tasks in Jira.
 
 Example:
+
 Suppose you need to urgently switch to another task.
 ```bash
 ...
@@ -224,10 +275,15 @@ caperoma finish
 
 #### Adding Accounts
 `caperoma accounts [add command] [account_type] [login] [password] [assignee]` - add (or overwrite) an account of type [account_type] to the database.
+
 `[add command]`: `-a`, `add`, `--add`, `-c`, `create`, `--create` (all these are equivalent).
+
 `[account_type]`: One of: `--jira`, `--pivotal` `--git`, `--gmail`
+
 `[login]` is your account login (email or username).
+
 `[password]` for --jira and --pivotal should be api_tokens (password won't do). for --git and --gmail it should be your password.
+
 `[assignee]` is only for --jira, for other types no need to write anything there.
 
 Examples:
@@ -243,7 +299,9 @@ caperoma accounts --create --gmail login password   # Add Gmail account for repo
 
 #### Removing accounts
 `caperoma accounts [remove_command] [account_type]` - remove an account of a given type.
+
 `[remove_command]`: `remove`, `--remove`, `-r`, `delete`, `--delete`, `-d` (all these are equivalent).
+
 `[account_type]`: One of the following: `--jira`, `--pivotal`, `--git`, `--gmail`
 
 Examples:
@@ -256,10 +314,18 @@ caperoma accounts -delete --gmail # Remove Gmail account for reports
 
 ### Deleting all data from this computer
 `caperoma delete_history` - removes the caperoma database, so deletes the information on the tasks, time spent, branch names, account credentials, etc.
+
 Keeps the folders of your projects intact.
 
+
+### Deleting all tasks from this computer
+`caperoma delete_tasks` - removes the tasks from the database, so deletes the information on the task names, time spent, branch names, etc.
+
+Keeps other settings (accounts, projects) and the folders of your projects intact.
+
 ### Version:
 `caperoma -v` - shows Caperoma version
+
 `caperoma version` - shows Caperoma version
 
 ### Recipients
@@ -268,7 +334,9 @@ Keeps the folders of your projects intact.
 
 #### Adding Report Recipients:
 `caperoma recipients [add command] [email]` - adds an email of a recipient of your reports to the database.
+
 `[add command]`: `-a`, `add`, `--add`, `-c`, `create`, `--create` (all these are equivalent).
+
 `[email]` - the email of the recipient
 
 Examples:
@@ -282,6 +350,7 @@ caperoma recipients --add "your_techlead@domain.com"
 
 #### Removing Report Recipients
 `caperoma recipients [remove command] [email]` - removes the `[email]` of the recipient of your reports from the database.
+
 `[remove command]`: `remove`, `--remove`, `-r`, `delete`, `--delete`, `-d` (all these are equivalent).
 
 Examples:
@@ -293,17 +362,19 @@ caperoma recipients --delete "your_supervisor@domain.com"
 
 ### Automatic Reports
 `caperoma report auto on` - turns on automatic report sending to all your recipients.
+
 `caperoma report auto off` - turn off automatic report sending to all your recipients.
 
 ### Sending Reports Manually
-`caperoma report daily` - send a daily report right now
-`caperoma report -d` - send a daily report right now
+`caperoma report [option]` - send a report right now.
+
+`[option]`:
+
+`daily`, `-d` - send a daily report right now
 
-`caperoma report three_day` - send a three-day report right now
-`caperoma report -t` - send a three-day report right now
+`three_day`, `-t` - send a three-day report right now
 
-`caperoma report weekly` - send a weekly report right now
-`caperoma report -w` - send a weekly report right now
+`weekly`, `-w` - send a weekly report right now
 
 ### Support me on Patreon.
 https://www.patreon.com/sergevinogradoff