tailor 0.1.5 → 1.0.0.alpha

data/features/configurable.feature

@@ -0,0 +1,78 @@
+@wip
+Feature: Configurable
+  As a Ruby developer
+  I want to be able to configure tailor to my style likings
+  So that tailor only detects the problems that I care about.
+
+  Scenario: No config file exists
+    Given a file named ".tailorrc" should not exist
+    When I successfully run `tailor --show-config`
+    Then the output should contain:
+      """
+      +---------------------------+------------------+
+      |                Configuration                 |
+      +---------------------------+------------------+
+      |    Indentation                               |
+      +---------------------------+------------------+
+      |    spaces                 |    2             |
+      |    allow_hard_tabs        |    false         |
+      |    continuation_spaces    |    2             |
+      +---------------------------+------------------+
+      |    Vertical whitespace                       |
+      +---------------------------+------------------+
+      |    trailing_newlines      |    1             |
+      +---------------------------+------------------+
+      """
+    And the exit status should be 0
+
+  Scenario: Configuration file at ~/.tailorrc is valid YAML
+    Given a file named ".tailorrc" with:
+      """
+      ---
+      :indentation:
+        :spaces: 5
+      :vertical_whitespace:
+        :trailing_newlines: 11
+      """
+    When I successfully run `tailor --show-config`
+    Then the output should contain:
+      """
+      +-------------------------+------------------+
+      |               Configuration                |
+      +-------------------------+------------------+
+      |    Indentation                             |
+      +-------------------------+------------------+
+      |    spaces               |    5             |
+      +-------------------------+------------------+
+      |    Vertical whitespace                     |
+      +-------------------------+------------------+
+      |    trailing_newlines    |    11            |
+      +-------------------------+------------------+
+      """
+
+  Scenario: Pass in configuration file at runtime
+    Given a file named "some_config.yml" with:
+      """
+      ---
+      :indentation:
+        :spaces: 7
+      :vertical_whitespace:
+        :trailing_newlines: 13
+      """
+    When I successfully run `tailor --config some_config.yml`
+    Then the output should contain:
+      """
+      +-------------------------+------------------+
+      |               Configuration                |
+      +-------------------------+------------------+
+      |    Indentation                             |
+      +-------------------------+------------------+
+      |    spaces               |    7             |
+      +-------------------------+------------------+
+      |    Vertical whitespace                     |
+      +-------------------------+------------------+
+      |    trailing_newlines    |    13            |
+      +-------------------------+------------------+
+      """
+
+

data/features/horizontal_spacing.feature

@@ -0,0 +1,262 @@
+Feature: Horizontal spacing detection
+  As a Ruby developer, I want to be able to detect horizontal spacing
+  problems so that I can fix them.
+
+  Background:
+    Given my configuration file ".tailor" looks like:
+    """
+    Tailor.config do |config|
+      config.file_set do
+        trailing_newlines 0
+      end
+    end
+    """
+
+  @bad_files @hard_tabs
+
+  Scenario Outline: Detect hard tabs
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*<Count>/
+    And the output should match /position:  <Position>/
+    And the output should match /position:  <Position 2>/
+    And the exit status should be 1
+
+  Scenarios: Hard tab
+    | File                                        | Position | Position 2 | Count |
+    | h_spacing/1/hard_tab                        | 2:0      |            | 1     |
+    | h_spacing/1/hard_tab_with_spaces            | 3:0      |            | 1     |
+    | h_spacing/1/hard_tab_with_1_indented_space  | 3:0      |            | 1     |
+    | h_spacing/2/hard_tab_with_2_indented_spaces | 3:0      | 3:5        | 2     |
+
+  @bad_files @long_lines
+
+  Scenario Outline: Detect long lines
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*<Count>/
+    And the output should match /position:  <Position>/
+    And the exit status should be 1
+
+  Scenarios:
+    | File                                | Position | Count |
+    | h_spacing/1/long_line_no_newline    | 1:81     | 1     |
+    | h_spacing/1/long_line_newline_at_82 | 1:81     | 1     |
+
+  @good_files @long_lines
+
+  Scenario Outline: Lines under long-line threshold
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*0/
+    And the exit status should be 0
+
+  Scenarios:
+    | File                                  |
+    | h_spacing/ok/short_line_no_newline    |
+    | h_spacing/ok/short_line_newline_at_81 |
+
+  @bad_files @trailing_spaces
+
+  Scenario Outline: Lines with trailing spaces
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*<Count>/
+    And the output should match /position:  <Position>/
+    And the exit status should be 1
+
+  Scenarios:
+    | File                                         | Count | Position |
+    | h_spacing/1/empty_line_with_spaces           | 1     | 1:2      |
+    | h_spacing/1/empty_line_with_spaces_in_method | 1     | 2:2      |
+    | h_spacing/1/trailing_spaces_on_def           | 1     | 1:10     |
+
+  @bad_files @commas
+
+  Scenario Outline: Lines with bad comma spacing
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*<Count>/
+    And the output should match /position:  <Position>/
+    And the output should match /position:  <Position 2>/
+    And the exit status should be 1
+
+  Scenarios:
+    | File                                             | Count | Position | Position 2 |
+    | h_spacing/1/no_space_after_comma                 | 1     | 1:3      |            |
+    | h_spacing/1/two_spaces_after_comma               | 1     | 1:3      |            |
+    | h_spacing/2/two_spaces_after_comma_twice         | 2     | 1:3      | 1:7        |
+    | h_spacing/1/one_space_before_comma               | 1     | 1:4      |            |
+    | h_spacing/1/two_spaces_before_comma              | 1     | 1:3      |            |
+    | h_spacing/2/two_spaces_before_comma_twice        | 2     | 1:3      | 1:8        |
+    | h_spacing/2/spaces_before_with_trailing_comments | 2     | 2:3      | 3:3        |
+
+  @good_files @commas
+
+  Scenario Outline: Lines with good comma spacing
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*0/
+    And the exit status should be 0
+
+  Scenarios:
+    | File                                              |
+    | h_spacing/ok/space_after_comma_in_array           |
+    | h_spacing/ok/trailing_comma                       |
+    | h_spacing/ok/trailing_comma_with_trailing_comment |
+
+  @good_files @braces
+
+  Scenario Outline: Lines with good spacing around braces
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*0/
+    And the exit status should be 0
+
+  @single_line
+  Scenarios: Single-line
+    | File                                            |
+    | h_spacing/ok/empty_hash                         |
+    | h_spacing/ok/single_line_hash                   |
+    | h_spacing/ok/single_line_hash_lonely_braces     |
+    | h_spacing/ok/single_line_block                  |
+    | h_spacing/ok/single_line_string_interp          |
+    | h_spacing/ok/single_line_block_in_string_interp |
+    | h_spacing/ok/empty_hash_in_string_in_block      |
+    | h_spacing/ok/string_interp_with_colonop         |
+    | h_spacing/ok/hash_as_param_in_parens            |
+
+  @multi_line
+  Scenarios: Multi-line
+    | File                                                 |
+    | h_spacing/ok/two_line_hash                           |
+    | h_spacing/ok/two_line_hash_trailing_comment          |
+    | h_spacing/ok/three_line_hash                         |
+    | h_spacing/ok/multi_line_braces_block                 |
+    | h_spacing/ok/multi_line_qword_using_braces           |
+    | h_spacing/ok/empty_hash_in_multi_line_statement      |
+    | h_spacing/ok/multi_line_hash_in_multi_line_statement |
+
+  @bad_files @braces
+
+  Scenario Outline: Lines with bad spacing around braces
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*<Problems>/
+    And the output should match /position:  <Position>/
+    And the output should match /position:  <Position 2>/
+    And the exit status should be 1
+
+  @single_line
+  Scenarios: Single-line
+    | File                                                                  | Position | Position 2 | Problems |
+    | h_spacing/1/single_line_hash_2_spaces_before_lbrace                   | 1:9      |            | 1        |
+    | h_spacing/1/single_line_hash_2_spaces_before_rbrace                   | 1:25     |            | 1        |
+    | h_spacing/1/single_line_hash_2_spaces_after_lbrace                    | 1:9      |            | 1        |
+    | h_spacing/1/single_line_hash_0_spaces_before_lbrace                   | 1:7      |            | 1        |
+    | h_spacing/1/single_line_block_2_spaces_before_lbrace                  | 1:13     |            | 1        |
+    | h_spacing/1/single_line_block_in_string_interp_2_spaces_before_lbrace | 1:27     |            | 1        |
+    | h_spacing/1/single_line_block_0_spaces_before_lbrace                  | 1:11     |            | 1        |
+    | h_spacing/1/space_in_empty_hash_in_string_in_block                    | 1:36     |            | 1        |
+    | h_spacing/2/no_space_after_l_before_r_after_string_interp             | 1:69     | 1:86       | 2        |
+    | h_spacing/2/no_space_before_consecutive_rbraces                       | 1:72     | 1:73       | 2        |
+
+  @multi_line
+  Scenarios: Multi-line
+    | File                                                                      | Position | Position 2 | Problems |
+    | h_spacing/1/two_line_hash_2_spaces_before_lbrace                          | 2:12     |            | 1        |
+    | h_spacing/1/two_line_hash_2_spaces_before_rbrace                          | 2:28     |            | 1        |
+    | h_spacing/1/two_line_hash_2_spaces_before_lbrace_lonely_braces            | 2:12     |            | 1        |
+    | h_spacing/1/two_line_braces_block_2_spaces_before_lbrace                  | 1:13     |            | 1        |
+    | h_spacing/1/two_line_braces_block_0_spaces_before_lbrace_trailing_comment | 1:11     |            | 1        |
+
+  @good_files @brackets
+
+  Scenario Outline: Lines with good spacing around brackets
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*0/
+    And the exit status should be 0
+
+  @single_line
+  Scenarios: Single-line
+    | File                            |
+    | h_spacing/ok/empty_array        |
+    | h_spacing/ok/simple_array       |
+    | h_spacing/ok/two_d_array        |
+    | h_spacing/ok/hash_key_reference |
+    | h_spacing/ok/array_of_hashes    |
+    | h_spacing/ok/array_of_symbols   |
+
+  @multi_line
+  Scenarios: Multi-line
+    | File                                             |
+    | h_spacing/ok/simple_array_lonely_brackets        |
+    | h_spacing/ok/simple_nested_array_lonely_brackets |
+    | h_spacing/ok/empty_array_in_multi_line_statement |
+
+  @bad_files @brackets
+
+  Scenario Outline: Lines with bad spacing around brackets
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*<Problems>/
+    And the output should match /position:  <Position>/
+    And the output should match /position:  <Position 2>/
+    And the exit status should be 1
+
+  @single_line
+  Scenarios: Single-line
+    | File                                           | Position | Position 2 | Problems |
+    | h_spacing/1/space_in_empty_array               | 1:1      |            | 1        |
+    | h_spacing/1/simple_array_space_after_lbracket  | 1:1      |            | 1        |
+    | h_spacing/1/simple_array_space_before_rbracket | 1:9      |            | 1        |
+    | h_spacing/1/hash_key_ref_space_before_rbracket | 1:11     |            | 1        |
+    | h_spacing/1/hash_key_ref_space_after_lbracket  | 1:6      |            | 1        |
+    | h_spacing/2/two_d_array_space_after_lbrackets  | 1:1      | 1:14       | 2        |
+    | h_spacing/2/two_d_array_space_before_rbrackets | 1:10     | 1:30       | 2        |
+
+  @good_files @parens
+
+  Scenario Outline: Lines with good spacing around parens
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*0/
+    And the exit status should be 0
+
+  @single_line
+  Scenarios: Single-line
+    | File                            |
+    | h_spacing/ok/empty_parens       |
+    | h_spacing/ok/simple_method_call |
+
+  @multi_line
+  Scenarios: Multi-line
+    | File                                              |
+    | h_spacing/ok/multi_line_method_call               |
+    | h_spacing/ok/multi_line_method_call_lonely_parens |
+
+  @bad_files @parens
+
+  Scenario Outline: Lines with bad spacing around parens
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*<Problems>/
+    And the output should match /position:  <Position>/
+    And the output should match /position:  <Position 2>/
+    And the exit status should be 1
+
+  @single_line
+  Scenarios: Single-line
+    | File                                                                      | Position | Position 2 | Problems |
+    | h_spacing/1/simple_method_call_space_after_lparen                         | 1:6      |            | 1        |
+    | h_spacing/1/simple_method_call_space_before_rparen                        | 1:15     |            | 1        |
+    | h_spacing/1/method_call_space_after_lparen_trailing_comment               | 1:6      |            | 1        |
+    | h_spacing/2/method_call_space_after_lparen_before_rparen_trailing_comment | 1:6      | 1:16       | 2        |
+
+  @multi_line
+  Scenarios: Multi-line
+    | File                                                                   | Position | Position 2 | Problems |
+    | h_spacing/1/multi_line_method_call_space_after_lparen                  | 1:6      |            | 1        |
+    | h_spacing/1/multi_line_method_call_space_after_lparen_trailing_comment | 1:6      |            | 1        |
+

data/features/indentation.feature

@@ -1,22 +1,18 @@
-Feature: Indentation
+@wip
+Feature: Indentation check
+  As a Ruby developer
+  I want to check the indentation of my Ruby code
+  So that I follow Ruby indentation conventions.
 
-  Scenario: A single file project with every in/outdent expression, indented properly
-    Given I have a project directory "1_long_file_with_indentation"
-      And I have 1 file in my project
-      And that file is indented properly
-    When I run the checker on the project
-    Then the checker should tell me my indentation is OK
-
-  Scenario: A single file that's indented properly
-    Given I have a project directory "1_good_simple_file"
-      And I have 1 file in my project
-      And the indentation of that file starts at level 0
-      And the line 1 is a "class" statement
-      And the line 2 is a "def" statement
-    When I run the checker on the project
-    Then the level of line 1 should be 0.0
-      And the level of line 2 should be 1.0
-      And the level of line 3 should be 2.0
-      And the level of line 4 should be 1.0
-      And the level of line 5 should be 0.0
-    
+  Scenario: No indentation problems with this project
+    Given my configuration file ".tailor" looks like:
+    """
+    Tailor.config do |config|
+      config.file_set do
+        trailing_newlines 0
+      end
+    end
+    """
+    When I successfully run `tailor -d -c .tailor ../../lib`
+    Then the output should contain "problem count: 0"
+    And the exit status should be 0

data/features/indentation/bad_files_with_no_trailing_newline.feature

@@ -0,0 +1,90 @@
+@indentation
+Feature: Indentation check on bad fails without trailing newlines
+
+  Background:
+    Given my configuration file ".tailor" looks like:
+    """
+    Tailor.config do |config|
+      config.file_set do
+        trailing_newlines 0
+      end
+    end
+    """
+
+  @bad_files
+  Scenario Outline: Detect singular problems on poorly indented files
+    Given <File> exists without a newline at the end
+    When I run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*1/
+    And the output should match /position:  <Position>/
+    And the exit status should be 1
+
+  @multi_line
+  Scenarios: 1 problem with classes
+    | File                                           | Position |
+    | indent/1/class_indented_end                    | 2:1      |
+    | indent/1/class_method_def_using_self_outdented | 2:1      |
+
+
+  @multi_line
+  Scenarios: 1 problem with single-line statement
+    | File                                                     | Position |
+    | indent/1/class_indented_singlestatement                  | 2:3      |
+    | indent/1/class_indented_singlestatement_trailing_comment | 2:3      |
+    | indent/1/class_outdented_singlestatement                 | 2:1      |
+    | indent/1/class_def_outdented_content                     | 3:3      |
+
+  @multi_line
+  Scenarios: 1 problem with def
+    | File                                     | Position |
+    | indent/1/def_indented_end                | 2:1      |
+    | indent/1/def_content_indented_end        | 3:1      |
+    | indent/1/class_def_content_outdented_end | 4:1      |
+
+  @multi_line
+  Scenarios: 1 problem with case
+    | File                                                | Position |
+    | indent/1/case_indented_whens_level                  | 2:3      |
+    | indent/1/case_indented_whens_level_trailing_comment | 2:3      |
+    | indent/1/case_outdented_whens_level                 | 2:1      |
+    | indent/1/case_when_indented_whens_level             | 3:3      |
+    | indent/1/case_when_outdented_whens_level            | 3:1      |
+    | indent/1/case_indented_whens_in                     | 2:3      |
+
+  @multi_line
+  Scenarios: 1 problem with 'do' loop
+    | File                                         | Position |
+    | indent/1/while_do_indented                   | 1:1      |
+    | indent/1/while_do_indented2                  | 4:1      |
+    | indent/1/while_do_indented2_trailing_comment | 4:1      |
+    | indent/1/while_do_outdented                  | 2:1      |
+    | indent/1/while_do_content_indented           | 3:5      |
+    | indent/1/while_do_content_outdented          | 3:3      |
+    | indent/1/until_do_indented                   | 4:1      |
+    | indent/1/for_do_indented                     | 1:1      |
+    | indent/1/loop_do_indented                    | 1:1      |
+
+  @multi_line
+  Scenarios: 1 problem with multi-line string
+    | File                                                            | Position |
+    | indent/1/multi_line_string_first_line_indented                  | 2:3      |
+    | indent/1/multi_line_string_first_line_indented_trailing_comment | 2:3      |
+
+  @multi_line
+  Scenarios: 1 problem with multi-line operator use
+    | File                                                           | Position |
+    | indent/1/multi_line_andop_first_line_indented                  | 2:3      |
+    | indent/1/multi_line_andop_first_line_indented_trailing_comment | 2:3      |
+    | indent/1/multi_line_andop_second_line_indented                 | 3:5      |
+    | indent/1/multi_line_string_concat_with_plus_out                | 2:1      |
+
+  @multi_line
+  Scenarios: 1 problem with multi-line method ending with period
+    | File                                                                            | Position |
+    | indent/1/multi_line_method_call_end_in                                          | 5:3      |
+    | indent/1/multi_line_method_call_ends_with_period_2nd_line_in                    | 4:5      |
+    | indent/1/multi_line_method_call_ends_with_many_periods_last_in                  | 3:4      |
+    | indent/1/multi_line_method_call_ends_with_many_periods_last_in_trailing_comment | 3:4      |
+
+
+