inch 0.3.2 → 0.3.3.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83d4cc8e22c5fe81cdd9a9e1f991394a2f68b1d2
-  data.tar.gz: c2a0ec4271685f914724eb92921ec690960f59f5
+  metadata.gz: 32657c657481312dac6a4325355524bdc9e04642
+  data.tar.gz: e79fb87d207616b128252f8bf5f27ae4c6aa0a18
 SHA512:
-  metadata.gz: 561a32eb812adc99fefd65119ec0e48bafd42399fc023ffd0340c851fe06bcb91cb0b22efe926e20940ebc79d863fd5b12bbdca9b8f46f2fe9b020d13619cb6d
-  data.tar.gz: 27562e6a16d36d17bc994a433d91aaef27cc90273cf3f20f4cf5d5bb77de1fb2bf2d308efe0ac632c546345b222fc376aae8962735984630e11fa7f45911574a
+  metadata.gz: d460817a8091d42386e72b936bcfdb46ae9fb461f8da4fc6486c3870d29bf1646dacd583f9329a9518b116d9f3e5d460b3bd5ef2924e98f3cb7c79ef4bdf9ff2
+  data.tar.gz: 399b22d66754c8641d96eba9a586843d961fb3930c6d7c9b5c9848c809b643b80a5c5bc08b227e6ce549cbe027ad9df04a47ab988942d6036fa1d9ec29de0a24

data/README.md

@@ -78,6 +78,33 @@ Inch will suggest that the docs could be improved:
     Only considering priority objects: ↑ ↗ →  (use `--help` for options).
 
 
+
+## Configuration
+
+By default, Inch looks into `{app,lib}/**/*.rb` for Ruby source files. You can customize this by either passing the desired files to the executable:
+
+    $ inch suggest plugins/**/*.rb
+
+or by creating a file named `.inch.yml` in your project directory:
+
+```yaml
+files:
+  # define files included in the analysis (defaults to ["{app,lib}/**/*.rb"])
+  included:
+    - plugins/**/*.rb
+  # define files excluded from the analysis (defaults to [])
+  excluded:
+    # you can use file paths
+    - plugins/vendor/sparkr/sparkr.rb
+    # or globs
+    - plugins/vendor/**/*.rb
+    # or regular expressions
+    - !ruby/regexp /vendor/
+```
+
+As you would expect, `included` sets an array of included files (or globs) and `excluded` sets an array of files, globs or regexes of files to exclude from the evaluation.
+
+
 ## Philosophy
 
 Inch was created to help people document their code, therefore it may be more important to look at **what it does not** do than at what it does.

data/lib/inch/code_object/provider/yard/object/method_object.rb

@@ -36,10 +36,15 @@ module Inch
               true
             end
 
+            def overloaded?
+            end
+
             def parameters
               @parameters ||= all_parameter_names.map do |name|
                 signature_name = in_signature(name)
-                tag = parameter_tag(name) || parameter_tag(signature_name)
+                tag = parameter_tag(name) || parameter_tag(signature_name) ||
+                        overload_tag_with_parameter(name)
+
                 MethodParameterObject.new(self, name, signature_name, tag)
               end
             end
@@ -106,8 +111,35 @@ module Inch
               (signature_parameter_names & possible_names).first
             end
 
+            def normalize_parameter_name(name)
+              # remove leading and trailing brackets
+              # (sometimes used to indicate optional parameters in overload
+              # signatures)
+              name.gsub(/[\[\]]/, '')
+            end
+
+            def overload_tags
+              object.tags(:overload)
+            end
+
+            # Returns all parameter names from all overload signatures.
+            # @todo analyse each signature on its own
+            def overloaded_parameter_names
+              overload_tags.map do |tag|
+                tag.parameters.map do |parameter|
+                  normalize_parameter_name(parameter[0])
+                end
+              end.flatten
+            end
+
+            def overload_tag_with_parameter(name)
+              overload_tags.detect do |tag|
+                tag.parameters.map(&:first).include?(name)
+              end
+            end
+
             def signature_parameter_names
-              object.parameters.map(&:first)
+              object.parameters.map(&:first) + overloaded_parameter_names
             end
 
             def parameter_tag(param_name)

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.3.2"
+  VERSION = "0.3.3.rc1"
 end

data/test/fixtures/simple/lib/broken.rb

@@ -30,6 +30,132 @@ module Foo
   end
 end
 
+module Overloading
+  # Creates a {Sass::Script::Value::Color Color} object from red, green, and
+  # blue values.
+  #
+  # @see #rgba
+  # @overload rgb($red, $green, $blue)
+  # @param $red [Sass::Script::Value::Number] The amount of red in the color.
+  #   Must be between 0 and 255 inclusive, or between `0%` and `100%`
+  #   inclusive
+  # @param $green [Sass::Script::Value::Number] The amount of green in the
+  #   color. Must be between 0 and 255 inclusive, or between `0%` and `100%`
+  #   inclusive
+  # @param $blue [Sass::Script::Value::Number] The amount of blue in the
+  #   color. Must be between 0 and 255 inclusive, or between `0%` and `100%`
+  #   inclusive
+  # @return [Sass::Script::Value::Color]
+  # @raise [ArgumentError] if any parameter is the wrong type or out of bounds
+  def rgb(red, green, blue)
+  end
+  # Creates a {Sass::Script::Value::Color Color} from red, green, blue, and
+  # alpha values.
+  # @see #rgb
+  #
+  # @overload rgba($red, $green, $blue, $alpha)
+  #   @param $red [Sass::Script::Value::Number] The amount of red in the
+  #     color. Must be between 0 and 255 inclusive
+  #   @param $green [Sass::Script::Value::Number] The amount of green in the
+  #     color. Must be between 0 and 255 inclusive
+  #   @param $blue [Sass::Script::Value::Number] The amount of blue in the
+  #     color. Must be between 0 and 255 inclusive
+  #   @param $alpha [Sass::Script::Value::Number] The opacity of the color.
+  #     Must be between 0 and 1 inclusive
+  #   @return [Sass::Script::Value::Color]
+  #   @raise [ArgumentError] if any parameter is the wrong type or out of
+  #     bounds
+  #
+  # @overload rgba($color, $alpha)
+  #   Sets the opacity of an existing color.
+  #
+  #   @example
+  #     rgba(#102030, 0.5) => rgba(16, 32, 48, 0.5)
+  #     rgba(blue, 0.2)    => rgba(0, 0, 255, 0.2)
+  #
+  #   @param $color [Sass::Script::Value::Color] The color whose opacity will
+  #     be changed.
+  #   @param $alpha [Sass::Script::Value::Number] The new opacity of the
+  #     color. Must be between 0 and 1 inclusive
+  #   @return [Sass::Script::Value::Color]
+  #   @raise [ArgumentError] if `$alpha` is out of bounds or either parameter
+  #     is the wrong type
+  def rgba(*args)
+  end
+
+  # Changes one or more properties of a color. This can change the red, green,
+  # blue, hue, saturation, value, and alpha properties. The properties are
+  # specified as keyword arguments, and replace the color's current value for
+  # that property.
+  #
+  # All properties are optional. You can't specify both RGB properties
+  # (`$red`, `$green`, `$blue`) and HSL properties (`$hue`, `$saturation`,
+  # `$value`) at the same time.
+  #
+  # @example
+  #   change-color(#102030, $blue: 5) => #102005
+  #   change-color(#102030, $red: 120, $blue: 5) => #782005
+  #   change-color(hsl(25, 100%, 80%), $lightness: 40%, $alpha: 0.8) => hsla(25, 100%, 40%, 0.8)
+  # @overload change_color($color, [$red], [$green], [$blue], [$hue], [$saturation], [$lightness], [$alpha])
+  # @param $color [Sass::Script::Value::Color]
+  # @param $red [Sass::Script::Value::Number] The new red component for the
+  #   color, within 0 and 255 inclusive
+  # @param $green [Sass::Script::Value::Number] The new green component for
+  #   the color, within 0 and 255 inclusive
+  # @param $blue [Sass::Script::Value::Number] The new blue component for the
+  #   color, within 0 and 255 inclusive
+  # @param $hue [Sass::Script::Value::Number] The new hue component for the
+  #   color, in degrees
+  # @param $saturation [Sass::Script::Value::Number] The new saturation
+  #   component for the color, between `0%` and `100%` inclusive
+  # @param $lightness [Sass::Script::Value::Number] The new lightness
+  #   component for the color, within `0%` and `100%` inclusive
+  # @param $alpha [Sass::Script::Value::Number] The new alpha component for
+  #   the color, within 0 and 1 inclusive
+  # @return [Sass::Script::Value::Color]
+  # @raise [ArgumentError] if any parameter is the wrong type or out-of
+  #   bounds, or if RGB properties and HSL properties are adjusted at the
+  #   same time
+  def change_color(color, kwargs)
+  end
+
+  # Mixes two colors together. Specifically, takes the average of each of the
+  # RGB components, optionally weighted by the given percentage. The opacity
+  # of the colors is also considered when weighting the components.
+  #
+  # The weight specifies the amount of the first color that should be included
+  # in the returned color. The default, `50%`, means that half the first color
+  # and half the second color should be used. `25%` means that a quarter of
+  # the first color and three quarters of the second color should be used.
+  #
+  # @example
+  #   mix(#f00, #00f) => #7f007f
+  #   mix(#f00, #00f, 25%) => #3f00bf
+  #   mix(rgba(255, 0, 0, 0.5), #00f) => rgba(63, 0, 191, 0.75)
+  # @overload mix($color1, $color2, $weight: 50%)
+  # @param $color1 [Sass::Script::Value::Color]
+  # @param $color2 [Sass::Script::Value::Color]
+  # @param $weight [Sass::Script::Value::Number] The relative weight of each
+  #   color. Closer to `0%` gives more weight to `$color`, closer to `100%`
+  #   gives more weight to `$color2`
+  # @return [Sass::Script::Value::Color]
+  # @raise [ArgumentError] if `$weight` is out of bounds or any parameter is
+  #   the wrong type
+  def mix(color1, color2, weight = 50)
+  end
+
+  # Retrieve all hooks of a given name, or all hooks if name.nil?
+  # @overload hooks(name)
+  #   Retrieve all hooks of a given name
+  #   @param name [Symbol]
+  #   @return [Array<#call>]
+  # @overload hooks()
+  #   Retrieve all hooks
+  #   @return [Hash<Symbol,Array<#call>>]
+  def hooks(name = nil)
+  end
+end
+
 module YardError
   if defined? ::Deprecate
     Deprecate = ::Deprecate
@@ -42,5 +168,4 @@ module YardError
   unless Deprecate.respond_to?(:skip_during)
     def Deprecate.skip_during; yield; end
   end
-
 end

data/test/unit/code_object/proxy/method_object_test.rb

@@ -263,4 +263,16 @@ describe ::Inch::CodeObject::Proxy::MethodObject do
     m2 = @objects.find("Foo#method_with_splat_parameter2")
     assert_equal m1.score, m2.score
   end
+
+  def test_overloading1
+    list = []
+    list << @objects.find("Overloading#rgb")
+    list << @objects.find("Overloading#rgba")
+    list << @objects.find("Overloading#change_color")
+    list << @objects.find("Overloading#mix")
+    list << @objects.find("Overloading#hooks")
+    list.each do |m|
+      assert_equal 100, m.score.to_i, "#{m.fullname} did not get 100"
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3.rc1
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -292,12 +292,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Documentation measurement tool for Ruby