fixbraces 1.2.0 → 1.3.0

data/bin/fixbraces

@@ -16,6 +16,7 @@ Usage:
 where [options] are:
 BANN
 
+  opt :dry_run, "Do not change any files, but list the names of those that would be changed."
 end
 
 source_files = []
@@ -23,6 +24,7 @@ source_files = []
 # Bail if no path of file is given
 Trollop::die "fixbraces needs to know what directory or files to attempt to correct" if ARGV.length < 1
 
+# Sort out the files that need to be processed
 ARGV.each do |path|
   f = File.expand_path path
 
@@ -43,11 +45,20 @@ ARGV.each do |path|
 end
 
 source_files.flatten.each do |f|
-  changed_file = Fixbraces.process_file f
+  changed_file = ""
+  output_prefix = ""
+
+  if opts[:dry_run]
+    changed_file = Fixbraces.dry_process_file f
+    output_prefix = "Will Correct:"
+  else
+    changed_file = Fixbraces.process_file f
+    output_prefix = "Corrected:"
+  end
 
   if changed_file
     path_name = Pathname.new changed_file
     relative_path_name = path_name.relative_path_from Pathname.pwd
-    puts "Corrected: #{relative_path_name}"
+    puts "#{output_prefix} #{relative_path_name}"
   end
 end

data/features/fixbraces.feature

@@ -1,5 +1,5 @@
-Feature: The binary interface for fixbraces works
-  In order to be sure that the cli version of the gem works
+Feature: The script correctly makes changes to files
+  In order to correct the formatting of the Objective-C source files
   The developer will need to make sure that these tests pass
 
   Scenario: Run the app on a single file

data/features/fixbraces_dry.feature

@@ -0,0 +1,43 @@
+Feature: The script correctly implements a dry run feature
+  In order to see what files _will_ be changed by running the script
+  the developer will need to make these tests pass
+
+    Scenario: Run the app on a single file
+    Given a single source file called MasterViewController.m
+    When I run `fixbraces -d MasterViewController.m`
+    Then MasterViewController.m should not be formatted correctly
+    Then the output should contain "MasterViewController.m"
+    And the exit status should be 0
+
+  Scenario: Run the app on a directory
+    Given an Xcode project
+    When I run `"fixbraces -d ."`
+    Then the files in the directory should be unchanged
+    And the exit status should be 0
+
+  Scenario: Run the app on a number of files in the directory
+    Given an Xcode project
+    When I run `"fixbraces -d FixbracesTestProject/*.m"`
+    And the suggested changed files should be listed
+    And the files in the directory should be unchanged
+    And the exit status should be 0
+
+  Scenario: Show an error message if no file or directory is provided
+    Given an Xcode project
+    When I run `fixbraces -d`
+    Then the output should contain "Error: fixbraces needs to know what directory or files to attempt to correct."
+    And the exit status should not be 0
+
+  Scenario: Show an error message for a non-existent file or directory
+    Given an Xcode project
+    When I run `fixbraces -d non_existent_path`
+    Then the output should contain "Invalid path"
+    And the exit status should be 0
+
+  Scenario: If one of the files is non-existent correct the file that can be changed and show an error message for the non-existent one
+    Given a single source file called MasterViewController.m
+    When I run `fixbraces -d MasterViewController.m some_file.m`
+    Then MasterViewController.m should not be formatted correctly
+    And the output should contain "MasterViewController.m"
+    And the output should contain "Invalid path"
+    And the exit status should be 0

data/features/step_definitions/fixbraces_steps.rb

@@ -10,6 +10,12 @@ Then /^MasterViewController\.m should be formatted correctly$/ do
   expect(FileUtils.compare_file @result_file, @expected_file).to eq true
 end
 
+Then /^MasterViewController\.m should not be formatted correctly$/ do
+  @expected_file = @fixtures_input_dir + "FixbracesTestProject/MasterViewController.m"
+  @result_file = @working_dir + "MasterViewController.m"
+  expect(FileUtils.compare_file @result_file, @expected_file).to eq true
+end
+
 Given /^an Xcode project$/ do
   FileUtils.mkdir_p @working_dir
   FileUtils.cp_r @fixtures_input_dir + "FixbracesTestProject", @working_dir
@@ -22,6 +28,11 @@ Then /^the files in the directory should be formatted correctly$/ do
   expect(result).to eq ""
 end
 
+Then /^the files in the directory should be unchanged$/ do
+  result = `diff -r --brief --exclude=.DS_Store #{@working_dir} #{@fixtures_input_dir}`
+  expect(result).to eq ""
+end
+
 Then /^the \.m files in that directory are changed$/ do
   # Under testing we have complete control over the files. so use a hard coded list.
   base_dir = File.join @working_dir, "FixbracesTestProject"
@@ -45,6 +56,10 @@ Then /^the changed files should be listed$/ do
   step %(the output should contain "main.m")
 end
 
+When /^the suggested changed files should be listed$/ do
+  step %(the changed files should be listed)
+end
+
 Then /^there should not be any .h files listed$/ do
   step %(the output should not contain "AppDelegate.h")
 end

data/lib/fixbraces/version.rb

@@ -1,3 +1,3 @@
 module Fixbraces
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/lib/fixbraces.rb

@@ -40,4 +40,16 @@ module Fixbraces
     # Return the file path or nil if no changes were made
     corrected_text ? file : nil
   end
+
+  def Fixbraces.dry_process_file(file)
+    corrected_text = ""
+
+    # Read in the text and pass it to the method that corrects it.
+    File.open(file, "r") do |f|
+      contents = f.read
+      corrected_text = fixbraces contents
+    end
+
+    corrected_text ? file : nil
+  end
 end

data/spec/fixbraces_spec.rb

@@ -32,7 +32,8 @@ describe Fixbraces do
     end
   end
 
-  describe "#process_file" do
+  context "Working with files" do
+
     before(:each) do
       tests_dir = Dir.pwd + "/tmp/spec/"
 
@@ -53,26 +54,61 @@ describe Fixbraces do
       end
     end
 
-    it "manages to update multiple files" do
-      files = Dir.glob Dir.pwd + "/tmp/spec/*.{h,m}"
-      files.each do |f|
-        Fixbraces.process_file f
+    describe "#process_file" do
+
+      it "manages to update multiple files" do
+        files = Dir.glob Dir.pwd + "/tmp/spec/*.{h,m}"
+        files.each do |f|
+          Fixbraces.process_file f
+        end
+
+        result = `diff -r --brief #{Dir.pwd + "/tmp/spec/"} #{Dir.pwd + "/spec/fixtures/expected/"}`
+        expect(result).to eq ""
       end
 
-      result = `diff -r --brief #{Dir.pwd + "/tmp/spec/"} #{Dir.pwd + "/spec/fixtures/expected/"}`
-      expect(result).to eq ""
+      it 'should preserve the original file mode' do
+        files = Dir.glob Dir.pwd + "/tmp/spec/*.{h,m}"
+        files.each do |f|
+          original_mode = File.new(f).stat.mode
+          Fixbraces.process_file f
+          new_mode = File.new(f).stat.mode
+
+          expect(new_mode).to eq original_mode
+        end
+      end
     end
 
-    it 'should preserve the original file mode' do
-      files = Dir.glob Dir.pwd + "/tmp/spec/*.{h,m}"
-      files.each do |f|
-        original_mode = File.new(f).stat.mode
-        Fixbraces.process_file f
-        new_mode = File.new(f).stat.mode
+    describe "#dry_process_file" do
+      it "returns the names of the files if changes could be applied" do
+        files = Dir.glob Dir.pwd + "/tmp/spec/*.{h,m}"
+
+        processed_files = Set.new
+        files.each do |f|
+          processed_file = Fixbraces.dry_process_file f
+          unless processed_file
+            next
+          end
+          processed_files.add (File.basename processed_file)
+        end
+
+        expected_processed_files = ["MasterViewController.h", "AppDelegate.m", "MasterViewController.m"].to_set
 
-        expect(new_mode).to eq original_mode
+        expect(processed_files).to eq expected_processed_files
       end
+
+      it 'should not change the contents of the files' do
+        files = Dir.glob Dir.pwd + "/tmp/spec/*.{h,m}"
+        files.each do |f|
+          Fixbraces.dry_process_file f
+        end
+
+        result = `diff -r --brief #{Dir.pwd + "/tmp/spec/"} #{Dir.pwd + "/spec/fixtures/input/"}`
+        expect(result).to eq ""
+      end
+
     end
+
   end
 
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fixbraces
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-01 00:00:00.000000000 Z
+date: 2013-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -99,6 +99,7 @@ files:
 - bin/fixbraces
 - features/cli.feature
 - features/fixbraces.feature
+- features/fixbraces_dry.feature
 - features/fixtures/FixbracesTestProject/FixbracesTestProject.xcodeproj/project.pbxproj
 - features/fixtures/FixbracesTestProject/FixbracesTestProject/AppDelegate.h
 - features/fixtures/FixbracesTestProject/FixbracesTestProject/AppDelegate.m
@@ -181,6 +182,7 @@ summary: Puts the opening brace on the same line
 test_files:
 - features/cli.feature
 - features/fixbraces.feature
+- features/fixbraces_dry.feature
 - features/fixtures/FixbracesTestProject/FixbracesTestProject.xcodeproj/project.pbxproj
 - features/fixtures/FixbracesTestProject/FixbracesTestProject/AppDelegate.h
 - features/fixtures/FixbracesTestProject/FixbracesTestProject/AppDelegate.m