Bump to 1.32

Add thefuck-alias for outputting the alias command.

README.md

@@ -110,7 +110,13 @@ alias fuck='eval $(thefuck $(fc -ln -1))'
 alias FUCK='fuck'
 ```
 
-[On in your shell config (Bash, Zsh, Fish, Powershell).](https://github.com/nvbn/thefuck/wiki/Shell-aliases)
+Alternatively, you can redirect the output of `thefuck-alias`:
+
+```bash
+thefuck-alias >> ~/.bashrc
+```
+
+[Or in your shell config (Bash, Zsh, Fish, Powershell).](https://github.com/nvbn/thefuck/wiki/Shell-aliases)
 
 Changes will be available only in a new shell session.
 
@@ -143,7 +149,10 @@ using matched rule and run it. Rules enabled by default:
 * `rm_dir` – adds `-rf` when you trying to remove directory;
 * `ssh_known_hosts` – removes host from `known_hosts` on warning;
 * `sudo` – prepends `sudo` to previous command if it failed because of permissions;
-* `switch_layout` – switches command from your local layout to en.
+* `switch_layout` – switches command from your local layout to en;
+* `apt_get` – installs app from apt if it not installed;
+* `brew_install` – fixes formula name for `brew install`;
+* `composer_not_command` – fixes composer command name.
 
 Bundled, but not enabled by default:
 
@@ -156,6 +165,9 @@ For adding your own rule you should create `your-rule-name.py`
 in `~/.thefuck/rules`. Rule should contain two functions:
 `match(command: Command, settings: Settings) -> bool`
 and `get_new_command(command: Command, settings: Settings) -> str`.
+Also the rule can contain optional function
+`side_effect(command: Command, settings: Settings) -> None` and
+optional boolean `enabled_by_default`
 
 `Command` has three attributes: `script`, `stdout` and `stderr`.
 
@@ -171,6 +183,12 @@ def match(command, settings):
 
 def get_new_command(command, settings):
     return 'sudo {}'.format(command.script)
+    
+# Optional:
+enabled_by_default = True
+
+def side_effect(command, settings):
+    subprocess.call('chmod 777 .', shell=True)
 ```
 
 [More examples of rules](https://github.com/nvbn/thefuck/tree/master/thefuck/rules),
@@ -200,7 +218,7 @@ Or via environment variables:
 * `THEFUCK_REQUIRE_CONFIRMATION` – require confirmation before running new command, `true/false`;
 * `THEFUCK_WAIT_COMMAND` – max amount of time in seconds for getting previous command output;
 * `THEFUCK_NO_COLORS` – disable colored output, `true/false`.
- 
+
 For example:
 
 ```bash

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 
 
-VERSION = '1.31'
+VERSION = '1.32'
 
 
 setup(name='thefuck',
@@ -17,4 +17,4 @@ setup(name='thefuck',
       zip_safe=False,
       install_requires=['pathlib', 'psutil', 'colorama', 'six'],
       entry_points={'console_scripts': [
-          'thefuck = thefuck.main:main']})
+          'thefuck = thefuck.main:main', 'thefuck-alias = thefuck.main:alias']})

tests/rules/test_brew_unknown_command.py

@@ -10,7 +10,7 @@ def brew_unknown_cmd():
 
 
 @pytest.fixture
-def brew_unknown_cmd_instaa():
+def brew_unknown_cmd2():
     return '''Error: Unknown command: instaa'''
 
 
@@ -20,9 +20,9 @@ def test_match(brew_unknown_cmd):
         assert not match(Command('brew ' + command), None)
 
 
-def test_get_new_command(brew_unknown_cmd, brew_unknown_cmd_instaa):
-    assert get_new_command(Command('brew inst', stderr=brew_unknown_cmd), None)\
-        == 'brew list'
+def test_get_new_command(brew_unknown_cmd, brew_unknown_cmd2):
+    assert get_new_command(Command('brew inst', stderr=brew_unknown_cmd),
+                           None) == 'brew list'
 
-    assert get_new_command(Command('brew instaa', stderr=brew_unknown_cmd_instaa),
+    assert get_new_command(Command('brew instaa', stderr=brew_unknown_cmd2),
                            None) == 'brew install'

tests/rules/test_ssh_known_host.py

@@ -2,7 +2,7 @@ import os
 import pytest
 from mock import Mock
 from thefuck.rules.ssh_known_hosts import match, get_new_command,\
-    remove_offending_keys
+    side_effect
 from tests.utils import Command
 
 
@@ -53,18 +53,14 @@ def test_match(ssh_error):
     assert not match(Command('ssh'), None)
 
 
-def test_remove_offending_keys(ssh_error):
+def test_side_effect(ssh_error):
     errormsg, path, reset, known_hosts = ssh_error
     command = Command('ssh user@host', stderr=errormsg)
-    remove_offending_keys(command, None)
+    side_effect(command, None)
     expected = ['123.234.567.890 asdjkasjdakjsd\n', '111.222.333.444 qwepoiwqepoiss\n']
     assert known_hosts(path) == expected
 
 
 def test_get_new_command(ssh_error, monkeypatch):
     errormsg, _, _, _ = ssh_error
-
-    method = Mock()
-    monkeypatch.setattr('thefuck.rules.ssh_known_hosts.remove_offending_keys', method)
     assert get_new_command(Command('ssh user@host', stderr=errormsg), None) == 'ssh user@host'
-    assert method.call_count

tests/test_main.py

@@ -74,6 +74,15 @@ def test_run_rule(capsys):
         main.run_rule(Rule(get_new_command=lambda *_: 'new-command'),
                       None, None)
         assert capsys.readouterr() == ('new-command\n', '')
+        # With side effect:
+        side_effect = Mock()
+        settings = Mock()
+        command = Mock()
+        main.run_rule(Rule(get_new_command=lambda *_: 'new-command',
+                           side_effect=side_effect),
+                      command, settings)
+        assert capsys.readouterr() == ('new-command\n', '')
+        side_effect.assert_called_once_with(command, settings)
     with patch('thefuck.main.confirm', return_value=False):
         main.run_rule(Rule(get_new_command=lambda *_: 'new-command'),
                       None, None)
@@ -82,15 +91,25 @@ def test_run_rule(capsys):
 
 def test_confirm(capsys):
     # When confirmation not required:
-    assert main.confirm('command', Mock(require_confirmation=False))
+    assert main.confirm('command', None, Mock(require_confirmation=False))
     assert capsys.readouterr() == ('', 'command\n')
+    # With side effect and without confirmation:
+    assert main.confirm('command', Mock(), Mock(require_confirmation=False))
+    assert capsys.readouterr() == ('', 'command*\n')
     # When confirmation required and confirmed:
     with patch('thefuck.main.sys.stdin.read', return_value='\n'):
-        assert main.confirm('command', Mock(require_confirmation=True,
-                                            no_colors=True))
+        assert main.confirm(
+            'command', None, Mock(require_confirmation=True,
+                                  no_colors=True))
         assert capsys.readouterr() == ('', 'command [enter/ctrl+c]')
+        # With side effect:
+        assert main.confirm(
+            'command', Mock(), Mock(require_confirmation=True,
+                                    no_colors=True))
+        assert capsys.readouterr() == ('', 'command* [enter/ctrl+c]')
     # When confirmation required and ctrl+c:
     with patch('thefuck.main.sys.stdin.read', side_effect=KeyboardInterrupt):
-        assert not main.confirm('command', Mock(require_confirmation=True,
-                                                no_colors=True))
+        assert not main.confirm('command', None,
+                                Mock(require_confirmation=True,
+                                     no_colors=True))
         assert capsys.readouterr() == ('', 'command [enter/ctrl+c]Aborted\n')

tests/test_types.py

@@ -1,11 +1,12 @@
-from thefuck.types import Rule, RulesNamesList, Settings
+from thefuck.types import RulesNamesList, Settings
+from tests.utils import Rule
 
 
 def test_rules_names_list():
     assert RulesNamesList(['bash', 'lisp']) == ['bash', 'lisp']
     assert RulesNamesList(['bash', 'lisp']) == RulesNamesList(['bash', 'lisp'])
-    assert Rule('lisp', None, None, False) in RulesNamesList(['lisp'])
-    assert Rule('bash', None, None, False) not in RulesNamesList(['lisp'])
+    assert Rule('lisp') in RulesNamesList(['lisp'])
+    assert Rule('bash') not in RulesNamesList(['lisp'])
 
 
 def test_update_settings():

tests/utils.py

@@ -7,5 +7,7 @@ def Command(script='', stdout='', stderr=''):
 
 def Rule(name='', match=lambda *_: True,
          get_new_command=lambda *_: '',
-         enabled_by_default=True):
-    return types.Rule(name, match, get_new_command, enabled_by_default)
+         enabled_by_default=True,
+         side_effect=None):
+    return types.Rule(name, match, get_new_command,
+                      enabled_by_default, side_effect)

thefuck/logs.py

@@ -26,17 +26,20 @@ def rule_failed(rule, exc_info, settings):
     exception('Rule {}'.format(rule.name), exc_info, settings)
 
 
-def show_command(new_command, settings):
-    sys.stderr.write('{bold}{command}{reset}\n'.format(
+def show_command(new_command, side_effect, settings):
+    sys.stderr.write('{bold}{command}{side_effect}{reset}\n'.format(
         command=new_command,
+        side_effect='*' if side_effect else '',
         bold=color(colorama.Style.BRIGHT, settings),
         reset=color(colorama.Style.RESET_ALL, settings)))
 
 
-def confirm_command(new_command, settings):
+def confirm_command(new_command, side_effect, settings):
     sys.stderr.write(
-        '{bold}{command}{reset} [{green}enter{reset}/{red}ctrl+c{reset}]'.format(
+        '{bold}{command}{side_effect}{reset} '
+        '[{green}enter{reset}/{red}ctrl+c{reset}]'.format(
             command=new_command,
+            side_effect='*' if side_effect else '',
             bold=color(colorama.Style.BRIGHT, settings),
             green=color(colorama.Fore.GREEN, settings),
             red=color(colorama.Fore.RED, settings),

thefuck/main.py

@@ -24,7 +24,8 @@ def load_rule(rule):
     rule_module = load_source(rule.name[:-3], str(rule))
     return types.Rule(rule.name[:-3], rule_module.match,
                       rule_module.get_new_command,
-                      getattr(rule_module, 'enabled_by_default', True))
+                      getattr(rule_module, 'enabled_by_default', True),
+                      getattr(rule_module, 'side_effect', None))
 
 
 def get_rules(user_dir, settings):
@@ -85,13 +86,13 @@ def get_matched_rule(command, rules, settings):
             logs.rule_failed(rule, sys.exc_info(), settings)
 
 
-def confirm(new_command, settings):
+def confirm(new_command, side_effect, settings):
     """Returns `True` when running of new command confirmed."""
     if not settings.require_confirmation:
-        logs.show_command(new_command, settings)
+        logs.show_command(new_command, side_effect, settings)
         return True
 
-    logs.confirm_command(new_command, settings)
+    logs.confirm_command(new_command, side_effect, settings)
     try:
         sys.stdin.read(1)
         return True
@@ -103,7 +104,9 @@ def confirm(new_command, settings):
 def run_rule(rule, command, settings):
     """Runs command from rule for passed command."""
     new_command = rule.get_new_command(command, settings)
-    if confirm(new_command, settings):
+    if confirm(new_command, rule.side_effect, settings):
+        if rule.side_effect:
+            rule.side_effect(command, settings)
         print(new_command)
 
 
@@ -112,6 +115,10 @@ def is_second_run(command):
     return command.script.startswith('fuck')
 
 
+def alias():
+    print("\nalias fuck='eval $(thefuck $(fc -ln -1))'\n")
+
+
 def main():
     colorama.init()
     user_dir = setup_user_dir()

thefuck/rules/brew_unknown_command.py

@@ -1,11 +1,77 @@
 import difflib
+import os
 import re
+import subprocess
 import thefuck.logs
 
-# This commands are based on Homebrew 0.9.5
-brew_commands = ['info', 'home', 'options', 'install', 'uninstall', 'search',
-                 'list', 'update', 'upgrade', 'pin', 'unpin', 'doctor',
-                 'create', 'edit']
+BREW_CMD_PATH = '/Library/Homebrew/cmd'
+TAP_PATH = '/Library/Taps'
+TAP_CMD_PATH = '/%s/%s/cmd'
+
+
+def _get_brew_path_prefix():
+    '''To get brew path'''
+    try:
+        return subprocess.check_output(['brew', '--prefix']).strip()
+    except:
+        return None
+
+
+def _get_brew_commands(brew_path_prefix):
+    '''To get brew default commands on local environment'''
+    brew_cmd_path = brew_path_prefix + BREW_CMD_PATH
+
+    commands = (name.replace('.rb', '') for name in os.listdir(brew_cmd_path)
+                if name.endswith('.rb'))
+
+    return commands
+
+
+def _get_brew_tap_specific_commands(brew_path_prefix):
+    '''To get tap's specific commands
+    https://github.com/Homebrew/homebrew/blob/master/Library/brew.rb#L115'''
+    commands = []
+    brew_taps_path = brew_path_prefix + TAP_PATH
+
+    for user in _get_directory_names_only(brew_taps_path):
+        taps = _get_directory_names_only(brew_taps_path + '/%s' % user)
+
+        # Brew Taps's naming rule
+        # https://github.com/Homebrew/homebrew/blob/master/share/doc/homebrew/brew-tap.md#naming-conventions-and-limitations
+        taps = (tap for tap in taps if tap.startswith('homebrew-'))
+        for tap in taps:
+            tap_cmd_path = brew_taps_path + TAP_CMD_PATH % (user, tap)
+
+            if os.path.isdir(tap_cmd_path):
+                commands += (name.replace('brew-', '').replace('.rb', '')
+                             for name in os.listdir(tap_cmd_path)
+                             if _is_brew_tap_cmd_naming(name))
+
+    return commands
+
+
+def _is_brew_tap_cmd_naming(name):
+    if name.startswith('brew-') and name.endswith('.rb'):
+        return True
+
+    return False
+
+
+def _get_directory_names_only(path):
+    return [d for d in os.listdir(path)
+            if os.path.isdir(os.path.join(path, d))]
+
+brew_commands = []
+brew_path_prefix = _get_brew_path_prefix()
+
+if brew_path_prefix:
+    brew_commands += _get_brew_commands(brew_path_prefix)
+    brew_commands += _get_brew_tap_specific_commands(brew_path_prefix)
+else:
+    # Failback commands for testing (Based on Homebrew 0.9.5)
+    brew_commands = ['info', 'home', 'options', 'install', 'uninstall',
+                     'search', 'list', 'update', 'upgrade', 'pin', 'unpin',
+                     'doctor', 'create', 'edit']
 
 
 def _get_similar_commands(command):

thefuck/rules/ssh_known_hosts.py

@@ -22,7 +22,11 @@ def match(command, settings):
     return True
 
 
-def remove_offending_keys(command, settings):
+def get_new_command(command, settings):
+    return command.script
+
+
+def side_effect(command, settings):
     offending = offending_pattern.findall(command.stderr)
     for filepath, lineno in offending:
         with open(filepath, 'r') as fh:
@@ -30,8 +34,3 @@ def remove_offending_keys(command, settings):
             del lines[int(lineno) - 1]
         with open(filepath, 'w') as fh:
             fh.writelines(lines)
-
-
-def get_new_command(command, settings):
-    remove_offending_keys(command, settings)
-    return command.script

thefuck/rules/sudo.py

@@ -8,7 +8,10 @@ patterns = ['permission denied',
             'This command has to be run under the root user.',
             'This operation requires root.',
             'You need to be root to perform this command.',
-            'requested operation requires superuser privilege']
+            'requested operation requires superuser privilege',
+            'must be run as root',
+            'must be superuser',
+            'Need to be root']
 
 
 def match(command, settings):

thefuck/types.py

@@ -4,11 +4,11 @@ from collections import namedtuple
 Command = namedtuple('Command', ('script', 'stdout', 'stderr'))
 
 Rule = namedtuple('Rule', ('name', 'match', 'get_new_command',
-                           'enabled_by_default'))
+                           'enabled_by_default', 'side_effect'))
 
 
 class RulesNamesList(list):
-    """Wrapper a top of list for string rules names."""
+    """Wrapper a top of list for storing rules names."""
 
     def __contains__(self, item):
         return super(RulesNamesList, self).__contains__(item.name)