Restructure commands: Adding get subcommands (WIP) #195

matheussbernardo · 2018-06-04T23:42:15Z

I started to implement the new commands,
I faced a big problem with the tests. I do not fully understand them, It does not seem to have a pattern between all the tests, some use VCR, other mock in a way others in another away, I need help on that.

Regarding the changes I propose a different structure.

According to the thor docs(http://whatisthor.com/) if I want to implement subcommands like (trollolo get SUBCOMMANDS), I need to create another class that inherits from Thor and then point that class from the parent class and wrap everything around the same module.

So basically what I did was, I created a module name TrolloloCLI on cli.rb, then I created a dir named cli and created a class inside named Get, I copied to this new class all the get related commands and renamed it to what was defined on #15.

On the cli.rb file I require the cli/get.rb, also I had to call some methods that were private on the class Cli because of that I changed these methods to be module methods and the @@settings to be a variable of the module, this way I can call them from the new class Get and in the future from the others classes that I intend to do.

What do you guys think? Is this a good way to do the restructure? And about the tests how can I understand them fully and maybe cleanup the test suite? (seems that @manno is working on that #193 PR)

cornelius · 2018-06-05T08:52:12Z

I would keep it simple for now and not introduce a new namespace or rename the command class. You could just add a new class CliGet where you define the get subcommand. This can be included in the same way as all other classes in lib/trollolo.rb and the file could also just live in lib/cli_get.rb.

Calling private methods from outside of a class is usually not a great idea. They are private for a reason after all. Maybe you can find a better way?

The existing @@settings variable also is not a great idea. This kind of global state tends to complicate things. This might be a bigger change but I would try to move the code base into a direction where this is not needed anymore but settings are passed explicitly to the classes which need them.

Regarding the tests I would not use VCR anymore. #193 will remove them. For the command line handling it might be best to not rely on any board data and only test that the logic of handling the commands works properly.

matheussbernardo · 2018-06-05T10:22:53Z

I understand the problem with a new namespace but it was created to fulfill the problem with the @@settings and the private methods, because they need to be available from any classes on that namespace. so that methods are not that private at all when introducing new classes. I will search for a better way, but I'm not sure what is the best way to share these methods and variables around these new classes.

Ana06 · 2018-06-05T15:12:14Z

@matheussbernardo regarding the @@setings, I agree with @cornelius that it would be better to move the code base into a direction where this is not needed anymore but settings are passed explicitly to the classes which need them.

Making CliGet a subclass of Cli may be an option if many of the methods there are needed. So that the namespace is not needed. @cornelius what do you think about that?

matheussbernardo · 2018-06-05T19:59:54Z

Actually @Ana06 I dont think inherit from Cli makes sense because the Cli class has public methods that I do not want to inherit, and the thor documentation uses the subcommands as subclasses from Thor.

matheussbernardo · 2018-06-05T20:23:15Z

I thought about introducing a new module that implements

def board_id(id_or_alias)
def require_trello_credentials
def process_global_options(options)
def self.settings=(s)
and getters and setters for settings,
then this module is includein the classes that need to use them.

Or maybe use ruby open classes and include the new module on the Thor class so that all the subcommands and Cli get the methods that is needed

Ana06 · 2018-06-06T12:19:08Z

Restructure commands

matheussbernardo · 2018-06-07T02:56:08Z

@cornelius @Ana06 What do you guys think about the module?

Ana06 · 2018-06-11T11:09:30Z

@matheussbernardo the idea sounds go to me, @cornelius what do you think?

cornelius · 2018-06-11T16:51:18Z

Yes, a module sounds good. Give it a try.

Ana06

@matheussbernardo you need to rebase

Ana06 · 2018-06-19T08:22:39Z

lib/cli.rb

@@ -408,7 +57,229 @@ def require_trello_credentials
  # Returns the board_id using id_or_alias. If id_or_alias matches a mapping
  # from trollolorc then the mapped id is returned or else the id_or_alias
  # is returned.
-  def board_id(id_or_alias)
+  def self.board_id(id_or_alias)


this method was private before and now it is public 🤔

Ana06 · 2018-06-19T08:22:58Z

lib/cli.rb

    write_back = false
-
+    


extra spaces that can be removed 😉

Ana06 · 2018-06-19T08:23:26Z

lib/cli.rb

    @@settings.verbose = options[:verbose]
    @@settings.raw = options[:raw]
  end

-  def require_trello_credentials
+  def self.require_trello_credentials


this method was private before and now it is public 🤔

Ana06 · 2018-06-19T08:24:07Z

lib/cli.rb

+    class_option :version, type: :boolean, desc: 'Show version'
+    class_option :verbose, type: :boolean, desc: 'Verbose mode'
+    class_option :raw, type: :boolean, desc: 'Raw mode'
+    # class_option 'board-id', type: :string, desc: 'id of Trello board'


why is this comment here?

Ana06 · 2018-06-19T08:24:17Z

lib/cli.rb

+    class_option :verbose, type: :boolean, desc: 'Verbose mode'
+    class_option :raw, type: :boolean, desc: 'Raw mode'
+    # class_option 'board-id', type: :string, desc: 'id of Trello board'
+


too many empty lines 🙈

cornelius · 2018-06-21T22:19:37Z

lib/cli.rb

-  def self.settings=(s)
-    @@settings = s
-  end
+  # class_option 'board-id', type: :string, desc: 'id of Trello board'


Don't leave in code which has been commented out.

cornelius · 2018-06-21T22:20:46Z

The code in general looks fine now but please rebase as Ana suggested so we can also see the CI run.

Ana06

Please prepare the commits to be merged with a description. 😉

Ana06 · 2018-06-25T14:12:23Z

.rubocop_todo.yml

@@ -96,6 +96,7 @@ Layout/ExtraSpacing:
 Layout/IndentHeredoc:
  Exclude:
    - 'lib/cli.rb'
+    - 'spec/unit/cli/*.rb'


you can do this automatically by running: rubocop --auto-gen-conf

Ana06

LGTM, @cornelius please take a look 😉

cornelius · 2018-07-02T12:26:06Z

In general the patch looks great now. I would suggest to slightly change the naming of the classes, though, to get a more consistent naming scheme. Sorry, if that feels like nitpicking but it's easier to do this before things are merged and so we get a clean state in master right away.

I would name all the CLI classes with a Cliprefix so CliGet, CliBackupetc. instead of using the suffix. This is more consistent with the directory structure, e.g. cli/get.rb. It also makes sure that when classes or files are sorted alphabetically they all go together. This can be handy when looking at files or in other tools.

It should be Cli, not CLI, in the class names, by the way. The convention is to only capitalize the first letter so that CamelCasing still works.

And there seems to be a test failing in the CI. This should also be fixed.

* Use Thor subcommands and creates new classes for each new subcommand * Change commands name to be more expressive * Change tests to reflect the changes

cornelius · 2018-07-11T13:23:30Z

looks good to me. please merge when the ci is green.

matheussbernardo · 2018-07-11T20:59:52Z

Ready to merge!

Ana06

Then let's merge it! 😉

Ana06 reviewed Jun 19, 2018

View reviewed changes

cornelius reviewed Jun 21, 2018

View reviewed changes

matheussbernardo force-pushed the master branch 2 times, most recently from 54e59cc to 9e685b6 Compare June 25, 2018 01:57

Ana06 reviewed Jun 25, 2018

View reviewed changes

matheussbernardo force-pushed the master branch 2 times, most recently from 1301cc9 to a2c5f6f Compare June 28, 2018 15:23

Ana06 approved these changes Jul 2, 2018

View reviewed changes

matheussbernardo force-pushed the master branch from a2c5f6f to a0891d0 Compare July 3, 2018 01:21

Restructure commands

1cef8d7

* Use Thor subcommands and creates new classes for each new subcommand * Change commands name to be more expressive * Change tests to reflect the changes

matheussbernardo force-pushed the master branch from a0891d0 to 1cef8d7 Compare July 11, 2018 13:21

Ana06 approved these changes Jul 12, 2018

View reviewed changes

Ana06 merged commit 82fd56c into openSUSE:master Jul 12, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Restructure commands: Adding get subcommands (WIP) #195

Restructure commands: Adding get subcommands (WIP) #195

matheussbernardo commented Jun 4, 2018 •

edited

cornelius commented Jun 5, 2018

matheussbernardo commented Jun 5, 2018 •

edited

Ana06 commented Jun 5, 2018

matheussbernardo commented Jun 5, 2018

matheussbernardo commented Jun 5, 2018

Ana06 commented Jun 6, 2018

matheussbernardo commented Jun 7, 2018

Ana06 commented Jun 11, 2018

cornelius commented Jun 11, 2018

Ana06 left a comment

Ana06 Jun 19, 2018

Ana06 Jun 19, 2018

Ana06 Jun 19, 2018

Ana06 Jun 19, 2018

Ana06 Jun 19, 2018

cornelius Jun 21, 2018

cornelius commented Jun 21, 2018

Ana06 left a comment

Ana06 Jun 25, 2018

Ana06 left a comment

cornelius commented Jul 2, 2018

cornelius commented Jul 11, 2018

matheussbernardo commented Jul 11, 2018

Ana06 left a comment

Restructure commands: Adding get subcommands (WIP) #195

Restructure commands: Adding get subcommands (WIP) #195

Conversation

matheussbernardo commented Jun 4, 2018 • edited

cornelius commented Jun 5, 2018

matheussbernardo commented Jun 5, 2018 • edited

Ana06 commented Jun 5, 2018

matheussbernardo commented Jun 5, 2018

matheussbernardo commented Jun 5, 2018

Ana06 commented Jun 6, 2018

matheussbernardo commented Jun 7, 2018

Ana06 commented Jun 11, 2018

cornelius commented Jun 11, 2018

Ana06 left a comment

Choose a reason for hiding this comment

Ana06 Jun 19, 2018

Choose a reason for hiding this comment

Ana06 Jun 19, 2018

Choose a reason for hiding this comment

Ana06 Jun 19, 2018

Choose a reason for hiding this comment

Ana06 Jun 19, 2018

Choose a reason for hiding this comment

Ana06 Jun 19, 2018

Choose a reason for hiding this comment

cornelius Jun 21, 2018

Choose a reason for hiding this comment

cornelius commented Jun 21, 2018

Ana06 left a comment

Choose a reason for hiding this comment

Ana06 Jun 25, 2018

Choose a reason for hiding this comment

Ana06 left a comment

Choose a reason for hiding this comment

cornelius commented Jul 2, 2018

cornelius commented Jul 11, 2018

matheussbernardo commented Jul 11, 2018

Ana06 left a comment

Choose a reason for hiding this comment

matheussbernardo commented Jun 4, 2018 •

edited

matheussbernardo commented Jun 5, 2018 •

edited