ruby-lint 0.0.2 → 0.0.3

data/lib/ruby-lint/definition_generator.rb

@@ -0,0 +1,155 @@
+require 'fileutils'
+require 'erb'
+require_relative 'template/scope'
+
+module RubyLint
+  ##
+  # The DefinitionGenerator class is used for generating definitions based on
+  # the data that is available in the current Ruby runtime. Using this
+  # generator the otherwise painful and time consuming task of adding
+  # definitions for large projects (e.g. Ruby itself or Rails) becomes very
+  # easy up to the point where it will only take a minute or two.
+  #
+  # Note that this generator works best on Ruby implementations that provide
+  # accurate parameter information using `UnboundMethod#parameters`. Currently
+  # the only implementation where this is the case is Rubinius HEAD. Both MRI
+  # and Jruby provide inaccurate information.
+  #
+  # @!attribute [r] directory
+  #  @return [String] The directory to store the generated definitions in.
+  # @!attribute [r] options
+  #  @return [Hash]
+  # @!attribute [String] template
+  #  @return [String] The filepath to the ERB template to use.
+  # @!attribute [r] inspector
+  #  @return [RubyLint::Inspector]
+  #
+  class DefinitionGenerator
+    attr_reader :directory, :options, :template, :inspector
+
+    ##
+    # @param [Class] constant
+    # @param [String] directory
+    # @param [Hash] options
+    #
+    def initialize(constant, directory, options = {})
+      @options   = default_options.merge(options)
+      @inspector = Inspector.new(constant)
+      @directory = directory
+      @template  = File.read(
+        File.expand_path('../template/definition.erb', __FILE__)
+      )
+    end
+
+    ##
+    # Generates the definitions for every constant.
+    #
+    def generate
+      constants = inspector.inspect_constants.sort - options[:ignore]
+
+      group_constants(constants).each do |root, names|
+        filepath    = File.join(directory, "#{root.snake_case}.rb")
+        definitions = []
+
+        if File.file?(filepath) and !options[:overwrite]
+          next
+        end
+
+        names.each do |name|
+          current_inspector = Inspector.new(name)
+          inspected_methods = inspect_methods(current_inspector)
+          variables         = {
+            :methods       => method_information(inspected_methods),
+            :constant      => current_inspector.constant,
+            :constant_name => current_inspector.constant_name,
+            :superclass    => (current_inspector.constant.superclass rescue nil)
+          }
+
+          scope = Template::Scope.new(variables)
+          erb   = ERB.new(template, nil, '-').result(scope.get_binding)
+
+          definitions << erb
+        end
+
+        File.open(filepath, 'w') do |handle|
+          handle.write(definitions.join("\n").strip)
+        end
+      end
+    end
+
+    private
+
+    ##
+    # Groups constants together based on the top level namespace segment.
+    #
+    # @param [Array] constants
+    # @return [Hash]
+    #
+    def group_constants(constants)
+      grouped = Hash.new { |hash, key| hash[key] = [] }
+
+      constants.each do |name|
+        root           = name.split('::')[0]
+        grouped[root] << name
+      end
+
+      return grouped
+    end
+
+    ##
+    # @return [Hash]
+    #
+    def default_options
+      return {:ignore => [], :overwrite => false}
+    end
+
+    ##
+    # @param [RubyLint::Inspector] inspector
+    # @return [Hash]
+    #
+    def inspect_methods(inspector)
+      return {
+        :method          => inspector.inspect_methods,
+        :instance_method => inspector.inspect_instance_methods
+      }
+    end
+
+    ##
+    # Returns a Hash containing all the instance and class methods and their
+    # arguments.
+    #
+    # @param [Hash] inspected
+    # @return [Hash]
+    #
+    def method_information(inspected)
+      arg_mapping = argument_mapping
+      info        = {:method => {}, :instance_method => {}}
+
+      inspected.each do |type, methods|
+        methods.each do |method|
+          args = []
+
+          method.parameters.each do |arg|
+            args << {:method => arg_mapping[arg[0]], :name => arg[1]}
+          end
+
+          info[type][method.name] = args
+        end
+      end
+
+      return info
+    end
+
+    ##
+    # @return [Hash]
+    #
+    def argument_mapping
+      return {
+        :req   => :argument,
+        :opt   => :optional_argument,
+        :rest  => :rest_argument,
+        :block => :block_argument
+      }
+    end
+  end # DefinitionGenerator
+end # RubyLint

data/lib/ruby-lint/definitions/core.rb

@@ -0,0 +1,5 @@
+require_relative 'core/module'
+require_relative 'core/class'
+require_relative 'core/kernel'
+require_relative 'core/basic_object'
+require_relative 'core/object'

data/lib/ruby-lint/definitions/core/arg0.rb

@@ -0,0 +1,7 @@
+##
+# Constant: ARG0
+# Created:  2013-04-01 18:33:52 +0200
+# Platform: rbx 2.0.0.rc1
+#
+RubyLint.global_scope.define_constant('ARG0') do |klass|
+end

data/lib/ruby-lint/definitions/core/argf.rb

@@ -0,0 +1,7 @@
+##
+# Constant: ARGF
+# Created:  2013-04-01 18:33:52 +0200
+# Platform: rbx 2.0.0.rc1
+#
+RubyLint.global_scope.define_constant('ARGF') do |klass|
+end

data/lib/ruby-lint/definitions/core/argument_error.rb

@@ -0,0 +1,12 @@
+##
+# Constant: ArgumentError
+# Created:  2013-04-01 18:33:52 +0200
+# Platform: rbx 2.0.0.rc1
+#
+RubyLint.global_scope.define_constant('ArgumentError') do |klass|
+  klass.inherits(RubyLint.global_constant('StandardError'))
+
+  klass.define_method('__class_init__')
+
+  klass.define_instance_method('to_s')
+end

data/lib/ruby-lint/definitions/core/argv.rb

@@ -0,0 +1,7 @@
+##
+# Constant: ARGV
+# Created:  2013-04-01 18:33:52 +0200
+# Platform: rbx 2.0.0.rc1
+#
+RubyLint.global_scope.define_constant('ARGV') do |klass|
+end

data/lib/ruby-lint/definitions/core/array.rb

@@ -0,0 +1,414 @@
+##
+# Constant: Array
+# Created:  2013-04-01 18:33:52 +0200
+# Platform: rbx 2.0.0.rc1
+#
+RubyLint.global_scope.define_constant('Array') do |klass|
+  klass.inherits(RubyLint.global_constant('Object'))
+
+  klass.define_method('[]') do |method|
+    method.define_rest_argument('args')
+  end
+
+  klass.define_method('__class_init__')
+
+  klass.define_method('allocate')
+
+  klass.define_method('try_convert') do |method|
+    method.define_argument('obj')
+  end
+
+  klass.define_instance_method('&') do |method|
+    method.define_argument('other')
+  end
+
+  klass.define_instance_method('*') do |method|
+    method.define_argument('multiplier')
+  end
+
+  klass.define_instance_method('+') do |method|
+    method.define_argument('other')
+  end
+
+  klass.define_instance_method('-') do |method|
+    method.define_argument('other')
+  end
+
+  klass.define_instance_method('<<') do |method|
+    method.define_argument('obj')
+  end
+
+  klass.define_instance_method('<=>') do |method|
+    method.define_argument('other')
+  end
+
+  klass.define_instance_method('==') do |method|
+    method.define_argument('other')
+  end
+
+  klass.define_instance_method('[]') do |method|
+    method.define_argument('arg1')
+    method.define_optional_argument('arg2')
+  end
+
+  klass.define_instance_method('[]=') do |method|
+    method.define_argument('index')
+    method.define_argument('ent')
+    method.define_optional_argument('fin')
+  end
+
+  klass.define_instance_method('__append__') do |method|
+    method.define_argument('obj')
+  end
+
+  klass.define_instance_method('__marshal__') do |method|
+    method.define_argument('ms')
+  end
+
+  klass.define_instance_method('__rescue_match__') do |method|
+    method.define_argument('exception')
+  end
+
+  klass.define_instance_method('assoc') do |method|
+    method.define_argument('obj')
+  end
+
+  klass.define_instance_method('at') do |method|
+    method.define_argument('idx')
+  end
+
+  klass.define_instance_method('clear')
+
+  klass.define_instance_method('collect')
+
+  klass.define_instance_method('collect!')
+
+  klass.define_instance_method('combination') do |method|
+    method.define_argument('num')
+  end
+
+  klass.define_instance_method('compact')
+
+  klass.define_instance_method('compact!')
+
+  klass.define_instance_method('concat') do |method|
+    method.define_argument('other')
+  end
+
+  klass.define_instance_method('cycle') do |method|
+    method.define_optional_argument('n')
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('delete') do |method|
+    method.define_argument('obj')
+  end
+
+  klass.define_instance_method('delete_at') do |method|
+    method.define_argument('idx')
+  end
+
+  klass.define_instance_method('delete_if') do |method|
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('drop') do |method|
+    method.define_argument('n')
+  end
+
+  klass.define_instance_method('each')
+
+  klass.define_instance_method('each_index')
+
+  klass.define_instance_method('empty?')
+
+  klass.define_instance_method('eql?') do |method|
+    method.define_argument('other')
+  end
+
+  klass.define_instance_method('fetch') do |method|
+    method.define_argument('idx')
+    method.define_optional_argument('default')
+  end
+
+  klass.define_instance_method('fill') do |method|
+    method.define_optional_argument('a')
+    method.define_optional_argument('b')
+    method.define_optional_argument('c')
+  end
+
+  klass.define_instance_method('find_index') do |method|
+    method.define_optional_argument('obj')
+  end
+
+  klass.define_instance_method('first') do |method|
+    method.define_optional_argument('n')
+  end
+
+  klass.define_instance_method('flatten') do |method|
+    method.define_optional_argument('level')
+  end
+
+  klass.define_instance_method('flatten!') do |method|
+    method.define_optional_argument('level')
+  end
+
+  klass.define_instance_method('hash')
+
+  klass.define_instance_method('include?') do |method|
+    method.define_argument('obj')
+  end
+
+  klass.define_instance_method('index') do |method|
+    method.define_optional_argument('obj')
+  end
+
+  klass.define_instance_method('insert') do |method|
+    method.define_argument('idx')
+    method.define_rest_argument('items')
+  end
+
+  klass.define_instance_method('inspect')
+
+  klass.define_instance_method('join') do |method|
+    method.define_optional_argument('sep')
+  end
+
+  klass.define_instance_method('keep_if') do |method|
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('last') do |method|
+    method.define_optional_argument('n')
+  end
+
+  klass.define_instance_method('length')
+
+  klass.define_instance_method('map')
+
+  klass.define_instance_method('map!')
+
+  klass.define_instance_method('new_range') do |method|
+    method.define_argument('start')
+    method.define_argument('count')
+  end
+
+  klass.define_instance_method('new_reserved') do |method|
+    method.define_argument('count')
+  end
+
+  klass.define_instance_method('nitems')
+
+  klass.define_instance_method('pack') do |method|
+    method.define_argument('directives')
+  end
+
+  klass.define_instance_method('permutation') do |method|
+    method.define_optional_argument('num')
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('pop') do |method|
+    method.define_optional_argument('many')
+  end
+
+  klass.define_instance_method('product') do |method|
+    method.define_rest_argument('args')
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('push') do |method|
+    method.define_rest_argument('args')
+  end
+
+  klass.define_instance_method('rassoc') do |method|
+    method.define_argument('obj')
+  end
+
+  klass.define_instance_method('reject') do |method|
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('reject!') do |method|
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('repeated_combination') do |method|
+    method.define_argument('combination_size')
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('repeated_permutation') do |method|
+    method.define_argument('combination_size')
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('replace') do |method|
+    method.define_argument('other')
+  end
+
+  klass.define_instance_method('reverse')
+
+  klass.define_instance_method('reverse!')
+
+  klass.define_instance_method('reverse_each')
+
+  klass.define_instance_method('rindex') do |method|
+    method.define_optional_argument('obj')
+  end
+
+  klass.define_instance_method('rotate') do |method|
+    method.define_optional_argument('n')
+  end
+
+  klass.define_instance_method('rotate!') do |method|
+    method.define_optional_argument('cnt')
+  end
+
+  klass.define_instance_method('sample') do |method|
+    method.define_rest_argument('args')
+  end
+
+  klass.define_instance_method('select')
+
+  klass.define_instance_method('select!') do |method|
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('shelljoin')
+
+  klass.define_instance_method('shift') do |method|
+    method.define_optional_argument('n')
+  end
+
+  klass.define_instance_method('shuffle') do |method|
+    method.define_optional_argument('options')
+  end
+
+  klass.define_instance_method('shuffle!') do |method|
+    method.define_optional_argument('options')
+  end
+
+  klass.define_instance_method('size')
+
+  klass.define_instance_method('slice') do |method|
+    method.define_argument('arg1')
+    method.define_optional_argument('arg2')
+  end
+
+  klass.define_instance_method('slice!') do |method|
+    method.define_argument('start')
+    method.define_optional_argument('length')
+  end
+
+  klass.define_instance_method('sort') do |method|
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('sort!') do |method|
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('sort_by!') do |method|
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('sort_inplace') do |method|
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('start')
+
+  klass.define_instance_method('start=')
+
+  klass.define_instance_method('to_a')
+
+  klass.define_instance_method('to_ary')
+
+  klass.define_instance_method('to_generator') do |method|
+    method.define_argument('method')
+  end
+
+  klass.define_instance_method('to_s')
+
+  klass.define_instance_method('to_tuple')
+
+  klass.define_instance_method('total')
+
+  klass.define_instance_method('total=')
+
+  klass.define_instance_method('transpose')
+
+  klass.define_instance_method('tuple')
+
+  klass.define_instance_method('tuple=')
+
+  klass.define_instance_method('uniq') do |method|
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('uniq!') do |method|
+    method.define_block_argument('block')
+  end
+
+  klass.define_instance_method('unshift') do |method|
+    method.define_rest_argument('values')
+  end
+
+  klass.define_instance_method('values_at') do |method|
+    method.define_rest_argument('args')
+  end
+
+  klass.define_instance_method('zip') do |method|
+    method.define_rest_argument('others')
+  end
+
+  klass.define_instance_method('|') do |method|
+    method.define_argument('other')
+  end
+end
+
+##
+# Constant: Array::SortedElement
+# Created:  2013-04-01 18:33:52 +0200
+# Platform: rbx 2.0.0.rc1
+#
+RubyLint.global_scope.define_constant('Array::SortedElement') do |klass|
+  klass.inherits(RubyLint.global_constant('Object'))
+
+  klass.define_method('__class_init__')
+
+  klass.define_instance_method('<=>') do |method|
+    method.define_argument('other')
+  end
+
+  klass.define_instance_method('initialize') do |method|
+    method.define_argument('val')
+    method.define_argument('sort_id')
+  end
+
+  klass.define_instance_method('sort_id')
+
+  klass.define_instance_method('value')
+end
+
+##
+# Constant: Array::ValueGenerator
+# Created:  2013-04-01 18:33:52 +0200
+# Platform: rbx 2.0.0.rc1
+#
+RubyLint.global_scope.define_constant('Array::ValueGenerator') do |klass|
+  klass.inherits(RubyLint.global_constant('Object'))
+
+  klass.define_method('__class_init__')
+
+  klass.define_instance_method('initialize') do |method|
+    method.define_argument('array')
+  end
+
+  klass.define_instance_method('next')
+
+  klass.define_instance_method('next?')
+
+  klass.define_instance_method('rewind')
+end