inch 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f5e51a1fb3956e91d0e804c28cbfb8c21dc1ef9
-  data.tar.gz: fb07a2be558122b91bcb674381a3dbac81ab49e2
+  metadata.gz: 40896e039aaa1bfed752dc6d80b2df28e5e628e6
+  data.tar.gz: cdac11d21c63a5e3e86ae5d8194f43e8f5a44a85
 SHA512:
-  metadata.gz: c6708035951911b83cecfec2ff1c885e7b9cfd73b148c36e48d827ac63ba520ff6159f4be9c73880e7bdfe7d17079bfbdc10251dc76b7e4b243abbb7fc3c644b
-  data.tar.gz: 4c22485a4a3afa60aacaccc3be699737e34329c9ec168715547457131e29fc9fba881f99105bbe9db24f748f16cdd8319a13d3524615075009776d8a7454ecd1
+  metadata.gz: 61f6c799bafcbd6f2251712c7206ed7f1e24431af34d704b9e656cd31e73d46b7364577ff1b5380be36960b7b5c25ffb76705156012ced4d5c4f9b6888b96ce1
+  data.tar.gz: 9cad52e8dc6ebede402102cfe23a9b90f71c2e19229c7176126116bbb9e1b2c6f945a7b54b0e2a6a030bbdfab2f9c2db1a1822c0e0d8282fc64f56dd2bbf52f3

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.7.1
+
+- Ruby: Setters can now be documented via their @param or @return
+- Elixir: Fix bug regarding parameter name recognition
+
 ## 0.7.0
 
 BREAKING CHANGE:

data/Gemfile

@@ -4,6 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'simplecov', require: false
   gem 'rubocop', '~> 0.25.0', require: false
 end

data/README.md

@@ -336,7 +336,7 @@ Shows you an overview of the codebase.
 
 ### inch show
 
-Shows you details about what can be approved in a specific object.
+Shows you details about what can be improved in a specific object.
 
     $ inch show Inch::SourceParser#find_object
 
@@ -472,7 +472,7 @@ Inch would not exist without Loren Segal's [YARD](http://yardoc.org/).
 
 ## License
 
-Inch is released under the MIT License. See the LICENSE.txt file for further
+Inch is released under the MIT License. See the LICENSE file for further
 details.
 
 For YARD's licensing, see YARD's README under http://yardoc.org/

data/config/ruby.rb

@@ -55,7 +55,18 @@ Inch::Config.register(:ruby) do
         return_description  0.0
       end
 
-      if !object.has_parameters? || object.setter?
+      if object.setter?
+        return_description  return_description + parameters
+
+        if object.original_docstring == ""
+          # we don't count parameters when the docstring is missing or implicit
+          parameters          0.0
+        else
+          parameters          parameters + return_description
+        end
+      end
+
+      if !object.has_parameters?
         return_description  docstring + parameters
         docstring           docstring + parameters
         parameters          0.0

data/lib/inch/api/diff.rb

@@ -7,6 +7,8 @@ module Inch
     class Diff
       include Utils::ShellHelper
 
+      GIT_SUBDIR = ".git"
+
       attr_reader :codebase_old
       attr_reader :codebase_new
       attr_reader :comparer
@@ -18,13 +20,18 @@ module Inch
       #   one is compared against
       def initialize(dir, config, before_rev, after_rev = nil)
         @work_dir = dir
-        @codebase_old = codebase_for(before_rev, config)
-        @codebase_new = if after_rev.nil?
-                          Codebase.parse(work_dir, config)
-                        else
-                          codebase_for(after_rev, config)
-                        end
-        @comparer = API::Compare::Codebases.new(@codebase_old, @codebase_new)
+        if @codebase_old = codebase_for(before_rev, config)
+          @codebase_new = if after_rev.nil?
+                            Codebase.parse(work_dir, config)
+                          else
+                            codebase_for(after_rev, config)
+                          end
+          @comparer = API::Compare::Codebases.new(@codebase_old, @codebase_new)
+        end
+      end
+
+      def failed?
+        @comparer.nil?
       end
 
       private
@@ -33,10 +40,11 @@ module Inch
         if (cached = codebase_from_cache(revision))
           cached
         else
-          codebase = codebase_from_copy(work_dir, config, revision)
-          filename = Codebase::Serializer.filename(revision)
-          Codebase::Serializer.save(codebase, filename)
-          codebase
+          if codebase = codebase_from_copy(work_dir, config, revision)
+            filename = Codebase::Serializer.filename(revision)
+            Codebase::Serializer.save(codebase, filename)
+            codebase
+          end
         end
       end
 
@@ -46,6 +54,8 @@ module Inch
       end
 
       def codebase_from_copy(original_dir, config, revision)
+        return unless File.exist?( File.join(original_dir, GIT_SUBDIR) )
+
         codebase = nil
         Dir.mktmpdir do |tmp_dir|
           new_dir = copy_work_dir(original_dir, tmp_dir)

data/lib/inch/cli/command/diff.rb

@@ -8,12 +8,18 @@ module Inch
       class Diff < Base
         include Utils::ShellHelper
 
+        EXIT_STATUS_FAILED = 1
+
         register_command_as :diff
 
         def description
           'Shows a diff'
         end
 
+        def exit_status
+          @exit_status || super
+        end
+
         def usage
           'Usage: inch diff [REV..[REV]] [options]'
         end
@@ -27,6 +33,8 @@ module Inch
                                before_rev, after_rev)
 
           Output::Diff.new(@options, diff.comparer)
+
+          @exit_status = EXIT_STATUS_FAILED if diff.failed?
         end
 
         private

data/lib/inch/cli/command/output/diff.rb

@@ -11,8 +11,16 @@ module Inch
           # @param comparer [API::Compare::Codebases]
           def initialize(options, comparer)
             @options = options
-            @comparer = comparer
+            if @comparer = comparer
+              display_diff
+            else
+              display_failure
+            end
+          end
 
+          private
+
+          def display_diff
             added    = @comparer.added_objects
             improved = @comparer.improved_objects
             degraded = @comparer.degraded_objects
@@ -24,7 +32,10 @@ module Inch
             end
           end
 
-          private
+          def display_failure
+            ui.trace 'Could not diff current directory.'
+            ui.trace 'To use `inch diff` please run it from the repository root containing .git!'
+          end
 
           def show(added, improved, degraded)
             unless added.empty? && improved.empty?

data/lib/inch/language/elixir/provider/reader/object/function_object.rb

@@ -42,7 +42,12 @@ module Inch
                     a
                   else
                     if a == '\\\\'
-                      name_from_tuple(*b.first)
+                      candidate = b.first
+                      if candidate.is_a?(Array)
+                        name_from_tuple(*candidate)
+                      else
+                        candidate
+                      end
                     else
                       warn "[WARN] could not parse FunctionSignature: #{[a, _, b].inspect}"
                     end

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

data/test/fixtures/ruby/simple/lib/role_methods.rb

@@ -17,6 +17,14 @@ module InchTest
   def manual_setter=(val)
   end
 
+  # @param val [String] the manual setter
+  def manual_setter_full_doc_via_param=(val)
+  end
+
+  # @return [String] the manual setter
+  def manual_setter_full_doc_via_return=(val)
+  end
+
   attr_writer :attr_setter
 
   def bang_method!

data/test/test_helper.rb

@@ -1,5 +1,3 @@
-require 'simplecov'
-
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'minitest/autorun'

data/test/unit/language/ruby/code_object/method_object_test.rb

@@ -216,6 +216,20 @@ describe ::Inch::Language::Ruby::CodeObject::MethodObject do
       assert_equal 0, m.score
     end
 
+    it 'should recognize a manually defined setter method that is docced via param' do
+      m = @objects.find('InchTest#manual_setter_full_doc_via_param=')
+      refute m.getter?
+      assert m.setter?, 'should be a setter'
+      assert m.score >= 80, "score was #{m.score}"
+    end
+
+    it 'should recognize a manually defined setter method that is docced via return' do
+      m = @objects.find('InchTest#manual_setter_full_doc_via_return=')
+      refute m.getter?
+      assert m.setter?, 'should be a setter'
+      assert m.score >= 80, "score was #{m.score}"
+    end
+
     it 'should recognize a getter in a manually defined getter/setter pair' do
       m = @objects.find('InchTest#manual_getset')
       assert m.getter?, 'should be a getter'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-23 00:00:00.000000000 Z
+date: 2016-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler