pippi 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d37c65528172c3c0e6fedbf801f96e8ea46034df
-  data.tar.gz: 846113876273b325dfa0b806dc817931444aed35
+  metadata.gz: 948ecbfacbd679fa33cc861541088156d6928069
+  data.tar.gz: 7037d5aa7e33ac744b041d4f15e266e433b138f8
 SHA512:
-  metadata.gz: 9cb6f46aaaae477eefc994667a1890c68e748ee223c3c1d9b0fa3462b1af82ce8b467d697a54fe639a8ab8f5e9193acaafdaf3f2039a4c7e7a684a7bc47efdd7
-  data.tar.gz: 25204a662c61af0f5906211e1b198286a04e94913a53753c807dd351a8c183fc8140c72103f163525bd3bd40d97fb853fd762a784aa1251ced648135fcdead21
+  metadata.gz: 3889d565b2472028144711ea64975e6e70ea6153b52a86d69eeb31767be7a8893ea939437319da2fae390f6ac78f81bc699c98673e451c11c679de74235d1b7f
+  data.tar.gz: 6578976bea375f870a594525cee6fdf6b20f07f0158deb9a1947178083ec84cd32686d028f16340973055252eb8296303a42c2062dddfc220ce062697abf6fd1

data/CHANGELOG.md

@@ -1,10 +1,16 @@
+## 0.0.14 (2015-04-23)
+
+* [NEW] Added Rails checkset with first rule StripFollowedByEmpty
+* [FIXED] Docs fixes
+* [FIXED] Missing require when using pippi outside Rails
+
 ## 0.0.13 (2015-02-17)
 
-* (FIXED) :io option was still opening default file
+* [FIXED] :io option was still opening default file
 
 ## 0.0.12 (2015-02-16)
 
-* (NEW) Changed output format to work better with IDEs
+* [NEW] Changed output format to work better with IDEs
 
 ## 0.0.11 (2014-12-19)
 

data/README.md

@@ -74,7 +74,13 @@ USE_PIPPI=true bundle exec rake test:units && cat log/pippi.log
 * You can also select a different checkset:
 
 ```text
-USE_PIPPI=true PIPPI_CHECKSET=training bundle exec rake test:units && cat log/pippi.log
+USE_PIPPI=true PIPPI_CHECKSET=rails bundle exec rake test:units && cat log/pippi.log
+```
+
+* And you can run multiple checksets:
+
+```text
+USE_PIPPI=true PIPPI_CHECKSET=basic,rails bundle exec rake test:units && cat log/pippi.log
 ```
 
 
@@ -129,18 +135,18 @@ Pippi has the concept of "checksets" which are, well, sets of checks.  The curre
 
 #### ReverseFollowedByEach
 
-Don't use each followed by reverse; use reverse_each instead
+Don't use reverse followed by each; use reverse_each instead
 
 For example, rather than doing this:
 
 ```ruby
-[1, 2, 3].reverse.each { |x| x + 1 }
+[1,2,3].reverse.each {|x| x+1 }
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1, 2, 3].reverse_each { |x| x + 1 }
+[1,2,3].reverse_each {|x| x+1 }
 ```
 
 #### SelectFollowedByAny
@@ -150,13 +156,13 @@ Don't use select followed by any?; use any? with a block instead
 For example, rather than doing this:
 
 ```ruby
-[1, 2, 3].select { |x| x > 1 }.any?
+[1,2,3].select {|x| x > 1 }.any?
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1, 2, 3].any? { |x| x > 1 }
+[1,2,3].any? {|x| x > 1 }
 ```
 
 #### SelectFollowedByEmpty
@@ -166,13 +172,13 @@ Don't use select followed by empty?; use none? instead
 For example, rather than doing this:
 
 ```ruby
-[1, 2, 3].select { |x| x > 1 }.empty?
+[1,2,3].select {|x| x > 1 }.empty?
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1, 2, 3].none? { |x| x > 1 }
+[1,2,3].none? {|x| x > 1 }
 ```
 
 #### SelectFollowedByFirst
@@ -182,13 +188,13 @@ Don't use select followed by first; use detect instead
 For example, rather than doing this:
 
 ```ruby
-[1, 2, 3].select { |x| x > 1 }.first
+[1,2,3].select {|x| x > 1 }.first
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1, 2, 3].detect { |x| x > 1 }
+[1,2,3].detect {|x| x > 1 }
 ```
 
 #### SelectFollowedByNone
@@ -198,13 +204,13 @@ Don't use select followed by none?; use none? with a block instead
 For example, rather than doing this:
 
 ```ruby
-[1, 2, 3].select { |x| x > 1 }.none?
+[1,2,3].select {|x| x > 1 }.none?
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1, 2, 3].none? { |x| x > 1 }
+[1,2,3].none? {|x| x > 1 }
 ```
 
 #### SelectFollowedBySelect
@@ -214,13 +220,13 @@ Don't use consecutive select blocks; use a single select instead
 For example, rather than doing this:
 
 ```ruby
-[1, 2, 3].select { |x| x > 1 }.select { |x| x > 2 }
+[1,2,3].select {|x| x > 1 }.select {|x| x > 2 }
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1, 2, 3].select { |x| x > 2 }
+[1,2,3].select {|x| x > 2 }
 ```
 
 #### SelectFollowedBySize
@@ -230,13 +236,13 @@ Don't use select followed by size; use count instead
 For example, rather than doing this:
 
 ```ruby
-[1 ,2, 3].select { |x| x > 1 }.size
+[1,2,3].select {|x| x > 1 }.size
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1, 2, 3].count { |x| x > 1 }
+[1,2,3].count {|x| x > 1 }
 ```
 ### buggy
 
@@ -263,13 +269,30 @@ Don't use map followed by flatten(1); use flat_map instead
 For example, rather than doing this:
 
 ```ruby
-[1, 2, 3].map { |x| [x, x + 1] }.flatten(1)
+[1,2,3].map {|x| [x,x+1] }.flatten(1)
+```
+
+Instead, consider doing this:
+
+```ruby
+[1,2,3].flat_map {|x| [x, x+1]}
+```
+### rails
+
+#### StripFollowedByEmpty
+
+Don't use String#strip followed by empty?; use String#blank? instead
+
+For example, rather than doing this:
+
+```ruby
+'   '.strip.empty?
 ```
 
 Instead, consider doing this:
 
 ```ruby
-[1, 2, 3].flat_map { |x| [x, x + 1] }
+'   '.blank?
 ```
 
 ## Ideas for other problems to detect:
@@ -335,9 +358,7 @@ end
 ## TODO
 
 * Clean up this initial hacked out metaprogramming
-* Do more checks
 * Finish refactoring duplicated code into MethodSequenceChecker
-* Use MethodSequenceFinder to do something with String
 
 ## Developing
 

data/doc/docs.md

@@ -2,7 +2,7 @@
 
 #### ReverseFollowedByEach
 
-Don't use each followed by reverse; use reverse_each instead
+Don't use reverse followed by each; use reverse_each instead
 
 For example, rather than doing this:
 
@@ -144,3 +144,20 @@ Instead, consider doing this:
 ```ruby
 [1,2,3].flat_map {|x| [x, x+1]}
 ```
+### rails
+
+#### StripFollowedByEmpty
+
+Don't use String#strip followed by empty?; use String#blank? instead
+
+For example, rather than doing this:
+
+```ruby
+'   '.strip.empty?
+```
+
+Instead, consider doing this:
+
+```ruby
+'   '.blank?
+```

data/lib/pippi.rb

@@ -16,6 +16,7 @@ require 'pippi/checks/select_followed_by_empty'
 require 'pippi/checks/select_followed_by_any'
 require 'pippi/checks/select_followed_by_none'
 require 'pippi/checks/select_followed_by_select'
+require 'pippi/checks/strip_followed_by_empty'
 require 'pippi/checks/method_sequence_finder'
 require 'pippi/checks/method_sequence_checker'
 require 'pippi/checks/assert_with_nil'

data/lib/pippi/check_set_mapper.rb

@@ -28,6 +28,9 @@ module Pippi
           "ReverseFollowedByEach",
           "SelectFollowedBySelect"
         ],
+        "rails" => [
+          "StripFollowedByEmpty"
+        ],
         "training" => [
         ],
         "research" => [

data/lib/pippi/checks/check.rb

@@ -6,8 +6,12 @@ module Pippi::Checks
       @ctx = ctx
     end
 
-    def array_mutator_methods
-      [:collect!, :compact!, :flatten!, :map!, :reject!, :reverse!, :rotate!, :select!, :shuffle!, :slice!, :sort!, :sort_by!, :uniq!]
+    def mutator_methods(the_type=Array)
+      if the_type == String
+        [:insert, :<<]
+      else
+        [:collect!, :compact!, :flatten!, :map!, :reject!, :reverse!, :rotate!, :select!, :shuffle!, :slice!, :sort!, :sort_by!, :uniq!]
+      end
     end
 
     def method_names_that_indicate_this_is_being_used_as_a_collection

data/lib/pippi/checks/map_followed_by_flatten.rb

@@ -22,7 +22,7 @@ module Pippi::Checks
           # Ignore Array subclasses since map or flatten may have difference meanings
         else
           result.extend MyFlatten
-          self.class._pippi_check_map_followed_by_flatten.array_mutator_methods.each do |this_means_its_ok_sym|
+          self.class._pippi_check_map_followed_by_flatten.mutator_methods.each do |this_means_its_ok_sym|
             result.define_singleton_method(this_means_its_ok_sym, self.class._pippi_check_map_followed_by_flatten.its_ok_watcher_proc(MyFlatten, :flatten))
           end
         end

data/lib/pippi/checks/method_sequence_checker.rb

@@ -3,7 +3,7 @@ class MethodSequenceChecker
   ARITY_TYPE_BLOCK_ARG = 1
   ARITY_TYPE_NONE = 2
 
-  attr_reader :check, :clazz_to_decorate, :method1, :method2, :first_method_arity_type, :second_method_arity_type, :should_check_subsequent_calls
+  attr_reader :check, :clazz_to_decorate, :method1, :method2, :first_method_arity_type, :second_method_arity_type, :should_check_subsequent_calls, :return_type
 
   def initialize(check, clazz_to_decorate, method1, method2, first_method_arity_type, second_method_arity_type, should_check_subsequent_calls)
     @check = check
@@ -33,7 +33,7 @@ class MethodSequenceChecker
             # e.g., Array#select returns an Array.  Would need to further parameterize this to get
             # different behavior.
             self.class.instance_variable_get(name).add_problem
-            if method_sequence_check_instance.should_check_subsequent_calls && method_sequence_check_instance.clazz_to_decorate == Array
+            if method_sequence_check_instance.should_check_subsequent_calls && method_sequence_check_instance.clazz_to_decorate == self.class
               problem_location = caller_locations.find { |c| c.to_s !~ /byebug|lib\/pippi\/checks/ }
               self.class.instance_variable_get(name).method_names_that_indicate_this_is_being_used_as_a_collection.each do |this_means_its_ok_sym|
                 define_singleton_method(this_means_its_ok_sym, self.class.instance_variable_get(name).clear_fault_proc(self.class.instance_variable_get(name), problem_location))
@@ -58,7 +58,7 @@ class MethodSequenceChecker
           end
           if self.class.instance_variable_get(name)
             result.extend second_method_decorator
-            self.class.instance_variable_get(name).array_mutator_methods.each do |this_means_its_ok_sym|
+            self.class.instance_variable_get(name).mutator_methods(result.class).each do |this_means_its_ok_sym|
               result.define_singleton_method(this_means_its_ok_sym, self.class.instance_variable_get(name).its_ok_watcher_proc(second_method_decorator, method_sequence_check_instance.method2))
             end
           end

data/lib/pippi/checks/reverse_followed_by_each.rb

@@ -16,7 +16,7 @@ module Pippi::Checks
           # Ignore Array subclasses since reverse or each may have difference meanings
         else
           result.singleton_class.class_eval { prepend MyEach }
-          self.class._pippi_check_reverse_followed_by_each.array_mutator_methods.each do |this_means_its_ok_sym|
+          self.class._pippi_check_reverse_followed_by_each.mutator_methods.each do |this_means_its_ok_sym|
             result.define_singleton_method(this_means_its_ok_sym, self.class._pippi_check_reverse_followed_by_each.its_ok_watcher_proc(MyEach, :each))
           end
         end
@@ -37,7 +37,7 @@ module Pippi::Checks
 
     class Documentation
       def description
-        "Don't use each followed by reverse; use reverse_each instead"
+        "Don't use reverse followed by each; use reverse_each instead"
       end
 
       def sample

data/lib/pippi/checks/strip_followed_by_empty.rb

@@ -0,0 +1,30 @@
+module Pippi::Checks
+
+  # This is a Rails-only check; how to call it out as such?
+  # Putting it in a "rails" checkset for now
+  class StripFollowedByEmpty < Check
+
+    def decorate
+      @mycheck.decorate
+    end
+
+    def initialize(ctx)
+      super
+      @mycheck = MethodSequenceChecker.new(self, String, "strip", "empty?", MethodSequenceChecker::ARITY_TYPE_NONE, MethodSequenceChecker::ARITY_TYPE_NONE, true)
+    end
+
+    class Documentation
+      def description
+        "Don't use String#strip followed by empty?; use String#blank? instead"
+      end
+      def sample
+        "'   '.strip.empty?"
+      end
+      def instead_use
+        "'   '.blank?"
+      end
+    end
+
+  end
+
+end

data/lib/pippi/report.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module Pippi
   class Report
     attr_reader :problems, :removed

data/lib/pippi/version.rb

@@ -1,3 +1,3 @@
 module Pippi
-  VERSION = '0.0.13'
+  VERSION = '0.0.14'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pippi
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Tom Copeland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2015-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -82,6 +82,7 @@ files:
 - lib/pippi/checks/select_followed_by_none.rb
 - lib/pippi/checks/select_followed_by_select.rb
 - lib/pippi/checks/select_followed_by_size.rb
+- lib/pippi/checks/strip_followed_by_empty.rb
 - lib/pippi/context.rb
 - lib/pippi/exec_runner.rb
 - lib/pippi/problem.rb