tailor 0.1.5 → 1.0.0.alpha

data/features/indentation/good_files_with_no_trailing_newline.feature

@@ -0,0 +1,206 @@
+@indentation
+Feature: Indentation check on good files without trailing newlines
+
+  Background:
+    Given my configuration file ".tailor" looks like:
+    """
+    Tailor.config do |config|
+      config.file_set do
+        trailing_newlines 0
+      end
+    end
+    """
+
+  @good_files
+  Scenario Outline: Don't detect problems on properly indented files with no newlines at the end
+    Given <File> exists without a newline at the end
+    When I successfully run `tailor -d -c .tailor <File>`
+    Then the output should match /Total Problems.*0/
+    And the exit status should be 0
+
+  Scenarios: Good class uses
+    | File                                         |
+    | indent/ok/class                              |
+    | indent/ok/nested_class                       |
+    | indent/ok/class_empty                        |
+    | indent/ok/class_empty_trailing_comment       |
+    | indent/ok/one_line_class                     |
+    | indent/ok/one_line_subclass                  |
+    | indent/ok/one_line_subclass_with_inheritance |
+
+  Scenarios: Good single-line statement uses
+    | File                                    |
+    | indent/ok/class_singlestatement         |
+    | indent/ok/require_class_singlestatement |
+
+  @multi_line
+  Scenarios: Good multi-line statement uses
+    | File                                                               |
+    | indent/ok/assignment_addition_multistatement                       |
+    | indent/ok/assignment_addition_multistatement_trailing_comment      |
+    | indent/ok/assignment_hash_multistatement                           |
+    | indent/ok/assignment_hash_multistatement_trailing_comment          |
+    | indent/ok/assignment_array_multistatement                          |
+    | indent/ok/assignment_array_multistatement_trailing_comment         |
+    | indent/ok/assignment_paren_multistatement                          |
+    | indent/ok/assignment_paren_multistatement_trailing_comment         |
+    | indent/ok/assignment_twolevel_hash_multistatement                  |
+    | indent/ok/assignment_twolevel_array_multistatement                 |
+    | indent/ok/assignment_twolevel_paren_multistatement                 |
+    | indent/ok/method_call_multistatement                               |
+    | indent/ok/method_call_multistatement_trailing_comment              |
+    | indent/ok/method_call_multistatement_lonely_paren                  |
+    | indent/ok/method_call_multistatement_lonely_paren_trailing_comment |
+    | indent/ok/rescue_ending_with_comma                                 |
+    | indent/ok/rescue_ending_with_comma_trailing_comment                |
+    | indent/ok/keyword_ending_with_period                               |
+    | indent/ok/keyword_ending_with_period_trailing_comment              |
+
+  Scenarios: Good def uses
+    | File                                                |
+    | indent/ok/def                                       |
+    | indent/ok/def_empty                                 |
+    | indent/ok/nested_def                                |
+    | indent/ok/require_class_singlestatement_def         |
+    | indent/ok/require_class_singlestatement_def_content |
+
+  @single_line
+  Scenarios: Good single-line modifiers
+    | File                                     |
+    | indent/ok/if_modifier                    |
+    | indent/ok/if_modifier2                   |
+    | indent/ok/def_return_if_modifier         |
+    | indent/ok/unless_modifier                |
+    | indent/ok/def_return_unless_modifier     |
+    | indent/ok/while_within_single_line_block |
+
+  @multi_line
+  Scenarios: Good multi-line modifiers
+    | File                                        |
+    | indent/ok/multi_line_if_with_trailing_andop |
+
+  @case
+  Scenarios: Good case statements
+    | File                              |
+    | indent/ok/case_whens_level        |
+    | indent/ok/case_strings_in_strings |
+
+  Scenarios: Good 'do' loops
+    | File                     |
+    | indent/ok/while_do_loop  |
+    | indent/ok/while_do_loop2 |
+    | indent/ok/until_do_loop  |
+    | indent/ok/until_do_loop2 |
+    | indent/ok/for_do_loop    |
+    | indent/ok/loop_do_loop   |
+
+  Scenarios: Good non-'do' loops
+    | File                             |
+    | indent/ok/while_as_modifier_loop |
+    | indent/ok/until_as_modifier_loop |
+    | indent/ok/for_with_break_loop    |
+    | indent/ok/for_with_next_loop     |
+    | indent/ok/for_with_redo_loop     |
+    | indent/ok/for_with_retry_loop    |
+    | indent/ok/loop_with_braces       |
+
+  @single_line @braces
+  Scenarios: Good single-line brace uses
+    | File                                     |
+    | indent/ok/single_line_braces             |
+    | indent/ok/single_line_braces_as_t_string |
+
+  @multi_line @braces
+  Scenarios: Good multi-line brace uses
+    | File                                           |
+    | indent/ok/multi_line_braces                    |
+    | indent/ok/multi_line_braces_as_t_string        |
+    | indent/ok/multi_line_lonely_braces             |
+    | indent/ok/multi_line_lonely_braces_as_t_string |
+    | indent/ok/multi_line_braces_embedded_arrays    |
+    | indent/ok/braces_combo                         |
+
+  @single_line @brackets
+  Scenarios: Good single-line bracket uses
+    | File                                       |
+    | indent/ok/single_line_brackets             |
+    | indent/ok/single_line_brackets_as_t_string |
+
+  @multi_line @brackets
+  Scenarios: Good multi-line bracket uses
+    | File                                             |
+    | indent/ok/multi_line_brackets                    |
+    | indent/ok/multi_line_brackets_as_t_string        |
+    | indent/ok/multi_line_lonely_brackets             |
+    | indent/ok/multi_line_lonely_brackets_as_t_string |
+    | indent/ok/multi_line_brackets_embedded_hashes    |
+    | indent/ok/brackets_combo                         |
+
+  @single_line @parens
+  Scenarios: Good single-line paren uses
+    | File                                     |
+    | indent/ok/single_line_parens             |
+    | indent/ok/single_line_parens_as_t_string |
+
+  @multi_line @parens
+  Scenarios: Good multi-line paren uses
+    | File                                           |
+    | indent/ok/multi_line_parens                    |
+    | indent/ok/multi_line_parens_as_t_string        |
+    | indent/ok/multi_line_lonely_parens             |
+    | indent/ok/multi_line_lonely_parens_with_commas |
+    | indent/ok/multi_line_lonely_parens_as_t_string |
+    | indent/ok/parens_combo                         |
+
+  @multi_line @ops
+  Scenarios: Good multi-line operator uses
+    | File                                                   |
+    | indent/ok/multi_line_ops                               |
+    | indent/ok/multi_line_andop_in_method                   |
+    | indent/ok/multi_line_rshift_in_method                  |
+    | indent/ok/multi_line_string_concat_with_plus           |
+    | indent/ok/multi_line_string_concat_with_plus_in_parens |
+    | indent/ok/multi_line_string_concat_twice               |
+
+  @multi_line
+  Scenarios: Good multi-line method calls
+    | File                                                    |
+    | indent/ok/multi_line_method_call                        |
+    | indent/ok/multi_line_method_call_ends_with_period       |
+    | indent/ok/multi_line_method_call_ends_with_many_periods |
+
+  @multi_line @ops
+  Scenarios: Good multi-line if + logical operators
+    | File                                |
+    | indent/ok/multi_line_if_logical_and |
+
+  @multi_line @blocks
+  Scenarios: Good multi-line blocks
+    | File                                               |
+    | indent/ok/multi_line_each_block                    |
+    | indent/ok/multi_line_each_block_with_op_and_parens |
+    | indent/ok/do_end_block_in_parens                   |
+
+  @single_line @keywords
+  Scenarios: Good use of single-line keyword statements
+    | File                                   |
+    | indent/ok/single_line_begin_rescue_end |
+
+  @multi_line @combos
+  Scenarios: Good combinations of many things
+    | File                                 |
+    | indent/ok/combo1                     |
+    | indent/ok/combo2                     |
+    | indent/ok/combo3                     |
+    | indent/ok/brace_bracket_paren_combo1 |
+    | indent/ok/paren_comma_combo1         |
+
+  @wip
+  Scenarios: WIPs
+    | File                                  |
+    | indent/ok/case_whens_in               |
+    | indent/ok/method_closing_lonely_paren |
+    | indent/ok/method_lonely_args          |
+    | indent/ok/line_ends_with_label        |
+    | indent/ok/rparen_and_do_same_line     |
+

data/features/name_detection.feature

@@ -0,0 +1,72 @@
+Feature: Name detection
+  As a Ruby developer, I want to be able to detect improper class and method
+  names 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
+    """
+
+  @method_naming @good_files
+  Scenario Outline: Method naming
+    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: Good method naming
+    | File                         |
+    | naming/ok/single_word_method |
+    | naming/ok/two_word_method    |
+
+  @method_naming @bad_files
+
+  Scenario Outline: Bad method naming
+    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: Bad method naming
+    | File                                                 | Count | Position |
+    | naming/1/one_caps_camel_case_method                  | 1     | 1:4      |
+    | naming/1/one_caps_camel_case_method_trailing_comment | 1     | 1:4      |
+
+  @class_naming @good_files
+
+  Scenario Outline: Good class naming
+    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: Good class/module naming
+    | File                         |
+    | naming/ok/single_word_class  |
+    | naming/ok/single_word_module |
+    | naming/ok/two_word_class     |
+    | naming/ok/two_word_module    |
+
+  @class_naming @bad_files
+
+  Scenario Outline: Bad class/module naming
+    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: Bad method naming
+    | File                                      | Count | Position |
+    | naming/1/one_screaming_snake_case_class   | 1     | 1:6      |
+    | naming/1/one_screaming_snake_module_class | 1     | 1:7      |
+    | naming/1/two_screaming_snake_case_class   | 1     | 1:6      |
+    | naming/1/two_screaming_snake_module_class | 1     | 1:7      |
+    
+

data/features/step_definitions/indentation_steps.rb

@@ -1,139 +1,16 @@
-require 'tailor/indentation'
-require 'tailor/file_line'
+Given /^(.+) exists with(\w*) a newline at the end$/ do |file_name, no_newline|
+  file_contents = get_file_contents(file_name)
+  file_contents.should_not be_nil
 
-Given /^that file is indented properly$/ do
-  pending
-  current_line = 1
-  
-  file_path = Pathname.new(File.expand_path(@file_list[0]))
-
-  current_level = 0.0
-  problem_count = 0
-  next_proper_level = 0.0
-
-  check_file do |line|
-    line = Tailor::FileLine.new(line, file_path, current_line)
-
-    puts '----'
-    puts "line = #{current_line}"
-    puts "current = #{current_level}"
-    actual_level = line.is_at_level
-    puts "actual = #{actual_level}"
-    should_be_at = line.should_be_at_level(current_level)
-    puts "should = #{should_be_at}"
-
-    problem_count += 1 if line.at_proper_level?(actual_level, should_be_at)
-    next_proper_level = line.next_line_should_be_at_level current_level
-    puts "next proper = #{next_proper_level}"
-    current_level = next_proper_level
-
-    current_line += 1
-  end
-end
-
-Given /^the indentation of that file starts at level (\d*)$/ do |level|
-  current_line = 1
-  result = nil
-  
-  file_path = Pathname.new(File.expand_path(@file_list[0]))
-
-  check_file do |line|
-    line = FileLine.new(line, file_path, current_line)
-    result = line.is_at_level
-    break line
-  end
-
-  result.should == 0
-end
-
-Given /^the line (\d*) is a "([^\"]*)" statement$/ do |line_num, statement_type|
-  current_line = 1
-  result = nil
-
-  check_file do |line|
-    result = line.strip =~ /^#{statement_type}/
-    current_line == line_num.to_i ? (break line) : current_line += 1
-  end
-  result.should_not be_nil 
-end
-
-Then "the checker should tell me my indentation is OK" do
-  pending
-end
-
-=begin
-Then /^the level of line 1 should be 0.0$/ do
-  file_path = Pathname.new(File.expand_path(@file_list[0]))
-  @current_level = nil
-
-  check_file do |line|
-    line = FileLine.new(line, file_path, 1)
-
-    @current_level = line.is_at_level
-    @level_change = @current_level + line.next_line_level_change
-    break line
+  if no_newline.empty?
+    file_contents << "\n" unless file_contents[-1] == "\n"
+  else
+    file_contents[-1] = '' if file_contents[-1] == "\n"
   end
-  @current_level.should.eql? 0.0
-end
-=end
-
-
-Then /^the level of line (\d*) should be (\d+\.\d+)$/ do |line_num_to_check, level_to_check|
-  file_path = Pathname.new(File.expand_path(@file_list[0]))
-  current_line_num = 1
-  next_proper_level = 0.0
-  current_proper_level = 0.0
- 
-  check_file do |line|
-    line = FileLine.new(line, file_path, current_line_num)
 
-    if current_line_num == line_num_to_check
-      line.is_at_level.should == level_to_check.to_f
-    
-      # Determine what the next line's level should be at, based on the current line's
-      # level.
-      next_proper_level = current_proper_level + line.indent_next_line_by
-    end
-
-    current_line_num += 1
-  end
+  write_file(file_name, file_contents)
 end
 
-=begin
-Then /^the level of line (\d*) should be (\d+\.\d+)$/ do |line_num_to_check, level_to_check|
-  file_path = Pathname.new(File.expand_path(@file_list[0]))
-  current_line = 1
-  actual_level = nil
-  current_level = 0.0   # new
-  level_change = nil    # new
-
-  check_file do |line|
-    line = FileLine.new(line, file_path, current_line)
-
-    # If the first line of the file, 
-    if current_line == 1    # new
-      level_change = current_level + line.next_line_level_change  #new
-      break line    #new
-    else  # new
-      actual_level = line.is_at_level
-    end  # new
-
-    # Only check the line specified; skip if it's the first line.
-    if (current_line == line_num_to_check) and (line_num_to_check > 1)
-      this_level = current_level + level_change   # new
-      this_level < 0.0 ? (this_level = 0.0) : this_level  # new
-      this_level.should == level_to_check    # new
-      actual_level.should == this_level
-      level_change = line.next_line_level_change
-      break line
-    else
-      current_line += 1
-    end
-  end
-  if current_line == 1
-    current_level.should.eql? level_to_check
-  else
-    current_level += level_change  #new
-  end
+Given /^my configuration file "([^"]*)" looks like:$/ do |file_name, string|
+  write_file(file_name, string)
 end
-=end

data/features/support/env.rb

@@ -1,17 +1,9 @@
-$:.unshift File.dirname(__FILE__) + "/../../lib/tailor"
-require "tailor"
+require 'aruba/cucumber'
+require 'simplecov'
 
-gem 'cucumber'
-require 'cucumber'
-gem 'rspec'
-require 'rspec'
-
-Before do
-  @tmp_root = File.dirname(__FILE__) + "/../../tmp"
-  @home_path = File.expand_path(File.join(@tmp_root, "home"))
-  @lib_path  = File.expand_path(File.dirname(__FILE__) + "/../../lib")
-  @features_path = File.dirname(__FILE__) + "/../"
-  FileUtils.rm_rf   @tmp_root
-  FileUtils.mkdir_p @home_path
-  ENV['HOME'] = @home_path
+SimpleCov.start do
+  add_group "Features", "features/"
+  add_group "Lib", "lib"
 end
+
+