yard-chef 1.0.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 121954baf88b0feaee034138ea9e36c56d986abb
+  data.tar.gz: 7948080f74a71041f0cb44cbf9838de8fd914a05
+SHA512:
+  metadata.gz: 4e0e4fbe640a607a008764970fbf6a6f4f01a2e857f93051763c943e6d0bdee14a18ee39d81ba4f5b2c5eb308b9820dd1d9823b229deee530bd90de95628c6dd
+  data.tar.gz: f124b5a46a840d651aa07c8490a02fc765d8edbf39633fb81c1f26751141e8c66406dee7ec7ca4b281b8f28d59739b7648664dd61eaf425919fc5c1065637dd0

data/lib/yard-chef.rb

@@ -28,6 +28,7 @@ require 'yard-chef/code_objects/provider_object'
 require 'yard-chef/code_objects/recipe_object'
 require 'yard-chef/code_objects/attribute_object'
 require 'yard-chef/code_objects/action_object'
+require 'yard-chef/code_objects/dependency_object'
 
 require 'yard-chef/handlers/base'
 require 'yard-chef/handlers/action'
@@ -36,6 +37,7 @@ require 'yard-chef/handlers/define'
 require 'yard-chef/handlers/actions'
 require 'yard-chef/handlers/cookbook'
 require 'yard-chef/handlers/recipe'
+require 'yard-chef/handlers/dependency'
 
 module YARD::CodeObjects::Chef
   # Since 'recipe' files do not have a specific keyword that can be matched,
@@ -44,21 +46,20 @@ module YARD::CodeObjects::Chef
   # be taken care of in the handler.
   # TODO: Investigate if YARD handlers can be invoked if parser is in a
   # specific directory.
-  YARD::Parser::SourceParser.before_parse_list do |files, globals|
+  YARD::Parser::SourceParser.before_parse_list do |files, _globals|
     files.each do |file|
       path_arr = File.expand_path(file).to_s.split('/')
-      unless (index = path_arr.index('recipes')).nil?
-        # Cookbook name can be derived from file path
-        # cookbook/<cookbook_name>/recipes/recipe_name.rb
-        cookbook_name = path_arr[index - 1]
-        cookbook = ChefObject.register(CHEF, cookbook_name, :cookbook)
+      next if (index = path_arr.index('recipes')).nil?
+      # Cookbook name can be derived from file path
+      # cookbook/<cookbook_name>/recipes/recipe_name.rb
+      cookbook_name = path_arr[index - 1]
+      cookbook = ChefObject.register(CHEF, cookbook_name, :cookbook)
 
-        recipe_name = path_arr.last.to_s.sub('.rb','')
-        recipe = ChefObject.register(cookbook, recipe_name, :recipe)
+      recipe_name = path_arr.last.to_s.sub('.rb', '')
+      recipe = ChefObject.register(cookbook, recipe_name, :recipe)
 
-        recipe.source = IO.read(file)
-        recipe.add_file(file, 1)
-      end
+      recipe.source = IO.read(file)
+      recipe.add_file(file, 1)
     end
   end
 

data/lib/yard-chef/code_objects/attribute_object.rb

@@ -39,6 +39,49 @@ module YARD::CodeObjects
       #
       def initialize(namespace, name)
         super(namespace, name)
+        @kind_of = ''
+        @default = ''
+      end
+
+      # Returns JSON representation of attribute name
+      #
+      # @return [String] JSON string
+      def to_json
+        json_string = "    {\n"
+        # default[:cluster][:config][:openstack][:volume_default_type]
+        if name =~ /(.+?)(\[.+\])/
+          # "default"
+          attribute_type = Regexp.last_match(1)
+          # [:cluster][:config][:openstack][:volume_default_type]
+          json_string += "      \"#{attribute_type}_attributes\": {\n      ...\n"
+          deepness = 2
+          attrs_tree = Regexp.last_match(2).split('[')
+          while (attr = attrs_tree.shift)
+            next if attr.empty?
+            attr = attr.gsub(/[:"'](.+?)["']?\]/, '\\1')
+            # Indent
+            json_string += (' ' * (deepness + 2) * 2)
+            # Attr name
+            json_string += "\"#{attr}\""
+            if attrs_tree.empty?
+              json_string += ": \"VALUE\"\n"
+            else
+              # New branch
+              json_string += ": {\n" unless attrs_tree.empty?
+              deepness += 1
+            end
+          end
+
+          # Closing brackets
+          deepness -= 1
+          deepness.times do |d|
+            # Indent
+            json_string += (' ' * (deepness - d + 2) * 2)
+            # Attr name
+            json_string += "}\n"
+          end
+        end
+        json_string + "      ...\n    }\n"
       end
     end
   end

data/lib/yard-chef/code_objects/chef_object.rb

@@ -70,8 +70,8 @@ module YARD::CodeObjects
           element_obj = YARD::Registry.resolve(:root, "#{namespace}::#{name}")
           if element_obj.nil?
             element_obj = element.new(namespace, name)
-            log.info "Created [#{type.to_s.capitalize}]" +
-              " #{element_obj.name} => #{element_obj.namespace}"
+            log.info "Created [#{type.to_s.capitalize}]" \
+                     " #{element_obj.name} => #{element_obj.namespace}"
           end
           element_obj
         else
@@ -87,7 +87,7 @@ module YARD::CodeObjects
       #
       def children_by_type(type)
         children = YARD::Registry.all(type)
-        children.reject { |child| child.parent != self }
+        children.select { |child| child.parent == self }
       end
 
       # Gets all Chef cookbooks.

data/lib/yard-chef/code_objects/cookbook_object.rb

@@ -96,13 +96,21 @@ module YARD::CodeObjects
         children_by_type(:method)
       end
 
+      # Dependencies of the cookbook.
+      #
+      # @return [Array<MethodObject>] dependencies of the cookbook
+      #
+      def dependencies
+        children_by_type(:dependency)
+      end
+
       # Libraries defined in the cookbook.
       #
       # @return [Array<ModuleObject>] libraries in the cookbook
       #
       def libraries
         modules = YARD::Registry.all(:module)
-        modules.select { |lib| !lib.parent.root? && lib.file =~ /#{@name}/ }
+        modules.select { |lib| lib.file.split('/').include?(@name.to_s) }
       end
     end
   end

data/lib/yard-chef/code_objects/dependency_object.rb

@@ -0,0 +1,52 @@
+# Copyright (c) 2015 Aleksey Hariton
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# 'Software'), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+# IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+# CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+# SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'yard'
+
+module YARD::CodeObjects
+  module Chef
+    # A DependencyObject represents a dependencies of a chef cookbook.
+    #
+    class DependencyObject < ChefObject
+      register_element :dependency
+
+      # Creates a new instance of DependencyObject.
+      #
+      # @param namespace [NamespaceObject] namespace to which the recipe belongs
+      # @param name [String] name of the recipe
+      #
+      # @return [DependencyObject] the newly created DependencyObject
+      #
+      def initialize(namespace, name)
+        super(namespace, name)
+        @docstring = ''
+      end
+
+      # Prefixes dependency name with the name of the cookbook.
+      #
+      # @return [String] recipe name
+      #
+      def name
+        @name.to_s
+      end
+    end
+  end
+end

data/lib/yard-chef/code_objects/provider_object.rb

@@ -39,6 +39,7 @@ module YARD::CodeObjects
       #
       def initialize(namespace, name)
         super(namespace, name)
+        @description = ''
       end
 
       # Constructs class name for the lightweight provider.
@@ -54,7 +55,7 @@ module YARD::CodeObjects
         else
           name = @name.to_s.capitalize
         end
-        namespace = @namespace.to_s.split('::').map { |str| str.capitalize }
+        namespace = @namespace.to_s.split('::').map(&:capitalize)
         "#{namespace.join('::')}::#{name}"
       end
 
@@ -65,12 +66,11 @@ module YARD::CodeObjects
       def map_resource(file)
         file_handle = File.open(File.expand_path(file), 'r')
         file_handle.readlines.each do |line|
-          if line =~ /#\s@resource/
-            resource_name = line.split(%r{@resource })[1].strip
-            @resource = ChefObject.register(RESOURCE, resource_name, :resource)
-            @resource.providers.push(self) unless @resource.providers.include?(self)
-            break
-          end
+          next unless line =~ /#\s@resource/
+          resource_name = line.split(/@resource /)[1].strip
+          @resource = ChefObject.register(RESOURCE, resource_name, :resource)
+          @resource.providers.push(self) unless @resource.providers.include?(self)
+          break
         end
       end
 

data/lib/yard-chef/code_objects/recipe_object.rb

@@ -38,6 +38,7 @@ module YARD::CodeObjects
       #
       def initialize(namespace, name)
         super(namespace, name)
+        @short_desc = ''
       end
 
       # Prefixes recipe name with the name of the cookbook.
@@ -45,7 +46,7 @@ module YARD::CodeObjects
       # @return [String] recipe name
       #
       def name
-        self.parent.name.to_s << '::' << @name.to_s
+        parent.name.to_s << '::' << @name.to_s
       end
     end
   end

data/lib/yard-chef/code_objects/resource_object.rb

@@ -56,7 +56,7 @@ module YARD::CodeObjects
           name = @name.to_s.capitalize
         end
 
-        namespace = @namespace.to_s.split('::').map { |str| str.capitalize }
+        namespace = @namespace.to_s.split('::').map(&:capitalize)
         "#{namespace.join('::')}::#{name}"
       end
 

data/lib/yard-chef/handlers/actions.rb

@@ -42,7 +42,7 @@ module YARD::Handlers
         # if multiple actions listed in same line, split the actions and
         # register them
         if statement.first_line =~ /,/
-          statement.first_line.split(%r{,?\s*:}).each do |action|
+          statement.first_line.split(/,?\s*:/).each do |_action|
             action = ChefObject.register(resource_obj, name, :action)
           end
         else
@@ -50,7 +50,7 @@ module YARD::Handlers
           action.docstring = statement.docstring
         end
 
-        log.info "Found [Actions] in #{parser.file.to_s}"
+        log.info "Found [Actions] in #{parser.file}"
       end
     end
   end

data/lib/yard-chef/handlers/attribute.rb

@@ -26,14 +26,17 @@ module YARD::Handlers
     # Handles "attributes" in cookbook metadata and lightweight resource.
     #
     class AttributeHandler < Base
+      MATCH = /^\s*(default|force_default|normal|override|force_override)(\[.+?\])\s*=\s*(.+)/m
       handles method_call(:attribute)
+      handles MATCH
 
       # Process "attribute" keyword.
       #
       def process
+        path_array = parser.file.to_s.split('/')
         # If file path includes metadata then handle cookbook attributes
         # else handle resource attributes
-        if parser.file =~ /metadata\.rb/
+        if path_array.include?('metadata.rb') || path_array.include?('attributes')
           namespace = cookbook
         else
           namespace = lwrp
@@ -46,9 +49,13 @@ module YARD::Handlers
         end
 
         # Register attribute if not already registered
-        attrib_obj = ChefObject.register(namespace, name, :attribute)
+        if path_array.include? 'attributes'
+          statement.source =~ MATCH
+          attrib_obj = ChefObject.register(namespace, "#{Regexp.last_match(1)}#{Regexp.last_match(2)}", :attribute)
+        else
+          attrib_obj = ChefObject.register(namespace, name, :attribute)
+        end
         attrib_obj.source = statement.source
-        attrib_obj.docstring = docstring
         attrib_obj.add_file(statement.file, statement.line)
       end
 
@@ -58,23 +65,45 @@ module YARD::Handlers
       # @return [YARD::Docstring] docstring for the attribute
       #
       def docstring
-        description = ""
+        description = ''
         path_array = parser.file.to_s.split('/')
+        # Parse docstring
         if path_array.include?('metadata.rb')
           # Suppose :description string have concatenation operator '+' then
           # YARD builds an abstract syntax tree (AST). We need to traverse the
           # tree to get the whole description string
           statement.parameters[1].children.each do |ast_node|
-            if ast_node.jump(:ident).source == "description"
-              ast_node.traverse do |child|
-                description << child.jump(:string_content).source if child.type == :string_content
-              end
+            next unless ast_node.jump(:ident).source == 'description'
+            ast_node.traverse do |child|
+              description << child.jump(:string_content).source if child.type == :string_content
             end
           end
         else
           description = statement.comments
         end
-        YARD::DocstringParser.new.parse(description).to_docstring
+        attrib_obj.docstring = YARD::DocstringParser.new.parse(description).to_docstring
+        is_kind_of = ''
+        is_default = ''
+        if path_array.include? 'attributes'
+          statement.source =~ MATCH
+          is_default = Regexp.last_match(3)
+        else
+          statement.parameters.each do |n|
+            next unless (n.is_a? YARD::Parser::Ruby::AstNode) && (n.source =~ /(default|kind_of)/)
+            n.each do |node|
+              if node.source =~ /default/
+                m = node.source.match(/\W+?\s(.*)/)
+                is_default = m[1] if m
+              end
+              if node.source =~ /kind_of/
+                m = node.source.match(/\W+?\s(.*)/)
+                is_kind_of = m[1] if m
+              end
+            end
+          end
+        end
+        attrib_obj.kind_of = is_kind_of
+        attrib_obj.default = is_default.split("\n").map { |s| "    #{s}" }.join("\n")
       end
     end
   end

data/lib/yard-chef/handlers/base.rb

@@ -39,13 +39,13 @@ module YARD::Handlers
       # @return [CookbookObject] the CookbookObject
       #
       def cookbook
-        cookbook_name = ""
+        cookbook_name = ''
         path_array = File.expand_path(statement.file).to_s.split('/')
-        if path_array.include?('metadata.rb')
-          cookbook_name = path_array[path_array.index('metadata.rb') - 1]
-        else
-          cookbook_name = path_array[path_array.length - 3]
-        end
+        cookbook_name = if path_array.include?('metadata.rb')
+                          path_array[path_array.index('metadata.rb') - 1]
+                        else
+                          path_array[path_array.length - 3]
+                        end
         ChefObject.register(CHEF, cookbook_name, :cookbook)
       end
 
@@ -57,23 +57,23 @@ module YARD::Handlers
       #
       def lwrp
         path_array = File.expand_path(statement.file).to_s.split('/')
-        if path_array.include?("resources")
+        if path_array.include?('resources')
           type = RESOURCE
           type_sym = :resource
-        elsif path_array.include?("providers")
+        elsif path_array.include?('providers')
           type = PROVIDER
           type_sym = :provider
         else
           raise "Invalid LWRP type #{@path_array.join(',')}"
         end
-        file_name = path_array.last.to_s.sub('.rb','')
+        file_name = path_array.last.to_s.sub('.rb', '')
 
         cookbook_obj = cookbook
-        if file_name == "default"
-          lwrp_name = cookbook_obj.name
-        else
-          lwrp_name = "#{cookbook_obj.name}_#{file_name}"
-        end
+        lwrp_name = if file_name == 'default'
+                      cookbook_obj.name
+                    else
+                      "#{cookbook_obj.name}_#{file_name}"
+                    end
         ChefObject.register(type, lwrp_name, type_sym)
       end
     end

data/lib/yard-chef/handlers/cookbook.rb

@@ -60,11 +60,21 @@ module YARD::Handlers
       # @return [String] the method name
       #
       def name
-        string = ""
-        # YARD builds an abstract syntax tree (AST) which we need to traverse
-        # to obtain the complete docstring
-        statement.parameters.first.traverse do |child|
-          string << child.jump(:string_content).source if child.type == :string_content
+        string = ''
+        value = statement.parameters.first
+        if value.is_a?(YARD::Parser::Ruby::MethodCallNode)
+          # The content is code, so evaluate it in the correct directory
+          # This handles ruby code like File.read in metadata.rb
+          current_directory = Dir.getwd
+          Dir.chdir(File.expand_path(File.dirname(statement.file)))
+          string << eval(value.source)
+          Dir.chdir current_directory
+        else
+          # YARD builds an abstract syntax tree (AST) which we need to traverse
+          # to obtain the complete docstring
+          value.traverse do |child|
+            string << child.jump(:string_content).source if child.type == :string_content
+          end
         end
         string
       end
@@ -77,17 +87,17 @@ module YARD::Handlers
         type = ''
         string = ''
         readme_path = base_dir + '/README.md'
-        if File.exists?(readme_path)
+        if File.exist?(readme_path)
           type = :markdown
           string = IO.read(readme_path)
         else
           readme_path = base_dir + '/README.rdoc'
-          if File.exists?(readme_path)
+          if File.exist?(readme_path)
             type = :rdoc
             string = IO.read(readme_path)
           end
         end
-        return YARD::DocstringParser.new.parse(string).to_docstring, type
+        [YARD::DocstringParser.new.parse(string).to_docstring, type]
       end
     end
   end