tailor 0.1.5 → 1.0.0.alpha

data/lib/tailor/rulers/trailing_newlines_ruler.rb

@@ -0,0 +1,36 @@
+require_relative '../ruler'
+
+
+class Tailor
+  module Rulers
+    class TrailingNewlinesRuler < Tailor::Ruler
+
+      # Checks to see if the number of newlines at the end of the file is not
+      # equal to the value at +@config+.
+      #
+      # @param [Fixnum] trailing_newline_count The number of newlines at the end
+      #   of the file.
+      def measure(trailing_newline_count)
+        if trailing_newline_count != @config
+          lineno = "<EOF>"
+          column = "<EOF>"
+          @problems << Problem.new(:trailing_newlines, lineno, column,
+            { actual_trailing_newlines: trailing_newline_count,
+              should_have: @config }
+          )
+        end
+      end
+
+      # Checks to see if the file's final character is a \n.  If it is, it just
+      # returns the text that was passed in.  If it's not, it adds a \n, since
+      # the current indentation-checking algorithm only checks indent levels when
+      # it parses a newline character (without this, indentation problems on the
+      # final line won't ever get caught).
+      #
+      # @param [Fixnum] trailing_newline_count
+      def file_update(trailing_newline_count)
+        measure(trailing_newline_count)
+      end
+    end
+  end
+end

data/lib/tailor/runtime_error.rb

@@ -0,0 +1,3 @@
+class Tailor
+  class RuntimeError < RuntimeError; end
+end

data/lib/tailor/tailorrc.erb

@@ -0,0 +1,88 @@
+#------------------------------------------------------------------------------
+# Horizontal Whitespace
+#------------------------------------------------------------------------------
+# allow_hard_tabs         True to let hard tabs be considered a single space.
+#                         Default:      false
+#
+# allow_trailing_line_spaces
+#                         True to skip detecting extra spaces at the ends of
+#                         lines.
+#                         Default:      false
+#
+# indentation_spaces      The number of spaces to consider a proper indent.
+#                         Default:      2
+#
+# max_line_length         The maximum number of characters in a line before
+#                         tailor complains.
+#                         Default:      80
+# spaces_after_comma      Number of spaces to expect after a comma.
+#                         Default:      1
+#
+# spaces_before_comma     Number of spaces to expect before a comma.
+#                         Default:      0
+#
+# spaces_after_lbrace     The number of spaces to expect after an lbrace ('{').
+#                         Default:      1
+#
+# spaces_before_lbrace    The number of spaces to expect before an lbrace ('{').
+#                         Default:      1
+#
+# spaces_before_rbrace    The number of spaces to expect before an rbrace ('}').
+#                         Default:      1
+#
+# spaces_in_empty_braces  The number of spaces to expect between braces when
+#                         there's nothing in the braces (i.e. {}).
+#                         Default:      0
+#
+# spaces_after_lbracket   The number of spaces to expect after an
+#                         lbracket ('[').
+#                         Default:      0
+#
+# spaces_before_rbracket  The number of spaces to expect before an
+#                         rbracket (']').
+#                         Default:      0
+#
+# spaces_after_lparen     The number of spaces to expect after an
+#                         lparen ('(').
+#                         Default:      0
+#
+# spaces_before_rparen    The number of spaces to expect before an
+#                         rbracket (')').
+#                         Default:      0
+#
+#------------------------------------------------------------------------------
+# Naming
+#------------------------------------------------------------------------------
+# allow_camel_case_methods
+#                         Setting to true skips detection of camel-case method
+#                         names (i.e. def myMethod).
+#                         Default:      false
+#
+# allow_screaming_snake_case_classes
+#                         Setting to true skips detection of screaming
+#                         snake-case class names (i.e. My_Class).
+#                         Default:      false
+#
+#------------------------------------------------------------------------------
+# Vertical Whitespace
+#------------------------------------------------------------------------------
+# max_code_lines_in_class The number of lines of code in a class to allow before
+#                         tailor will warn you.
+#                         Default:      300
+#
+# max_code_lines_in_method
+#                         The number of lines of code in a method to allow
+#                         before tailor will warn you.
+#                         Default:      30
+#
+# trailing_newlines       The number of newlines that should be at the end of
+#                         the file.
+#                         Default:      1
+#
+Tailor.config do |config|
+  config.formatters <%= formatters %>
+  config.file_set '<%= file_list %>' do
+    <% style.each do |rule, value| %><%= rule %> <%= value %>
+    <% end %>
+  end
+end

data/lib/tailor/version.rb

@@ -1,3 +1,3 @@
-module Tailor
-  VERSION = '0.1.5'
+class Tailor
+  VERSION = '1.0.0.alpha'
 end

data/spec/spec_helper.rb

@@ -1,7 +1,9 @@
-$:.unshift(File.dirname(__FILE__) + '/../lib')
-require 'tailor'
-require 'rspec'
+require 'fakefs/spec_helpers'
+require 'simplecov'
 
-def create_file_line(string, line_number)
-  FileLine.new(string, Pathname.new(__FILE__), line_number)
+SimpleCov.start
+
+RSpec.configure do |conf|
+  conf.include FakeFS::SpecHelpers
 end
+

data/spec/tailor/cli_spec.rb

@@ -0,0 +1,94 @@
+require_relative '../spec_helper'
+require 'tailor/cli'
+
+
+describe Tailor::CLI do
+  let(:args) { [] }
+  let(:options) { double "Options", show_config: false }
+
+  let(:config) do
+    double "Tailor::Configuration",
+      file_sets: nil, formatters: nil
+  end
+
+  before do
+    Tailor::Configuration.stub(:new).and_return config
+    Tailor::Critic.stub(:new)
+    Tailor::Reporter.stub(:new)
+  end
+
+  after do
+    Tailor::Configuration.unstub(:new)
+  end
+
+  subject { Tailor::CLI.new(args) }
+
+  describe "::run" do
+    it "creates an instance of Tailor::CLI and calls that object's #execute!" do
+      cli = double "Tailor::CLI"
+      cli.should_receive(:execute!)
+      Tailor::CLI.should_receive(:new).and_return cli
+      Tailor::CLI.run([])
+    end
+  end
+
+  describe "#initialize" do
+    let(:args) { ['last'] }
+    
+    it "uses Options to parse the args" do
+      Tailor::Configuration.stub(:new).and_return config
+      Tailor::Critic.stub(:new)
+      Tailor::Reporter.stub(:new)
+      Tailor::CLI::Options.should_receive(:parse!).with(args).and_return options
+
+      Tailor::CLI.new(args)
+    end
+
+    it "creates a new Configuration from the file/dir and options" do
+      Tailor::CLI::Options.stub(:parse!).and_return(options)
+      Tailor::Configuration.should_receive(:new).
+        with(args, options).and_return config
+      Tailor::Critic.stub(:new)
+
+      Tailor::CLI.new(args)
+    end
+    
+    context "options.show_config is true" do
+      
+    end
+    
+    context "options.show_config is false" do
+      
+    end
+    
+  end
+
+  describe "#execute!" do
+    let(:reporter) { double "Tailor::Reporter" }
+    let(:critic) { double "Tailor::Critic", problem_count: 0 }
+
+    before do
+      Tailor::Critic.stub(:new).and_return(critic)
+      Tailor::Reporter.stub(:new).and_return(reporter)
+      subject.instance_variable_set(:@critic, critic)
+      subject.instance_variable_set(:@reporter, reporter)
+    end
+    
+    after do
+      Tailor::Critic.unstub(:new)
+      Tailor::Reporter.unstub(:new)
+    end
+
+    it "calls @critic.critique and yields file problems and the label" do
+      problems_for_file = {}
+      label = :test
+      critic.stub(:problem_count).and_return 1
+      critic.stub(:problems)
+      critic.stub(:critique).and_yield(problems_for_file, label)
+      reporter.stub(:summary_report)
+      reporter.should_receive(:file_report).with(problems_for_file, label)
+      
+      subject.execute!
+    end
+  end
+end

data/spec/tailor/configuration_spec.rb

@@ -0,0 +1,147 @@
+require_relative '../spec_helper'
+require 'tailor/configuration'
+
+describe Tailor::Configuration do
+  before { Tailor::Logger.stub(:log) }
+
+  subject do
+    Tailor::Configuration.new('.')
+  end
+
+  describe "#formatters" do
+    context "param is nil" do
+      it "returns the pre-exisiting @formatters" do
+        subject.instance_variable_set(:@formatters, [:blah])
+        subject.formatters.should == [:blah]
+      end
+    end
+
+    context "param is some value" do
+      it "sets @formatters to that value" do
+        subject.formatters "blah"
+        subject.instance_variable_get(:@formatters).should == ["blah"]
+      end
+    end
+  end
+
+  describe "#file_set" do
+    before do
+      subject.instance_variable_set(:@file_sets, {})
+    end
+    
+    it "adds the set of stuff to @file_sets" do
+      subject.file_set(:bobo) do
+        trailing_newlines 2
+      end
+
+      subject.instance_variable_get(:@file_sets).should == {
+        bobo: {
+          file_list: [],
+          style: {
+            :allow_camel_case_methods=>false,
+            :allow_hard_tabs=>false,
+            :allow_screaming_snake_case_classes=>false,
+            :allow_trailing_line_spaces=>false,
+            :indentation_spaces=>2,
+            :max_code_lines_in_class=>300,
+            :max_code_lines_in_method=>30,
+            :max_line_length=>80,
+            :spaces_after_comma=>1,
+            :spaces_before_comma=>0,
+            :spaces_before_lbrace=>1,
+            :spaces_after_lbrace=>1,
+            :spaces_before_rbrace=>1,
+            :spaces_in_empty_braces=>0,
+            :spaces_after_lbracket=>0,
+            :spaces_before_rbracket=>0,
+            :spaces_after_lparen=>0,
+            :spaces_before_rparen=>0,
+            :trailing_newlines=>2
+          }
+        }
+      }
+    end
+
+    context "first param is nil" do
+      it "uses :default as the label" do
+        subject.file_set
+        subject.instance_variable_get(:@file_sets).should include(:default)
+      end
+    end
+  end
+
+  describe "#confg_file" do
+    context "@config_file is already set" do
+      it "returns @config_file" do
+        subject.instance_variable_set(:@config_file, 'pants')
+        subject.config_file
+        subject.instance_variable_get(:@config_file).should == 'pants'
+      end
+    end
+    
+    context "@config_file is nil" do
+      it "returns DEFAULT_RC_FILE" do
+        subject.config_file
+        subject.instance_variable_get(:@config_file).should ==
+          Tailor::Configuration::DEFAULT_RC_FILE
+      end
+    end
+  end
+  
+  describe "#file_list" do
+    before do
+      FileUtils.mkdir_p 'one/two'
+      File.new('one/two/three.rb', 'w') { |f| f.write "stuff" }
+    end
+
+    context "glob is an Array" do
+      context "the Array has files" do
+        it "returns all files in the glob" do
+          results = subject.file_list(['one/two/three.rb'])
+          results.last.should match /one\/two\/three.rb/
+        end
+      end
+      
+      context "the Array has a directory" do
+        context "the directory has files" do
+          it "returns all files in the directory" do
+            results = subject.file_list(['.'])
+            results.last.should match /one\/two\/three.rb/
+          end
+        end
+        
+        context "the directory is empty" do
+          before do
+            FileUtils.mkdir 'empty'
+            FileUtils.rm_rf 'one'
+          end
+
+          it "returns an empty Array" do
+            results = subject.file_list(['.'])
+            results.should == []
+          end
+        end
+      end
+    end
+    
+    context "glob is a glob" do
+      it "returns all files in the glob" do
+        results = subject.file_list('one/**/*.rb')
+        results.last.should match /one\/two\/three.rb/
+      end
+    end
+
+    context "glob is a directory" do
+      it "returns all files in the glob" do
+        results = subject.file_list('one')
+        results.last.should match /one\/two\/three.rb/
+      end
+    end
+    
+    context "glob is a file" do
+      it "returns all files in the glob" do
+        subject.file_list('one/two/three.rb').last.should match /one\/two\/three.rb/
+      end
+    end
+  end
+end

data/spec/tailor/critic_spec.rb

@@ -0,0 +1,63 @@
+require_relative '../spec_helper'
+require 'tailor/critic'
+
+describe Tailor::Critic do
+  let(:configuration) { } # empty on purpose
+  before { subject.stub(:log) }
+  subject { Tailor::Critic.new(configuration) }
+
+  describe "#check_file" do
+    let(:lexer) { double "Lexer" }
+    let(:ruler) { double "Ruler" }
+    let(:file_name) { "this_file.rb" }
+
+    before do
+      subject.stub(:init_rulers)
+    end
+
+    it "lexes the file" do
+      lexer.should_receive(:lex)
+      lexer.stub(:check_added_newline)
+      Tailor::Lexer.should_receive(:new).with(file_name).and_return lexer
+      subject.stub_chain(:problems, :[]=)
+      subject.stub_chain(:problems, :[])
+
+      subject.check_file(file_name, 1)
+    end
+
+    it "adds problems for the file to the main list of problems" do
+      lexer.stub(:lex)
+      lexer.stub(:check_added_newline)
+      Tailor::Lexer.stub(:new).and_return lexer
+      subject.problems.should_receive(:[]=).with(file_name, [])
+
+      subject.check_file(file_name, 1)
+    end
+  end
+
+  describe "#problems" do
+    specify { subject.problems.should be_a Hash }
+    specify { subject.problems.should be_empty }
+  end
+
+  describe "#problem_count" do
+    context "#problems is empty" do
+      it "returns 0" do
+        subject.instance_variable_set(:@problems, {})
+        subject.problem_count.should == 0
+      end
+    end
+
+    context "#problems contains valid values" do
+      it "adds the number of each problem together" do
+        probs = {
+           one: { type: :indentation, line: 1, message: "" },
+           two: { type: :indentation, line: 2, message: "" },
+           thre: { type: :indentation, line: 27, message: "" }
+        }
+        subject.instance_variable_set(:@problems, probs)
+        subject.problem_count.should == 3
+      end
+    end
+  end
+end