Merge pull request #195 from scotje/maint_fixup_json_specs

(MAINT) Refactor and clean up JSON-related unit tests

Author: scotje

.gitignore

@@ -41,3 +41,6 @@ Gemfile.lock
 
 ## local coverage results
 /coverage/
+
+## local rspec config
+/.rspec-local

Gemfile

@@ -18,7 +18,8 @@ group :test do
   gem 'puppetlabs_spec_helper'
   gem 'serverspec'
   gem 'simplecov-console'
-  gem "rspec", "~> 3.1"
+  gem 'rspec', '~> 3.1'
+  gem 'json_spec', '~> 1.1', '>= 1.1.5'
 end
 
 group :acceptance do

lib/puppet-strings/json.rb

@@ -26,42 +26,4 @@ def self.render(file = nil)
       puts JSON.pretty_generate(document)
     end
   end
-
-  # Converts a list of tags into an array of hashes.
-  # @param [Array] tags List of tags to be converted into an array of hashes.
-  # @return [Array] Returns an array of tag hashes.
-  def self.tags_to_hashes(tags)
-    # Skip over the API tags that are public
-    tags.select { |t| (t.tag_name != 'api' || t.text != 'public') }.map do |t|
-      next t.to_hash if t.respond_to?(:to_hash)
-
-      tag = { tag_name: t.tag_name }
-      # grab nested information for @option tags
-      if tag[:tag_name] == 'option'
-        tag[:opt_name] = t.pair.name
-        tag[:opt_text] = t.pair.text
-        tag[:opt_types] = t.pair.types
-        tag[:parent] = t.name
-      end
-      tag[:text] = t.text if t.text
-      tag[:types] = t.types if t.types
-      tag[:name] = t.name if t.name
-      tag
-    end
-  end
-
-  # Converts a YARD::Docstring (or String) to a docstring hash for JSON output.
-  # @param [YARD::Docstring, String] docstring The docstring to convert to a hash.
-  # @param [Array] select_tags List of tags to select. Other tags will be filtered out.
-  # @return [Hash] Returns a hash representation of the given docstring.
-  def self.docstring_to_hash(docstring, select_tags=nil)
-    hash = {}
-    hash[:text] = docstring
-    if docstring.is_a? YARD::Docstring
-      tags = tags_to_hashes(docstring.tags.select { |t| select_tags.nil? || select_tags.include?(t.tag_name.to_sym) })
-
-      hash[:tags] = tags unless tags.empty?
-    end
-    hash
-  end
 end

lib/puppet-strings/yard/code_objects/class.rb

@@ -50,7 +50,7 @@ def to_hash
     hash[:file] = file
     hash[:line] = line
     hash[:inherits] = statement.parent_class if statement.parent_class
-    hash[:docstring] = PuppetStrings::Json.docstring_to_hash(docstring)
+    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring)
     defaults = Hash[*parameters.select{ |p| !p[1].nil? }.flatten]
     hash[:defaults] = defaults unless defaults.empty?
     hash[:source] = source unless source && source.empty?

lib/puppet-strings/yard/code_objects/defined_type.rb

@@ -49,7 +49,7 @@ def to_hash
     hash[:name] = name
     hash[:file] = file
     hash[:line] = line
-    hash[:docstring] = PuppetStrings::Json.docstring_to_hash(docstring)
+    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring)
     defaults = Hash[*parameters.select{ |p| !p[1].nil? }.flatten]
     hash[:defaults] = defaults unless defaults.empty?
     hash[:source] = source unless source && source.empty?

lib/puppet-strings/yard/code_objects/function.rb

@@ -88,13 +88,13 @@ def to_hash
     if self.has_tag? :overload
       # loop over overloads and append onto the signatures array
       self.tags(:overload).each do |o|
-        hash[:signatures] << { :signature => o.signature, :docstring => PuppetStrings::Json.docstring_to_hash(o.docstring, [:param, :option, :return, :example]) }
+        hash[:signatures] << { :signature => o.signature, :docstring => PuppetStrings::Yard::Util.docstring_to_hash(o.docstring, [:param, :option, :return, :example]) }
       end
     else
-      hash[:signatures] << { :signature => self.signature, :docstring =>  PuppetStrings::Json.docstring_to_hash(docstring, [:param, :option, :return, :example]) }
+      hash[:signatures] << { :signature => self.signature, :docstring =>  PuppetStrings::Yard::Util.docstring_to_hash(docstring, [:param, :option, :return, :example]) }
     end
 
-    hash[:docstring] = PuppetStrings::Json.docstring_to_hash(docstring)
+    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring)
     defaults = Hash[*parameters.select{ |p| !p[1].nil? }.flatten]
     hash[:defaults] = defaults unless defaults.empty?
     hash[:source] = source unless source && source.empty?

lib/puppet-strings/yard/code_objects/plan.rb

@@ -47,7 +47,7 @@ def to_hash
     hash[:name] = name
     hash[:file] = file
     hash[:line] = line
-    hash[:docstring] = PuppetStrings::Json.docstring_to_hash(docstring)
+    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring)
     defaults = Hash[*parameters.select{ |p| !p[1].nil? }.flatten]
     hash[:defaults] = defaults unless defaults.empty?
     hash[:source] = source unless source && source.empty?

lib/puppet-strings/yard/code_objects/provider.rb

@@ -82,7 +82,7 @@ def to_hash
     hash[:type_name] = type_name
     hash[:file] = file
     hash[:line] = line
-    hash[:docstring] = PuppetStrings::Json.docstring_to_hash(docstring)
+    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring)
     hash[:confines] = confines if confines && !confines.empty?
     hash[:features] = features if features && !features.empty?
     hash[:defaults] = defaults if defaults && !defaults.empty?

lib/puppet-strings/yard/code_objects/type.rb

@@ -141,7 +141,7 @@ def to_hash
     hash[:name] = name
     hash[:file] = file
     hash[:line] = line
-    hash[:docstring] = PuppetStrings::Json.docstring_to_hash(docstring)
+    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring)
     hash[:properties] = properties.map(&:to_hash) if properties && !properties.empty?
     hash[:parameters] = parameters.map(&:to_hash) if parameters && !parameters.empty?
     hash[:features] = features.map(&:to_hash) if features && !features.empty?

lib/puppet-strings/yard/parsers/json/parser.rb

@@ -22,7 +22,9 @@ def enumerator
   def parse
     begin
       json = JSON.parse(source)
-      @statements.push(PuppetStrings::Yard::Parsers::JSON::TaskStatement.new(json, @source, @file))
+      # TODO: this should compare json to a Task metadata json-schema or perform some other hueristics
+      # to determine what type of statement it represents
+      @statements.push(PuppetStrings::Yard::Parsers::JSON::TaskStatement.new(json, @source, @file)) unless json.empty?
     rescue
       log.error "Failed to parse #{@file}: "
       @statements = []

lib/puppet-strings/yard/tags/overload_tag.rb

@@ -99,7 +99,7 @@ def to_hash
     hash[:tag_name] = tag_name
     hash[:text] = text if text
     hash[:signature] = signature
-    hash[:docstring] = PuppetStrings::Json.docstring_to_hash(docstring) if !docstring.blank?
+    hash[:docstring] = PuppetStrings::Yard::Util.docstring_to_hash(docstring) if !docstring.blank?
     defaults = Hash[*parameters.select{ |p| !p[1].nil? }.flatten]
     hash[:defaults] = defaults unless defaults.empty?
     hash[:types] = types if types

lib/puppet-strings/yard/util.rb

@@ -28,4 +28,52 @@ def self.github_to_yard_links(data)
     end
     data
   end
+
+  # Converts a list of tags into an array of hashes.
+  # @param [Array] tags List of tags to be converted into an array of hashes.
+  # @return [Array] Returns an array of tag hashes.
+  def self.tags_to_hashes(tags)
+    # Skip over the API tags that are public
+    tags.select { |t| (t.tag_name != 'api' || t.text != 'public') }.map do |t|
+      next t.to_hash if t.respond_to?(:to_hash)
+
+      tag = { tag_name: t.tag_name }
+      # grab nested information for @option tags
+      if tag[:tag_name] == 'option'
+        tag[:opt_name] = t.pair.name
+        tag[:opt_text] = t.pair.text
+        tag[:opt_types] = t.pair.types
+        tag[:parent] = t.name
+      end
+      tag[:text] = t.text if t.text
+      tag[:types] = t.types if t.types
+      tag[:name] = t.name if t.name
+      tag
+    end
+  end
+
+  # Converts a YARD::Docstring (or String) to a docstring hash for JSON output.
+  # @param [YARD::Docstring, String] docstring The docstring to convert to a hash.
+  # @param [Array] select_tags List of tags to select. Other tags will be filtered out.
+  # @return [Hash] Returns a hash representation of the given docstring.
+  def self.docstring_to_hash(docstring, select_tags=nil)
+    hash = {}
+    hash[:text] = docstring
+
+    if docstring.is_a? YARD::Docstring
+      tags = tags_to_hashes(docstring.tags.select { |t| select_tags.nil? || select_tags.include?(t.tag_name.to_sym) })
+
+      unless tags.empty?
+        hash[:tags] = tags
+        #   .sort_by do |tag|
+        #   sort_key = tag[:tag_name].dup
+        #   sort_key << "-#{tag[:name]}" if tag[:name]
+        #   sort_key << "-#{tag[:opt_name]}" if tag[:opt_name]
+        #   sort_key
+        # end
+      end
+    end
+
+    hash
+  end
 end