3llo 0.3.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e05bd8d3c7bea9ee60906b240c091388184e4564
-  data.tar.gz: 3c42a1c12897aba513a736b3afd84d3dcf624838
+SHA256:
+  metadata.gz: 924f5388e35597e1570a41cc0e0d346d999a6c5a354904e2d4db189579a5047d
+  data.tar.gz: 0d6d728e7831db53095118317a12e3d952793ecdae041db2dd75ca6d8282f515
 SHA512:
-  metadata.gz: d81e257f0a944ec5ab3dd6373814ee8d4ae0482d0029d169222b827865a10cbfff93b08a6f508dab1c2b068acbecc7f40dbf4d13fe8032617dbfd299e27e56b8
-  data.tar.gz: fbaa8605fb23e12ecf5c93133bcbe70933b6eb8f7bcfe33cf4cae18920ecaca99fa6d355eed44e77e79fb37b060b046aa136b86e655be0931d2716b08eec77e1
+  metadata.gz: 11c88432c0490b325080423edee099ac78263f7f0efcb7ef0f9d81d5348733d26649bddfcb335452946b5b8150b2dc539fb224094f6efeabc128ee14694cc198
+  data.tar.gz: '0318a410ef4b35661a9442cab3cdf9a22dcec2cda1645e0000e6eab0629b38ea6df4c97183dae1beb814b444bbd05a841d7da4db1f86aea1882207466f91664d'

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby_version: ['2.5.x', '2.6.x']
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby ${{ matrix.ruby_version }}
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+    - name: Install dependencies
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+    - name: Start httpbin container
+      run: docker run -d -p 8080:80 kennethreitz/httpbin
+    - name: Run Rubocop
+      run: bundle exec rubocop
+    - name: Run test
+      run: bundle exec rspec

data/.rubocop.yml

@@ -0,0 +1,122 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+Layout/LineLength:
+  Max: 120
+
+Layout/DotPosition:
+  EnforcedStyle: leading
+
+Layout/EmptyLinesAroundBlockBody:
+  EnforcedStyle: no_empty_lines
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/SpaceInsideBlockBraces:
+  EnforcedStyle: space
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Layout/SpaceInsideParens:
+  EnforcedStyle: no_space
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Metrics:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
+Security/JSONLoad:
+  Enabled: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/GlobalVars:
+  AllowedVariables: ['$application']
+
+Style/GuardClause:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19
+
+Style/MethodCallWithoutArgsParentheses:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/MultilineBlockChain:
+  Enabled: false
+
+Style/PreferredHashMethods:
+  EnforcedStyle: verbose
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: no_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: no_comma
+
+Style/WordArray:
+  EnforcedStyle: percent
+  MinSize: 3
+
+Style/SpecialGlobalVars:
+  EnforcedStyle: use_english_names
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Lint/NonDeterministicRequireOrder:
+  Enabled: false

data/3llo.gemspec

@@ -1,21 +1,20 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require '3llo/version'
+require "3llo/version"
 
 Gem::Specification.new do |spec|
   spec.name = "3llo"
   spec.version = Tr3llo::VERSION
-  spec.authors = ["Cẩm Huỳnh"]
-  spec.email = ["huynhquancam@gmail.com"]
+  spec.authors = ["Cẩm Huỳnh", "Diệp Sở Hùng"]
+  spec.email = ["huynhquancam@gmail.com", "diepsohung@gmail.com"]
 
-  spec.summary = %q{Trello CLI}
-  spec.description = %q{CLI for Trello}
+  spec.summary = "Trello CLI app"
+  spec.description = "Interactive CLI application for Trello"
   spec.homepage = "https://github.com/qcam/3llo"
   spec.license = "MIT"
 
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
   else
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end
@@ -25,9 +24,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |filename| File.basename(filename) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '~> 2.0'
+  spec.required_ruby_version = "~> 2.5"
 
-  spec.add_runtime_dependency 'tty-prompt', '~> 0.12.0'
+  spec.add_runtime_dependency "tty-prompt", "~> 0.20"
 
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.79"
 end

data/CHANGELOG.md

@@ -1,5 +1,36 @@
 # CHANGELOG
 
+## v1.2.0
+
+* Support running multiple commands with `--init` switch (#83)
+* Include current board name to status line (#77)
+* Introduce `card add-label` command (#74)
+* Support multiline card description (#72)
+
+## v1.1.0
+
+* Introduce "list add" command.
+* Introduce "board add" command.
+* Introduce label related command.
+* Support exiting with Ctrl+D.
+
+## v1.0.0
+
+* Support using shortcuts to access entities.
+* Introduce `--config` switch.
+* Introduce `--init` switch.
+* Introduce `--configure` switch.
+* Deprecate using environment variables for configuration.
+* Improve performance of several commands.
+* Support checklist related commands.
+* Support Ruby 2.5+.
+* Introduce `card edit` command.
+* Improve command auto completion.
+
+## v0.3.1
+
+* Improve self-documentation [#39](https://github.com/qcam/3llo/pull/39).
+
 ## v0.3.0
 
 * Accept multiline in "card comment" command [#33](https://github.com/qcam/3llo/pull/33).

data/Gemfile

@@ -1,7 +1,7 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in trecli.gemspec
 gemspec
 
-gem 'bundler'
-gem 'rake'
+gem "bundler"
+gem "rake"

data/{LICENSE.md → LICENSE}

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
 Copyright (c) 2017 Cẩm Huỳnh
+Copyright (c) 2020 Cẩm Huỳnh and Diệp Sở Hùng
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,66 +1,146 @@
-# 3llo - Interactive CLI for Trello
+3llo - The interactive CLI application for Trello
+================
 
-3llo is the terminal client for Trello, which helps you manage Trello cards without
-leaving your awesome terminal.
+3llo allows you to work with Trello without exiting your favorite terminal.
 
-[![video](intro.gif)](https://asciinema.org/a/0z3l05hwph3vdq91gu7n1m3o4)
+![video](intro.gif)
 
 3llo was inspired by the awesome
 [rainbowstream](https://github.com/DTVD/rainbowstream) and
 [facy](https://github.com/huydx/facy).
 
-## Why this named 3llo?
-
-Good to know that `3 == "tre"` in Swedish.
-
 ## Installation
 
 ```ruby
 gem install 3llo
 ```
 
-You also need to have these environment variables set in your shell.
+Run `3llo --configure` and follow the instructions to complete the set up.
+
+## Usage
+
+### "board" command family
+
+Just like the web version of Trello, you need to select a board:
 
 ```
-export TRELLO_USER=your_username
-export TRELLO_KEY=your_key
-export TRELLO_TOKEN=your_token
+3llo  > board list
+
+[123abc000000000000000001 #1] - Weekend TODOs
+[123abc000000000000000002 #2] - 3llo project
+[123abc000000000000000003 #3] - Grocery list
+
+3llo > board select #2
+
+Board Work stuff selected
 ```
 
-### Obtain Trello API key and token
+Please note that you can also access any entities with their Trello ID.
+
+```
+3llo > board select 123abc000000000000000002
 
-1. Go to [Get started](https://developers.trello.com/get-started/start-building).
-2. Click on **Get your Application Key**.
-3. Copy the Application Key and generate a Token using the instruction on the page.
+Board Work stuff selected
+```
 
-## Usage
+### "list" command family
+
+Executing `list list` will list all the lists in the board.
+
+```
+3llo > list list
+
+[123abc000000000000000001 #1] To Do
+[123abc000000000000000002 #2] Doing
+[123abc000000000000000003 #3] Pending
+[123abc000000000000000004 #4] Done
+```
+
+`list cards <list_key>` will list all the cards.
+
+```
+3llo > list cards #1
+
+[123abc000000000000000001 #1] Merge card editing command
+[123abc000000000000000002 #2] Refactor code
+...
+```
+
+### "card" command family
+
+"card" command family comes with many commands to work with cards.
+
+To list all the cards in the board, run `card list`.
 
-There are a couple of commands available in 3llo.
-
-* `board list`: List your board
-* `board select <board_id>`: Select the active board.
-* `card list`: List all cards of the active board.
-* `card list mine`: List all your cards of the active board.
-* `card add`: Create a card.
-* `card show <card_id>`: Show card information.
-* `card move <card_id> <list_id>`: Move card to a specified list.
-* `card self-assign <card_id>`: Self-assign a card.
-* `card comments <card_id>`: Show recent comments of a card.
-* `card comment <card_id>`: Add a comment to a card.
-* `card archive <card_id>`: Archive a card.
-* `list list`: List all the lists of the active board.
-* `list archive-cards <list_id>`: Archives all the cards on the specified list.
-* `help`: Show help menu.
-* `exit`: Exit.
+```
+3llo > card list
+
+#To Do
+======
+[123abc000000000000000001 #1] Merge card editing command [#small]
+[123abc000000000000000002 #2] Refactor code [#medium] [@qcam]
+
+
+#Doing
+======
+[123abc000000000000000003 #3] Release v1.0 [#release] [@qcam]
+
+#Pending
+...
+```
+
+You can also list cards that have been assigned to you with `card list mine`.
+
+```
+3llo > card list mine
+
+[123abc000000000000000002 #2] (To Do) Refactor code
+[123abc000000000000000003 #3] (Doing) Release v1.0
+```
+
+To view a card in detail, `card show <card_key>` is your friend.
+
+```
+3llo > card show #2
+
+Refactor code
+[123abc000000000000000002 #2]
+Link: https://trello.com/c/AbCdEfG
+
+Things to do [123abc000000000000000001 #1]
+[ ] Item 1 [123abc000000000000000001 #1]
+[ ] Item 2 [123abc000000000000000002 #2]
+[ ] Item 3 [123abc000000000000000003 #3]
+[ ] Item 4 ...
+```
+
+Want to comment on a card? Run `card comment <card_key>`.
+
+```
+3llo > card comment #2
+
+Comment: (Press CTRL-D or CTRL-Z to finish)
+What else should we refactor more?<enter>
+
+Comment has been posted
+
+3llo > card comments #2
+
+@just_another_person_on_the_internet on <Jan 01, 2020 00:55:55> wrote:
+This card is awesome!
+
+@qcam on <Jan 01, 2020 00:55:55> wrote:
+What else should we refactor more?
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/qcam/3llo. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/qcam/3llo.
 
-### Development Roadmap
+### "3llo" sounds odd to me. Where did the name come from?
 
-View in [Issues](https://github.com/qcam/3llo/issues)
+It might be interesting to know that `3 == "tre"` in Swedish 🇸🇪.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+MIT